diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 000000000..9eb7cfdae --- /dev/null +++ b/.dockerignore @@ -0,0 +1,38 @@ +# Packages +node_modules/ + +# Log files +logs/ +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Env +.env + +# Dist +dist/ + +# Miscellaneous +.tmp/ +.vscode/* +!.vscode/extensions.json +!.vscode/settings.json +.idea/ +.DS_Store +.turbo +tsconfig.tsbuildinfo + +# yarn +.pnp.* +.yarn/* +!.yarn/cache +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/sdks +!.yarn/versions diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index aed591f98..aac2f48f8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -16,6 +16,7 @@ body: - collection - rest - proxy + - proxy-container - voice validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index f7e0ee44f..0e23c723c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -18,6 +18,7 @@ body: - collection - rest - proxy + - proxy-container - voice validations: required: true diff --git a/.github/labeler.yml b/.github/labeler.yml index fea2befbf..9096d3b43 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -22,6 +22,10 @@ chore: - packages/proxy/* - packages/proxy/**/* +'packages:proxy-container': + - packages/proxy-container/* + - packages/proxy-container/**/* + 'packages:rest': - packages/rest/* - packages/rest/**/* diff --git a/.github/labels.yml b/.github/labels.yml index b5e092bbe..7e3f943c1 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -54,6 +54,8 @@ color: 'fbca04' - name: 'packages:proxy' color: 'fbca04' +- name: 'packages:proxy-container' + color: 'fbca04' - name: 'packages:rest' color: 'fbca04' - name: 'packages:voice' diff --git a/.github/workflows/publish-dev-docker.yml b/.github/workflows/publish-dev-docker.yml new file mode 100644 index 000000000..af1148c27 --- /dev/null +++ b/.github/workflows/publish-dev-docker.yml @@ -0,0 +1,25 @@ +name: Publish dev Docker Images +on: + workflow_dispatch: + schedule: + - cron: '0 */12 * * *' +jobs: + docker: + name: Docker + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Login to DockerHub + run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_TOKEN }} + + - name: Build the image + run: docker build -t discordjs/proxy:latest -f packages/proxy-container/Dockerfile . + + - name: Push image to DockerHub + run: docker push discordjs/proxy:latest diff --git a/.github/workflows/publish-docker.yml b/.github/workflows/publish-docker.yml new file mode 100644 index 000000000..d30b8b763 --- /dev/null +++ b/.github/workflows/publish-docker.yml @@ -0,0 +1,26 @@ +name: Publish Docker Images +on: + workflow_dispatch: +jobs: + docker: + name: Docker + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v1 + + - name: Login to DockerHub + run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_TOKEN }} + + - name: Build the image + run: docker build -t discordjs/proxy:latest -f packages/proxy-container/Dockerfile . + + - name: Tag the image with major + run: docker tag discordjs/proxy discordjs/proxy:$(cut -d '.' -f1 <<< $(jq --raw-output '.version' packages/proxy-container/package.json)) + + - name: Push image to DockerHub + run: docker push --all-tags discordjs/proxy diff --git a/packages/proxy-container/.eslintrc.json b/packages/proxy-container/.eslintrc.json new file mode 100644 index 000000000..99ef7cec8 --- /dev/null +++ b/packages/proxy-container/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "../../.eslintrc.json" +} diff --git a/packages/proxy-container/.gitignore b/packages/proxy-container/.gitignore new file mode 100644 index 000000000..b5e30aac1 --- /dev/null +++ b/packages/proxy-container/.gitignore @@ -0,0 +1,32 @@ +# Packages +node_modules/ + +# Log files +logs/ +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Env +.env + +# Dist +dist/ +typings/ +docs/**/* +!docs/index.yml +!docs/README.md + +# Miscellaneous +.tmp/ +coverage/ +tsconfig.tsbuildinfo +.turbo + +# Yarn files +.yarn/install-state.gz +.yarn/build-state.yml diff --git a/packages/proxy-container/.prettierignore b/packages/proxy-container/.prettierignore new file mode 100644 index 000000000..553e0ea6c --- /dev/null +++ b/packages/proxy-container/.prettierignore @@ -0,0 +1,8 @@ +# Autogenerated +CHANGELOG.md +.turbo +dist/ +docs/**/* +!docs/index.yml +!docs/README.md +coverage/ diff --git a/packages/proxy-container/.prettierrc.json b/packages/proxy-container/.prettierrc.json new file mode 100644 index 000000000..eba3f4077 --- /dev/null +++ b/packages/proxy-container/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "useTabs": true, + "singleQuote": true, + "quoteProps": "as-needed", + "trailingComma": "all", + "endOfLine": "lf" +} diff --git a/packages/proxy-container/Dockerfile b/packages/proxy-container/Dockerfile new file mode 100644 index 000000000..cae61b406 --- /dev/null +++ b/packages/proxy-container/Dockerfile @@ -0,0 +1,18 @@ +FROM node:16-alpine + +WORKDIR /usr/proxy + +# First copy over dependencies separate from src for better caching +COPY package.json yarn.lock tsconfig.json .yarnrc.yml tsup.config.ts ./ +COPY .yarn ./.yarn +COPY ./packages/proxy-container/package.json ./packages/proxy-container/ + +WORKDIR /usr/proxy/packages/proxy-container + +RUN yarn workspaces focus + +# Next up, copy over our src and build it, then prune deps for prod +COPY ./packages/proxy-container ./ +RUN yarn build && yarn workspaces focus --production + +CMD ["node", "--enable-source-maps", "./dist/index.js"] diff --git a/packages/proxy-container/LICENSE b/packages/proxy-container/LICENSE new file mode 100644 index 000000000..f9786ff8f --- /dev/null +++ b/packages/proxy-container/LICENSE @@ -0,0 +1,191 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2022 Noel Buechler + Copyright 2022 Charlotte Cristea + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/proxy-container/README.md b/packages/proxy-container/README.md new file mode 100644 index 000000000..e8d094835 --- /dev/null +++ b/packages/proxy-container/README.md @@ -0,0 +1,56 @@ +
+ +## About + +`@discordjs/proxy-container` - Lightweight HTTP proxy for Discord's API, brought to you as a container 📦 + +## Usage + +Quickly spin up an instance: + +`docker run -d --restart unless-stopped --name proxy -p 127.0.0.1:8080:8080 -e DISCORD_TOKEN=abc discordjs/proxy` + +Use it: + +```ts +import { Client } from 'discord.js'; +import { ProxyAgent } from 'undici'; + +const client = new Client({ + // other options, + rest: { + agent: new ProxyAgent('https://localhost:8080'), + }, +}); +``` + +## Links + +- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) +- [Documentation](https://discord.js.org/#/docs/proxy) +- [discord.js Discord server](https://discord.gg/djs) +- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/proxy) +- [npm](https://www.npmjs.com/package/@discordjs/proxy) + +## Contributing + +Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the +[documentation](https://discord.js.org/#/docs/proxy). +See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. + +## Help + +If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle +nudge in the right direction, please don't hesitate to join our official [discord.js Server](https://discord.gg/djs). diff --git a/packages/proxy-container/cliff.toml b/packages/proxy-container/cliff.toml new file mode 100644 index 000000000..b36ec15b1 --- /dev/null +++ b/packages/proxy-container/cliff.toml @@ -0,0 +1,65 @@ +[changelog] +header = """ +# Changelog + +All notable changes to this project will be documented in this file.\n +""" +body = """ +{% if version %}\ + # [{{ version | trim_start_matches(pat="v") }}]\ + {% if previous %}\ + {% if previous.version %}\ + (https://github.com/discordjs/discord.js/compare/{{ previous.version }}...{{ version }})\ + {% else %} + (https://github.com/discordjs/discord.js/tree/{{ version }})\ + {% endif %}\ + {% endif %} \ + - ({{ timestamp | date(format="%Y-%m-%d") }}) +{% else %}\ + # [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ## {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.scope %}\ + **{{commit.scope}}:** \ + {% endif %}\ + {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/discordjs/discord.js/commit/{{ commit.id }}))\ + {% if commit.breaking %}\ + \n\n {% raw %} {% endraw %} ### Breaking Changes:\n \ + {% for breakingChange in commit.footers %}\ + {% raw %} {% endraw %} - {{ breakingChange }}\n\ + {% endfor %}\ + {% endif %}\ + {% endfor %} +{% endfor %}\n +""" +trim = true +footer = "" + +[git] +conventional_commits = true +filter_unconventional = true +commit_parsers = [ + { message = "^feat", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^docs", group = "Documentation"}, + { message = "^perf", group = "Performance"}, + { message = "^refactor", group = "Refactor"}, + { message = "^typings", group = "Typings"}, + { message = "^types", group = "Typings"}, + { message = ".*deprecated", body = ".*deprecated", group = "Deprecation"}, + { message = "^revert", skip = true}, + { message = "^style", group = "Styling"}, + { message = "^test", group = "Testing"}, + { message = "^chore", skip = true}, + { message = "^ci", skip = true}, + { message = "^build", skip = true}, + { body = ".*security", group = "Security"}, +] +filter_commits = true +tag_pattern = "@discordjs\\/proxy-container@.*" +skip_tags = "v[0-9]*|11|12" +ignore_tags = "" +topo_order = false +sort_commits = "newest" diff --git a/packages/proxy-container/package.json b/packages/proxy-container/package.json new file mode 100644 index 000000000..8643a1ad6 --- /dev/null +++ b/packages/proxy-container/package.json @@ -0,0 +1,67 @@ +{ + "name": "@discordjs/proxy-container", + "version": "0.1.0-dev", + "description": "Lightweight HTTP proxy for Discord's API, brought to you as a container 📦", + "scripts": { + "build": "tsup && tsc --noEmit", + "lint": "prettier --check . && eslint src --ext mjs,js,ts", + "format": "prettier --write . && eslint src --ext mjs,js,ts --fix", + "prepublishOnly": "yarn build && yarn lint && yarn test", + "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/proxy-container/*'" + }, + "main": "./dist/index.js", + "type": "module", + "directories": { + "lib": "src" + }, + "files": [ + "dist" + ], + "contributors": [ + "Crawl