diff --git a/.dockerignore b/.dockerignore index cbfebc09e59c..9bcce7a80897 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,12 +1,3 @@ -Dockerfile -build -deployment -doc -.github -.gitignore -.node-version -.travis.yml -LICENSE -README.md -node_modules -release \ No newline at end of file +** +!release-packages +!ci diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000000..65705d954568 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,6 @@ +root = true + +[*] +indent_style = space +trim_trailing_whitespace = true +indent_size = 2 diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 000000000000..793a923d16eb --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# Prettier 3.4.2 +9b0340a09276f93c054d705d1b9a5f24cc5dbc97 \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000000..dc5caf936908 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.afdesign filter=lfs diff=lfs merge=lfs -text diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 11fee14e7271..04718d97bc09 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,7 @@ -* @code-asher @kylecarbs -Dockerfile @nhooyr +* @coder/code-server + +ci/helm-chart/ @Matthew-Beckett @alexgorbatchev + +docs/install.md @GNUxeava + +src/node/i18n/locales/zh-cn.json @zhaozhiming diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000000..c43d5c65e23b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,126 @@ +name: Bug report +description: File a bug report +labels: ["bug", "triage"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + attributes: + label: OS/Web Information + description: | + examples: + - **Web Browser**: Chrome + - **Local OS**: macOS + - **Remote OS**: Ubuntu + - **Remote Architecture**: amd64 + - **`code-server --version`**: 4.0.1 + + Please do not just put "latest" for the version. + value: | + - Web Browser: + - Local OS: + - Remote OS: + - Remote Architecture: + - `code-server --version`: + validations: + required: true + + - type: textarea + attributes: + label: Steps to Reproduce + description: | + Please describe exactly how to reproduce the bug. For example: + 1. Open code-server in Firefox + 2. Install extension `foo.bar` from the extensions sidebar + 3. Run command `foo.bar.baz` + value: | + 1. + 2. + 3. + validations: + required: true + + - type: textarea + attributes: + label: Expected + description: What should happen? + validations: + required: true + + - type: textarea + attributes: + label: Actual + description: What actually happens? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs + description: Run code-server with the --verbose flag and then paste any relevant logs from the server, from the browser console and/or the browser network tab. For issues with installation, include installation logs (i.e. output of `npm install -g code-server`). + render: shell + + - type: textarea + attributes: + label: Screenshot/Video + description: Please include a screenshot, gif or screen recording of your issue. + validations: + required: false + + - type: dropdown + attributes: + label: Does this bug reproduce in native VS Code? + description: If the bug reproduces in native VS Code, submit the issue upstream instead (https://github.com/microsoft/vscode). + options: + - Yes, this is also broken in native VS Code + - No, this works as expected in native VS Code + - This cannot be tested in native VS Code + - I did not test native VS Code + validations: + required: true + + - type: dropdown + attributes: + label: Does this bug reproduce in VS Code web? + description: If the bug reproduces in VS Code web, submit the issue upstream instead (https://github.com/microsoft/vscode). You can run VS Code web with `code serve-web` (this is not the same as vscode.dev). + options: + - Yes, this is also broken in VS Code web + - No, this works as expected in VS Code web + - This cannot be tested in VS Code web + - I did not test VS Code web + validations: + required: true + + - type: dropdown + attributes: + label: Does this bug reproduce in GitHub Codespaces? + description: If the bug reproduces in GitHub Codespaces, submit the issue upstream instead (https://github.com/microsoft/vscode). + options: + - Yes, this is also broken in GitHub Codespaces + - No, this works as expected in GitHub Codespaces + - This cannot be tested in GitHub Codespaces + - I did not test GitHub Codespaces + validations: + required: true + + - type: checkboxes + attributes: + label: Are you accessing code-server over a secure context? + description: code-server relies on service workers (which only work in secure contexts) for many features. Double-check that you are using a secure context like HTTPS or localhost. + options: + - label: I am using a secure context. + required: false + + - type: textarea + attributes: + label: Notes + description: Please include any addition notes that will help us resolve this issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 50e90f1f21fa..000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Bug Report -about: Report problems and unexpected behavior. -title: '' -labels: 'bug' -assignees: '' ---- - - - - -- `code-server` version: -- OS Version: - -## Description - - - -## Steps to Reproduce - -1. -1. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000000..e24498346339 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Question? + url: https://github.com/coder/code-server/discussions/new?category_id=22503114 + about: Ask the community for help on our GitHub Discussions board + - name: code-server Slack Community + about: Need immediate help or just want to talk? Hop in our Slack. Note - this Slack is not actively monitored by code-server maintainers. + url: https://cdr.co/join-community diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md new file mode 100644 index 000000000000..75240e7f7631 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -0,0 +1,11 @@ +--- +name: Documentation improvement +about: Suggest a documentation improvement +labels: "docs" +--- + +## What is your suggestion? + +## How will this improve the docs? + +## Are you interested in submitting a PR for this? diff --git a/.github/ISSUE_TEMPLATE/extension_bug.md b/.github/ISSUE_TEMPLATE/extension_bug.md deleted file mode 100644 index 7c30b9479417..000000000000 --- a/.github/ISSUE_TEMPLATE/extension_bug.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Extension Bug -about: Report problems and unexpected behavior with extensions. -title: '' -labels: 'extension-specific' -assignees: '' ---- - - - -- `code-server` version: -- OS Version: -- Extension: - -## Description - - - -## Steps to Reproduce - -1. -1. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000000..89837e3441e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,13 @@ +--- +name: Feature request +about: Suggest an idea to improve code-server +labels: enhancement +--- + +## What is your suggestion? + +## Why do you want this feature? + +## Are there any workarounds to get this functionality today? + +## Are you interested in submitting a PR for this? diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index b33f67bc7ebf..000000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for this project. -title: '' -labels: 'feature' -assignees: '' ---- - - - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 3c234cd1c76c..000000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Question -about: Ask a question. -title: '' -labels: 'question' -assignees: '' ---- - - - -## Description - - - -## Related Issues - - \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..e240a5f49c8d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ + + +Fixes # diff --git a/.github/codecov.yml b/.github/codecov.yml new file mode 100644 index 000000000000..c2e23821411d --- /dev/null +++ b/.github/codecov.yml @@ -0,0 +1,31 @@ +codecov: + require_ci_to_pass: yes + allow_coverage_offsets: True + +coverage: + precision: 2 + round: down + range: "40...70" + status: + patch: off + notify: + slack: + default: + url: secret:v1::tXC7VwEIKYjNU8HRgRv2GdKOSCt5UzpykKZb+o1eCDqBgb2PEqwE3A26QUPYMLo4BO2qtrJhFIvwhUvlPwyzDCNGoNiuZfXr0UeZZ0y1TcZu672R/NBNMwEPO/e1Ye0pHxjzKHnuH7HqbjFucox/RBQLtiL3J56SWGE3JtbkC6o= + threshold: 1% + only_pulls: false + branches: + - "main" + +parsers: + gcov: + branch_detection: + conditional: yes + loop: yes + method: no + macro: no + +comment: + layout: "reach,diff,flags,files,footer" + behavior: default + require_changes: no diff --git a/.github/codeql-config.yml b/.github/codeql-config.yml new file mode 100644 index 000000000000..9f98cc2a62b1 --- /dev/null +++ b/.github/codeql-config.yml @@ -0,0 +1 @@ +name: "code-server CodeQL config" diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 000000000000..d39541471001 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,31 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" + time: "06:00" + timezone: "America/Chicago" + cooldown: + default-days: 7 + labels: [] + + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "monthly" + time: "06:00" + timezone: "America/Chicago" + cooldown: + default-days: 7 + labels: [] + ignore: + # Ignore patch updates for all dependencies + - dependency-name: "*" + update-types: + - version-update:semver-patch + # Ignore major updates to Node.js types, because they need to + # correspond to the Node.js engine version + - dependency-name: "@types/node" + update-types: + - version-update:semver-major diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index e056fdf5f161..000000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,6 +0,0 @@ - - -### Describe in detail the problem you had and how this PR fixes it - -### Is there an open issue you can link to? - diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 000000000000..945de5a3e12a --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,12 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 180 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 5 +# Label to apply when stale. +staleLabel: stale +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no activity occurs in the next 5 days. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: false diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 000000000000..22d27335ab8e --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,311 @@ +name: Build + +on: + push: + branches: + - main + pull_request: + branches: + - main + +# Cancel in-progress runs for pull requests when developers push +# additional changes, and serialize builds in branches. +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-concurrency-to-cancel-any-in-progress-job-or-run +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +jobs: + changes: + runs-on: ubuntu-latest + outputs: + ci: ${{ steps.filter.outputs.ci }} + code: ${{ steps.filter.outputs.code }} + npm: ${{ steps.filter.outputs.npm }} + vscode: ${{ steps.filter.outputs.vscode }} + docs: ${{ steps.filter.outputs.docs }} + helm: ${{ steps.filter.outputs.helm }} + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: dorny/paths-filter@ceb8a2b8f2d89434be7ff52d3de7ec3738c5cc9d # v4.0.3 + id: filter + with: + filters: | + ci: + - ".github/**" + - "ci/**" + docs: + - "docs/**" + - "README.md" + - "CHANGELOG.md" + helm: + - "ci/helm-chart/**" + code: + - "src/**" + - "test/**" + npm: + - "package-lock.json" + - "test/package-lock.json" + vscode: + - "lib/**" + - "patches/**" + - id: debug + run: | + echo "${{ toJSON(steps.filter )}}" + + prettier: + name: Run prettier check + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - run: npx prettier --check . + + doctoc: + name: Doctoc markdown files + runs-on: ubuntu-22.04 + needs: changes + if: needs.changes.outputs.docs == 'true' + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - run: npm run doctoc + + lint-helm: + name: Lint Helm chart + runs-on: ubuntu-22.04 + needs: changes + if: needs.changes.outputs.helm == 'true' + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: bmuschko/setup-kubeconform@e5d264ec1eafe2314e750c429a9da7639dd5a003 # v1.1.0 + with: + kubeconform-version: "0.8.0" + - run: kubeconform ci/helm-chart + + lint-ts: + name: Lint TypeScript files + runs-on: ubuntu-22.04 + needs: changes + if: needs.changes.outputs.code == 'true' || needs.changes.outputs.ci == 'true' || needs.changes.outputs.npm == 'true' + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - run: npm run lint:ts + + lint-actions: + name: Lint GitHub Actions + runs-on: ubuntu-latest + needs: changes + if: needs.changes.outputs.ci == 'true' + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - name: Check workflow files + run: | + bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash) 1.7.9 + ./actionlint -color -shellcheck= -ignore "softprops/action-gh-release" + shell: bash + + test-unit: + name: Run unit tests + runs-on: ubuntu-22.04 + needs: changes + if: needs.changes.outputs.code == 'true' || needs.changes.outputs.npm == 'true' + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - run: npm run test:unit + - uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1 + if: success() + with: + token: ${{ secrets.CODECOV_TOKEN }} + + build: + name: linux-x64 + runs-on: ubuntu-22.04 + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + DISABLE_V8_COMPILE_CACHE: 1 + VERSION: 0.0.0 + VSCODE_ARCH: x64 + VSCODE_TARGET: linux-x64 + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ELECTRON_SKIP_BINARY_DOWNLOAD: 1 + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1 + + steps: + - run: sudo apt update && sudo apt install -y libkrb5-dev + - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # latest + with: + packages: quilt + version: 1.0 + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + submodules: true + - run: quilt push -a + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + + # Get Code's git hash. When this changes it means the content is + # different and we need to rebuild. + - name: Get latest lib/vscode rev + id: vscode-rev + run: echo "rev=$(git rev-parse HEAD:./lib/vscode)" >> $GITHUB_OUTPUT + + # We need to rebuild when we have a new version of Code, when any of the + # patches changed, or when the code-server version changes (since it gets + # embedded into the code). Use VSCODE_CACHE_VERSION to force a rebuild. + - name: Fetch prebuilt linux-x64 Code package from cache + id: cache-vscode + uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + with: + path: lib/vscode-reh-web-linux-x64 + key: vscode-linux-x64-package-${{ secrets.VSCODE_CACHE_VERSION }}-${{ steps.vscode-rev.outputs.rev }}-${{ hashFiles('patches/*.diff', 'ci/build/build-vscode.sh') }} + - name: Build vscode + if: steps.cache-vscode.outputs.cache-hit != 'true' + run: | + cd lib/vscode/build + npm ci + cd .. + source ./build/azure-pipelines/linux/setup-env.sh + # Run preinstall script before root dependencies are installed + # so that v8 headers are patched correctly for native modules. + node build/npm/preinstall.ts + npm ci + cd ../.. + npm run build:vscode + + # Build the code-server wrapper. + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - run: npm run build + + # Push up an artifact containing the linux-x64 release. + - run: KEEP_MODULES=1 npm run release + - run: tar -czf package.tar.gz release + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + with: + name: linux-x64-package + path: ./package.tar.gz + + test-e2e: + name: Run e2e tests + runs-on: ubuntu-22.04 + env: + LOG_LEVEL: debug + needs: [changes, build] + if: needs.changes.outputs.code == 'true' || needs.changes.outputs.npm == 'true' || needs.changes.outputs.vscode == 'true' || needs.changes.outputs.ci == 'true' + + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - name: Install Playwright OS dependencies + run: | + ./test/node_modules/.bin/playwright install-deps + ./test/node_modules/.bin/playwright install + + - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8 + with: + name: linux-x64-package + - run: tar -xzf package.tar.gz + + - run: CODE_SERVER_TEST_ENTRY=./release npm run test:e2e + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + if: always() + with: + name: failed-test-videos + path: ./test/test-results + + test-e2e-proxy: + name: Run e2e tests behind proxy + runs-on: ubuntu-22.04 + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + LOG_LEVEL: debug + needs: [changes, build] + if: needs.changes.outputs.code == 'true' || needs.changes.outputs.npm == 'true' || needs.changes.outputs.vscode == 'true' || needs.changes.outputs.ci == 'true' + + steps: + - name: Cache Caddy + uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 + id: caddy-cache + with: + path: | + ~/.cache/caddy + key: cache-caddy-2.5.2 + - name: Install Caddy + if: steps.caddy-cache.outputs.cache-hit != 'true' + run: | + gh release download v2.5.2 --repo caddyserver/caddy --pattern "caddy_2.5.2_linux_amd64.tar.gz" + mkdir -p ~/.cache/caddy + tar -xzf caddy_2.5.2_linux_amd64.tar.gz --directory ~/.cache/caddy + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + - run: SKIP_SUBMODULE_DEPS=1 npm ci + - name: Install Playwright OS dependencies + run: | + ./test/node_modules/.bin/playwright install-deps + ./test/node_modules/.bin/playwright install + + - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8 + with: + name: linux-x64-package + - run: tar -xzf package.tar.gz + + - run: ~/.cache/caddy/caddy start --config ./ci/Caddyfile + - run: CODE_SERVER_TEST_ENTRY=./release npm run test:e2e:proxy + - run: ~/.cache/caddy/caddy stop --config ./ci/Caddyfile + if: always() + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 + if: always() + with: + name: failed-test-videos-proxy + path: ./test/test-results diff --git a/.github/workflows/installer.yaml b/.github/workflows/installer.yaml new file mode 100644 index 000000000000..1777844dd11b --- /dev/null +++ b/.github/workflows/installer.yaml @@ -0,0 +1,76 @@ +name: Installer integration + +on: + push: + branches: + - main + paths: + - "install.sh" + - ".github/workflows/installer.yaml" + pull_request: + branches: + - main + paths: + - "install.sh" + - ".github/workflows/installer.yaml" + +# Cancel in-progress runs for pull requests when developers push +# additional changes, and serialize builds in branches. +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-concurrency-to-cancel-any-in-progress-job-or-run +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +permissions: + contents: read + +jobs: + ubuntu: + name: Test installer on Ubuntu + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Install code-server + run: ./install.sh + + - name: Test code-server was installed globally + run: code-server --help + + alpine: + name: Test installer on Alpine + runs-on: ubuntu-latest + container: "alpine:3.17" + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Install curl + run: apk add curl + + - name: Add user + run: adduser coder --disabled-password + + # Standalone should work without root. + - name: Test standalone to a non-existent prefix + run: su coder -c "./install.sh --method standalone --prefix /tmp/does/not/yet/exist" + + # We do not actually have Alpine standalone builds so running code-server + # will not work. + - name: Test code-server was installed to prefix + run: test -f /tmp/does/not/yet/exist/bin/code-server + + macos: + name: Test installer on macOS + runs-on: macos-latest + + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Install code-server + run: ./install.sh + + - name: Test code-server was installed globally + run: code-server --help diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 000000000000..32cf8370e817 --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,167 @@ +name: Publish code-server + +on: + # Shows the manual trigger in GitHub UI + # helpful as a back-up in case the GitHub Actions Workflow fails + workflow_dispatch: + inputs: + version: + type: string + required: true + + release: + types: [released] + +# Cancel in-progress runs for pull requests when developers push +# additional changes, and serialize builds in branches. +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-concurrency-to-cancel-any-in-progress-job-or-run +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +jobs: + npm: + runs-on: ubuntu-latest + env: + TAG: ${{ inputs.version || github.ref_name }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + NPM_ENVIRONMENT: "production" + + steps: + - name: Set version to tag without leading v + run: | + echo "VERSION=${TAG#v}" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + + - uses: robinraju/release-downloader@28fc21f50d76778e7023361aa1f863e717d3d56f # v1.13 + with: + repository: "coder/code-server" + tag: ${{ env.TAG }} + fileName: "package.tar.gz" + out-file-path: "release-npm-package" + + - run: tar -xzf release-npm-package/package.tar.gz + - run: | + echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc + pushd release + npm publish --tag latest --access public + + aur: + runs-on: ubuntu-latest + timeout-minutes: 10 + env: + GH_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} + TAG: ${{ inputs.version || github.ref_name }} + + steps: + - name: Set version to tag without leading v + run: | + echo "VERSION=${TAG#v}" >> $GITHUB_ENV + + - name: Checkout code-server-aur repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + repository: "cdrci/code-server-aur" + token: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} + ref: "master" + + - name: Configure git + run: | + git config --global user.name cdrci + git config --global user.email opensource@coder.com + + - name: Fetch and reset master + run: | + git remote add upstream https://github.com/coder/code-server-aur.git + git fetch upstream + git reset --hard upstream/master + git push --force + + - name: Validate package + uses: heyhusen/archlinux-package-action@3f7aaada28c782497bfe02d6d6ea365b25fdea12 # v3.0.1 + with: + pkgver: ${{ env.VERSION }} + updpkgsums: true + srcinfo: true + + - name: Open PR + run: | + git checkout -b update-version-${{ env.VERSION }} + git add . + git commit -m "Update to ${{ env.VERSION }}" + git push -u origin $(git branch --show) + gh pr create --repo coder/code-server-aur --title "Update to ${{ env.VERSION }}" --body "PR opened by @$GITHUB_ACTOR" --assignee $GITHUB_ACTOR + + docker: + runs-on: ubuntu-latest + env: + GITHUB_TOKEN: ${{ github.token }} + TAG: ${{ inputs.version || github.ref_name }} + + steps: + - name: Set version to tag without leading v + run: | + echo "VERSION=${TAG#v}" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + - uses: docker/setup-qemu-action@1f40c72289eff860ee54a304f1438e3cff362e0a # v4.3.0 + - uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1 + + - uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + - uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - uses: robinraju/release-downloader@28fc21f50d76778e7023361aa1f863e717d3d56f # v1.13 + with: + repository: "coder/code-server" + tag: v${{ env.VERSION }} + fileName: "*.deb" + out-file-path: "release-packages" + - uses: robinraju/release-downloader@28fc21f50d76778e7023361aa1f863e717d3d56f # v1.13 + with: + repository: "coder/code-server" + tag: v${{ env.VERSION }} + fileName: "*.rpm" + out-file-path: "release-packages" + + - run: npm run publish:docker + + repo: + runs-on: ubuntu-latest + env: + GH_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} + TAG: ${{ inputs.version || github.ref_name }} + needs: docker + + steps: + - name: Set version to tag without leading v + run: | + echo "VERSION=${TAG#v}" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - run: ./ci/build/update-repo.sh + + - name: Open PR + run: | + git config --global user.name cdrci + git config --global user.email opensource@coder.com + git checkout -b "helm/$VERSION" + git add . + git commit -m "Update Helm chart and changelog with $VERSION" + git push -u origin "$(git branch --show)" + gh pr create \ + --repo coder/code-server \ + --body-file .cache/checklist \ + --title "Update Helm chart and changelog with $VERSION" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 000000000000..7d24603a9ae6 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,356 @@ +name: Draft release + +on: + workflow_dispatch: + inputs: + version: + type: string + required: true + pull_request_target: + types: + - closed + branches: + - main + +permissions: + contents: write # For creating releases. + discussions: write # For creating a discussion. + +# Cancel in-progress runs for pull requests when developers push +# additional changes +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +jobs: + package-linux: + name: ${{ format('linux-{0}', matrix.vscode_arch) }} + runs-on: ubuntu-22.04 + if: >- + (github.event_name == 'workflow_dispatch') || + (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true && startsWith(github.head_ref, 'update/')) + + strategy: + matrix: + include: + - npm_arch: x64 + vscode_arch: x64 + package_arch: amd64 + - npm_arch: arm64 + vscode_arch: arm64 + package_arch: arm64 + + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ELECTRON_SKIP_BINARY_DOWNLOAD: 1 + PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1 + TAG: ${{ inputs.version || github.event.pull_request.head.ref || github.ref_name }} + # Set release package name. + ARCH: ${{ matrix.package_arch }} + # Cross-compile target. + VSCODE_ARCH: ${{ matrix.vscode_arch }} + npm_config_arch: ${{ matrix.npm_arch }} + # Ensure native modules are built from source to avoid prebuilds and use + # the correct version of glibc. + npm_config_build_from_source: true + # Gulp target name. + # TODO: Pull from VSCODE_ARCH instead. + VSCODE_TARGET: ${{ format('linux-{0}', matrix.vscode_arch) }} + + steps: + - run: sudo apt update && sudo apt install -y libkrb5-dev + - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # latest + with: + packages: quilt + version: 1.0 + - name: Install nfpm + run: | + mkdir -p ~/.local/bin + curl -sSfL https://github.com/goreleaser/nfpm/releases/download/v2.3.1/nfpm_2.3.1_`uname -s`_`uname -m`.tar.gz | tar -C ~/.local/bin -zxv nfpm + echo "$HOME/.local/bin" >> $GITHUB_PATH + + - name: Strip update/ and v from tag and set major version + run: | + version=${TAG#update/} + version=${version#v} + version=4${version:1} + echo "VERSION=$version" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + submodules: true + # When an update/ branch is merged, a release is automatically created + # which requires secrets. + allow-unsafe-pr-checkout: true + - run: quilt push -a + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + + - name: Build + run: | + cd lib/vscode/build + npm ci + cd .. + source ./build/azure-pipelines/linux/setup-env.sh + # Run preinstall script before root dependencies are installed + # so that v8 headers are patched correctly for native modules. + node build/npm/preinstall.ts + cd ../.. + npm ci + npm run build + npm run build:vscode + + # Platform-agnostic NPM package. + - run: npm run release + if: ${{ matrix.vscode_arch == 'x64' }} + - run: tar -czf package.tar.gz release + if: ${{ matrix.vscode_arch == 'x64' }} + - run: | + sed "/^## Unreleased/,/^## / ! d" CHANGELOG.md | head -n -2 | tail -n +3 > .cache/release-notes + if: ${{ matrix.vscode_arch == 'x64' }} + - uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3 + if: ${{ matrix.vscode_arch == 'x64' }} + with: + draft: true + discussion_category_name: "📣 Announcements" + files: package.tar.gz + tag_name: v${{ env.VERSION }} + name: v${{ env.VERSION }} + body_path: .cache/release-notes + + # Platform-specific release. + - run: KEEP_MODULES=1 npm run release + - run: npm run package + - uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3 + with: + draft: true + discussion_category_name: "📣 Announcements" + files: ./release-packages/* + tag_name: v${{ env.VERSION }} + name: v${{ env.VERSION }} + + package-macos: + name: ${{ matrix.vscode_target }} + runs-on: ${{ matrix.os }} + if: >- + (github.event_name == 'workflow_dispatch') || + (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true && startsWith(github.head_ref, 'update/')) + strategy: + matrix: + include: + - os: macos-15-intel + vscode_target: darwin-x64 + - os: macos-latest + vscode_target: darwin-arm64 + env: + VSCODE_TARGET: ${{ matrix.vscode_target }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + TAG: ${{ inputs.version || github.event.pull_request.head.ref || github.ref_name }} + # Ensure native modules are built from source to avoid prebuilds. + npm_config_build_from_source: true + + steps: + # The version of node-gyp we use depends on distutils but it was removed + # in Python 3.12. It seems to be fixed in the latest node-gyp so when we + # next update Node we can probably remove this. For now, install + # setuptools since it contains distutils. + - run: brew install python-setuptools quilt + - name: Install nfpm + run: | + mkdir -p ~/.local/bin + curl -sSfL https://github.com/goreleaser/nfpm/releases/download/v2.3.1/nfpm_2.3.1_`uname -s`_`uname -m`.tar.gz | tar -C ~/.local/bin -zxv nfpm + echo "$HOME/.local/bin" >> $GITHUB_PATH + + - name: Strip update/ and v from tag and set major version + run: | + version=${TAG#update/} + version=${version#v} + version=4${version:1} + echo "VERSION=$version" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + submodules: true + # When an update/ branch is merged, a release is automatically created + # which requires secrets. + allow-unsafe-pr-checkout: true + - run: quilt push -a + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + + - run: npm ci + - run: npm run build + - run: npm run build:vscode + - run: KEEP_MODULES=1 npm run release + - run: npm run test:native + + - run: npm run package + - uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3 + with: + draft: true + discussion_category_name: "📣 Announcements" + files: ./release-packages/* + tag_name: v${{ env.VERSION }} + name: v${{ env.VERSION }} + + package-windows: + name: win32-x64 + runs-on: windows-2022 + if: >- + (github.event_name == 'workflow_dispatch') || + (github.event_name == 'pull_request_target' && github.event.pull_request.merged == true && startsWith(github.head_ref, 'update/')) + + defaults: + run: + shell: bash + + env: + VSCODE_TARGET: win32-x64 + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + TAG: ${{ inputs.version || github.event.pull_request.head.ref || github.ref_name }} + # Ensure native modules are built from source to avoid prebuilds. + npm_config_build_from_source: true + OS: windows + + steps: + # Git rewrites line endings on windows by default, which turns every + # shell script the build is made of into one bash cannot read, and + # every name in patches/series into one with a stray return. + - name: Keep line endings as they are in the repository + run: git config --global core.autocrlf false + + - name: Strip update/ and v from tag and set major version + run: | + version=${TAG#update/} + version=${version#v} + version=4${version:1} + echo "VERSION=$version" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + submodules: true + # When an update/ branch is merged, a release is automatically created + # which requires secrets. + allow-unsafe-pr-checkout: true + + # quilt has no windows build. The patches are ordinary -p1 diffs + # against the repository root, so git applies them in series order. + - name: Apply patches + run: | + while read -r patch; do + case "$patch" in '' | '#'*) continue ;; esac + echo "applying $patch" + git apply --whitespace=nowarn "patches/$patch" + done < patches/series + + - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + cache: npm + cache-dependency-path: | + package-lock.json + test/package-lock.json + + # npm hands every script it runs to cmd, which cannot run the shell + # scripts this repository is built out of. Point it at the same bash + # the steps here use rather than at a path, which moves between + # images. + - name: Let npm run shell scripts + run: echo "npm_config_script_shell=$(cygpath -w "$(command -v bash)")" >> $GITHUB_ENV + + # The build merges json by handing jq a process substitution, which + # bash presents as a file under /dev/fd. The jq on this image is a + # windows program and cannot open those, so it reads the second input + # as nothing and the merge fails. Both the product and the package + # merge go through here. + - name: Let jq read what bash hands it + run: | + mkdir -p "$RUNNER_TEMP/shim" + cat > "$RUNNER_TEMP/shim/jq" <<'SHIM' + #!/usr/bin/env bash + set -euo pipefail + args=() + for arg in "$@"; do + case $arg in + /dev/fd/* | /proc/*/fd/*) + copy=$(mktemp) + cat "$arg" > "$copy" + args+=("$copy") + ;; + *) args+=("$arg") ;; + esac + done + exec jq.exe "${args[@]}" + SHIM + chmod +x "$RUNNER_TEMP/shim/jq" + echo "$RUNNER_TEMP/shim" >> $GITHUB_PATH + + # Stamping version details into the native binaries clears any + # signature they arrived with and asks signtool whether there is one. + # That only reads and removes, so it wants no certificate and signs + # nothing. It just has to be findable, and the sdk carrying it is not + # on the path. + - name: Put signtool on the path + run: | + sdk=$(ls -d "/c/Program Files (x86)/Windows Kits/10/bin"/*/x64 | sort -V | tail -1) + test -x "$sdk/signtool.exe" + cygpath -w "$sdk" >> $GITHUB_PATH + + # build-release.sh copies the tree with rsync, which neither windows + # nor the git bash on this image has. MSYS2 is already here, just not + # on the path. + - name: Install rsync + shell: cmd + run: C:\msys64\usr\bin\pacman -Sy --noconfirm --needed rsync + + # Only rsync crosses over. Putting msys2's /usr/bin in front instead + # breaks the release step: npm on the path is a shell script whose + # shebang reads /usr/bin/env bash, so with msys2 first it is msys2's + # bash that runs it, and crossing into a second msys runtime does not + # carry the environment. npm then sees no script-shell and falls back + # to cmd, which cannot run ./ci/build/build-release.sh, and + # KEEP_MODULES is dropped on the way. A forwarder avoids the whole + # class: rsync is a native exe that loads its runtime from beside + # itself, and nothing else on the path moves. + - name: Reach rsync without moving the path + run: | + cat > "$RUNNER_TEMP/shim/rsync" <<'SHIM' + #!/usr/bin/env bash + exec /c/msys64/usr/bin/rsync.exe "$@" + SHIM + chmod +x "$RUNNER_TEMP/shim/rsync" + + - run: npm ci + - run: npm run build + - run: npm run build:vscode + - run: KEEP_MODULES=1 npm run release + + # Of the two tars on this image it is git bash's GNU one that can + # rename the tree's top directory as it archives; the windows bsdtar + # is built without substitution support. Asserted rather than + # assumed, since the two are interchangeable everywhere except here. + - name: Package + run: | + case "$(tar --version | head -1)" in + *GNU*) ;; + *) echo "expected GNU tar for --transform, got $(tar --version | head -1)" >&2; exit 1 ;; + esac + npm run package + + - uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2 + with: + draft: true + discussion_category_name: "📣 Announcements" + files: ./release-packages/* + tag_name: v${{ env.VERSION }} + name: v${{ env.VERSION }} diff --git a/.github/workflows/scripts.yaml b/.github/workflows/scripts.yaml new file mode 100644 index 000000000000..180975866b12 --- /dev/null +++ b/.github/workflows/scripts.yaml @@ -0,0 +1,67 @@ +name: Script unit tests + +on: + push: + branches: + - main + paths: + - "**.sh" + - "**.bats" + pull_request: + branches: + - main + paths: + - "**.sh" + - "**.bats" + +permissions: + actions: none + checks: none + contents: read + deployments: none + issues: none + packages: none + pull-requests: none + repository-projects: none + security-events: none + statuses: none + +# Cancel in-progress runs for pull requests when developers push +# additional changes, and serialize builds in branches. +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-concurrency-to-cancel-any-in-progress-job-or-run +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +jobs: + test: + name: Run script unit tests + runs-on: ubuntu-latest + # This runs on Alpine to make sure we're testing with actual sh. + container: "alpine:3.17" + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Install test utilities + run: apk add bats checkbashisms + + - name: Check Bashisms + run: checkbashisms ./install.sh + + - name: Run script unit tests + run: ./ci/dev/test-scripts.sh + + lint: + name: Lint shell files + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Install lint utilities + run: sudo apt install shellcheck + + - name: Lint shell files + run: ./ci/dev/lint-scripts.sh diff --git a/.github/workflows/security.yaml b/.github/workflows/security.yaml new file mode 100644 index 000000000000..362b68a9dccb --- /dev/null +++ b/.github/workflows/security.yaml @@ -0,0 +1,92 @@ +name: Security + +on: + push: + branches: [main] + paths: + - "package.json" + pull_request: + paths: + - "package.json" + schedule: + # Runs every Monday morning PST + - cron: "17 15 * * 1" + +# Cancel in-progress runs for pull requests when developers push additional +# changes, and serialize builds in branches. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.event_name == 'pull_request' }} + +jobs: + audit: + name: Audit node modules + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + fetch-depth: 0 + + - name: Install Node.js + uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v6 + with: + node-version-file: .node-version + + - name: Audit npm for vulnerabilities + run: npm audit + if: success() + + trivy-scan-repo: + name: Scan repo with Trivy + permissions: + contents: read # for actions/checkout to fetch code + security-events: write # for github/codeql-action/upload-sarif to upload SARIF results + runs-on: ubuntu-22.04 + steps: + - name: Checkout repo + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + fetch-depth: 0 + + - name: Run Trivy vulnerability scanner in repo mode + uses: aquasecurity/trivy-action@d2a0b60797ff03db6132bd4e2b293f9b37081297 # latest + with: + scan-type: "fs" + scan-ref: "." + ignore-unfixed: true + format: "template" + template: "@/contrib/sarif.tpl" + output: "trivy-repo-results.sarif" + severity: "HIGH,CRITICAL" + + - name: Upload Trivy scan results to GitHub Security tab + uses: github/codeql-action/upload-sarif@5595ccaf912efad79be6eef63a5619ff05969be3 # v4 + with: + sarif_file: "trivy-repo-results.sarif" + + codeql-analyze: + permissions: + actions: read # for github/codeql-action/init to get workflow details + contents: read # for actions/checkout to fetch code + security-events: write # for github/codeql-action/autobuild to send a status report + name: Analyze with CodeQL + runs-on: ubuntu-22.04 + + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2 + with: + config-file: ./.github/codeql-config.yml + languages: javascript + + - name: Autobuild + uses: github/codeql-action/autobuild@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2 diff --git a/.github/workflows/trivy-docker.yaml b/.github/workflows/trivy-docker.yaml new file mode 100644 index 000000000000..7ad57f8dc34f --- /dev/null +++ b/.github/workflows/trivy-docker.yaml @@ -0,0 +1,63 @@ +name: Trivy Nightly Docker Scan + +on: + # Run scans if the workflow is modified, in order to test the + # workflow itself. This results in some spurious notifications, + # but seems okay for testing. + pull_request: + branches: + - main + paths: + - .github/workflows/trivy-docker.yaml + + # Run scans against master whenever changes are merged. + push: + branches: + - main + paths: + - .github/workflows/trivy-docker.yaml + + schedule: + - cron: "15 10 * * *" + + workflow_dispatch: + +permissions: + actions: none + checks: none + contents: read + deployments: none + issues: none + packages: none + pull-requests: none + repository-projects: none + security-events: write + statuses: none + +# Cancel in-progress runs for pull requests when developers push +# additional changes, and serialize builds in branches. +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-concurrency-to-cancel-any-in-progress-job-or-run +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + +jobs: + trivy-scan-image: + runs-on: ubuntu-22.04 + + steps: + - name: Checkout code + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + + - name: Run Trivy vulnerability scanner in image mode + uses: aquasecurity/trivy-action@d2a0b60797ff03db6132bd4e2b293f9b37081297 # latest + with: + image-ref: "docker.io/codercom/code-server:latest" + ignore-unfixed: true + format: "sarif" + output: "trivy-image-results.sarif" + severity: "HIGH,CRITICAL" + + - name: Upload Trivy scan results to GitHub Security tab + uses: github/codeql-action/upload-sarif@5595ccaf912efad79be6eef63a5619ff05969be3 # v4 + with: + sarif_file: "trivy-image-results.sarif" diff --git a/.github/workflows/update.yaml b/.github/workflows/update.yaml new file mode 100644 index 000000000000..b54826c79f70 --- /dev/null +++ b/.github/workflows/update.yaml @@ -0,0 +1,72 @@ +name: Update code-server + +on: + workflow_dispatch: + inputs: + version: + type: string + required: true + schedule: + - cron: "0 16,21 * * *" + +jobs: + update: + runs-on: ubuntu-latest + env: + TAG: ${{ inputs.version }} + GH_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} + + steps: + - name: Fetch latest tag + if: env.TAG == '' + run: | + tag=$(curl -fsSLI -o /dev/null -w "%{url_effective}" https://github.com/microsoft/vscode/releases/latest) + tag="${tag#https://github.com/microsoft/vscode/releases/tag/}" + echo "TAG=$tag" >> $GITHUB_ENV + + - name: Remove leading v from tag + run: | + echo "VERSION=${TAG#v}" >> $GITHUB_ENV + + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v6 + with: + submodules: true + + - name: Check current version + id: check + run: | + commit="$(git -C lib/vscode rev-parse HEAD)" + if [[ $(git -C lib/vscode ls-remote --tags | grep "$commit") == */"$VERSION" ]] ; then + echo "$VERSION update has already been merged into $(git rev-parse --abbrev-ref HEAD)" + echo done=true >> $GITHUB_OUTPUT + elif git ls-remote --exit-code --heads origin "update/$VERSION" ; then + echo "There is already a PR for updating to $VERSION" + echo done=true >> $GITHUB_OUTPUT + else + echo "$VERSION update has not started yet" + echo done=false >> $GITHUB_OUTPUT + fi + + - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # latest + if: steps.check.outputs.done == 'false' + with: + packages: quilt + version: 1.0 + + - run: ./ci/build/update-vscode.sh + if: steps.check.outputs.done == 'false' + + - name: Open PR + if: steps.check.outputs.done == 'false' + run: | + git config --global user.name cdrci + git config --global user.email opensource@coder.com + git checkout -b "update/$VERSION" + git add . + git commit -m "Update Code to $VERSION" + git push -u origin "$(git branch --show)" + gh pr create \ + --repo coder/code-server \ + --title "Update Code to $VERSION" \ + --body-file .cache/checklist \ + --draft diff --git a/.gitignore b/.gitignore index 92c07dafd5a5..7fea491b82ac 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,24 @@ +.tsbuildinfo +.cache +/out*/ +release/ +release-packages/ +release-gcp/ +release-images/ node_modules -build -release +/plugins +/lib/coder-cloud-agent +.home +coverage +**/.DS_Store +*.bak + +# Code packages itself here. +/lib/vscode-reh-web-* + +# Failed e2e test videos are saved here +test/test-results + +# Quilt's internal data. +/.pc +/patches/*.diff~ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000000..9854a1b1dd30 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "lib/vscode"] + path = lib/vscode + url = https://github.com/microsoft/vscode diff --git a/.node-version b/.node-version index 5007551bf8c7..df6ae3370f9f 100644 --- a/.node-version +++ b/.node-version @@ -1 +1 @@ -10.16.0 +24.21.0 diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 5fca0d518be7..000000000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -scripts-prepend-node-path=true diff --git a/.nvmrc b/.nvmrc new file mode 120000 index 000000000000..070266a2687d --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +.node-version \ No newline at end of file diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 000000000000..40cfb028f4d0 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,8 @@ +lib +release-packages +release +helm-chart +test/scripts +test/e2e/extensions/test-extension +.pc +package-lock.json diff --git a/.prettierrc.yaml b/.prettierrc.yaml new file mode 100644 index 000000000000..b6114bf4613b --- /dev/null +++ b/.prettierrc.yaml @@ -0,0 +1,6 @@ +printWidth: 120 +semi: false +trailingComma: all +arrowParens: always +singleQuote: false +useTabs: false diff --git a/.tours/contributing.tour b/.tours/contributing.tour new file mode 100644 index 000000000000..aaff2b500c99 --- /dev/null +++ b/.tours/contributing.tour @@ -0,0 +1,151 @@ +{ + "$schema": "https://aka.ms/codetour-schema", + "title": "Contributing", + "steps": [ + { + "directory": "src", + "line": 1, + "description": "Hello world! code-server's source code lives here in `src` (see the explorer). It's broadly arranged into browser code, Node code, and code shared between both." + }, + { + "file": "src/node/entry.ts", + "line": 157, + "description": "code-server begins execution here. CLI arguments are parsed, special flags like --help are handled, then the HTTP server is started." + }, + { + "file": "src/node/cli.ts", + "line": 28, + "description": "This describes all of the code-server CLI options and how they will be parsed." + }, + { + "file": "src/node/cli.ts", + "line": 233, + "description": "Here's the actual CLI parser." + }, + { + "file": "src/node/settings.ts", + "line": 1, + "description": "code-server maintains a settings file that is read and written here." + }, + { + "file": "src/node/app.ts", + "line": 11, + "description": "The core of code-server are HTTP and web socket servers which are created here. They provide authentication, file access, an API, and serve web-based applications like VS Code." + }, + { + "file": "src/node/wsRouter.ts", + "line": 38, + "description": "This is an analog to Express's Router that handles web socket routes." + }, + { + "file": "src/node/http.ts", + "line": 1, + "description": "This file provides various HTTP utility functions." + }, + { + "file": "src/node/coder_cloud.ts", + "line": 9, + "description": "The cloud agent spawned here provides the --link functionality." + }, + { + "file": "src/node/heart.ts", + "line": 7, + "description": "code-server's heart beats to indicate recent activity.\n\nAlso documented here: [https://github.com/coder/code-server/blob/main/docs/FAQ.md#heartbeat-file](https://github.com/coder/code-server/blob/main/docs/FAQ.md#heartbeat-file)" + }, + { + "file": "src/node/socket.ts", + "line": 13, + "description": "We pass sockets to child processes, however we can't pass TLS sockets so when code-server is handling TLS (via --cert) we use this to create a proxy that can be passed to the child." + }, + { + "directory": "src/node/routes", + "line": 1, + "description": "code-server's routes live here in `src/node/routes` (see the explorer)." + }, + { + "file": "src/node/routes/index.ts", + "line": 123, + "description": "The architecture of code-server allows it to be extended with applications via plugins. Each application is registered at its own route and handles requests at and below that route. Currently we have only VS Code (although it is not yet actually split out into a plugin)." + }, + { + "file": "src/node/plugin.ts", + "line": 103, + "description": "The previously mentioned plugins are loaded here." + }, + { + "file": "src/node/routes/apps.ts", + "line": 12, + "description": "This provides a list of the applications registered with code-server." + }, + { + "file": "src/node/routes/domainProxy.ts", + "line": 18, + "description": "code-server provides a built-in proxy to help in developing web-based applications. This is the code for the domain-based proxy.\n\nAlso documented here: [https://github.com/coder/code-server/blob/main/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/coder/code-server/blob/main/docs/FAQ.md#how-do-i-securely-access-web-services)" + }, + { + "file": "src/node/routes/pathProxy.ts", + "line": 19, + "description": "Here is the path-based version of the proxy.\n\nAlso documented here: [https://github.com/coder/code-server/blob/main/docs/FAQ.md#how-do-i-securely-access-web-services](https://github.com/coder/code-server/blob/main/docs/FAQ.md#how-do-i-securely-access-web-services)" + }, + { + "file": "src/node/proxy.ts", + "line": 4, + "description": "Both the domain and path proxy use the single proxy instance created here." + }, + { + "file": "src/node/routes/health.ts", + "line": 5, + "description": "A simple endpoint that lets you see if code-server is up.\n\nAlso documented here: [https://github.com/coder/code-server/blob/main/docs/FAQ.md#healthz-endpoint](https://github.com/coder/code-server/blob/main/docs/FAQ.md#healthz-endpoint)" + }, + { + "file": "src/node/routes/login.ts", + "line": 46, + "description": "code-server supports a password-based login here." + }, + { + "file": "src/node/routes/static.ts", + "line": 16, + "description": "This serves static assets. Anything under the code-server directory can be fetched. Anything outside requires authentication." + }, + { + "file": "src/node/routes/update.ts", + "line": 10, + "description": "This endpoint lets you query for the latest code-server version. It's used to power the update popup you see in VS Code." + }, + { + "file": "src/node/routes/vscode.ts", + "line": 15, + "description": "This is the endpoint that serves VS Code's HTML, handles VS Code's websockets, and handles a few VS Code-specific endpoints for fetching static files." + }, + { + "file": "src/node/vscode.ts", + "line": 13, + "description": "The actual VS Code spawn and initialization is handled here. VS Code runs in a separate child process. We communicate via IPC and by passing it web sockets." + }, + { + "file": "src/browser/serviceWorker.ts", + "line": 1, + "description": "The service worker only exists to provide PWA functionality." + }, + { + "directory": "src/browser/pages", + "line": 1, + "description": "HTML, CSS, and JavaScript for each page lives in here `src/browser/pages` (see the explorer). Currently our HTML uses a simple search and replace template system with variables that {{LOOK_LIKE_THIS}}." + }, + { + "file": "src/browser/pages/vscode.html", + "line": 1, + "description": "The VS Code HTML is based off VS Code's own `workbench.html`." + }, + { + "directory": "src/browser/media", + "line": 1, + "description": "Static images and the manifest live here in `src/browser/media` (see the explorer)." + }, + { + "directory": "lib/vscode", + "line": 1, + "description": "code-server makes use of VS Code's frontend web/remote support. Most of the modifications implement the remote server since that portion of the code is closed source and not released with VS Code.\n\nWe also have a few bug fixes and have added some features (like client-side extensions). See [https://github.com/coder/code-server/blob/main/docs/CONTRIBUTING.md#modifications-to-vs-code](https://github.com/coder/code-server/blob/main/docs/CONTRIBUTING.md#modifications-to-vs-code) for a list.\n\nWe make an effort to keep the modifications as few as possible." + } + ] +} diff --git a/.tours/start-development.tour b/.tours/start-development.tour new file mode 100644 index 000000000000..999adba06125 --- /dev/null +++ b/.tours/start-development.tour @@ -0,0 +1,26 @@ +{ + "$schema": "https://aka.ms/codetour-schema", + "title": "Start Development", + "steps": [ + { + "file": "package.json", + "line": 31, + "description": "## Commands\n\nTo start developing, make sure you have Node 16+ and the [required dependencies](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites) installed. Then, run the following commands:\n\n1. Install dependencies:\n>> npm\n\n3. Start development mode (and watch for changes):\n>> npm run watch" + }, + { + "file": "src/node/app.ts", + "line": 68, + "description": "## Visit the web server\n\nIf all goes well, you should see something like this in your terminal. code-server should be live in development mode.\n\n---\n```bash\n[2020-12-09T21:03:37.156Z] info code-server 3.7.4 development\n[2020-12-09T21:03:37.157Z] info Using user-data-dir ~/.local/share/code-server\n[2020-12-09T21:03:37.165Z] info Using config file ~/.config/code-server/config.yaml\n[2020-12-09T21:03:37.165Z] info HTTP server listening on http://127.0.0.1:8080 \n[2020-12-09T21:03:37.165Z] info - Authentication is enabled\n[2020-12-09T21:03:37.165Z] info - Using password from ~/.config/code-server/config.yaml\n[2020-12-09T21:03:37.165Z] info - Not serving HTTPS\n```\n\n---\n\nIf you have the default configuration, you can access it at [http://localhost:8080](http://localhost:8080)." + }, + { + "file": "src/browser/pages/login.html", + "line": 26, + "description": "## Make a change\n\nThis is the login page, let's make a change and see it update on our web server! Perhaps change the text :)\n\n```html\n
Modifying the login page 👨🏼‍💻
\n```\n\nReminder, you can likely preview at [http://localhost:8080](http://localhost:8080)" + }, + { + "file": "src/node/app.ts", + "line": 62, + "description": "## That's it!\n\n\nThat's all there is to it! When this tour ends, your terminal session may stop, but just use `npm run watch` to start developing from here on out!\n\n\nIf you haven't already, be sure to check out these resources:\n- [Tour: Contributing](command:codetour.startTourByTitle?[\"Contributing\"])\n- [Docs: FAQ.md](https://github.com/coder/code-server/blob/main/docs/FAQ.md)\n- [Docs: CONTRIBUTING.md](https://github.com/coder/code-server/blob/main/docs/CONTRIBUTING.md)\n- [Community: GitHub Discussions](https://github.com/coder/code-server/discussions)\n- [Community: Slack](https://community.coder.com)" + } + ] +} diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8b9b003fa063..000000000000 --- a/.travis.yml +++ /dev/null @@ -1,80 +0,0 @@ -language: node_js -node_js: - - 10.16.0 -services: - - docker - -before_install: - - export MAJOR_VERSION="2" - - export VSCODE_VERSION="1.38.1" - - export VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER" - - export TAG="$VERSION-vsc$VSCODE_VERSION" - - if [[ "$TRAVIS_BRANCH" == "master" ]]; then export MINIFY="true"; fi - - if [[ "$TRAVIS_BRANCH" == "master" ]]; then export PACKAGE="true"; fi - -# Don't build on tags because we'll already have built the commit. -jobs: - include: - - name: "Linux build" - os: linux - dist: trusty - env: TARGET="linux" - if: tag IS blank - script: scripts/ci.bash - - name: "Alpine build" - os: linux - dist: trusty - env: TARGET="alpine" - if: tag IS blank - script: scripts/ci.bash - - name: "MacOS build" - os: osx - if: tag IS blank - script: travis_wait 30 scripts/ci.bash - - name: "Docker build" - os: linux - dist: trusty - env: DOCKER_BUILD="true" - if: branch == master AND tag IS blank - script: docker build --build-arg githubToken="$GITHUB_TOKEN" --build-arg codeServerVersion="$VERSION" --build-arg vscodeVersion="$VSCODE_VERSION" -t codercom/code-server:"$TAG" -t codercom/code-server:v2 . - -git: - depth: 3 - -before_deploy: - - echo "$TAG" "$TRAVIS_COMMIT" - - git config --local user.name "$USER_NAME" - - git config --local user.email "$USER_EMAIL" - - if ! git tag "$TAG" "$TRAVIS_COMMIT" ; then echo "$TAG already exists"; fi - - if [[ -n "$DOCKER_BUILD" ]] ; then echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin ; fi - -deploy: - - provider: releases - file_glob: true - draft: true - tag_name: "$TAG" - target_commitish: "$TRAVIS_COMMIT" - name: "$TAG" - skip_cleanup: true - api_key: - secure: YL/x24KjYjgYXPcJWk3FV7FGxI79Mh6gBECQEcdlf3fkLEoKFVgzHBoUNWrFPzyR4tgLyWNAgcpD9Lkme1TRWTom7UPjXcwMNyLcLa+uec7ciSAnYD9ntLTpiCuPDD1u0LtRGclSi/EHQ+F8YVq+HZJpXTsJeAmOmihma3GVbGKSZr+BRum+0YZSG4w+o4TOlYzw/4bLWS52MogZcwpjd+hemBbgXLuGU2ziKv2vEKCZFbEeA16II4x1WLI4mutDdCeh7+3aLzGLwDa49NxtsVYNjyNFF75JhCTCNA55e2YMiLz9Uq69IXe/mi5F7xUaFfhIqqLNyKBnKeEOzu3dYnc+8n3LjnQ+00PmkF05nx9kBn3UfV1kwQGh6QbyDmTtBP07rtUMyI14aeQqHjxsaVRdMnwj9Q2DjXRr8UDqESZF0rmK3pHCXS2fBhIzLE8tLVW5Heiba2pQRFMHMZW+KBE97FzcFh7is90Ait3T8enfcd/PWFPYoBejDAdjwxwOkezh5N5ZkYquEfDYuWrFi6zRFCktsruaAcA+xGtTf9oilBBzUqu8Ie+YFWH5me83xakcblJWdaW/D2rLJAJH3m6LFm8lBqyUgDX5t/etob6CpDuYHu5D1J3XINOj/+aLAcadq6qlh70PMZS3zYffUu3JlzaD2amlSHIT8b5YXFc= - file: - - release/*.tar.gz - - release/*.zip - on: - repo: cdr/code-server - branch: master - - - provider: script - skip_cleanup: true - script: docker push codercom/code-server:"$TAG" ; docker push codercom/code-server:v2 - on: - repo: cdr/code-server - branch: master - condition: -n "$DOCKER_BUILD" - -cache: - yarn: true - timeout: 1000 - directories: - - .cache diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000000..e86bd3bea33c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,1653 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## Unreleased + +## [4.141.0](https://github.com/coder/code-server/releases/tag/v4.141.0) - 2026-10-08 + +Code v1.141.0 + +### Added + +- A new `--enable-remote-storage` flag can be used to make code-server persist + workbench storage on the remote server instead of browser storage. Use this if + you want to share storage between multiple devices. + +### Fixed + +- The Typescript extension was trying to load as a browser extension even though + we build the remote server version, causing it to fail to activate. + +### Changed + +- Update to Code 1.141.0 + +## [4.140.0](https://github.com/coder/code-server/releases/tag/v4.140.0) - 2026-10-02 + +Code v1.140.0 + +### Changed + +- Update to Code 1.140.0 + +## [4.139.1](https://github.com/coder/code-server/releases/tag/v4.139.1) - 2026-09-26 + +Code v1.139.1 + +### Changed + +- Update to Code 1.139.1 + +### Fixed + +- `--idle-timeout-seconds` was only validated when passed as + `--idle-timeout-seconds=`; values of 60 or less passed as + `--idle-timeout-seconds ` were silently accepted. + +## [4.138.0](https://github.com/coder/code-server/releases/tag/v4.138.0) - 2026-09-19 + +Code v1.138.0 + +### Changed + +- Update to Code 1.138.0 + +### Fixed + +- Preserve the original path, query parameters, and fragment when rewriting + localhost URLs through the port proxy. If `VSCODE_PROXY_URI` has any query + parameters or fragments, those will be lost. + +## [4.137.0](https://github.com/coder/code-server/releases/tag/v4.137.0) - 2026-09-11 + +Code v1.137.0 + +### Changed + +- Update to Code 1.137.0 + +## [4.136.2](https://github.com/coder/code-server/releases/tag/v4.136.2) - 2026-09-08 + +Code v1.136.1 + +### Changed + +- Update to Code 1.136.1 + +### Fixed + +- 4.136.2 replaces a removed 4.136.1 release that had the data path incorrectly + being set to `~/.vscode-server-oss/data`. + +## [4.135.0](https://github.com/coder/code-server/releases/tag/v4.135.0) - 2026-08-27 + +Code v1.135.0 + +### Changed + +- Update to Code 1.135.0 + +## [4.134.0](https://github.com/coder/code-server/releases/tag/v4.134.0) - 2026-08-24 + +Code v1.134.0 + +### Added + +- New `--socket-fd` flag that can be used to listen on a file descriptor. In + particular, this allows using code-server with systemd's socket activation. +- New `--vscode-option` repeatable flag that can be used to pass through options + to VS Code. It requires `flag=value` or simply `flag` for booleans. For + example: `--vscode-option enable-sandbox --vscode-option agents=true`. The + `VSCODE_OPTIONS` environment variable may also be used. For example: + `VSCODE_OPTIONS="enable-sandbox agents=true"`. Note that code-server simply + splits this variable on spaces and is not aware of quoting. + +### Changed + +- Update to Code 1.134.0 +- Remove `--unsafe-perm` from installation scripts. This flag results in an + error when used with npm since v12 and has been a no-op since v7. If you are + installing with a version of npm older than v7 as root, installation may not + work correctly. + +## [4.133.0](https://github.com/coder/code-server/releases/tag/v4.133.0) - 2026-08-17 + +Code v1.133.0 + +### Changed + +- Update to Code 1.133.0 + +## [4.132.0](https://github.com/coder/code-server/releases/tag/v4.132.0) - 2026-08-10 + +Code v1.132.0 + +### Changed + +- Update to Code 1.132.0 + +### Fixed + +- When proxying, cookies were being decoded and re-encoded, which could cause + issues for applications that encode differently. Cookies are now passed + through unchanged (aside from stripping out code-server's session token). + +## [4.131.0](https://github.com/coder/code-server/releases/tag/v4.131.0) - 2026-07-30 + +Code v1.131.0 + +### Changed + +- Update to Code 1.131.0 + +## [4.130.0](https://github.com/coder/code-server/releases/tag/v4.130.0) - 2026-07-24 + +Code v1.130.0 + +### Changed + +- Update to Code 1.130.0 + +## [4.129.0](https://github.com/coder/code-server/releases/tag/v4.129.0) - 2026-07-17 + +Code v1.129.0 + +### Changed + +- Update to Code 1.129.0 + +## [4.128.0](https://github.com/coder/code-server/releases/tag/v4.128.0) - 2026-07-11 + +Code v1.128.0 + +### Changed + +- Update to Code 1.128.0 + +## [4.127.0](https://github.com/coder/code-server/releases/tag/v4.127.0) - 2026-07-02 + +Code v1.127.0 + +### Changed + +- Update to Code 1.127.0 + +## [4.126.0](https://github.com/coder/code-server/releases/tag/v4.126.0) - 2026-06-24 + +Code v1.126.0 + +### Changed + +- Update to Code 1.126.0 + +## [4.125.0](https://github.com/coder/code-server/releases/tag/v4.125.0) - 2026-06-18 + +Code v1.125.0 + +### Changed + +- Update to Code 1.125.0 + +## [4.124.2](https://github.com/coder/code-server/releases/tag/v4.124.2) - 2026-06-16 + +Code v1.124.2 + +### Security + +- Strip code-server's session token from the cookie before proxying to a local + port. Previously, when you used built-in password authentication, the cookie + would be sent to the local proxied port, which meant if the service was + malicious and not already running as your code-server user it could use the + cookie to log into code-server and execute commands as your code-server user. + +### Changed + +- Update to Code 1.124.2 + +## [4.123.0](https://github.com/coder/code-server/releases/tag/v4.123.0) - 2026-06-03 + +Code v1.123.0 + +### Changed + +- Update to Code 1.123.0 +- Microsoft dropped support for armhf remotes so there will no longer be any + builds for armhf. + +## [4.122.1](https://github.com/coder/code-server/releases/tag/v4.122.1) - 2026-06-02 + +Code v1.122.1 + +### Changed + +- Update to Code 1.122.1 + +## [4.122.0](https://github.com/coder/code-server/releases/tag/v4.122.0) - 2026-05-29 + +Code v1.122.0 + +### Changed + +- Update to Code 1.122.0 + +### Fixed + +- `--app-name` will now affect window titles within the editor (it is now used + as the value for `${appName}` in the title template) as well as some other + places like the help > about dialog. + +### Added + +- App name can now be set with the `CODE_SERVER_APP_NAME` environment variable. + +## [4.121.0](https://github.com/coder/code-server/releases/tag/v4.121.0) - 2026-05-20 + +Code v1.121.0 + +### Changed + +- Update to Code 1.121.0 + +## [4.118.0](https://github.com/coder/code-server/releases/tag/v4.118.0) - 2026-05-06 + +Code v1.118.0 + +### Changed + +- Update to Code 1.118.0 + +## [4.117.0](https://github.com/coder/code-server/releases/tag/v4.117.0) - 2026-04-22 + +Code v1.117.0 + +### Changed + +- Update to Code 1.117.0 + +## [4.116.0](https://github.com/coder/code-server/releases/tag/v4.116.0) - 2026-04-16 + +Code v1.116.0 + +### Changed + +- Update to Code 1.116.0 + +## [4.115.0](https://github.com/coder/code-server/releases/tag/v4.115.0) - 2026-04-08 + +Code v1.115.0 + +### Changed + +- Update to Code 1.115.0 + +## [4.114.1](https://github.com/coder/code-server/releases/tag/v4.114.1) - 2026-04-06 + +Code v1.114.0 + +### Changed + +- Ensure native modules are built from source so they use the correct version of + glibc. This should bring down the requirement from 2.34 back down to 2.28. + +## [4.114.0](https://github.com/coder/code-server/releases/tag/v4.114.0) - 2026-04-04 + +Code v1.114.0 + +### Changed + +- Update to Code 1.114.0. + +## [4.113.1](https://github.com/coder/code-server/releases/tag/v4.113.1) - 2026-04-03 + +Code v1.113.0 + +This is a re-release of v4.113.0 but with the correct Node binaries for arm64 +and armv7l. Previously they were packaging the amd64 Node binary due to a +mistake while refactoring CI to use more of the upstream build scripts. + +## [4.113.0](https://github.com/coder/code-server/releases/tag/v4.113.0) - 2026-04-02 + +Code v1.113.0 + +### Changed + +- Update to Code 1.113.0 + +## [4.112.0](https://github.com/coder/code-server/releases/tag/v4.112.0) - 2026-03-19 + +Code v1.112.0 + +### Changed + +- Update to Code 1.112.0 + +## [4.111.0](https://github.com/coder/code-server/releases/tag/v4.111.0) - 2026-03-11 + +Code v1.111.0 + +### Changed + +- Update to Code 1.111.0 +- `--app-name` now affects the error page title. + +## [4.110.1](https://github.com/coder/code-server/releases/tag/v4.110.1) - 2026-03-10 + +Code v1.110.1 + +### Changed + +- Update to Code 1.110.1 + +## [4.110.0](https://github.com/coder/code-server/releases/tag/v4.110.0) - 2026-03-09 + +Code v1.110.0 + +### Changed + +- Update to Code 1.110.0 + +## [4.109.5](https://github.com/coder/code-server/releases/tag/v4.109.5) - 2026-03-02 + +Code v1.109.5 + +### Changed + +- Update to Code 1.109.5 + +## [4.109.2](https://github.com/coder/code-server/releases/tag/v4.109.2) - 2026-02-12 + +Code v1.109.2 + +### Changed + +- Update to Code 1.109.2 + +## [4.109.0](https://github.com/coder/code-server/releases/tag/v4.109.0) - 2026-02-12 + +Code v1.109.0 + +### Changed + +- Update to Code 1.109.0 + +## [4.108.2](https://github.com/coder/code-server/releases/tag/v4.108.2) - 2026-01-26 + +Code v1.108.2 + +### Changed + +- Update to Code 1.108.2 + +## [4.108.1](https://github.com/coder/code-server/releases/tag/v4.108.1) - 2026-01-16 + +Code v1.108.1 + +### Changed + +- Update to Code 1.108.1 + +## [4.108.0](https://github.com/coder/code-server/releases/tag/v4.108.0) - 2026-01-12 + +Code v1.108.0 + +### Changed + +- Update to Code 1.108.0 + +## [4.107.1](https://github.com/coder/code-server/releases/tag/v4.107.1) - 2026-01-09 + +Code v1.107.1 + +### Changed + +- Update to Code 1.107.1 + +## [4.107.0](https://github.com/coder/code-server/releases/tag/v4.107.0) - 2026-12-17 + +Code v1.107.0 + +### Changed + +- Update to Code 1.107.0 + +### Added + +- New `--cookie-suffix` flag that can be used to add a suffix to the cookie when + using the built-in password authentication. You can use this to avoid + collisions with other instances of code-server. +- Support a new property `authorizationHeaderToken` on the extension gallery + configuration. This will be added to marketplace requests as a bearer token + using the `Authorization` header. + +## [4.106.3](https://github.com/coder/code-server/releases/tag/v4.106.3) - 2025-12-01 + +Code v1.106.3 + +### Changed + +- Update to Code 1.106.3 + +## [4.106.2](https://github.com/coder/code-server/releases/tag/v4.106.2) - 2025-11-19 + +Code v1.106.2 + +### Changed + +- Update to Code 1.106.2 + +## [4.106.0](https://github.com/coder/code-server/releases/tag/v4.106.0) - 2025-11-19 + +Code v1.106.0 + +### Changed + +- Update to Code 1.106.0 + +## [4.105.1](https://github.com/coder/code-server/releases/tag/v4.105.1) - 2025-10-20 + +Code v1.105.1 + +### Changed + +- Update to Code 1.105.1 + +## [4.105.0](https://github.com/coder/code-server/releases/tag/v4.105.0) - 2025-10-17 + +Code v1.105.0 + +### Changed + +- Update to Code 1.105.0 + +## [4.104.3](https://github.com/coder/code-server/releases/tag/v4.104.3) - 2025-10-07 + +Code v1.104.3 + +### Changed + +- Update to Code 1.104.3. + +## [4.104.2](https://github.com/coder/code-server/releases/tag/v4.104.2) - 2025-09-26 + +Code v1.104.2 + +### Changed + +- Update to Code 1.104.2. + +## [4.104.1](https://github.com/coder/code-server/releases/tag/v4.104.1) - 2025-09-19 + +Code v1.104.1 + +### Changed + +- Update to Code 1.104.1. + +## [4.104.0](https://github.com/coder/code-server/releases/tag/v4.104.0) - 2025-09-15 + +Code v1.104.0 + +### Fixed + +- Fix "extension not found" errors from Open VSX when trying to install the + latest version of an extension. + +### Changed + +- Update to Code 1.104.0. + +## [4.103.2](https://github.com/coder/code-server/releases/tag/v4.103.2) - 2025-08-25 + +Code v1.103.2 + +### Changed + +- Update to Code 1.103.2. + +## [4.103.1](https://github.com/coder/code-server/releases/tag/v4.103.1) - 2025-08-15 + +Code v1.103.1 + +### Changed + +- Update to Code 1.103.1. + +## [4.103.0](https://github.com/coder/code-server/releases/tag/v4.103.0) - 2025-08-12 + +Code v1.103.0 + +### Changed + +- Update to Code 1.103.0. + +## [4.102.2](https://github.com/coder/code-server/releases/tag/v4.102.2) - 2025-07-24 + +Code v1.102.2 + +### Changed + +- Update to Code 1.102.2. + +## [4.102.1](https://github.com/coder/code-server/releases/tag/v4.102.1) - 2025-07-17 + +Code v1.102.1 + +### Changed + +- Update to Code 1.102.1. + +## [4.102.0](https://github.com/coder/code-server/releases/tag/v4.102.0) - 2025-07-16 + +Code v1.102.0 + +### Changed + +- Update to Code 1.102.0. + +### Added + +- Custom strings can be configured using the `--i18n` flag set to a JSON + file. This can be used for either translation (and can be used alongside + `--locale`) or for customizing the strings. See + [./src/node/i18n/locales/en.json](./src/node/i18n/locales/en.json) for the + available keys. + +## [4.101.2](https://github.com/coder/code-server/releases/tag/v4.101.2) - 2025-06-25 + +Code v1.101.2 + +### Changed + +- Update to Code 1.101.2. + +### Fixed + +- Fix web views not loading due to 401 when requesting the service worker. + +## [4.101.1](https://github.com/coder/code-server/releases/tag/v4.101.1) - 2025-06-20 + +Code v1.101.1 + +### Changed + +- Update to Code 1.101.1. + +## [4.101.0](https://github.com/coder/code-server/releases/tag/v4.101.0) - 2025-06-20 + +Code v1.101.0 + +### Changed + +- Update to Code 1.101.0. + +## [4.100.3](https://github.com/coder/code-server/releases/tag/v4.100.3) - 2025-06-03 + +Code v1.100.3 + +### Changed + +- Update to Code 1.100.3. + +## [4.100.2](https://github.com/coder/code-server/releases/tag/v4.100.2) - 2025-05-15 + +Code v1.100.2 + +### Changed + +- Update to Code 1.100.2. + +## [4.100.1](https://github.com/coder/code-server/releases/tag/v4.100.1) - 2025-05-13 + +Code v1.100.1 + +### Changed + +- Update to Code 1.100.1. + +## [4.100.0](https://github.com/coder/code-server/releases/tag/v4.100.0) - 2025-05-12 + +Code v1.100.0 + +### Added + +- Trusted domains for links can now be set at run-time by configuring + `linkProtectionTrustedDomains` in the `lib/vscode/product.json` file or via + the `--link-protection-trusted-domains` flag. + +### Changed + +- Update to Code 1.100.0. +- Disable extension signature verification, which previously was skipped by + default (the package used for verification is not available to OSS builds of + VS Code) but now reportedly throws hard errors making it impossible to install + extensions. + +### Fixed + +- Flags with repeatable options now work via the config file. + +## [4.99.4](https://github.com/coder/code-server/releases/tag/v4.99.4) - 2025-05-02 + +Code v1.99.3 + +### Security + +- Validate that ports in the path proxy are numbers, to prevent proxying to + arbitrary domains. + +## [4.99.3](https://github.com/coder/code-server/releases/tag/v4.99.3) - 2025-04-17 + +Code v1.99.3 + +### Added + +- Added `--skip-auth-preflight` flag to let preflight requests through the + proxy. + +### Changed + +- Update to Code 1.99.3. + +## [4.99.2](https://github.com/coder/code-server/releases/tag/v4.99.2) - 2025-04-10 + +Code v1.99.2 + +### Changed + +- Update to Code 1.99.2. + +## [4.99.1](https://github.com/coder/code-server/releases/tag/v4.99.1) - 2025-04-08 + +Code v1.99.1 + +### Changed + +- Update to Code 1.99.1. + +## [4.99.0](https://github.com/coder/code-server/releases/tag/v4.99.0) - 2025-04-07 + +Code v1.99.0 + +### Changed + +- Update to Code 1.99.0. + +## [4.98.0](https://github.com/coder/code-server/releases/tag/v4.98.0) - 2025-03-07 + +Code v1.98.0 + +### Changed + +- Update to Code 1.98.0. + +## [4.97.2](https://github.com/coder/code-server/releases/tag/v4.96.4) - 2025-02-18 + +Code v1.97.2 + +### Added + +- Added back macOS amd64 builds. + +### Changed + +- Update to Code 1.97.2. +- Softened dark mode login page colors. + +## [4.96.4](https://github.com/coder/code-server/releases/tag/v4.96.4) - 2025-01-20 + +Code v1.96.4 + +### Changed + +- Update to Code 1.96.4. + +## [4.96.2](https://github.com/coder/code-server/releases/tag/v4.96.2) - 2024-12-20 + +Code v1.96.2 + +### Changed + +- Update to Code 1.96.2. + +## [4.96.1](https://github.com/coder/code-server/releases/tag/v4.96.1) - 2024-12-18 + +Code v1.96.1 + +### Added + +- Dark color scheme for login and error pages. + +### Changed + +- Update to Code 1.96.1. + +## [4.95.3](https://github.com/coder/code-server/releases/tag/v4.95.3) - 2024-11-18 + +Code v1.95.3 + +### Changed + +- Update to Code 1.95.3. + +## [4.95.2](https://github.com/coder/code-server/releases/tag/v4.95.2) - 2024-11-12 + +Code v1.95.2 + +### Changed + +- Update to Code 1.95.2. + +## [4.95.1](https://github.com/coder/code-server/releases/tag/v4.95.1) - 2024-11-06 + +Code v1.95.1 + +### Changed + +- Update to Code 1.95.1. + +## [4.93.1](https://github.com/coder/code-server/releases/tag/v4.93.1) - 2024-09-23 + +Code v1.93.1 + +### Changed + +- Updated to Code 1.93.1. + +### Added + +- Added `--abs-proxy-base-path` flag for when code-server is not at the root. + +## [4.92.2](https://github.com/coder/code-server/releases/tag/v4.92.2) - 2024-08-19 + +Code v1.92.2 + +### Breaking changes + +- Dropped a patch that changed the compile target from es2022 to es2020 because + it no longer works with the way VS Code uses static properties. This may break + older browsers, so those browsers will either have to be updated or use an + older version of code-server. + +### Changed + +- Updated to Code 1.92.2. + +## [4.91.0](https://github.com/coder/code-server/releases/tag/v4.91.0) - 2024-07-10 + +Code v1.91.0 + +### Changed + +- Updated to Code 1.91.0. + +## [4.90.3](https://github.com/coder/code-server/releases/tag/v4.90.3) - 2024-06-21 + +Code v1.90.2 + +### Changed + +- Updated to Code 1.90.2. + +### Fixed + +- When the log gets rotated it will no longer incorrectly be moved to a new + directory created in the current working directory named with a date. + Instead, the file itself is prepended with the date and kept in the same + directory, as originally intended. + +## [4.90.2](https://github.com/coder/code-server/releases/tag/v4.90.2) - 2024-06-14 + +Code v1.90.1 + +### Changed + +- Updated to Code 1.90.1. + +## [4.90.1](https://github.com/coder/code-server/releases/tag/v4.90.1) - 2024-06-12 + +Code v1.90.0 + +### Fixed + +- Cache a call to get CPU information used in telemetry that could result in a + lack responsiveness if it was particularly slow. + +## [4.90.0](https://github.com/coder/code-server/releases/tag/v4.90.0) - 2024-06-11 + +Code v1.90.0 + +### Changed + +- Updated to Code 1.90.0. +- Updated Node to 20.11.1. + +### Added + +- Send contents to the clipboard in the integrated terminal by piping to + `code-server --stdin-to-clipboard` or `code-server -c`. + + You may want to make this an alias: + + ``` + alias xclip="code-server --stdin-to-clipboard" + echo -n "hello world" | xclip + ``` + +## [4.89.1](https://github.com/coder/code-server/releases/tag/v4.89.1) - 2024-04-14 + +Code v1.89.1 + +### Changed + +- Updated to Code 1.89.1. + +## [4.89.0](https://github.com/coder/code-server/releases/tag/v4.89.0) - 2024-04-08 + +Code v1.89.0 + +### Changed + +- Updated to Code 1.89.0. + +## [4.23.1](https://github.com/coder/code-server/releases/tag/v4.23.1) - 2024-04-15 + +Code v1.88.1 + +### Changed + +- Updated to Code 1.88.1. + +## [4.23.0](https://github.com/coder/code-server/releases/tag/v4.23.0) - 2024-04-08 + +Code v1.88.0 + +### Changed + +- Updated to Code 1.88.0. +- Updated Node to 18.18.2. + +### Fixed + +- Fix masking the exit code when failing to install extensions on the command + line outside the integrated terminal. Installing extensions inside the + integrated terminal still masks the exit code and is an upstream bug. + +## [4.22.1](https://github.com/coder/code-server/releases/tag/v4.22.1) - 2024-03-14 + +Code v1.87.2 + +### Changed + +- Updated to Code 1.87.2. +- Enable keep-alive for proxy agent. + +## [4.22.0](https://github.com/coder/code-server/releases/tag/v4.22.0) - 2024-03-03 + +Code v1.87.0 + +### Changed + +- Updated to Code 1.87.0. + +## [4.21.2](https://github.com/coder/code-server/releases/tag/v4.21.2) - 2024-02-28 + +Code v1.86.2 + +### Changed + +- Updated to Code 1.86.2. + +## [4.21.1](https://github.com/coder/code-server/releases/tag/v4.21.1) - 2024-02-09 + +Code v1.86.1 + +### Changed + +- Updated to Code 1.86.1. +- Updated to Node 18.17.1. + +### Added + +- Docker images for Fedora and openSUSE. + +## [4.21.0](https://github.com/coder/code-server/releases/tag/v4.21.0) - 2024-02-05 + +Code v1.86.0 + +### Changed + +- Updated to Code 1.86.0. + +## [4.20.1](https://github.com/coder/code-server/releases/tag/v4.20.1) - 2024-01-22 + +Code v1.85.2 + +### Changed + +- Updated to Code 1.85.2. + +### Fixed + +- Query variables are no longer double-encoded when going over the path proxy. + +## [4.20.0](https://github.com/coder/code-server/releases/tag/v4.20.0) - 2023-12-21 + +Code v1.85.1 + +### Added + +- New flag `--disable-file-uploads` to disable uploading files to the remote by + drag and drop and to disable opening local files via the "show local" button + in the file open prompt. Note that you can still open local files by drag and + dropping the file onto the editor pane. +- Added `wget` to the release image. + +### Changed + +- Updated to Code 1.85.1. +- The `--disable-file-downloads` flag will now disable the "show local" button + in the file save prompt as well. +- Debian release image updated to use Bookworm. + +## [4.19.1](https://github.com/coder/code-server/releases/tag/v4.19.1) - 2023-11-29 + +Code v1.84.2 + +### Fixed + +- Fixed an issue where parts of the editor would not load (like the file + explorer, source control, etc) when using a workspace file. + +## [4.19.0](https://github.com/coder/code-server/releases/tag/v4.19.0) - 2023-11-18 + +Code v1.84.2 + +### Changed + +- Updated to Code 1.84.2. + +## [4.18.0](https://github.com/coder/code-server/releases/tag/v4.18.0) - 2023-10-20 + +Code v1.83.1 + +### Changed + +- Updated to Code 1.83.1. + +## [4.17.1](https://github.com/coder/code-server/releases/tag/v4.17.1) - 2023-09-29 + +Code v1.82.2 + +### Fixed + +- Make secret storage persistent. For example, logging in with GitHub should + persist between browser refreshes and code-server restarts. +- Issues with argon2 on arm builds should be fixed now. + +## [4.17.0](https://github.com/coder/code-server/releases/tag/v4.17.0) - 2023-09-22 + +Code v1.82.2 + +### Added + +- Japanese locale. +- `CODE_SERVER_HOST` environment variable. + +### Changed + +- Update to Code 1.82.2. This includes an update to Node 18, which also means + that the minimum glibc is now 2.28. If you need to maintain a lower glibc then + you can take a version of Node 18 that is compiled with a lower glibc and use + that to build code-server (or at a minimum rebuild the native modules). +- Display paths to config files in full rather than abbreviated. If you have + trouble with the password not working please update and make sure the + displayed config paths are what you expect. + +### Fixed + +- Fix some dependency issues for the standalone arm64 and armv7l releases. If + you had issues with missing or failing modules please try these new builds. + +## [4.16.1](https://github.com/coder/code-server/releases/tag/v4.16.1) - 2023-07-31 + +Code v1.80.2 + +### Changed + +- Updated to Code 1.80.2. + +## [4.16.0](https://github.com/coder/code-server/releases/tag/v4.16.0) - 2023-07-28 + +Code v1.80.1 + +### Added + +- `--disable-proxy` flag. This disables the domain and path proxies but it does + not disable the ports panel in Code. That can be disabled by using + `remote.autoForwardPorts=false` in your settings. + +## [4.15.0](https://github.com/coder/code-server/releases/tag/v4.15.0) - 2023-07-21 + +Code v1.80.1 + +### Changed + +- Updated to Code 1.80.1. + +### Added + +- `--trusted-origin` flag for specifying origins that you trust but do not + control (for example a reverse proxy). + +Code v1.79.2 + +## [4.14.1](https://github.com/coder/code-server/releases/tag/v4.14.1) - 2023-06-26 + +Code v1.79.2 + +### Security + +- Remove extra write permissions on the Node binary bundled with the linux-amd64 + tarball. If you extract the tar without a umask this could mean the Node + binary would be unexpectedly writable. + +### Fixed + +- Inability to launch multiple instances of code-server for different users. + +### Added + +- `--session-socket` CLI flag to configure the location of the session socket. + By default it will be placed in `/code-server-ipc.sock`. + +## [4.14.0](https://github.com/coder/code-server/releases/tag/v4.14.0) - 2023-06-16 + +Code v1.79.2 + +### Added + +- `--domain-proxy` now supports `{{port}}` and `{{host}}` template variables. + +### Changed + +- Updated to Code 1.79.2 +- Files opened from an external terminal will now open in the most closely + related window rather than in the last opened window. + +## [4.13.0](https://github.com/coder/code-server/releases/tag/v4.13.0) - 2023-05-19 + +Code v1.78.2 + +### Changed + +- Updated to Code 1.78.2. + +### Fixed + +- Proxying files that contain non-ASCII characters. +- Origin check when X-Forwarded-Host contains comma-separated hosts. + +## [4.12.0](https://github.com/coder/code-server/releases/tag/v4.12.0) - 2023-04-21 + +Code v1.77.3 + +### Changed + +- Updated to Code 1.77.3 +- Ports panel will use domain-based proxy (instead of the default path-based + proxy) when set via --proxy-domain. +- Apply --app-name to the PWA title. + +### Added + +- Thai translation for login page. +- Debug logs around the origin security check. If you are getting forbidden + errors on web sockets please run code-server with `--log debug` to see why the + requests are being blocked. + +## [4.11.0](https://github.com/coder/code-server/releases/tag/v4.11.0) - 2023-03-16 + +Code v1.76.1 + +### Changed + +- Updated to Code 1.76.1 + +## [4.10.1](https://github.com/coder/code-server/releases/tag/v4.10.1) - 2023-03-04 + +Code v1.75.1 + +### Security + +Added an origin check to web sockets to prevent cross-site hijacking attacks on +users using older or niche browser that do not support SameSite cookies and +attacks across sub-domains that share the same root domain. + +The check requires the host header to be set so if you use a reverse proxy +ensure it forwards that information otherwise web sockets will be blocked. + +## [4.10.0](https://github.com/coder/code-server/releases/tag/v4.10.0) - 2023-02-15 + +Code v1.75.1 + +### Changed + +- Updated to Code 1.75.1 + +### Removed + +- Removed `--link` (was deprecated over thirteen months ago in 4.0.1). + +## [4.9.1](https://github.com/coder/code-server/releases/tag/v4.9.1) - 2022-12-15 + +Code v1.73.1 + +### Changed + +- Updated a couple steps in the build and release process to ensure we're using + `npm` and `yarn` consistently depending on the step. + +### Fixed + +- Fixed an issue with code-server version not displaying in the Help > About window. +- Fixed terminal not loading on macOS clients. + +## [4.9.0](https://github.com/coder/code-server/releases/tag/v4.9.0) - 2022-12-06 + +Code v1.73.1 + +### Changed + +- Upgraded to Code 1.73.1 + +### Added + +- `/security.txt` added as a route with info on our security policy information thanks to @ghuntley + +### Fixed + +- Installing on majaro images should now work thanks to @MrPeacockNLB for + adding the `--noconfirm` flag in `install.sh` + +### Known Issues + +- `--cert` on Ubuntu 22.04: OpenSSL v3 is used which breaks `pem` meaning the + `--cert` feature will not work. [Reference](https://github.com/adobe/fetch/pull/318#issuecomment-1306070259) + +## [4.8.3](https://github.com/coder/code-server/releases/tag/v4.8.3) - 2022-11-07 + +Code v1.72.1 + +### Added + +- install script now supports arch-like (i.e. manjaro, endeavourous, etc.) + architectures + +### Changed + +- Updated text in the Getting Started page. + +## [4.8.2](https://github.com/coder/code-server/releases/tag/v4.8.2) - 2022-11-02 + +Code v1.72.1 + +### Added + +- New text in the Getting Started page with info about + `coder/coder`. This is enabled by default but can be disabled by passing the CLI + flag `--disable-getting-started-override` or setting + `CS_DISABLE_GETTING_STARTED_OVERRIDE=1` or + `CS_DISABLE_GETTING_STARTED_OVERRIDE=true`. + +## [4.8.1](https://github.com/coder/code-server/releases/tag/v4.8.1) - 2022-10-28 + +Code v1.72.1 + +### Fixed + +- Fixed CSP error introduced in 4.8.0 that caused issues with webviews and most + extensions. + +## [4.8.0](https://github.com/coder/code-server/releases/tag/v4.8.0) - 2022-10-24 + +Code v1.72.1 + +### Added + +- Support for the Ports panel which leverages code-server's built-in proxy. It + also uses `VSCODE_PROXY_URI` where `{{port}}` is replace when forwarding a port. + Example: `VSCODE_PROXY_URI=https://{{port}}.kyle.dev` would forward an + application running on localhost:3000 to https://3000.kyle.dev +- Support for `--disable-workspace-trust` CLI flag +- Support for `--goto` flag to open file @ line:column +- Added Ubuntu-based images for Docker releases. If you run into issues with + `PATH` being overwritten in Docker please try the Ubuntu image as this is a + problem in the Debian base image. + +### Changed + +- Updated Code to 1.72.1 + +### Fixed + +- Enabled `BROWSER` environment variable +- Patched `asExternalUri` to work so now extensions run inside code-server can use it + +## [4.7.1](https://github.com/coder/code-server/releases/tag/v4.7.1) - 2022-09-30 + +Code v1.71.2 + +### Changed + +- Updated Code to 1.71.2 + +### Fixed + +- Fixed install script not upgrading code-server when already installed on RPM-based machines +- Fixed install script failing to gain root permissions on FreeBSD + +## [4.7.0](https://github.com/coder/code-server/releases/tag/v4.7.0) - 2022-09-09 + +Code v1.71.0 + +### Changed + +- Updated Code to 1.71.0 + +### Removed + +- Dropped heartbeat patch because it was implemented upstream + +### Fixed + +- Add flags --unsafe-perm --legacy-peer-deps in `npm-postinstall.sh` which ensures installing with npm works correctly + +## [4.6.1](https://github.com/coder/code-server/releases/tag/v4.6.1) - 2022-09-31 + +Code v1.70.2 + +### Changed + +- Updated Code to 1.70.2 +- Updated `argon2` to 0.29.0 which should fix issues on FreeBSD +- Updated docs to suggest using `npm` instead of `yarn` + +### Removed + +- Dropped database migration patch affected to 4.0.2 versions and earlier. + +### Fixed + +- Fixed preservation of `process.execArgv` which means you can pass `--prof` to profile code-server + +## [4.6.0](https://github.com/coder/code-server/releases/tag/v4.6.0) - 2022-08-17 + +Code v1.70.1 + +### Changed + +- Updated Code to 1.70.1. + +### Added + +- Added a heartbeat to sockets. This should prevent them from getting closed by + reverse proxy timeouts when idle like NGINX's default 60-second timeout. + +### Fixed + +- Fixed logout option appearing even when authentication is disabled. + +## [4.5.2](https://github.com/coder/code-server/releases/tag/v4.5.2) - 2022-08-15 + +Code v1.68.1 + +### Security + +- Fixed the proxy route not performing authentication. For example if you were + to run a development HTTP server using `python -m http.server 8000` then it + would be accessible at `my.domain/proxy/8000/` without any authentication. + + If all of the following apply to you please update as soon as possible: + - You run code-server with the built-in password authentication. + - You run unprotected HTTP services on ports accessible by code-server. + +### Changed + +- Invoking `code-server` in the integrated terminal will now use the script that + comes with upstream Code. This means flags like `--wait` will be + automatically supported now. However the upstream script only has the ability + to interact with the running code-server and cannot spawn new instances. If + you need to spawn a new code-server from the integrated terminal please + specify the full path to code-server's usual script (for example + `/usr/bin/code-server`). + +### Fixed + +- Invoking `code-server` in the integrated terminal will now work instead of + erroring about not finding Node. + +## [4.5.1](https://github.com/coder/code-server/releases/tag/v4.5.1) - 2022-07-18 + +Code v1.68.1 + +### Changed + +- We now use `release/v<0.0.0>` for the release branch name so it doesn't + conflict with the tag name +- Added `.prettierignore` to ignore formatting files in `lib/vscode` + +### Added + +- Allow more comprehensive affinity config in Helm chart +- Added custom message in Homebrew PR to make sure code-server maintainers are + tagged +- Allow setting `priorityClassName` via Helm chart +- Added troubleshooting docs to `CONTRIBUTING.md` + +### Fixed + +- Removed default memory limit which was set via `NODE_OPTIONS` +- Changed output in pipe to make it easier to debug code-server when doing live + edits +- Fixed display-language patch to use correct path which broke in 4.5.0 +- Fixed multiple code-server windows opening when using the code-server CLI in + the Integrated Terminal +- Fixed Integrated Terminal not working when web base was not the root path + +### Security + +- Updated `glob-parent` version in dependencies + +## [4.5.0](https://github.com/coder/code-server/releases/tag/v4.5.0) - 2022-06-29 + +Code v1.68.1 + +### Changed + +- Updated codecov to use codecov uploader +- Moved integration tests to Jest +- Fixed docker release to only download .deb +- Upgraded to Code 1.68.1 +- Install `nfpm` from GitHub +- Upgraded to TypeScript 4.6 + +### Added + +- Added tests for `open`, `isWsl`, `handlePasswordValidation` +- Provided alternate image registry to dockerhub +- Allowed users to have scripts run on container with `ENTRYPOINTD` environment + variable + +### Fixed + +- Fixed open CLI command to work on macOS + +## [4.4.0](https://github.com/coder/code-server/releases/tag/v4.4.0) - 2022-05-06 + +Code v1.66.2 + +### Changed + +- Refactored methods in `Heart` class and made `Heart.beat()` async to make + testing easier. +- Upgraded to Code 1.66.2. + +### Added + +- Added back telemetry patch which was removed in the Code reachitecture. +- Added support to use `true` for `CS_DISABLE_FILE_DOWNLOADS` environment + variable. This means you can disable file downloads by setting + `CS_DISABLE_FILE_DOWNLOADS` to `true` or `1`. +- Added tests for `Heart` class. + +### Fixed + +- Fixed installation issue in AUR after LICENSE rename. +- Fixed issue with listening on IPv6 addresses. +- Fixed issue with Docker publish action not being able to find artifacts. Now + it downloads the release assets from the release. + +## [4.3.0](https://github.com/coder/code-server/releases/tag/v4.3.0) - 2022-04-14 + +Code v1.65.2 + +### Changed + +- Excluded .deb files from release Docker image which drops the compressed and + uncompressed size by 58% and 34%. +- Upgraded to Code 1.65.2. + +### Added + +- Added a new CLI flag called `--disable-file-downloads` which allows you to + disable the "Download..." option that shows in the UI when right-clicking on a + file. This can also set by running `CS_DISABLE_FILE_DOWNLOADS=1`. +- Aligned the dependencies for binary and npm release artifacts. + +### Fixed + +- Fixed the code-server version from not displaying in the Help > About dialog. +- Fixed issues with the TypeScript and JavaScript Language Features Extension + failing to activate. +- Fixed missing files in ipynb extension. +- Fixed the homebrew release workflow. +- Fixed the Docker release workflow from not always publishing version tags. + +## [4.2.0](https://github.com/coder/code-server/releases/tag/v4.2.0) - 2022-03-22 + +Code v1.64.2 + +### Added + +- Added tests for `handleArgsSocketCatchError`, `setDefaults` and + `optionDescriptions`. + +### Changed + +- We switched from using the fork `coder/vscode` to a submodule of + `microsoft/vscode` + patches managed by `quilt` for how Code sits inside the + code-server codebase. +- Upgraded to Code 1.64.2. + +### Fixed + +- Update popup notification through `--disable-update-check` is now fixed. +- Fixed PWA icons not loading on iPad +- Fixed the homebrew release process. Our `cdrci` bot should now automatically + update the version as part of the release pipeline. +- Fixed titleBar color setting being ignored in PWA. + +### Security + +- Updated to `minimist-list`. +- Updated `cloud-agent` to `v0.2.4` which uses `nhooyr.io/webscoket` `v1.8.7`. + +## [4.1.0](https://github.com/coder/code-server/releases/tag/v4.1.0) - 2022-03-03 + +Code v1.63.0 + +### Added + +- Support for injecting GitHub token into Code so extensions can make use of it. + This can be done with the `GITHUB_TOKEN` environment variable or `github-auth` + in the config file. +- New flag `--socket-mode` allows setting the mode (file permissions) of the + socket created when using `--socket`. +- The version of Code bundled with code-server now appears when using the + `--version` flag. For example: `4.0.2 5cdfe74686aa73e023f8354a9a6014eb30caa7dd with Code 1.63.0`. + If you have been parsing this flag for the version you might want to use + `--version --json` instead as doing that will be more stable. + +### Changed + +- The workspace or folder passed on the CLI will now use the same redirect + method that the last opened workspace or folder uses. This means if you use + something like `code-server /path/to/dir` you will now get a query parameter + added (like so: `my-domain.tld?folder=/path/to/dir`), making it easier to edit + by hand and making it consistent with the last opened and menu open behaviors. +- The folder/workspace query parameter no longer has encoded slashes, making + them more readable and editable by hand. This was only affecting the last + opened behavior, not opens from the menu. + +### Fixed + +- Fix web sockets not connecting when using `--cert`. +- Prevent workspace state collisions when opening a workspace that shares the + same file path with another workspace on a different machine that shares the + same domain. This was causing files opened in one workspace to be "re-"opened + in the other workspace when the other workspace is opened. +- Pin the Express version which should make installing from npm work again. +- Propagate signals to code-server in the Docker image which means it should + stop more quickly and gracefully. +- Fix missing argon binaries in the standalone releases on arm machines. + +## [4.0.2](https://github.com/coder/code-server/releases/tag/v4.0.2) - 2022-01-27 + +Code v1.63.0 + +### Fixed + +- Unset the `BROWSER` environment variable. This fixes applications that hard + exit when trying to spawn the helper script `BROWSER` points to because the + file is missing. While we do include the script now we are leaving the + variable omitted because the script does not work yet. + +## [4.0.1](https://github.com/coder/code-server/releases/tag/v4.0.1) - 2022-01-04 + +Code v1.63.0 + +code-server has been rebased on upstream's newly open-sourced server +implementation (#4414). + +### Changed + +- Web socket compression has been made the default (when supported). This means + the `--enable` flag will no longer take `permessage-deflate` as an option. +- The static endpoint can no longer reach outside code-server. However the + vscode-remote-resource endpoint still can. +- OpenVSX has been made the default marketplace. +- The last opened folder/workspace is no longer stored separately in the + settings file (we rely on the already-existing query object instead). +- The marketplace override environment variables `SERVICE_URL` and `ITEM_URL` + have been replaced with a single `EXTENSIONS_GALLERY` variable that + corresponds to `extensionsGallery` in Code's `product.json`. + +### Added + +- `VSCODE_PROXY_URI` env var for use in the terminal and extensions. + +### Removed + +- Extra extension directories have been removed. The `--extra-extensions-dir` + and `--extra-builtin-extensions-dir` flags will no longer be accepted. +- The `--install-source` flag has been removed. + +### Deprecated + +- `--link` is now deprecated (#4562). + +### Security + +- We fixed a XSS vulnerability by escaping HTML from messages in the error page (#4430). + +## [3.12.0](https://github.com/coder/code-server/releases/tag/v3.12.0) - 2021-09-15 + +Code v1.60.0 + +### Changed + +- Upgrade Code to 1.60.0. + +### Fixed + +- Fix logout when using a base path (#3608). + +## [3.11.1](https://github.com/coder/code-server/releases/tag/v3.11.1) - 2021-08-06 + +Undocumented (see releases page). + +## [3.11.0](https://github.com/coder/code-server/releases/tag/v3.11.0) - 2021-06-14 + +Undocumented (see releases page). + +## [3.10.2](https://github.com/coder/code-server/releases/tag/v3.10.2) - 2021-05-21 + +Code v1.56.1 + +### Added + +- Support `extraInitContainers` in helm chart values (#3393). + +### Changed + +- Change `extraContainers` to support templating in helm chart (#3393). + +### Fixed + +- Fix "Open Folder" on welcome page (#3437). + +## [3.10.1](https://github.com/coder/code-server/releases/tag/v3.10.1) - 2021-05-17 + +Code v1.56.1 + +### Fixed + +- Check the logged user instead of $USER (#3330). +- Fix broken node_modules.asar symlink in npm package (#3355). +- Update cloud agent to fix version issue (#3342). + +### Changed + +- Use xdgBasedir.runtime instead of tmp (#3304). + +## [3.10.0](https://github.com/coder/code-server/releases/tag/v3.10.0) - 2021-05-10 + +Code v1.56.0 + +### Changed + +- Update to Code 1.56.0 (#3269). +- Minor connections refactor (#3178). Improves connection stability. +- Use ptyHostService (#3308). This brings us closer to upstream Code. + +### Added + +- Add flag for toggling permessage-deflate (#3286). The default is off so + compression will no longer be used by default. Use the --enable flag to + toggle it back on. + +### Fixed + +- Make rate limiter not count against successful logins (#3141). +- Refactor logout (#3277). This fixes logging out in some scenarios. +- Make sure directories exist (#3309). This fixes some errors on startup. + +### Security + +- Update dependencies with CVEs (#3223). + +## Previous versions + +This was added with `3.10.0`, which means any previous versions are not +documented in the changelog. + +To see those, please visit the [Releases page](https://github.com/coder/code-server/releases). diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 031b52b67b6d..000000000000 --- a/Dockerfile +++ /dev/null @@ -1,60 +0,0 @@ -FROM node:10.16.0 -ARG codeServerVersion=docker -ARG vscodeVersion -ARG githubToken - -# Install VS Code's deps. These are the only two it seems we need. -RUN apt-get update && apt-get install -y \ - libxkbfile-dev \ - libsecret-1-dev - -# Ensure latest yarn. -RUN npm install -g yarn@1.13 - -WORKDIR /src -COPY . . - -RUN yarn \ - && MINIFY=true GITHUB_TOKEN="${githubToken}" yarn build "${vscodeVersion}" "${codeServerVersion}" \ - && yarn binary "${vscodeVersion}" "${codeServerVersion}" \ - && mv "/src/build/code-server${codeServerVersion}-vsc${vscodeVersion}-linux-x86_64-built/code-server${codeServerVersion}-vsc${vscodeVersion}-linux-x86_64" /src/build/code-server \ - && rm -r /src/build/vscode-* \ - && rm -r /src/build/code-server*-linux-* - -# We deploy with ubuntu so that devs have a familiar environment. -FROM ubuntu:18.04 - -RUN apt-get update && apt-get install -y \ - openssl \ - net-tools \ - git \ - locales \ - sudo \ - dumb-init \ - vim \ - curl \ - wget - -RUN locale-gen en_US.UTF-8 -# We cannot use update-locale because docker will not use the env variables -# configured in /etc/default/locale so we need to set it manually. -ENV LC_ALL=en_US.UTF-8 - -RUN adduser --gecos '' --disabled-password coder && \ - echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd - -USER coder -# We create first instead of just using WORKDIR as when WORKDIR creates, the -# user is root. -RUN mkdir -p /home/coder/project - -WORKDIR /home/coder/project - -# This ensures we have a volume mounted even if the user forgot to do bind -# mount. So that they do not lose their data if they delete the container. -VOLUME [ "/home/coder/project" ] - -COPY --from=0 /src/build/code-server /usr/local/bin/code-server -EXPOSE 8080 - -ENTRYPOINT ["dumb-init", "code-server", "--host", "0.0.0.0"] diff --git a/README.md b/README.md deleted file mode 100644 index c87fdd2103a2..000000000000 --- a/README.md +++ /dev/null @@ -1,166 +0,0 @@ -# code-server · [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![Build Status](https://img.shields.io/travis/com/cdr/code-server/master)](https://github.com/cdr/code-server) - -`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a -remote server, accessible through the browser. - -Try it out: - -```bash -docker run -it -p 127.0.0.1:8080:8080 -v "${HOME}/.local/share/code-server:/home/coder/.local/share/code-server" -v "$PWD:/home/coder/project" codercom/code-server:v2 -``` - -- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a - consistent dev environment. develop more easily for Linux if you have a - Windows or Mac, and pick up where you left off when switching workstations. -- **Server-powered:** Take advantage of large cloud servers to speed up tests, - compilations, downloads, and more. Preserve battery life when you're on the go - since all intensive computation runs on your server. - -![Screenshot](/doc/assets/ide.gif) - -## Getting Started - -### Requirements - -- Minimum GLIBC version of 2.17 and a minimum version of GLIBCXX of 3.4.15. - - This is the main requirement for building Visual Studio Code. We cannot go lower than this. -- A 64-bit host with at least 1GB RAM and 2 cores. - - 1 core hosts would work but not optimally. -- Docker (for Docker versions of `code-server`). - -### Run over SSH - -Use [sshcode](https://github.com/codercom/sshcode) for a simple setup. - -### Docker - -See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile). - -To debug Golang using the -[ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go), -you need to add `--security-opt seccomp=unconfined` to your `docker run` -arguments when launching code-server with Docker. See -[#725](https://github.com/cdr/code-server/issues/725) for details. - -### Digital Ocean - -[![Create a Droplet](./doc/assets/droplet.svg)](https://marketplace.digitalocean.com/apps/code-server?action=deploy) - -### Binaries - -1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and - OS X supported. Windows coming soon) -2. Unpack the downloaded file then run the binary. -3. In your browser navigate to `localhost:8080`. - -- For self-hosting and other information see [doc/quickstart.md](doc/quickstart.md). -- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md). - -### Build - -- If you also plan on developing, set the `OUT` environment variable. Otherwise - it will build in this directory which will cause issues because `yarn watch` - will try to compile the build directory as well. -- Run `yarn build ${vscodeVersion} ${codeServerVersion}` in this directory (for - example: `yarn build 1.36.0 development`). -- If you target the same VS Code version our Travis builds do everything will - work but if you target some other version it might not (we have to do some - patching to VS Code so different versions aren't always compatible). -- You can run the built code with `node path/to/build/out/vs/server/main.js` or run - `yarn binary` with the same arguments in the previous step to package the - code into a single binary. - -## Known Issues - -- Creating custom VS Code extensions and debugging them doesn't work. -- Extension profiling and tips are currently disabled. - -## Future - -- **Stay up to date!** Get notified about new releases of code-server. - ![Screenshot](/doc/assets/release.gif) -- Windows support. -- Electron and Chrome OS applications to bridge the gap between local<->remote. -- Run VS Code unit tests against our builds to ensure features work as expected. - -## Extensions - -code-server does not provide access to the official -[Visual Studio Marketplace](https://marketplace.visualstudio.com/vscode). Instead, -Coder has created a custom extension marketplace that we manage for open-source -extensions. If you want to use an extension with code-server that we do not have -in our marketplace please look for a release in the extension’s repository, -contact us to see if we have one in the works or, if you build an extension -locally from open source, you can copy it to the `extensions` folder. If you -build one locally from open-source please contribute it to the project and let -us know so we can give you props! If you have your own custom marketplace, it is -possible to point code-server to it by setting the `SERVICE_URL` and `ITEM_URL` -environment variables. - -## Telemetry - -Use the `--disable-telemetry` flag to completely disable telemetry. We use the -data collected to improve code-server. - -## Contributing - -### Development - -```shell -git clone https://github.com/microsoft/vscode -cd vscode -git checkout -git clone https://github.com/cdr/code-server src/vs/server -cd src/vs/server -yarn patch:apply -yarn -yarn watch -# Wait for the initial compilation to complete (it will say "Finished compilation"). -# Run the next command in another shell. -yarn start -# Visit http://localhost:8080 -``` - -If you run into issues about a different version of Node being used, try running -`npm rebuild` in the VS Code directory and ignore the error at the end from -`vscode-ripgrep`. - -### Upgrading VS Code - -We patch VS Code to provide and fix some functionality. As the web portion of VS -Code matures, we'll be able to shrink and maybe even entirely eliminate our -patch. In the meantime, however, upgrading the VS Code version requires ensuring -that the patch still applies and has the intended effects. - -To generate a new patch, **stage all the changes** you want to be included in -the patch in the VS Code source, then run `yarn patch:generate` in this -directory. - -Our changes include: - -- Change the remote schema to `code-server`. -- Allow multiple extension directories (both user and built-in). -- Modify the loader, websocket, webview, service worker, and asset requests to - use the URL of the page as a base (and TLS if necessary for the websocket). -- Send client-side telemetry through the server and get the initial log level - from the server. -- Add an upload service for use in editor windows and the explorer along with a - file prefix to ignore for temporary files created during upload. -- Make changing the display language work. -- Make hiding or toggling the menu bar possible. -- Make it possible for us to load code on the client. -- Modify the build process to include our code. - -## License - -[MIT](LICENSE) - -## Enterprise - -Visit [our enterprise page](https://coder.com/enterprise) for more information -about our enterprise offering. - -## Commercialization - -If you would like to commercialize code-server, please contact -contact@coder.com. diff --git a/ThirdPartyNotices.txt b/ThirdPartyNotices.txt new file mode 100644 index 000000000000..fd6f420e235e --- /dev/null +++ b/ThirdPartyNotices.txt @@ -0,0 +1,22 @@ +code-server + +THIRD-PARTY SOFTWARE NOTICES AND INFORMATION +Do Not Translate or Localize + +1. Microsoft/vscode version 1.47.0 (https://github.com/Microsoft/vscode) + +%% Microsoft/vscode NOTICES AND INFORMATION BEGIN HERE +========================================= +MIT License + + +Copyright (c) 2015 - present Microsoft Corporation + + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/ci/Caddyfile b/ci/Caddyfile new file mode 100644 index 000000000000..52e4da6da281 --- /dev/null +++ b/ci/Caddyfile @@ -0,0 +1,15 @@ +{ + admin localhost:4444 +} +:8000 { + @portLocalhost path_regexp port ^/([0-9]+)\/ide + handle @portLocalhost { + uri strip_prefix {re.port.1}/ide + reverse_proxy localhost:{re.port.1} + } + + handle { + respond "Bad hostname" 400 + } + +} diff --git a/ci/build/build-code-server.sh b/ci/build/build-code-server.sh new file mode 100755 index 000000000000..df86f2d97a18 --- /dev/null +++ b/ci/build/build-code-server.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Builds code-server into out and the frontend into dist. + +main() { + cd "$(dirname "${0}")/../.." + + tsc + + # If out/node/entry.js does not already have the shebang, + # we make sure to add it and make it executable. + if ! grep -q -m1 "^#!/usr/bin/env node" out/node/entry.js; then + sed -i.bak "1s;^;#!/usr/bin/env node\n;" out/node/entry.js && rm out/node/entry.js.bak + chmod +x out/node/entry.js + fi +} + +main "$@" diff --git a/ci/build/build-lib.sh b/ci/build/build-lib.sh new file mode 100755 index 000000000000..520276c1bfc3 --- /dev/null +++ b/ci/build/build-lib.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash + +# This is a library which contains functions used inside ci/build +# +# We separated it into it's own file so that we could easily unit test +# these functions and helpers. + +# On some CPU architectures (notably node/uname "armv7l", default on Raspberry Pis), +# different package managers have different labels for the same CPU (deb=armhf, rpm=armhfp). +# This function returns the overriden arch on platforms +# with alternate labels, or the same arch otherwise. +get_nfpm_arch() { + local PKG_FORMAT="${1:-}" + local ARCH="${2:-}" + + case "$ARCH" in + armv7l) + if [ "$PKG_FORMAT" = "deb" ]; then + echo armhf + elif [ "$PKG_FORMAT" = "rpm" ]; then + echo armhfp + fi + ;; + *) + echo "$ARCH" + ;; + esac +} diff --git a/ci/build/build-packages.sh b/ci/build/build-packages.sh new file mode 100755 index 000000000000..dfd29dba20d3 --- /dev/null +++ b/ci/build/build-packages.sh @@ -0,0 +1,65 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Given a release found in $RELEASE_PATH, generate a deb, rpm, and tarball each +# named after $ARCH (derived from uname -m but can be overridden for +# cross-compilation) and $OS (derived from uname and cannot be overridden) and +# place them in ./release-packages and ./release-gcp. + +main() { + cd "$(dirname "${0}")/../.." + source ./ci/lib.sh + source ./ci/build/build-lib.sh + + VERSION=$(jq -r .version "$RELEASE_PATH/package.json") + export VERSION # for nfpm to use + + mkdir -p release-packages + + release_archive + + if [[ $OS == "linux" ]]; then + release_nfpm + fi +} + +release_archive() { + local release_name="code-server-$VERSION-$OS-$ARCH" + if [[ $OS == "linux" || $OS == "windows" ]]; then + tar -czf "release-packages/$release_name.tar.gz" --owner=0 --group=0 --transform "s/^$RELEASE_PATH/$release_name/" "$RELEASE_PATH" + else + tar -czf "release-packages/$release_name.tar.gz" -s "/^$RELEASE_PATH/$release_name/" "$RELEASE_PATH" + fi + + echo "done (release-packages/$release_name)" + + release_gcp +} + +release_gcp() { + mkdir -p "release-gcp/$VERSION" + cp "release-packages/$release_name.tar.gz" "./release-gcp/$VERSION/$OS-$ARCH.tar.gz" + mkdir -p "release-gcp/latest" + cp "./release-packages/$release_name.tar.gz" "./release-gcp/latest/$OS-$ARCH.tar.gz" +} + +# Generates deb and rpm packages. +release_nfpm() { + local nfpm_config + + export NFPM_ARCH + + NFPM_ARCH="$(get_nfpm_arch deb "$ARCH")" + nfpm_config="$(envsubst < ./ci/build/nfpm.yaml)" + echo "Building deb" + echo "$nfpm_config" | head --lines=4 + nfpm pkg -f <(echo "$nfpm_config") --target "release-packages/code-server_${VERSION}_${NFPM_ARCH}.deb" + + NFPM_ARCH="$(get_nfpm_arch rpm "$ARCH")" + nfpm_config="$(envsubst < ./ci/build/nfpm.yaml)" + echo "Building rpm" + echo "$nfpm_config" | head --lines=4 + nfpm pkg -f <(echo "$nfpm_config") --target "release-packages/code-server-$VERSION-$NFPM_ARCH.rpm" +} + +main "$@" diff --git a/ci/build/build-release.sh b/ci/build/build-release.sh new file mode 100755 index 000000000000..0b84dfdcd3f9 --- /dev/null +++ b/ci/build/build-release.sh @@ -0,0 +1,187 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Once both code-server and VS Code have been built, use this script to copy +# them into a single directory (./release), prepare the package.json and +# product.json, and add shrinkwraps. This results in a generic NPM package that +# we can publish to NPM. + +# MINIFY controls whether minified VS Code is bundled. It must match the value +# used when VS Code was built. +MINIFY="${MINIFY-true}" + +# node_modules are not copied by default. Set KEEP_MODULES=1 to copy them. +# Note these modules will be for the platform that built them, making the result +# no longer generic (it can still be published though as the modules will be +# ignored when pushing). +KEEP_MODULES="${KEEP_MODULES-0}" + +main() { + cd "$(dirname "${0}")/../.." + + source ./ci/lib.sh + + VSCODE_SRC_PATH="lib/vscode" + VSCODE_OUT_PATH="$RELEASE_PATH/lib/vscode" + + create_shrinkwraps + + mkdir -p "$RELEASE_PATH" + + bundle_code_server + bundle_vscode + + rsync ./docs/README.md "$RELEASE_PATH" + rsync LICENSE "$RELEASE_PATH" + rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH" + + if [ "$KEEP_MODULES" = 1 ]; then + # Copy the code-server launcher. + mkdir -p "$RELEASE_PATH/bin" + rsync ./ci/build/code-server.sh "$RELEASE_PATH/bin/code-server" + chmod 755 "$RELEASE_PATH/bin/code-server" + + # Windows cannot run the shell launcher, so it gets one of its own. + if [ "$OS" = windows ]; then + rsync ./ci/build/code-server.cmd "$RELEASE_PATH/bin/code-server.cmd" + fi + + # Delete the extra bin scripts. + rm "$RELEASE_PATH/lib/vscode/bin/remote-cli/code-darwin.sh" + rm "$RELEASE_PATH/lib/vscode/bin/remote-cli/code-linux.sh" + rm "$RELEASE_PATH/lib/vscode/bin/helpers/browser-darwin.sh" + rm "$RELEASE_PATH/lib/vscode/bin/helpers/browser-linux.sh" + if [ "$OS" != windows ] ; then + rm "$RELEASE_PATH/lib/vscode/bin/remote-cli/code.cmd" + rm "$RELEASE_PATH/lib/vscode/bin/helpers/browser.cmd" + fi + fi +} + +bundle_code_server() { + rsync out "$RELEASE_PATH" + + # For source maps and images. + mkdir -p "$RELEASE_PATH/src/browser" + rsync src/browser/media/ "$RELEASE_PATH/src/browser/media" + mkdir -p "$RELEASE_PATH/src/browser/pages" + rsync src/browser/pages/*.html "$RELEASE_PATH/src/browser/pages" + rsync src/browser/pages/*.css "$RELEASE_PATH/src/browser/pages" + rsync src/browser/robots.txt "$RELEASE_PATH/src/browser" + + # Adds the commit to package.json + jq --slurp '(.[0] | del(.scripts,.jest,.devDependencies)) * .[1]' package.json <( + cat << EOF + { + "version": "$(jq -r .codeServerVersion "./lib/vscode-reh-web-$VSCODE_TARGET/product.json")", + "commit": "$(git rev-parse HEAD)", + "scripts": { + "postinstall": "sh ./postinstall.sh" + } + } +EOF + ) > "$RELEASE_PATH/package.json" + mv npm-shrinkwrap.json "$RELEASE_PATH" + + if [ "$KEEP_MODULES" = 1 ]; then + local rsync_opts=(-a) + if [[ ${DEBUG-} = 1 ]]; then + rsync_opts+=(-vh) + fi + # If we build from source, exclude the prebuilds. + if [[ ${npm_config_build_from_source-} = true ]]; then + rsync_opts+=(--exclude /argon2/prebuilds) + fi + rsync "${rsync_opts[@]}" node_modules/ "$RELEASE_PATH/node_modules" + # Remove dev dependencies. + pushd "$RELEASE_PATH" + npm prune --production + popd + fi + + rsync ci/build/npm-postinstall.sh "$RELEASE_PATH/postinstall.sh" +} + +bundle_vscode() { + mkdir -p "$VSCODE_OUT_PATH" + + local rsync_opts=(-a) + if [[ ${DEBUG-} = 1 ]]; then + rsync_opts+=(-vh) + fi + + # Some extensions have a .gitignore which excludes their built source from the + # npm package so exclude any .gitignore files. + rsync_opts+=(--exclude .gitignore) + + # Exclude Node since we want to place it in a directory above. + rsync_opts+=(--exclude /node) + rsync_opts+=(--exclude /node.exe) + + # Exclude Node modules. Note that these will already only include production + # dependencies, so if we do keep them there is no need to do any + # post-processing to remove dev dependencies. + if [[ $KEEP_MODULES = 0 ]]; then + rsync_opts+=(--exclude node_modules) + fi + + rsync "${rsync_opts[@]}" "./lib/vscode-reh-web-$VSCODE_TARGET/" "$VSCODE_OUT_PATH" + + # Copy the Node binary. + if [[ $KEEP_MODULES = 1 ]]; then + if [ "$OS" = windows ]; then + cp "./lib/vscode-reh-web-$VSCODE_TARGET/node.exe" "$RELEASE_PATH/lib" + else + cp "./lib/vscode-reh-web-$VSCODE_TARGET/node" "$RELEASE_PATH/lib" + fi + fi + + # Merge the package.json for the web/remote server so we can include + # dependencies, since we want to ship this via NPM. + # Also override the name to prevent vulnerability scanners from + # misidentifying this package as VS Code (see #7071). + jq --slurp '.[0] * .[1] | .name = "code-oss"' \ + "$VSCODE_SRC_PATH/remote/package.json" \ + "$VSCODE_OUT_PATH/package.json" > "$VSCODE_OUT_PATH/package.json.merged" + mv "$VSCODE_OUT_PATH/package.json.merged" "$VSCODE_OUT_PATH/package.json" + cp "$VSCODE_SRC_PATH/remote/npm-shrinkwrap.json" "$VSCODE_OUT_PATH/npm-shrinkwrap.json" + + # Include global extension dependencies as well. + rsync "$VSCODE_SRC_PATH/extensions/package.json" "$VSCODE_OUT_PATH/extensions/package.json" + cp "$VSCODE_SRC_PATH/extensions/npm-shrinkwrap.json" "$VSCODE_OUT_PATH/extensions/npm-shrinkwrap.json" + rsync "$VSCODE_SRC_PATH/extensions/postinstall.mjs" "$VSCODE_OUT_PATH/extensions/postinstall.mjs" +} + +create_shrinkwraps() { + # package-lock.json files (used to ensure deterministic versions of + # dependencies) are not packaged when publishing to the NPM registry. + # + # To ensure deterministic dependency versions (even when code-server is + # installed with NPM), we create an npm-shrinkwrap.json file from the + # currently installed node_modules. This ensures the versions used from + # development (that the package-lock.json guarantees) are also the ones + # installed by end-users. These will include devDependencies, but those will + # be ignored when installing globally (for code-server), and because we use + # --omit=dev (for VS Code). + + # We first generate the shrinkwrap file for code-server itself - which is the + # current directory. + cp package-lock.json package-lock.json.temp + npm shrinkwrap + mv package-lock.json.temp package-lock.json + + # Then the shrinkwrap files for the bundled VS Code. + pushd "$VSCODE_SRC_PATH/remote/" + cp package-lock.json package-lock.json.temp + npm shrinkwrap + mv package-lock.json.temp package-lock.json + popd + + pushd "$VSCODE_SRC_PATH/extensions/" + cp package-lock.json package-lock.json.temp + npm shrinkwrap + mv package-lock.json.temp package-lock.json + popd +} + +main "$@" diff --git a/ci/build/build-vscode.sh b/ci/build/build-vscode.sh new file mode 100755 index 000000000000..c38b0ae22acc --- /dev/null +++ b/ci/build/build-vscode.sh @@ -0,0 +1,170 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Builds vscode into lib/vscode/out-vscode. + +# MINIFY controls whether a minified version of vscode is built. +MINIFY=${MINIFY-true} + +fix-bin-script() { + local script="lib/vscode-reh-web-$VSCODE_TARGET/bin/$1" + sed -i.bak "s/@@VERSION@@/$(vscode_version)/g" "$script" + sed -i.bak "s/@@COMMIT@@/$BUILD_SOURCEVERSION/g" "$script" + sed -i.bak "s/@@APPNAME@@/code-server/g" "$script" + + # Fix Node path on Darwin and Linux. + # We do not want expansion here; this text should make it to the file as-is. + # shellcheck disable=SC2016 + sed -i.bak 's/^ROOT=\(.*\)$/VSROOT=\1\nROOT="$(dirname "$(dirname "$VSROOT")")"/g' "$script" + sed -i.bak 's/ROOT\/out/VSROOT\/out/g' "$script" + # We do not want expansion here; this text should make it to the file as-is. + # shellcheck disable=SC2016 + sed -i.bak 's/$ROOT\/node/${NODE_EXEC_PATH:-$ROOT\/lib\/node}/g' "$script" + + # Fix Node path on Windows. + sed -i.bak 's/^set ROOT_DIR=\(.*\)$/set ROOT_DIR=%~dp0..\\..\\..\\..\r\nset VSROOT_DIR=\1/g' "$script" + sed -i.bak 's/%ROOT_DIR%\\out/%VSROOT_DIR%\\out/g' "$script" + sed -i.bak 's/%ROOT_DIR%\\node.exe/%ROOT_DIR%\\lib\\node.exe/g' "$script" + + chmod +x "$script" + rm "$script.bak" +} + +copy-bin-script() { + cp "lib/vscode/resources/server/bin/$1" "lib/vscode-reh-web-$VSCODE_TARGET/bin/$1" + fix-bin-script "$1" +} + +main() { + cd "$(dirname "${0}")/../.." + + source ./ci/lib.sh + + # Set the commit Code will embed into the product.json. We need to do this + # since Code tries to get the commit from the `.git` directory which will fail + # as it is a submodule. + # + # Also, we use code-server's commit rather than VS Code's otherwise it would + # not update when only our patch files change, and that will cause caching + # issues where the browser keeps using outdated code. + export BUILD_SOURCEVERSION + BUILD_SOURCEVERSION=$(git rev-parse HEAD) + + pushd lib/vscode + + if [[ ! ${VERSION-} ]]; then + echo "VERSION not set. Please set before running this script:" + echo "VERSION='0.0.0' npm run build:vscode" + exit 1 + fi + + # Modify the product.json: + # - Add the date + # - Set the code-server name. + # - Add our links + # - Enable telemetry (this just makes telemetry available; telemetry can still + # be disabled by flag or setting) + # - Configure trusted extensions (since some, like github.copilot-chat, never + # ask to be trusted and this is the only way to get auth working). + # - Make Typescript server plugins run in the workspace. We build the remote + # server version, so there is no browser distribution, and this key is not + # added automatically. + # + # This needs to be done before building as Code will read this file and embed + # it into the client-side code. + git checkout product.json # Reset in case the script exited early. + cp product.json product.original.json # Since jq has no inline edit. + jq --slurp '.[0] * .[1]' product.original.json <( + cat << EOF + { + "enableTelemetry": true, + "quality": "stable", + "codeServerVersion": "$VERSION", + "nameShort": "code-server", + "nameLong": "code-server", + "applicationName": "code-server", + "dataFolderName": ".code-server", + "win32MutexName": "codeserver", + "licenseUrl": "https://github.com/coder/code-server/blob/main/LICENSE", + "win32DirName": "code-server", + "win32NameVersion": "code-server", + "win32AppUserModelId": "coder.code-server", + "win32ShellNameShort": "c&ode-server", + "darwinBundleIdentifier": "com.coder.code.server", + "linuxIconName": "com.coder.code.server", + "reportIssueUrl": "https://github.com/coder/code-server/issues/new", + "documentationUrl": "https://go.microsoft.com/fwlink/?LinkID=533484#vscode", + "keyboardShortcutsUrlMac": "https://go.microsoft.com/fwlink/?linkid=832143", + "keyboardShortcutsUrlLinux": "https://go.microsoft.com/fwlink/?linkid=832144", + "keyboardShortcutsUrlWin": "https://go.microsoft.com/fwlink/?linkid=832145", + "introductoryVideosUrl": "https://go.microsoft.com/fwlink/?linkid=832146", + "tipsAndTricksUrl": "https://go.microsoft.com/fwlink/?linkid=852118", + "newsletterSignupUrl": "https://www.research.net/r/vsc-newsletter", + "linkProtectionTrustedDomains": [ + "https://open-vsx.org" + ], + "trustedExtensionAuthAccess": [ + "vscode.git", "vscode.github", + "github.vscode-pull-request-github", + "github.copilot", "github.copilot-chat" + ], + "aiConfig": { + "ariaKey": "code-server" + }, + "extensionPointExtensionKind": { + "typescriptServerPlugins": ["workspace"] + } + } +EOF + ) > product.json + + + VSCODE_QUALITY=stable npm run gulp compile-copilot-extension-full-build + + npm run gulp core-ci + npm run gulp "vscode-reh-web-$VSCODE_TARGET${MINIFY:+-min}-ci" + + # Reset so if you develop after building you will not be stuck with the wrong + # commit (the dev client will use `oss-dev` but the dev server will still use + # product.json which will have `stable-$commit`). + git checkout product.json + + popd + + pushd "lib/vscode-reh-web-$VSCODE_TARGET" + # Make sure Code took the version we set in the environment variable. Not + # having a version will break display languages. + if ! jq -e .commit product.json; then + echo "'commit' is missing from product.json" + exit 1 + fi + popd + + # Set vars and fix paths. + case $OS in + windows) + fix-bin-script remote-cli/code-server.cmd + fix-bin-script helpers/browser.cmd + ;; + *) + fix-bin-script remote-cli/code-server + fix-bin-script helpers/browser.sh + ;; + esac + + # Include bin scripts for other platforms so we can use the right one in the + # NPM post-install. + + # These provide a `code-server` command in the integrated terminal to open + # files in the current instance. + copy-bin-script remote-cli/code-darwin.sh + copy-bin-script remote-cli/code-linux.sh + copy-bin-script remote-cli/code.cmd + + # These provide a way for terminal applications to open browser windows. + copy-bin-script helpers/browser-darwin.sh + copy-bin-script helpers/browser-linux.sh + copy-bin-script helpers/browser.cmd +} + +main "$@" diff --git a/ci/build/clean.sh b/ci/build/clean.sh new file mode 100755 index 000000000000..9d90836a36f6 --- /dev/null +++ b/ci/build/clean.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "${0}")/../.." + source ./ci/lib.sh + + git clean -Xffd +} + +main "$@" diff --git a/ci/build/code-server-nfpm.sh b/ci/build/code-server-nfpm.sh new file mode 100755 index 000000000000..e12f493ba92c --- /dev/null +++ b/ci/build/code-server-nfpm.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +exec /usr/lib/code-server/bin/code-server "$@" diff --git a/ci/build/code-server-user.service b/ci/build/code-server-user.service new file mode 100644 index 000000000000..a2f48e938e55 --- /dev/null +++ b/ci/build/code-server-user.service @@ -0,0 +1,11 @@ +[Unit] +Description=code-server +After=network.target + +[Service] +Type=exec +ExecStart=/usr/bin/code-server +Restart=always + +[Install] +WantedBy=default.target diff --git a/ci/build/code-server.cmd b/ci/build/code-server.cmd new file mode 100644 index 000000000000..1b6a5b2ac1e5 --- /dev/null +++ b/ci/build/code-server.cmd @@ -0,0 +1,8 @@ +@echo off + +rem This script is intended to be bundled into the standalone releases. +rem Runs code-server with the bundled node binary. + +setlocal +set "ROOT=%~dp0.." +"%ROOT%\lib\node.exe" "%ROOT%" %* diff --git a/ci/build/code-server.sh b/ci/build/code-server.sh new file mode 100755 index 000000000000..801835ea843b --- /dev/null +++ b/ci/build/code-server.sh @@ -0,0 +1,28 @@ +#!/bin/sh +set -eu + +# This script is intended to be bundled into the standalone releases. +# Runs code-server with the bundled node binary. + +_realpath() { + # See https://github.com/coder/code-server/issues/1537 on why no realpath or readlink -f. + + script="$1" + cd "$(dirname "$script")" + + while [ -L "$(basename "$script")" ]; do + script="$(readlink "$(basename "$script")")" + cd "$(dirname "$script")" + done + + echo "$PWD/$(basename "$script")" +} + +root() { + script="$(_realpath "$0")" + bin_dir="$(dirname "$script")" + dirname "$bin_dir" +} + +ROOT="$(root)" +exec "$ROOT/lib/node" "$ROOT" "$@" diff --git a/ci/build/code-server@.service b/ci/build/code-server@.service new file mode 100644 index 000000000000..bfb62d78dea0 --- /dev/null +++ b/ci/build/code-server@.service @@ -0,0 +1,12 @@ +[Unit] +Description=code-server +After=network.target + +[Service] +Type=exec +ExecStart=/usr/bin/code-server +Restart=always +User=%i + +[Install] +WantedBy=default.target diff --git a/ci/build/nfpm.yaml b/ci/build/nfpm.yaml new file mode 100644 index 000000000000..4b0ee371a2eb --- /dev/null +++ b/ci/build/nfpm.yaml @@ -0,0 +1,25 @@ +name: "code-server" +arch: "${NFPM_ARCH}" +platform: "linux" +version: "v${VERSION}" +section: "devel" +priority: "optional" +maintainer: "Joe Previte " +description: | + Run VS Code in the browser. +vendor: "Coder" +homepage: "https://github.com/coder/code-server" +license: "MIT" + +contents: + - src: ./ci/build/code-server-nfpm.sh + dst: /usr/bin/code-server + + - src: ./ci/build/code-server@.service + dst: /usr/lib/systemd/system/code-server@.service + + - src: ./ci/build/code-server-user.service + dst: /usr/lib/systemd/user/code-server.service + + - src: ./release/* + dst: /usr/lib/code-server diff --git a/ci/build/npm-postinstall.sh b/ci/build/npm-postinstall.sh new file mode 100755 index 000000000000..856f1acfa9eb --- /dev/null +++ b/ci/build/npm-postinstall.sh @@ -0,0 +1,134 @@ +#!/usr/bin/env sh +set -eu + +# Copied from ../lib.sh except we do not rename Darwin and we do not need to +# detect Alpine. +os() { + osname=$(uname | tr '[:upper:]' '[:lower:]') + case $osname in + cygwin* | mingw*) osname="windows" ;; + esac + echo "$osname" +} + +# Create a symlink at $2 pointing to $1 on any platform. Anything that +# currently exists at $2 will be deleted. +symlink() { + source="$1" + dest="$2" + rm -rf "$dest" + case $OS in + windows) cmd //c mklink //J "$dest" "$source" ;; + *) ln -s "$source" "$dest" ;; + esac +} + +# Make a symlink at bin/$1/$3 pointing to the platform-specific version of the +# script in $2. The extension of the link will be .cmd for Windows otherwise it +# will be whatever is in $4 (or no extension if $4 is not set). +symlink_bin_script() { + oldpwd="$(pwd)" + cd "bin/$1" + source="$2" + dest="$3" + ext="${4-}" + case $OS in + windows) symlink "$source.cmd" "$dest.cmd" ;; + darwin | macos) symlink "$source-darwin.sh" "$dest$ext" ;; + *) symlink "$source-linux.sh" "$dest$ext" ;; + esac + cd "$oldpwd" +} + +command_exists() { + if [ ! "$1" ]; then return 1; fi + command -v "$@" > /dev/null +} + +is_root() { + if command_exists id && [ "$(id -u)" = 0 ]; then + return 0 + fi + return 1 +} + +OS="$(os)" + +main() { + # Grabs the major version of node from $npm_config_user_agent which looks like + # yarn/1.21.1 npm/? node/v14.2.0 darwin x64 + major_node_version=$(echo "$npm_config_user_agent" | sed -n 's/.*node\/v\([^.]*\).*/\1/p') + + if [ -n "${FORCE_NODE_VERSION:-}" ]; then + echo "WARNING: Overriding required Node.js version to v$FORCE_NODE_VERSION" + echo "This could lead to broken functionality, and is unsupported." + echo "USE AT YOUR OWN RISK!" + fi + + if [ "$major_node_version" -ne "${FORCE_NODE_VERSION:-24}" ]; then + echo "ERROR: code-server currently requires node v24." + if [ -n "${FORCE_NODE_VERSION:-}" ]; then + echo "However, you have overrided the version check to use v$FORCE_NODE_VERSION." + fi + echo "We have detected that you are on node v$major_node_version" + echo "You can override this version check by setting \$FORCE_NODE_VERSION," + echo "but configurations that do not use the same node version are unsupported." + exit 1 + fi + + + if ! vscode_install; then + echo "You may not have the required dependencies to build the native modules." + echo "Please see https://github.com/coder/code-server/blob/main/docs/npm.md" + exit 1 + fi + + if [ -n "${FORCE_NODE_VERSION:-}" ]; then + echo "WARNING: The required Node.js version was overriden to v$FORCE_NODE_VERSION" + echo "This could lead to broken functionality, and is unsupported." + echo "USE AT YOUR OWN RISK!" + fi +} + +install_with_yarn_or_npm() { + echo "User agent: ${npm_config_user_agent-none}" + # For development we enforce npm, but for installing the package as an + # end-user we want to keep using whatever package manager is in use. + case "${npm_config_user_agent-}" in + npm*) + if ! npm install --omit=dev; then + return 1 + fi + ;; + yarn*) + if ! yarn --production --frozen-lockfile --no-default-rc; then + return 1 + fi + ;; + *) + echo "Could not determine which package manager is being used to install code-server" + exit 1 + ;; + esac + return 0 +} + +vscode_install() { + echo 'Installing Code dependencies...' + cd lib/vscode + if ! install_with_yarn_or_npm; then + return 1 + fi + + symlink_bin_script remote-cli code code-server + symlink_bin_script helpers browser browser .sh + + cd extensions + if ! install_with_yarn_or_npm; then + return 1 + fi + + return 0 +} + +main "$@" diff --git a/ci/build/update-repo.sh b/ci/build/update-repo.sh new file mode 100755 index 000000000000..0f1924fa91a4 --- /dev/null +++ b/ci/build/update-repo.sh @@ -0,0 +1,96 @@ +#!/usr/bin/env bash + +set -Eeuo pipefail + +# Given versions $1 and $2 figure out the first component that is different +# (major, minor, patch). +function find_version_diff() { + # shellcheck disable=SC2206 + local a=( ${1//./ } ) + # shellcheck disable=SC2206 + local b=( ${2//./ } ) + + if [[ ${a[0]} != "${b[0]}" ]] ; then + echo major + elif [[ ${a[1]} != "${b[1]}" ]] ; then + echo minor + else + echo patch + fi +} + +# Bump $1 by the bump type (major, minor, patch) in $2. +function bump_version() { + # shellcheck disable=SC2206 + local a=( ${1//./ } ) + case $2 in + major) + ((a[0]++)) + a[1]=0 + a[2]=0 + ;; + minor) + ((a[1]++)) + a[2]=0 + ;; + *) + ((a[2]++)) + ;; + esac + echo "${a[0]}.${a[1]}.${a[2]}" +} + +function update_helm() { + local chart_version + chart_version=$(yq .version ci/helm-chart/Chart.yaml) + local app_version + app_version=$(yq .appVersion ci/helm-chart/Chart.yaml) + local image_version + image_version=$(yq .image.tag ci/helm-chart/values.yaml) + + local bump_type + bump_type=$(find_version_diff "$app_version" "$version") + local chart_version_bump + chart_version_bump=$(bump_version "$chart_version" "$bump_type") + + # Use sed to replace because yq will reformat. + echo "Bumping version from $chart_version to $chart_version_bump..." + sed -i.bak "s/^version: $chart_version\$/version: $chart_version_bump/" ci/helm-chart/Chart.yaml + + echo "Bumping app version from $app_version to $version..." + sed -i.bak "s/^appVersion: .\+\$/appVersion: $version/" ci/helm-chart/Chart.yaml + + echo "Bumping image version from $image_version to $version..." + sed -i.bak "s/^ tag: .\+\$/ tag: '$version'/" ci/helm-chart/values.yaml +} + +function update_changelog() { + local date + date=$(printf '%(%Y-%m-%d)T\n' -1) + local link="https://github.com/coder/code-server/releases/tag/v$version" + sed -i.bak "s|## Unreleased|## Unreleased\n\n## [$version]($link) - $date|" CHANGELOG.md +} + +function main() { + cd "$(dirname "${0}")/../.." + + source ./ci/lib.sh + + local version=${VERSION:-$(git describe --tags)} + version="${version#v}" + + declare -a steps + + steps+=( + "Update Helm chart" "update_helm" + "Update changelog" "update_changelog" + ) + + # Even if a step failed, still output the last checkmark. + run-steps "${steps[@]}" || true + + # This step is always manual. + echo "- [ ] https://github.com/coder/code-server-aur/pulls" >> .cache/checklist +} + +main "$@" diff --git a/ci/build/update-vscode.sh b/ci/build/update-vscode.sh new file mode 100755 index 000000000000..b3b4857d2eb4 --- /dev/null +++ b/ci/build/update-vscode.sh @@ -0,0 +1,162 @@ +#!/usr/bin/env bash + +set -Eeuo pipefail + +function unapply_patches() { + local -i exit_code=0 + quiet quilt pop -af 2>&1 || exit_code=$? + case $exit_code in + # Sucessfully unapplied. + 0) ;; + # No more patches to unapply. + 2) ;; + # Some error. + *) return $exit_code ;; + esac +} + +function apply_patches() { + local -i exit_code=0 + quiet quilt push -a 2>&1 || exit_code=$? + case $exit_code in + # Sucessfully applied. + 0) ;; + # No more patches to apply. + 2) ;; + # Some error. + *) return $exit_code ;; + esac +} + +function update_vscode() { + pushd lib/vscode + if ! git checkout 2>&1 "$target_vscode_version" ; then + echo "$target_vscode_version does not exist locally, fetching..." + git fetch --all --prune --tags + echo "Checking out $target_vscode_version again..." + git checkout "$target_vscode_version" + fi + popd +} + +function refresh_patches() { + local -i exit_code=0 + while quiet quilt push 2>&1 ; ! (( exit_code=$? )) ; do + quilt refresh 2>&1 + done + case $exit_code in + # No more patches to apply. + 2) ;; + # Some error. + *) return $exit_code ;; + esac +} + +function update_node() { + local node_version + node_version=$(cat .node-version) + local target_node_version + target_node_version=$(grep target lib/vscode/remote/.npmrc | awk -F= '{print $2}' | tr -d '"') + if [[ $node_version == "$target_node_version" ]] ; then + echo "Already set to $target_node_version" + else + echo "Updating from $node_version to $target_node_version..." + echo "$target_node_version" > .node-version + fi +} + +function get-webview-script-hash() { + local html + html=$(<"$1") + local start_tag='" + html=${html##*"$start_tag"} + html=${html%%"$end_tag"*} + echo -n "$html" | openssl sha256 -binary | openssl base64 +} + +function delete_csp() { + quilt delete csp-hashes.diff || true +} + +function update_csp() { + apply_patches + + local files=( + ./lib/vscode/src/vs/workbench/contrib/webview/browser/pre/index.html + ./lib/vscode/src/vs/workbench/services/extensions/worker/webWorkerExtensionHostIframe.html + ) + + quilt new csp-hashes.diff + + local file + for file in "${files[@]}" ; do + quilt add "$file" + + local hash + hash=$(get-webview-script-hash "$file") + echo "Calculated hash as $hash" + # Use octothorpe as a delimiter since the hash may contain a slash. + sed -i.bak "s#'sha256-[^']\+'#'sha256-$hash'#" "$file" + done + + quilt refresh +} + +function add_changelog() { + local file=CHANGELOG.md + if grep --quiet "Code $target_vscode_version" "$file" ; then + echo "Changelog for $target_vscode_version already exists" + else + # TODO: This is not exactly robust. In particular, it needs to handle if + # there is already a "changed" section. + sed -i.bak "s/## Unreleased/## Unreleased\n\nCode v$target_vscode_version\n\n### Changed\n\n- Update to Code $target_vscode_version/" "$file" + fi +} + +function main() { + cd "$(dirname "${0}")/../.." + + source ./ci/lib.sh + + declare -a steps + + # Hashes are always regenerated to avoid having to resolve conflicts.. + steps+=("Revert CSP hashes" "delete_csp") + + # If version is not set, assume we are already at the target version and the + # user is just trying to resolve conflics. + local target_vscode_version + if [[ ${VERSION-} ]] ; then + # Removing patches only needs to be done locally; in CI we start from a + # fresh clone each time. + if [[ ! ${CI-} ]] ; then + steps+=("Unapplying patches" "unapply_patches") + fi + target_vscode_version="${VERSION#v}" + steps+=( + "Update Code to $target_vscode_version" "update_vscode" + "Refresh Code patches" "refresh_patches" + ) + else + target_vscode_version="$(git -C lib/vscode describe --tags --exact-match)" + echo "Detected Code version $target_vscode_version" + fi + + steps+=( + "Update Node version" "update_node" + "Regenerate CSP hashes" "update_csp" + "Add changelog note" "add_changelog" + ) + + # Even if a step failed, still output the last checkmark. + run-steps "${steps[@]}" || true + + # This step is always manual. + echo "- [ ] Verify changelog" >> .cache/checklist +} + +main "$@" diff --git a/ci/dev/doctoc.sh b/ci/dev/doctoc.sh new file mode 100755 index 000000000000..39930f21e0b5 --- /dev/null +++ b/ci/dev/doctoc.sh @@ -0,0 +1,26 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "$0")/../.." + + doctoc --title '# FAQ' docs/FAQ.md > /dev/null + doctoc --title '# Setup Guide' docs/guide.md > /dev/null + doctoc --title '# Install' docs/install.md > /dev/null + doctoc --title '# npm Install Requirements' docs/npm.md > /dev/null + doctoc --title '# Contributing' docs/CONTRIBUTING.md > /dev/null + doctoc --title '# Maintaining' docs/MAINTAINING.md > /dev/null + doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md > /dev/null + doctoc --title '# iPad' docs/ipad.md > /dev/null + doctoc --title '# Termux' docs/termux.md > /dev/null + + if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then + echo "Files need generation or are formatted incorrectly:" + git -c color.ui=always status | grep --color=no '\[31m' + echo "Please run the following locally:" + echo " npm run doctoc" + exit 1 + fi +} + +main "$@" diff --git a/ci/dev/gen_icons.sh b/ci/dev/gen_icons.sh new file mode 100755 index 000000000000..39d509bc4f4b --- /dev/null +++ b/ci/dev/gen_icons.sh @@ -0,0 +1,50 @@ +#!/bin/sh +set -eu + +# Generate icons from a single favicon.svg. favicon.svg should have no fill +# colors set. +main() { + cd src/browser/media + + # We need .ico for backwards compatibility. The other two are the only icon + # sizes required by Chrome and we use them for stuff like apple-touch-icon as + # well. https://web.dev/add-manifest/ + # + # This should be enough and we can always add more if there are problems. + # + # -quiet to avoid https://github.com/ImageMagick/ImageMagick/issues/884 + # -background defaults to white but we want it transparent. + # -density somehow makes the image both sharper and smaller in file size. + # + # https://imagemagick.org/script/command-line-options.php#background + convert -quiet -background transparent \ + -resize 256x256 -density 256x256 \ + favicon.svg favicon.ico + + # Generate PWA icons. There should be enough padding to support masking. + convert -quiet -border 60x60 -bordercolor white -background white \ + -resize 192x192 -density 192x192 \ + favicon.svg pwa-icon-maskable-192.png + convert -quiet -border 160x160 -bordercolor white -background white \ + -resize 512x512 -density 512x512 \ + favicon.svg pwa-icon-maskable-512.png + + # Generate non-maskable PWA icons. + magick pwa-icon-maskable-192.png \ + \( +clone -threshold 101% -fill white -draw "roundRectangle 0,0 %[fx:int(w)],%[fx:int(h)] 50,50" \) \ + -channel-fx "| gray=>alpha" \ + pwa-icon-192.png + magick pwa-icon-maskable-512.png \ + \( +clone -threshold 101% -fill white -draw "roundRectangle 0,0 %[fx:int(w)],%[fx:int(h)] 100,100" \) \ + -channel-fx "| gray=>alpha" \ + pwa-icon-512.png + + # The following adds dark mode support for the favicon as + # favicon-dark-support.svg There is no similar capability for pwas or .ico so + # we can only add support to the svg. + favicon_dark_style="" + cp favicon.svg favicon-dark-support.svg + sed "s% favicon-dark-support.svg +} + +main "$@" diff --git a/ci/dev/lint-scripts.sh b/ci/dev/lint-scripts.sh new file mode 100755 index 000000000000..742030affc62 --- /dev/null +++ b/ci/dev/lint-scripts.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "$0")/../.." + shellcheck -e SC2046,SC2164,SC2154,SC1091,SC1090,SC2002 $(git ls-files '*.sh' | grep -v 'lib/vscode') +} + +main "$@" diff --git a/ci/dev/postinstall.sh b/ci/dev/postinstall.sh new file mode 100755 index 000000000000..63aad7bcf985 --- /dev/null +++ b/ci/dev/postinstall.sh @@ -0,0 +1,38 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Install dependencies in $1. +install-deps() { + local args=() + if [[ ${CI-} ]]; then + args+=(ci) + else + args+=(install) + fi + # If there is no package.json then npm will look upward and end up installing + # from the root resulting in an infinite loop (this can happen if you have not + # checked out the submodule yet for example). + if [[ ! -f "$1/package.json" ]]; then + echo "$1/package.json is missing; did you run git submodule update --init?" + exit 1 + fi + pushd "$1" + echo "Installing dependencies for $PWD" + npm "${args[@]}" + popd +} + +main() { + cd "$(dirname "$0")/../.." + source ./ci/lib.sh + + install-deps test + install-deps test/e2e/extensions/test-extension + # We don't need these when running the integration tests + # so you can pass SKIP_SUBMODULE_DEPS + if [[ ! ${SKIP_SUBMODULE_DEPS-} ]]; then + install-deps lib/vscode + fi +} + +main "$@" diff --git a/ci/dev/preinstall.js b/ci/dev/preinstall.js new file mode 100644 index 000000000000..9c4240d89696 --- /dev/null +++ b/ci/dev/preinstall.js @@ -0,0 +1,3 @@ +if (process.env.npm_execpath.includes("yarn")) { + throw new Error("`yarn` is no longer supported; please use `npm install` instead") +} diff --git a/ci/dev/test-e2e.sh b/ci/dev/test-e2e.sh new file mode 100755 index 000000000000..fa748823974e --- /dev/null +++ b/ci/dev/test-e2e.sh @@ -0,0 +1,50 @@ +#!/usr/bin/env bash +set -euo pipefail + +help() { + echo >&2 " You can build with 'npm run watch' or you can build a release" + echo >&2 " For example: 'npm run build && npm run build:vscode && KEEP_MODULES=1 npm run release'" + echo >&2 " Then 'CODE_SERVER_TEST_ENTRY=./release npm run test:e2e'" + echo >&2 " You can manually run that release with 'node ./release'" +} + +main() { + cd "$(dirname "$0")/../.." + + source ./ci/lib.sh + + pushd test/e2e/extensions/test-extension + echo "Building test extension" + npm run build + popd + + local dir="$PWD" + if [[ ! ${CODE_SERVER_TEST_ENTRY-} ]]; then + echo "Set CODE_SERVER_TEST_ENTRY to test another build of code-server" + else + pushd "$CODE_SERVER_TEST_ENTRY" + dir="$PWD" + popd + fi + + echo "Testing build in '$dir'" + + # Simple sanity checks to see that we've built. There could still be things + # wrong (native modules version issues, incomplete build, etc). + if [[ ! -d $dir/out ]]; then + echo >&2 "No code-server build detected" + help + exit 1 + fi + + if [[ ! -d $dir/lib/vscode/out ]]; then + echo >&2 "No VS Code build detected" + help + exit 1 + fi + + cd test + ./node_modules/.bin/playwright test "$@" +} + +main "$@" diff --git a/ci/dev/test-integration.sh b/ci/dev/test-integration.sh new file mode 100755 index 000000000000..36d87de8ad6d --- /dev/null +++ b/ci/dev/test-integration.sh @@ -0,0 +1,39 @@ +#!/usr/bin/env bash +set -euo pipefail + +help() { + echo >&2 " You can build the release with 'KEEP_MODULES=1 npm run release'" + echo >&2 " Or you can pass in a custom path." + echo >&2 " CODE_SERVER_PATH='/var/tmp/coder/code-server/bin/code-server' npm run test:integration" +} + +# Make sure a code-server release works. You can pass in the path otherwise it +# will look for $RELEASE_PATH in the current directory. +# +# This is to make sure we don't have Node version errors or any other +# compilation-related errors. +main() { + cd "$(dirname "$0")/../.." + + source ./ci/lib.sh + + local path="$RELEASE_PATH/bin/code-server" + if [[ ! ${CODE_SERVER_PATH-} ]]; then + echo "Set CODE_SERVER_PATH to test another build of code-server" + else + path="$CODE_SERVER_PATH" + fi + + echo "Running tests with code-server binary: '$path'" + + if [[ ! -f $path ]]; then + echo >&2 "No code-server build detected" + echo >&2 "Looked in $path" + help + exit 1 + fi + + CODE_SERVER_PATH="$path" ./test/node_modules/.bin/jest "$@" --coverage=false --testRegex "./test/integration" --testPathIgnorePatterns "./test/integration/fixtures" +} + +main "$@" diff --git a/ci/dev/test-native.sh b/ci/dev/test-native.sh new file mode 100755 index 000000000000..8e91f9a63e3b --- /dev/null +++ b/ci/dev/test-native.sh @@ -0,0 +1,39 @@ +#!/usr/bin/env bash +set -euo pipefail + +help() { + echo >&2 " You can build the release with 'KEEP_MODULES=1 npm run release'" + echo >&2 " Or you can pass in a custom path." + echo >&2 " CODE_SERVER_PATH='/var/tmp/coder/code-server/bin/code-server' npm run test:integration" +} + +# Make sure a code-server release works. You can pass in the path otherwise it +# will look for $RELEASE_PATH in the current directory. +# +# This is to make sure we don't have Node version errors or any other +# compilation-related errors. +main() { + cd "$(dirname "$0")/../.." + + source ./ci/lib.sh + + local path="$RELEASE_PATH/bin/code-server" + if [[ ! ${CODE_SERVER_PATH-} ]]; then + echo "Set CODE_SERVER_PATH to test another build of code-server" + else + path="$CODE_SERVER_PATH" + fi + + echo "Running tests with code-server binary: '$path'" + + if [[ ! -f $path ]]; then + echo >&2 "No code-server build detected" + echo >&2 "Looked in $path" + help + exit 1 + fi + + CODE_SERVER_PATH="$path" ./test/node_modules/.bin/jest "$@" --coverage=false --testRegex "./test/integration/help.test.ts" +} + +main "$@" diff --git a/ci/dev/test-scripts.sh b/ci/dev/test-scripts.sh new file mode 100755 index 000000000000..ebe1efa8ed22 --- /dev/null +++ b/ci/dev/test-scripts.sh @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "$0")/../.." + bats ./test/scripts +} + +main "$@" diff --git a/ci/dev/test-unit.sh b/ci/dev/test-unit.sh new file mode 100755 index 000000000000..15fd2030ea59 --- /dev/null +++ b/ci/dev/test-unit.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "$0")/../.." + + source ./ci/lib.sh + + # We must keep jest in a sub-directory. See ../../test/package.json for more + # information. We must also run it from the root otherwise coverage will not + # include our source files. + ./test/node_modules/.bin/jest "$@" --testRegex "./test/unit/.*ts" +} + +main "$@" diff --git a/ci/dev/watch.ts b/ci/dev/watch.ts new file mode 100644 index 000000000000..e48489ce69dc --- /dev/null +++ b/ci/dev/watch.ts @@ -0,0 +1,143 @@ +import { spawn, ChildProcess } from "child_process" +import * as path from "path" +import { onLine, OnLineCallback } from "../../src/node/util" + +interface DevelopmentCompilers { + [key: string]: ChildProcess | undefined + vscode: ChildProcess + vscodeWebExtensions: ChildProcess + codeServer: ChildProcess + plugins: ChildProcess | undefined +} + +class Watcher { + private rootPath = path.resolve(process.cwd()) + private readonly paths = { + /** Path to uncompiled VS Code source. */ + vscodeDir: path.join(this.rootPath, "lib/vscode"), + pluginDir: process.env.PLUGIN_DIR, + } + + //#region Web Server + + /** Development web server. */ + private webServer: ChildProcess | undefined + + private reloadWebServer = (): void => { + if (this.webServer) { + this.webServer.kill() + } + + // Pass CLI args, save for `node` and the initial script name. + const args = process.argv.slice(2) + this.webServer = spawn("node", [path.join(this.rootPath, "out/node/entry.js"), ...args]) + onLine(this.webServer, (line) => console.log("[code-server]", line)) + const { pid } = this.webServer + + this.webServer.on("exit", () => console.log("[code-server]", `Web process ${pid} exited`)) + + console.log("\n[code-server]", `Spawned web server process ${pid}`) + } + + //#endregion + + //#region Compilers + + private readonly compilers: DevelopmentCompilers = { + codeServer: spawn("tsc", ["--watch", "--pretty", "--preserveWatchOutput"], { cwd: this.rootPath }), + vscode: spawn("npm", ["run", "watch"], { cwd: this.paths.vscodeDir }), + vscodeWebExtensions: spawn("npm", ["run", "watch-web"], { cwd: this.paths.vscodeDir }), + plugins: this.paths.pluginDir + ? spawn("npm", ["run", "build", "--watch"], { cwd: this.paths.pluginDir }) + : undefined, + } + + public async initialize(): Promise { + for (const event of ["SIGINT", "SIGTERM"]) { + process.on(event, () => this.dispose(0)) + } + + for (const [processName, devProcess] of Object.entries(this.compilers)) { + if (!devProcess) continue + + devProcess.on("exit", (code) => { + console.log(`[${processName}]`, "Terminated unexpectedly") + this.dispose(code) + }) + + if (devProcess.stderr) { + devProcess.stderr.on("data", (d: string | Uint8Array) => process.stderr.write(d)) + } + } + + onLine(this.compilers.vscode, this.parseVSCodeLine) + onLine(this.compilers.codeServer, this.parseCodeServerLine) + + if (this.compilers.plugins) { + onLine(this.compilers.plugins, this.parsePluginLine) + } + } + + //#endregion + + //#region Line Parsers + + private parseVSCodeLine: OnLineCallback = (strippedLine, originalLine) => { + if (!strippedLine.length) return + + console.log("[Code OSS]", originalLine) + + if (strippedLine.includes("Finished compilation with")) { + console.log("[Code OSS] ✨ Finished compiling! ✨", "(Refresh your web browser ♻️)") + this.reloadWebServer() + } + } + + private parseCodeServerLine: OnLineCallback = (strippedLine, originalLine) => { + if (!strippedLine.length) return + + console.log("[Compiler][code-server]", originalLine) + + if (strippedLine.includes("Watching for file changes")) { + console.log("[Compiler][code-server]", "Finished compiling!", "(Refresh your web browser ♻️)") + this.reloadWebServer() + } + } + + private parsePluginLine: OnLineCallback = (strippedLine, originalLine) => { + if (!strippedLine.length) return + + console.log("[Compiler][Plugin]", originalLine) + + if (strippedLine.includes("Watching for file changes...")) { + this.reloadWebServer() + } + } + + //#endregion + + //#region Utilities + + private dispose(code: number | null): void { + for (const [processName, devProcess] of Object.entries(this.compilers)) { + console.log(`[${processName}]`, "Killing...\n") + devProcess?.removeAllListeners() + devProcess?.kill() + } + process.exit(typeof code === "number" ? code : 0) + } + + //#endregion +} + +async function main(): Promise { + try { + const watcher = new Watcher() + await watcher.initialize() + } catch (error: any) { + console.error(error.message) + process.exit(1) + } +} + +main() diff --git a/ci/helm-chart/.helmignore b/ci/helm-chart/.helmignore new file mode 100644 index 000000000000..0e8a0eb36f4c --- /dev/null +++ b/ci/helm-chart/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/ci/helm-chart/Chart.yaml b/ci/helm-chart/Chart.yaml new file mode 100644 index 000000000000..dd4dec8f4f68 --- /dev/null +++ b/ci/helm-chart/Chart.yaml @@ -0,0 +1,23 @@ +apiVersion: v2 +name: code-server +description: A Helm chart for coder/code-server + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 3.56.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +appVersion: 4.141.0 diff --git a/ci/helm-chart/templates/NOTES.txt b/ci/helm-chart/templates/NOTES.txt new file mode 100644 index 000000000000..45c9aed3881d --- /dev/null +++ b/ci/helm-chart/templates/NOTES.txt @@ -0,0 +1,24 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "code-server.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "code-server.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "code-server.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl port-forward --namespace {{ .Release.Namespace }} service/{{ include "code-server.fullname" . }} 8080:http +{{- end }} + +Administrator credentials: + + Password: echo $(kubectl get secret --namespace {{ .Release.Namespace }} {{ template "code-server.fullname" . }} -o jsonpath="{.data.password}" | base64 --decode) diff --git a/ci/helm-chart/templates/_helpers.tpl b/ci/helm-chart/templates/_helpers.tpl new file mode 100644 index 000000000000..bb36e8c21972 --- /dev/null +++ b/ci/helm-chart/templates/_helpers.tpl @@ -0,0 +1,63 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "code-server.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "code-server.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "code-server.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Common labels +*/}} +{{- define "code-server.labels" -}} +helm.sh/chart: {{ include "code-server.chart" . }} +{{ include "code-server.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "code-server.selectorLabels" -}} +app.kubernetes.io/name: {{ include "code-server.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "code-server.serviceAccountName" -}} +{{- if .Values.serviceAccount.create -}} + {{ default (include "code-server.fullname" .) .Values.serviceAccount.name }} +{{- else -}} + {{ default "default" .Values.serviceAccount.name }} +{{- end -}} +{{- end -}} diff --git a/ci/helm-chart/templates/deployment.yaml b/ci/helm-chart/templates/deployment.yaml new file mode 100644 index 000000000000..18bece028fc6 --- /dev/null +++ b/ci/helm-chart/templates/deployment.yaml @@ -0,0 +1,194 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "code-server.fullname" . }} + labels: + {{- include "code-server.labels" . | nindent 4 }} + {{- if .Values.annotations }} + annotations: {{- toYaml .Values.annotations | nindent 4 }} + {{- end }} +spec: + {{- if ne .Values.replicaCount nil }} + replicas: {{ .Values.replicaCount }} + {{- end }} + strategy: + type: Recreate + selector: + matchLabels: + {{- include "code-server.selectorLabels" . | nindent 6 }} + template: + metadata: + labels: + {{- include "code-server.selectorLabels" . | nindent 8 }} + {{- if .Values.podAnnotations }} + annotations: {{- toYaml .Values.podAnnotations | nindent 8 }} + {{- end }} + spec: + imagePullSecrets: {{- toYaml .Values.imagePullSecrets | nindent 8 }} + {{- if .Values.hostnameOverride }} + hostname: {{ .Values.hostnameOverride }} + {{- end }} + {{- if .Values.priorityClassName }} + priorityClassName: {{ .Values.priorityClassName }} + {{- end }} + {{- if .Values.securityContext.enabled }} + securityContext: + fsGroup: {{ .Values.securityContext.fsGroup }} + {{- end }} + {{- if or (and .Values.volumePermissions.enabled .Values.persistence.enabled) .Values.extraInitContainers }} + initContainers: + {{- if and .Values.volumePermissions.enabled .Values.persistence.enabled }} + - name: init-chmod-data + image: busybox:latest + imagePullPolicy: IfNotPresent + command: + - sh + - -c + - | + chown -R {{ .Values.securityContext.runAsUser }}:{{ .Values.securityContext.fsGroup }} /home/coder + securityContext: + runAsUser: {{ .Values.volumePermissions.securityContext.runAsUser }} + volumeMounts: + - name: data + mountPath: /home/coder + {{- end }} +{{- if .Values.extraInitContainers }} +{{ tpl .Values.extraInitContainers . | indent 6}} +{{- end }} + {{- end }} + containers: +{{- if .Values.extraContainers }} +{{ tpl .Values.extraContainers . | indent 8}} +{{- end }} + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- if .Values.securityContext.enabled }} + securityContext: + runAsUser: {{ .Values.securityContext.runAsUser }} + {{- end }} + {{- if .Values.lifecycle.enabled }} + lifecycle: + {{- if .Values.lifecycle.postStart }} + postStart: + {{ toYaml .Values.lifecycle.postStart | nindent 14 }} + {{- end }} + {{- if .Values.lifecycle.preStop }} + preStop: + {{ toYaml .Values.lifecycle.preStop | nindent 14 }} + {{- end }} + {{- end }} + env: + {{- if .Values.extraVars }} +{{ toYaml .Values.extraVars | indent 10 }} + {{- end }} + - name: PASSWORD + valueFrom: + secretKeyRef: + {{- if .Values.existingSecret }} + name: {{ .Values.existingSecret }} + {{- else }} + name: {{ template "code-server.fullname" . }} + {{- end }} + key: password + {{- if .Values.extraArgs }} + args: +{{ toYaml .Values.extraArgs | indent 10 }} + {{- end }} + volumeMounts: + - name: data + mountPath: /home/coder + {{- range .Values.extraConfigmapMounts }} + - name: {{ .name }} + mountPath: {{ .mountPath }} + subPath: {{ .subPath | default "" }} + readOnly: {{ .readOnly }} + {{- end }} + {{- range .Values.extraSecretMounts }} + - name: {{ .name }} + mountPath: {{ .mountPath }} + subPath: {{ .subPath | default "" }} + readOnly: {{ .readOnly }} + {{- end }} + {{- range .Values.extraVolumeMounts }} + - name: {{ .name }} + mountPath: {{ .mountPath }} + subPath: {{ .subPath | default "" }} + readOnly: {{ .readOnly }} + {{- end }} + ports: + - name: http + containerPort: 8080 + protocol: TCP + {{- range .Values.extraPorts }} + - name: {{ .name }} + containerPort: {{ .port }} + protocol: {{ .protocol }} + {{- end }} + {{- if ne .Values.livenessProbe.enabled false }} + livenessProbe: + httpGet: + path: /healthz + port: http + {{- end }} + {{- if ne .Values.readinessProbe.enabled false }} + readinessProbe: + httpGet: + path: /healthz + port: http + {{- end }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- tpl . $ | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ template "code-server.serviceAccountName" . }} + volumes: + - name: data + {{- if .Values.persistence.enabled }} + {{- if not .Values.persistence.hostPath }} + persistentVolumeClaim: + claimName: {{ .Values.persistence.existingClaim | default (include "code-server.fullname" .) }} + {{- else }} + hostPath: + path: {{ .Values.persistence.hostPath }} + type: Directory + {{- end -}} + {{- else }} + emptyDir: {} + {{- end -}} + {{- range .Values.extraSecretMounts }} + - name: {{ .name }} + secret: + secretName: {{ .secretName }} + defaultMode: {{ .defaultMode }} + {{- end }} + {{- range .Values.extraConfigmapMounts }} + - name: {{ .name }} + configMap: + name: {{ .configMap }} + defaultMode: {{ .defaultMode }} + {{- end }} + {{- range .Values.extraVolumeMounts }} + - name: {{ .name }} + {{- if .existingClaim }} + persistentVolumeClaim: + claimName: {{ .existingClaim }} + {{- else if .hostPath }} + hostPath: + path: {{ .hostPath }} + type: Directory + {{- else }} + emptyDir: + {{- toYaml .emptyDir | nindent 10 }} + {{- end }} + {{- end }} diff --git a/ci/helm-chart/templates/ingress.yaml b/ci/helm-chart/templates/ingress.yaml new file mode 100644 index 000000000000..1da432074b29 --- /dev/null +++ b/ci/helm-chart/templates/ingress.yaml @@ -0,0 +1,63 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "code-server.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "code-server.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if .Values.ingress.ingressClassName }} + ingressClassName: {{ .Values.ingress.ingressClassName }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion -}} + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ . }} + pathType: Prefix + backend: + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- end }} + {{- end }} + {{- else -}} + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ . }} + backend: + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} \ No newline at end of file diff --git a/ci/helm-chart/templates/pvc.yaml b/ci/helm-chart/templates/pvc.yaml new file mode 100644 index 000000000000..206b834e930d --- /dev/null +++ b/ci/helm-chart/templates/pvc.yaml @@ -0,0 +1,26 @@ +{{- if and (and .Values.persistence.enabled (not .Values.persistence.existingClaim)) (not .Values.persistence.hostPath) }} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ include "code-server.fullname" . }} + namespace: {{ .Release.Namespace }} +{{- with .Values.persistence.annotations }} + annotations: +{{ toYaml . | indent 4 }} +{{- end }} + labels: + {{- include "code-server.labels" . | nindent 4 }} +spec: + accessModes: + - {{ .Values.persistence.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.size | quote }} +{{- if .Values.persistence.storageClass }} +{{- if (eq "-" .Values.persistence.storageClass) }} + storageClassName: "" +{{- else }} + storageClassName: "{{ .Values.persistence.storageClass }}" +{{- end }} +{{- end }} +{{- end }} diff --git a/ci/helm-chart/templates/secrets.yaml b/ci/helm-chart/templates/secrets.yaml new file mode 100644 index 000000000000..93e75800dffd --- /dev/null +++ b/ci/helm-chart/templates/secrets.yaml @@ -0,0 +1,17 @@ +{{- if not .Values.existingSecret }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "code-server.fullname" . }} + annotations: + "helm.sh/hook": "pre-install" + labels: + {{- include "code-server.labels" . | nindent 4 }} +type: Opaque +data: + {{- if .Values.password }} + password: "{{ .Values.password | b64enc }}" + {{- else }} + password: "{{ randAlphaNum 24 | b64enc }}" + {{- end }} +{{- end }} diff --git a/ci/helm-chart/templates/service.yaml b/ci/helm-chart/templates/service.yaml new file mode 100644 index 000000000000..1b58af0b1acd --- /dev/null +++ b/ci/helm-chart/templates/service.yaml @@ -0,0 +1,22 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "code-server.fullname" . }} + labels: + {{- include "code-server.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + {{- range .Values.extraPorts }} + - port: {{ .port }} + targetPort: {{ .port }} + protocol: {{ .protocol }} + name: {{ .name }} + {{- end }} + selector: + app.kubernetes.io/name: {{ include "code-server.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} diff --git a/ci/helm-chart/templates/serviceaccount.yaml b/ci/helm-chart/templates/serviceaccount.yaml new file mode 100644 index 000000000000..2fa308fec172 --- /dev/null +++ b/ci/helm-chart/templates/serviceaccount.yaml @@ -0,0 +1,8 @@ +{{- if or .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + labels: + {{- include "code-server.labels" . | nindent 4 }} + name: {{ template "code-server.serviceAccountName" . }} +{{- end -}} diff --git a/ci/helm-chart/templates/tests/test-connection.yaml b/ci/helm-chart/templates/tests/test-connection.yaml new file mode 100644 index 000000000000..dd81f8904e06 --- /dev/null +++ b/ci/helm-chart/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "code-server.fullname" . }}-test-connection" + labels: + {{- include "code-server.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "code-server.fullname" . }}:{{ .Values.service.port }}/healthz'] + restartPolicy: Never diff --git a/ci/helm-chart/values.yaml b/ci/helm-chart/values.yaml new file mode 100644 index 000000000000..8013333fb083 --- /dev/null +++ b/ci/helm-chart/values.yaml @@ -0,0 +1,236 @@ +# Default values for code-server. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: codercom/code-server + tag: '4.141.0' + pullPolicy: Always + +# Specifies one or more secrets to be used when pulling images from a +# private container repository +# https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry +imagePullSecrets: [] +# - name: registry-creds + +nameOverride: "" +fullnameOverride: "" +hostnameOverride: "" + +# The existing secret to use for code-server authentication in the frontend. the password is stored in the secret under the key `password` +# existingSecret: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +# Specifies annotations for deployment +annotations: {} + +# code-server.labels -- The Deployment labels. See: +# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ +labels: {} + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +priorityClassName: "" + +service: + type: ClusterIP + port: 8080 + +ingress: + enabled: false + #annotations: + # kubernetes.io/tls-acme: "true" + #hosts: + # - host: code-server.example.loc + # paths: + # - / + ingressClassName: "" + #tls: + # - secretName: code-server + # hosts: + # - code-server.example.loc + +# Optional additional arguments +extraArgs: [] + # These are the arguments normally passed to code-server; run + # code-server --help for a list of available options. + # + # Each argument and parameter must have its own entry; if you use + # --param value on the command line, then enter it here as: + # + # - --param + # - value + # + # If you receive an error like "Unknown option --param value", it may be + # because both the parameter and value are specified as a single argument, + # rather than two separate arguments (e.g. "- --param value" on a line). + +# Optional additional environment variables +extraVars: [] +# - name: DISABLE_TELEMETRY +# value: "true" +# if dind is desired: +# - name: DOCKER_HOST +# value: "tcp://localhost:2376" + +## +## Init containers parameters: +## volumePermissions: Change the owner of the persist volume mountpoint to RunAsUser:fsGroup +## +volumePermissions: + enabled: true + securityContext: + runAsUser: 0 + +## Pod Security Context +## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +## +securityContext: + enabled: true + fsGroup: 1000 + runAsUser: 1000 + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 1000Mi + +livenessProbe: + enabled: true + +readinessProbe: + enabled: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +## Persist data to a persistent volume +persistence: + enabled: true + ## code-server data Persistent Volume Storage Class + ## If defined, storageClassName: + ## If set to "-", storageClassName: "", which disables dynamic provisioning + ## If undefined (the default) or set to null, no storageClassName spec is + ## set, choosing the default provisioner. (gp2 on AWS, standard on + ## GKE, AWS & OpenStack) + ## + # storageClass: "-" + accessMode: ReadWriteOnce + size: 10Gi + annotations: {} + # existingClaim: "" + # hostPath: /data + +lifecycle: + enabled: false + # postStart: + # exec: + # command: + # - /bin/bash + # - -c + # - curl -s -L SOME_SCRIPT | bash + + # for dind, the following may be helpful + # postStart: + # exec: + # command: + # - /bin/sh + # - -c + # - | + # sudo apt-get update \ + # && sudo apt-get install -y docker.io + +## Enable an Specify container in extraContainers. +## This is meant to allow adding code-server dependencies, like docker-dind. +extraContainers: | +# If docker-dind is used, DOCKER_HOST env is mandatory to set in "extraVars" +# - name: docker-dind +# image: docker:28.3.2-dind +# imagePullPolicy: IfNotPresent +# resources: +# requests: +# cpu: 1 +# ephemeral-storage: "50Gi" +# memory: 10Gi +# securityContext: +# privileged: true +# procMount: Default +# env: +# - name: DOCKER_TLS_CERTDIR +# value: "" # disable TLS setup +# command: +# - dockerd +# - --host=unix:///var/run/docker.sock +# - --host=tcp://0.0.0.0:2376 + + +extraInitContainers: | +# - name: customization +# image: {{ .Values.image.repository }}:{{ .Values.image.tag }} +# imagePullPolicy: IfNotPresent +# env: +# - name: SERVICE_URL +# value: https://open-vsx.org/vscode/gallery +# - name: ITEM_URL +# value: https://open-vsx.org/vscode/item +# command: +# - sh +# - -c +# - | +# code-server --install-extension ms-python.python +# code-server --install-extension golang.Go +# volumeMounts: +# - name: data +# mountPath: /home/coder + +## Additional code-server secret mounts +extraSecretMounts: [] + # - name: secret-files + # mountPath: /etc/secrets + # subPath: private.key # (optional) + # secretName: code-server-secret-files + # readOnly: true + +## Additional code-server volume mounts +extraVolumeMounts: [] + # - name: extra-volume + # mountPath: /mnt/volume + # readOnly: true + # existingClaim: volume-claim + # hostPath: "" + # emptyDir: {} + +extraConfigmapMounts: [] + # - name: certs-configmap + # mountPath: /etc/code-server/ssl/ + # subPath: certificates.crt # (optional) + # configMap: certs-configmap + # readOnly: true + +extraPorts: [] + # - name: minecraft + # port: 25565 + # protocol: tcp diff --git a/ci/lib.sh b/ci/lib.sh new file mode 100755 index 000000000000..bd9c5c9c0c53 --- /dev/null +++ b/ci/lib.sh @@ -0,0 +1,127 @@ +#!/usr/bin/env bash +set -euo pipefail + +pushd() { + builtin pushd "$@" > /dev/null +} + +popd() { + builtin popd > /dev/null +} + +vscode_version() { + jq -r .version lib/vscode/package.json +} + +os() { + osname=$(uname | tr '[:upper:]' '[:lower:]') + case $osname in + linux) + # Alpine's ldd doesn't have a version flag but if you use an invalid flag + # (like --version) it outputs the version to stderr and exits with 1. + # TODO: Better to check /etc/os-release; see ../install.sh. + ldd_output=$(ldd --version 2>&1 || true) + if echo "$ldd_output" | grep -iq musl; then + osname="alpine" + fi + ;; + darwin) osname="macos" ;; + cygwin* | mingw*) osname="windows" ;; + esac + echo "$osname" +} + +arch() { + cpu="$(uname -m)" + case "$cpu" in + aarch64) cpu=arm64 ;; + x86_64) cpu=amd64 ;; + esac + echo "$cpu" +} + +rsync() { + command rsync -a --del "$@" +} + +if [[ ! ${ARCH-} ]]; then + ARCH=$(arch) + export ARCH +fi + +# Windows predefines OS as Windows_NT for every process, so on a windows shell +# the check below would always find a value and never call os(). That is not a +# name this build knows, so it does not count as one the caller chose. +if [[ ! ${OS-} || ${OS-} == "Windows_NT" ]]; then + OS=$(os) + export OS +fi + +# RELEASE_PATH is the destination directory for the release from the root. +# Defaults to release +if [[ ! ${RELEASE_PATH-} ]]; then + RELEASE_PATH="release" + export RELEASE_PATH +fi + +nodeOS() { + osname=$OS + case $osname in + macos) osname=darwin ;; + windows) osname=win32 ;; + esac + echo "$osname" +} + +nodeArch() { + cpu=$ARCH + case $cpu in + amd64) cpu=x64 ;; + esac + echo "$cpu" +} + +run-steps() { + local -i failed=0 + mkdir -p .cache + rm -f .cache/checklist + while (( $# )) ; do + local name=$1 ; shift + local fn=$1 ; shift + echo "$name..." + # Only run if an earlier step has not failed. + # For all failed steps, write out an empty checkbox. + if [[ $failed == 0 ]] ; then + if $fn | indent ; then + echo "- [X] $name" >> .cache/checklist + else + ((failed++)) + echo "- [ ] $name" >> .cache/checklist + echo "Failed" | indent + fi + else + echo "- [ ] $name" >> .cache/checklist + echo "Skipped" | indent + fi + done + if [[ $failed != 0 ]] ; then + return 1 + fi +} + +quiet() { + "$@" >/dev/null +} + +indent() { + local count=2 + local space + space=$(printf "%${count}s") + sed "s/^/$space| /g" +} + +# See gulpfile.reh.ts for available targets. +if [[ ! ${VSCODE_TARGET-} ]]; then + VSCODE_TARGET="$(nodeOS)-$(nodeArch)" + export VSCODE_TARGET +fi diff --git a/ci/release-image/Dockerfile b/ci/release-image/Dockerfile new file mode 100644 index 000000000000..4c91e291e0e8 --- /dev/null +++ b/ci/release-image/Dockerfile @@ -0,0 +1,61 @@ +# syntax=docker/dockerfile:experimental + +ARG BASE=debian:13 +FROM scratch AS packages +COPY release-packages/code-server*.deb /tmp/ + +FROM $BASE + +RUN apt-get update \ + && apt-get install -y \ + curl \ + dumb-init \ + git \ + git-lfs \ + htop \ + locales \ + lsb-release \ + man-db \ + nano \ + openssh-client \ + procps \ + sudo \ + vim-tiny \ + wget \ + zsh \ + && git lfs install \ + && rm -rf /var/lib/apt/lists/* + +# https://wiki.debian.org/Locale#Manually +RUN sed -i "s/# en_US.UTF-8/en_US.UTF-8/" /etc/locale.gen \ + && locale-gen +ENV LANG=en_US.UTF-8 + +RUN if grep -q 1000 /etc/passwd; then \ + userdel -r "$(id -un 1000)"; \ + fi \ + && adduser --gecos '' --disabled-password coder \ + && echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd + +RUN ARCH="$(dpkg --print-architecture)" \ + && curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v0.6.0/fixuid-0.6.0-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - \ + && chown root:root /usr/local/bin/fixuid \ + && chmod 4755 /usr/local/bin/fixuid \ + && mkdir -p /etc/fixuid \ + && printf "user: coder\ngroup: coder\n" > /etc/fixuid/config.yml + +COPY ci/release-image/entrypoint.sh /usr/bin/entrypoint.sh +RUN --mount=from=packages,src=/tmp,dst=/tmp/packages dpkg -i /tmp/packages/code-server*$(dpkg --print-architecture).deb + +# Allow users to have scripts run on container startup to prepare workspace. +# https://github.com/coder/code-server/issues/5177 +ENV ENTRYPOINTD=${HOME}/entrypoint.d + +EXPOSE 8080 +# This way, if someone sets $DOCKER_USER, docker-exec will still work as +# the uid will remain the same. note: only relevant if -u isn't passed to +# docker-run. +USER 1000 +ENV USER=coder +WORKDIR /home/coder +ENTRYPOINT ["/usr/bin/entrypoint.sh", "--bind-addr", "0.0.0.0:8080", "."] diff --git a/ci/release-image/Dockerfile.fedora b/ci/release-image/Dockerfile.fedora new file mode 100644 index 000000000000..ec618530cb78 --- /dev/null +++ b/ci/release-image/Dockerfile.fedora @@ -0,0 +1,51 @@ +# syntax=docker/dockerfile:experimental + +ARG BASE=fedora:39 +FROM scratch AS packages +COPY release-packages/code-server*.rpm /tmp/ + +FROM $BASE + +RUN dnf update -y \ + && dnf install -y \ + curl \ + git \ + git-lfs \ + htop \ + nano \ + openssh-clients \ + procps \ + wget \ + zsh \ + dumb-init \ + glibc-langpack-en \ + && rm -rf /var/cache/dnf +RUN git lfs install + +ENV LANG=en_US.UTF-8 +RUN echo 'LANG="en_US.UTF-8"' > /etc/locale.conf + +RUN useradd -u 1000 coder && echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd + +RUN ARCH="$(uname -m | sed 's/x86_64/amd64/g' | sed 's/aarch64/arm64/g')" \ + && curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v0.6.0/fixuid-0.6.0-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - \ + && chown root:root /usr/local/bin/fixuid \ + && chmod 4755 /usr/local/bin/fixuid \ + && mkdir -p /etc/fixuid \ + && printf "user: coder\ngroup: coder\n" > /etc/fixuid/config.yml + +COPY ci/release-image/entrypoint.sh /usr/bin/entrypoint.sh +RUN --mount=from=packages,src=/tmp,dst=/tmp/packages rpm -i /tmp/packages/code-server*$(uname -m | sed 's/x86_64/amd64/g' | sed 's/aarch64/arm64/g').rpm + +# Allow users to have scripts run on container startup to prepare workspace. +# https://github.com/coder/code-server/issues/5177 +ENV ENTRYPOINTD=${HOME}/entrypoint.d + +EXPOSE 8080 +# This way, if someone sets $DOCKER_USER, docker-exec will still work as +# the uid will remain the same. note: only relevant if -u isn't passed to +# docker-run. +USER 1000 +ENV USER=coder +WORKDIR /home/coder +ENTRYPOINT ["/usr/bin/entrypoint.sh", "--bind-addr", "0.0.0.0:8080", "."] diff --git a/ci/release-image/Dockerfile.opensuse b/ci/release-image/Dockerfile.opensuse new file mode 100644 index 000000000000..f445d45c27b1 --- /dev/null +++ b/ci/release-image/Dockerfile.opensuse @@ -0,0 +1,51 @@ +# syntax=docker/dockerfile:experimental + +ARG BASE=opensuse/tumbleweed +FROM scratch AS packages +COPY release-packages/code-server*.rpm /tmp/ + +FROM $BASE + +RUN zypper dup -y \ + && zypper in -y \ + curl \ + git \ + git-lfs \ + htop \ + nano \ + openssh-clients \ + procps \ + wget \ + zsh \ + sudo \ + catatonit \ + && rm -rf /var/cache/zypp /var/cache/zypper +RUN git lfs install + +ENV LANG=en_US.UTF-8 +RUN echo 'LANG="en_US.UTF-8"' > /etc/locale.conf + +RUN useradd -u 1000 coder && echo "coder ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers.d/nopasswd + +RUN ARCH="$(uname -m | sed 's/x86_64/amd64/g' | sed 's/aarch64/arm64/g')" \ + && curl -fsSL "https://github.com/boxboat/fixuid/releases/download/v0.6.0/fixuid-0.6.0-linux-$ARCH.tar.gz" | tar -C /usr/local/bin -xzf - \ + && chown root:root /usr/local/bin/fixuid \ + && chmod 4755 /usr/local/bin/fixuid \ + && mkdir -p /etc/fixuid \ + && printf "user: coder\ngroup: coder\n" > /etc/fixuid/config.yml + +COPY ci/release-image/entrypoint-catatonit.sh /usr/bin/entrypoint-catatonit.sh +RUN --mount=from=packages,src=/tmp,dst=/tmp/packages rpm -i /tmp/packages/code-server*$(uname -m | sed 's/x86_64/amd64/g' | sed 's/aarch64/arm64/g').rpm + +# Allow users to have scripts run on container startup to prepare workspace. +# https://github.com/coder/code-server/issues/5177 +ENV ENTRYPOINTD=${HOME}/entrypoint.d + +EXPOSE 8080 +# This way, if someone sets $DOCKER_USER, docker-exec will still work as +# the uid will remain the same. note: only relevant if -u isn't passed to +# docker-run. +USER 1000 +ENV USER=coder +WORKDIR /home/coder +ENTRYPOINT ["/usr/bin/entrypoint-catatonit.sh", "--bind-addr", "0.0.0.0:8080", "."] diff --git a/ci/release-image/docker-bake.hcl b/ci/release-image/docker-bake.hcl new file mode 100644 index 000000000000..ecb0c313daed --- /dev/null +++ b/ci/release-image/docker-bake.hcl @@ -0,0 +1,130 @@ +# Use this file from the top of the repo, with `-f ci/release-image/docker-bake.hcl` + +# Uses env var VERSION if set; +# normally, this is set by ci/lib.sh +variable "VERSION" { + default = "latest" +} + +variable "DOCKER_REGISTRY" { + default = "docker.io/codercom/code-server" +} + +variable "GITHUB_REGISTRY" { + default = "ghcr.io/coder/code-server" +} + +group "default" { + targets = [ + "code-server-debian-13", + "code-server-debian-12", + "code-server-ubuntu-focal", + "code-server-ubuntu-noble", + "code-server-ubuntu-resolute", + "code-server-fedora-39", + "code-server-opensuse-tumbleweed", + ] +} + +function "prepend_hyphen_if_not_null" { + params = [tag] + result = notequal("","${tag}") ? "-${tag}" : "${tag}" +} + +# use empty tag (tag="") to generate default tags +function "gen_tags" { + params = [registry, tag] + result = notequal("","${registry}") ? [ + notequal("", "${tag}") ? "${registry}:${tag}" : "${registry}:latest", + notequal("latest",VERSION) ? "${registry}:${VERSION}${prepend_hyphen_if_not_null(tag)}" : "", + ] : [] +} + +# helper function to generate tags for docker registry and github registry. +# set (DOCKER|GITHUB)_REGISTRY="" to disable corresponding registry +function "gen_tags_for_docker_and_ghcr" { + params = [tag] + result = concat( + gen_tags("${DOCKER_REGISTRY}", "${tag}"), + gen_tags("${GITHUB_REGISTRY}", "${tag}"), + ) +} + +target "code-server-debian-13" { + dockerfile = "ci/release-image/Dockerfile" + tags = concat( + gen_tags_for_docker_and_ghcr(""), + gen_tags_for_docker_and_ghcr("debian"), + gen_tags_for_docker_and_ghcr("trixie"), + ) + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-debian-12" { + dockerfile = "ci/release-image/Dockerfile" + tags = concat( + gen_tags_for_docker_and_ghcr("bookworm"), + ) + args = { + BASE = "debian:12" + } + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-ubuntu-focal" { + dockerfile = "ci/release-image/Dockerfile" + tags = concat( + gen_tags_for_docker_and_ghcr("focal"), + ) + args = { + BASE = "ubuntu:focal" + } + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-ubuntu-noble" { + dockerfile = "ci/release-image/Dockerfile" + tags = concat( + gen_tags_for_docker_and_ghcr("noble"), + gen_tags_for_docker_and_ghcr("ubuntu"), + ) + args = { + BASE = "ubuntu:noble" + } + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-ubuntu-resolute" { + dockerfile = "ci/release-image/Dockerfile" + tags = concat( + gen_tags_for_docker_and_ghcr("resolute"), + ) + args = { + BASE = "ubuntu:resolute" + } + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-fedora-39" { + dockerfile = "ci/release-image/Dockerfile.fedora" + tags = concat( + gen_tags_for_docker_and_ghcr("fedora"), + gen_tags_for_docker_and_ghcr("39"), + ) + args = { + BASE = "fedora:39" + } + platforms = ["linux/amd64", "linux/arm64"] +} + +target "code-server-opensuse-tumbleweed" { + dockerfile = "ci/release-image/Dockerfile.opensuse" + tags = concat( + gen_tags_for_docker_and_ghcr("opensuse"), + gen_tags_for_docker_and_ghcr("tumbleweed"), + ) + args = { + BASE = "opensuse/tumbleweed" + } + platforms = ["linux/amd64", "linux/arm64"] +} diff --git a/ci/release-image/entrypoint-catatonit.sh b/ci/release-image/entrypoint-catatonit.sh new file mode 100755 index 000000000000..d22acc6d237b --- /dev/null +++ b/ci/release-image/entrypoint-catatonit.sh @@ -0,0 +1,27 @@ +#!/bin/sh +set -eu + +# We do this first to ensure sudo works below when renaming the user. +# Otherwise the current container UID may not exist in the passwd database. +eval "$(fixuid -q)" + +if [ "${DOCKER_USER-}" ]; then + USER="$DOCKER_USER" + if [ "$DOCKER_USER" != "$(whoami)" ]; then + echo "$DOCKER_USER ALL=(ALL) NOPASSWD:ALL" | sudo tee -a /etc/sudoers.d/nopasswd > /dev/null + # Unfortunately we cannot change $HOME as we cannot move any bind mounts + # nor can we bind mount $HOME into a new home as that requires a privileged container. + sudo usermod --login "$DOCKER_USER" coder + sudo groupmod -n "$DOCKER_USER" coder + + sudo sed -i "/coder/d" /etc/sudoers.d/nopasswd + fi +fi + +# Allow users to have scripts run on container startup to prepare workspace. +# https://github.com/coder/code-server/issues/5177 +if [ -d "${ENTRYPOINTD}" ]; then + find "${ENTRYPOINTD}" -type f -executable -print -exec {} \; +fi + +exec catatonit -- /usr/bin/code-server "$@" diff --git a/ci/release-image/entrypoint.sh b/ci/release-image/entrypoint.sh new file mode 100755 index 000000000000..efe2f39d9bd9 --- /dev/null +++ b/ci/release-image/entrypoint.sh @@ -0,0 +1,27 @@ +#!/bin/sh +set -eu + +# We do this first to ensure sudo works below when renaming the user. +# Otherwise the current container UID may not exist in the passwd database. +eval "$(fixuid -q)" + +if [ "${DOCKER_USER-}" ]; then + USER="$DOCKER_USER" + if [ -z "$(id -u "$DOCKER_USER" 2>/dev/null)" ]; then + echo "$DOCKER_USER ALL=(ALL) NOPASSWD:ALL" | sudo tee -a /etc/sudoers.d/nopasswd > /dev/null + # Unfortunately we cannot change $HOME as we cannot move any bind mounts + # nor can we bind mount $HOME into a new home as that requires a privileged container. + sudo usermod --login "$DOCKER_USER" coder + sudo groupmod -n "$DOCKER_USER" coder + + sudo sed -i "/coder/d" /etc/sudoers.d/nopasswd + fi +fi + +# Allow users to have scripts run on container startup to prepare workspace. +# https://github.com/coder/code-server/issues/5177 +if [ -d "${ENTRYPOINTD}" ]; then + find "${ENTRYPOINTD}" -type f -executable -print -exec {} \; +fi + +exec dumb-init /usr/bin/code-server "$@" diff --git a/ci/steps/docker-buildx-push.sh b/ci/steps/docker-buildx-push.sh new file mode 100755 index 000000000000..6314063ffa54 --- /dev/null +++ b/ci/steps/docker-buildx-push.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +set -euo pipefail + +main() { + cd "$(dirname "$0")/../.." + # NOTE@jsjoeio - this script assumes VERSION exists as an + # environment variable. + + # NOTE@jsjoeio - this script assumes that you've downloaded + # the release-packages artifact to ./release-packages before + # running this docker buildx step + docker buildx bake -f ci/release-image/docker-bake.hcl --push +} + +main "$@" diff --git a/ci/steps/steps-lib.sh b/ci/steps/steps-lib.sh new file mode 100755 index 000000000000..e71378e27f6c --- /dev/null +++ b/ci/steps/steps-lib.sh @@ -0,0 +1,47 @@ +#!/usr/bin/env bash + +# This is a library which contains functions used inside ci/steps +# +# We separated it into it's own file so that we could easily unit test +# these functions and helpers + +# Checks whether and environment variable is set. +# Source: https://stackoverflow.com/a/62210688/3015595 +is_env_var_set() { + local name="${1:-}" + if test -n "${!name:-}"; then + return 0 + else + return 1 + fi +} + +# Checks whether a directory exists. +directory_exists() { + local dir="${1:-}" + if [[ -d "${dir:-}" ]]; then + return 0 + else + return 1 + fi +} + +# Checks whether a file exists. +file_exists() { + local file="${1:-}" + if test -f "${file:-}"; then + return 0 + else + return 1 + fi +} + +# Checks whether a file is executable. +is_executable() { + local file="${1:-}" + if [ -f "${file}" ] && [ -r "${file}" ] && [ -x "${file}" ]; then + return 0 + else + return 1 + fi +} diff --git a/doc/assets/cros.png b/doc/assets/cros.png deleted file mode 100644 index 64d94c23098d..000000000000 Binary files a/doc/assets/cros.png and /dev/null differ diff --git a/doc/assets/droplet.svg b/doc/assets/droplet.svg deleted file mode 100644 index ecbb3f249de1..000000000000 --- a/doc/assets/droplet.svg +++ /dev/null @@ -1,24 +0,0 @@ - - - - do-btn-blue-ghost - Created with Sketch. - - - - - - - - - - - - - - Create a Droplet - - - - - diff --git a/doc/assets/ide.gif b/doc/assets/ide.gif deleted file mode 100644 index c8183c1e9fe4..000000000000 Binary files a/doc/assets/ide.gif and /dev/null differ diff --git a/doc/assets/release.gif b/doc/assets/release.gif deleted file mode 100644 index b8ad499732b0..000000000000 Binary files a/doc/assets/release.gif and /dev/null differ diff --git a/doc/cros-install.md b/doc/cros-install.md deleted file mode 100644 index 0c12b6db5588..000000000000 --- a/doc/cros-install.md +++ /dev/null @@ -1,75 +0,0 @@ -# Installing code-server in your ChromiumOS/ChromeOS/CloudReady machine - -This guide will show you how to install code-server into your CrOS machine. - -## Using Crostini - -One of the easier ways to run code-server is via -[Crostini](https://www.aboutchromebooks.com/tag/project-crostini/), the Linux -apps support feature in CrOS. Make sure you have enough RAM, HDD space and your -CPU has VT-x/ AMD-V support. If your chromebook has this, then you are -qualified to use Crostini. - -If you are running R69, you might want to enable this on -[Chrome Flags](chrome://flags/#enable-experimental-crostini-ui). -If you run R72, however, this is already enabled for you. - -After checking your prerequisites, follow the steps in [the self-host install guide](index.md) -on installing code-server. Once done, make sure code-server works by running -it. After running it, simply go to `penguin.linux.test:8080` to access -code-server. Now you should be greeted with this screen. If you did, -congratulations, you have installed code-server in your Chromebook! - -![code-server on Chromebook](assets/cros.png) - -Alternatively, if you ran code-server in another container and you need the IP -for that specific container, simply go to Termina's shell via `crosh` and type -`vsh termina`. - -```bash -Loading extra module: /usr/share/crosh/dev.d/50-crosh.sh -Welcome to crosh, the Chrome OS developer shell. - -If you got here by mistake, don't panic! Just close this tab and carry on. - -Type 'help' for a list of commands. - -If you want to customize the look/behavior, you can use the options page. -Load it by using the Ctrl+Shift+P keyboard shortcut. - -crosh> vsh termina -(termina) chronos@localhost ~ $ -``` -While in termina, run `lxc list`. It should output the list of running containers. - -```bash -(termina) chronos@localhost ~ $ lxc list -+---------|---------|-----------------------|------|------------|-----------+ -| NAME | STATE | IPV4 | IPV6 | TYPE | SNAPSHOTS | -+---------|---------|-----------------------|------|------------|-----------+ -| penguin | RUNNING | 100.115.92.199 (eth0) | | PERSISTENT | 0 | -+---------|---------|-----------------------|------|------------|-----------+ -(termina) chronos@localhost ~ $ -``` - -For this example, we show the default `penguin` container, which is exposed on -`eth0` at 100.115.92.199. Simply enter the IP of the container where the -code-server runs to Chrome. - -## Using Crouton - -[Crouton](https://github.com/dnschneid/crouton) is one of the old ways to get a -running full Linux via `chroot` on a Chromebook. To use crouton, enable -developer mode and go to `crosh`. This time, run `shell`, which should drop you -to `bash`. - -Make sure you downloaded `crouton`, if so, go ahead and run it under -`~/Downloads`. After installing your chroot container via crouton, go ahead and -enter `enter-chroot` to enter your container. - -Follow the instructions set in [the self-host install guide](index.md) to -install code-server. After that is done, run `code-server` and verify it works -by going to `localhost:8080`. - -> At this point in writing, `localhost` seems to work in this method. However, -> the author is not sure if it applies still to newer Chromebooks. diff --git a/doc/deploy.md b/doc/deploy.md deleted file mode 100644 index f2505e507a8e..000000000000 --- a/doc/deploy.md +++ /dev/null @@ -1,73 +0,0 @@ -# Set up instance -## EC2 on AWS -- Click **Launch Instance** from your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home). -- Select the Ubuntu Server 18.04 LTS (HVM), SSD Volume Type -- Select an appropriate instance size (we recommend t2.medium/large, depending - on team size and number of repositories/languages enabled), then - **Next: Configure Instance Details**. -- Select **Next: ...** until you get to the **Configure Security Group** page, - then add a **Custom TCP Rule** rule with port range set to `8080` and source - set to "Anywhere". - > Rules with source of 0.0.0.0/0 allow all IP addresses to access your - > instance. We recommend setting [security group rules](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html?icmpid=docs_ec2_console) - > to allow access from known IP addresses only. -- Click **Launch**. -- You will be prompted to create a key pair. -- From the dropdown choose "create a new pair", give the key pair a name. -- Click **Download Key Pair** and store the file in a safe place. -- Click **Launch Instances**. -- Head to your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home) - and choose instances from the left panel. -- In the description of your EC2 instance copy the public DNS (iPv4) address - using the copy to clipboard button. -- Open a terminal on your computer and SSH into your instance: - ``` - ssh -i ${path to key pair} ubuntu@${public address} - ``` - -## DigitalOcean -[Open your DigitalOcean dashboard](https://cloud.digitalocean.com/droplets/new) -to create a new droplet - -- **Choose an image -** Select the **Distributions** tab and then choose Ubuntu. -- **Choose a size -** We recommend at least 4GB RAM and 2 CPU, more depending - on team size and number of repositories/languages enabled. -- Launch your instance. -- Open a terminal on your computer and SSH into your instance: - ``` - ssh root@${instance ip} - ``` - -## Google Cloud -> Pre-requisite: Set up the [Google Cloud SDK](https://cloud.google.com/sdk/docs/) -> on your local machine - -- [Open your Google Cloud console](https://console.cloud.google.com/compute/instances) - to create a new VM instance and click **Create Instance**. -- Choose an appropriate machine type (we recommend 2 vCPU and 7.5 GB RAM, more - depending on team size and number of repositories/languages enabled). -- Choose Ubuntu 16.04 LTS as your boot disk. -- Expand the "Management, security, disks, networking, sole tenancy" section, - go to the "Networking" tab, then under network tags add "code-server". -- Create your VM, and **take note** of its public IP address. -- Visit "VPC network" in the console and go to "Firewall rules". Create a new - firewall rule called "http-8080". Under "Target tags" add "code-server", and - under "Protocols and ports" tick "Specified protocols and ports" and "tcp". - Beside "tcp", add "8080", then create the rule. -- Open a terminal on your computer and SSH into your Google Cloud VM: - ``` - gcloud compute ssh --zone ${region} ${instance name} - ``` -# Run code-server -- Download the latest code-server release from the - [releases page](https://github.com/cdr/code-server/releases/latest) - to the instance, extract the file, then run the code-server binary: - ``` - wget https://github.com/cdr/code-server/releases/download/{version}/code-server{version}-linux-x64.tar.gz - tar -xvzf code-server{version}-linux-x64.tar.gz - cd code-server{version}-linux-x64 - ./code-server - ``` -- Open your browser and visit http://$public_ip:8080/ where `$public_ip` is - your instance's public IP address. -- For long-term use, set up a systemd service to run code-server. diff --git a/doc/examples/fail2ban.conf b/doc/examples/fail2ban.conf deleted file mode 100644 index 2c00872446d5..000000000000 --- a/doc/examples/fail2ban.conf +++ /dev/null @@ -1,15 +0,0 @@ -# Fail2Ban filter for code-server - -[Definition] - -failregex = ^INFO\s+Failed login attempt\s+{\"password\":\"(\\.|[^"])*\",\"remoteAddress\":\"\" - -# Use this instead for proxies (ensure the proxy is configured to send the -# X-Forwarded-For header). -# failregex = ^INFO\s+Failed login attempt\s+{\"password\":\"(\\.|[^"])*\",\"xForwardedFor\":\"\" - -ignoreregex = - -datepattern = "timestamp":{EPOCH}}$ - -# Author: Dean Sheather diff --git a/doc/examples/kubernetes.aws.yaml b/doc/examples/kubernetes.aws.yaml deleted file mode 100644 index 079da4b47460..000000000000 --- a/doc/examples/kubernetes.aws.yaml +++ /dev/null @@ -1,73 +0,0 @@ -apiVersion: v1 -kind: Namespace -metadata: - name: code-server ---- -apiVersion: v1 -kind: Service -metadata: - name: code-server - namespace: code-server -spec: - ports: - - port: 8080 - name: https - protocol: TCP - selector: - app: code-server - type: ClusterIP ---- -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: gp2 - annotations: - storageclass.kubernetes.io/is-default-class: "true" -provisioner: kubernetes.io/aws-ebs -parameters: - type: gp2 - fsType: ext4 ---- -kind: PersistentVolumeClaim -apiVersion: v1 -metadata: - name: code-store - namespace: code-server -spec: - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 60Gi ---- -apiVersion: extensions/v1beta1 -kind: Deployment -metadata: - labels: - app: code-server - name: code-server - namespace: code-server -spec: - selector: - matchLabels: - app: code-server - replicas: 1 - template: - metadata: - labels: - app: code-server - spec: - containers: - - image: codercom/code-server:v2 - imagePullPolicy: Always - name: code-servery - ports: - - containerPort: 8080 - name: https - volumeMounts: - - name: code-server-storage - mountPath: /go/src - volumes: - - name: code-server-storage - persistentVolumeClaim: - claimName: code-store diff --git a/doc/examples/kubernetes.yaml b/doc/examples/kubernetes.yaml deleted file mode 100644 index 6259689d3283..000000000000 --- a/doc/examples/kubernetes.yaml +++ /dev/null @@ -1,43 +0,0 @@ -apiVersion: v1 -kind: Namespace -metadata: - name: code-server ---- -apiVersion: v1 -kind: Service -metadata: - name: code-server - namespace: code-server -spec: - ports: - - port: 8080 - name: https - protocol: TCP - selector: - app: code-server - type: ClusterIP ---- -apiVersion: extensions/v1beta1 -kind: Deployment -metadata: - labels: - app: code-server - name: code-server - namespace: code-server -spec: - selector: - matchLabels: - app: code-server - replicas: 1 - template: - metadata: - labels: - app: code-server - spec: - containers: - - image: codercom/code-server:v2 - imagePullPolicy: Always - name: code-server - ports: - - containerPort: 8080 - name: https diff --git a/doc/fail2ban.md b/doc/fail2ban.md deleted file mode 100644 index 18fbcfee6192..000000000000 --- a/doc/fail2ban.md +++ /dev/null @@ -1,35 +0,0 @@ -# Protecting code-server from bruteforce attempts -code-server outputs all failed login attempts, along with the IP address, -provided password, user agent and timestamp by default. - -When using a reverse proxy such as Nginx or Apache, the remote address may -appear to be `127.0.0.1` or a similar address so `X-Forwarded-For` should be -used instead. Ensure that you are setting this value in your reverse proxy: - -Nginx: -``` -location / { - ... - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - ... -} -``` - -Apache: -``` - - ... - SetEnvIf X-Forwarded-For "^.*\..*\..*\..*" forwarded - ... - -``` - -It is extremely important that you ensure that your code-server instance is not -accessible from the internet (use localhost or block it in your firewall). - -## Fail2Ban -Fail2Ban allows for automatically banning and logging repeated failed -authentication attempts for many applications through regex filters. A working -filter for code-server can be found in `./code-server.fail2ban.conf`. Once this -is installed and configured correctly, repeated failed login attempts should -automatically be banned from connecting to your server. diff --git a/doc/quickstart.md b/doc/quickstart.md deleted file mode 100644 index db76d15fcafb..000000000000 --- a/doc/quickstart.md +++ /dev/null @@ -1,107 +0,0 @@ -# Quickstart Guide -1. Visit the [releases page](https://github.com/cdr/code-server/releases) and - download the latest binary for your operating system. -2. Unpack the downloaded file then run the binary. -3. In your browser navigate to `localhost:8080`. - -## Usage -Run `code-server --help` to view available options. - -### Encrypting traffic with HTTPS -To encrypt the traffic between the browser and server use `code-server --cert` -followed by the path to your certificate. Additionally, you can use certificate -keys with `--cert-key` followed by the path to your key. If you pass `--cert` -without any path code-server will generate a self-signed certificate. - -You can use [Let's Encrypt](https://letsencrypt.org/) to get an SSL certificate -for free. - -### Nginx Reverse Proxy -The trailing slashes are important. - -``` -server { - listen 80; - listen [::]:80; - server_name code.example.com code.example.org; - location /some/path/ { # Or / if hosting at the root. - proxy_pass http://localhost:8080/; - proxy_set_header Host $host; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection upgrade; - proxy_set_header Accept-Encoding gzip; - } -} -``` - -### Apache Reverse Proxy -``` - - ServerName code.example.com - - RewriteEngine On - RewriteCond %{HTTP:Upgrade} =websocket [NC] - RewriteRule /(.*) ws://localhost:8080/$1 [P,L] - RewriteCond %{HTTP:Upgrade} !=websocket [NC] - RewriteRule /(.*) http://localhost:8080/$1 [P,L] - - ProxyRequests off - ProxyPass / http://localhost:8080/ nocanon - ProxyPassReverse / http://localhost:8080/ - -``` - -### Run automatically at startup - -In some cases you might need to run code-server automatically once the host starts. You may use your local init service to do so. - -#### Systemd - -```ini -[Unit] -Description=Code Server IDE -After=network.target - -[Service] -Type=simple -User= -EnvironmentFile=$HOME/.profile -WorkingDirectory=$HOME -Restart=on-failure -RestartSec=10 - -ExecStart= $(pwd) - -StandardOutput=file:/var/log/code-server-output.log -StandardError=file:/var/log/code-server-error.log - -[Install] -WantedBy=multi-user.target -``` - -#### OpenRC - -```sh -#!/sbin/openrc-run - -depend() { - after net-online - need net -} - -supervisor=supervise-daemon -name="code-server" -command="/opt/cdr/code-server" -command_args="" - -pidfile="/var/run/cdr.pid" -respawn_delay=5 - -set -o allexport -if [ -f /etc/environment ]; then source /etc/environment; fi -set +o allexport -``` - -#### Kubernetes/Docker - -Make sure you set your restart policy to always - this will ensure your container starts as the daemon starts. diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 000000000000..168eac481bb7 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,92 @@ + + + +# Contributor Covenant Code of Conduct + +- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) + - [Our Pledge](#our-pledge) + - [Our Standards](#our-standards) + - [Our Responsibilities](#our-responsibilities) + - [Scope](#scope) + - [Enforcement](#enforcement) + - [Attribution](#attribution) + + + + +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource@coder.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000000..d857b20c3850 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,288 @@ + + + +# Contributing + +- [Requirements](#requirements) + - [Linux-specific requirements](#linux-specific-requirements) +- [Development workflow](#development-workflow) + - [Version updates to Code](#version-updates-to-code) + - [Patching Code](#patching-code) + - [Build](#build) + - [Troubleshooting](#troubleshooting) + - [I see "Forbidden access" when I load code-server in the browser](#i-see-forbidden-access-when-i-load-code-server-in-the-browser) + - ["Can only have one anonymous define call per script"](#can-only-have-one-anonymous-define-call-per-script) + - [Help](#help) +- [Test](#test) + - [Unit tests](#unit-tests) + - [Script tests](#script-tests) + - [Integration tests](#integration-tests) + - [End-to-end tests](#end-to-end-tests) +- [Structure](#structure) + - [Modifications to Code](#modifications-to-code) + - [Currently Known Issues](#currently-known-issues) + + + + +## Requirements + +The prerequisites for contributing to code-server are almost the same as those +for [VS Code](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). +Here is what is needed: + +- `node` v24.x +- `git` v2.x or greater +- [`git-lfs`](https://git-lfs.github.com) +- [`npm`](https://www.npmjs.com/) + - Used to install JS packages and run scripts +- [`nfpm`](https://nfpm.goreleaser.com/) + - Used to build `.deb` and `.rpm` packages +- [`jq`](https://stedolan.github.io/jq/) + - Used to build code-server releases +- [`gnupg`](https://gnupg.org/index.html) + - All commits must be signed and verified; see GitHub's [Managing commit + signature + verification](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification) + or follow [this tutorial](https://joeprevite.com/verify-commits-on-github) +- `quilt` + - Used to manage patches to Code +- `rsync` and `unzip` + - Used for code-server releases +- `bats` + - Used to run script unit tests + +### Linux-specific requirements + +If you're developing code-server on Linux, make sure you have installed or +install the following dependencies: + +```shell +sudo apt-get install build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev libkrb5-dev python-is-python3 +``` + +These are required by Code. See [their Wiki](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites) +for more information. + +## Development workflow + +1. `git clone https://github.com/coder/code-server.git` - Clone `code-server` +2. `git submodule update --init` - Clone `vscode` submodule +3. `quilt push -a` - Apply patches to the `vscode` submodule. +4. `npm install` - Install dependencies +5. `npm run watch` - Launch code-server localhost:8080. code-server will be live + reloaded when changes are made; the browser needs to be refreshed manually. + +When pulling down changes that include modifications to the patches you will +need to apply them with `quilt`. If you pull down changes that update the +`vscode` submodule you will need to run `git submodule update --init` and +re-apply the patches. + +When you make a change that affects people deploying the marketplace please +update the changelog as part of your PR. + +Note that building code-server takes a very, very long time, and loading it in +the browser in development mode also takes a very, very long time. + +Display language (Spanish, etc) support only works in a full build; it will not +work in development mode. + +Generally we prefer that PRs be squashed into `main` but you can rebase or merge +if it is important to keep the individual commits (make sure to clean up the +commits first if you are doing this). + +### Version updates to Code + +PRs will be automatically created with updates to VS Code. If a patch cannot be +automatically resolved, it will be necessary to clone the branch, resolve the +conflicts manually, and finish the update. To do this: + +1. Apply as many patches as possible `quilt push -a`. +2. Once you hit a conflict, force apply with `quilt push -f`, manually add back + the rejected code, then run `quilt refresh`. +3. Once all patches have been resolved, run `./ci/build/update.sh` to finish the + update process. +4. Commit all changes, push them up to the branch, and update the checklist in + the PR description. + +Once the PR is ready, manually verify that the unreleased changelog section +contains all the changes going into this version before merging. + +### Patching Code + +1. You can go through the patch stack with `quilt push` and `quilt pop`. +2. Create a new patch (`quilt new {name}.diff`) or use an existing patch. +3. Add the file(s) you are patching (`quilt add [-P patch] {file}`). A file + **must** be added before you make changes to it. +4. Make your changes. Patches do not need to be independent of each other but + each patch must result in a working code-server without any broken in-between + states otherwise they are difficult to test and modify. +5. Add your changes to the patch (`quilt refresh`) +6. Add a comment in the patch about the reason for the patch and how to + reproduce the behavior it fixes or adds. Every patch should have an e2e test + as well. + +### Build + +You can build a full production release as follows: + +```shell +git submodule update --init +quilt push -a +npm install +npm run build +VERSION=0.0.0 npm run build:vscode +KEEP_MODULES=1 npm run release +``` + +You can omit `KEEP_MODULES` if you intend to use this in a platform-agnostic way +(like for publishing to NPM), but since the VS Code build process does +post-processing deletion of the modules, it is recommended to keep the modules +when possible, since if you install them later you will have more than is +required. `KEEP_MODULES` will also bundle Node and the code-server entry script. + +Run your build: + +```shell +./release/bin/code-server +``` + +Or if you omitted `KEEP_MODULES`: + +```shell +cd release +npm install --omit=dev +node . +``` + +Then, to package the release: + +```shell +npm run package +``` + +> On Linux, the currently running distro will become the minimum supported +> version. In our GitHub Actions CI, we use CentOS 8 for maximum compatibility. +> If you need your builds to support older distros, run the build commands +> inside a Docker container with all the build requirements installed. + +### Troubleshooting + +#### I see "Forbidden access" when I load code-server in the browser + +This means your patches didn't apply correctly. We have a patch to remove the +auth from vanilla Code because we use our own. + +Try popping off the patches with `quilt pop -a` and reapplying with `quilt push +-a`. + +#### "Can only have one anonymous define call per script" + +Code might be trying to use a dev or prod HTML in the wrong context. You can try +re-running code-server and setting `VSCODE_DEV=1`. + +### Help + +If you get stuck or need help, you can always start a new GitHub Discussion +[here](https://github.com/coder/code-server/discussions). One of the maintainers +will respond and help you out. + +## Test + +There are four kinds of tests in code-server: + +1. Unit tests +2. Script tests +3. Integration tests +4. End-to-end tests + +### Unit tests + +Our unit tests are written in TypeScript and run using +[Jest](https://jestjs.io/), the testing framework]. + +These live under [test/unit](../test/unit). + +We use unit tests for functions and things that can be tested in isolation. The +file structure is modeled closely after `/src` so it's easy for people to know +where test files should live. + +### Script tests + +Our script tests are written in bash and run using [bats](https://github.com/bats-core/bats-core). + +These tests live under `test/scripts`. + +We use these to test anything related to our scripts (most of which live under +`ci`). + +### Integration tests + +These are a work in progress. We build code-server and run tests with `npm run +test:integration`, which ensures that code-server builds work on their +respective platforms. + +Our integration tests look at components that rely on one another. For example, +testing the CLI requires us to build and package code-server. + +### End-to-end tests + +The end-to-end (e2e) tests are written in TypeScript and run using +[Playwright](https://playwright.dev/). + +These live under [test/e2e](../test/e2e). + +Before the e2e tests run, we run `globalSetup`, which eliminates the need to log +in before each test by preserving the authentication state. + +Take a look at `codeServer.test.ts` to see how you would use it (see +`test.use`). + +We also have a model where you can create helpers to use within tests. See +[models/CodeServer.ts](../test/e2e/models/CodeServer.ts) for an example. + +## Structure + +code-server essentially serves as an HTTP API for logging in and starting a +remote Code process. + +The CLI code is in [src/node](../src/node) and the HTTP routes are implemented +in [src/node/routes](../src/node/routes). + +Most of the meaty parts are in the Code portion of the codebase under +[lib/vscode](../lib/vscode), which we describe next. + +### Modifications to Code + +Our modifications to Code can be found in the [patches](../patches) directory. +We pull in Code as a submodule pointing to an upstream release branch. + +In v1 of code-server, we had Code as a submodule and used a single massive patch +that split the codebase into a front-end and a server. The front-end consisted +of the UI code, while the server ran the extensions and exposed an API to the +front-end for file access and all UI needs. + +Over time, Microsoft added support to Code to run it on the web. They had made +the front-end open source, but not the server. As such, code-server v2 (and +later) uses the Code front-end and implements the server. We did this by using a +Git subtree to fork and modify Code. + +Microsoft eventually made the server open source and we were able to reduce our +changes significantly. Some time later we moved back to a submodule and patches +(managed by `quilt` this time instead of the mega-patch). + +As the web portion of Code continues to mature, we'll be able to shrink and +possibly eliminate our patches. In the meantime, upgrading the Code version +requires us to ensure that our changes are still applied correctly and work as +intended. In the future, we'd like to run Code unit tests against our builds to +ensure that features work as expected. + +> We have [extension docs](../ci/README.md) on the CI and build system. + +If the functionality you're working on does NOT depend on code from Code, please +move it out and into code-server. + +### Currently Known Issues + +- Creating custom Code extensions and debugging them doesn't work +- Extension profiling and tips are currently disabled diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 000000000000..c492c73b2c59 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,601 @@ + + + +# FAQ + +- [Questions?](#questions) +- [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet) +- [Can I use code-server on the iPad?](#can-i-use-code-server-on-the-ipad) +- [How does the config file work?](#how-does-the-config-file-work) +- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work) +- [Why can't code-server use Microsoft's extension marketplace?](#why-cant-code-server-use-microsofts-extension-marketplace) +- [How can I request an extension that's missing from the marketplace?](#how-can-i-request-an-extension-thats-missing-from-the-marketplace) +- [How do I install an extension?](#how-do-i-install-an-extension) +- [How do I install an extension manually?](#how-do-i-install-an-extension-manually) +- [How do I use my own extensions marketplace?](#how-do-i-use-my-own-extensions-marketplace) +- [Where are extensions stored?](#where-are-extensions-stored) +- [Where is VS Code configuration stored?](#where-is-vs-code-configuration-stored) +- [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration) +- [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open) +- [Can I open a file at a specific line from a URL?](#can-i-open-a-file-at-a-specific-line-from-a-url) +- [How do I access my Documents/Downloads/Desktop folders in code-server on macOS?](#how-do-i-access-my-documentsdownloadsdesktop-folders-in-code-server-on-macos) +- [How do I direct server-side requests through a proxy?](#how-do-i-direct-server-side-requests-through-a-proxy) +- [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server) +- [What is the healthz endpoint?](#what-is-the-healthz-endpoint) +- [What is the heartbeat file?](#what-is-the-heartbeat-file) +- [How do I change the reconnection grace time?](#how-do-i-change-the-reconnection-grace-time) +- [How do I change the password?](#how-do-i-change-the-password) +- [Can I store my password hashed?](#can-i-store-my-password-hashed) +- [Is multi-tenancy possible?](#is-multi-tenancy-possible) +- [Can I use Docker in a code-server container?](#can-i-use-docker-in-a-code-server-container) +- [How do I disable telemetry?](#how-do-i-disable-telemetry) +- [What's the difference between code-server and Coder?](#whats-the-difference-between-code-server-and-coder) +- [What's the difference between code-server and Theia?](#whats-the-difference-between-code-server-and-theia) +- [What's the difference between code-server and OpenVSCode-Server?](#whats-the-difference-between-code-server-and-openvscode-server) +- [What's the difference between code-server and GitHub Codespaces?](#whats-the-difference-between-code-server-and-github-codespaces) +- [What's the difference between code-server and VS Code web?](#whats-the-difference-between-code-server-and-vs-code-web) +- [Does code-server have any security login validation?](#does-code-server-have-any-security-login-validation) +- [Are there community projects involving code-server?](#are-there-community-projects-involving-code-server) +- [How do I change the port?](#how-do-i-change-the-port) +- [How do I hide the coder/coder promotion in Help: Getting Started?](#how-do-i-hide-the-codercoder-promotion-in-help-getting-started) +- [How do I disable the proxy?](#how-do-i-disable-the-proxy) +- [How do I disable file download?](#how-do-i-disable-file-download) +- [Why do web views not work?](#why-do-web-views-not-work) +- [Can I run code-server with systemd socket activation?](#can-i-run-code-server-with-systemd-socket-activation) + + + + +## Questions? + +Please file all questions and support requests at +. + +## How should I expose code-server to the internet? + +Please see [our instructions on exposing code-server safely to the +internet](./guide.md). + +## Can I use code-server on the iPad? + +See [iPad](./ipad.md) for information on using code-server on the iPad. + +## How does the config file work? + +When `code-server` starts up, it creates a default config file in `~/.config/code-server/config.yaml`: + +```yaml +bind-addr: 127.0.0.1:8080 +auth: password +password: mew...22 # Randomly generated for each config.yaml +cert: false +``` + +The default config defines the following behavior: + +- Listen on the loopback IP port 8080 +- Enable password authorization +- Do not use TLS + +Each key in the file maps directly to a `code-server` flag (run `code-server --help` to see a listing of all the flags). Any flags passed to `code-server` +will take priority over the config file. + +You can change the config file's location using the `--config` flag or +`$CODE_SERVER_CONFIG` environment variable. + +The default location respects `$XDG_CONFIG_HOME`. + +## How do I make my keyboard shortcuts work? + +Many shortcuts will not work by default, since they'll be "caught" by the browser. + +If you use Chrome, you can work around this by installing the progressive web +app (PWA): + +1. Start the editor +2. Click the **plus** icon in the URL toolbar to install the PWA + +If you use Firefox, you can use the appropriate extension to install PWA. + +1. Go to the installation [website](https://addons.mozilla.org/en-US/firefox/addon/pwas-for-firefox/) of the add-on +2. Add the add-on to Firefox +3. Follow the os-specific instructions on how to install the runtime counterpart + +For other browsers, you'll have to remap keybindings for shortcuts to work. + +## Why can't code-server use Microsoft's extension marketplace? + +Though code-server takes the open-source core of VS Code and allows you to run +it in the browser, it is not entirely equivalent to Microsoft's VS Code. + +One major difference is in regards to extensions and the marketplace. The core +of VS code is open source, while the marketplace and many published Microsoft +extensions are not. Furthermore, Microsoft prohibits the use of any +non-Microsoft VS Code from accessing their marketplace. Per the [Terms of +Service](https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-Studio-Marketplace-Terms-of-Use.pdf): + +> Marketplace Offerings are intended for use only with Visual Studio Products +> and Services, and you may only install and use Marketplace Offerings with +> Visual Studio Products and Services. + +Because of this, we can't offer any extensions on Microsoft's marketplace. +Instead, we use the [Open-VSX extension gallery](https://open-vsx.org), which is also used by various other forks. +It isn't perfect, but its getting better by the day with more and more extensions. + +We also offer our own marketplace for open source extensions, but plan to +deprecate it at a future date and completely migrate to Open-VSX. + +These are the closed-source extensions that are presently unavailable: + +1. [Live Share](https://visualstudio.microsoft.com/services/live-share). We may + implement something similar (see + [#33](https://github.com/coder/code-server/issues/33)) +1. [Remote Extensions (SSH, Containers, + WSL)](https://github.com/microsoft/vscode-remote-release). We may implement + these again at some point, see + ([#1315](https://github.com/coder/code-server/issues/1315)). + +For more about the closed source portions of VS Code, see [vscodium/vscodium](https://github.com/VSCodium/vscodium#why-does-this-exist). + +## How can I request an extension that's missing from the marketplace? + +To add an extension to Open-VSX, please see [open-vsx/publish-extensions](https://github.com/open-vsx/publish-extensions). +We no longer plan to add new extensions to our legacy extension gallery. + +## How do I install an extension? + +You can install extensions from the marketplace using the extensions sidebar in +code-server or from the command line: + +```console +code-server --install-extension +# example: code-server --install-extension wesbos.theme-cobalt2 + +# From the Coder extension marketplace +code-server --install-extension ms-python.python + +# From a downloaded VSIX on the file system +code-server --install-extension downloaded-ms-python.python.vsix +``` + +## How do I install an extension manually? + +If there's an extension unavailable in the marketplace or an extension that +doesn't work, you can download the VSIX from its GitHub releases or build it +yourself. + +Once you have downloaded the VSIX to the remote machine, you can either: + +- Run the **Extensions: Install from VSIX** command in the Command Palette. +- Run `code-server --install-extension ` in the terminal + +You can also download extensions using the command line. For instance, +downloading from OpenVSX can be done like this: + +```shell +code-server --install-extension +``` + +## How do I use my own extensions marketplace? + +If you own a marketplace that implements the VS Code Extension Gallery API, you +can point code-server to it by setting `$EXTENSIONS_GALLERY`. +This corresponds directly with the `extensionsGallery` entry in in VS Code's `product.json`. + +For example: + +```bash +export EXTENSIONS_GALLERY='{"serviceUrl": "https://my-extensions/api"}' +``` + +Though you can technically use Microsoft's marketplace in this manner, we +strongly discourage you from doing so since this is [against their Terms of Use](#why-cant-code-server-use-microsofts-extension-marketplace). + +For further information, see [this +discussion](https://github.com/microsoft/vscode/issues/31168#issue-244533026) +regarding the use of the Microsoft URLs in forks, as well as [VSCodium's +docs](https://github.com/VSCodium/vscodium/blob/master/DOCS.md#extensions--marketplace). + +## Where are extensions stored? + +Extensions are stored in `~/.local/share/code-server/extensions` by default. + +On Linux and macOS if you set the `XDG_DATA_HOME` environment variable, the +extensions directory will be `$XDG_DATA_HOME/code-server/extensions`. In +general, we try to follow the XDG directory spec. + +## Where is VS Code configuration stored? + +VS Code configuration such as settings and keybindings are stored in +`~/.local/share/code-server` by default. + +On Linux and macOS if you set the `XDG_DATA_HOME` environment variable, the data +directory will be `$XDG_DATA_HOME/code-server`. In general, we try to follow the +XDG directory spec. + +## How can I reuse my VS Code configuration? + +You can use the [Settings +Sync](https://marketplace.visualstudio.com/items?itemName=Shan.code-settings-sync) +extension for this purpose. + +Alternatively, you can also pass `--user-data-dir ~/.vscode` or copy `~/.vscode` +into `~/.local/share/code-server` to reuse your existing VS Code extensions and +configuration. + +## How does code-server decide what workspace or folder to open? + +code-server tries the following in this order: + +1. The `workspace` query parameter +2. The `folder` query parameter +3. The workspace or directory passed via the command line +4. The last opened workspace or directory + +## Can I open a file at a specific line from a URL? + +Yes. In addition to `workspace` and `folder`, code-server supports VS Code's +`payload` query parameter, which can open a specific file — optionally at a +line and column — once the workbench loads. + +`payload` is a URL-encoded JSON array of `[key, value]` string pairs. The +`openFile` key takes a `vscode-remote:///` URI, where +`` is the host you use to reach code-server. Add +`["gotoLineMode","true"]` to have a trailing `:line[:column]` suffix on the +path interpreted as a cursor position: + +```text +https://code.example.com/?folder=/home/coder/project&payload=[["gotoLineMode","true"],["openFile","vscode-remote://code.example.com/home/coder/project/src/app.py:10:5"]] +``` + +(with the `payload` value URL-encoded). Notes: + +- Paths must be absolute; there is no form relative to `folder`. +- This is upstream VS Code web behavior (the same mechanism vscode.dev uses), + so it works without any code-server-specific configuration. + +For example, to generate links from a shell: + +```sh +#!/bin/sh +# usage: code-link [line[:column]] +HOST=code.example.com +payload="[[\"gotoLineMode\",\"true\"],[\"openFile\",\"vscode-remote://$HOST$1${2:+:$2}\"]]" +printf 'https://%s/?folder=%s&payload=%s\n' "$HOST" "$(dirname "$1")" \ + "$(printf '%s' "$payload" | jq -sRr @uri)" +``` + +## How do I access my Documents/Downloads/Desktop folders in code-server on macOS? + +Newer versions of macOS require permission through a non-UNIX mechanism for +code-server to access the Desktop, Documents, Pictures, Downloads, and other folders. + +You may have to give Node.js full disk access, since it doesn't implement any of the macOS permission request features natively: + +1. Find where Node.js is installed on your machine + + ```console + $ which node + /usr/local/bin/node + ``` + +2. Grant Node.js full disk access. Open **System Preferences** > **Security & + Privacy** > **Privacy** > **Full Disk Access**. Then, click the 🔒 to unlock, + click **+**, and select the Node.js binary you located in the previous step. + +See [#2794](https://github.com/coder/code-server/issues/2794) for additional context. + +## How do I direct server-side requests through a proxy? + +> code-server proxies only server-side requests. + +To direct server-side requests through a proxy, code-server supports the +following environment variables: + +- `$HTTP_PROXY` +- `$HTTPS_PROXY` +- `$NO_PROXY` + +```sh +export HTTP_PROXY=https://134.8.5.4 +export HTTPS_PROXY=https://134.8.5.4 +# Now all of code-server's server side requests will go through +# https://134.8.5.4 first. +code-server +``` + +- See + [proxy-from-env](https://www.npmjs.com/package/proxy-from-env#environment-variables) + for a detailed reference on these environment variables and their syntax (note + that code-server only uses the `http` and `https` protocols). +- See [proxy-agent](https://www.npmjs.com/package/proxy-agent) for information + on on the supported proxy protocols. + +## How do I debug issues with code-server? + +First, run code-server with the `debug` logging (or `trace` to be really +thorough) by setting the `--log` flag or the `LOG_LEVEL` environment variable. +`-vvv` and `--verbose` are aliases for `--log trace`. + +First, run code-server with `debug` logging (or `trace` logging for more +thorough messages) by setting the `--log` flag or the `LOG_LEVEL` environment +variable. + +```text +code-server --log debug +``` + +> Note that the `-vvv` and `--verbose` flags are aliases for `--log trace`. + +Next, replicate the issue you're having so that you can collect logging +information from the following places: + +1. The most recent files from `~/.local/share/code-server/coder-logs` +2. The browser console +3. The browser network tab + +Additionally, collecting core dumps (you may need to enable them first) if +code-server crashes can be helpful. + +## What is the healthz endpoint? + +You can use the `/healthz` endpoint exposed by code-server to check whether +code-server is running without triggering a heartbeat. The response includes a +status (e.g., `alive` or `expired`) and a timestamp for the last heartbeat +(the default is `0`). + +```json +{ + "status": "alive", + "lastHeartbeat": 1599166210566 +} +``` + +This endpoint doesn't require authentication. + +## What is the heartbeat file? + +As long as there is an active browser connection, code-server touches +`~/.local/share/code-server/heartbeat` once a minute. + +If you want to shutdown code-server if there hasn't been an active connection +after a predetermined amount of time, you can use the --idle-timeout-seconds flag +or set an `CODE_SERVER_IDLE_TIMEOUT_SECONDS` environment variable. + +## How do I change the reconnection grace time? + +Pass `--reconnection-grace-time ` to `code-server`, set +`CODE_SERVER_RECONNECTION_GRACE_TIME=`, or add +`reconnection-grace-time: ` to +`~/.config/code-server/config.yaml`. + +The default is `10800` (3 hours). If a client stays disconnected longer than +this, it must reload the window. + +## How do I change the password? + +Edit the `password` field in the code-server config file at +`~/.config/code-server/config.yaml`, then restart code-server: + +```bash +sudo systemctl restart code-server@$USER +``` + +## Can I store my password hashed? + +Yes, you can do so by setting the value of `hashed-password` instead of `password`. Generate the hash with: + +```shell +echo -n "thisismypassword" | npx argon2-cli -e +$argon2i$v=19$m=4096,t=3,p=1$wst5qhbgk2lu1ih4dmuxvg$ls1alrvdiwtvzhwnzcm1dugg+5dto3dt1d5v9xtlws4 +``` + +Replace `thisismypassword` with your actual password and **remember to put it +inside quotes**! For example: + +```yaml +auth: password +hashed-password: "$argon2i$v=19$m=4096,t=3,p=1$wST5QhBgk2lu1ih4DMuxvg$LS1alrVdIWtvZHwnzCM1DUGg+5DTO3Dt1d5v9XtLws4" +``` + +The `hashed-password` field takes precedence over `password`. + +If you're using Docker Compose file, in order to make this work, you need to change all the single $ to $$. For example: + +```yaml +- HASHED_PASSWORD=$$argon2i$$v=19$$m=4096,t=3,p=1$$wST5QhBgk2lu1ih4DMuxvg$$LS1alrVdIWtvZHwnzCM1DUGg+5DTO3Dt1d5v9XtLws4 +``` + +## Is multi-tenancy possible? + +If you want to run multiple code-servers on shared infrastructure, we recommend +using virtual machines (provide one VM per user). This will easily allow users +to run a Docker daemon. If you want to use Kubernetes, you'll want to +use [kubevirt](https://kubevirt.io) or +[sysbox](https://github.com/nestybox/sysbox) to give each user a VM-like +experience instead of just a container. + +## Can I use Docker in a code-server container? + +If you'd like to access Docker inside of code-server, mount the Docker socket in +from `/var/run/docker.sock`. Then, install the Docker CLI in the code-server +container, and you should be able to access the daemon. + +You can even make volume mounts work. Let's say you want to run a container and +mount into `/home/coder/myproject` from inside the `code-server` container. You +need to make sure the Docker daemon's `/home/coder/myproject` is the same as the +one mounted inside the `code-server` container, and the mount will work. + +If you want Docker enabled when deploying on Kubernetes, look at the `values.yaml` +file for the 3 fields: `extraVars`, `lifecycle.postStart`, and `extraContainers`. + +## How do I disable telemetry? + +Use the `--disable-telemetry` flag to disable telemetry. + +> We use the data collected only to improve code-server. + +## What's the difference between code-server and Coder? + +code-server and Coder are both applications that can be installed on any +machine. The main difference is who they serve. Out of the box, code-server is +simply VS Code in the browser while Coder is a tool for provisioning remote +development environments via Terraform. + +code-server was built for individuals while Coder was built for teams. In Coder, you create Workspaces which can have applications like code-server. If you're looking for a team solution, you should reach for [Coder](https://github.com/coder/coder). + +## What's the difference between code-server and Theia? + +At a high level, code-server is a patched fork of VS Code that runs in the +browser whereas Theia takes some parts of VS Code but is an entirely different +editor. + +[Theia](https://github.com/eclipse-theia/theia) is a browser IDE loosely based +on VS Code. It uses the same text editor library +([Monaco](https://github.com/Microsoft/monaco-editor)) and extension API, but +everything else is different. Theia also uses [Open VSX](https://open-vsx.org) +for extensions. + +Theia doesn't allow you to reuse your existing VS Code config. + +## What's the difference between code-server and OpenVSCode-Server? + +code-server and OpenVSCode-Server both allow you to access VS Code via a +browser. OpenVSCode-Server is a direct fork of VS Code with changes comitted +directly while code-server pulls VS Code in via a submodule and makes changes +via patch files. + +However, OpenVSCode-Server is scoped at only making VS Code available as-is in +the web browser. code-server contains additional changes to make the self-hosted +experience better (see the next section for details). + +## What's the difference between code-server and GitHub Codespaces? + +Both code-server and GitHub Codespaces allow you to access VS Code via a +browser. GitHub Codespaces, however, is a closed-source, paid service offered by +GitHub and Microsoft. + +On the other hand, code-server is self-hosted, free, open-source, and can be run +on any machine with few limitations. + +Specific changes include: + +- Password authentication +- The ability to host at sub-paths +- Self-contained web views that do not call out to Microsoft's servers +- The ability to use your own marketplace and collect your own telemetry +- Built-in proxy for accessing ports on the remote machine integrated into + VS Code's ports panel +- Settings are stored on disk like desktop VS Code, instead of in browser + storage (note that state is still stored in browser storage). +- Wrapper process that spawns VS Code on-demand and has a separate CLI +- Notification when updates are available +- [Some other things](https://github.com/coder/code-server/tree/main/patches) + +Some of these changes appear very unlikely to ever be adopted by Microsoft. +Some may make their way upstream, further closing the gap, but at the moment it +looks like there will always be some subtle differences. + +## What's the difference between code-server and VS Code web? + +VS Code web (which can be ran using `code serve-web`) has the same differences +as the Codespaces section above. VS Code web can be a better choice if you need +access to the official Microsoft marketplace. + +## Does code-server have any security login validation? + +code-server supports setting a single password and limits logins to two per +minute plus an additional twelve per hour. + +## Are there community projects involving code-server? + +Visit the [awesome-code-server](https://github.com/coder/awesome-code-server) +repository to view community projects and guides with code-server! Feel free to +add your own! + +## How do I change the port? + +There are two ways to change the port on which code-server runs: + +1. with an environment variable e.g. `PORT=3000 code-server` +2. using the flag `--bind-addr` e.g. `code-server --bind-addr localhost:3000` + +## How do I hide the coder/coder promotion in Help: Getting Started? + +You can pass the flag `--disable-getting-started-override` to `code-server` or +you can set the environment variable `CS_DISABLE_GETTING_STARTED_OVERRIDE=1` or +`CS_DISABLE_GETTING_STARTED_OVERRIDE=true`. + +## How do I disable the proxy? + +You can pass the flag `--disable-proxy` to `code-server` or +you can set the environment variable `CS_DISABLE_PROXY=1` or +`CS_DISABLE_PROXY=true`. + +Note, this option currently only disables the proxy routes to forwarded ports, including +the domain and path proxy routes over HTTP and WebSocket; however, it does not +disable the automatic port forwarding in the VS Code workbench itself. In other words, +user will still see the Ports tab and notifications, but will not be able to actually +use access the ports. It is recommended to set `remote.autoForwardPorts` to `false` +when using the option. + +## How do I disable file download? + +You can pass the flag `--disable-file-downloads` to `code-server` + +## Why do web views not work? + +Web views rely on service workers, and service workers are only available in a +secure context, so most likely the answer is that you are using an insecure +context (for example an IP address). + +If this happens, in the browser log you will see something like: + +> Error loading webview: Error: Could not register service workers: SecurityError: Failed to register a ServiceWorker for scope with script: An SSL certificate error occurred when fetching the script.. + +To fix this, you must either: + +- Access over localhost/127.0.0.1 which is always considered secure. +- Use a domain with a real certificate (for example with Let's Encrypt). +- Use a trusted self-signed certificate with [mkcert](https://mkcert.dev) (or + create and trust a certificate manually). +- Disable security if your browser allows it. For example, in Chromium see + `chrome://flags/#unsafely-treat-insecure-origin-as-secure` + +## Can I run code-server with systemd socket activation? + +Yes. Pass the inherited socket to code-server with `--socket-fd`. systemd +passes the first listening socket as file descriptor `3`. + +Create a socket unit, `~/.config/systemd/user/code-server.socket`: + +```ini +[Socket] +ListenStream=8080 + +[Install] +WantedBy=sockets.target +``` + +And a matching service unit, `~/.config/systemd/user/code-server.service`: + +```ini +[Service] +ExecStart=/usr/bin/code-server --socket-fd 3 +``` + +Then enable and start the socket: + +```bash +systemctl --user enable --now code-server.socket +``` + +code-server will start on the first connection and listen on the socket +systemd created. `--socket-fd` takes precedence over `--socket` and +`--bind-addr`/`--port`/`--host`, and `--socket-mode` is ignored because +systemd owns the socket's permissions. + +Socket activation only changes how code-server binds; your usual +authentication still applies (it keeps prompting for the configured password +unless you set `--auth none`), so keep authentication enabled when exposing the +server. diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md new file mode 100644 index 000000000000..69263576ec2c --- /dev/null +++ b/docs/MAINTAINING.md @@ -0,0 +1,112 @@ + + + +# Maintaining + +- [Releasing](#releasing) + - [Release Candidates](#release-candidates) + - [AUR](#aur) + - [Docker](#docker) + - [nixpkgs](#nixpkgs) + - [npm](#npm) +- [Testing](#testing) +- [Documentation](#documentation) + - [Troubleshooting](#troubleshooting) + + + + +We keep code-server up to date with VS Code releases (there are usually two or +three a month) but we are not generally actively developing code-server aside +from fixing regressions. + +Most of the work is keeping on top of issues and discussions. + +## Releasing + +1. Check that the changelog lists all the important changes. +2. Make sure the changelog entry lists the current version of VS Code. +3. Go to GitHub Actions > Draft release > Run workflow on the commit you want to + release. For the version we match VS Code's minor and patch version. The + patch number may become temporarily out of sync if we need to put out a + patch, but if we make our own minor change then we will not release it until + the next minor VS Code release. +4. CI will build an NPM package and platform-specific packages, and upload those + to a draft release. +5. Update the resulting draft release with the changelog contents. +6. Publish the draft release after validating it. +7. Update the changelog with the release date and bump the Helm chart version + once the Docker images have published. +8. Merge the PR submitted to coder/code-server-aur repo. + +#### Release Candidates + +We prefer to do release candidates so the community can test things before a +full-blown release. To do this follow the same steps as above but: + +1. Add a `-rc.` suffix to the version. +2. When you publish the release select "pre-release". CI will not automatically + publish pre-releases. +3. Do not update the chart version or merge in the changelog until the final + release. + +#### AUR + +We publish to AUR as a package +[here](https://aur.archlinux.org/packages/code-server/). This process is manual +and can be done by following the steps in [this +repo](https://github.com/coder/code-server-aur). + +#### Docker + +We publish code-server as a Docker image +[here](https://hub.docker.com/r/codercom/code-server), tagging it both with the +version and latest. + +This is currently automated with the release process. + +#### nixpkgs + +We publish code-server in nixpkgs but it must be updated manually. + +#### npm + +We publish code-server as a npm package +[here](https://www.npmjs.com/package/code-server/v/latest). + +This is currently automated with the release process. + +## Testing + +Our testing structure is laid out under our [Contributing +docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test). + +If you're ever looking to add more tests, here are a few ways to get started: + +- run `npm run test:unit` and look at the coverage chart. You'll see all the + uncovered lines. This is a good place to start. +- look at `test/scripts` to see which scripts are tested. We can always use more + tests there. +- look at `test/e2e`. We can always use more end-to-end tests. + +Otherwise, talk to a current maintainer and ask which part of the codebase is +lacking most when it comes to tests. + +## Documentation + +### Troubleshooting + +Our docs are hosted on [Vercel](https://vercel.com/). Vercel only shows logs in +realtime, which means you need to have the logs open in one tab and reproduce +your error in another tab. Since our logs are private to Coder the organization, +you can only follow these steps if you're a Coder employee. Ask a maintainer for +help if you need it. + +Taking a real scenario, let's say you wanted to troubleshoot [this docs +change](https://github.com/coder/code-server/pull/4042). Here is how you would +do it: + +1. Go to https://vercel.com/codercom/codercom +2. Click "View Function Logs" +3. In a separate tab, open the preview link from github-actions-bot +4. Now look at the function logs and see if there are errors in the logs diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000000..470095071afd --- /dev/null +++ b/docs/README.md @@ -0,0 +1,82 @@ +# code-server + +[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![Discord](https://img.shields.io/discord/747933592273027093)](https://discord.com/invite/coder) [![codecov](https://codecov.io/gh/coder/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/coder/code-server) [![See latest](https://img.shields.io/static/v1?label=Docs&message=see%20latest&color=blue)](https://coder.com/docs/code-server/latest) + +Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and +access it in the browser. + +![Screenshot](./assets/screenshot-1.png) +![Screenshot](./assets/screenshot-2.png) + +## Highlights + +- Code on any device with a consistent development environment +- Use cloud servers to speed up tests, compilations, downloads, and more +- Preserve battery life when you're on the go; all intensive tasks run on your + server + +## Requirements + +See [requirements](https://coder.com/docs/code-server/latest/requirements) for minimum specs, as well as instructions +on how to set up a Google VM on which you can install code-server. + +**TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs + +## Getting started + +There are five ways to get started: + +1. Using the [install + script](https://github.com/coder/code-server/blob/main/install.sh), which + automates most of the process. The script uses the system package manager if + possible. +2. Manually [installing + code-server](https://coder.com/docs/code-server/latest/install) +3. Deploy code-server to your team with [coder/coder](https://cdr.co/coder-github) +4. Using our one-click buttons and guides to [deploy code-server to a cloud + provider](https://github.com/coder/deploy-code-server) ⚡ +5. Using the [code-server feature for + devcontainers](https://github.com/coder/devcontainer-features/blob/main/src/code-server/README.md), + if you already use devcontainers in your project. + +If you use the install script, you can preview what occurs during the install +process: + +```bash +curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run +``` + +To install, run: + +```bash +curl -fsSL https://code-server.dev/install.sh | sh +``` + +When done, the install script prints out instructions for running and starting +code-server. + +> **Note** +> To manage code-server for a team on your infrastructure, see: [coder/coder](https://cdr.co/coder-github) + +We also have an in-depth [setup and +configuration](https://coder.com/docs/code-server/latest/guide) guide. + +## Questions? + +See answers to [frequently asked +questions](https://coder.com/docs/code-server/latest/FAQ). + +## Want to help? + +See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for +details. + +## Hiring + +Interested in [working at Coder](https://coder.com/careers)? Check out [our open +positions](https://coder.com/careers#openings)! + +## For Teams + +We develop [coder/coder](https://cdr.co/coder-github) to help teams to +adopt remote development. diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 000000000000..9ff33e365c4b --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1,33 @@ +# Security Policy + +Coder and the code-server team want to keep the code-server project secure and safe for end-users. + +## Tools + +We use the following tools to help us stay on top of vulnerability mitigation. + +- [dependabot](https://dependabot.com/) + - Submits pull requests to upgrade dependencies. We use dependabot's version + upgrades as well as security updates. +- code-scanning + - [CodeQL](https://securitylab.github.com/tools/codeql/) + - Semantic code analysis engine that runs on a regular schedule (see + `codeql-analysis.yml`) + - [trivy](https://github.com/aquasecurity/trivy) + - Comprehensive vulnerability scanner that runs on PRs into the default + branch and scans both our container image and repository code (see + `trivy-scan-repo` and `trivy-scan-image` jobs in `build.yaml`) +- `npm audit` + - Audits NPM dependencies. + +## Supported Versions + +Coder sponsors the development and maintenance of the code-server project. We will fix security issues within 90 days of receiving a report and publish the fix in a subsequent release. The code-server project does not provide backports or patch releases for security issues at this time. + +| Version | Supported | +| ------------------------------------------------------- | ------------------ | +| [Latest](https://github.com/coder/code-server/releases) | :white_check_mark: | + +## Reporting a Vulnerability + +To report a vulnerability, please send an email to security[@]coder.com, and our security team will respond to you. diff --git a/docs/android.md b/docs/android.md new file mode 100644 index 000000000000..4541bc7b5fee --- /dev/null +++ b/docs/android.md @@ -0,0 +1,31 @@ +# Running code-server using UserLAnd + +1. Install UserLAnd from [Google Play](https://play.google.com/store/apps/details?id=tech.ula&hl=en_US&gl=US) +2. Install an Ubuntu VM +3. Start app +4. Install Node.js and `curl` using `sudo apt install nodejs npm curl -y` +5. Install `nvm`: + +```shell +curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash +``` + +6. Exit the terminal using `exit` and then reopen the terminal +7. Install and use Node.js 24: + +```shell +nvm install 24 +nvm use 24 +``` + +8. Install code-server globally on device with: `npm install --global code-server` +9. Run code-server with `code-server` +10. Access on localhost:8080 in your browser + +# Running code-server using Nix-on-Droid + +1. Install Nix-on-Droid from [F-Droid](https://f-droid.org/packages/com.termux.nix/) +2. Start app +3. Spawn a shell with code-server by running `nix-shell -p code-server` +4. Run code-server with `code-server` +5. Access on localhost:8080 in your browser diff --git a/docs/assets/images/icons/collab.svg b/docs/assets/images/icons/collab.svg new file mode 100644 index 000000000000..239666a993bf --- /dev/null +++ b/docs/assets/images/icons/collab.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/icons/contributing.svg b/docs/assets/images/icons/contributing.svg new file mode 100644 index 000000000000..c814591e1c7f --- /dev/null +++ b/docs/assets/images/icons/contributing.svg @@ -0,0 +1 @@ + diff --git a/docs/assets/images/icons/faq.svg b/docs/assets/images/icons/faq.svg new file mode 100644 index 000000000000..a3e196d298a9 --- /dev/null +++ b/docs/assets/images/icons/faq.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/icons/home.svg b/docs/assets/images/icons/home.svg new file mode 100644 index 000000000000..0f7bee254cd3 --- /dev/null +++ b/docs/assets/images/icons/home.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/icons/requirements.svg b/docs/assets/images/icons/requirements.svg new file mode 100644 index 000000000000..c3888f90274f --- /dev/null +++ b/docs/assets/images/icons/requirements.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/icons/upgrade.svg b/docs/assets/images/icons/upgrade.svg new file mode 100644 index 000000000000..28c35752f201 --- /dev/null +++ b/docs/assets/images/icons/upgrade.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/images/icons/usage.svg b/docs/assets/images/icons/usage.svg new file mode 100644 index 000000000000..f38aa04813e3 --- /dev/null +++ b/docs/assets/images/icons/usage.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/assets/images/icons/wrench.svg b/docs/assets/images/icons/wrench.svg new file mode 100644 index 000000000000..acca9b7614a1 --- /dev/null +++ b/docs/assets/images/icons/wrench.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/screenshot-1.png b/docs/assets/screenshot-1.png new file mode 100644 index 000000000000..cacbc21bd771 Binary files /dev/null and b/docs/assets/screenshot-1.png differ diff --git a/docs/assets/screenshot-2.png b/docs/assets/screenshot-2.png new file mode 100644 index 000000000000..5861fac0b905 Binary files /dev/null and b/docs/assets/screenshot-2.png differ diff --git a/docs/coder.md b/docs/coder.md new file mode 100644 index 000000000000..eff3423b5b7a --- /dev/null +++ b/docs/coder.md @@ -0,0 +1,48 @@ +# Coder + +To install and run code-server in a Coder workspace, we suggest using the `install.sh` +script in your template like so: + +```terraform +resource "coder_agent" "dev" { + arch = "amd64" + os = "linux" + startup_script = < + + +# Setup Guide + +- [Expose code-server](#expose-code-server) + - [Port forwarding via SSH](#port-forwarding-via-ssh) + - [Using Let's Encrypt with Caddy](#using-lets-encrypt-with-caddy) + - [Using Let's Encrypt with NGINX](#using-lets-encrypt-with-nginx) + - [Using a self-signed certificate](#using-a-self-signed-certificate) + - [TLS 1.3 and Safari](#tls-13-and-safari) + - [Cloudflare Rocket Loader](#cloudflare-rocket-loader) +- [External authentication](#external-authentication) +- [HTTPS and self-signed certificates](#https-and-self-signed-certificates) +- [Accessing web services](#accessing-web-services) + - [Using a subdomain](#using-a-subdomain) + - [Using a subpath](#using-a-subpath) + - [Using your own proxy](#using-your-own-proxy) + - [Stripping `/proxy/` from the request path](#stripping-proxyport-from-the-request-path) + - [Proxying to create a React app](#proxying-to-create-a-react-app) + - [Proxying to a Vue app](#proxying-to-a-vue-app) + - [Proxying to an Angular app](#proxying-to-an-angular-app) + - [Proxying to a Svelte app](#proxying-to-a-svelte-app) + - [Prefixing `/absproxy/` with a path](#prefixing-absproxyport-with-a-path) + - [Preflight requests](#preflight-requests) +- [Internationalization and customization](#internationalization-and-customization) + - [Available keys and placeholders](#available-keys-and-placeholders) + - [Legacy flag](#legacy-flag) + + + + +This article will walk you through exposing code-server securely once you've +completed the [installation process](install.md). + +## Expose code-server + +**Never** expose code-server directly to the internet without some form of +authentication and encryption, otherwise someone can take over your machine via +the terminal. + +By default, code-server uses password authentication. As such, you must copy the +password from code-server's config file to log in. To avoid exposing itself +unnecessarily, code-server listens on `localhost`; this practice is fine for +testing, but it doesn't work if you want to access code-server from a different +machine. + +> **Rate limits:** code-server rate limits password authentication attempts to +> two per minute plus an additional twelve per hour. + +There are several approaches to operating and exposing code-server securely: + +- Port forwarding via SSH +- Using Let's Encrypt with Caddy +- Using Let's Encrypt with NGINX +- Using a self-signed certificate + +### Port forwarding via SSH + +We highly recommend using [port forwarding via +SSH](https://help.ubuntu.com/community/SSH/OpenSSH/PortForwarding) to access +code-server. If you have an SSH server on your remote machine, this approach +doesn't require any additional setup at all. + +The downside to SSH forwarding, however, is that you can't access code-server +when using machines without SSH clients (such as iPads). If this applies to you, +we recommend using another method, such as [Let's Encrypt](#let-encrypt) instead. + +> To work properly, your environment should have WebSockets enabled, which +> code-server uses to communicate between the browser and server. + +1. SSH into your instance and edit the code-server config file to disable + password authentication: + + ```console + # Replaces "auth: password" with "auth: none" in the code-server config. + sed -i.bak 's/auth: password/auth: none/' ~/.config/code-server/config.yaml + ``` + +2. Restart code-server: + + ```console + sudo systemctl restart code-server@$USER + ``` + +3. Forward local port `8080` to `127.0.0.1:8080` on the remote instance by running the following command on your local machine: + + ```console + # -N disables executing a remote shell + ssh -N -L 8080:127.0.0.1:8080 [user]@ + ``` + +4. At this point, you can access code-server by pointing your web browser to `http://127.0.0.1:8080`. + +5. If you'd like to make the port forwarding via SSH persistent, we recommend + using [mutagen](https://mutagen.io/documentation/introduction/installation) + to do so. Once you've installed mutagen, you can port forward as follows: + + ```shell + # This is the same as the above SSH command, but it runs in the background + # continuously. Be sure to add `mutagen daemon start` to your ~/.bashrc to + # start the mutagen daemon when you open a shell. + mutagen forward create --name=code-server tcp:127.0.0.1:8080 < instance-ip > :tcp:127.0.0.1:8080 + ``` + +6. Optional, but highly recommended: add the following to `~/.ssh/config` so + that you can detect bricked SSH connections: + + ```bash + Host * + ServerAliveInterval 5 + ExitOnForwardFailure yes + ``` + +> You can [forward your +> SSH](https://developer.github.com/v3/guides/using-ssh-agent-forwarding/) and +> [GPG agent](https://wiki.gnupg.org/AgentForwarding) to the instance to +> securely access GitHub and sign commits without having to copy your keys. + +### Using Let's Encrypt with Caddy + +Using [Let's Encrypt](https://letsencrypt.org) is an option if you want to +access code-server on an iPad or do not want to use SSH port forwarding. + +1. This option requires that the remote machine be exposed to the internet. Make sure that your instance allows HTTP/HTTPS traffic. + +2. You'll need a domain name (if you don't have one, you can purchase one from + [Google Domains](https://domains.google.com) or the domain service of your + choice). Once you have a domain name, add an A record to your domain that contains your + instance's IP address. + +3. Install [Caddy](https://caddyserver.com/docs/download#debian-ubuntu-raspbian): + + ```console + sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https + curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg + curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list + sudo apt update + sudo apt install caddy + ``` + +4. Replace `/etc/caddy/Caddyfile` using `sudo` so that the file looks like this: + + ```text + mydomain.com { + reverse_proxy 127.0.0.1:8080 + } + ``` + + If you want to serve code-server from a sub-path, you can do so as follows: + + ```text + mydomain.com/code/* { + uri strip_prefix /code + reverse_proxy 127.0.0.1:8080 + } + ``` + + Remember to replace `mydomain.com` with your domain name! + +5. Reload Caddy: + + ```console + sudo systemctl reload caddy + ``` + +At this point, you should be able to access code-server via +`https://mydomain.com`. + +### Using Let's Encrypt with NGINX + +1. This option requires that the remote machine be exposed to the internet. Make + sure that your instance allows HTTP/HTTPS traffic. + +2. You'll need a domain name (if you don't have one, you can purchase one from + [Google Domains](https://domains.google.com) or the domain service of your + choice). Once you have a domain name, add an A record to your domain that contains your + instance's IP address. + +3. Install NGINX: + + ```bash + sudo apt update + sudo apt install -y nginx certbot python3-certbot-nginx + ``` + +4. Update `/etc/nginx/sites-available/code-server` using sudo with the following + configuration: + + ```text + server { + listen 80; + listen [::]:80; + server_name mydomain.com; + + location / { + proxy_pass http://localhost:8080/; + proxy_set_header Host $http_host; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection upgrade; + proxy_set_header Accept-Encoding gzip; + } + } + ``` + + Be sure to replace `mydomain.com` with your domain name! + +5. Enable the config: + ```console + sudo ln -s ../sites-available/code-server /etc/nginx/sites-enabled/code-server + sudo certbot --non-interactive --redirect --agree-tos --nginx -d mydomain.com -m me@example.com + ``` + Be sure to replace `me@example.com` with your actual email. + +At this point, you should be able to access code-server via +`https://mydomain.com`. + +### Using a self-signed certificate + +> Self signed certificates do not work with iPad; see [./ipad.md](./ipad.md) for +> more information. + +Before proceeding, we recommend familiarizing yourself with the [risks of +self-signing a certificate for +SSL](https://security.stackexchange.com/questions/8110). + +We recommend self-signed certificates as a last resort, since self-signed +certificates do not work with iPads and may cause unexpected issues with +code-server. You should only proceed with this option if: + +- You do not want to buy a domain or you cannot expose the remote machine to + the internet +- You do not want to use port forwarding via SSH + +To use a self-signed certificate: + +1. This option requires that the remote machine be exposed to the internet. Make + sure that your instance allows HTTP/HTTPS traffic. + +1. SSH into your instance and edit your code-server config file to use a + randomly generated self-signed certificate: + + ```console + # Replaces "cert: false" with "cert: true" in the code-server config. + sed -i.bak 's/cert: false/cert: true/' ~/.config/code-server/config.yaml + # Replaces "bind-addr: 127.0.0.1:8080" with "bind-addr: 0.0.0.0:443" in the code-server config. + sed -i.bak 's/bind-addr: 127.0.0.1:8080/bind-addr: 0.0.0.0:443/' ~/.config/code-server/config.yaml + # Allows code-server to listen on port 443. + sudo setcap cap_net_bind_service=+ep /usr/lib/code-server/lib/node + ``` + +1. Restart code-server: + + ```console + sudo systemctl restart code-server@$USER + ``` + +At this point, you should be able to access code-server via +`https://`. + +If you'd like to avoid the warnings displayed by code-server when using a +self-signed certificate, you can use [mkcert](https://mkcert.dev) to create a +self-signed certificate that's trusted by your operating system, then pass the +certificate to code-server via the `cert` and `cert-key` config fields. + +### TLS 1.3 and Safari + +If you will be using Safari and your configuration does not allow anything less +than TLS 1.3 you will need to add support for TLS 1.2 since Safari does not +support TLS 1.3 for web sockets at the time of writing. If this is the case you +should see OSSStatus: 9836 in the browser console. + +### Cloudflare Rocket Loader + +If you serve code-server through Cloudflare, disable Rocket Loader for that +hostname. Rocket Loader rewrites inline ` + + + + diff --git a/src/browser/robots.txt b/src/browser/robots.txt new file mode 100644 index 000000000000..1f53798bb4fe --- /dev/null +++ b/src/browser/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/src/browser/security.txt b/src/browser/security.txt new file mode 100644 index 000000000000..18996f284232 --- /dev/null +++ b/src/browser/security.txt @@ -0,0 +1,6 @@ +Contact: mailto:security@coder.com +Acknowledgments: https://coder.com/security/thanks +Preferred-Languages: en-US +Canonical: https://coder.com/.well-known/security.txt +Policy: https://coder.com/security/policy +Hiring: https://coder.com/careers \ No newline at end of file diff --git a/src/browser/serviceWorker.ts b/src/browser/serviceWorker.ts new file mode 100644 index 000000000000..37fbf7afa5f5 --- /dev/null +++ b/src/browser/serviceWorker.ts @@ -0,0 +1,12 @@ +self.addEventListener("install", () => { + console.debug("[Service Worker] installed") +}) + +self.addEventListener("activate", (event: any) => { + event.waitUntil((self as any).clients.claim()) + console.debug("[Service Worker] activated") +}) + +self.addEventListener("fetch", () => { + // Without this event handler we won't be recognized as a PWA. +}) diff --git a/src/browser/upload.ts b/src/browser/upload.ts deleted file mode 100644 index 23ab914fec98..000000000000 --- a/src/browser/upload.ts +++ /dev/null @@ -1,372 +0,0 @@ -import { DesktopDragAndDropData } from "vs/base/browser/ui/list/listView"; -import { VSBuffer, VSBufferReadableStream } from "vs/base/common/buffer"; -import { Disposable } from "vs/base/common/lifecycle"; -import * as path from "vs/base/common/path"; -import { URI } from "vs/base/common/uri"; -import { generateUuid } from "vs/base/common/uuid"; -import { IFileService } from "vs/platform/files/common/files"; -import { createDecorator, IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; -import { INotificationService, Severity } from "vs/platform/notification/common/notification"; -import { IProgress, IProgressService, IProgressStep, ProgressLocation } from "vs/platform/progress/common/progress"; -import { IWindowsService } from "vs/platform/windows/common/windows"; -import { IWorkspaceContextService } from "vs/platform/workspace/common/workspace"; -import { ExplorerItem } from "vs/workbench/contrib/files/common/explorerModel"; -import { IEditorGroup } from "vs/workbench/services/editor/common/editorGroupsService"; -import { IEditorService } from "vs/workbench/services/editor/common/editorService"; - -export const IUploadService = createDecorator("uploadService"); - -export interface IUploadService { - _serviceBrand: undefined; - handleDrop(event: DragEvent, resolveTargetGroup: () => IEditorGroup | undefined, afterDrop: (targetGroup: IEditorGroup | undefined) => void, targetIndex?: number): Promise; - handleExternalDrop(data: DesktopDragAndDropData, target: ExplorerItem, originalEvent: DragEvent): Promise; -} - -export class UploadService extends Disposable implements IUploadService { - public _serviceBrand: undefined; - public upload: Upload; - - public constructor( - @IInstantiationService instantiationService: IInstantiationService, - @IWorkspaceContextService private readonly contextService: IWorkspaceContextService, - @IWindowsService private readonly windowsService: IWindowsService, - @IEditorService private readonly editorService: IEditorService, - ) { - super(); - this.upload = instantiationService.createInstance(Upload); - } - - public async handleDrop(event: DragEvent, resolveTargetGroup: () => IEditorGroup | undefined, afterDrop: (targetGroup: IEditorGroup | undefined) => void, targetIndex?: number): Promise { - // TODO: should use the workspace for the editor it was dropped on? - const target =this.contextService.getWorkspace().folders[0].uri; - const uris = (await this.upload.uploadDropped(event, target)).map((u) => URI.file(u)); - if (uris.length > 0) { - await this.windowsService.addRecentlyOpened(uris.map((u) => ({ fileUri: u }))); - } - const editors = uris.map((uri) => ({ - resource: uri, - options: { - pinned: true, - index: targetIndex, - }, - })); - const targetGroup = resolveTargetGroup(); - this.editorService.openEditors(editors, targetGroup); - afterDrop(targetGroup); - } - - public async handleExternalDrop(_data: DesktopDragAndDropData, target: ExplorerItem, originalEvent: DragEvent): Promise { - await this.upload.uploadDropped(originalEvent, target.resource); - } -} - -/** - * There doesn't seem to be a provided type for entries, so here is an - * incomplete version. - */ -interface IEntry { - name: string; - isFile: boolean; - file: (cb: (file: File) => void) => void; - createReader: () => ({ - readEntries: (cb: (entries: Array) => void) => void; - }); -} - -/** - * Handles file uploads. - */ -class Upload { - private readonly maxParallelUploads = 100; - private readonly uploadingFiles = new Map(); - private readonly fileQueue = new Map(); - private progress: IProgress | undefined; - private uploadPromise: Promise | undefined; - private resolveUploadPromise: (() => void) | undefined; - private uploadedFilePaths = []; - private _total = 0; - private _uploaded = 0; - private lastPercent = 0; - - public constructor( - @INotificationService private notificationService: INotificationService, - @IProgressService private progressService: IProgressService, - @IFileService private fileService: IFileService, - ) {} - - /** - * Upload dropped files. This will try to upload everything it can. Errors - * will show via notifications. If an upload operation is ongoing, the files - * will be added to that operation. - */ - public async uploadDropped(event: DragEvent, uploadDir: URI): Promise { - await this.queueFiles(event, uploadDir); - if (!this.uploadPromise) { - this.uploadPromise = this.progressService.withProgress({ - cancellable: true, - location: ProgressLocation.Notification, - title: "Uploading files...", - }, (progress) => { - return new Promise((resolve): void => { - this.progress = progress; - this.resolveUploadPromise = (): void => { - const uploaded = this.uploadedFilePaths; - this.uploadPromise = undefined; - this.resolveUploadPromise = undefined; - this.uploadedFilePaths = []; - this.lastPercent = 0; - this._uploaded = 0; - this._total = 0; - resolve(uploaded); - }; - }); - }, () => this.cancel()); - } - this.uploadFiles(); - return this.uploadPromise; - } - - /** - * Cancel all file uploads. - */ - public async cancel(): Promise { - this.fileQueue.clear(); - this.uploadingFiles.forEach((r) => r && r.abort()); - } - - private get total(): number { return this._total; } - private set total(total: number) { - this._total = total; - this.updateProgress(); - } - - private get uploaded(): number { return this._uploaded; } - private set uploaded(uploaded: number) { - this._uploaded = uploaded; - this.updateProgress(); - } - - private updateProgress(): void { - if (this.progress && this.total > 0) { - const percent = Math.floor((this.uploaded / this.total) * 100); - this.progress.report({ increment: percent - this.lastPercent }); - this.lastPercent = percent; - } - } - - /** - * Upload as many files as possible. When finished, resolve the upload - * promise. - */ - private uploadFiles(): void { - while (this.fileQueue.size > 0 && this.uploadingFiles.size < this.maxParallelUploads) { - const [path, file] = this.fileQueue.entries().next().value; - this.fileQueue.delete(path); - if (this.uploadingFiles.has(path)) { - this.notificationService.error(new Error(`Already uploading ${path}`)); - } else { - this.uploadingFiles.set(path, undefined); - this.uploadFile(path, file).catch((error) => { - this.notificationService.error(error); - }).finally(() => { - this.uploadingFiles.delete(path); - this.uploadFiles(); - }); - } - } - if (this.fileQueue.size === 0 && this.uploadingFiles.size === 0) { - this.resolveUploadPromise!(); - } - } - - /** - * Upload a file, asking to override if necessary. - */ - private async uploadFile(filePath: string, file: File): Promise { - const uri = URI.file(filePath); - if (await this.fileService.exists(uri)) { - const overwrite = await new Promise((resolve): void => { - this.notificationService.prompt( - Severity.Error, - `${filePath} already exists. Overwrite?`, - [ - { label: "Yes", run: (): void => resolve(true) }, - { label: "No", run: (): void => resolve(false) }, - ], - { onCancel: () => resolve(false) }, - ); - }); - if (!overwrite) { - return; - } - } - const tempUri = uri.with({ - path: path.join( - path.dirname(uri.path), - `.code-server-partial-upload-${path.basename(uri.path)}-${generateUuid()}`, - ), - }); - const reader = new Reader(file); - reader.on("data", (data) => { - if (data && data.byteLength > 0) { - this.uploaded += data.byteLength; - } - }); - this.uploadingFiles.set(filePath, reader); - await this.fileService.writeFile(tempUri, reader); - if (reader.aborted) { - this.uploaded += (file.size - reader.offset); - await this.fileService.del(tempUri); - } else { - await this.fileService.move(tempUri, uri, true); - this.uploadedFilePaths.push(filePath); - } - } - - /** - * Queue files from a drop event. We have to get the files first; we can't do - * it in tandem with uploading or the entries will disappear. - */ - private async queueFiles(event: DragEvent, uploadDir: URI): Promise { - const promises: Array> = []; - for (let i = 0; event.dataTransfer && event.dataTransfer.items && i < event.dataTransfer.items.length; ++i) { - const item = event.dataTransfer.items[i]; - if (typeof item.webkitGetAsEntry === "function") { - promises.push(this.traverseItem(item.webkitGetAsEntry(), uploadDir.fsPath)); - } else { - const file = item.getAsFile(); - if (file) { - this.addFile(uploadDir.fsPath + "/" + file.name, file); - } - } - } - await Promise.all(promises); - } - - /** - * Traverses an entry and add files to the queue. - */ - private async traverseItem(entry: IEntry, path: string): Promise { - if (entry.isFile) { - return new Promise((resolve): void => { - entry.file((file) => { - resolve(this.addFile(path + "/" + file.name, file)); - }); - }); - } - path += "/" + entry.name; - await new Promise((resolve): void => { - const promises: Array> = []; - const dirReader = entry.createReader(); - // According to the spec, readEntries() must be called until it calls - // the callback with an empty array. - const readEntries = (): void => { - dirReader.readEntries((entries) => { - if (entries.length === 0) { - Promise.all(promises).then(resolve).catch((error) => { - this.notificationService.error(error); - resolve(); - }); - } else { - promises.push(...entries.map((c) => this.traverseItem(c, path))); - readEntries(); - } - }); - }; - readEntries(); - }); - } - - /** - * Add a file to the queue. - */ - private addFile(path: string, file: File): void { - this.total += file.size; - this.fileQueue.set(path, file); - } -} - -class Reader implements VSBufferReadableStream { - private _offset = 0; - private readonly size = 32000; // ~32kb max while reading in the file. - private _aborted = false; - private readonly reader = new FileReader(); - private paused = true; - private buffer?: VSBuffer; - private callbacks = new Map void>>(); - - public constructor(private readonly file: File) { - this.reader.addEventListener("load", this.onLoad); - } - - public get offset(): number { return this._offset; } - public get aborted(): boolean { return this._aborted; } - - public on(event: "data" | "error" | "end", callback: (...args:any[]) => void): void { - if (!this.callbacks.has(event)) { - this.callbacks.set(event, []); - } - this.callbacks.get(event)!.push(callback); - if (this.aborted) { - return this.emit("error", new Error("stream has been aborted")); - } else if (this.done) { - return this.emit("error", new Error("stream has ended")); - } else if (event === "end") { // Once this is being listened to we can safely start outputting data. - this.resume(); - } - } - - public abort = (): void => { - this._aborted = true; - this.reader.abort(); - this.reader.removeEventListener("load", this.onLoad); - this.emit("end"); - } - - public pause(): void { - this.paused = true; - } - - public resume(): void { - if (this.paused) { - this.paused = false; - this.readNextChunk(); - } - } - - public destroy(): void { - this.abort(); - } - - private onLoad = (): void => { - this.buffer = VSBuffer.wrap(new Uint8Array(this.reader.result as ArrayBuffer)); - if (!this.paused) { - this.readNextChunk(); - } - } - - private readNextChunk(): void { - if (this.buffer) { - this._offset += this.buffer.byteLength; - this.emit("data", this.buffer); - this.buffer = undefined; - } - if (!this.paused) { // Could be paused during the data event. - if (this.done) { - this.emit("end"); - } else { - this.reader.readAsArrayBuffer(this.file.slice(this.offset, this.offset + this.size)); - } - } - } - - private emit(event: "data" | "error" | "end", ...args: any[]): void { - if (this.callbacks.has(event)) { - this.callbacks.get(event)!.forEach((cb) => cb(...args)); - } - } - - private get done(): boolean { - return this.offset >= this.file.size; - } -} diff --git a/src/common/emitter.ts b/src/common/emitter.ts new file mode 100644 index 000000000000..78d0d7990ddb --- /dev/null +++ b/src/common/emitter.ts @@ -0,0 +1,61 @@ +import { logger } from "@coder/logger" + +/** + * Event emitter callback. Called with the emitted value and a promise that + * resolves when all emitters have finished. + */ +export type Callback> = (t: T, p: Promise) => R + +export interface Disposable { + dispose(): void | Promise +} + +export interface Event { + (listener: Callback): Disposable +} + +/** + * Emitter typecasts for a single event type. + */ +export class Emitter { + private listeners: Array> = [] + + public get event(): Event { + return (cb: Callback): Disposable => { + this.listeners.push(cb) + + return { + dispose: (): void => { + const i = this.listeners.indexOf(cb) + if (i !== -1) { + this.listeners.splice(i, 1) + } + }, + } + } + } + + /** + * Emit an event with a value. + */ + public async emit(value: T): Promise { + let resolve: () => void + const promise = new Promise((r) => (resolve = r)) + + await Promise.all( + this.listeners.map(async (cb) => { + try { + await cb(value, promise) + } catch (error: any) { + logger.error(error.message) + } + }), + ) + + resolve!() + } + + public dispose(): void { + this.listeners = [] + } +} diff --git a/src/common/http.ts b/src/common/http.ts new file mode 100644 index 000000000000..f005272bfc53 --- /dev/null +++ b/src/common/http.ts @@ -0,0 +1,29 @@ +export enum HttpCode { + Ok = 200, + Redirect = 302, + NotFound = 404, + BadRequest = 400, + Unauthorized = 401, + Forbidden = 403, + LargePayload = 413, + ServerError = 500, +} + +/** + * Represents an error with a message and an HTTP status code. This code will be + * used in the HTTP response. + */ +export class HttpError extends Error { + public constructor( + message: string, + public readonly statusCode: HttpCode, + public readonly details?: object, + ) { + super(message) + this.name = this.constructor.name + } +} + +export function getCookieSessionName(suffix?: string): string { + return suffix ? `code-server-session-${suffix.replace(/[^a-zA-Z0-9-]/g, "-")}` : "code-server-session" +} diff --git a/src/common/nodeProxy.ts b/src/common/nodeProxy.ts deleted file mode 100644 index bfbd6575dc9f..000000000000 --- a/src/common/nodeProxy.ts +++ /dev/null @@ -1,47 +0,0 @@ -import { Event } from "vs/base/common/event"; -import { IChannel, IServerChannel } from "vs/base/parts/ipc/common/ipc"; -import { createDecorator } from "vs/platform/instantiation/common/instantiation"; -import { ReadWriteConnection } from "vs/server/node_modules/@coder/node-browser/out/common/connection"; - -export const INodeProxyService = createDecorator("nodeProxyService"); - -export interface INodeProxyService extends ReadWriteConnection { - _serviceBrand: any; - send(message: string): void; - onMessage: Event; - onUp: Event; - onClose: Event; - onDown: Event; -} - -export class NodeProxyChannel implements IServerChannel { - constructor(private service: INodeProxyService) {} - - listen(_: unknown, event: string): Event { - switch (event) { - case "onMessage": return this.service.onMessage; - } - throw new Error(`Invalid listen ${event}`); - } - - async call(_: unknown, command: string, args?: any): Promise { - switch (command) { - case "send": return this.service.send(args[0]); - } - throw new Error(`Invalid call ${command}`); - } -} - -export class NodeProxyChannelClient { - _serviceBrand: any; - - public readonly onMessage: Event; - - constructor(private readonly channel: IChannel) { - this.onMessage = this.channel.listen("onMessage"); - } - - public send(data: string): void { - this.channel.call("send", [data]); - } -} diff --git a/src/common/telemetry.ts b/src/common/telemetry.ts deleted file mode 100644 index 28adaed5870d..000000000000 --- a/src/common/telemetry.ts +++ /dev/null @@ -1,49 +0,0 @@ -import { ITelemetryData } from "vs/base/common/actions"; -import { Event } from "vs/base/common/event"; -import { IChannel, IServerChannel } from "vs/base/parts/ipc/common/ipc"; -import { ClassifiedEvent, GDPRClassification, StrictPropertyCheck } from "vs/platform/telemetry/common/gdprTypings"; -import { ITelemetryInfo, ITelemetryService } from "vs/platform/telemetry/common/telemetry"; - -export class TelemetryChannel implements IServerChannel { - constructor(private service: ITelemetryService) {} - - listen(_: unknown, event: string): Event { - throw new Error(`Invalid listen ${event}`); - } - - call(_: unknown, command: string, args?: any): Promise { - switch (command) { - case "publicLog": return this.service.publicLog(args[0], args[1], args[2]); - case "publicLog2": return this.service.publicLog2(args[0], args[1], args[2]); - case "setEnabled": return Promise.resolve(this.service.setEnabled(args[0])); - case "getTelemetryInfo": return this.service.getTelemetryInfo(); - } - throw new Error(`Invalid call ${command}`); - } -} - -export class TelemetryChannelClient implements ITelemetryService { - _serviceBrand: any; - - constructor(private readonly channel: IChannel) {} - - public publicLog(eventName: string, data?: ITelemetryData, anonymizeFilePaths?: boolean): Promise { - return this.channel.call("publicLog", [eventName, data, anonymizeFilePaths]); - } - - public publicLog2 = never, T extends GDPRClassification = never>(eventName: string, data?: StrictPropertyCheck, anonymizeFilePaths?: boolean): Promise { - return this.channel.call("publicLog2", [eventName, data, anonymizeFilePaths]); - } - - public setEnabled(value: boolean): void { - this.channel.call("setEnable", [value]); - } - - public getTelemetryInfo(): Promise { - return this.channel.call("getTelemetryInfo"); - } - - public get isOptedIn(): boolean { - return true; - } -} diff --git a/src/common/util.ts b/src/common/util.ts new file mode 100644 index 000000000000..6639beca42b1 --- /dev/null +++ b/src/common/util.ts @@ -0,0 +1,35 @@ +/** + * Appends an 's' to the provided string if count is greater than one; + * otherwise the string is returned + */ +export const plural = (count: number, str: string): string => (count === 1 ? str : `${str}s`) + +export const generateUuid = (length = 24): string => { + const possible = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" + return Array(length) + .fill(1) + .map(() => possible[Math.floor(Math.random() * possible.length)]) + .join("") +} + +/** + * Remove extra slashes in a URL. + * + * This is meant to fill the job of `path.join` so you can concatenate paths and + * then normalize out any extra slashes. + * + * If you are using `path.join` you do not need this but note that `path` is for + * file system paths, not URLs. + */ +export const normalize = (url: string, keepTrailing = false): string => { + return url.replace(/\/\/+/g, "/").replace(/\/+$/, keepTrailing ? "/" : "") +} + +// TODO: Might make sense to add Error handling to the logger itself. +export function logError(logger: { error: (msg: string) => void }, prefix: string, err: unknown): void { + if (err instanceof Error) { + logger.error(`${prefix}: ${err.message} ${err.stack}`) + } else { + logger.error(`${prefix}: ${err}`) + } +} diff --git a/src/login/index.html b/src/login/index.html deleted file mode 100644 index baa440aeb06d..000000000000 --- a/src/login/index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - Authenticate: code-server - - - - - - - - - diff --git a/src/media/code-server.png b/src/media/code-server.png deleted file mode 100644 index d3271a30c32d..000000000000 Binary files a/src/media/code-server.png and /dev/null differ diff --git a/src/media/favicon.ico b/src/media/favicon.ico deleted file mode 100644 index be99fc8c516d..000000000000 Binary files a/src/media/favicon.ico and /dev/null differ diff --git a/src/media/login.css b/src/media/login.css deleted file mode 100644 index f075a6386bc7..000000000000 --- a/src/media/login.css +++ /dev/null @@ -1,94 +0,0 @@ -html { - box-sizing: border-box; -} - -*, *:before, *:after { - box-sizing: inherit; -} - -html, body { - background-color: #FFFFFF; - height: 100%; - min-height: 100%; -} - -body { - align-items: center; - display: flex; - font-family: "monospace"; - justify-content: center; - margin: 0; - padding: 10px; -} - -.login-form { - border-radius: 5px; - box-shadow: 0 18px 80px 10px rgba(69, 65, 78, 0.08); - color: #575962; - margin-top: -10%; - max-width: 328px; - padding: 40px; - position: relative; - width: 100%; -} - -.login-form > .title { - text-align: center; - text-transform: uppercase; - font-size: 12px; - font-weight: 500; - letter-spacing: 1.5px; - line-height: 15px; - margin-bottom: 0px; - margin-bottom: 5px; - margin-top: 0px; -} - -.login-form > .subtitle { - font-size: 19px; - font-weight: bold; - line-height: 25px; - margin-bottom: 45px; - margin: 0; - text-align: center; -} - -.login-form > .field { - text-align: left; - font-size: 12px; - color: #797E84; - margin: 16px 0; -} - -.login-form > .field > .input { - background: none !important; - border: 1px solid #ccc; - border-radius: 2px; - padding: 5px; - width: 100%; -} - -.login-form > .button { - border: none; - border-radius: 24px; - box-shadow: 0 12px 17px 2px rgba(171,173,163,0.14), 0 5px 22px 4px rgba(171,173,163,0.12), 0 7px 8px -4px rgba(171,173,163,0.2); - cursor: pointer; - display: block; - padding: 15px 5px; - width: 100%; -} - -.login-form > .button:hover { - background-color: rgb(0, 122, 204); - color: #fff; -} - -.error-display { - box-sizing: border-box; - color: #bb2d0f; - font-size: 14px; - font-weight: 400; - line-height: 12px; - padding: 20px 8px 0; - text-align: center; -} diff --git a/src/media/manifest.json b/src/media/manifest.json deleted file mode 100644 index 872ecae01f72..000000000000 --- a/src/media/manifest.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "name": "code-server", - "short_name": "code-server", - "start_url": ".", - "display": "standalone", - "background-color": "#fff", - "description": "Run VS Code on a remote server.", - "icons": [{ - "src": "./static/out/vs/server/src/media/code-server.png", - "sizes": "384x384", - "type": "image/png" - }] -} diff --git a/src/node/app.ts b/src/node/app.ts new file mode 100644 index 000000000000..82b1d2733f13 --- /dev/null +++ b/src/node/app.ts @@ -0,0 +1,141 @@ +import { logger } from "@coder/logger" +import compression from "compression" +import express, { Express } from "express" +import { promises as fs } from "fs" +import http from "http" +import * as httpolyglot from "httpolyglot" +import { Disposable } from "../common/emitter" +import * as util from "../common/util" +import { DefaultedArgs } from "./cli" +import { disposer } from "./http" +import { isNodeJSErrnoException } from "./util" +import { EditorSessionManager, makeEditorSessionManagerServer } from "./vscodeSocket" +import { handleUpgrade } from "./wsRouter" + +type SocketOptions = { socket: string; "socket-mode"?: string } +type FdOptions = { "socket-fd": number } +type ListenOptions = DefaultedArgs | SocketOptions | FdOptions + +export interface App extends Disposable { + /** Handles regular HTTP requests. */ + router: Express + /** Handles websocket requests. */ + wsRouter: Express + /** The underlying HTTP server. */ + server: http.Server + /** Handles requests to the editor session management API. */ + editorSessionManagerServer: http.Server +} + +const isSocketOpts = (opts: ListenOptions): opts is SocketOptions => { + return !!(opts as SocketOptions).socket || !(opts as DefaultedArgs).host +} + +export const isFdOpts = (opts: ListenOptions): opts is FdOptions => { + return typeof (opts as FdOptions)["socket-fd"] === "number" +} + +export const listen = async (server: http.Server, opts: ListenOptions) => { + if (!isFdOpts(opts) && isSocketOpts(opts)) { + try { + await fs.unlink(opts.socket) + } catch (error: any) { + handleArgsSocketCatchError(error) + } + } + await new Promise(async (resolve, reject) => { + server.on("error", reject) + const onListen = () => { + // Promise resolved earlier so this is an unrelated error. + server.off("error", reject) + server.on("error", (err) => util.logError(logger, "http server error", err)) + resolve() + } + if (isFdOpts(opts)) { + server.listen({ fd: opts["socket-fd"] }, onListen) + } else if (isSocketOpts(opts)) { + server.listen(opts.socket, onListen) + } else { + // [] is the correct format when using :: but Node errors with them. + server.listen(opts.port, opts.host.replace(/^\[|\]$/g, ""), onListen) + } + }) + + // NOTE@jsjoeio: we need to chmod after the server is finished + // listening. Otherwise, the socket may not have been created yet. + if (!isFdOpts(opts) && isSocketOpts(opts)) { + if (opts["socket-mode"]) { + await fs.chmod(opts.socket, opts["socket-mode"]) + } + } +} + +/** + * Create an Express app and an HTTP/S server to serve it. + */ +export const createApp = async (args: DefaultedArgs): Promise => { + const router = express() + router.use(compression()) + + const server = args.cert + ? httpolyglot.createServer( + { + cert: args.cert && (await fs.readFile(args.cert.value)), + key: args["cert-key"] && (await fs.readFile(args["cert-key"])), + }, + router, + ) + : http.createServer(router) + + const disposeServer = disposer(server) + + await listen(server, args) + + const wsRouter = express() + handleUpgrade(wsRouter, server) + + const editorSessionManager = new EditorSessionManager() + const editorSessionManagerServer = await makeEditorSessionManagerServer(args["session-socket"], editorSessionManager) + const disposeEditorSessionManagerServer = disposer(editorSessionManagerServer) + + const dispose = async () => { + await Promise.all([disposeServer(), disposeEditorSessionManagerServer()]) + } + + return { router, wsRouter, server, dispose, editorSessionManagerServer } +} + +/** + * Get the address of a server as a string (protocol *is* included) while + * ensuring there is one (will throw if there isn't). + * + * The address might be a URL or it might be a pipe or socket path. + */ +export const ensureAddress = (server: http.Server, protocol: string): URL | string => { + const addr = server.address() + + if (!addr) { + throw new Error("Server has no address") + } + + if (typeof addr !== "string") { + const host = addr.family === "IPv6" ? `[${addr.address}]` : addr.address + return new URL(`${protocol}://${host}:${addr.port}`) + } + + // If this is a string then it is a pipe or Unix socket. + return addr +} + +/** + * Handles the error that occurs in the catch block + * after we try fs.unlink(args.socket). + * + * We extracted into a function so that we could + * test this logic more easily. + */ +export const handleArgsSocketCatchError = (error: any) => { + if (!isNodeJSErrnoException(error) || error.code !== "ENOENT") { + throw Error(error.message ? error.message : error) + } +} diff --git a/src/node/channel.ts b/src/node/channel.ts deleted file mode 100644 index 05accab06fb4..000000000000 --- a/src/node/channel.ts +++ /dev/null @@ -1,314 +0,0 @@ -import * as path from "path"; -import { VSBuffer } from "vs/base/common/buffer"; -import { Emitter, Event } from "vs/base/common/event"; -import { IDisposable } from "vs/base/common/lifecycle"; -import { OS } from "vs/base/common/platform"; -import { URI, UriComponents } from "vs/base/common/uri"; -import { transformOutgoingURIs } from "vs/base/common/uriIpc"; -import { IServerChannel } from "vs/base/parts/ipc/common/ipc"; -import { IDiagnosticInfo } from "vs/platform/diagnostics/common/diagnostics"; -import { IEnvironmentService } from "vs/platform/environment/common/environment"; -import { ExtensionIdentifier, IExtensionDescription } from "vs/platform/extensions/common/extensions"; -import { FileDeleteOptions, FileOpenOptions, FileOverwriteOptions, FileType, IStat, IWatchOptions } from "vs/platform/files/common/files"; -import { DiskFileSystemProvider } from "vs/platform/files/node/diskFileSystemProvider"; -import { ILogService } from "vs/platform/log/common/log"; -import pkg from "vs/platform/product/node/package"; -import product from "vs/platform/product/node/product"; -import { IRemoteAgentEnvironment } from "vs/platform/remote/common/remoteAgentEnvironment"; -import { ITelemetryService } from "vs/platform/telemetry/common/telemetry"; -import { INodeProxyService } from "vs/server/src/common/nodeProxy"; -import { getTranslations } from "vs/server/src/node/nls"; -import { getUriTransformer, localRequire } from "vs/server/src/node/util"; -import { ExtensionScanner, ExtensionScannerInput } from "vs/workbench/services/extensions/node/extensionPoints"; - -/** - * Extend the file provider to allow unwatching. - */ -class Watcher extends DiskFileSystemProvider { - public readonly watches = new Map(); - - public dispose(): void { - this.watches.forEach((w) => w.dispose()); - this.watches.clear(); - super.dispose(); - } - - public _watch(req: number, resource: URI, opts: IWatchOptions): void { - this.watches.set(req, this.watch(resource, opts)); - } - - public unwatch(req: number): void { - this.watches.get(req)!.dispose(); - this.watches.delete(req); - } -} - -export class FileProviderChannel implements IServerChannel, IDisposable { - private readonly provider: DiskFileSystemProvider; - private readonly watchers = new Map(); - - public constructor( - private readonly environmentService: IEnvironmentService, - private readonly logService: ILogService, - ) { - this.provider = new DiskFileSystemProvider(this.logService); - } - - public listen(context: any, event: string, args?: any): Event { - switch (event) { - // This is where the actual file changes are sent. The watch method just - // adds things that will fire here. That means we have to split up - // watchers based on the session otherwise sessions would get events for - // other sessions. There is also no point in having the watcher unless - // something is listening. I'm not sure there is a different way to - // dispose, anyway. - case "filechange": - const session = args[0]; - const emitter = new Emitter({ - onFirstListenerAdd: () => { - const provider = new Watcher(this.logService); - this.watchers.set(session, provider); - const transformer = getUriTransformer(context.remoteAuthority); - provider.onDidChangeFile((events) => { - emitter.fire(events.map((event) => ({ - ...event, - resource: transformer.transformOutgoing(event.resource), - }))); - }); - provider.onDidErrorOccur((event) => emitter.fire(event)); - }, - onLastListenerRemove: () => { - this.watchers.get(session)!.dispose(); - this.watchers.delete(session); - }, - }); - - return emitter.event; - } - - throw new Error(`Invalid listen "${event}"`); - } - - public call(_: unknown, command: string, args?: any): Promise { - switch (command) { - case "stat": return this.stat(args[0]); - case "open": return this.open(args[0], args[1]); - case "close": return this.close(args[0]); - case "read": return this.read(args[0], args[1], args[2]); - case "write": return this.write(args[0], args[1], args[2], args[3], args[4]); - case "delete": return this.delete(args[0], args[1]); - case "mkdir": return this.mkdir(args[0]); - case "readdir": return this.readdir(args[0]); - case "rename": return this.rename(args[0], args[1], args[2]); - case "copy": return this.copy(args[0], args[1], args[2]); - case "watch": return this.watch(args[0], args[1], args[2], args[3]); - case "unwatch": return this.unwatch(args[0], args[1]); - } - - throw new Error(`Invalid call "${command}"`); - } - - public dispose(): void { - this.watchers.forEach((w) => w.dispose()); - this.watchers.clear(); - } - - private async stat(resource: UriComponents): Promise { - return this.provider.stat(this.transform(resource)); - } - - private async open(resource: UriComponents, opts: FileOpenOptions): Promise { - return this.provider.open(this.transform(resource), opts); - } - - private async close(fd: number): Promise { - return this.provider.close(fd); - } - - private async read(fd: number, pos: number, length: number): Promise<[VSBuffer, number]> { - const buffer = VSBuffer.alloc(length); - const bytesRead = await this.provider.read(fd, pos, buffer.buffer, 0, length); - return [buffer, bytesRead]; - } - - private write(fd: number, pos: number, buffer: VSBuffer, offset: number, length: number): Promise { - return this.provider.write(fd, pos, buffer.buffer, offset, length); - } - - private async delete(resource: UriComponents, opts: FileDeleteOptions): Promise { - return this.provider.delete(this.transform(resource), opts); - } - - private async mkdir(resource: UriComponents): Promise { - return this.provider.mkdir(this.transform(resource)); - } - - private async readdir(resource: UriComponents): Promise<[string, FileType][]> { - return this.provider.readdir(this.transform(resource)); - } - - private async rename(resource: UriComponents, target: UriComponents, opts: FileOverwriteOptions): Promise { - return this.provider.rename(this.transform(resource), URI.from(target), opts); - } - - private copy(resource: UriComponents, target: UriComponents, opts: FileOverwriteOptions): Promise { - return this.provider.copy(this.transform(resource), URI.from(target), opts); - } - - private async watch(session: string, req: number, resource: UriComponents, opts: IWatchOptions): Promise { - this.watchers.get(session)!._watch(req, this.transform(resource), opts); - } - - private async unwatch(session: string, req: number): Promise { - this.watchers.get(session)!.unwatch(req); - } - - private transform(resource: UriComponents): URI { - // Used for walkthrough content. - if (/^\/static[^/]*\//.test(resource.path)) { - return URI.file(this.environmentService.appRoot + resource.path.replace(/^\/static[^/]*\//, "/")); - // Used by the webview service worker to load resources. - } else if (resource.path === "/vscode-resource" && resource.query) { - try { - const query = JSON.parse(resource.query); - if (query.requestResourcePath) { - return URI.file(query.requestResourcePath); - } - } catch (error) { /* Carry on. */ } - } - return URI.from(resource); - } -} - -export class ExtensionEnvironmentChannel implements IServerChannel { - public constructor( - private readonly environment: IEnvironmentService, - private readonly log: ILogService, - private readonly telemetry: ITelemetryService, - private readonly connectionToken: string, - ) {} - - public listen(_: unknown, event: string): Event { - throw new Error(`Invalid listen "${event}"`); - } - - public async call(context: any, command: string, args?: any): Promise { - switch (command) { - case "getEnvironmentData": - return transformOutgoingURIs( - await this.getEnvironmentData(args.language), - getUriTransformer(context.remoteAuthority), - ); - case "getDiagnosticInfo": return this.getDiagnosticInfo(); - case "disableTelemetry": return this.disableTelemetry(); - } - throw new Error(`Invalid call "${command}"`); - } - - private async getEnvironmentData(locale: string): Promise { - return { - pid: process.pid, - connectionToken: this.connectionToken, - appRoot: URI.file(this.environment.appRoot), - appSettingsHome: this.environment.appSettingsHome, - settingsPath: this.environment.machineSettingsHome, - logsPath: URI.file(this.environment.logsPath), - extensionsPath: URI.file(this.environment.extensionsPath!), - extensionHostLogsPath: URI.file(path.join(this.environment.logsPath, "extension-host")), - globalStorageHome: URI.file(this.environment.globalStorageHome), - userHome: URI.file(this.environment.userHome), - extensions: await this.scanExtensions(locale), - os: OS, - }; - } - - private async scanExtensions(locale: string): Promise { - const translations = await getTranslations(locale, this.environment.userDataPath); - - const scanMultiple = (isBuiltin: boolean, isUnderDevelopment: boolean, paths: string[]): Promise => { - return Promise.all(paths.map((path) => { - return ExtensionScanner.scanExtensions(new ExtensionScannerInput( - pkg.version, - product.commit, - locale, - !!process.env.VSCODE_DEV, - path, - isBuiltin, - isUnderDevelopment, - translations, - ), this.log); - })); - }; - - const scanBuiltin = async (): Promise => { - return scanMultiple(true, false, [this.environment.builtinExtensionsPath, ...this.environment.extraBuiltinExtensionPaths]); - }; - - const scanInstalled = async (): Promise => { - return scanMultiple(false, true, [this.environment.extensionsPath!, ...this.environment.extraExtensionPaths]); - }; - - return Promise.all([scanBuiltin(), scanInstalled()]).then((allExtensions) => { - const uniqueExtensions = new Map(); - allExtensions.forEach((multipleExtensions) => { - multipleExtensions.forEach((extensions) => { - extensions.forEach((extension) => { - const id = ExtensionIdentifier.toKey(extension.identifier); - if (uniqueExtensions.has(id)) { - const oldPath = uniqueExtensions.get(id)!.extensionLocation.fsPath; - const newPath = extension.extensionLocation.fsPath; - this.log.warn(`${oldPath} has been overridden ${newPath}`); - } - uniqueExtensions.set(id, extension); - }); - }); - }); - return Array.from(uniqueExtensions.values()); - }); - } - - private getDiagnosticInfo(): Promise { - throw new Error("not implemented"); - } - - private async disableTelemetry(): Promise { - this.telemetry.setEnabled(false); - } -} - -export class NodeProxyService implements INodeProxyService { - public _serviceBrand = undefined; - - public readonly server: import("@coder/node-browser/out/server/server").Server; - - private readonly _onMessage = new Emitter(); - public readonly onMessage = this._onMessage.event; - private readonly _$onMessage = new Emitter(); - public readonly $onMessage = this._$onMessage.event; - public readonly _onDown = new Emitter(); - public readonly onDown = this._onDown.event; - public readonly _onUp = new Emitter(); - public readonly onUp = this._onUp.event; - - // Unused because the server connection will never permanently close. - private readonly _onClose = new Emitter(); - public readonly onClose = this._onClose.event; - - public constructor() { - // TODO: close/down/up - const { Server } = localRequire("@coder/node-browser/out/server/server"); - this.server = new Server({ - onMessage: this.$onMessage, - onClose: this.onClose, - onDown: this.onDown, - onUp: this.onUp, - send: (message: string): void => { - this._onMessage.fire(message); - } - }); - } - - public send(message: string): void { - this._$onMessage.fire(message); - } -} diff --git a/src/node/cli.ts b/src/node/cli.ts index 1766bdb2e8c0..6597a3b6ae6b 100644 --- a/src/node/cli.ts +++ b/src/node/cli.ts @@ -1,262 +1,1017 @@ -import * as cp from "child_process"; -import * as os from "os"; -import * as path from "path"; -import { setUnexpectedErrorHandler } from "vs/base/common/errors"; -import { main as vsCli } from "vs/code/node/cliProcessMain"; -import { validatePaths } from "vs/code/node/paths"; -import { ParsedArgs } from "vs/platform/environment/common/environment"; -import { buildHelpMessage, buildVersionMessage, Option as VsOption, options as vsOptions } from "vs/platform/environment/node/argv"; -import { parseMainProcessArgv } from "vs/platform/environment/node/argvHelper"; -import pkg from "vs/platform/product/node/package"; -import product from "vs/platform/product/node/product"; -import { ipcMain } from "vs/server/src/node/ipc"; -import { enableCustomMarketplace } from "vs/server/src/node/marketplace"; -import { MainServer } from "vs/server/src/node/server"; -import { AuthType, buildAllowedMessage, enumToArray, FormatType, generateCertificate, generatePassword, localRequire, open, unpackExecutables } from "vs/server/src/node/util"; - -const { logger } = localRequire("@coder/logger/out/index"); -setUnexpectedErrorHandler((error) => logger.warn(error.message)); - -interface Args extends ParsedArgs { - auth?: AuthType; - "base-path"?: string; - cert?: string; - "cert-key"?: string; - format?: string; - host?: string; - open?: string; - port?: string; - socket?: string; +import { field, Level, logger } from "@coder/logger" +import * as crypto from "crypto" +import { promises as fs } from "fs" +import { load } from "js-yaml" +import * as path from "path" +import { expandTilde, generateCertificate, generatePassword, paths, splitOnFirstEquals } from "./util" +import { EditorSessionManagerClient } from "./vscodeSocket" + +export enum Feature { + // No current experimental features! + Placeholder = "placeholder", +} + +export enum AuthType { + Password = "password", + None = "none", +} + +export class Optional { + public constructor(public readonly value?: T) {} +} + +export enum LogLevel { + Trace = "trace", + Debug = "debug", + Info = "info", + Warn = "warn", + Error = "error", +} + +export class OptionalString extends Optional {} + +/** + * (VS) Code flags provided by the user. + */ +export interface UserProvidedCodeArgs { + "disable-telemetry"?: boolean + force?: boolean + "user-data-dir"?: string + "enable-proposed-api"?: string[] + "extensions-dir"?: string + "builtin-extensions-dir"?: string + "install-extension"?: string[] + "uninstall-extension"?: string[] + "list-extensions"?: boolean + "locate-extension"?: string[] + "show-versions"?: boolean + category?: string + "github-auth"?: string + "enable-remote-storage"?: boolean + "disable-update-check"?: boolean + "disable-file-downloads"?: boolean + "disable-file-uploads"?: boolean + "disable-workspace-trust"?: boolean + "disable-getting-started-override"?: boolean + "disable-proxy"?: boolean + "reconnection-grace-time"?: string + "session-socket"?: string + "cookie-suffix"?: string + "link-protection-trusted-domains"?: string[] + // locale is used by both VS Code and code-server. + locale?: string +} + +/** + * Arguments that the user explicitly provided on the command line. All + * arguments must be optional. + * + * For arguments with defaults see DefaultedArgs. + */ +export interface UserProvidedArgs extends UserProvidedCodeArgs { + config?: string + auth?: AuthType + password?: string + "hashed-password"?: string + cert?: OptionalString + "cert-host"?: string + "cert-key"?: string + enable?: string[] + help?: boolean + host?: string + port?: number + json?: boolean + log?: LogLevel + open?: boolean + "bind-addr"?: string + socket?: string + "socket-fd"?: number + "socket-mode"?: string + "trusted-origins"?: string[] + version?: boolean + "proxy-domain"?: string[] + "skip-auth-preflight"?: boolean + "reuse-window"?: boolean + "new-window"?: boolean + "ignore-last-opened"?: boolean + verbose?: boolean + "app-name"?: string + "welcome-text"?: string + "abs-proxy-base-path"?: string + i18n?: string + "idle-timeout-seconds"?: number + "vscode-option"?: string[] + /* Positional arguments. */ + _?: string[] +} + +interface Option { + type: T + /** + * Short flag for the option. + */ + short?: string + /** + * Whether the option is a path and should be resolved. + */ + path?: boolean + /** + * Description of the option. Leave blank to hide the option. + */ + description?: string + + /** + * If marked as deprecated, the option is marked as deprecated in help. + */ + deprecated?: boolean +} + +type OptionType = T extends boolean + ? "boolean" + : T extends OptionalString + ? typeof OptionalString + : T extends LogLevel + ? typeof LogLevel + : T extends AuthType + ? typeof AuthType + : T extends number + ? "number" + : T extends string + ? "string" + : T extends string[] + ? "string[]" + : "unknown" + +export type Options = { + [P in keyof T]: Option> +} + +export const options: Options> = { + auth: { type: AuthType, description: "The type of authentication to use." }, + password: { + type: "string", + description: "The password for password authentication (can only be passed in via $PASSWORD or the config file).", + }, + "hashed-password": { + type: "string", + description: + "The password hashed with argon2 for password authentication (can only be passed in via $HASHED_PASSWORD or the config file). \n" + + "Takes precedence over 'password'.", + }, + cert: { + type: OptionalString, + path: true, + description: "Path to certificate. A self signed certificate is generated if none is provided.", + }, + "cert-host": { + type: "string", + description: "Hostname to use when generating a self signed certificate.", + }, + "cert-key": { type: "string", path: true, description: "Path to certificate key when using non-generated cert." }, + "disable-telemetry": { type: "boolean", description: "Disable telemetry." }, + "disable-update-check": { + type: "boolean", + description: + "Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and \n" + + "then notifies you once every week that a new release is available.", + }, + "session-socket": { + type: "string", + }, + "cookie-suffix": { + type: "string", + description: + "Adds a suffix to the cookie. This can prevent a collision of cookies for subdomains, making them explixit. \n" + + "Without this flag, no suffix is used. This can also be set with CODE_SERVER_COOKIE_SUFFIX set to any string.", + }, + "disable-file-downloads": { + type: "boolean", + description: + "Disable file downloads from Code. This can also be set with CS_DISABLE_FILE_DOWNLOADS set to 'true' or '1'.", + }, + "disable-file-uploads": { + type: "boolean", + description: "Disable file uploads.", + }, + "disable-workspace-trust": { + type: "boolean", + description: "Disable Workspace Trust feature. This switch only affects the current session.", + }, + "disable-getting-started-override": { + type: "boolean", + description: "Disable the coder/coder override in the Help: Getting Started page.", + }, + "disable-proxy": { + type: "boolean", + description: "Disable domain and path proxy routes.", + }, + // --enable can be used to enable experimental features. These features + // provide no guarantees. + enable: { type: "string[]" }, + help: { type: "boolean", short: "h", description: "Show this output." }, + json: { type: "boolean" }, + "link-protection-trusted-domains": { + type: "string[]", + description: "Links matching a trusted domain can be opened without link protection.", + }, + locale: { + // The preferred way to set the locale is via the UI. + type: "string", + description: ` + Set vscode display language and language to show on the login page, more info see + https://en.wikipedia.org/wiki/IETF_language_tag + `, + }, + open: { type: "boolean", description: "Open in browser on startup. Does not work remotely." }, + + "bind-addr": { + type: "string", + description: "Address to bind to in host:port. You can also use $PORT to override the port.", + }, + + config: { + type: "string", + description: "Path to yaml config file. Every flag maps directly to a key in the config file.", + }, + + // These two have been deprecated by bindAddr. + host: { type: "string", description: "" }, + port: { type: "number", description: "" }, + + socket: { type: "string", path: true, description: "Path to a socket (bind-addr will be ignored)." }, + "socket-fd": { + type: "number", + description: "File descriptor of a pre-bound, listening socket to use (for systemd socket activation).", + }, + "socket-mode": { type: "string", description: "File mode of the socket." }, + "trusted-origins": { + type: "string[]", + description: + "Disables authenticate origin check for trusted origin. Useful if not able to access reverse proxy configuration.", + }, + version: { type: "boolean", short: "v", description: "Display version information." }, + _: { type: "string[]" }, + + "user-data-dir": { type: "string", path: true, description: "Path to the user data directory." }, + "extensions-dir": { type: "string", path: true, description: "Path to the extensions directory." }, + "builtin-extensions-dir": { type: "string", path: true }, + "list-extensions": { type: "boolean", description: "List installed VS Code extensions." }, + force: { type: "boolean", description: "Avoid prompts when installing VS Code extensions." }, + "locate-extension": { type: "string[]" }, + category: { type: "string" }, + "install-extension": { + type: "string[]", + description: + "Install or update a VS Code extension by id or vsix. The identifier of an extension is `${publisher}.${name}`.\n" + + "To install a specific version provide `@${version}`. For example: 'vscode.csharp@1.2.3'.", + }, + "enable-proposed-api": { + type: "string[]", + description: + "Enable proposed API features for extensions. Can receive one or more extension IDs to enable individually.", + }, + "uninstall-extension": { type: "string[]", description: "Uninstall a VS Code extension by id." }, + "show-versions": { type: "boolean", description: "Show VS Code extension versions." }, + "github-auth": { + type: "string", + description: "GitHub authentication token (can only be passed in via $GITHUB_TOKEN or the config file).", + }, + "enable-remote-storage": { + type: "boolean", + description: "Persist VS Code workbench storage on the remote server instead of browser storage.", + }, + "proxy-domain": { type: "string[]", description: "Domain used for proxying ports." }, + "skip-auth-preflight": { + type: "boolean", + description: "Allows preflight requests through proxy without authentication.", + }, + "ignore-last-opened": { + type: "boolean", + short: "e", + description: "Ignore the last opened directory or workspace in favor of an empty window.", + }, + "new-window": { + type: "boolean", + short: "n", + description: "Force to open a new window.", + }, + "reuse-window": { + type: "boolean", + short: "r", + description: "Force to open a file or folder in an already opened window.", + }, + + log: { type: LogLevel }, + verbose: { type: "boolean", short: "vvv", description: "Enable verbose logging." }, + "app-name": { + type: "string", + short: "an", + description: + "Will replace the {{app}} placeholder in any strings, which by default includes the title bar and welcome message", + }, + "welcome-text": { + type: "string", + short: "w", + description: "Text to show on login page", + deprecated: true, + }, + "abs-proxy-base-path": { + type: "string", + description: "The base path to prefix to all absproxy requests", + }, + i18n: { + type: "string", + path: true, + description: "Path to JSON file with custom translations. Merges with default strings and supports all i18n keys.", + }, + "idle-timeout-seconds": { + type: "number", + description: "Timeout in seconds to wait before shutting down when idle.", + }, + "reconnection-grace-time": { + type: "string", + description: + "Override the reconnection grace time in seconds. Clients who disconnect for longer than this duration will need to \n" + + "reload the window. Defaults to 10800 (3 hours).", + }, + "vscode-option": { + type: "string[]", + description: + "Pass an option straight through to the VS Code server as flag=value, or as a bare flag for a \n" + + "boolean. Repeatable; repeating the same flag builds an array. Use this to reach VS Code options \n" + + "code-server does not model itself, e.g. --vscode-option enable-sandbox --vscode-option agents=true.", + }, +} + +export const optionDescriptions = (opts: Partial>> = options): string[] => { + const entries = Object.entries(opts).filter(([, v]) => !!v.description) + const widths = entries.reduce( + (prev, [k, v]) => ({ + long: k.length > prev.long ? k.length : prev.long, + short: v.short && v.short.length > prev.short ? v.short.length : prev.short, + }), + { short: 0, long: 0 }, + ) + return entries.map(([k, v]) => { + const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${v.short ? `-${v.short}` : " "} --${k} ` + return ( + help + + v.description + ?.trim() + .split(/\n/) + .map((line, i) => { + line = line.trim() + if (i === 0) { + return " ".repeat(widths.long - k.length) + (v.deprecated ? "(deprecated) " : "") + line + } + return " ".repeat(widths.long + widths.short + 6) + line + }) + .join("\n") + + (typeof v.type === "object" ? ` [${Object.values(v.type).join(", ")}]` : "") + ) + }) +} + +/** + * Parse arguments into UserProvidedArgs. This should not go beyond checking + * that arguments are valid types and have values when required. + */ +export const parse = ( + argv: string[], + opts?: { + configFile?: string + }, +): UserProvidedArgs => { + const error = (msg: string): Error => { + if (opts?.configFile) { + msg = `error reading ${opts.configFile}: ${msg}` + } + + return new Error(msg) + } + + const args: UserProvidedArgs = {} + let ended = false + + for (let i = 0; i < argv.length; ++i) { + const arg = argv[i] + + // -- signals the end of option parsing. + if (!ended && arg === "--") { + ended = true + continue + } + + // Options start with a dash and require a value if non-boolean. + if (!ended && arg.startsWith("-")) { + let key: keyof UserProvidedArgs | undefined + let value: string | undefined + if (arg.startsWith("--")) { + const split = splitOnFirstEquals(arg.replace(/^--/, "")) + key = split[0] as keyof UserProvidedArgs + value = split[1] + } else { + const short = arg.replace(/^-/, "") + const pair = Object.entries(options).find(([, v]) => v.short === short) + if (pair) { + key = pair[0] as keyof UserProvidedArgs + } + } + + if (!key || !options[key]) { + throw error(`Unknown option ${arg}`) + } + + if (key === "password" && !opts?.configFile) { + throw new Error("--password can only be set in the config file or passed in via $PASSWORD") + } + + if (key === "hashed-password" && !opts?.configFile) { + throw new Error("--hashed-password can only be set in the config file or passed in via $HASHED_PASSWORD") + } + + if (key === "github-auth" && !opts?.configFile) { + throw new Error("--github-auth can only be set in the config file or passed in via $GITHUB_TOKEN") + } + + const option = options[key] + if (option.type === "boolean") { + // Booleans set to false (for example `--flag=false`, which is also how + // false values from the config file are passed in) are ignored. + if (value !== "false") { + ;(args[key] as boolean) = true + } + continue + } + + // Might already have a value if it was the --long=value format. + if (typeof value === "undefined") { + // A value is only valid if it doesn't look like an option. + value = argv[i + 1] && !argv[i + 1].startsWith("-") ? argv[++i] : undefined + } + + if (!value && option.type === OptionalString) { + ;(args[key] as OptionalString) = new OptionalString(value) + continue + } else if (!value) { + throw error(`--${key} requires a value`) + } + + if (key === "idle-timeout-seconds" && Number(value) <= 60) { + throw new Error("--idle-timeout-seconds must be greater than 60 seconds.") + } + + if (option.type === OptionalString && value === "false") { + continue + } + + if (option.path) { + value = path.resolve(expandTilde(value)) + } + + switch (option.type) { + case "string": + ;(args[key] as string) = value + break + case "string[]": + if (!args[key]) { + ;(args[key] as string[]) = [] + } + ;(args[key] as string[]).push(value) + break + case "number": + ;(args[key] as number) = parseInt(value, 10) + if (isNaN(args[key] as number)) { + throw error(`--${key} must be a number`) + } + break + case OptionalString: + ;(args[key] as OptionalString) = new OptionalString(value) + break + default: { + if (!Object.values(option.type).includes(value)) { + throw error(`--${key} valid values: [${Object.values(option.type).join(", ")}]`) + } + ;(args[key] as string) = value + break + } + } + + continue + } + + // Everything else goes into _. + if (typeof args._ === "undefined") { + args._ = [] + } + + args._.push(arg) + } + + // If a cert was provided a key must also be provided. + if (args.cert && args.cert.value && !args["cert-key"]) { + throw new Error("--cert-key is missing") + } + + logger.debug(() => [`parsed ${opts?.configFile ? "config" : "command line"}`, field("args", redactArgs(args))]) + + return args +} + +/** + * Redact sensitive information from arguments for logging. + */ +export const redactArgs = (args: UserProvidedArgs): UserProvidedArgs => { + return { + ...args, + password: args.password ? "" : undefined, + "hashed-password": args["hashed-password"] ? "" : undefined, + "github-auth": args["github-auth"] ? "" : undefined, + } +} + +/** + * User-provided arguments with defaults. The distinction between user-provided + * args and defaulted args exists so we can tell the difference between end + * values and what the user actually provided on the command line. + */ +export interface DefaultedArgs extends ConfigArgs { + auth: AuthType + cert?: { + value: string + } + host: string + port: number + "proxy-domain": string[] + verbose: boolean + usingEnvPassword: boolean + usingEnvHashedPassword: boolean + "extensions-dir": string + "user-data-dir": string + "session-socket": string + "app-name": string + /* Positional arguments. */ + _: string[] +} + +/** + * Take CLI and config arguments (optional) and return a single set of arguments + * with the defaults set. Arguments from the CLI are prioritized over config + * arguments. + */ +export async function setDefaults(cliArgs: UserProvidedArgs, configArgs?: ConfigArgs): Promise { + const args = Object.assign({}, configArgs || {}, cliArgs) + + if (!args["user-data-dir"]) { + args["user-data-dir"] = paths.data + } + + if (!args["extensions-dir"]) { + args["extensions-dir"] = path.join(args["user-data-dir"], "extensions") + } + + if (!args["session-socket"]) { + args["session-socket"] = defaultSessionSocket(args["user-data-dir"]) + } + process.env.CODE_SERVER_SESSION_SOCKET = args["session-socket"] + + // --verbose takes priority over --log and --log takes priority over the + // environment variable. + if (args.verbose) { + args.log = LogLevel.Trace + } else if ( + !args.log && + process.env.LOG_LEVEL && + Object.values(LogLevel).includes(process.env.LOG_LEVEL as LogLevel) + ) { + args.log = process.env.LOG_LEVEL as LogLevel + } + + // Sync --log, --verbose, the environment variable, and logger level. + if (args.log) { + process.env.LOG_LEVEL = args.log + } + switch (args.log) { + case LogLevel.Trace: + logger.level = Level.Trace + args.verbose = true + break + case LogLevel.Debug: + logger.level = Level.Debug + args.verbose = false + break + case LogLevel.Info: + logger.level = Level.Info + args.verbose = false + break + case LogLevel.Warn: + logger.level = Level.Warn + args.verbose = false + break + case LogLevel.Error: + logger.level = Level.Error + args.verbose = false + break + } + + // Default to using a password. + if (!args.auth) { + args.auth = AuthType.Password + } + + const addr = bindAddrFromAllSources(configArgs || {}, cliArgs) + args.host = addr.host + args.port = addr.port + + if (args.cert && !args.cert.value) { + const { cert, certKey } = await generateCertificate(args["cert-host"] || "localhost") + args.cert = { + value: cert, + } + args["cert-key"] = certKey + } + + let usingEnvPassword = !!process.env.PASSWORD + if (process.env.PASSWORD) { + args.password = process.env.PASSWORD + } + + if (process.env.CS_DISABLE_FILE_DOWNLOADS?.match(/^(1|true)$/)) { + args["disable-file-downloads"] = true + } + + if (process.env.CS_DISABLE_GETTING_STARTED_OVERRIDE?.match(/^(1|true)$/)) { + args["disable-getting-started-override"] = true + } + + if (process.env.CS_DISABLE_PROXY?.match(/^(1|true)$/)) { + args["disable-proxy"] = true + } + + const usingEnvHashedPassword = !!process.env.HASHED_PASSWORD + if (process.env.HASHED_PASSWORD) { + args["hashed-password"] = process.env.HASHED_PASSWORD + usingEnvPassword = false + } + + if (process.env.CODE_SERVER_COOKIE_SUFFIX) { + args["cookie-suffix"] = process.env.CODE_SERVER_COOKIE_SUFFIX + } + + if (process.env.GITHUB_TOKEN) { + args["github-auth"] = process.env.GITHUB_TOKEN + } + + if (process.env.CODE_SERVER_RECONNECTION_GRACE_TIME) { + args["reconnection-grace-time"] = process.env.CODE_SERVER_RECONNECTION_GRACE_TIME + } + + // Space-separated, like NODE_OPTIONS. Appended to any flags rather than + // replacing them so the two can be combined. + if (process.env.VSCODE_OPTIONS) { + args["vscode-option"] = [ + ...(args["vscode-option"] ?? []), + ...process.env.VSCODE_OPTIONS.split(/\s+/).filter((option) => option), + ] + } + + if (process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS) { + if (isNaN(Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS))) { + logger.info("CODE_SERVER_IDLE_TIMEOUT_SECONDS must be a number") + } + if (Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS) <= 60) { + throw new Error("--idle-timeout-seconds must be greater than 60 seconds.") + } + args["idle-timeout-seconds"] = Number(process.env.CODE_SERVER_IDLE_TIMEOUT_SECONDS) + } + + // Ensure they're not readable by child processes. + delete process.env.PASSWORD + delete process.env.HASHED_PASSWORD + delete process.env.GITHUB_TOKEN + + // Filter duplicate proxy domains and remove any leading `*.`. + const proxyDomains = new Set((args["proxy-domain"] || []).map((d) => d.replace(/^\*\./, ""))) + const finalProxies = [] + + for (const proxyDomain of proxyDomains) { + if (!proxyDomain.includes("{{port}}")) { + finalProxies.push("{{port}}." + proxyDomain) + } else { + finalProxies.push(proxyDomain) + } + } + + // all proxies are of format anyprefix-{{port}}-anysuffix.{{host}}, where {{host}} is optional + // e.g. code-8080.domain.tld would match for code-{{port}}.domain.tld and code-{{port}}.{{host}} + if (finalProxies.length > 0 && !process.env.VSCODE_PROXY_URI) { + process.env.VSCODE_PROXY_URI = `//${finalProxies[0]}` + } + args["proxy-domain"] = finalProxies + + args["app-name"] ??= process.env.CODE_SERVER_APP_NAME || "code-server" + + args._ = getResolvedPathsFromArgs(args) + + return { + ...args, + usingEnvPassword, + usingEnvHashedPassword, + } as DefaultedArgs // TODO: Technically no guarantee this is fulfilled. +} + +/** + * The session socket to use when one was not given. + * + * Windows has no Unix sockets, so there it is a named pipe, which lives in its + * own namespace rather than on disk and so cannot be placed inside the user + * data directory. The name is derived from that directory anyway, so that two + * instances with separate data directories do not collide and a later + * invocation with the same one finds the first. Windows paths are compared + * without regard to case, so the name is folded before it is hashed; otherwise + * the same directory typed two ways would produce two pipes. + */ +export function defaultSessionSocket(userDataDir: string, platform: NodeJS.Platform = process.platform): string { + if (platform !== "win32") { + return path.join(userDataDir, "code-server-ipc.sock") + } + const name = crypto.createHash("sha256").update(path.resolve(userDataDir).toLowerCase()).digest("hex").slice(0, 16) + return String.raw`\\.\pipe\code-server-ipc-${name}` +} + +export function getResolvedPathsFromArgs(args: UserProvidedArgs): string[] { + return (args._ ?? []).map((p) => path.resolve(p)) +} + +/** + * Helper function to return the default config file. + * + * @param {string} password - Password passed in (usually from generatePassword()) + * @returns The default config file: + * + * - bind-addr: 127.0.0.1:8080 + * - auth: password + * - password: + * - cert: false + */ +export function defaultConfigFile(password: string): string { + return `bind-addr: 127.0.0.1:8080 +auth: password +password: ${password} +cert: false +` +} + +interface ConfigArgs extends UserProvidedArgs { + config: string +} + +/** + * Reads the code-server yaml config file and returns it as Args. + * + * @param configPath Read the config from configPath instead of $CODE_SERVER_CONFIG or the default. + */ +export async function readConfigFile(configPath?: string): Promise { + if (!configPath) { + configPath = process.env.CODE_SERVER_CONFIG + if (!configPath) { + configPath = path.join(paths.config, "config.yaml") + } + } + + await fs.mkdir(path.dirname(configPath), { recursive: true }) + + try { + const generatedPassword = await generatePassword() + await fs.writeFile(configPath, defaultConfigFile(generatedPassword), { + flag: "wx", // wx means to fail if the path exists. + }) + logger.info(`Wrote default config file to ${configPath}`) + } catch (error: any) { + // EEXIST is fine; we don't want to overwrite existing configurations. + if (error.code !== "EEXIST") { + throw error + } + } + + const configFile = await fs.readFile(configPath, "utf8") + return parseConfigFile(configFile, configPath) +} + +/** + * parseConfigFile parses configFile into ConfigArgs. + * configPath is used as the filename in error messages + */ +export function parseConfigFile(configFile: string, configPath: string): ConfigArgs { + if (!configFile) { + return { config: configPath } + } + + const config = load(configFile, { + filename: configPath, + }) + if (!config || typeof config === "string") { + throw new Error(`invalid config: ${config}`) + } + + // We convert the config file into a set of flags. + // This is a temporary measure until we add a proper CLI library. + const configFileArgv = Object.entries(config) + .map(([optName, opt]) => { + if (opt === true) { + return `--${optName}` + } else if (Array.isArray(opt)) { + return opt.map((o) => `--${optName}=${o}`) + } + return `--${optName}=${opt}` + }) + .flat() + const args = parse(configFileArgv, { + configFile: configPath, + }) + return { + ...args, + config: configPath, + } +} + +function parseBindAddr(bindAddr: string): Addr { + const u = new URL(`http://${bindAddr}`) + return { + host: u.hostname, + // With the http scheme 80 will be dropped so assume it's 80 if missing. + // This means --bind-addr without a port will default to 80 as well + // and not the code-server default. + port: u.port ? parseInt(u.port, 10) : 80, + } +} + +interface Addr { + host: string + port: number +} + +/** + * This function creates the bind address + * using the CLI args. + */ +export function bindAddrFromArgs(addr: Addr, args: UserProvidedArgs): Addr { + addr = { ...addr } + if (args["bind-addr"]) { + addr = parseBindAddr(args["bind-addr"]) + } + if (process.env.CODE_SERVER_HOST) { + addr.host = process.env.CODE_SERVER_HOST + } + if (args.host) { + addr.host = args.host + } + + if (process.env.PORT) { + addr.port = parseInt(process.env.PORT, 10) + } + if (args.port !== undefined) { + addr.port = args.port + } + return addr } -// @ts-ignore: Force `keyof Args` to work. -interface Option extends VsOption { - id: keyof Args; +function bindAddrFromAllSources(...argsConfig: UserProvidedArgs[]): Addr { + let addr: Addr = { + host: "localhost", + port: 8080, + } + + for (const args of argsConfig) { + addr = bindAddrFromArgs(addr, args) + } + + return addr } -const getArgs = (): Args => { - const options = vsOptions as Option[]; - // The last item is _ which is like -- so our options need to come before it. - const last = options.pop()!; - - // Remove options that won't work or don't make sense. - let i = options.length; - while (i--) { - switch (options[i].id) { - case "add": - case "diff": - case "file-uri": - case "folder-uri": - case "goto": - case "new-window": - case "reuse-window": - case "wait": - case "disable-gpu": - // TODO: pretty sure these don't work but not 100%. - case "max-memory": - case "prof-startup": - case "inspect-extensions": - case "inspect-brk-extensions": - options.splice(i, 1); - break; - } - } - - options.push({ id: "base-path", type: "string", cat: "o", description: "Base path of the URL at which code-server is hosted (used for login redirects)." }); - options.push({ id: "cert", type: "string", cat: "o", description: "Path to certificate. If the path is omitted, both this and --cert-key will be generated." }); - options.push({ id: "cert-key", type: "string", cat: "o", description: "Path to the certificate's key if one was provided." }); - options.push({ id: "extra-builtin-extensions-dir", type: "string", cat: "o", description: "Path to an extra builtin extension directory." }); - options.push({ id: "extra-extensions-dir", type: "string", cat: "o", description: "Path to an extra user extension directory." }); - options.push({ id: "format", type: "string", cat: "o", description: `Format for the version. ${buildAllowedMessage(FormatType)}.` }); - options.push({ id: "host", type: "string", cat: "o", description: "Host for the server." }); - options.push({ id: "auth", type: "string", cat: "o", description: `The type of authentication to use. ${buildAllowedMessage(AuthType)}.` }); - options.push({ id: "open", type: "boolean", cat: "o", description: "Open in the browser on startup." }); - options.push({ id: "port", type: "string", cat: "o", description: "Port for the main server." }); - options.push({ id: "socket", type: "string", cat: "o", description: "Listen on a socket instead of host:port." }); - - options.push(last); - - const args = parseMainProcessArgv(process.argv); - if (!args["user-data-dir"]) { - args["user-data-dir"] = path.join(process.env.XDG_DATA_HOME || path.join(os.homedir(), ".local/share"), "code-server"); - } - if (!args["extensions-dir"]) { - args["extensions-dir"] = path.join(args["user-data-dir"], "extensions"); - } - - return validatePaths(args); -}; - -const startVscode = async (): Promise => { - const args = getArgs(); - const extra = args["_"] || []; - const options = { - auth: args.auth, - basePath: args["base-path"], - cert: args.cert, - certKey: args["cert-key"], - folderUri: extra.length > 1 ? extra[extra.length - 1] : undefined, - host: args.host, - password: process.env.PASSWORD, - }; - - if (options.auth && enumToArray(AuthType).filter((t) => t === options.auth).length === 0) { - throw new Error(`'${options.auth}' is not a valid authentication type.`); - } else if (options.auth && !options.password) { - options.password = await generatePassword(); - } - - if (!options.certKey && typeof options.certKey !== "undefined") { - throw new Error(`--cert-key cannot be blank`); - } else if (options.certKey && !options.cert) { - throw new Error(`--cert-key was provided but --cert was not`); - } if (!options.cert && typeof options.cert !== "undefined") { - const { cert, certKey } = await generateCertificate(); - options.cert = cert; - options.certKey = certKey; - } - - enableCustomMarketplace(); - - const server = new MainServer({ - ...options, - port: typeof args.port !== "undefined" ? parseInt(args.port, 10) : 8080, - socket: args.socket, - }, args); - - const [serverAddress, /* ignore */] = await Promise.all([ - server.listen(), - unpackExecutables(), - ]); - logger.info(`Server listening on ${serverAddress}`); - - if (options.auth && !process.env.PASSWORD) { - logger.info(` - Password is ${options.password}`); - logger.info(" - To use your own password, set the PASSWORD environment variable"); - } else if (options.auth) { - logger.info(" - Using custom password for authentication"); - } else { - logger.info(" - No authentication"); - } - - if (server.protocol === "https") { - logger.info( - args.cert - ? ` - Using provided certificate${args["cert-key"] ? " and key" : ""} for HTTPS` - : ` - Using generated certificate and key for HTTPS`, - ); - } else { - logger.info(" - Not serving HTTPS"); - } - - if (!server.options.socket && args.open) { - // The web socket doesn't seem to work if browsing with 0.0.0.0. - const openAddress = serverAddress.replace(/:\/\/0.0.0.0/, "://localhost"); - await open(openAddress).catch(console.error); - logger.info(` - Opened ${openAddress}`); - } -}; - -const startCli = (): boolean | Promise => { - const args = getArgs(); - if (args.help) { - const executable = `${product.applicationName}${os.platform() === "win32" ? ".exe" : ""}`; - console.log(buildHelpMessage(product.nameLong, executable, pkg.codeServerVersion, undefined, false)); - return true; - } - - if (args.version) { - if (args.format === "json") { - console.log(JSON.stringify({ - codeServerVersion: pkg.codeServerVersion, - commit: product.commit, - vscodeVersion: pkg.version, - })); - } else { - buildVersionMessage(pkg.codeServerVersion, product.commit).split("\n").map((line) => logger.info(line)); - } - return true; - } - - const shouldSpawnCliProcess = (): boolean => { - return !!args["install-source"] - || !!args["list-extensions"] - || !!args["install-extension"] - || !!args["uninstall-extension"] - || !!args["locate-extension"] - || !!args["telemetry"]; - }; - - if (shouldSpawnCliProcess()) { - enableCustomMarketplace(); - return vsCli(args); - } - - return false; -}; - -export class WrapperProcess { - private process?: cp.ChildProcess; - private started?: Promise; - - public constructor() { - ipcMain.onMessage(async (message) => { - switch (message) { - case "relaunch": - logger.info("Relaunching..."); - this.started = undefined; - if (this.process) { - this.process.kill(); - } - try { - await this.start(); - } catch (error) { - logger.error(error.message); - process.exit(typeof error.code === "number" ? error.code : 1); - } - break; - default: - logger.error(`Unrecognized message ${message}`); - break; - } - }); - } - - public start(): Promise { - if (!this.started) { - const child = this.spawn(); - this.started = ipcMain.handshake(child); - this.process = child; - } - return this.started; - } - - private spawn(): cp.ChildProcess { - return cp.spawn(process.argv[0], process.argv.slice(1), { - env: { - ...process.env, - LAUNCH_VSCODE: "true", - }, - stdio: ["inherit", "inherit", "inherit", "ipc"], - }); - } +/** + * Determine if it looks like the user is trying to open a file or folder in an + * existing instance. The arguments here should be the arguments the user + * explicitly passed on the command line, *NOT DEFAULTS* or the configuration. + */ +export const shouldOpenInExistingInstance = async ( + args: UserProvidedArgs, + sessionSocket: string, +): Promise => { + // Always use the existing instance if we're running from VS Code's terminal. + if (process.env.VSCODE_IPC_HOOK_CLI) { + logger.debug("Found VSCODE_IPC_HOOK_CLI") + return process.env.VSCODE_IPC_HOOK_CLI + } + + const paths = getResolvedPathsFromArgs(args) + const client = new EditorSessionManagerClient(sessionSocket) + + // If these flags are set then assume the user is trying to open in an + // existing instance since these flags have no effect otherwise. That means + // if there is no existing instance we should error rather than falling back + // to spawning code-server normally. + const openInFlagCount = ["reuse-window", "new-window"].reduce((prev, cur) => { + return args[cur as keyof UserProvidedArgs] ? prev + 1 : prev + }, 0) + if (openInFlagCount > 0) { + logger.debug("Found --reuse-window or --new-window") + const socketPath = await client.getConnectedSocketPath(paths[0]) + if (!socketPath) { + throw new Error(`No opened code-server instances found to handle ${paths[0]}`) + } + return socketPath + } + + // It's possible the user is trying to spawn another instance of code-server. + // 1. Check if any unrelated flags are set (this should only run when + // code-server is invoked exactly like this: `code-server my-file`). + // 2. That a file or directory was passed. + // 3. That the socket is active. + // 4. That an instance exists to handle the path (implied by #3). + if (Object.keys(args).length === 1 && typeof args._ !== "undefined" && args._.length > 0) { + if (!(await client.canConnect())) { + return undefined + } + const socketPath = await client.getConnectedSocketPath(paths[0]) + if (socketPath) { + logger.debug("Found existing code-server socket") + return socketPath + } + } + + return undefined } -const main = async(): Promise => { - if (process.env.LAUNCH_VSCODE) { - await ipcMain.handshake(); - return startVscode(); - } - return startCli() || new WrapperProcess().start(); -}; - -// It's possible that the pipe has closed (for example if you run code-server -// --version | head -1). Assume that means we're done. -if (!process.stdout.isTTY) { - process.stdout.on("error", () => process.exit()); +/** + * Arguments for running Code's server. + * + * A subset of ../../lib/vscode/src/vs/server/node/serverEnvironmentService.ts:90 + */ +export interface CodeArgs extends UserProvidedCodeArgs { + "accept-server-license-terms"?: boolean + "connection-token"?: string + help: boolean + port?: string + version: boolean + "without-connection-token"?: boolean + "without-browser-env-var"?: boolean + compatibility?: string + log?: string[] } -main().catch((error) => { - logger.error(error.message); - process.exit(typeof error.code === "number" ? error.code : 1); -}); +/** + * Expand --vscode-option entries into VS Code server arguments. + * + * An entry is `flag=value`, or a bare `flag` meaning true. A leading `--` on + * the flag is optional, so both spellings people reach for work. Repeating a + * flag collects the values into an array, since several VS Code options take + * one. + * + * `true` and `false` become booleans rather than strings. VS Code tests these + * flags for truthiness and the string "false" is truthy, so passing it along + * verbatim would quietly do the opposite of what was asked. + */ +export const parseVscodeOptions = (entries: string[]): Record => { + const parsed: Record = {} + + for (const entry of entries) { + const [flag, rawValue] = splitOnFirstEquals(entry.replace(/^--/, "")) + if (!flag) { + throw new Error(`--vscode-option requires a flag name (got "${entry}")`) + } + + const value: string | boolean = + typeof rawValue === "undefined" || rawValue === "true" ? true : rawValue === "false" ? false : rawValue + + const existing = parsed[flag] + if (typeof existing === "undefined") { + parsed[flag] = value + } else if (Array.isArray(existing)) { + existing.push(String(value)) + } else { + parsed[flag] = [String(existing), String(value)] + } + } + + return parsed +} + +/** + * Convert our arguments to equivalent VS Code server arguments. + * Does not add any extra arguments. + */ +export const toCodeArgs = async (args: DefaultedArgs): Promise => { + // The passthrough option is ours; VS Code has no idea what it is. + const { "vscode-option": vscodeOptions, ...rest } = args + return { + ...rest, + /** Type casting. */ + help: !!args.help, + version: !!args.version, + port: args.port?.toString(), + log: args.log ? [args.log] : undefined, + // Last, so that reaching an option code-server does model still works. + ...parseVscodeOptions(vscodeOptions ?? []), + } as CodeArgs +} diff --git a/src/node/connection.ts b/src/node/connection.ts deleted file mode 100644 index 98bebd33f9f9..000000000000 --- a/src/node/connection.ts +++ /dev/null @@ -1,156 +0,0 @@ -import * as cp from "child_process"; -import { getPathFromAmdModule } from "vs/base/common/amd"; -import { VSBuffer } from "vs/base/common/buffer"; -import { Emitter } from "vs/base/common/event"; -import { ISocket } from "vs/base/parts/ipc/common/ipc.net"; -import { NodeSocket } from "vs/base/parts/ipc/node/ipc.net"; -import { IEnvironmentService } from "vs/platform/environment/common/environment"; -import { ILogService } from "vs/platform/log/common/log"; -import { getNlsConfiguration } from "vs/server/src/node/nls"; -import { Protocol } from "vs/server/src/node/protocol"; -import { uriTransformerPath } from "vs/server/src/node/util"; -import { IExtHostReadyMessage } from "vs/workbench/services/extensions/common/extensionHostProtocol"; - -export abstract class Connection { - private readonly _onClose = new Emitter(); - public readonly onClose = this._onClose.event; - private disposed = false; - private _offline: number | undefined; - - public constructor(protected protocol: Protocol, public readonly token: string) {} - - public get offline(): number | undefined { - return this._offline; - } - - public reconnect(socket: ISocket, buffer: VSBuffer): void { - this._offline = undefined; - this.doReconnect(socket, buffer); - } - - public dispose(): void { - if (!this.disposed) { - this.disposed = true; - this.doDispose(); - this._onClose.fire(); - } - } - - protected setOffline(): void { - if (!this._offline) { - this._offline = Date.now(); - } - } - - /** - * Set up the connection on a new socket. - */ - protected abstract doReconnect(socket: ISocket, buffer: VSBuffer): void; - protected abstract doDispose(): void; -} - -/** - * Used for all the IPC channels. - */ -export class ManagementConnection extends Connection { - public constructor(protected protocol: Protocol, token: string) { - super(protocol, token); - protocol.onClose(() => this.dispose()); // Explicit close. - protocol.onSocketClose(() => this.setOffline()); // Might reconnect. - } - - protected doDispose(): void { - this.protocol.sendDisconnect(); - this.protocol.dispose(); - this.protocol.getSocket().end(); - } - - protected doReconnect(socket: ISocket, buffer: VSBuffer): void { - this.protocol.beginAcceptReconnection(socket, buffer); - this.protocol.endAcceptReconnection(); - } -} - -export class ExtensionHostConnection extends Connection { - private process?: cp.ChildProcess; - - public constructor( - locale:string, protocol: Protocol, buffer: VSBuffer, token: string, - private readonly log: ILogService, - private readonly environment: IEnvironmentService, - ) { - super(protocol, token); - this.protocol.dispose(); - this.spawn(locale, buffer).then((p) => this.process = p); - this.protocol.getUnderlyingSocket().pause(); - } - - protected doDispose(): void { - if (this.process) { - this.process.kill(); - } - this.protocol.getSocket().end(); - } - - protected doReconnect(socket: ISocket, buffer: VSBuffer): void { - // This is just to set the new socket. - this.protocol.beginAcceptReconnection(socket, null); - this.protocol.dispose(); - this.sendInitMessage(buffer); - } - - private sendInitMessage(buffer: VSBuffer): void { - const socket = this.protocol.getUnderlyingSocket(); - socket.pause(); - this.process!.send({ // Process must be set at this point. - type: "VSCODE_EXTHOST_IPC_SOCKET", - initialDataChunk: (buffer.buffer as Buffer).toString("base64"), - skipWebSocketFrames: this.protocol.getSocket() instanceof NodeSocket, - }, socket); - } - - private async spawn(locale: string, buffer: VSBuffer): Promise { - const config = await getNlsConfiguration(locale, this.environment.userDataPath); - const proc = cp.fork( - getPathFromAmdModule(require, "bootstrap-fork"), - [ "--type=extensionHost", `--uriTransformerPath=${uriTransformerPath}` ], - { - env: { - ...process.env, - AMD_ENTRYPOINT: "vs/workbench/services/extensions/node/extensionHostProcess", - PIPE_LOGGING: "true", - VERBOSE_LOGGING: "true", - VSCODE_EXTHOST_WILL_SEND_SOCKET: "true", - VSCODE_HANDLES_UNCAUGHT_ERRORS: "true", - VSCODE_LOG_STACK: "false", - VSCODE_LOG_LEVEL: this.environment.verbose ? "trace" : this.environment.log, - VSCODE_NLS_CONFIG: JSON.stringify(config), - }, - silent: true, - }, - ); - - proc.on("error", () => this.dispose()); - proc.on("exit", () => this.dispose()); - proc.stdout.setEncoding("utf8").on("data", (d) => this.log.info("Extension host stdout", d)); - proc.stderr.setEncoding("utf8").on("data", (d) => this.log.error("Extension host stderr", d)); - proc.on("message", (event) => { - if (event && event.type === "__$console") { - const severity = (this.log)[event.severity] ? event.severity : "info"; - (this.log)[severity]("Extension host", event.arguments); - } - if (event && event.type === "VSCODE_EXTHOST_DISCONNECTED") { - this.setOffline(); - } - }); - - const listen = (message: IExtHostReadyMessage) => { - if (message.type === "VSCODE_EXTHOST_IPC_READY") { - proc.removeListener("message", listen); - this.sendInitMessage(buffer); - } - }; - - return proc.on("message", listen); - } -} diff --git a/src/node/constants.ts b/src/node/constants.ts new file mode 100644 index 000000000000..06281c6889cf --- /dev/null +++ b/src/node/constants.ts @@ -0,0 +1,52 @@ +import { logger } from "@coder/logger" +import * as os from "os" +import * as path from "path" + +type PackageJson = { + version: string + commit: string +} + +export function getPackageJson(relativePath: string): PackageJson { + let pkg = {} + try { + pkg = require(relativePath) + } catch (error: any) { + logger.warn(error.message) + } + + return pkg as PackageJson +} + +export const rootPath = path.resolve(__dirname, "../..") +export const vsRootPath = path.join(rootPath, "lib/vscode") +const PACKAGE_JSON = "package.json" +const pkg = getPackageJson(`${rootPath}/${PACKAGE_JSON}`) +const codePkg = getPackageJson(`${vsRootPath}/${PACKAGE_JSON}`) || { version: "0.0.0" } +export const version = pkg.version || "development" +export const commit = pkg.commit || "development" +export const codeVersion = codePkg.version || "development" +export const tmpdir = path.join(os.tmpdir(), "code-server") +export const isDevMode = commit === "development" +export const httpProxyUri = + process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy + +/** + * getVersionString returns a human-readable version string suitable + * for outputting to the console. + */ +export function getVersionString(): string { + return [version, commit, "with Code", codeVersion].join(" ") +} + +/** + * getVersionJsonString returns a machine-readable version string + * suitable for outputting to the console. + */ +export function getVersionJsonString(): string { + return JSON.stringify({ + codeServer: version, + commit, + vscode: codeVersion, + }) +} diff --git a/src/node/entry.ts b/src/node/entry.ts new file mode 100644 index 000000000000..749b6e966cbc --- /dev/null +++ b/src/node/entry.ts @@ -0,0 +1,66 @@ +import { logger } from "@coder/logger" +import { optionDescriptions, parse, readConfigFile, setDefaults, shouldOpenInExistingInstance } from "./cli" +import { getVersionString, getVersionJsonString } from "./constants" +import { openInExistingInstance, runCodeServer, runCodeCli, shouldSpawnCliProcess } from "./main" +import { isChild, wrapper } from "./wrapper" + +async function entry(): Promise { + // There's no need to check flags like --help or to spawn in an existing + // instance for the child process because these would have already happened in + // the parent and the child wouldn't have been spawned. We also get the + // arguments from the parent so we don't have to parse twice and to account + // for environment manipulation (like how PASSWORD gets removed to avoid + // leaking to child processes). + if (isChild(wrapper)) { + const args = await wrapper.handshake() + wrapper.preventExit() + const server = await runCodeServer(args) + wrapper.onDispose(() => server.dispose()) + return + } + + const cliArgs = parse(process.argv.slice(2)) + const configArgs = await readConfigFile(cliArgs.config) + const args = await setDefaults(cliArgs, configArgs) + + if (args.help) { + console.log("code-server", getVersionString()) + console.log("") + console.log(`Usage: code-server [options] [path]`) + console.log(` - Opening a directory: code-server ./path/to/your/project`) + console.log(` - Opening a saved workspace: code-server ./path/to/your/project.code-workspace`) + console.log("") + console.log("Options") + optionDescriptions().forEach((description) => { + console.log("", description) + }) + return + } + + if (args.version) { + if (args.json) { + console.log(getVersionJsonString()) + } else { + console.log(getVersionString()) + } + return + } + + if (shouldSpawnCliProcess(args)) { + logger.debug("Found VS Code arguments; spawning VS Code CLI") + return runCodeCli(args) + } + + const socketPath = await shouldOpenInExistingInstance(cliArgs, args["session-socket"]) + if (socketPath) { + logger.debug("Trying to open in existing instance") + return openInExistingInstance(args, socketPath) + } + + return wrapper.start(args) +} + +entry().catch((error) => { + logger.error(error.message) + wrapper.exit(error) +}) diff --git a/src/node/heart.ts b/src/node/heart.ts new file mode 100644 index 000000000000..b78f4edb80d2 --- /dev/null +++ b/src/node/heart.ts @@ -0,0 +1,82 @@ +import { logger } from "@coder/logger" +import { promises as fs } from "fs" +import { Emitter } from "../common/emitter" + +/** + * Provides a heartbeat using a local file to indicate activity. + */ +export class Heart { + private heartbeatTimer?: NodeJS.Timeout + private heartbeatInterval = 60000 + public lastHeartbeat = 0 + private readonly _onChange = new Emitter<"alive" | "expired" | "unknown">() + readonly onChange = this._onChange.event + private state: "alive" | "expired" | "unknown" = "expired" + + public constructor( + private readonly heartbeatPath: string, + private readonly isActive: () => Promise, + ) { + this.beat = this.beat.bind(this) + this.alive = this.alive.bind(this) + } + + private setState(state: typeof this.state) { + if (this.state !== state) { + this.state = state + this._onChange.emit(this.state) + } + } + + public alive(): boolean { + const now = Date.now() + return now - this.lastHeartbeat < this.heartbeatInterval + } + /** + * Write to the heartbeat file if we haven't already done so within the + * timeout and start or reset a timer that keeps running as long as there is + * activity. Failures are logged as warnings. + */ + public async beat(): Promise { + if (this.alive()) { + this.setState("alive") + return + } + + logger.debug("heartbeat") + this.lastHeartbeat = Date.now() + if (typeof this.heartbeatTimer !== "undefined") { + clearTimeout(this.heartbeatTimer) + } + + this.heartbeatTimer = setTimeout(async () => { + try { + if (await this.isActive()) { + this.beat() + } else { + this.setState("expired") + } + } catch (error: unknown) { + logger.warn((error as Error).message) + this.setState("unknown") + } + }, this.heartbeatInterval) + + this.setState("alive") + + try { + return await fs.writeFile(this.heartbeatPath, "") + } catch (error: any) { + logger.warn(error.message) + } + } + + /** + * Call to clear any heartbeatTimer for shutdown. + */ + public dispose(): void { + if (typeof this.heartbeatTimer !== "undefined") { + clearTimeout(this.heartbeatTimer) + } + } +} diff --git a/src/node/http.ts b/src/node/http.ts new file mode 100644 index 000000000000..1429b09a15ef --- /dev/null +++ b/src/node/http.ts @@ -0,0 +1,439 @@ +import { field, logger } from "@coder/logger" +import * as express from "express" +import * as http from "http" +import * as net from "net" +import qs from "qs" +import { Disposable } from "../common/emitter" +import { HttpCode, HttpError } from "../common/http" +import { normalize } from "../common/util" +import { AuthType, DefaultedArgs } from "./cli" +import { version as codeServerVersion } from "./constants" +import { Heart } from "./heart" +import { CoderSettings, SettingsProvider } from "./settings" +import { UpdateProvider } from "./update" +import { + getPasswordMethod, + IsCookieValidArgs, + isCookieValid, + sanitizeString, + escapeHtml, + escapeJSON, + splitOnFirstEquals, +} from "./util" + +/** + * Base options included on every page. + */ +export interface ClientConfiguration { + codeServerVersion: string + /** Relative path from this page to the root. No trailing slash. */ + base: string + /** Relative path from this page to the static root. No trailing slash. */ + csStaticBase: string +} + +declare global { + // eslint-disable-next-line @typescript-eslint/no-namespace + namespace Express { + export interface Request { + args: DefaultedArgs + heart: Heart + settings: SettingsProvider + updater: UpdateProvider + cookieSessionName: string + } + } +} + +export const createClientConfiguration = (req: express.Request): ClientConfiguration => { + const base = relativeRoot(req.originalUrl) + + return { + base, + csStaticBase: base + "/_static", + codeServerVersion, + } +} + +/** + * Replace common variable strings in HTML templates. + */ +export const replaceTemplates = ( + req: express.Request, + content: string, + extraOpts?: Omit, +): string => { + const serverOptions: ClientConfiguration = { + ...createClientConfiguration(req), + ...extraOpts, + } + + return content + .replace(/{{TO}}/g, (typeof req.query.to === "string" && escapeHtml(req.query.to)) || "/") + .replace(/{{BASE}}/g, serverOptions.base) + .replace(/{{CS_STATIC_BASE}}/g, serverOptions.csStaticBase) + .replace("{{OPTIONS}}", () => escapeJSON(serverOptions)) +} + +/** + * Throw an error if proxy is not enabled. Call `next` if provided. + */ +export const ensureProxyEnabled = (req: express.Request, _?: express.Response, next?: express.NextFunction): void => { + if (!proxyEnabled(req)) { + throw new HttpError("Forbidden", HttpCode.Forbidden) + } + if (next) { + next() + } +} + +/** + * Return true if proxy is enabled. + */ +export const proxyEnabled = (req: express.Request): boolean => { + return !req.args["disable-proxy"] +} + +/** + * Throw an error if not authorized. Call `next` if provided. + */ +export const ensureAuthenticated = async ( + req: express.Request, + _?: express.Response, + next?: express.NextFunction, +): Promise => { + const isAuthenticated = await authenticated(req) + if (!isAuthenticated) { + throw new HttpError("Unauthorized", HttpCode.Unauthorized) + } + if (next) { + next() + } +} + +/** + * Return true if authenticated via cookies. + */ +export const authenticated = async (req: express.Request): Promise => { + switch (req.args.auth) { + case AuthType.None: { + return true + } + case AuthType.Password: { + // The password is stored in the cookie after being hashed. + const hashedPasswordFromArgs = req.args["hashed-password"] + const passwordMethod = getPasswordMethod(hashedPasswordFromArgs) + const isCookieValidArgs: IsCookieValidArgs = { + passwordMethod, + cookieKey: sanitizeString(req.cookies[req.cookieSessionName]), + passwordFromArgs: req.args.password || "", + hashedPasswordFromArgs: req.args["hashed-password"], + } + + return await isCookieValid(isCookieValidArgs) + } + default: { + throw new Error(`Unsupported auth type ${req.args.auth}`) + } + } +} + +/** + * Get the relative path that will get us to the root of the page. For each + * slash we need to go up a directory. Will not have a trailing slash. + * + * For example: + * + * / => . + * /foo => . + * /foo/ => ./.. + * /foo/bar => ./.. + * /foo/bar/ => ./../.. + * + * All paths must be relative in order to work behind a reverse proxy since we + * we do not know the base path. Anything that needs to be absolute (for + * example cookies) must get the base path from the frontend. + * + * All relative paths must be prefixed with the relative root to ensure they + * work no matter the depth at which they happen to appear. + * + * For Express `req.originalUrl` should be used as they remove the base from the + * standard `url` property making it impossible to get the true depth. + */ +export const relativeRoot = (originalUrl: string): string => { + const depth = (originalUrl.split("?", 1)[0].match(/\//g) || []).length + return normalize("./" + (depth > 1 ? "../".repeat(depth - 1) : "")) +} + +/** + * A helper function to construct a redirect path based on + * an Express Request, query and a path to redirect to. + * + * Redirect path is relative to `/${to}`. + */ +export const constructRedirectPath = (req: express.Request, query: qs.ParsedQs, to: string): string => { + const relativePath = normalize(`${relativeRoot(req.originalUrl)}/${to}`, true) + // %2f or %2F are both equalivent to an encoded slash / + const queryString = qs.stringify(query).replace(/%2[fF]/g, "/") + const redirectPath = `${relativePath}${queryString ? `?${queryString}` : ""}` + + return redirectPath +} + +/** + * Redirect relatively to `/${to}`. Query variables on the current URI will be + * preserved. `to` should be a simple path without any query parameters + * `override` will merge with the existing query (use `undefined` to unset). + */ +export const redirect = (req: express.Request, res: express.Response, to: string, override: qs.ParsedQs = {}): void => { + const query = Object.assign({}, req.query, override) + Object.keys(override).forEach((key) => { + if (typeof override[key] === "undefined") { + delete query[key] + } + }) + + const redirectPath = constructRedirectPath(req, query, to) + logger.debug(`redirecting from ${req.originalUrl} to ${redirectPath}`) + res.redirect(redirectPath) +} + +/** + * Get the value that should be used for setting a cookie domain. This will + * allow the user to authenticate once no matter what sub-domain they use to log + * in. This will use the highest level proxy domain (e.g. `coder.com` over + * `test.coder.com` if both are specified). + */ +export const getCookieDomain = (host: string, proxyDomains: string[]): string | undefined => { + const idx = host.lastIndexOf(":") + host = idx !== -1 ? host.substring(0, idx) : host + // If any of these are true we will still set cookies but without an explicit + // `Domain` attribute on the cookie. + if ( + // The host can be be blank or missing so there's nothing we can set. + !host || + // IP addresses can't have subdomains so there's no value in setting the + // domain for them. Assume that anything with a : is ipv6 (valid domain name + // characters are alphanumeric or dashes)... + host.includes(":") || + // ...and that anything entirely numbers and dots is ipv4 (currently tlds + // cannot be entirely numbers). + !/[^0-9.]/.test(host) || + // localhost subdomains don't seem to work at all (browser bug?). A cookie + // set at dev.localhost cannot be read by 8080.dev.localhost. + host.endsWith(".localhost") || + // Domains without at least one dot (technically two since domain.tld will + // become .domain.tld) are considered invalid according to the spec so don't + // set the domain for them. In my testing though localhost is the only + // problem (the browser just doesn't store the cookie at all). localhost has + // an additional problem which is that a reverse proxy might give + // code-server localhost even though the domain is really domain.tld (by + // default NGINX does this). + !host.includes(".") + ) { + logger.debug("no valid cookie domain", field("host", host)) + return undefined + } + + proxyDomains.forEach((domain) => { + if (host.endsWith(domain) && domain.length < host.length) { + host = domain + } + }) + + logger.debug("got cookie domain", field("host", host)) + return host || undefined +} + +/** + * Return a function capable of fully disposing an HTTP server. + */ +export function disposer(server: http.Server): Disposable["dispose"] { + const sockets = new Set() + let cleanupTimeout: undefined | NodeJS.Timeout + + server.on("connection", (socket) => { + sockets.add(socket) + + socket.on("close", () => { + sockets.delete(socket) + + if (cleanupTimeout && sockets.size === 0) { + clearTimeout(cleanupTimeout) + cleanupTimeout = undefined + } + }) + }) + + return () => { + return new Promise((resolve, reject) => { + // The whole reason we need this disposer is because close will not + // actually close anything; it only prevents future connections then waits + // until everything is closed. + server.close((err) => { + if (err) { + return reject(err) + } + + resolve() + }) + + // If there are sockets remaining we might need to force close them or + // this promise might never resolve. + if (sockets.size > 0) { + // Give sockets a chance to close up shop. + cleanupTimeout = setTimeout(() => { + cleanupTimeout = undefined + + for (const socket of sockets.values()) { + console.warn("a socket was left hanging") + socket.destroy() + } + }, 1000) + } + }) + } +} + +/** + * Get the options for setting a cookie. The options must be identical for + * setting and unsetting cookies otherwise they are considered separate. + */ +export const getCookieOptions = (req: express.Request): express.CookieOptions => { + // Normally we set paths relatively. However browsers do not appear to allow + // cookies to be set relatively which means we need an absolute path. We + // cannot be guaranteed we know the path since a reverse proxy might have + // rewritten it. That means we need to get the path from the frontend. + + // The reason we need to set the path (as opposed to defaulting to /) is to + // avoid code-server instances on different sub-paths clobbering each other or + // from accessing each other's tokens (and to prevent other services from + // accessing code-server's tokens). + + // When logging in or out the request must include the href (the full current + // URL of that page) and the relative path to the root as given to it by the + // backend. Using these two we can determine the true absolute root. + const url = new URL( + req.query.base || req.body?.base || "/", + req.query.href || req.body?.href || "http://" + (req.headers.host || "localhost"), + ) + return { + domain: getCookieDomain(url.host, req.args["proxy-domain"]), + path: normalize(url.pathname) || "/", + sameSite: "lax", + } +} + +/** + * Return the full path to the current page, preserving any trailing slash. + */ +export const self = (req: express.Request): string => { + return normalize(`${req.baseUrl}${req.originalUrl.endsWith("/") ? "/" : ""}`, true) +} + +function getFirstHeader(req: http.IncomingMessage, headerName: string): string | undefined { + const val = req.headers[headerName] + return Array.isArray(val) ? val[0] : val +} + +/** + * Throw a forbidden error if origin checks fail. Call `next` if provided. + */ +export function ensureOrigin(req: express.Request, _?: express.Response, next?: express.NextFunction): void { + try { + authenticateOrigin(req) + if (next) { + next() + } + } catch (error) { + logger.debug(`${error instanceof Error ? error.message : error}; blocking request to ${req.originalUrl}`) + throw new HttpError("Forbidden", HttpCode.Forbidden) + } +} + +/** + * Return true if the origin matches any trusted origin. Entries are matched + * as exact strings, the special wildcard `"*"`, or `*.example.com`-style + * domain wildcards (same as --proxy-domain). + */ +export function isTrustedOrigin(origin: string, trustedOrigins: string[]): boolean { + return trustedOrigins.some((trusted) => { + if (trusted === "*" || trusted === origin) { + return true + } + // *.example.com style: match origin if it is the domain or a subdomain + if (trusted.startsWith("*.")) { + const domain = trusted.slice(2).toLowerCase() + return origin === domain || origin.endsWith("." + domain) + } + return false + }) +} + +/** + * Authenticate the request origin against the host. Throw if invalid. + */ +export function authenticateOrigin(req: express.Request): void { + // A missing origin probably means the source is non-browser. Not sure we + // have a use case for this but let it through. + const originRaw = getFirstHeader(req, "origin") + if (!originRaw) { + return + } + + let origin: string + try { + origin = new URL(originRaw).host.trim().toLowerCase() + } catch (error) { + throw new Error(`unable to parse malformed origin "${originRaw}"`) + } + + const trustedOrigins = req.args["trusted-origins"] || [] + if (isTrustedOrigin(origin, trustedOrigins)) { + return + } + + const host = getHost(req) + if (typeof host === "undefined") { + // A missing host likely means the reverse proxy has not been configured to + // forward the host which means we cannot perform the check. Emit an error + // so an admin can fix the issue. + logger.error("No host headers found") + logger.error("Are you behind a reverse proxy that does not forward the host?") + throw new Error("no host headers found") + } + + if (host !== origin) { + throw new Error(`host "${host}" does not match origin "${origin}"`) + } +} + +/** + * Get the host from headers. It will be trimmed and lowercased. + */ +export function getHost(req: express.Request): string | undefined { + // Honor Forwarded if present. + const forwardedRaw = getFirstHeader(req, "forwarded") + if (forwardedRaw) { + const parts = forwardedRaw.split(/[;,]/) + for (let i = 0; i < parts.length; ++i) { + const [key, value] = splitOnFirstEquals(parts[i]) + if (key.trim().toLowerCase() === "host" && value) { + return value.trim().toLowerCase() + } + } + } + + // Honor X-Forwarded-Host if present. Some reverse proxies will set multiple + // comma-separated hosts. + const xHost = getFirstHeader(req, "x-forwarded-host") + if (xHost) { + const firstXHost = xHost.split(",")[0] + if (firstXHost) { + return firstXHost.trim().toLowerCase() + } + } + + const host = getFirstHeader(req, "host") + return host ? host.trim().toLowerCase() : undefined +} diff --git a/src/node/i18n/index.ts b/src/node/i18n/index.ts new file mode 100644 index 000000000000..491f2291b07e --- /dev/null +++ b/src/node/i18n/index.ts @@ -0,0 +1,63 @@ +import { promises as fs } from "fs" +import i18next, { init } from "i18next" +import * as en from "./locales/en.json" +import * as ja from "./locales/ja.json" +import * as th from "./locales/th.json" +import * as tr from "./locales/tr.json" +import * as ur from "./locales/ur.json" +import * as zhCn from "./locales/zh-cn.json" + +const defaultResources = { + en: { + translation: en, + }, + "zh-cn": { + translation: zhCn, + }, + th: { + translation: th, + }, + tr: { + translation: tr, + }, + ja: { + translation: ja, + }, + ur: { + translation: ur, + }, +} + +export async function loadCustomStrings(filePath: string): Promise { + try { + // Read custom strings from file path only + const fileContent = await fs.readFile(filePath, "utf8") + const customStringsData = JSON.parse(fileContent) + + // User-provided strings override all languages. + Object.keys(defaultResources).forEach((locale) => { + i18next.addResourceBundle(locale, "translation", customStringsData) + }) + } catch (error) { + if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") { + throw new Error(`Custom strings file not found: ${filePath}\nPlease ensure the file exists and is readable.`) + } else if (error instanceof SyntaxError) { + throw new Error(`Invalid JSON in custom strings file: ${filePath}\n${error.message}`) + } else { + throw new Error( + `Failed to load custom strings from ${filePath}: ${error instanceof Error ? error.message : String(error)}`, + ) + } + } +} + +init({ + lng: "en", + fallbackLng: "en", // language to use if translations in user language are not available. + returnNull: false, + lowerCaseLng: true, + debug: process.env.NODE_ENV === "development", + resources: defaultResources, +}) + +export default i18next diff --git a/src/node/i18n/locales/en.json b/src/node/i18n/locales/en.json new file mode 100644 index 000000000000..150bacc7b817 --- /dev/null +++ b/src/node/i18n/locales/en.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "{{app}} login", + "LOGIN_BELOW": "Please log in below.", + "WELCOME": "Welcome to {{app}}", + "LOGIN_PASSWORD": "Check the config file for the password.", + "LOGIN_USING_ENV_PASSWORD": "Password was set from $PASSWORD.", + "LOGIN_USING_HASHED_PASSWORD": "Password was set from $HASHED_PASSWORD.", + "SUBMIT": "SUBMIT", + "PASSWORD_PLACEHOLDER": "PASSWORD", + "LOGIN_RATE_LIMIT": "Login rate limited!", + "MISS_PASSWORD": "Missing password", + "INCORRECT_PASSWORD": "Incorrect password" +} diff --git a/src/node/i18n/locales/ja.json b/src/node/i18n/locales/ja.json new file mode 100644 index 000000000000..5abba920c09f --- /dev/null +++ b/src/node/i18n/locales/ja.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "{{app}} ログイン", + "LOGIN_BELOW": "以下によりログインしてください。", + "WELCOME": "ようこそ {{app}} へ！", + "LOGIN_PASSWORD": "パスワードは設定ファイルを確認してください。", + "LOGIN_USING_ENV_PASSWORD": "パスワードは環境変数 $PASSWORD で設定されています。", + "LOGIN_USING_HASHED_PASSWORD": "パスワードは環境変数 $HASHED_PASSWORD で設定されています。", + "SUBMIT": "実行", + "PASSWORD_PLACEHOLDER": "パスワード", + "LOGIN_RATE_LIMIT": "ログイン制限を超えました！", + "MISS_PASSWORD": "パスワードを入力してください。", + "INCORRECT_PASSWORD": "パスワードが間違っています。" +} diff --git a/src/node/i18n/locales/th.json b/src/node/i18n/locales/th.json new file mode 100644 index 000000000000..f6840c773bdb --- /dev/null +++ b/src/node/i18n/locales/th.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "เข้าสู่ระบบ {{app}}", + "LOGIN_BELOW": "กรุณาเข้าสู่ระบบด้านล่าง", + "WELCOME": "ยินดีต้อนรับสู่ {{app}}", + "LOGIN_PASSWORD": "ตรวจสอบไฟล์กำหนดค่าเพื่อดูรหัสผ่าน", + "LOGIN_USING_ENV_PASSWORD": "รหัสผ่านถูกกำหนดเป็น $PASSWORD", + "LOGIN_USING_HASHED_PASSWORD": "รรหัสผ่านถูกกำหนดเป็น $HASHED_PASSWORD", + "SUBMIT": "ส่ง", + "PASSWORD_PLACEHOLDER": "รหัสผ่าน", + "LOGIN_RATE_LIMIT": "ถึงขีดจำกัดอัตราการเข้าสู่ระบบ!", + "MISS_PASSWORD": "รหัสผ่านหายไป", + "INCORRECT_PASSWORD": "รหัสผ่านไม่ถูกต้อง" +} diff --git a/src/node/i18n/locales/tr.json b/src/node/i18n/locales/tr.json new file mode 100644 index 000000000000..3016a7ec4e0c --- /dev/null +++ b/src/node/i18n/locales/tr.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "{{app}} girişi", + "LOGIN_BELOW": "Lütfen aşağıdan giriş yapın.", + "WELCOME": "{{app}} uygulamasına hoş geldiniz", + "LOGIN_PASSWORD": "Parola için yapılandırma dosyasını kontrol edin.", + "LOGIN_USING_ENV_PASSWORD": "Parola $PASSWORD ortam değişkeninden ayarlandı.", + "LOGIN_USING_HASHED_PASSWORD": "Parola $HASHED_PASSWORD ortam değişkeninden ayarlandı.", + "SUBMIT": "GÖNDER", + "PASSWORD_PLACEHOLDER": "PAROLA", + "LOGIN_RATE_LIMIT": "Giriş denemesi sınırına ulaşıldı!", + "MISS_PASSWORD": "Parola eksik", + "INCORRECT_PASSWORD": "Parola yanlış." +} diff --git a/src/node/i18n/locales/ur.json b/src/node/i18n/locales/ur.json new file mode 100644 index 000000000000..3560b36ba50d --- /dev/null +++ b/src/node/i18n/locales/ur.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "{{app}} لاگ ان کریں", + "LOGIN_BELOW": "براہ کرم نیچے لاگ ان کریں۔", + "WELCOME": "میں خوش آمدید {{app}}", + "LOGIN_PASSWORD": "پاس ورڈ کے لیے کنفگ فائل چیک کریں۔", + "LOGIN_USING_ENV_PASSWORD": "پاس ورڈ $PASSWORD سے سیٹ کیا گیا تھا۔", + "LOGIN_USING_HASHED_PASSWORD": "پاس ورڈ $HASHED_PASSWORD سے سیٹ کیا گیا تھا۔", + "SUBMIT": "جمع کرائیں", + "PASSWORD_PLACEHOLDER": "پاس ورڈ", + "LOGIN_RATE_LIMIT": "لاگ ان کی شرح محدود!", + "MISS_PASSWORD": "پاس ورڈ غائب ہے۔", + "INCORRECT_PASSWORD": "غلط پاس ورڈ" +} diff --git a/src/node/i18n/locales/zh-cn.json b/src/node/i18n/locales/zh-cn.json new file mode 100644 index 000000000000..7d9f2fc21211 --- /dev/null +++ b/src/node/i18n/locales/zh-cn.json @@ -0,0 +1,13 @@ +{ + "LOGIN_TITLE": "{{app}} 登录", + "LOGIN_BELOW": "请在下面登录。", + "WELCOME": "欢迎来到 {{app}}", + "LOGIN_PASSWORD": "查看配置文件中的密码。", + "LOGIN_USING_ENV_PASSWORD": "密码在 $PASSWORD 中设置。", + "LOGIN_USING_HASHED_PASSWORD": "密码在 $HASHED_PASSWORD 中设置。", + "SUBMIT": "提交", + "PASSWORD_PLACEHOLDER": "密码", + "LOGIN_RATE_LIMIT": "登录速率限制!", + "MISS_PASSWORD": "缺少密码", + "INCORRECT_PASSWORD": "密码不正确" +} diff --git a/src/node/insights.ts b/src/node/insights.ts deleted file mode 100644 index 3a5804013513..000000000000 --- a/src/node/insights.ts +++ /dev/null @@ -1,57 +0,0 @@ -import * as appInsights from "applicationinsights"; -import * as https from "https"; -import * as http from "http"; -import * as os from "os"; - -export class TelemetryClient implements appInsights.TelemetryClient { - public config: any = {}; - - public channel = { - setUseDiskRetryCaching: (): void => undefined, - }; - - public trackEvent(options: appInsights.EventTelemetry): void { - if (!options.properties) { - options.properties = {}; - } - if (!options.measurements) { - options.measurements = {}; - } - - try { - const cpus = os.cpus(); - options.measurements.cores = cpus.length; - options.properties["common.cpuModel"] = cpus[0].model; - } catch (error) {} - - try { - options.measurements.memoryFree = os.freemem(); - options.measurements.memoryTotal = os.totalmem(); - } catch (error) {} - - try { - options.properties["common.shell"] = os.userInfo().shell; - options.properties["common.release"] = os.release(); - options.properties["common.arch"] = os.arch(); - } catch (error) {} - - try { - const url = process.env.TELEMETRY_URL || "https://v1.telemetry.coder.com/track"; - const request = (/^http:/.test(url) ? http : https).request(url, { - method: "POST", - headers: { - "Content-Type": "application/json", - }, - }); - request.on("error", () => { /* We don't care. */ }); - request.write(JSON.stringify(options)); - request.end(); - } catch (error) {} - } - - public flush(options: appInsights.FlushOptions): void { - if (options.callback) { - options.callback(""); - } - } -} diff --git a/src/node/ipc.ts b/src/node/ipc.ts deleted file mode 100644 index da188234d748..000000000000 --- a/src/node/ipc.ts +++ /dev/null @@ -1,52 +0,0 @@ -import * as cp from "child_process"; -import { Emitter } from "vs/base/common/event"; - -enum ControlMessage { - okToChild = "ok>", - okFromChild = "ok<", -} - -export type Message = "relaunch"; - -class IpcMain { - protected readonly _onMessage = new Emitter(); - public readonly onMessage = this._onMessage.event; - - public handshake(child?: cp.ChildProcess): Promise { - return new Promise((resolve, reject) => { - const target = child || process; - if (!target.send) { - throw new Error("Not spawned with IPC enabled"); - } - target.on("message", (message) => { - if (message === child ? ControlMessage.okFromChild : ControlMessage.okToChild) { - target.removeAllListeners(); - target.on("message", (msg) => this._onMessage.fire(msg)); - if (child) { - target.send!(ControlMessage.okToChild); - } - resolve(); - } - }); - if (child) { - child.once("error", reject); - child.once("exit", (code) => { - const error = new Error(`Unexpected exit with code ${code}`); - (error as any).code = code; - reject(error); - }); - } else { - target.send(ControlMessage.okFromChild); - } - }); - } - - public relaunch(): void { - if (!process.send) { - throw new Error("Not a child process with IPC enabled"); - } - process.send("relaunch"); - } -} - -export const ipcMain = new IpcMain(); diff --git a/src/node/main.ts b/src/node/main.ts new file mode 100644 index 000000000000..c2d3bd57852b --- /dev/null +++ b/src/node/main.ts @@ -0,0 +1,245 @@ +import { field, logger } from "@coder/logger" +import http from "http" +import * as os from "os" +import * as path from "path" +import { Disposable } from "../common/emitter" +import { plural } from "../common/util" +import { createApp, ensureAddress } from "./app" +import { AuthType, DefaultedArgs, Feature, toCodeArgs, UserProvidedArgs } from "./cli" +import { commit, version, vsRootPath } from "./constants" +import { loadCustomStrings } from "./i18n" +import { register } from "./routes" +import { VSCodeModule } from "./routes/vscode" +import { isDirectory, open } from "./util" +import { wrapper } from "./wrapper" + +/** + * Return true if the user passed an extension-related VS Code flag. + */ +export const shouldSpawnCliProcess = (args: UserProvidedArgs): boolean => { + return ( + !!args["list-extensions"] || + !!args["install-extension"] || + !!args["uninstall-extension"] || + !!args["locate-extension"] + ) +} + +/** + * This is copy of OpenCommandPipeArgs from + * ../../lib/vscode/src/vs/workbench/api/node/extHostCLIServer.ts:15 + * + * Arguments supported by Code's socket. It can be used to perform actions from + * the CLI in a running instance of Code (for example to open a file). + * + * TODO: Can we import this (and other types) directly? + */ +export interface OpenCommandPipeArgs { + type: "open" + fileURIs?: string[] + folderURIs: string[] + forceNewWindow?: boolean + diffMode?: boolean + addMode?: boolean + gotoLineMode?: boolean + forceReuseWindow?: boolean + waitMarkerFilePath?: string +} + +/** + * Run Code's CLI for things like managing extensions. + */ +export const runCodeCli = async (args: DefaultedArgs): Promise => { + logger.debug("Running Code CLI") + try { + // See vscode.loadVSCode for more on this jank. + process.env.CODE_SERVER_PARENT_PID = process.pid.toString() + let modPath = path.join(vsRootPath, "out/server-main.js") + if (os.platform() === "win32") { + // On Windows, absolute paths of ESM modules must be a valid file URI. + modPath = "file:///" + modPath.replace(/\\/g, "/") + } + const mod = (await eval(`import("${modPath}")`)) as VSCodeModule + const serverModule = await mod.loadCodeWithNls() + await serverModule.spawnCli(await toCodeArgs(args)) + // Rather than have the caller handle errors and exit, spawnCli will exit + // itself. Additionally, it does this on a timeout set to 0. So, try + // waiting for VS Code to exit before giving up and doing it ourselves. + await new Promise((r) => setTimeout(r, 1000)) + logger.warn("Code never exited") + process.exit(0) + } catch (error: any) { + // spawnCli catches all errors, but just in case that changes. + logger.error("Got error from Code", error) + process.exit(1) + } +} + +export const openInExistingInstance = async (args: DefaultedArgs, socketPath: string): Promise => { + const pipeArgs: OpenCommandPipeArgs & { fileURIs: string[] } = { + type: "open", + folderURIs: [], + fileURIs: [], + forceReuseWindow: args["reuse-window"], + forceNewWindow: args["new-window"], + gotoLineMode: true, + } + for (let i = 0; i < args._.length; i++) { + const fp = args._[i] + if (await isDirectory(fp)) { + pipeArgs.folderURIs.push(fp) + } else { + pipeArgs.fileURIs.push(fp) + } + } + if (pipeArgs.forceNewWindow && pipeArgs.fileURIs.length > 0) { + logger.error("--new-window can only be used with folder paths") + process.exit(1) + } + if (pipeArgs.folderURIs.length === 0 && pipeArgs.fileURIs.length === 0) { + logger.error("Please specify at least one file or folder") + process.exit(1) + } + const vscode = http.request( + { + path: "/", + method: "POST", + socketPath, + }, + (response) => { + response.on("data", (message) => { + logger.debug("got message from Code", field("message", message.toString())) + }) + }, + ) + vscode.on("error", (error: unknown) => { + logger.error("got error from Code", field("error", error)) + }) + vscode.write(JSON.stringify(pipeArgs)) + vscode.end() +} + +export const runCodeServer = async ( + args: DefaultedArgs, +): Promise<{ dispose: Disposable["dispose"]; server: http.Server }> => { + logger.info(`code-server ${version} ${commit}`) + + // Load custom strings if provided + if (args.i18n) { + await loadCustomStrings(args.i18n) + logger.info("Loaded custom strings") + } + + logger.info(`Using user-data-dir ${args["user-data-dir"]}`) + logger.debug(`Using extensions-dir ${args["extensions-dir"]}`) + + if (args.auth === AuthType.Password && !args.password && !args["hashed-password"]) { + throw new Error( + "Please pass in a password via the config file or environment variable ($PASSWORD or $HASHED_PASSWORD)", + ) + } + + const app = await createApp(args) + const protocol = args.cert ? "https" : "http" + const serverAddress = ensureAddress(app.server, protocol) + const { disposeRoutes, heart } = await register(app, args) + + logger.info(`Using config file ${args.config}`) + logger.info(`${protocol.toUpperCase()} server listening on ${serverAddress.toString()}`) + if (args.auth === AuthType.Password) { + logger.info(" - Authentication is enabled") + if (args.usingEnvPassword) { + logger.info(" - Using password from $PASSWORD") + } else if (args.usingEnvHashedPassword) { + logger.info(" - Using password from $HASHED_PASSWORD") + } else if (args["hashed-password"]) { + logger.info(` - Using hashed-password from ${args.config}`) + } else { + logger.info(` - Using password from ${args.config}`) + } + } else { + logger.info(" - Authentication is disabled") + } + + if (args.cert) { + logger.info(` - Using certificate for HTTPS: ${args.cert.value}`) + } else { + logger.info(" - Not serving HTTPS") + } + + if (args["idle-timeout-seconds"]) { + logger.info(` - Idle timeout set to ${args["idle-timeout-seconds"]} seconds`) + + let idleShutdownTimer: NodeJS.Timeout | undefined + const startIdleShutdownTimer = () => { + idleShutdownTimer = setTimeout(() => { + logger.warn(`Idle timeout of ${args["idle-timeout-seconds"]} seconds exceeded`) + wrapper.exit(0) + }, args["idle-timeout-seconds"]! * 1000) + } + + startIdleShutdownTimer() + + heart.onChange((state) => { + clearTimeout(idleShutdownTimer) + if (state === "expired") { + startIdleShutdownTimer() + } + }) + } + + if (args["disable-proxy"]) { + logger.info(" - Proxy disabled") + } else if (args["proxy-domain"].length > 0) { + logger.info(` - ${plural(args["proxy-domain"].length, "Proxying the following domain")}:`) + args["proxy-domain"].forEach((domain) => logger.info(` - ${domain}`)) + } + if (args["skip-auth-preflight"]) { + logger.info(" - Skipping authentication for preflight requests") + } + if (process.env.VSCODE_PROXY_URI) { + logger.info(`Using proxy URI in PORTS tab: ${process.env.VSCODE_PROXY_URI}`) + } + + const sessionServerAddress = app.editorSessionManagerServer.address() + if (sessionServerAddress) { + logger.info(`Session server listening on ${sessionServerAddress.toString()}`) + } + + if (process.env.EXTENSIONS_GALLERY) { + logger.info("Using custom extensions gallery") + logger.debug(` - ${process.env.EXTENSIONS_GALLERY}`) + } + + if (args.enable && args.enable.length > 0) { + logger.info("Enabling the following experimental features:") + args.enable.forEach((feature) => { + if (Object.values(Feature).includes(feature as Feature)) { + logger.info(` - "${feature}"`) + } else { + logger.error(` X "${feature}" (unknown feature)`) + } + }) + // TODO: Could be nice to add wrapping to the logger? + logger.info( + " The code-server project does not provide stability guarantees or commit to fixing bugs relating to these experimental features. When filing bug reports, please ensure that you can reproduce the bug with all experimental features turned off.", + ) + } + + if (args.open) { + try { + await open(serverAddress) + logger.info(`Opened ${serverAddress}`) + } catch (error) { + logger.error("Failed to open", field("address", serverAddress.toString()), field("error", error)) + } + } + + return { + server: app.server, + dispose: async () => { + disposeRoutes() + await app.dispose() + }, + } +} diff --git a/src/node/marketplace.ts b/src/node/marketplace.ts deleted file mode 100644 index 9c2abff9e183..000000000000 --- a/src/node/marketplace.ts +++ /dev/null @@ -1,176 +0,0 @@ -import * as fs from "fs"; -import * as path from "path"; -import * as util from "util"; -import { CancellationToken } from "vs/base/common/cancellation"; -import { mkdirp } from "vs/base/node/pfs"; -import * as vszip from "vs/base/node/zip"; -import * as nls from "vs/nls"; -import product from "vs/platform/product/node/product"; -import { localRequire } from "vs/server/src/node/util"; - -const tarStream = localRequire("tar-stream/index"); - -// We will be overriding these, so keep a reference to the original. -const vszipExtract = vszip.extract; -const vszipBuffer = vszip.buffer; - -export interface IExtractOptions { - overwrite?: boolean; - /** - * Source path within the TAR/ZIP archive. Only the files - * contained in this path will be extracted. - */ - sourcePath?: string; -} - -export interface IFile { - path: string; - contents?: Buffer | string; - localPath?: string; -} - -export const tar = async (tarPath: string, files: IFile[]): Promise => { - const pack = tarStream.pack(); - const chunks: Buffer[] = []; - const ended = new Promise((resolve) => { - pack.on("end", () => resolve(Buffer.concat(chunks))); - }); - pack.on("data", (chunk: Buffer) => chunks.push(chunk)); - for (let i = 0; i < files.length; i++) { - const file = files[i]; - pack.entry({ name: file.path }, file.contents); - } - pack.finalize(); - await util.promisify(fs.writeFile)(tarPath, await ended); - return tarPath; -}; - -export const extract = async (archivePath: string, extractPath: string, options: IExtractOptions = {}, token: CancellationToken): Promise => { - try { - await extractTar(archivePath, extractPath, options, token); - } catch (error) { - if (error.toString().includes("Invalid tar header")) { - await vszipExtract(archivePath, extractPath, options, token); - } - } -}; - -export const buffer = (targetPath: string, filePath: string): Promise => { - return new Promise(async (resolve, reject) => { - try { - let done: boolean = false; - await extractAssets(targetPath, new RegExp(filePath), (assetPath: string, data: Buffer) => { - if (path.normalize(assetPath) === path.normalize(filePath)) { - done = true; - resolve(data); - } - }); - if (!done) { - throw new Error("couldn't find asset " + filePath); - } - } catch (error) { - if (error.toString().includes("Invalid tar header")) { - vszipBuffer(targetPath, filePath).then(resolve).catch(reject); - } else { - reject(error); - } - } - }); -}; - -const extractAssets = async (tarPath: string, match: RegExp, callback: (path: string, data: Buffer) => void): Promise => { - return new Promise((resolve, reject): void => { - const extractor = tarStream.extract(); - const fail = (error: Error) => { - extractor.destroy(); - reject(error); - }; - extractor.once("error", fail); - extractor.on("entry", async (header, stream, next) => { - const name = header.name; - if (match.test(name)) { - extractData(stream).then((data) => { - callback(name, data); - next(); - }).catch(fail); - } else { - stream.on("end", () => next()); - stream.resume(); // Just drain it. - } - }); - extractor.on("finish", resolve); - fs.createReadStream(tarPath).pipe(extractor); - }); -}; - -const extractData = (stream: NodeJS.ReadableStream): Promise => { - return new Promise((resolve, reject): void => { - const fileData: Buffer[] = []; - stream.on("error", reject); - stream.on("end", () => resolve(Buffer.concat(fileData))); - stream.on("data", (data) => fileData.push(data)); - }); -}; - -const extractTar = async (tarPath: string, targetPath: string, options: IExtractOptions = {}, token: CancellationToken): Promise => { - return new Promise((resolve, reject): void => { - const sourcePathRegex = new RegExp(options.sourcePath ? `^${options.sourcePath}` : ""); - const extractor = tarStream.extract(); - const fail = (error: Error) => { - extractor.destroy(); - reject(error); - }; - extractor.once("error", fail); - extractor.on("entry", async (header, stream, next) => { - const nextEntry = (): void => { - stream.on("end", () => next()); - stream.resume(); - }; - - const rawName = path.normalize(header.name); - if (token.isCancellationRequested || !sourcePathRegex.test(rawName)) { - return nextEntry(); - } - - const fileName = rawName.replace(sourcePathRegex, ""); - const targetFileName = path.join(targetPath, fileName); - if (/\/$/.test(fileName)) { - return mkdirp(targetFileName).then(nextEntry); - } - - const dirName = path.dirname(fileName); - const targetDirName = path.join(targetPath, dirName); - if (targetDirName.indexOf(targetPath) !== 0) { - return fail(new Error(nls.localize("invalid file", "Error extracting {0}. Invalid file.", fileName))); - } - - await mkdirp(targetDirName, undefined, token); - - const fstream = fs.createWriteStream(targetFileName, { mode: header.mode }); - fstream.once("close", () => next()); - fstream.once("error", fail); - stream.pipe(fstream); - }); - extractor.once("finish", resolve); - fs.createReadStream(tarPath).pipe(extractor); - }); -}; - -/** - * Override original functionality so we can use a custom marketplace with - * either tars or zips. - */ -export const enableCustomMarketplace = (): void => { - (product).extensionsGallery = { // Use `any` to override readonly. - serviceUrl: process.env.SERVICE_URL || "https://v1.extapi.coder.com", - itemUrl: process.env.ITEM_URL || "", - controlUrl: "", - recommendationsUrl: "", - ...(product.extensionsGallery || {}), - }; - - const target = vszip as typeof vszip; - target.zip = tar; - target.extract = extract; - target.buffer = buffer; -}; diff --git a/src/node/nls.ts b/src/node/nls.ts deleted file mode 100644 index 30922502fdde..000000000000 --- a/src/node/nls.ts +++ /dev/null @@ -1,80 +0,0 @@ -import * as fs from "fs"; -import * as path from "path"; -import * as util from "util"; -import { getPathFromAmdModule } from "vs/base/common/amd"; -import * as lp from "vs/base/node/languagePacks"; -import product from "vs/platform/product/node/product"; -import { Translations } from "vs/workbench/services/extensions/common/extensionPoints"; - -const configurations = new Map>(); -const metadataPath = path.join(getPathFromAmdModule(require, ""), "nls.metadata.json"); - -export const isInternalConfiguration = (config: lp.NLSConfiguration): config is lp.InternalNLSConfiguration => { - return config && !!(config)._languagePackId; -}; - -const DefaultConfiguration = { - locale: "en", - availableLanguages: {}, -}; - -export const getNlsConfiguration = async (locale: string, userDataPath: string): Promise => { - const id = `${locale}: ${userDataPath}`; - if (!configurations.has(id)) { - configurations.set(id, new Promise(async (resolve) => { - const config = product.commit && await util.promisify(fs.exists)(metadataPath) - ? await lp.getNLSConfiguration(product.commit, userDataPath, metadataPath, locale) - : DefaultConfiguration; - if (isInternalConfiguration(config)) { - config._languagePackSupport = true; - } - resolve(config); - })); - } - return configurations.get(id)!; -}; - -export const getTranslations = async (locale: string, userDataPath: string): Promise => { - const config = await getNlsConfiguration(locale, userDataPath); - if (isInternalConfiguration(config)) { - try { - return JSON.parse(await util.promisify(fs.readFile)(config._translationsConfigFile, "utf8")); - } catch (error) { /* Nothing yet. */} - } - return {}; -}; - -export const getLocaleFromConfig = async (userDataPath: string): Promise => { - let locale = "en"; - try { - const localeConfigUri = path.join(userDataPath, "User/locale.json"); - const content = stripComments(await util.promisify(fs.readFile)(localeConfigUri, "utf8")); - locale = JSON.parse(content).locale; - } catch (error) { /* Ignore. */ } - return locale; -}; - -// Taken from src/main.js in the main VS Code source. -const stripComments = (content: string): string => { - const regexp = /("(?:[^\\"]*(?:\\.)?)*")|('(?:[^\\']*(?:\\.)?)*')|(\/\*(?:\r?\n|.)*?\*\/)|(\/{2,}.*?(?:(?:\r?\n)|$))/g; - - return content.replace(regexp, (match, _m1, _m2, m3, m4) => { - // Only one of m1, m2, m3, m4 matches - if (m3) { - // A block comment. Replace with nothing - return ''; - } else if (m4) { - // A line comment. If it ends in \r?\n then keep it. - const length_1 = m4.length; - if (length_1 > 2 && m4[length_1 - 1] === '\n') { - return m4[length_1 - 2] === '\r' ? '\r\n' : '\n'; - } - else { - return ''; - } - } else { - // We match a string - return match; - } - }); -}; diff --git a/src/node/protocol.ts b/src/node/protocol.ts deleted file mode 100644 index fde6662a63c7..000000000000 --- a/src/node/protocol.ts +++ /dev/null @@ -1,73 +0,0 @@ -import * as net from "net"; -import { VSBuffer } from "vs/base/common/buffer"; -import { PersistentProtocol } from "vs/base/parts/ipc/common/ipc.net"; -import { NodeSocket, WebSocketNodeSocket } from "vs/base/parts/ipc/node/ipc.net"; -import { AuthRequest, ConnectionTypeRequest, HandshakeMessage } from "vs/platform/remote/common/remoteAgentConnection"; - -export interface SocketOptions { - readonly reconnectionToken: string; - readonly reconnection: boolean; - readonly skipWebSocketFrames: boolean; -} - -export class Protocol extends PersistentProtocol { - public constructor(socket: net.Socket, public readonly options: SocketOptions) { - super( - options.skipWebSocketFrames - ? new NodeSocket(socket) - : new WebSocketNodeSocket(new NodeSocket(socket)), - ); - } - - public getUnderlyingSocket(): net.Socket { - const socket = this.getSocket(); - return socket instanceof NodeSocket - ? socket.socket - : (socket as WebSocketNodeSocket).socket.socket; - } - - /** - * Perform a handshake to get a connection request. - */ - public handshake(): Promise { - return new Promise((resolve, reject) => { - const handler = this.onControlMessage((rawMessage) => { - try { - const message = JSON.parse(rawMessage.toString()); - switch (message.type) { - case "auth": return this.authenticate(message); - case "connectionType": - handler.dispose(); - return resolve(message); - default: throw new Error("Unrecognized message type"); - } - } catch (error) { - handler.dispose(); - reject(error); - } - }); - }); - } - - /** - * TODO: This ignores the authentication process entirely for now. - */ - private authenticate(_message: AuthRequest): void { - this.sendMessage({ type: "sign", data: "" }); - } - - /** - * TODO: implement. - */ - public tunnel(): void { - throw new Error("Tunnel is not implemented yet"); - } - - /** - * Send a handshake message. In the case of the extension host, it just sends - * back a debug port. - */ - public sendMessage(message: HandshakeMessage | { debugPort?: number } ): void { - this.sendControl(VSBuffer.fromString(JSON.stringify(message))); - } -} diff --git a/src/node/proxy.ts b/src/node/proxy.ts new file mode 100644 index 000000000000..2d9056996d53 --- /dev/null +++ b/src/node/proxy.ts @@ -0,0 +1,56 @@ +import * as cookie from "cookie" +import type { Request } from "express" +import proxyServer from "http-proxy" +import { getCookieSessionName, HttpCode } from "../common/http" + +export const proxy = proxyServer.createProxyServer({}) + +// The error handler catches when the proxy fails to connect (for example when +// there is nothing running on the target port). +proxy.on("error", (error, _, res) => { + // This could be for either a web socket or a regular request. Despite what + // the types say, writeHead() will not exist on web socket requests (nor will + // status() from Express). But writing out the code manually does not work + // for regular requests thus the branching behavior. + if (typeof res.writeHead !== "undefined") { + res.writeHead(HttpCode.ServerError) + res.end(error.message) + } else { + res.end(`HTTP/1.1 ${HttpCode.ServerError} ${error.message}\r\n\r\n`) + } +}) + +function identity(val: T): T { + return val +} + +// Strip the code-server cookie if it exists to avoid transmitting the cookie +// to potentially malicious local ports. +proxy.on("proxyReq", (preq, req) => { + if (req.headers.cookie) { + const cookieSessionName = getCookieSessionName((req as Request).args["cookie-suffix"]) + // Encoding and decoding are no-ops; we just want to remove the token + // without changing anything else about the cookies because not all + // applications encode/decode the same way `cookie` here does. + preq.setHeader( + "Cookie", + cookie.stringifyCookie( + { + ...cookie.parseCookie(req.headers.cookie, { decode: identity }), + [cookieSessionName]: undefined, + }, + { + encode: identity, + }, + ), + ) + } +}) + +// Intercept the response to rewrite absolute redirects against the base path. +// Is disabled when the request has no base path which means /absproxy is in use. +proxy.on("proxyRes", (res, req) => { + if (res.headers.location && res.headers.location.startsWith("/") && (req as any).base) { + res.headers.location = (req as any).base + res.headers.location + } +}) diff --git a/src/node/routes/domainProxy.ts b/src/node/routes/domainProxy.ts new file mode 100644 index 000000000000..6ffee67fa002 --- /dev/null +++ b/src/node/routes/domainProxy.ts @@ -0,0 +1,118 @@ +import { Request, Router } from "express" +import { HttpCode, HttpError } from "../../common/http" +import { getHost, ensureProxyEnabled, authenticated, ensureAuthenticated, ensureOrigin, redirect, self } from "../http" +import { proxy } from "../proxy" +import { Router as WsRouter } from "../wsRouter" + +export const router = Router() + +const proxyDomainToRegex = (matchString: string): RegExp => { + const escapedMatchString = matchString.replace(/[.*+?^$()|[\]\\]/g, "\\$&") + + // Replace {{port}} with a regex group to capture the port + // Replace {{host}} with .+ to allow any host match (so rely on DNS record here) + let regexString = escapedMatchString.replace("{{port}}", "(\\d+)") + regexString = regexString.replace("{{host}}", ".+") + + regexString = regexString.replace(/[{}]/g, "\\$&") //replace any '{}' that might be left + + return new RegExp("^" + regexString + "$") +} + +let proxyRegexes: RegExp[] = [] +const proxyDomainsToRegex = (proxyDomains: string[]): RegExp[] => { + if (proxyDomains.length !== proxyRegexes.length) { + proxyRegexes = proxyDomains.map(proxyDomainToRegex) + } + return proxyRegexes +} + +/** + * Return the port if the request should be proxied. + * + * The proxy-domain should be of format anyprefix-{{port}}-anysuffix.{{host}}, where {{host}} is optional + * e.g. code-8080.domain.tld would match for code-{{port}}.domain.tld and code-{{port}}.{{host}}. + * + */ +const maybeProxy = (req: Request): string | undefined => { + const reqDomain = getHost(req) + if (reqDomain === undefined) { + return undefined + } + + const regexs = proxyDomainsToRegex(req.args["proxy-domain"]) + + for (const regex of regexs) { + const match = reqDomain.match(regex) + + if (match) { + return match[1] // match[1] contains the port + } + } + + return undefined +} + +router.all(/.*/, async (req, res, next) => { + const port = maybeProxy(req) + if (!port) { + return next() + } + + ensureProxyEnabled(req) + + if (req.method === "OPTIONS" && req.args["skip-auth-preflight"]) { + // Allow preflight requests with `skip-auth-preflight` flag + return next() + } + + // Must be authenticated to use the proxy. + const isAuthenticated = await authenticated(req) + if (!isAuthenticated) { + // Let the assets through since they're used on the login page. + if (req.path.startsWith("/_static/") && req.method === "GET") { + return next() + } + + // Assume anything that explicitly accepts text/html is a user browsing a + // page (as opposed to an xhr request). Don't use `req.accepts()` since + // *every* request that I've seen (in Firefox and Chromium at least) + // includes `*/*` making it always truthy. Even for css/javascript. + if (req.headers.accept && req.headers.accept.includes("text/html")) { + // Let the login through. + if (/\/login\/?/.test(req.path)) { + return next() + } + // Redirect all other pages to the login. + const to = self(req) + return redirect(req, res, "login", { + to: to !== "/" ? to : undefined, + }) + } + + // Everything else gets an unauthorized message. + throw new HttpError("Unauthorized", HttpCode.Unauthorized) + } + + proxy.web(req, res, { + ignorePath: true, + target: `http://0.0.0.0:${port}${req.originalUrl}`, + }) +}) + +export const wsRouter = WsRouter() + +wsRouter.ws(/.*/, async (req, _, next) => { + const port = maybeProxy(req) + if (!port) { + return next() + } + + ensureProxyEnabled(req) + ensureOrigin(req) + await ensureAuthenticated(req) + proxy.ws(req, req.ws, req.head, { + ignorePath: true, + target: `http://0.0.0.0:${port}${req.originalUrl}`, + }) +}) diff --git a/src/node/routes/errors.ts b/src/node/routes/errors.ts new file mode 100644 index 000000000000..47286210afe8 --- /dev/null +++ b/src/node/routes/errors.ts @@ -0,0 +1,90 @@ +import { logger } from "@coder/logger" +import express from "express" +import { promises as fs } from "fs" +import path from "path" +import { HttpCode } from "../../common/http" +import { rootPath } from "../constants" +import { replaceTemplates } from "../http" +import { escapeHtml, getMediaMime } from "../util" +import type { WebsocketRequest } from "../wsRouter" + +interface ErrorWithStatusCode { + statusCode: number +} + +interface ErrorWithCode { + code: string +} + +/** Error is network related. */ +export const errorHasStatusCode = (error: any): error is ErrorWithStatusCode => { + return error && "statusCode" in error +} + +/** Error originates from file system. */ +export const errorHasCode = (error: any): error is ErrorWithCode => { + return error && "code" in error +} + +const notFoundCodes = [404, "ENOENT", "EISDIR"] + +/** + * Final HTTP error handler. + * + * Note: This handler intentionally does not call `next()` even though it + * accepts it as an argument; it is expected to be mounted last. + */ +export const errorHandler: express.ErrorRequestHandler = async (err, req, res, next) => { + let statusCode = 500 + + if (errorHasStatusCode(err)) { + statusCode = err.statusCode + } else if (errorHasCode(err) && notFoundCodes.includes(err.code)) { + statusCode = HttpCode.NotFound + } + + res.status(statusCode) + + // Assume anything that explicitly accepts text/html is a user browsing a + // page (as opposed to an xhr request). Don't use `req.accepts()` since + // *every* request that I've seen (in Firefox and Chromium at least) + // includes `*/*` making it always truthy. Even for css/javascript. + if (req.headers.accept && req.headers.accept.includes("text/html")) { + const resourcePath = path.resolve(rootPath, "src/browser/pages/error.html") + res.set("Content-Type", getMediaMime(resourcePath)) + const content = await fs.readFile(resourcePath, "utf8") + res.send( + replaceTemplates(req, content) + .replace(/{{ERROR_TITLE}}/g, statusCode.toString()) + .replace(/{{ERROR_HEADER}}/g, statusCode.toString()) + .replace(/{{ERROR_BODY}}/g, escapeHtml(err.message)) + .replace(/{{APP_NAME}}/g, req.args["app-name"]), + ) + } else { + res.json({ + error: err.message, + ...(err.details || {}), + }) + } +} + +/** + * Final WebSocket error handler. + * + * Note: This handler intentionally does not call `next()` even though it + * accepts it as an argument; it is expected to be mounted last. + */ +export const wsErrorHandler: express.ErrorRequestHandler = async (err, req, res, next) => { + let statusCode = 500 + if (errorHasStatusCode(err)) { + statusCode = err.statusCode + } else if (errorHasCode(err) && notFoundCodes.includes(err.code)) { + statusCode = HttpCode.NotFound + } + if (statusCode >= 500) { + logger.error(`${err.message} ${err.stack}`) + } else { + logger.debug(`${err.message} ${err.stack}`) + } + ;(req as WebsocketRequest).ws.end(`HTTP/1.1 ${statusCode} ${err.message}\r\n\r\n`) +} diff --git a/src/node/routes/health.ts b/src/node/routes/health.ts new file mode 100644 index 000000000000..faf1f9c75141 --- /dev/null +++ b/src/node/routes/health.ts @@ -0,0 +1,28 @@ +import { Router } from "express" +import { wss, Router as WsRouter } from "../wsRouter" + +export const router = Router() + +router.get("/", (req, res) => { + res.json({ + status: req.heart.alive() ? "alive" : "expired", + lastHeartbeat: req.heart.lastHeartbeat, + }) +}) + +export const wsRouter = WsRouter() + +wsRouter.ws("/", async (req) => { + wss.handleUpgrade(req, req.ws, req.head, (ws) => { + ws.addEventListener("message", () => { + ws.send( + JSON.stringify({ + event: "health", + status: req.heart.alive() ? "alive" : "expired", + lastHeartbeat: req.heart.lastHeartbeat, + }), + ) + }) + req.ws.resume() + }) +}) diff --git a/src/node/routes/index.ts b/src/node/routes/index.ts new file mode 100644 index 000000000000..78e30566867d --- /dev/null +++ b/src/node/routes/index.ts @@ -0,0 +1,189 @@ +import { logger } from "@coder/logger" +import cookieParser from "cookie-parser" +import * as express from "express" +import { promises as fs } from "fs" +import * as path from "path" +import * as tls from "tls" +import { Disposable } from "../../common/emitter" +import { getCookieSessionName, HttpCode, HttpError } from "../../common/http" +import { plural } from "../../common/util" +import { App } from "../app" +import { AuthType, DefaultedArgs } from "../cli" +import { commit, rootPath } from "../constants" +import { Heart } from "../heart" +import { redirect } from "../http" +import { CoderSettings, SettingsProvider } from "../settings" +import { UpdateProvider } from "../update" +import { getMediaMime, paths } from "../util" +import type { WebsocketRequest } from "../wsRouter" +import * as domainProxy from "./domainProxy" +import { errorHandler, wsErrorHandler } from "./errors" +import * as health from "./health" +import * as login from "./login" +import * as logout from "./logout" +import * as pathProxy from "./pathProxy" +import * as update from "./update" +import * as vscode from "./vscode" + +/** + * Register all routes and middleware. + */ +export const register = async ( + app: App, + args: DefaultedArgs, +): Promise<{ disposeRoutes: Disposable["dispose"]; heart: Heart }> => { + const heart = new Heart(path.join(paths.data, "heartbeat"), async () => { + return new Promise((resolve, reject) => { + // getConnections appears to not call the callback when there are no more + // connections. Feels like it must be a bug? For now add a timer to make + // sure we eventually resolve. + const timer = setTimeout(() => { + logger.debug("Node failed to respond with connections; assuming zero") + resolve(false) + }, 5000) + app.server.getConnections((error, count) => { + clearTimeout(timer) + if (error) { + return reject(error) + } + logger.debug(plural(count, `${count} active connection`)) + resolve(count > 0) + }) + }) + }) + + app.router.disable("x-powered-by") + app.wsRouter.disable("x-powered-by") + + app.router.use(cookieParser()) + app.wsRouter.use(cookieParser()) + + const settings = new SettingsProvider(path.join(args["user-data-dir"], "coder.json")) + const updater = new UpdateProvider("https://api.github.com/repos/coder/code-server/releases/latest", settings) + + const cookieSessionName = getCookieSessionName(args["cookie-suffix"]) + + const common: express.RequestHandler = (req, _, next) => { + // /healthz|/healthz/ needs to be excluded otherwise health checks will make + // it look like code-server is always in use. + if (!/^\/healthz\/?$/.test(req.url)) { + // NOTE@jsjoeio - intentionally not awaiting the .beat() call here because + // we don't want to slow down the request. + heart.beat() + } + + // Add common variables routes can use. + req.args = args + req.heart = heart + req.settings = settings + req.updater = updater + req.cookieSessionName = cookieSessionName + + next() + } + + app.router.use(common) + app.wsRouter.use(common) + + app.router.use(/.*/, async (req, res, next) => { + // If we're handling TLS ensure all requests are redirected to HTTPS. + // TODO: This does *NOT* work if you have a base path since to specify the + // protocol we need to specify the whole path. + if (args.cert && !(req.connection as tls.TLSSocket).encrypted) { + return res.redirect(`https://${req.headers.host}${req.originalUrl}`) + } + next() + }) + + app.router.get(["/security.txt", "/.well-known/security.txt"], async (_, res) => { + const resourcePath = path.resolve(rootPath, "src/browser/security.txt") + res.set("Content-Type", getMediaMime(resourcePath)) + res.send(await fs.readFile(resourcePath)) + }) + + app.router.get("/robots.txt", async (_, res) => { + const resourcePath = path.resolve(rootPath, "src/browser/robots.txt") + res.set("Content-Type", getMediaMime(resourcePath)) + res.send(await fs.readFile(resourcePath)) + }) + + app.router.use("/", domainProxy.router) + app.wsRouter.use("/", domainProxy.wsRouter.router) + + app.router.all("/proxy/:port{/*path}", async (req, res) => { + await pathProxy.proxy(req, res) + }) + app.wsRouter.get("/proxy/:port{/*path}", async (req) => { + await pathProxy.wsProxy(req as unknown as WebsocketRequest) + }) + // These two routes pass through the path directly. + // So the proxied app must be aware it is running + // under /absproxy// + app.router.all("/absproxy/:port{/*path}", async (req, res) => { + await pathProxy.proxy(req, res, { + passthroughPath: true, + proxyBasePath: args["abs-proxy-base-path"], + }) + }) + app.wsRouter.get("/absproxy/:port{/*path}", async (req) => { + await pathProxy.wsProxy(req as unknown as WebsocketRequest, { + passthroughPath: true, + proxyBasePath: args["abs-proxy-base-path"], + }) + }) + + app.router.use(express.json()) + app.router.use(express.urlencoded({ extended: true })) + + app.router.use( + "/_static", + express.static(rootPath, { + cacheControl: commit !== "development", + fallthrough: false, + setHeaders: (res, path, stat) => { + // The service worker is served from a sub-path on the static route so + // this is required to allow it to register a higher scope (by default + // the browser only allows it to register from its own path or lower). + if (path.endsWith("/serviceWorker.js")) { + res.setHeader("Service-Worker-Allowed", "/") + } + }, + }), + ) + + app.router.use("/healthz", health.router) + app.wsRouter.use("/healthz", health.wsRouter.router) + + if (args.auth === AuthType.Password) { + app.router.use("/login", login.router) + app.router.use("/logout", logout.router) + } else { + app.router.all("/login", (req, res) => redirect(req, res, "/", {})) + app.router.all("/logout", (req, res) => redirect(req, res, "/", {})) + } + + app.router.use("/update", update.router) + + // For historic reasons we also load at /vscode because the root was replaced + // by a plugin in v1 of Coder. The plugin system (which was for internal use + // only) has been removed, but leave the additional route for now. + for (const routePrefix of ["/vscode", "/"]) { + app.router.use(routePrefix, vscode.router) + app.wsRouter.use(routePrefix, vscode.wsRouter.router) + } + + app.router.use(() => { + throw new HttpError("Not Found", HttpCode.NotFound) + }) + + app.router.use(errorHandler) + app.wsRouter.use(wsErrorHandler) + + return { + disposeRoutes: () => { + heart.dispose() + vscode.dispose() + }, + heart, + } +} diff --git a/src/node/routes/login.ts b/src/node/routes/login.ts new file mode 100644 index 000000000000..e3f797e76471 --- /dev/null +++ b/src/node/routes/login.ts @@ -0,0 +1,121 @@ +import { Router, Request } from "express" +import { promises as fs } from "fs" +import { RateLimiter as Limiter } from "limiter" +import * as path from "path" +import { rootPath } from "../constants" +import { authenticated, getCookieOptions, redirect, replaceTemplates } from "../http" +import i18n from "../i18n" +import { getPasswordMethod, handlePasswordValidation, sanitizeString, escapeHtml } from "../util" + +// RateLimiter wraps around the limiter library for logins. +// It allows 2 logins every minute plus 12 logins every hour. +export class RateLimiter { + private readonly minuteLimiter = new Limiter({ tokensPerInterval: 2, interval: "minute" }) + private readonly hourLimiter = new Limiter({ tokensPerInterval: 12, interval: "hour" }) + + public canTry(): boolean { + // Note: we must check using >= 1 because technically when there are no tokens left + // you get back a number like 0.00013333333333333334 + // which would cause fail if the logic were > 0 + return this.minuteLimiter.getTokensRemaining() >= 1 || this.hourLimiter.getTokensRemaining() >= 1 + } + + public removeToken(): boolean { + return this.minuteLimiter.tryRemoveTokens(1) || this.hourLimiter.tryRemoveTokens(1) + } +} + +const getRoot = async (req: Request, error?: Error): Promise => { + const content = await fs.readFile(path.join(rootPath, "src/browser/pages/login.html"), "utf8") + const locale = req.args["locale"] || "en" + i18n.changeLanguage(locale) + const welcomeText = req.args["welcome-text"] || (i18n.t("WELCOME", { app: req.args["app-name"] }) as string) + + // Determine password message using i18n + let passwordMsg = i18n.t("LOGIN_PASSWORD") + if (req.args.usingEnvPassword) { + passwordMsg = i18n.t("LOGIN_USING_ENV_PASSWORD") + } else if (req.args.usingEnvHashedPassword) { + passwordMsg = i18n.t("LOGIN_USING_HASHED_PASSWORD") + } + + return replaceTemplates( + req, + content + .replace(/{{I18N_LOGIN_TITLE}}/g, i18n.t("LOGIN_TITLE", { app: req.args["app-name"] })) + .replace(/{{WELCOME_TEXT}}/g, welcomeText) + .replace(/{{PASSWORD_MSG}}/g, passwordMsg) + .replace(/{{I18N_LOGIN_BELOW}}/g, i18n.t("LOGIN_BELOW")) + .replace(/{{I18N_PASSWORD_PLACEHOLDER}}/g, i18n.t("PASSWORD_PLACEHOLDER")) + .replace(/{{I18N_SUBMIT}}/g, i18n.t("SUBMIT")) + .replace(/{{ERROR}}/, error ? `
${escapeHtml(error.message)}
` : ""), + ) +} + +const limiter = new RateLimiter() + +export const router = Router() + +router.use(async (req, res, next) => { + const to = (typeof req.query.to === "string" && req.query.to) || "/" + if (await authenticated(req)) { + return redirect(req, res, to, { to: undefined }) + } + next() +}) + +router.get("/", async (req, res) => { + res.send(await getRoot(req)) +}) + +router.post<{}, string, { password?: string; base?: string } | undefined, { to?: string }>("/", async (req, res) => { + const password = sanitizeString(req.body?.password) + const hashedPasswordFromArgs = req.args["hashed-password"] + + try { + // Check to see if they exceeded their login attempts + if (!limiter.canTry()) { + throw new Error(i18n.t("LOGIN_RATE_LIMIT") as string) + } + + if (!password) { + throw new Error(i18n.t("MISS_PASSWORD") as string) + } + + const passwordMethod = getPasswordMethod(hashedPasswordFromArgs) + const { isPasswordValid, hashedPassword } = await handlePasswordValidation({ + passwordMethod, + hashedPasswordFromArgs, + passwordFromRequestBody: password, + passwordFromArgs: req.args.password, + }) + + if (isPasswordValid) { + // The hash does not add any actual security but we do it for + // obfuscation purposes (and as a side effect it handles escaping). + res.cookie(req.cookieSessionName, hashedPassword, getCookieOptions(req)) + + const to = (typeof req.query.to === "string" && req.query.to) || "/" + return redirect(req, res, to, { to: undefined }) + } + + // Note: successful logins should not count against the RateLimiter + // which is why this logic must come after the successful login logic + limiter.removeToken() + + console.error( + "Failed login attempt", + JSON.stringify({ + xForwardedFor: req.headers["x-forwarded-for"], + remoteAddress: req.connection.remoteAddress, + userAgent: req.headers["user-agent"], + timestamp: Math.floor(new Date().getTime() / 1000), + }), + ) + + throw new Error(i18n.t("INCORRECT_PASSWORD") as string) + } catch (error: any) { + const renderedHtml = await getRoot(req, error) + res.send(renderedHtml) + } +}) diff --git a/src/node/routes/logout.ts b/src/node/routes/logout.ts new file mode 100644 index 000000000000..425b3ce17c8f --- /dev/null +++ b/src/node/routes/logout.ts @@ -0,0 +1,13 @@ +import { Router } from "express" +import { getCookieOptions, redirect } from "../http" +import { sanitizeString } from "../util" + +export const router = Router() + +router.get<{}, undefined, undefined, { base?: string; to?: string }>("/", async (req, res) => { + // Must use the *identical* properties used to set the cookie. + res.clearCookie(req.cookieSessionName, getCookieOptions(req)) + + const to = sanitizeString(req.query.to) || "/" + return redirect(req, res, to, { to: undefined, base: undefined, href: undefined }) +}) diff --git a/src/node/routes/pathProxy.ts b/src/node/routes/pathProxy.ts new file mode 100644 index 000000000000..4f84b3f87e71 --- /dev/null +++ b/src/node/routes/pathProxy.ts @@ -0,0 +1,78 @@ +import { Request, Response } from "express" +import * as path from "path" +import { HttpCode, HttpError } from "../../common/http" +import { ensureProxyEnabled, authenticated, ensureAuthenticated, ensureOrigin, redirect, self } from "../http" +import { proxy as _proxy } from "../proxy" +import type { WebsocketRequest } from "../wsRouter" + +const getProxyTarget = ( + req: Request, + opts?: { + proxyBasePath?: string + }, +): string => { + // If there is a base path, strip it out. + const base = (req as any).base || "" + // Cast since we only have one port param. + const port = parseInt(req.params.port as string, 10) + if (isNaN(port)) { + throw new HttpError("Invalid port", HttpCode.BadRequest) + } + return `http://0.0.0.0:${port}${opts?.proxyBasePath || ""}/${req.originalUrl.slice(base.length)}` +} + +export async function proxy( + req: Request, + res: Response, + opts?: { + passthroughPath?: boolean + proxyBasePath?: string + }, +): Promise { + ensureProxyEnabled(req) + + if (req.method === "OPTIONS" && req.args["skip-auth-preflight"]) { + // Allow preflight requests with `skip-auth-preflight` flag + } else if (!(await authenticated(req))) { + // If visiting the root (/:port only) redirect to the login page. + if (!req.params.path || req.params.path === "/") { + const to = self(req) + return redirect(req, res, "login", { + to: to !== "/" ? to : undefined, + }) + } + throw new HttpError("Unauthorized", HttpCode.Unauthorized) + } + + // The base is used for rewriting (redirects, target). + if (!opts?.passthroughPath) { + ;(req as any).base = req.path.split(path.sep).slice(0, 3).join(path.sep) + } + + _proxy.web(req, res, { + ignorePath: true, + target: getProxyTarget(req, opts), + }) +} + +export async function wsProxy( + req: WebsocketRequest, + opts?: { + passthroughPath?: boolean + proxyBasePath?: string + }, +): Promise { + ensureProxyEnabled(req) + ensureOrigin(req) + await ensureAuthenticated(req) + + // The base is used for rewriting (redirects, target). + if (!opts?.passthroughPath) { + ;(req as any).base = req.path.split(path.sep).slice(0, 3).join(path.sep) + } + + _proxy.ws(req, req.ws, req.head, { + ignorePath: true, + target: getProxyTarget(req, opts), + }) +} diff --git a/src/node/routes/update.ts b/src/node/routes/update.ts new file mode 100644 index 000000000000..60d2011eae72 --- /dev/null +++ b/src/node/routes/update.ts @@ -0,0 +1,15 @@ +import { Router } from "express" +import { version } from "../constants" +import { ensureAuthenticated } from "../http" + +export const router = Router() + +router.get("/check", ensureAuthenticated, async (req, res) => { + const update = await req.updater.getUpdate(req.query.force === "true") + res.json({ + checked: update.checked, + latest: update.version, + current: version, + isLatest: req.updater.isLatestVersion(update), + }) +}) diff --git a/src/node/routes/vscode.ts b/src/node/routes/vscode.ts new file mode 100644 index 000000000000..f8c048c6f036 --- /dev/null +++ b/src/node/routes/vscode.ts @@ -0,0 +1,258 @@ +import { logger } from "@coder/logger" +import * as crypto from "crypto" +import * as express from "express" +import { promises as fs } from "fs" +import * as http from "http" +import * as net from "net" +import * as os from "os" +import * as path from "path" +import { logError } from "../../common/util" +import { CodeArgs, toCodeArgs } from "../cli" +import { isDevMode, vsRootPath } from "../constants" +import { authenticated, ensureAuthenticated, ensureOrigin, redirect, replaceTemplates, self } from "../http" +import { SocketProxyProvider } from "../socket" +import { isFile } from "../util" +import { type WebsocketRequest, Router as WsRouter } from "../wsRouter" + +export const router = express.Router() + +export const wsRouter = WsRouter() + +/** + * The API of VS Code's web client server. code-server delegates requests to VS + * Code here. + * + * @see ../../../lib/vscode/src/vs/server/node/server.main.ts:72 + */ +export interface IVSCodeServerAPI { + handleRequest(req: http.IncomingMessage, res: http.ServerResponse): Promise + handleUpgrade(req: http.IncomingMessage, socket: net.Socket): void + handleServerError(err: Error): void + dispose(): void +} + +/** + * VS Code's CLI entrypoint (../../../lib/vscode/src/server-main.js). + * + * Normally VS Code will run `node server-main.js` which starts either the web + * server or the CLI (for installing extensions, etc) but we patch it so we can + * `require` it and call its functions directly in order to integrate with our + * web server. + */ +export type VSCodeModule = { + // See ../../../lib/vscode/src/server-main.js:339. + loadCodeWithNls(): Promise<{ + // See ../../../lib/vscode/src/vs/server/node/server.main.ts:72. + createServer(address: string | net.AddressInfo | null, args: CodeArgs): Promise + // See ../../../lib/vscode/src/vs/server/node/server.main.ts:65. + spawnCli(args: CodeArgs): Promise + }> +} + +/** + * Load then create the VS Code server. + */ +async function loadVSCode(req: express.Request): Promise { + // Since server-main.js is an ES module, we have to use `import`. However, + // tsc will transpile this to `require` unless we change our module type, + // which will also require that we switch to ESM, since a hybrid approach + // breaks importing `rotating-file-stream` for some reason. To work around + // this, use `eval` for now, but we should consider switching to ESM. + let modPath = path.join(vsRootPath, "out/server-main.js") + if (os.platform() === "win32") { + // On Windows, absolute paths of ESM modules must be a valid file URI. + modPath = "file:///" + modPath.replace(/\\/g, "/") + } + const mod = (await eval(`import("${modPath}")`)) as VSCodeModule + const serverModule = await mod.loadCodeWithNls() + return serverModule.createServer(null, { + ...(await toCodeArgs(req.args)), + "accept-server-license-terms": true, + // This seems to be used to make the connection token flags optional (when + // set to 1.63) but we have always included them. + compatibility: "1.64", + "without-connection-token": true, + }) +} + +// To prevent loading the module more than once at a time. We also have the +// resolved value so you do not need to `await` everywhere. +let vscodeServerPromise: Promise | undefined + +// The resolved value from the dynamically loaded VS Code server. Do not use +// without first calling and awaiting `ensureCodeServerLoaded`. +let vscodeServer: IVSCodeServerAPI | undefined + +/** + * Ensure the VS Code server is loaded. + */ +export const ensureVSCodeLoaded = async ( + req: express.Request, + _: express.Response, + next: express.NextFunction, +): Promise => { + if (vscodeServer) { + return next() + } + if (!vscodeServerPromise) { + vscodeServerPromise = loadVSCode(req) + } + try { + vscodeServer = await vscodeServerPromise + } catch (error) { + vscodeServerPromise = undefined // Unset so we can try again. + logError(logger, "CodeServerRouteWrapper", error) + if (isDevMode) { + return next( + new Error( + (error instanceof Error ? error.message : error) + + " (Have you applied the patches? If so, VS Code may still be compiling)", + ), + ) + } + return next(error) + } + return next() +} + +router.get("/", ensureVSCodeLoaded, async (req, res, next) => { + const isAuthenticated = await authenticated(req) + const NO_FOLDER_OR_WORKSPACE_QUERY = !req.query.folder && !req.query.workspace + // Ew means the workspace was closed so clear the last folder/workspace. + const FOLDER_OR_WORKSPACE_WAS_CLOSED = req.query.ew + + if (!isAuthenticated) { + const to = self(req) + return redirect(req, res, "login", { + to: to !== "/" ? to : undefined, + }) + } + + if (NO_FOLDER_OR_WORKSPACE_QUERY && !FOLDER_OR_WORKSPACE_WAS_CLOSED) { + const settings = await req.settings.read() + const lastOpened = settings.query || {} + // This flag disables the last opened behavior + const IGNORE_LAST_OPENED = req.args["ignore-last-opened"] + const HAS_LAST_OPENED_FOLDER_OR_WORKSPACE = lastOpened.folder || lastOpened.workspace + const HAS_FOLDER_OR_WORKSPACE_FROM_CLI = req.args._.length > 0 + const to = self(req) + + let folder = undefined + let workspace = undefined + + // Redirect to the last folder/workspace if nothing else is opened. + if (HAS_LAST_OPENED_FOLDER_OR_WORKSPACE && !IGNORE_LAST_OPENED) { + folder = lastOpened.folder + workspace = lastOpened.workspace + } else if (HAS_FOLDER_OR_WORKSPACE_FROM_CLI) { + const lastEntry = path.resolve(req.args._[req.args._.length - 1]) + const entryIsFile = await isFile(lastEntry) + const IS_WORKSPACE_FILE = entryIsFile && path.extname(lastEntry) === ".code-workspace" + + if (IS_WORKSPACE_FILE) { + workspace = lastEntry + } else if (!entryIsFile) { + folder = lastEntry + } + } + + if (folder || workspace) { + return redirect(req, res, to, { + folder, + workspace, + }) + } + } + + // Store the query parameters so we can use them on the next load. This + // also allows users to create functionality around query parameters. + await req.settings.write({ query: req.query }) + + next() +}) + +router.get("/manifest.json", async (req, res) => { + res.writeHead(200, { "Content-Type": "application/manifest+json" }) + + res.end( + replaceTemplates( + req, + JSON.stringify( + { + name: req.args["app-name"], + short_name: req.args["app-name"], + start_url: ".", + display: "fullscreen", + display_override: ["window-controls-overlay"], + description: "Run Code on a remote server.", + icons: [192, 512] + .map((size) => [ + { + src: `{{BASE}}/_static/src/browser/media/pwa-icon-${size}.png`, + type: "image/png", + sizes: `${size}x${size}`, + purpose: "any", + }, + { + src: `{{BASE}}/_static/src/browser/media/pwa-icon-maskable-${size}.png`, + type: "image/png", + sizes: `${size}x${size}`, + purpose: "maskable", + }, + ]) + .flat(), + }, + null, + 2, + ), + ), + ) +}) + +let mintKeyPromise: Promise | undefined +router.post("/mint-key", ensureAuthenticated, async (req, res) => { + if (!mintKeyPromise) { + mintKeyPromise = new Promise(async (resolve) => { + const keyPath = path.join(req.args["user-data-dir"], "serve-web-key-half") + logger.debug(`Reading server web key half from ${keyPath}`) + try { + resolve(await fs.readFile(keyPath)) + return + } catch (error: any) { + if (error.code !== "ENOENT") { + logError(logger, `read ${keyPath}`, error) + } + } + // VS Code wants 256 bits. + const key = crypto.randomBytes(32) + try { + await fs.writeFile(keyPath, key) + } catch (error: any) { + logError(logger, `write ${keyPath}`, error) + } + resolve(key) + }) + } + const key = await mintKeyPromise + res.end(key) +}) + +router.all(/.*/, ensureAuthenticated, ensureVSCodeLoaded, async (req, res) => { + vscodeServer!.handleRequest(req, res) +}) + +const socketProxyProvider = new SocketProxyProvider() +wsRouter.ws(/.*/, ensureOrigin, ensureAuthenticated, ensureVSCodeLoaded, async (req: WebsocketRequest) => { + const wrappedSocket = await socketProxyProvider.createProxy(req.ws) + // This should actually accept a duplex stream but it seems Code has not + // been updated to match the Node 16 types so cast for now. There does not + // appear to be any code specific to sockets so this should be fine. + vscodeServer!.handleUpgrade(req, wrappedSocket as net.Socket) + + req.ws.resume() +}) + +export function dispose() { + vscodeServer?.dispose() + socketProxyProvider.stop() +} diff --git a/src/node/server.ts b/src/node/server.ts deleted file mode 100644 index 0c0541b8a356..000000000000 --- a/src/node/server.ts +++ /dev/null @@ -1,813 +0,0 @@ -import * as crypto from "crypto"; -import * as fs from "fs"; -import * as http from "http"; -import * as https from "https"; -import * as net from "net"; -import * as path from "path"; -import * as querystring from "querystring"; -import { Readable } from "stream"; -import * as tls from "tls"; -import * as url from "url"; -import * as util from "util"; -import { Emitter } from "vs/base/common/event"; -import { sanitizeFilePath } from "vs/base/common/extpath"; -import { Schemas } from "vs/base/common/network"; -import { URI, UriComponents } from "vs/base/common/uri"; -import { generateUuid } from "vs/base/common/uuid"; -import { getMachineId } from 'vs/base/node/id'; -import { NLSConfiguration } from "vs/base/node/languagePacks"; -import { mkdirp, rimraf } from "vs/base/node/pfs"; -import { ClientConnectionEvent, IPCServer, StaticRouter } from "vs/base/parts/ipc/common/ipc"; -import { LogsDataCleaner } from "vs/code/electron-browser/sharedProcess/contrib/logsDataCleaner"; -import { IConfigurationService } from "vs/platform/configuration/common/configuration"; -import { ConfigurationService } from "vs/platform/configuration/node/configurationService"; -import { ExtensionHostDebugBroadcastChannel } from "vs/platform/debug/common/extensionHostDebugIpc"; -import { IDialogService } from "vs/platform/dialogs/common/dialogs"; -import { DialogChannelClient } from "vs/platform/dialogs/node/dialogIpc"; -import { IEnvironmentService, ParsedArgs } from "vs/platform/environment/common/environment"; -import { EnvironmentService } from "vs/platform/environment/node/environmentService"; -import { ExtensionGalleryService } from "vs/platform/extensionManagement/common/extensionGalleryService"; -import { IExtensionGalleryService, IExtensionManagementService } from "vs/platform/extensionManagement/common/extensionManagement"; -import { ExtensionManagementChannel } from "vs/platform/extensionManagement/common/extensionManagementIpc"; -import { ExtensionManagementService } from "vs/platform/extensionManagement/node/extensionManagementService"; -import { IFileService } from "vs/platform/files/common/files"; -import { FileService } from "vs/platform/files/common/fileService"; -import { DiskFileSystemProvider } from "vs/platform/files/node/diskFileSystemProvider"; -import { SyncDescriptor } from "vs/platform/instantiation/common/descriptors"; -import { InstantiationService } from "vs/platform/instantiation/common/instantiationService"; -import { ServiceCollection } from "vs/platform/instantiation/common/serviceCollection"; -import { ILocalizationsService } from "vs/platform/localizations/common/localizations"; -import { LocalizationsService } from "vs/platform/localizations/node/localizations"; -import { LocalizationsChannel } from "vs/platform/localizations/node/localizationsIpc"; -import { getLogLevel, ILogService } from "vs/platform/log/common/log"; -import { LogLevelSetterChannel } from "vs/platform/log/common/logIpc"; -import { SpdLogService } from "vs/platform/log/node/spdlogService"; -import { IProductService } from "vs/platform/product/common/product"; -import pkg from "vs/platform/product/node/package"; -import product from "vs/platform/product/node/product"; -import { ConnectionType, ConnectionTypeRequest } from "vs/platform/remote/common/remoteAgentConnection"; -import { REMOTE_FILE_SYSTEM_CHANNEL_NAME } from "vs/platform/remote/common/remoteAgentFileSystemChannel"; -import { IRequestService } from "vs/platform/request/common/request"; -import { RequestChannel } from "vs/platform/request/common/requestIpc"; -import { RequestService } from "vs/platform/request/node/requestService"; -import ErrorTelemetry from "vs/platform/telemetry/browser/errorTelemetry"; -import { ITelemetryService } from "vs/platform/telemetry/common/telemetry"; -import { ITelemetryServiceConfig, TelemetryService } from "vs/platform/telemetry/common/telemetryService"; -import { combinedAppender, LogAppender, NullTelemetryService } from "vs/platform/telemetry/common/telemetryUtils"; -import { AppInsightsAppender } from "vs/platform/telemetry/node/appInsightsAppender"; -import { resolveCommonProperties } from "vs/platform/telemetry/node/commonProperties"; -import { UpdateChannel } from "vs/platform/update/node/updateIpc"; -import { ExtensionEnvironmentChannel, FileProviderChannel, NodeProxyService } from "vs/server/src/node/channel"; -import { Connection, ExtensionHostConnection, ManagementConnection } from "vs/server/src/node/connection"; -import { TelemetryClient } from "vs/server/src/node/insights"; -import { getLocaleFromConfig, getNlsConfiguration } from "vs/server/src/node/nls"; -import { NodeProxyChannel, INodeProxyService } from "vs/server/src/common/nodeProxy"; -import { Protocol } from "vs/server/src/node/protocol"; -import { TelemetryChannel } from "vs/server/src/common/telemetry"; -import { UpdateService } from "vs/server/src/node/update"; -import { AuthType, getMediaMime, getUriTransformer, localRequire, tmpdir } from "vs/server/src/node/util"; -import { RemoteExtensionLogFileName } from "vs/workbench/services/remote/common/remoteAgentService"; -import { IWorkbenchConstructionOptions } from "vs/workbench/workbench.web.api"; - -const tarFs = localRequire("tar-fs/index"); - -export enum HttpCode { - Ok = 200, - Redirect = 302, - NotFound = 404, - BadRequest = 400, - Unauthorized = 401, - LargePayload = 413, - ServerError = 500, -} - -export interface Options { - WORKBENCH_WEB_CONGIGURATION: IWorkbenchConstructionOptions; - REMOTE_USER_DATA_URI: UriComponents | URI; - NLS_CONFIGURATION: NLSConfiguration; -} - -export interface Response { - cache?: boolean; - code?: number; - content?: string | Buffer; - filePath?: string; - headers?: http.OutgoingHttpHeaders; - mime?: string; - redirect?: string; - stream?: Readable; -} - -export interface LoginPayload { - password?: string; -} - -export class HttpError extends Error { - public constructor(message: string, public readonly code: number) { - super(message); - // @ts-ignore - this.name = this.constructor.name; - Error.captureStackTrace(this, this.constructor); - } -} - -export interface ServerOptions { - readonly auth?: AuthType; - readonly basePath?: string; - readonly connectionToken?: string; - readonly cert?: string; - readonly certKey?: string; - readonly folderUri?: string; - readonly host?: string; - readonly password?: string; - readonly port?: number; - readonly socket?: string; -} - -export abstract class Server { - protected readonly server: http.Server | https.Server; - protected rootPath = path.resolve(__dirname, "../../../../.."); - protected serverRoot = path.join(this.rootPath, "/out/vs/server/src"); - protected readonly allowedRequestPaths: string[] = [this.rootPath]; - private listenPromise: Promise | undefined; - public readonly protocol: "http" | "https"; - public readonly options: ServerOptions; - - public constructor(options: ServerOptions) { - this.options = { - host: options.auth && options.cert ? "0.0.0.0" : "localhost", - ...options, - basePath: options.basePath ? options.basePath.replace(/\/+$/, "") : "", - }; - this.protocol = this.options.cert ? "https" : "http"; - if (this.protocol === "https") { - const httpolyglot = localRequire("httpolyglot/lib/index"); - this.server = httpolyglot.createServer({ - cert: this.options.cert && fs.readFileSync(this.options.cert), - key: this.options.certKey && fs.readFileSync(this.options.certKey), - }, this.onRequest); - } else { - this.server = http.createServer(this.onRequest); - } - } - - public listen(): Promise { - if (!this.listenPromise) { - this.listenPromise = new Promise((resolve, reject) => { - this.server.on("error", reject); - this.server.on("upgrade", this.onUpgrade); - const onListen = () => resolve(this.address()); - if (this.options.socket) { - this.server.listen(this.options.socket, onListen); - } else { - this.server.listen(this.options.port, this.options.host, onListen); - } - }); - } - return this.listenPromise; - } - - /** - * The *local* address of the server. - */ - public address(): string { - const address = this.server.address(); - const endpoint = typeof address !== "string" - ? (address.address === "::" ? "localhost" : address.address) + ":" + address.port - : address; - return `${this.protocol}://${endpoint}`; - } - - protected abstract handleWebSocket( - socket: net.Socket, - parsedUrl: url.UrlWithParsedQuery - ): Promise; - - protected abstract handleRequest( - base: string, - requestPath: string, - parsedUrl: url.UrlWithParsedQuery, - request: http.IncomingMessage, - ): Promise; - - protected async getResource(...parts: string[]): Promise { - const filePath = this.ensureAuthorizedFilePath(...parts); - return { content: await util.promisify(fs.readFile)(filePath), filePath }; - } - - protected async getTarredResource(...parts: string[]): Promise { - const filePath = this.ensureAuthorizedFilePath(...parts); - return { stream: tarFs.pack(filePath), filePath, mime: "application/tar" }; - } - - protected ensureAuthorizedFilePath(...parts: string[]): string { - const filePath = path.join(...parts); - if (!this.isAllowedRequestPath(filePath)) { - throw new HttpError("Unauthorized", HttpCode.Unauthorized); - } - return filePath; - } - - protected withBase(request: http.IncomingMessage, path: string): string { - const split = request.url ? request.url.split("?", 2) : []; - return `${this.protocol}://${request.headers.host}${this.options.basePath}${path}${split.length === 2 ? `?${split[1]}` : ""}`; - } - - private isAllowedRequestPath(path: string): boolean { - for (let i = 0; i < this.allowedRequestPaths.length; ++i) { - if (path.indexOf(this.allowedRequestPaths[i]) === 0) { - return true; - } - } - return false; - } - - private onRequest = async (request: http.IncomingMessage, response: http.ServerResponse): Promise => { - try { - const parsedUrl = request.url ? url.parse(request.url, true) : { query: {}}; - const payload = await this.preHandleRequest(request, parsedUrl); - response.writeHead(payload.redirect ? HttpCode.Redirect : payload.code || HttpCode.Ok, { - "Content-Type": payload.mime || getMediaMime(payload.filePath), - ...(payload.redirect ? { Location: this.withBase(request, payload.redirect) } : {}), - ...(request.headers["service-worker"] ? { "Service-Worker-Allowed": this.options.basePath || "/" } : {}), - ...(payload.cache ? { "Cache-Control": "public, max-age=31536000" } : {}), - ...payload.headers, - }); - if (payload.stream) { - payload.stream.on("error", (error: NodeJS.ErrnoException) => { - response.writeHead(error.code === "ENOENT" ? HttpCode.NotFound : HttpCode.ServerError); - response.end(error.message); - }); - payload.stream.pipe(response); - } else { - response.end(payload.content); - } - } catch (error) { - if (error.code === "ENOENT" || error.code === "EISDIR") { - error = new HttpError("Not found", HttpCode.NotFound); - } - response.writeHead(typeof error.code === "number" ? error.code : HttpCode.ServerError); - response.end(error.message); - } - } - - private async preHandleRequest(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise { - const secure = (request.connection as tls.TLSSocket).encrypted; - if (this.options.cert && !secure) { - return { redirect: request.url }; - } - - const fullPath = decodeURIComponent(parsedUrl.pathname || "/"); - const match = fullPath.match(/^(\/?[^/]*)(.*)$/); - let [/* ignore */, base, requestPath] = match - ? match.map((p) => p.replace(/\/+$/, "")) - : ["", "", ""]; - if (base.indexOf(".") !== -1) { // Assume it's a file at the root. - requestPath = base; - base = "/"; - } else if (base === "") { // Happens if it's a plain `domain.com`. - base = "/"; - } - base = path.normalize(base); - requestPath = path.normalize(requestPath || "/index.html"); - - if (base !== "/login" || !this.options.auth || requestPath !== "/index.html") { - this.ensureGet(request); - } - - // Allow for a versioned static endpoint. This lets us cache every static - // resource underneath the path based on the version without any work and - // without adding query parameters which have their own issues. - // REVIEW: Discuss whether this is the best option; this is sort of a quick - // hack almost to get caching in the meantime but it does work pretty well. - if (/^\/static-.+/.test(base)) { - base = "/static"; - } - - switch (base) { - case "/": - switch (requestPath) { - case "/favicon.ico": - case "/manifest.json": - const response = await this.getResource(this.serverRoot, "media", requestPath); - response.cache = true; - return response; - } - if (!this.authenticate(request)) { - return { redirect: "/login" }; - } - break; - case "/static": - const response = await this.getResource(this.rootPath, requestPath); - response.cache = true; - return response; - case "/login": - if (!this.options.auth || requestPath !== "/index.html") { - throw new HttpError("Not found", HttpCode.NotFound); - } - return this.tryLogin(request); - default: - if (!this.authenticate(request)) { - throw new HttpError("Unauthorized", HttpCode.Unauthorized); - } - break; - } - - return this.handleRequest(base, requestPath, parsedUrl, request); - } - - private onUpgrade = async (request: http.IncomingMessage, socket: net.Socket): Promise => { - try { - await this.preHandleWebSocket(request, socket); - } catch (error) { - socket.destroy(); - console.error(error.message); - } - } - - private preHandleWebSocket(request: http.IncomingMessage, socket: net.Socket): Promise { - socket.on("error", () => socket.destroy()); - socket.on("end", () => socket.destroy()); - - this.ensureGet(request); - if (!this.authenticate(request)) { - throw new HttpError("Unauthorized", HttpCode.Unauthorized); - } else if (!request.headers.upgrade || request.headers.upgrade.toLowerCase() !== "websocket") { - throw new Error("HTTP/1.1 400 Bad Request"); - } - - // This magic value is specified by the websocket spec. - const magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; - const reply = crypto.createHash("sha1") - .update(request.headers["sec-websocket-key"] + magic) - .digest("base64"); - socket.write([ - "HTTP/1.1 101 Switching Protocols", - "Upgrade: websocket", - "Connection: Upgrade", - `Sec-WebSocket-Accept: ${reply}`, - ].join("\r\n") + "\r\n\r\n"); - - const parsedUrl = request.url ? url.parse(request.url, true) : { query: {}}; - return this.handleWebSocket(socket, parsedUrl); - } - - private async tryLogin(request: http.IncomingMessage): Promise { - if (this.authenticate(request) && (request.method === "GET" || request.method === "POST")) { - return { redirect: "/" }; - } - if (request.method === "POST") { - const data = await this.getData(request); - if (this.authenticate(request, data)) { - return { - redirect: "/", - headers: {"Set-Cookie": `password=${data.password}` } - }; - } - console.error("Failed login attempt", JSON.stringify({ - xForwardedFor: request.headers["x-forwarded-for"], - remoteAddress: request.connection.remoteAddress, - userAgent: request.headers["user-agent"], - timestamp: Math.floor(new Date().getTime() / 1000), - })); - return this.getLogin("Invalid password", data); - } - this.ensureGet(request); - return this.getLogin(); - } - - private async getLogin(error: string = "", payload?: LoginPayload): Promise { - const filePath = path.join(this.serverRoot, "login/index.html"); - const content = (await util.promisify(fs.readFile)(filePath, "utf8")) - .replace("{{ERROR}}", error) - .replace("display:none", error ? "display:block" : "display:none") - .replace('value=""', `value="${payload && payload.password || ""}"`); - return { content, filePath }; - } - - private ensureGet(request: http.IncomingMessage): void { - if (request.method !== "GET") { - throw new HttpError(`Unsupported method ${request.method}`, HttpCode.BadRequest); - } - } - - private getData(request: http.IncomingMessage): Promise { - return request.method === "POST" - ? new Promise((resolve, reject) => { - let body = ""; - const onEnd = (): void => { - off(); - resolve(querystring.parse(body) as T); - }; - const onError = (error: Error): void => { - off(); - reject(error); - }; - const onData = (d: Buffer): void => { - body += d; - if (body.length > 1e6) { - onError(new HttpError("Payload is too large", HttpCode.LargePayload)); - request.connection.destroy(); - } - }; - const off = (): void => { - request.off("error", onError); - request.off("data", onError); - request.off("end", onEnd); - }; - request.on("error", onError); - request.on("data", onData); - request.on("end", onEnd); - }) - : Promise.resolve({} as T); - } - - private authenticate(request: http.IncomingMessage, payload?: LoginPayload): boolean { - if (!this.options.auth) { - return true; - } - const safeCompare = localRequire("safe-compare/index"); - if (typeof payload === "undefined") { - payload = this.parseCookies(request); - } - return !!this.options.password && safeCompare(payload.password || "", this.options.password); - } - - private parseCookies(request: http.IncomingMessage): T { - const cookies: { [key: string]: string } = {}; - if (request.headers.cookie) { - request.headers.cookie.split(";").forEach((keyValue) => { - const [key, value] = keyValue.split("=", 2); - cookies[key.trim()] = decodeURI(value); - }); - } - return cookies as T; - } -} - -export class MainServer extends Server { - public readonly _onDidClientConnect = new Emitter(); - public readonly onDidClientConnect = this._onDidClientConnect.event; - private readonly ipc = new IPCServer(this.onDidClientConnect); - - private readonly maxExtraOfflineConnections = 0; - private readonly connections = new Map>(); - - private readonly services = new ServiceCollection(); - private readonly servicesPromise: Promise; - - public readonly _onProxyConnect = new Emitter(); - private proxyPipe = path.join(tmpdir, "tls-proxy"); - private _proxyServer?: Promise; - private readonly proxyTimeout = 5000; - - public constructor(options: ServerOptions, args: ParsedArgs) { - super(options); - this.servicesPromise = this.initializeServices(args); - } - - public async listen(): Promise { - const environment = (this.services.get(IEnvironmentService) as EnvironmentService); - const [address] = await Promise.all([ - super.listen(), ...[ - environment.extensionsPath, - ].map((p) => mkdirp(p).then(() => p)), - ]); - return address; - } - - protected async handleWebSocket(socket: net.Socket, parsedUrl: url.UrlWithParsedQuery): Promise { - if (!parsedUrl.query.reconnectionToken) { - throw new Error("Reconnection token is missing from query parameters"); - } - const protocol = new Protocol(await this.createProxy(socket), { - reconnectionToken: parsedUrl.query.reconnectionToken, - reconnection: parsedUrl.query.reconnection === "true", - skipWebSocketFrames: parsedUrl.query.skipWebSocketFrames === "true", - }); - try { - await this.connect(await protocol.handshake(), protocol); - } catch (error) { - protocol.sendMessage({ type: "error", reason: error.message }); - protocol.dispose(); - protocol.getSocket().dispose(); - } - } - - protected async handleRequest( - base: string, - requestPath: string, - parsedUrl: url.UrlWithParsedQuery, - request: http.IncomingMessage, - ): Promise { - switch (base) { - case "/": return this.getRoot(request, parsedUrl); - case "/resource": - case "/vscode-remote-resource": - if (typeof parsedUrl.query.path === "string") { - return this.getResource(parsedUrl.query.path); - } - break; - case "/tar": - if (typeof parsedUrl.query.path === "string") { - return this.getTarredResource(parsedUrl.query.path); - } - break; - case "/webview": - if (requestPath.indexOf("/vscode-resource") === 0) { - return this.getResource(requestPath.replace(/^\/vscode-resource/, "")); - } - return this.getResource( - this.rootPath, - "out/vs/workbench/contrib/webview/browser/pre", - requestPath - ); - } - throw new HttpError("Not found", HttpCode.NotFound); - } - - private async getRoot(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise { - const filePath = path.join(this.rootPath, "out/vs/code/browser/workbench/workbench.html"); - let [content] = await Promise.all([ - util.promisify(fs.readFile)(filePath, "utf8"), - this.servicesPromise, - ]); - - const logger = this.services.get(ILogService) as ILogService; - logger.info("request.url", `"${request.url}"`); - - const cwd = process.env.VSCODE_CWD || process.cwd(); - - const remoteAuthority = request.headers.host as string; - const transformer = getUriTransformer(remoteAuthority); - const validatePath = async (filePath: string[] | string | undefined, isDirectory: boolean, unsetFallback?: string): Promise => { - if (!filePath || filePath.length === 0) { - if (!unsetFallback) { - return undefined; - } - filePath = unsetFallback; - } else if (Array.isArray(filePath)) { - filePath = filePath[0]; - } - const uri = URI.file(sanitizeFilePath(filePath, cwd)); - try { - const stat = await util.promisify(fs.stat)(uri.fsPath); - if (isDirectory !== stat.isDirectory()) { - return undefined; - } - } catch (error) { - return undefined; - } - return transformer.transformOutgoing(uri); - }; - - const environment = this.services.get(IEnvironmentService) as IEnvironmentService; - const options: Options = { - WORKBENCH_WEB_CONGIGURATION: { - workspaceUri: await validatePath(parsedUrl.query.workspace, false), - folderUri: !parsedUrl.query.workspace ? await validatePath(parsedUrl.query.folder, true, this.options.folderUri) : undefined, - remoteAuthority, - productConfiguration: product, - }, - REMOTE_USER_DATA_URI: transformer.transformOutgoing((environment).webUserDataHome), - NLS_CONFIGURATION: await getNlsConfiguration(environment.args.locale || await getLocaleFromConfig(environment.userDataPath), environment.userDataPath), - }; - - content = content.replace(/\/static\//g, `/static${product.commit ? `-${product.commit}` : ""}/`).replace("{{WEBVIEW_ENDPOINT}}", ""); - for (const key in options) { - content = content.replace(`"{{${key}}}"`, `'${JSON.stringify(options[key as keyof Options])}'`); - } - - return { content, filePath }; - } - - private async connect(message: ConnectionTypeRequest, protocol: Protocol): Promise { - if (product.commit && message.commit !== product.commit) { - throw new Error(`Version mismatch (${message.commit} instead of ${product.commit})`); - } - - switch (message.desiredConnectionType) { - case ConnectionType.ExtensionHost: - case ConnectionType.Management: - if (!this.connections.has(message.desiredConnectionType)) { - this.connections.set(message.desiredConnectionType, new Map()); - } - const connections = this.connections.get(message.desiredConnectionType)!; - - const ok = async () => { - return message.desiredConnectionType === ConnectionType.ExtensionHost - ? { debugPort: await this.getDebugPort() } - : { type: "ok" }; - }; - - const token = protocol.options.reconnectionToken; - if (protocol.options.reconnection && connections.has(token)) { - protocol.sendMessage(await ok()); - const buffer = protocol.readEntireBuffer(); - protocol.dispose(); - return connections.get(token)!.reconnect(protocol.getSocket(), buffer); - } else if (protocol.options.reconnection || connections.has(token)) { - throw new Error(protocol.options.reconnection - ? "Unrecognized reconnection token" - : "Duplicate reconnection token" - ); - } - - protocol.sendMessage(await ok()); - - let connection: Connection; - if (message.desiredConnectionType === ConnectionType.Management) { - connection = new ManagementConnection(protocol, token); - this._onDidClientConnect.fire({ - protocol, onDidClientDisconnect: connection.onClose, - }); - // NOTE: We can do this because we only have one connection at a - // time but if that changes we need a way to determine which clients - // belong to a connection and dispose only those. - (this.services.get(INodeProxyService) as NodeProxyService)._onUp.fire(); - connection.onClose(() => (this.services.get(INodeProxyService) as NodeProxyService)._onDown.fire()); - } else { - const buffer = protocol.readEntireBuffer(); - connection = new ExtensionHostConnection( - message.args ? message.args.language : "en", - protocol, buffer, token, - this.services.get(ILogService) as ILogService, - this.services.get(IEnvironmentService) as IEnvironmentService, - ); - } - connections.set(token, connection); - connection.onClose(() => connections.delete(token)); - this.disposeOldOfflineConnections(connections); - break; - case ConnectionType.Tunnel: return protocol.tunnel(); - default: throw new Error("Unrecognized connection type"); - } - } - - private disposeOldOfflineConnections(connections: Map): void { - const offline = Array.from(connections.values()) - .filter((connection) => typeof connection.offline !== "undefined"); - for (let i = 0, max = offline.length - this.maxExtraOfflineConnections; i < max; ++i) { - offline[i].dispose(); - } - } - - private async initializeServices(args: ParsedArgs): Promise { - const environmentService = new EnvironmentService(args, process.execPath); - const logService = new SpdLogService(RemoteExtensionLogFileName, environmentService.logsPath, getLogLevel(environmentService)); - const fileService = new FileService(logService); - fileService.registerProvider(Schemas.file, new DiskFileSystemProvider(logService)); - - this.allowedRequestPaths.push( - path.join(environmentService.userDataPath, "clp"), // Language packs. - environmentService.extensionsPath, - environmentService.builtinExtensionsPath, - ...environmentService.extraExtensionPaths, - ...environmentService.extraBuiltinExtensionPaths, - ); - - this.ipc.registerChannel("loglevel", new LogLevelSetterChannel(logService)); - this.ipc.registerChannel(ExtensionHostDebugBroadcastChannel.ChannelName, new ExtensionHostDebugBroadcastChannel()); - - const router = new StaticRouter((ctx: any) => ctx.clientId === "renderer"); - this.services.set(ILogService, logService); - this.services.set(IEnvironmentService, environmentService); - this.services.set(IConfigurationService, new SyncDescriptor(ConfigurationService, [environmentService.machineSettingsResource])); - this.services.set(IRequestService, new SyncDescriptor(RequestService)); - this.services.set(IFileService, fileService); - this.services.set(IProductService, { _serviceBrand: undefined, ...product }); - this.services.set(IDialogService, new DialogChannelClient(this.ipc.getChannel("dialog", router))); - this.services.set(IExtensionGalleryService, new SyncDescriptor(ExtensionGalleryService)); - this.services.set(IExtensionManagementService, new SyncDescriptor(ExtensionManagementService)); - - if (!environmentService.args["disable-telemetry"]) { - this.services.set(ITelemetryService, new SyncDescriptor(TelemetryService, [{ - appender: combinedAppender( - new AppInsightsAppender("code-server", null, () => new TelemetryClient(), logService), - new LogAppender(logService), - ), - commonProperties: resolveCommonProperties( - product.commit, pkg.codeServerVersion, await getMachineId(), - [], environmentService.installSourcePath, "code-server", - ), - piiPaths: this.allowedRequestPaths, - } as ITelemetryServiceConfig])); - } else { - this.services.set(ITelemetryService, NullTelemetryService); - } - - await new Promise((resolve) => { - const instantiationService = new InstantiationService(this.services); - const localizationService = instantiationService.createInstance(LocalizationsService); - this.services.set(ILocalizationsService, localizationService); - const proxyService = instantiationService.createInstance(NodeProxyService); - this.services.set(INodeProxyService, proxyService); - this.ipc.registerChannel("localizations", new LocalizationsChannel(localizationService)); - instantiationService.invokeFunction(() => { - instantiationService.createInstance(LogsDataCleaner); - - const extensionsService = this.services.get(IExtensionManagementService) as IExtensionManagementService; - const telemetryService = this.services.get(ITelemetryService) as ITelemetryService; - - const extensionsChannel = new ExtensionManagementChannel(extensionsService, (context) => getUriTransformer(context.remoteAuthority)); - const extensionsEnvironmentChannel = new ExtensionEnvironmentChannel(environmentService, logService, telemetryService, this.options.connectionToken || ""); - const fileChannel = new FileProviderChannel(environmentService, logService); - const requestChannel = new RequestChannel(this.services.get(IRequestService) as IRequestService); - const telemetryChannel = new TelemetryChannel(telemetryService); - const updateChannel = new UpdateChannel(instantiationService.createInstance(UpdateService)); - const nodeProxyChannel = new NodeProxyChannel(proxyService); - - this.ipc.registerChannel("extensions", extensionsChannel); - this.ipc.registerChannel("remoteextensionsenvironment", extensionsEnvironmentChannel); - this.ipc.registerChannel("request", requestChannel); - this.ipc.registerChannel("telemetry", telemetryChannel); - this.ipc.registerChannel("nodeProxy", nodeProxyChannel); - this.ipc.registerChannel("update", updateChannel); - this.ipc.registerChannel(REMOTE_FILE_SYSTEM_CHANNEL_NAME, fileChannel); - resolve(new ErrorTelemetry(telemetryService)); - }); - }); - } - - /** - * TODO: implement. - */ - private async getDebugPort(): Promise { - return undefined; - } - - /** - * Since we can't pass TLS sockets to children, use this to proxy the socket - * and pass a non-TLS socket. - */ - private createProxy = async (socket: net.Socket): Promise => { - if (!(socket instanceof tls.TLSSocket)) { - return socket; - } - - await this.startProxyServer(); - - return new Promise((resolve, reject) => { - const timeout = setTimeout(() => { - listener.dispose(); - socket.destroy(); - proxy.destroy(); - reject(new Error("TLS socket proxy timed out")); - }, this.proxyTimeout); - - const listener = this._onProxyConnect.event((connection) => { - connection.once("data", (data) => { - if (!socket.destroyed && !proxy.destroyed && data.toString() === id) { - clearTimeout(timeout); - listener.dispose(); - [[proxy, socket], [socket, proxy]].forEach(([a, b]) => { - a.pipe(b); - a.on("error", () => b.destroy()); - a.on("close", () => b.destroy()); - a.on("end", () => b.end()); - }); - resolve(connection); - } - }); - }); - - const id = generateUuid(); - const proxy = net.connect(this.proxyPipe); - proxy.once("connect", () => proxy.write(id)); - }); - } - - private async startProxyServer(): Promise { - if (!this._proxyServer) { - this._proxyServer = new Promise(async (resolve) => { - this.proxyPipe = await this.findFreeSocketPath(this.proxyPipe); - await mkdirp(tmpdir); - await rimraf(this.proxyPipe); - const proxyServer = net.createServer((p) => this._onProxyConnect.fire(p)); - proxyServer.once("listening", resolve); - proxyServer.listen(this.proxyPipe); - }); - } - return this._proxyServer; - } - - private async findFreeSocketPath(basePath: string, maxTries: number = 100): Promise { - const canConnect = (path: string): Promise => { - return new Promise((resolve) => { - const socket = net.connect(path); - socket.once("error", () => resolve(false)); - socket.once("connect", () => { - socket.destroy(); - resolve(true); - }); - }); - }; - - let i = 0; - let path = basePath; - while (await canConnect(path) && i < maxTries) { - path = `${basePath}-${++i}`; - } - return path; - } -} diff --git a/src/node/settings.ts b/src/node/settings.ts new file mode 100644 index 000000000000..cc55dd5f9508 --- /dev/null +++ b/src/node/settings.ts @@ -0,0 +1,56 @@ +import { logger } from "@coder/logger" +import type { ParsedQs } from "qs" +import { promises as fs } from "fs" + +export type Settings = { [key: string]: Settings | string | boolean | number } + +/** + * Provides read and write access to settings. + */ +export class SettingsProvider { + public constructor(private readonly settingsPath: string) {} + + /** + * Read settings from the file. On a failure return last known settings and + * log a warning. + */ + public async read(): Promise { + try { + const raw = (await fs.readFile(this.settingsPath, "utf8")).trim() + return raw ? JSON.parse(raw) : ({} as T) + } catch (error: any) { + if (error.code !== "ENOENT") { + logger.warn(error.message) + } + } + return {} as T + } + + /** + * Write settings combined with current settings. On failure log a warning. + * Settings will be merged shallowly. + */ + public async write(settings: Partial): Promise { + try { + const oldSettings = await this.read() + const nextSettings = { ...oldSettings, ...settings } + await fs.writeFile(this.settingsPath, JSON.stringify(nextSettings, null, 2)) + } catch (error: any) { + logger.warn(error.message) + } + } +} + +export interface UpdateSettings { + update: { + checked: number + version: string + } +} + +/** + * Global code-server settings. + */ +export interface CoderSettings extends UpdateSettings { + query?: ParsedQs +} diff --git a/src/node/socket.ts b/src/node/socket.ts new file mode 100644 index 000000000000..7ce2068a7029 --- /dev/null +++ b/src/node/socket.ts @@ -0,0 +1,106 @@ +import { promises as fs } from "fs" +import * as net from "net" +import * as path from "path" +import * as stream from "stream" +import * as tls from "tls" +import { Emitter } from "../common/emitter" +import { generateUuid } from "../common/util" +import { canConnect, paths } from "./util" + +/** + * Provides a way to proxy a TLS socket. Can be used when you need to pass a + * socket to a child process since you can't pass the TLS socket. + */ +export class SocketProxyProvider { + private readonly onProxyConnect = new Emitter() + private proxyPipe = path.join(paths.runtime, "tls-proxy") + private _proxyServer?: Promise + private readonly proxyTimeout = 5000 + + /** + * Stop the proxy server. + */ + public stop(): void { + if (this._proxyServer) { + this._proxyServer.then((server) => server.close()) + this._proxyServer = undefined + } + } + + /** + * Create a socket proxy for TLS sockets. If it is not a TLS socket the + * original socket or stream is returned. This will spawn a proxy server on + * demand. + */ + public async createProxy(socket: tls.TLSSocket | net.Socket): Promise + public async createProxy(socket: stream.Duplex): Promise + public async createProxy(socket: tls.TLSSocket | net.Socket | stream.Duplex): Promise { + if (!(socket instanceof tls.TLSSocket)) { + return socket + } + + await this.startProxyServer() + + return new Promise((resolve, reject) => { + const id = generateUuid() + const proxy = net.connect(this.proxyPipe) + proxy.once("connect", () => proxy.write(id)) + + const timeout = setTimeout(() => { + listener.dispose() + socket.destroy() + proxy.destroy() + reject(new Error("TLS socket proxy timed out")) + }, this.proxyTimeout) + + const listener = this.onProxyConnect.event((connection) => { + connection.once("data", (data) => { + if (!socket.destroyed && !proxy.destroyed && data.toString() === id) { + clearTimeout(timeout) + listener.dispose() + ;[ + [proxy, socket], + [socket, proxy], + ].forEach(([a, b]) => { + a.pipe(b) + a.on("error", () => b.destroy()) + a.on("close", () => b.destroy()) + a.on("end", () => b.end()) + }) + resolve(connection) + } + }) + }) + }) + } + + private async startProxyServer(): Promise { + if (!this._proxyServer) { + this._proxyServer = this.findFreeSocketPath(this.proxyPipe) + .then((pipe) => { + this.proxyPipe = pipe + return Promise.all([ + fs.mkdir(path.dirname(this.proxyPipe), { recursive: true }), + fs.rm(this.proxyPipe, { force: true, recursive: true }), + ]) + }) + .then(() => { + return new Promise((resolve) => { + const proxyServer = net.createServer((p) => this.onProxyConnect.emit(p)) + proxyServer.once("listening", () => resolve(proxyServer)) + proxyServer.listen(this.proxyPipe) + }) + }) + } + return this._proxyServer + } + + public async findFreeSocketPath(basePath: string, maxTries = 100): Promise { + let i = 0 + let path = basePath + while ((await canConnect(path)) && i < maxTries) { + path = `${basePath}-${++i}` + } + return path + } +} diff --git a/src/node/update.ts b/src/node/update.ts index af58d444dbbd..4e4a1babe501 100644 --- a/src/node/update.ts +++ b/src/node/update.ts @@ -1,149 +1,137 @@ -import * as cp from "child_process"; -import * as os from "os"; -import * as path from "path"; -import { Stream } from "stream"; -import * as util from "util"; -import { toVSBufferReadableStream } from "vs/base/common/buffer"; -import { CancellationToken } from "vs/base/common/cancellation"; -import { URI } from "vs/base/common/uri"; -import * as pfs from "vs/base/node/pfs"; -import { IConfigurationService } from "vs/platform/configuration/common/configuration"; -import { IEnvironmentService } from "vs/platform/environment/common/environment"; -import { IFileService } from "vs/platform/files/common/files"; -import { ILogService } from "vs/platform/log/common/log"; -import pkg from "vs/platform/product/node/package"; -import { asJson, IRequestService } from "vs/platform/request/common/request"; -import { AvailableForDownload, State, StateType, UpdateType } from "vs/platform/update/common/update"; -import { AbstractUpdateService } from "vs/platform/update/electron-main/abstractUpdateService"; -import { ipcMain } from "vs/server/src/node/ipc"; -import { extract } from "vs/server/src/node/marketplace"; -import { tmpdir } from "vs/server/src/node/util"; -import * as zlib from "zlib"; +import { field, logger } from "@coder/logger" +import * as http from "http" +import * as https from "https" +import { ProxyAgent } from "proxy-agent" +import * as semver from "semver" +import * as url from "url" +import { httpProxyUri, version } from "./constants" +import { SettingsProvider, UpdateSettings } from "./settings" -interface IUpdate { - name: string; +export interface Update { + checked: number + version: string } -export class UpdateService extends AbstractUpdateService { - _serviceBrand: any; +export interface LatestResponse { + name: string +} + +/** + * Provide update information. + */ +export class UpdateProvider { + private update?: Promise + private updateInterval = 1000 * 60 * 60 * 24 // Milliseconds between update checks. - constructor( - @IConfigurationService configurationService: IConfigurationService, - @IEnvironmentService environmentService: IEnvironmentService, - @IRequestService requestService: IRequestService, - @ILogService logService: ILogService, - @IFileService private readonly fileService: IFileService, - ) { - super(null, configurationService, environmentService, requestService, logService); - } + public constructor( + /** + * The URL for getting the latest version of code-server. Should return JSON + * that fulfills `LatestResponse`. + */ + private readonly latestUrl: string, + /** + * Update information will be stored here. + */ + private readonly settings: SettingsProvider, + ) {} - public async isLatestVersion(latest?: IUpdate | null): Promise { - if (!latest) { - latest = await this.getLatestVersion(); - } - if (latest) { - const latestMajor = parseInt(latest.name); - const currentMajor = parseInt(pkg.codeServerVersion); - return !isNaN(latestMajor) && !isNaN(currentMajor) && - currentMajor <= latestMajor && latest.name === pkg.codeServerVersion; - } - return true; - } + /** + * Query for and return the latest update. + */ + public async getUpdate(force?: boolean): Promise { + // Don't run multiple requests at a time. + if (!this.update) { + this.update = this._getUpdate(force) + this.update.then(() => (this.update = undefined)) + } - protected buildUpdateFeedUrl(): string { - return "https://api.github.com/repos/cdr/code-server/releases/latest"; - } + return this.update + } - protected doQuitAndInstall(): void { - ipcMain.relaunch(); - } + private async _getUpdate(force?: boolean): Promise { + const now = Date.now() + try { + let { update } = !force ? await this.settings.read() : { update: undefined } + if (!update || update.checked + this.updateInterval < now) { + const buffer = await this.request(this.latestUrl) + const data = JSON.parse(buffer.toString()) as LatestResponse + update = { checked: now, version: data.name.replace(/^v/, "") } + await this.settings.write({ update }) + } + logger.debug("got latest version", field("latest", update.version)) + return update + } catch (error: any) { + logger.error("Failed to get latest version", field("error", error.message)) + return { + checked: now, + version: "unknown", + } + } + } - protected async doCheckForUpdates(context: any): Promise { - if (this.state.type !== StateType.Idle) { - return Promise.resolve(); - } - this.setState(State.CheckingForUpdates(context)); - try { - const update = await this.getLatestVersion(); - if (!update || this.isLatestVersion(update)) { - this.setState(State.Idle(UpdateType.Archive)); - } else { - this.setState(State.AvailableForDownload({ - version: update.name, - productVersion: update.name, - })); - } - } catch (error) { - this.onRequestError(error, !!context); - } - } + /** + * Return true if the currently installed version is the latest. + */ + public isLatestVersion(latest: Update): boolean { + logger.debug("comparing versions", field("current", version), field("latest", latest.version)) + try { + return semver.lte(latest.version, version) + } catch (error) { + return true + } + } - private async getLatestVersion(): Promise { - const data = await this.requestService.request({ - url: this.url, - headers: { - "User-Agent": "code-server", - }, - }, CancellationToken.None); - return asJson(data); - } + private async request(uri: string): Promise { + const response = await this.requestResponse(uri) + return new Promise((resolve, reject) => { + const chunks: Buffer[] = [] + let bufferLength = 0 + response.on("data", (chunk) => { + bufferLength += chunk.length + chunks.push(chunk) + }) + response.on("error", reject) + response.on("end", () => { + resolve(Buffer.concat(chunks, bufferLength)) + }) + }) + } - protected async doDownloadUpdate(state: AvailableForDownload): Promise { - this.setState(State.Updating(state.update)); - const target = os.platform(); - const releaseName = await this.buildReleaseName(state.update.version); - const url = "https://github.com/cdr/code-server/releases/download/" - + `${state.update.version}/${releaseName}` - + `.${target === "darwin" ? "zip" : "tar.gz"}`; - const downloadPath = path.join(tmpdir, `${state.update.version}-archive`); - const extractPath = path.join(tmpdir, state.update.version); - try { - await pfs.mkdirp(tmpdir); - const context = await this.requestService.request({ url }, CancellationToken.None); - // Decompress the gzip as we download. If the gzip encoding is set then - // the request service already does this. - // HACK: This uses knowledge of the internals of the request service. - if (target !== "darwin" && context.res.headers["content-encoding"] !== "gzip") { - const stream = (context.res as any as Stream); - stream.removeAllListeners(); - context.stream = toVSBufferReadableStream(stream.pipe(zlib.createGunzip())); - } - await this.fileService.writeFile(URI.file(downloadPath), context.stream); - await extract(downloadPath, extractPath, undefined, CancellationToken.None); - const newBinary = path.join(extractPath, releaseName, "code-server"); - if (!pfs.exists(newBinary)) { - throw new Error("No code-server binary in extracted archive"); - } - await pfs.unlink(process.argv[0]); // Must unlink first to avoid ETXTBSY. - await pfs.move(newBinary, process.argv[0]); - this.setState(State.Ready(state.update)); - } catch (error) { - this.onRequestError(error, true); - } - await Promise.all([downloadPath, extractPath].map((p) => pfs.rimraf(p))); - } + private async requestResponse(uri: string): Promise { + let redirects = 0 + const maxRedirects = 10 + return new Promise((resolve, reject) => { + const request = (uri: string): void => { + logger.debug("Making request", field("uri", uri)) + const isHttps = uri.startsWith("https") + const agent = new ProxyAgent({ + keepAlive: true, + getProxyForUrl: () => httpProxyUri || "", + }) + const httpx = isHttps ? https : http + const client = httpx.get(uri, { headers: { "User-Agent": "code-server" }, agent }, (response) => { + if (!response.statusCode || response.statusCode < 200 || response.statusCode >= 400) { + response.destroy() + return reject(new Error(`${uri}: ${response.statusCode || "500"}`)) + } - private onRequestError(error: Error, showNotification?: boolean): void { - this.logService.error(error); - const message: string | undefined = showNotification ? (error.message || error.toString()) : undefined; - this.setState(State.Idle(UpdateType.Archive, message)); - } + if (response.statusCode >= 300) { + response.destroy() + ++redirects + if (redirects > maxRedirects) { + return reject(new Error("reached max redirects")) + } + if (!response.headers.location) { + return reject(new Error("received redirect with no location header")) + } + return request(url.resolve(uri, response.headers.location)) + } - private async buildReleaseName(release: string): Promise { - let target: string = os.platform(); - if (target === "linux") { - const result = await util.promisify(cp.exec)("ldd --version").catch((error) => ({ - stderr: error.message, - stdout: "", - })); - if (result.stderr.indexOf("musl") !== -1 || result.stdout.indexOf("musl") !== -1) { - target = "alpine"; - } - } - let arch = os.arch(); - if (arch === "x64") { - arch = "x86_64"; - } - return `code-server${release}-${target}-${arch}`; - } + resolve(response) + }) + client.on("error", reject) + } + request(uri) + }) + } } diff --git a/src/node/uriTransformer.js b/src/node/uriTransformer.js deleted file mode 100644 index 1312f5b2e956..000000000000 --- a/src/node/uriTransformer.js +++ /dev/null @@ -1,27 +0,0 @@ -// This file is included via a regular Node require. I'm not sure how (or if) -// we can write this in Typescript and have it compile to non-AMD syntax. -module.exports = (remoteAuthority) => { - return { - transformIncoming: (uri) => { - switch (uri.scheme) { - case "code-server": return { scheme: "file", path: uri.path }; - case "file": return { scheme: "code-server", path: uri.path }; - default: return uri; - } - }, - transformOutgoing: (uri) => { - switch (uri.scheme) { - case "code-server": return { scheme: "file", path: uri.path }; - case "file": return { scheme: "code-server", authority: remoteAuthority, path: uri.path }; - default: return uri; - } - }, - transformOutgoingScheme: (scheme) => { - switch (scheme) { - case "code-server": return "file"; - case "file": return "code-server"; - default: return scheme; - } - }, - }; -}; diff --git a/src/node/util.ts b/src/node/util.ts index f4a8cb14a61d..8befd9941426 100644 --- a/src/node/util.ts +++ b/src/node/util.ts @@ -1,139 +1,528 @@ -import * as cp from "child_process"; -import * as crypto from "crypto"; -import * as fs from "fs"; -import * as os from "os"; -import * as path from "path"; -import * as util from "util"; -import * as rg from "vscode-ripgrep"; - -import { getPathFromAmdModule } from "vs/base/common/amd"; -import { getMediaMime as vsGetMediaMime } from "vs/base/common/mime"; -import { extname } from "vs/base/common/path"; -import { URITransformer, IRawURITransformer } from "vs/base/common/uriIpc"; -import { mkdirp } from "vs/base/node/pfs"; - -export enum AuthType { - Password = "password", -} - -export enum FormatType { - Json = "json", -} - -export const tmpdir = path.join(os.tmpdir(), "code-server"); - -export const generateCertificate = async (): Promise<{ cert: string, certKey: string }> => { - const paths = { - cert: path.join(tmpdir, "self-signed.cert"), - certKey: path.join(tmpdir, "self-signed.key"), - }; - - const exists = await Promise.all([ - util.promisify(fs.exists)(paths.cert), - util.promisify(fs.exists)(paths.certKey), - ]); - - if (!exists[0] || !exists[1]) { - const pem = localRequire("pem/lib/pem"); - const certs = await new Promise((resolve, reject): void => { - pem.createCertificate({ selfSigned: true }, (error, result) => { - if (error) { - return reject(error); - } - resolve(result); - }); - }); - await mkdirp(tmpdir); - await Promise.all([ - util.promisify(fs.writeFile)(paths.cert, certs.certificate), - util.promisify(fs.writeFile)(paths.certKey, certs.serviceKey), - ]); - } - - return paths; -}; - -export const uriTransformerPath = getPathFromAmdModule(require, "vs/server/src/node/uriTransformer"); -export const getUriTransformer = (remoteAuthority: string): URITransformer => { - const rawURITransformerFactory = require.__$__nodeRequire(uriTransformerPath); - const rawURITransformer = rawURITransformerFactory(remoteAuthority); - return new URITransformer(rawURITransformer); -}; - -export const generatePassword = async (length: number = 24): Promise => { - const buffer = Buffer.alloc(Math.ceil(length / 2)); - await util.promisify(crypto.randomFill)(buffer); - return buffer.toString("hex").substring(0, length); -}; +import * as argon2 from "argon2" +import * as cp from "child_process" +import * as crypto from "crypto" +import envPaths from "env-paths" +import { promises as fs } from "fs" +import * as net from "net" +import * as os from "os" +import * as path from "path" +import safeCompare from "safe-compare" +import * as util from "util" +import xdgBasedir from "xdg-basedir" + +export interface Paths { + data: string + config: string + runtime: string +} + +// From https://github.com/chalk/ansi-regex +const pattern = [ + "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)", + "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", +].join("|") +const re = new RegExp(pattern, "g") + +export type OnLineCallback = (strippedLine: string, originalLine: string) => void +/** + * Split stdout on newlines and strip ANSI codes. + */ +export const onLine = (proc: cp.ChildProcess, callback: OnLineCallback): void => { + let buffer = "" + if (!proc.stdout) { + throw new Error("no stdout") + } + proc.stdout.setEncoding("utf8") + proc.stdout.on("data", (d) => { + const data = buffer + d + const split = data.split("\n") + const last = split.length - 1 + + for (let i = 0; i < last; ++i) { + callback(split[i].replace(re, ""), split[i]) + } + + // The last item will either be an empty string (the data ended with a + // newline) or a partial line (did not end with a newline) and we must + // wait to parse it until we get a full line. + buffer = split[last] + }) +} + +export const paths = getEnvPaths() + +/** + * Gets the config and data paths for the current platform/configuration. + * On MacOS this function gets the standard XDG directories instead of using the native macOS + * ones. Most CLIs do this as in practice only GUI apps use the standard macOS directories. + */ +export function getEnvPaths(platform = process.platform): Paths { + const paths = envPaths("code-server", { suffix: "" }) + const append = (p: string): string => path.join(p, "code-server") + switch (platform) { + case "darwin": + return { + // envPaths uses native directories so force Darwin to use the XDG spec + // to align with other CLI tools. + data: xdgBasedir.data ? append(xdgBasedir.data) : paths.data, + config: xdgBasedir.config ? append(xdgBasedir.config) : paths.config, + // Fall back to temp if there is no runtime dir. + runtime: xdgBasedir.runtime ? append(xdgBasedir.runtime) : paths.temp, + } + case "win32": + return { + data: paths.data, + config: paths.config, + // Windows doesn't have a runtime dir. + runtime: paths.temp, + } + default: + return { + data: paths.data, + config: paths.config, + // Fall back to temp if there is no runtime dir. + runtime: xdgBasedir.runtime ? append(xdgBasedir.runtime) : paths.temp, + } + } +} + +export const generateCertificate = async (hostname: string): Promise<{ cert: string; certKey: string }> => { + const certPath = path.join(paths.data, `${hostname.replace(/\./g, "_")}.crt`) + const certKeyPath = path.join(paths.data, `${hostname.replace(/\./g, "_")}.key`) + + // Try generating the certificates if we can't access them (which probably + // means they don't exist). + try { + await Promise.all([fs.access(certPath), fs.access(certKeyPath)]) + } catch (error) { + // Require on demand so openssl isn't required if you aren't going to + // generate certificates. + const pem = require("pem") as typeof import("pem") + const certs = await new Promise((resolve, reject): void => { + pem.createCertificate( + { + selfSigned: true, + commonName: hostname, + config: ` +[req] +req_extensions = v3_req + +[ v3_req ] +basicConstraints = CA:true +extendedKeyUsage = serverAuth +subjectAltName = @alt_names + +[alt_names] +DNS.1 = ${hostname} +`, + }, + (error, result) => { + return error ? reject(error) : resolve(result) + }, + ) + }) + await fs.mkdir(paths.data, { recursive: true }) + await Promise.all([fs.writeFile(certPath, certs.certificate), fs.writeFile(certKeyPath, certs.serviceKey)]) + } + + return { + cert: certPath, + certKey: certKeyPath, + } +} + +export const generatePassword = async (length = 24): Promise => { + const buffer = Buffer.alloc(Math.ceil(length / 2)) + await util.promisify(crypto.randomFill)(buffer) + return buffer.toString("hex").substring(0, length) +} + +/** + * Used to hash the password. + */ +export const hash = async (password: string): Promise => { + return await argon2.hash(password) +} + +/** + * Used to verify if the password matches the hash + */ +export const isHashMatch = async (password: string, hash: string) => { + if (password === "" || hash === "" || !hash.startsWith("$")) { + return false + } + return await argon2.verify(hash, password) +} + +/** + * Used to hash the password using the sha256 + * algorithm. We only use this to for checking + * the hashed-password set in the config. + * + * Kept for legacy reasons. + */ +export const hashLegacy = (str: string): string => { + return crypto.createHash("sha256").update(str).digest("hex") +} + +/** + * Used to check if the password matches the hash using + * the hashLegacy function + */ +export const isHashLegacyMatch = (password: string, hashPassword: string) => { + const hashedWithLegacy = hashLegacy(password) + return safeCompare(hashedWithLegacy, hashPassword) +} + +export type PasswordMethod = "SHA256" | "ARGON2" | "PLAIN_TEXT" + +/** + * Used to determine the password method. + * + * There are three options for the return value: + * 1. "SHA256" -> the legacy hashing algorithm + * 2. "ARGON2" -> the newest hashing algorithm + * 3. "PLAIN_TEXT" -> regular ol' password with no hashing + * + * @returns {PasswordMethod} "SHA256" | "ARGON2" | "PLAIN_TEXT" + */ +export function getPasswordMethod(hashedPassword: string | undefined): PasswordMethod { + if (!hashedPassword) { + return "PLAIN_TEXT" + } + + // This is the new hashing algorithm + if (hashedPassword.includes("$argon")) { + return "ARGON2" + } + + // This is the legacy hashing algorithm + return "SHA256" +} + +type PasswordValidation = { + isPasswordValid: boolean + hashedPassword: string +} + +type HandlePasswordValidationArgs = { + /** The PasswordMethod */ + passwordMethod: PasswordMethod + /** The password provided by the user */ + passwordFromRequestBody: string + /** The password set in PASSWORD or config */ + passwordFromArgs: string | undefined + /** The hashed-password set in HASHED_PASSWORD or config */ + hashedPasswordFromArgs: string | undefined +} + +/** + * Checks if a password is valid and also returns the hash + * using the PasswordMethod + */ +export async function handlePasswordValidation({ + passwordMethod, + passwordFromArgs, + passwordFromRequestBody, + hashedPasswordFromArgs, +}: HandlePasswordValidationArgs): Promise { + const passwordValidation = { + isPasswordValid: false, + hashedPassword: "", + } + + switch (passwordMethod) { + case "PLAIN_TEXT": { + const isValid = passwordFromArgs ? safeCompare(passwordFromRequestBody, passwordFromArgs) : false + passwordValidation.isPasswordValid = isValid + + const hashedPassword = await hash(passwordFromRequestBody) + passwordValidation.hashedPassword = hashedPassword + break + } + case "SHA256": { + const isValid = isHashLegacyMatch(passwordFromRequestBody, hashedPasswordFromArgs || "") + passwordValidation.isPasswordValid = isValid + + passwordValidation.hashedPassword = hashedPasswordFromArgs || (await hashLegacy(passwordFromRequestBody)) + break + } + case "ARGON2": { + const isValid = await isHashMatch(passwordFromRequestBody, hashedPasswordFromArgs || "") + passwordValidation.isPasswordValid = isValid + + passwordValidation.hashedPassword = hashedPasswordFromArgs || "" + break + } + default: + break + } + + return passwordValidation +} + +export type IsCookieValidArgs = { + passwordMethod: PasswordMethod + cookieKey: string + hashedPasswordFromArgs: string | undefined + passwordFromArgs: string | undefined +} + +/** Checks if a req.cookies.key is valid using the PasswordMethod */ +export async function isCookieValid({ + passwordFromArgs = "", + cookieKey, + hashedPasswordFromArgs = "", + passwordMethod, +}: IsCookieValidArgs): Promise { + let isValid = false + switch (passwordMethod) { + case "PLAIN_TEXT": + isValid = await isHashMatch(passwordFromArgs, cookieKey) + break + case "ARGON2": + case "SHA256": + isValid = safeCompare(cookieKey, hashedPasswordFromArgs) + break + default: + break + } + return isValid +} + +/** Ensures that the input is sanitized by checking + * - it's a string + * - greater than 0 characters + * - trims whitespace + */ +export function sanitizeString(str: unknown): string { + // Very basic sanitization of string + // Credit: https://stackoverflow.com/a/46719000/3015595 + return typeof str === "string" ? str.trim() : "" +} + +const mimeTypes: { [key: string]: string } = { + ".aac": "audio/x-aac", + ".avi": "video/x-msvideo", + ".bmp": "image/bmp", + ".css": "text/css", + ".flv": "video/x-flv", + ".gif": "image/gif", + ".html": "text/html", + ".ico": "image/x-icon", + ".jpe": "image/jpg", + ".jpeg": "image/jpg", + ".jpg": "image/jpg", + ".js": "application/javascript", + ".json": "application/json", + ".m1v": "video/mpeg", + ".m2a": "audio/mpeg", + ".m2v": "video/mpeg", + ".m3a": "audio/mpeg", + ".mid": "audio/midi", + ".midi": "audio/midi", + ".mk3d": "video/x-matroska", + ".mks": "video/x-matroska", + ".mkv": "video/x-matroska", + ".mov": "video/quicktime", + ".movie": "video/x-sgi-movie", + ".mp2": "audio/mpeg", + ".mp2a": "audio/mpeg", + ".mp3": "audio/mpeg", + ".mp4": "video/mp4", + ".mp4a": "audio/mp4", + ".mp4v": "video/mp4", + ".mpe": "video/mpeg", + ".mpeg": "video/mpeg", + ".mpg": "video/mpeg", + ".mpg4": "video/mp4", + ".mpga": "audio/mpeg", + ".oga": "audio/ogg", + ".ogg": "audio/ogg", + ".ogv": "video/ogg", + ".png": "image/png", + ".psd": "image/vnd.adobe.photoshop", + ".qt": "video/quicktime", + ".spx": "audio/ogg", + ".svg": "image/svg+xml", + ".tga": "image/x-tga", + ".tif": "image/tiff", + ".tiff": "image/tiff", + ".txt": "text/plain", + ".wav": "audio/x-wav", + ".wasm": "application/wasm", + ".webm": "video/webm", + ".webp": "image/webp", + ".wma": "audio/x-ms-wma", + ".wmv": "video/x-ms-wmv", + ".woff": "application/font-woff", +} export const getMediaMime = (filePath?: string): string => { - return filePath && (vsGetMediaMime(filePath) || (<{[index: string]: string}>{ - ".css": "text/css", - ".html": "text/html", - ".js": "application/javascript", - ".json": "application/json", - })[extname(filePath)]) || "text/plain"; -}; - -export const isWsl = async (): Promise => { - return process.platform === "linux" - && os.release().toLowerCase().indexOf("microsoft") !== -1 - || (await util.promisify(fs.readFile)("/proc/version", "utf8")) - .toLowerCase().indexOf("microsoft") !== -1; -}; - -export const open = async (url: string): Promise => { - const args = []; - const options = {}; - const platform = await isWsl() ? "wsl" : process.platform; - let command = platform === "darwin" ? "open" : "xdg-open"; - if (platform === "win32" || platform === "wsl") { - command = platform === "wsl" ? "cmd.exe" : "cmd"; - args.push("/c", "start", '""', "/b"); - url = url.replace(/&/g, "^&"); - } - const proc = cp.spawn(command, [...args, url], options); - await new Promise((resolve, reject) => { - proc.on("error", reject); - proc.on("close", (code) => { - return code !== 0 - ? reject(new Error(`Failed to open with code ${code}`)) - : resolve(); - }); - }); -}; - -/** - * Extract executables to the temporary directory. This is required since we - * can't execute binaries stored within our binary. - */ -export const unpackExecutables = async (): Promise => { - const rgPath = (rg as any).binaryRgPath; - const destination = path.join(tmpdir, path.basename(rgPath || "")); - if (rgPath && !(await util.promisify(fs.exists)(destination))) { - await mkdirp(tmpdir); - await util.promisify(fs.writeFile)(destination, await util.promisify(fs.readFile)(rgPath)); - await util.promisify(fs.chmod)(destination, "755"); - } -}; - -export const enumToArray = (t: any): string[] => { - const values = []; - for (const k in t) { - values.push(t[k]); - } - return values; -}; - -export const buildAllowedMessage = (t: any): string => { - const values = enumToArray(t); - return `Allowed value${values.length === 1 ? " is" : "s are"} ${values.map((t) => `'${t}'`).join(",")}`; -}; - -/** - * Require a local module. This is necessary since VS Code's loader only looks - * at the root for Node modules. - */ -export const localRequire = (modulePath: string): T => { - return require.__$__nodeRequire(path.resolve(__dirname, "../../node_modules", modulePath)); -}; + return (filePath && mimeTypes[path.extname(filePath)]) || "text/plain" +} + +/** + * A helper function that checks if the platform is Windows Subsystem for Linux + * (WSL) + * + * @see https://github.com/sindresorhus/is-wsl/blob/main/index.js + * @returns {Boolean} boolean if it is WSL + */ +export const isWsl = async ( + platform: NodeJS.Platform, + osRelease: string, + procVersionFilePath: string, +): Promise => { + if (platform !== "linux") { + return false + } + + if (osRelease.toLowerCase().includes("microsoft")) { + return true + } + + try { + return (await fs.readFile(procVersionFilePath, "utf8")).toLowerCase().includes("microsoft") + } catch (_) { + return false + } +} + +interface OpenOptions { + args: string[] + command: string + urlSearch: string +} + +/** + * A helper function to construct options for `open` function. + * + * Extract to make it easier to test. + * + * @param platform - platform on machine + * @param urlSearch - url.search + * @returns an object with args, command, options and urlSearch + */ +export function constructOpenOptions(platform: NodeJS.Platform | "wsl", urlSearch: string): OpenOptions { + const args: string[] = [] + let command = platform === "darwin" ? "open" : "xdg-open" + if (platform === "win32" || platform === "wsl") { + command = platform === "wsl" ? "cmd.exe" : "cmd" + args.push("/c", "start", '""', "/b") + urlSearch = urlSearch.replace(/&/g, "^&") + } + + return { + args, + command, + urlSearch, + } +} + +/** + * Try opening an address using whatever the system has set for opening URLs. + */ +export const open = async (address: URL | string): Promise => { + if (typeof address === "string") { + throw new Error("Cannot open socket paths") + } + // Web sockets do not seem to work if browsing with 0.0.0.0. + const url = new URL(address) + if (url.hostname === "0.0.0.0") { + url.hostname = "localhost" + } + const platform = (await isWsl(process.platform, os.release(), "/proc/version")) ? "wsl" : process.platform + const { command, args, urlSearch } = constructOpenOptions(platform, url.search) + url.search = urlSearch + const proc = cp.spawn(command, [...args, url.toString()], {}) + await new Promise((resolve, reject) => { + proc.on("error", reject) + proc.on("close", (code) => { + return code !== 0 ? reject(new Error(`Failed to open with code ${code}`)) : resolve() + }) + }) +} + +/** + * Return a promise that resolves with whether the socket path is active. + */ +export function canConnect(path: string): Promise { + return new Promise((resolve) => { + const socket = net.connect(path) + socket.once("error", () => resolve(false)) + socket.once("connect", () => { + socket.destroy() + resolve(true) + }) + }) +} + +export const isFile = async (path: string): Promise => { + try { + const stat = await fs.stat(path) + return stat.isFile() + } catch (error) { + return false + } +} + +export const isDirectory = async (path: string): Promise => { + try { + const stat = await fs.stat(path) + return stat.isDirectory() + } catch (error) { + return false + } +} + +/** + * Escapes any HTML string special characters, like &, <, >, ", and '. + * + * Source: https://stackoverflow.com/a/6234804/3015595 + **/ +export function escapeHtml(unsafe: string): string { + return unsafe + .replace(/&/g, "&") + .replace(//g, ">") + .replace(/"/g, """) + .replace(/'/g, "'") +} + +/** + * A helper function which returns a boolean indicating whether + * the given error is a NodeJS.ErrnoException by checking if + * it has a .code property. + */ +export function isNodeJSErrnoException(error: unknown): error is NodeJS.ErrnoException { + return error !== undefined && (error as NodeJS.ErrnoException).code !== undefined +} + +// TODO: Replace with proper templating system. +export const escapeJSON = (value: cp.Serializable) => JSON.stringify(value).replace(/"/g, """) + +/** + * Split a string on the first equals. The result will always be an array with + * two items regardless of how many equals there are. The second item will be + * undefined if empty or missing. + */ +export function splitOnFirstEquals(str: string): [string, string | undefined] { + const split = str.split(/=(.+)?/, 2) + return [split[0], split[1]] +} + +/** + * Expand a leading `~` to the home directory. The shell does this for + * command-line arguments but values from the config file are not expanded. + * `~user` forms are left alone. + */ +export function expandTilde(p: string): string { + if (p === "~") { + return os.homedir() + } + if (p.startsWith("~/") || p.startsWith(`~${path.sep}`)) { + return path.join(os.homedir(), p.slice(2)) + } + return p +} diff --git a/src/node/vscodeSocket.ts b/src/node/vscodeSocket.ts new file mode 100644 index 000000000000..e01d1a15012b --- /dev/null +++ b/src/node/vscodeSocket.ts @@ -0,0 +1,206 @@ +import { logger } from "@coder/logger" +import express from "express" +import * as http from "http" +import * as path from "path" +import { HttpCode, HttpError } from "../common/http" +import { listen } from "./app" +import { errorHandler } from "./routes/errors" +import { canConnect } from "./util" + +export interface EditorSessionEntry { + workspace: { + id: string + folders: { + uri: { + path: string + } + }[] + } + + socketPath: string +} + +interface DeleteSessionRequest { + socketPath?: string +} + +interface AddSessionRequest { + entry?: EditorSessionEntry +} + +interface GetSessionResponse { + socketPath?: string +} + +export async function makeEditorSessionManagerServer( + codeServerSocketPath: string, + editorSessionManager: EditorSessionManager, +): Promise { + const router = express() + + router.use(express.json()) + + router.get<{}, GetSessionResponse | string | unknown, undefined, { filePath?: string }>( + "/session", + async (req, res) => { + const filePath = req.query.filePath + if (!filePath) { + throw new HttpError("filePath is required", HttpCode.BadRequest) + } + const socketPath = await editorSessionManager.getConnectedSocketPath(filePath) + const response: GetSessionResponse = { socketPath } + res.json(response) + }, + ) + + router.post<{}, string, AddSessionRequest | undefined>("/add-session", async (req, res) => { + const entry = req.body?.entry + if (!entry) { + throw new HttpError("entry is required", HttpCode.BadRequest) + } + editorSessionManager.addSession(entry) + res.status(200).send("session added") + }) + + router.post<{}, string, DeleteSessionRequest | undefined>("/delete-session", async (req, res) => { + const socketPath = req.body?.socketPath + if (!socketPath) { + throw new HttpError("socketPath is required", HttpCode.BadRequest) + } + editorSessionManager.deleteSession(socketPath) + res.status(200).send("session deleted") + }) + + router.use(errorHandler) + + const server = http.createServer(router) + try { + await listen(server, { socket: codeServerSocketPath }) + } catch (e) { + logger.warn(`Could not create socket at ${codeServerSocketPath}`) + } + return server +} + +export class EditorSessionManager { + // Map from socket path to EditorSessionEntry. + private entries = new Map() + + addSession(entry: EditorSessionEntry): void { + logger.debug(`Adding session to session registry: ${entry.socketPath}`) + this.entries.set(entry.socketPath, entry) + } + + getCandidatesForFile(filePath: string): EditorSessionEntry[] { + const matchCheckResults = new Map() + + const checkMatch = (entry: EditorSessionEntry): boolean => { + if (matchCheckResults.has(entry.socketPath)) { + return matchCheckResults.get(entry.socketPath)! + } + const result = entry.workspace.folders.some((folder) => filePath.startsWith(folder.uri.path + path.sep)) + matchCheckResults.set(entry.socketPath, result) + return result + } + + return Array.from(this.entries.values()) + .reverse() // Most recently registered first. + .sort((a, b) => { + // Matches first. + const aMatch = checkMatch(a) + const bMatch = checkMatch(b) + if (aMatch === bMatch) { + return 0 + } + if (aMatch) { + return -1 + } + return 1 + }) + } + + deleteSession(socketPath: string): void { + logger.debug(`Deleting session from session registry: ${socketPath}`) + this.entries.delete(socketPath) + } + + /** + * Returns the best socket path that we can connect to. + * We also delete any sockets that we can't connect to. + */ + async getConnectedSocketPath(filePath: string): Promise { + const candidates = this.getCandidatesForFile(filePath) + let match: EditorSessionEntry | undefined = undefined + + for (const candidate of candidates) { + if (await canConnect(candidate.socketPath)) { + match = candidate + break + } + this.deleteSession(candidate.socketPath) + } + + return match?.socketPath + } +} + +export class EditorSessionManagerClient { + constructor(private codeServerSocketPath: string) {} + + async canConnect() { + return canConnect(this.codeServerSocketPath) + } + + async getConnectedSocketPath(filePath: string): Promise { + const response = await new Promise((resolve, reject) => { + const opts = { + path: "/session?filePath=" + encodeURIComponent(filePath), + socketPath: this.codeServerSocketPath, + method: "GET", + } + const req = http.request(opts, (res) => { + let rawData = "" + res.setEncoding("utf8") + res.on("data", (chunk) => { + rawData += chunk + }) + res.on("end", () => { + try { + const obj = JSON.parse(rawData) + if (res.statusCode === 200) { + resolve(obj) + } else { + reject(new Error("Unexpected status code: " + res.statusCode)) + } + } catch (e: unknown) { + reject(e) + } + }) + }) + req.on("error", reject) + req.end() + }) + return response.socketPath + } + + // Currently only used for tests. + async addSession(request: AddSessionRequest): Promise { + await new Promise((resolve, reject) => { + const opts = { + path: "/add-session", + socketPath: this.codeServerSocketPath, + method: "POST", + headers: { + "content-type": "application/json", + accept: "application/json", + }, + } + const req = http.request(opts, () => { + resolve() + }) + req.on("error", reject) + req.write(JSON.stringify(request)) + req.end() + }) + } +} diff --git a/src/node/wrapper.ts b/src/node/wrapper.ts new file mode 100644 index 000000000000..607512e2c9fb --- /dev/null +++ b/src/node/wrapper.ts @@ -0,0 +1,397 @@ +import { field, Logger, logger } from "@coder/logger" +import * as cp from "child_process" +import * as path from "path" +import * as rfs from "rotating-file-stream" +import { Emitter } from "../common/emitter" +import { DefaultedArgs, redactArgs } from "./cli" +import { paths } from "./util" + +const timeoutInterval = 10000 // 10s, matches VS Code's timeouts. + +/** + * Listen to a single message from a process. Reject if the process errors, + * exits, or times out. + * + * `fn` is a function that determines whether the message is the one we're + * waiting for. + */ +export function onMessage( + proc: cp.ChildProcess | NodeJS.Process, + fn: (message: M) => message is T, + customLogger?: Logger, +): Promise { + return new Promise((resolve, reject) => { + const cleanup = () => { + proc.off("error", onError) + proc.off("exit", onExit) + proc.off("message", onMessage) + clearTimeout(timeout) + } + + const timeout = setTimeout(() => { + cleanup() + reject(new Error("timed out")) + }, timeoutInterval) + + const onError = (error: Error) => { + cleanup() + reject(error) + } + + const onExit = (code: number) => { + cleanup() + reject(new Error(`exited unexpectedly with code ${code}`)) + } + + const onMessage = (message: M) => { + if (fn(message)) { + cleanup() + resolve(message) + } else { + ;(customLogger || logger).debug("got unhandled message", field("message", message)) + } + } + + proc.on("message", onMessage) + // NodeJS.Process doesn't have `error` but binding anyway shouldn't break + // anything. It does have `exit` but the types aren't working. + ;(proc as cp.ChildProcess).on("error", onError) + ;(proc as cp.ChildProcess).on("exit", onExit) + }) +} + +interface ParentHandshakeMessage { + type: "handshake" + args: DefaultedArgs +} + +interface ChildHandshakeMessage { + type: "handshake" +} + +interface RelaunchMessage { + type: "relaunch" + version: string +} + +type ChildMessage = RelaunchMessage | ChildHandshakeMessage +type ParentMessage = ParentHandshakeMessage + +class ProcessError extends Error { + public constructor( + message: string, + public readonly code: number | undefined, + ) { + super(message) + this.name = this.constructor.name + Error.captureStackTrace(this, this.constructor) + } +} + +/** + * Wrapper around a process that tries to gracefully exit when a process exits + * and provides a way to prevent `process.exit`. + */ +abstract class Process { + /** + * Emit this to trigger a graceful exit. + */ + protected readonly _onDispose = new Emitter() + + /** + * Emitted when the process is about to be disposed. + */ + public readonly onDispose = this._onDispose.event + + /** + * Uniquely named logger for the process. + */ + public abstract logger: Logger + + public constructor() { + process.on("SIGINT", () => this._onDispose.emit("SIGINT")) + process.on("SIGTERM", () => this._onDispose.emit("SIGTERM")) + process.on("exit", () => this._onDispose.emit(undefined)) + + this.onDispose((signal, wait) => { + // Remove listeners to avoid possibly triggering disposal again. + process.removeAllListeners() + + // Try waiting for other handlers to run first then exit. + this.logger.debug("disposing", field("code", signal)) + wait.then(() => this.exit(0)) + setTimeout(() => this.exit(0), 5000) + }) + } + + /** + * Ensure control over when the process exits. + */ + public preventExit(): void { + ;(process.exit as any) = (code?: number) => { + this.logger.warn(`process.exit() was prevented: ${code || "unknown code"}.`) + } + } + + private readonly processExit: (code?: number) => never = process.exit + + /** + * Will always exit even if normal exit is being prevented. + */ + public exit(error?: number | ProcessError): never { + if (error && typeof error !== "number") { + this.processExit(typeof error.code === "number" ? error.code : 1) + } else { + this.processExit(error) + } + } +} + +/** + * Child process that will clean up after itself if the parent goes away and can + * perform a handshake with the parent and ask it to relaunch. + */ +export class ChildProcess extends Process { + public logger = logger.named(`child:${process.pid}`) + + public constructor(private readonly parentPid: number) { + super() + + // Kill the inner process if the parent dies. This is for the case where the + // parent process is forcefully terminated and cannot clean up. + setInterval(() => { + try { + // process.kill throws an exception if the process doesn't exist. + process.kill(this.parentPid, 0) + } catch (_) { + // Consider this an error since it should have been able to clean up + // the child process unless it was forcefully killed. + this.logger.error(`parent process ${parentPid} died`) + this._onDispose.emit(undefined) + } + }, 5000) + } + + /** + * Initiate the handshake and wait for a response from the parent. + */ + public async handshake(): Promise { + this.logger.debug("initiating handshake") + this.send({ type: "handshake" }) + const message = await onMessage( + process, + (message): message is ParentHandshakeMessage => { + return message.type === "handshake" + }, + this.logger, + ) + this.logger.debug( + "got message", + field("message", { + type: message.type, + args: redactArgs(message.args), + }), + ) + return message.args + } + + /** + * Notify the parent process that it should relaunch the child. + */ + public relaunch(version: string): void { + this.send({ type: "relaunch", version }) + } + + /** + * Send a message to the parent. + */ + private send(message: ChildMessage): void { + if (!process.send) { + throw new Error("not spawned with IPC") + } + process.send(message) + } +} + +/** + * Parent process wrapper that spawns the child process and performs a handshake + * with it. Will relaunch the child if it receives a SIGUSR1 or SIGUSR2 or is + * asked to by the child. If the child otherwise exits the parent will also + * exit. + */ +export class ParentProcess extends Process { + public logger = logger.named(`parent:${process.pid}`) + + private child?: cp.ChildProcess + private started?: Promise + private readonly logStdoutStream: rfs.RotatingFileStream + private readonly logStderrStream: rfs.RotatingFileStream + + protected readonly _onChildMessage = new Emitter() + protected readonly onChildMessage = this._onChildMessage.event + + private args?: DefaultedArgs + + public constructor(private currentVersion: string) { + super() + + process.on("SIGUSR1", async () => { + this.logger.info("Received SIGUSR1; hotswapping") + this.relaunch() + }) + + process.on("SIGUSR2", async () => { + this.logger.info("Received SIGUSR2; hotswapping") + this.relaunch() + }) + + const opts = { + size: "10M", + maxFiles: 10, + path: path.join(paths.data, "coder-logs"), + } + this.logStdoutStream = rfs.createStream("code-server-stdout.log", opts) + this.logStderrStream = rfs.createStream("code-server-stderr.log", opts) + + this.onDispose(() => this.disposeChild()) + + this.onChildMessage((message) => { + switch (message.type) { + case "relaunch": + this.logger.info(`Relaunching: ${this.currentVersion} -> ${message.version}`) + this.currentVersion = message.version + this.relaunch() + break + default: + this.logger.error(`Unrecognized message ${message}`) + break + } + }) + } + + private async disposeChild(): Promise { + this.started = undefined + if (this.child) { + const child = this.child + child.removeAllListeners() + child.kill() + // Wait for the child to exit otherwise its output will be lost which can + // be especially problematic if you're trying to debug why cleanup failed. + await new Promise((r) => child!.on("exit", r)) + } + } + + private async relaunch(): Promise { + this.disposeChild() + try { + this.started = this._start() + await this.started + } catch (error: any) { + this.logger.error(error.message) + this.exit(typeof error.code === "number" ? error.code : 1) + } + } + + public start(args: DefaultedArgs): Promise { + // Our logger was created before we parsed CLI arguments so update the level + // in case it has changed. + this.logger.level = logger.level + + // Store for relaunches. + this.args = args + if (!this.started) { + this.started = this._start() + } + return this.started + } + + private async _start(): Promise { + const child = this.spawn() + this.child = child + + // Log child output to stdout/stderr and to the log directory. + if (child.stdout) { + child.stdout.on("data", (data) => { + this.logStdoutStream.write(data) + process.stdout.write(data) + }) + } + if (child.stderr) { + child.stderr.on("data", (data) => { + this.logStderrStream.write(data) + process.stderr.write(data) + }) + } + + this.logger.debug(`spawned child process ${child.pid}`) + + await this.handshake(child) + + child.once("exit", (code) => { + this.logger.debug(`inner process ${child.pid} exited unexpectedly`) + this.exit(code || 0) + }) + } + + private spawn(): cp.ChildProcess { + return cp.fork(path.join(__dirname, "entry"), { + env: { + ...process.env, + CODE_SERVER_PARENT_PID: process.pid.toString(), + NODE_EXEC_PATH: process.execPath, + }, + stdio: ["pipe", "pipe", "pipe", "ipc"], + }) + } + + /** + * Wait for a handshake from the child then reply. + */ + private async handshake(child: cp.ChildProcess): Promise { + if (!this.args) { + throw new Error("started without args") + } + const message = await onMessage( + child, + (message): message is ChildHandshakeMessage => { + return message.type === "handshake" + }, + this.logger, + ) + this.logger.debug("got message", field("message", message)) + this.send(child, { type: "handshake", args: this.args }) + } + + /** + * Send a message to the child. + */ + private send(child: cp.ChildProcess, message: ParentMessage): void { + child.send(message) + } +} + +/** + * Process wrapper. + */ +export const wrapper = + typeof process.env.CODE_SERVER_PARENT_PID !== "undefined" + ? new ChildProcess(parseInt(process.env.CODE_SERVER_PARENT_PID)) + : new ParentProcess(require("../../package.json").version) + +export function isChild(proc: ChildProcess | ParentProcess): proc is ChildProcess { + return proc instanceof ChildProcess +} + +// It's possible that the pipe has closed (for example if you run code-server +// --version | head -1). Assume that means we're done. +if (!process.stdout.isTTY) { + process.stdout.on("error", () => wrapper.exit()) +} + +// Don't let uncaught exceptions crash the process. +process.on("uncaughtException", (error) => { + wrapper.logger.error(`Uncaught exception: ${error.message}`) + if (typeof error.stack !== "undefined") { + wrapper.logger.error(error.stack) + } +}) diff --git a/src/node/wsRouter.ts b/src/node/wsRouter.ts new file mode 100644 index 000000000000..0f901bb8ad7f --- /dev/null +++ b/src/node/wsRouter.ts @@ -0,0 +1,68 @@ +import * as express from "express" +import * as expressCore from "express-serve-static-core" +import * as http from "http" +import * as stream from "stream" +import Websocket from "ws" + +export interface WebsocketRequest extends express.Request { + ws: stream.Duplex + head: Buffer +} + +interface InternalWebsocketRequest extends WebsocketRequest { + _ws_handled: boolean +} + +export const handleUpgrade = (app: express.Express, server: http.Server): void => { + server.on("upgrade", (req, socket, head) => { + socket.pause() + + const wreq = req as InternalWebsocketRequest + wreq.ws = socket + wreq.head = head + wreq._ws_handled = false + + // Send the request off to be handled by Express. + ;(app as any).handle(wreq, new http.ServerResponse(wreq), () => { + if (!wreq._ws_handled) { + socket.end("HTTP/1.1 404 Not Found\r\n\r\n") + } + }) + }) +} + +export type WebSocketHandler = ( + req: WebsocketRequest, + res: express.Response, + next: express.NextFunction, +) => void | Promise + +export class WebsocketRouter { + public readonly router = express.Router() + + /** + * Handle a websocket at this route. Note that websockets are immediately + * paused when they come in. + * + * If the origin header exists it must match the host or the connection will + * be prevented. + */ + public ws(route: expressCore.PathParams, ...handlers: WebSocketHandler[]): void { + this.router.get( + route, + ...handlers.map((handler) => { + const wrapped: express.Handler = (req, res, next) => { + ;(req as InternalWebsocketRequest)._ws_handled = true + return handler(req as WebsocketRequest, res, next) + } + return wrapped + }), + ) + } +} + +export function Router(): WebsocketRouter { + return new WebsocketRouter() +} + +export const wss = new Websocket.Server({ noServer: true }) diff --git a/test/e2e/appName.test.ts b/test/e2e/appName.test.ts new file mode 100644 index 000000000000..a12795cb0b33 --- /dev/null +++ b/test/e2e/appName.test.ts @@ -0,0 +1,9 @@ +import { version } from "../../src/node/constants" +import { describe, test, expect } from "./baseFixture" + +const appName = "testnäme" +describe("--app-name", [`--app-name=${appName}`], {}, () => { + test("should use app-name for the title", async ({ codeServerPage }) => { + expect(await codeServerPage.page.title()).toContain(appName) + }) +}) diff --git a/test/e2e/baseFixture.ts b/test/e2e/baseFixture.ts new file mode 100644 index 000000000000..a1293f061c66 --- /dev/null +++ b/test/e2e/baseFixture.ts @@ -0,0 +1,64 @@ +import { test as base } from "@playwright/test" +import { CodeServer, CodeServerPage } from "./models/CodeServer" + +/** + * Wraps `test.describe` to create and manage an instance of code-server. If you + * don't use this you will need to create your own code-server instance and pass + * it to `test.use`. + * + * If `includeCredentials` is `true` page requests will be authenticated. + */ +export const describe = ( + name: string, + codeServerArgs: string[], + codeServerEnv: NodeJS.ProcessEnv, + fn: (codeServer: CodeServer) => void, +) => { + test.describe(name, () => { + // This will spawn on demand so nothing is necessary on before. + const codeServer = new CodeServer(name, codeServerArgs, codeServerEnv, undefined) + + // Kill code-server after the suite has ended. This may happen even without + // doing it explicitly but it seems prudent to be sure. + test.afterAll(async () => { + await codeServer.close() + }) + + test.use({ + // Makes `codeServer` and `authenticated` available to the extend call + // below. + codeServer, + // NOTE@jsjoeio some tests use --cert which uses a self-signed certificate + // without this option, those tests will fail. + ignoreHTTPSErrors: true, + }) + + fn(codeServer) + }) +} + +interface TestFixtures { + codeServer: CodeServer + codeServerPage: CodeServerPage +} + +/** + * Create a test that spawns code-server if necessary and ensures the page is + * ready. + */ +export const test = base.extend({ + codeServer: undefined, // No default; should be provided through `test.use`. + codeServerPage: async ({ codeServer, page }, use) => { + // It's possible code-server might prevent navigation because of unsaved + // changes (seems to happen based on timing even if no changes have been + // made too). In these cases just accept. + page.on("dialog", (d) => d.accept()) + + const codeServerPage = new CodeServerPage(codeServer, page) + await codeServerPage.navigate() + await use(codeServerPage) + }, +}) + +/** Shorthand for test.expect. */ +export const expect = test.expect diff --git a/test/e2e/codeServer.test.ts b/test/e2e/codeServer.test.ts new file mode 100644 index 000000000000..199298a1495e --- /dev/null +++ b/test/e2e/codeServer.test.ts @@ -0,0 +1,44 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { getMaybeProxiedCodeServer } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" +import { CodeServer } from "./models/CodeServer" + +describe("code-server", ["--disable-workspace-trust"], {}, () => { + // TODO@asher: Generalize this? Could be nice if we were to ever need + // multiple migration tests in other suites. + const instances = new Map() + test.afterAll(async () => { + const procs = Array.from(instances.values()) + instances.clear() + await Promise.all(procs.map((cs) => cs.close())) + }) + + test("should navigate to home page", async ({ codeServerPage }) => { + // We navigate codeServer before each test + // and we start the test with a storage state + // which means we should be logged in + // so it should be on the address + const url = codeServerPage.page.url() + // We use match because there may be a / at the end + // so we don't want it to fail if we expect http://localhost:8080 to match http://localhost:8080/ + const address = await getMaybeProxiedCodeServer(codeServerPage) + expect(url).toMatch(address) + }) + + test("should always see the code-server editor", async ({ codeServerPage }) => { + expect(await codeServerPage.isEditorVisible()).toBe(true) + }) + + test("should show the Integrated Terminal", async ({ codeServerPage }) => { + await codeServerPage.focusTerminal() + await expect(codeServerPage.page.locator("#terminal")).toBeVisible() + }) + + test("should open a file", async ({ codeServerPage }) => { + const dir = await codeServerPage.workspaceDir + const file = path.join(dir, "foo") + await fs.writeFile(file, "bar") + await codeServerPage.openFile(file) + }) +}) diff --git a/test/e2e/downloads.test.ts b/test/e2e/downloads.test.ts new file mode 100644 index 000000000000..56c2ca858bd5 --- /dev/null +++ b/test/e2e/downloads.test.ts @@ -0,0 +1,107 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { clean } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" + +describe("Downloads (enabled)", ["--disable-workspace-trust"], {}, async () => { + const testName = "downloads-enabled" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should see the 'Download...' option", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const tmpFilePath = path.join(workspaceDir, "unique-file.txt") + await fs.writeFile(tmpFilePath, "hello world") + + // Action + await codeServerPage.openContextMenu("text=unique-file.txt") + + await expect(codeServerPage.page.locator("text=Download...")).toBeVisible() + }) + + test("should see the 'Show Local' button on Save As", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const fileName = "unique-file-save-as.txt" + const tmpFilePath = path.join(workspaceDir, fileName) + await fs.writeFile(tmpFilePath, "Hello World") + + // Action + await codeServerPage.page.waitForSelector(`text=${fileName}`) + + await codeServerPage.openFile(fileName) + await codeServerPage.navigateMenus(["File", "Auto Save"]) + await codeServerPage.page.keyboard.type("Making some edits.") + await codeServerPage.navigateMenus(["File", "Save As..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).toBeVisible() + }) + + test("should see the 'Show Local' button on Save File", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "New Text File"]) + await codeServerPage.waitForTab("Untitled-1") + await codeServerPage.navigateMenus(["File", "Save"]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).toBeVisible() + }) + + test("should see the 'Show Local' button on Save Workspace As", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "Save Workspace As..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).toBeVisible() + }) +}) + +describe("Downloads (disabled)", ["--disable-workspace-trust", "--disable-file-downloads"], {}, async () => { + const testName = "downloads-disabled" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should not see the 'Download...' option", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const tmpFilePath = path.join(workspaceDir, "unique-file.txt") + await fs.writeFile(tmpFilePath, "Hello World") + + // Action + await codeServerPage.openContextMenu("text=unique-file.txt") + + await expect(codeServerPage.page.locator("text=Download...")).not.toBeVisible() + }) + + test("should not see the 'Show Local' button on Save as", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const fileName = "unique-file-save-as.txt" + const tmpFilePath = path.join(workspaceDir, fileName) + await fs.writeFile(tmpFilePath, "Hello World") + + // Action + await codeServerPage.page.waitForSelector(`text=${fileName}`) + await codeServerPage.openFile(fileName) + await codeServerPage.navigateMenus(["File", "Save As..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).not.toBeVisible() + }) + + test("should not see the 'Show Local' button on Save File", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "New Text File"]) + await codeServerPage.waitForTab("Untitled-1") + await codeServerPage.navigateMenus(["File", "Save"]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).not.toBeVisible() + }) + + test("should not see the 'Show Local' button on Save Workspace As", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "Save Workspace As..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).not.toBeVisible() + }) +}) diff --git a/test/e2e/extensions.test.ts b/test/e2e/extensions.test.ts new file mode 100644 index 000000000000..376bdce3ab5d --- /dev/null +++ b/test/e2e/extensions.test.ts @@ -0,0 +1,97 @@ +import { test as base } from "@playwright/test" +import * as path from "path" +import { getMaybeProxiedCodeServer } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" + +function runTestExtensionTests() { + // This will only work if the test extension is loaded into code-server. + test("should have access to VSCODE_PROXY_URI", async ({ codeServerPage }) => { + const address = await getMaybeProxiedCodeServer(codeServerPage) + + await codeServerPage.waitForTestExtensionLoaded() + await codeServerPage.executeCommandViaMenus("code-server: Get proxy URI") + + // Remove end slash in address. + const normalizedAddress = address.replace(/\/+$/, "") + await expect(codeServerPage.page.getByText(`Info: proxyUri: ${normalizedAddress}/proxy/{{port}}/`)).toBeVisible() + }) + + runExternalUriTests() +} + +function runExternalUriTests(proxyEndpointTemplate?: string) { + const cases = [ + { + name: "path", + input: "http://127.0.0.1:1234/my/path", + suffix: "/my/path", + }, + { + name: "query and fragment", + input: "http://localhost:1234/my/path?token=abc&mode=preview#section", + suffix: "/my/path?token%3Dabc%26mode%3Dpreview#section", + }, + { + name: "encoded components", + input: "http://0.0.0.0:1234/my%20path/%23file?token=a%20b#my%20section", + suffix: "/my%20path/%23file?token%3Da%20b#my%20section", + }, + { + name: "root path", + input: "http://127.0.0.1:1234/", + suffix: "/", + }, + ] + + for (const { name, input, suffix } of cases) { + test(`asExternalUri should preserve ${name}`, async ({ codeServerPage }) => { + const address = await getMaybeProxiedCodeServer(codeServerPage) + const normalizedAddress = address.replace(/\/+$/, "") + const proxyBase = proxyEndpointTemplate + ? new URL(proxyEndpointTemplate.replace("{{port}}", "1234"), `${normalizedAddress}/`).toString() + : `${normalizedAddress}/proxy/1234/` + + await codeServerPage.waitForTestExtensionLoaded() + await codeServerPage.executeCommandViaMenus("code-server: asExternalUri test") + + await codeServerPage.page.waitForSelector(".quick-input-widget:focus-within") + await codeServerPage.page.keyboard.type(input) + await codeServerPage.page.keyboard.press("Enter") + + // The test extension displays URI.toString(), which also encodes query delimiters. + const output = `${proxyBase.replace(/\/$/, "")}${suffix}` + await expect( + codeServerPage.page.getByText(`Info: input: ${input} output: ${output}`, { exact: true }), + ).toBeVisible() + }) + } +} + +const flags = ["--disable-workspace-trust", "--extensions-dir", path.join(__dirname, "./extensions")] + +describe("Extensions", flags, {}, () => { + runTestExtensionTests() +}) + +for (const proxyEndpointTemplate of ["./proxy/{{port}}", "https://{{port}}-workspace.example.com"]) { + describe( + `Extensions with VSCODE_PROXY_URI=${proxyEndpointTemplate}`, + flags, + { VSCODE_PROXY_URI: proxyEndpointTemplate }, + () => { + runExternalUriTests(proxyEndpointTemplate) + }, + ) +} + +if (process.env.USE_PROXY !== "1") { + describe("Extensions with --cert", [...flags, "--cert"], {}, () => { + runTestExtensionTests() + }) +} else { + base.describe("Extensions with --cert", () => { + base.skip("skipped because USE_PROXY is set", () => { + // Playwright will not show this without a function. + }) + }) +} diff --git a/test/e2e/extensions/test-extension/.gitignore b/test/e2e/extensions/test-extension/.gitignore new file mode 100644 index 000000000000..e7b307d8c4f7 --- /dev/null +++ b/test/e2e/extensions/test-extension/.gitignore @@ -0,0 +1 @@ +/extension.js diff --git a/test/e2e/extensions/test-extension/extension.ts b/test/e2e/extensions/test-extension/extension.ts new file mode 100644 index 000000000000..a53e1a6f9878 --- /dev/null +++ b/test/e2e/extensions/test-extension/extension.ts @@ -0,0 +1,58 @@ +import * as vscode from "vscode" + +export function activate(context: vscode.ExtensionContext) { + vscode.window.showInformationMessage("test extension loaded") + + // Prints the current proxy URI into a notification. + context.subscriptions.push( + vscode.commands.registerCommand("codeServerTest.proxyUri", () => { + if (process.env.VSCODE_PROXY_URI) { + vscode.window.showInformationMessage(`proxyUri: ${process.env.VSCODE_PROXY_URI}`) + } else { + vscode.window.showErrorMessage("No proxy URI was set") + } + }), + ) + + // Asks for a URI, then runs it through asExternalUri and prints the result + // into a notification. + context.subscriptions.push( + vscode.commands.registerCommand("codeServerTest.asExternalUri", async () => { + const input = await vscode.window.showInputBox({ + prompt: "URL to pass through to asExternalUri", + }) + + if (input) { + const output = await vscode.env.asExternalUri(vscode.Uri.parse(input)) + vscode.window.showInformationMessage(`input: ${input} output: ${output}`) + } else { + vscode.window.showErrorMessage(`Failed to run test case. No input provided.`) + } + }), + ) + + const secretKey = "code-server-test-secret" + + // Asks for a string, then stores it as a secret. + context.subscriptions.push( + vscode.commands.registerCommand("codeServerTest.setSecret", async () => { + const input = await vscode.window.showInputBox({ + prompt: "Secret to store", + }) + + if (input) { + await context.secrets.store(secretKey, input) + vscode.window.showInformationMessage(`set secret: ${input}`) + } else { + vscode.window.showErrorMessage(`Failed to run test case. No input provided.`) + } + }), + ) + + // Prints the current secret, if any. + context.subscriptions.push( + vscode.commands.registerCommand("codeServerTest.getSecret", async () => { + vscode.window.showInformationMessage(`get secret: ${await context.secrets.get(secretKey)}`) + }), + ) +} diff --git a/test/e2e/extensions/test-extension/package-lock.json b/test/e2e/extensions/test-extension/package-lock.json new file mode 100644 index 000000000000..ec9e89af85f3 --- /dev/null +++ b/test/e2e/extensions/test-extension/package-lock.json @@ -0,0 +1,41 @@ +{ + "name": "code-server-extension", + "version": "0.0.1", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "code-server-extension", + "version": "0.0.1", + "license": "MIT", + "devDependencies": { + "@types/vscode": "^1.56.0", + "typescript": "^5.6.2" + }, + "engines": { + "vscode": "^1.56.0" + } + }, + "node_modules/@types/vscode": { + "version": "1.94.0", + "resolved": "https://registry.npmjs.org/@types/vscode/-/vscode-1.94.0.tgz", + "integrity": "sha512-UyQOIUT0pb14XSqJskYnRwD2aG0QrPVefIfrW1djR+/J4KeFQ0i1+hjZoaAmeNf3Z2jleK+R2hv+EboG/m8ruw==", + "dev": true, + "license": "MIT" + }, + "node_modules/typescript": { + "version": "5.6.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz", + "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + } + } +} diff --git a/test/e2e/extensions/test-extension/package.json b/test/e2e/extensions/test-extension/package.json new file mode 100644 index 000000000000..e965733890b5 --- /dev/null +++ b/test/e2e/extensions/test-extension/package.json @@ -0,0 +1,45 @@ +{ + "name": "code-server-extension", + "description": "code-server test extension", + "version": "0.0.1", + "publisher": "coder", + "license": "MIT", + "activationEvents": [ + "onStartupFinished" + ], + "engines": { + "vscode": "^1.56.0" + }, + "main": "./extension.js", + "contributes": { + "commands": [ + { + "command": "codeServerTest.proxyUri", + "title": "Get proxy URI", + "category": "code-server" + }, + { + "command": "codeServerTest.asExternalUri", + "title": "asExternalUri test", + "category": "code-server" + }, + { + "command": "codeServerTest.setSecret", + "title": "Set test secret", + "category": "code-server" + }, + { + "command": "codeServerTest.getSecret", + "title": "Get test secret", + "category": "code-server" + } + ] + }, + "devDependencies": { + "@types/vscode": "^1.56.0", + "typescript": "^5.6.2" + }, + "scripts": { + "build": "tsc" + } +} diff --git a/test/e2e/extensions/test-extension/tsconfig.json b/test/e2e/extensions/test-extension/tsconfig.json new file mode 100644 index 000000000000..17c0d751da96 --- /dev/null +++ b/test/e2e/extensions/test-extension/tsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "target": "es2020", + "module": "commonjs", + "outDir": ".", + "strict": true, + "baseUrl": "./", + "skipLibCheck": true + }, + "include": ["./extension.ts"], + "exclude": ["node_modules"] +} diff --git a/test/e2e/github.test.ts b/test/e2e/github.test.ts new file mode 100644 index 000000000000..aa45886bd1f6 --- /dev/null +++ b/test/e2e/github.test.ts @@ -0,0 +1,38 @@ +import { test as base } from "@playwright/test" +import { describe, expect, test } from "./baseFixture" + +if (process.env.GITHUB_TOKEN) { + describe("GitHub token", ["--disable-workspace-trust"], {}, () => { + test("should be logged in to pull requests extension", async ({ codeServerPage }) => { + await codeServerPage.exec("git init") + await codeServerPage.exec("git remote add origin https://github.com/coder/code-server") + await codeServerPage.installExtension("GitHub.vscode-pull-request-github") + await codeServerPage.executeCommandViaMenus("View: Show Github") + await codeServerPage.page.click("text=Sign in") + await codeServerPage.page.click("text=Allow") + // It should ask to select an account, one of which will be the one we + // pre-injected. + await expect(codeServerPage.page.locator("text=Select an account")).not.toBeVisible() + }) + }) + + describe("No GitHub token", ["--disable-workspace-trust"], { GITHUB_TOKEN: "" }, () => { + test("should not be logged in to pull requests extension", async ({ codeServerPage }) => { + await codeServerPage.exec("git init") + await codeServerPage.exec("git remote add origin https://github.com/coder/code-server") + await codeServerPage.installExtension("GitHub.vscode-pull-request-github") + await codeServerPage.executeCommandViaMenus("View: Show Github") + await codeServerPage.page.click("text=Sign in") + await codeServerPage.page.click("text=Allow") + // Since there is no account it will ask directly for the token (because + // we are on localhost; otherwise it would initiate the oauth flow). + await expect(codeServerPage.page.locator("text=GitHub Personal Access Token")).not.toBeVisible() + }) + }) +} else { + base.describe("GitHub token", () => { + base.skip("skipped because GITHUB_TOKEN is not set", () => { + // Playwright will not show this without a function. + }) + }) +} diff --git a/test/e2e/login.test.ts b/test/e2e/login.test.ts new file mode 100644 index 000000000000..2ce9ce8e8035 --- /dev/null +++ b/test/e2e/login.test.ts @@ -0,0 +1,62 @@ +import { PASSWORD } from "../utils/constants" +import { describe, test, expect } from "./baseFixture" + +describe("login", ["--disable-workspace-trust", "--auth", "password"], {}, () => { + test("should see the login page", async ({ codeServerPage }) => { + // It should send us to the login page + expect(await codeServerPage.page.title()).toBe("code-server login") + }) + + test("should be able to login", async ({ codeServerPage }) => { + // Type in password + await codeServerPage.page.fill(".password", PASSWORD) + // Click the submit button and login + await codeServerPage.page.click(".submit") + await codeServerPage.page.waitForLoadState("networkidle") + // We do this because occassionally code-server doesn't load on Firefox + // but loads if you reload once or twice + await codeServerPage.reloadUntilEditorIsReady() + // Make sure the editor actually loaded + expect(await codeServerPage.isEditorVisible()).toBe(true) + }) + + test("should see an error message for missing password", async ({ codeServerPage }) => { + // Skip entering password + // Click the submit button and login + await codeServerPage.page.click(".submit") + // The required input blocks empty submits, so the server-side error can't render. + await expect(codeServerPage.page.locator("input.password:invalid")).toBeVisible() + }) + + test("should see an error message for incorrect password", async ({ codeServerPage }) => { + // Type in password + await codeServerPage.page.fill(".password", "password123") + // Click the submit button and login + await codeServerPage.page.click(".submit") + await codeServerPage.page.waitForLoadState("networkidle") + await expect(codeServerPage.page.locator("text=Incorrect password")).toBeVisible() + }) + + test("should hit the rate limiter for too many unsuccessful logins", async ({ codeServerPage }) => { + test.slow() + // Click the submit button and login + // The current RateLimiter allows 2 logins per minute plus + // 12 logins per hour for a total of 14 + // See: src/node/routes/login.ts + for (let i = 1; i <= 14; i++) { + await codeServerPage.page.fill(".password", "password123") + await codeServerPage.page.click(".submit") + await codeServerPage.page.waitForLoadState("networkidle") + // We double-check that the correct error message shows + // which should be for incorrect password + await expect(codeServerPage.page.locator("text=Incorrect password")).toBeVisible() + } + + // The 15th should fail for a different reason: + // login rate + await codeServerPage.page.fill(".password", "password123") + await codeServerPage.page.click(".submit") + await codeServerPage.page.waitForLoadState("networkidle") + await expect(codeServerPage.page.locator("text=Login rate limited!")).toBeVisible() + }) +}) diff --git a/test/e2e/logout.test.ts b/test/e2e/logout.test.ts new file mode 100644 index 000000000000..eb9d57d659a8 --- /dev/null +++ b/test/e2e/logout.test.ts @@ -0,0 +1,12 @@ +// NOTE@jsjoeio commenting out until we can figure out what's wrong +// import { describe, test, expect } from "./baseFixture" + +// describe("logout", true, ["--disable-workspace-trust"], {}, () => { +// test("should be able logout", async ({ codeServerPage }) => { +// // Recommended by Playwright for async navigation +// // https://github.com/microsoft/playwright/issues/1987#issuecomment-620182151 +// await Promise.all([codeServerPage.page.waitForNavigation(), codeServerPage.navigateMenus(["Log Out"])]) +// const currentUrl = codeServerPage.page.url() +// expect(currentUrl).toBe(`${await codeServerPage.address()}/login`) +// }) +// }) diff --git a/test/e2e/models/CodeServer.ts b/test/e2e/models/CodeServer.ts new file mode 100644 index 000000000000..7829d79ee4db --- /dev/null +++ b/test/e2e/models/CodeServer.ts @@ -0,0 +1,602 @@ +import { field, Logger, logger } from "@coder/logger" +import * as cp from "child_process" +import { promises as fs } from "fs" +import * as path from "path" +import { Page } from "playwright" +import * as util from "util" +import { logError, normalize, plural } from "../../../src/common/util" +import { onLine } from "../../../src/node/util" +import { PASSWORD, workspaceDir } from "../../utils/constants" +import { getMaybeProxiedCodeServer, idleTimer, tmpdir } from "../../utils/helpers" + +interface CodeServerProcess { + process: cp.ChildProcess + address: string +} + +class Context { + private _canceled = false + private _done = false + public canceled(): boolean { + return this._canceled + } + public finished(): boolean { + return this._done + } + public cancel(): void { + this._canceled = true + } + public finish(): void { + this._done = true + } +} + +/** + * Class for spawning and managing code-server. + */ +export class CodeServer { + private process: Promise | undefined + public readonly logger: Logger + private closed = false + + constructor( + name: string, + private readonly args: string[], + private readonly env: NodeJS.ProcessEnv, + private _workspaceDir: Promise | string | undefined, + private readonly entry = process.env.CODE_SERVER_TEST_ENTRY || ".", + ) { + this.logger = logger.named(name) + } + + /** + * The address at which code-server can be accessed. Spawns code-server if it + * has not yet been spawned. + */ + async address(): Promise { + if (!this.process) { + this.process = this.spawn() + } + const { address } = await this.process + + return address + } + + /** + * The workspace directory code-server opens with. + */ + get workspaceDir(): Promise | string { + if (!this._workspaceDir) { + this._workspaceDir = tmpdir(workspaceDir) + } + return this._workspaceDir + } + + /** + * Create a random workspace and seed it with settings. + */ + private async createWorkspace(): Promise { + const dir = await this.workspaceDir + await fs.mkdir(path.join(dir, "User"), { recursive: true }) + await fs.writeFile( + path.join(dir, "User/settings.json"), + JSON.stringify({ + "workbench.startupEditor": "none", + // Disable the welcome popup so we can avoid having to click through it + // on every test. + "workbench.welcomePage.experimentalOnboarding": false, + }), + "utf8", + ) + + const extensionsDir = path.join(__dirname, "../extensions") + const languagepacksContent = { + es: { + hash: "8d919a946475223861fa0c62665a4c50", + extensions: [ + { + extensionIdentifier: { + id: "ms-ceintl.vscode-language-pack-es", + uuid: "47e020a1-33db-4cc0-a1b4-42f97781749a", + }, + version: "1.70.0", + }, + ], + translations: { + vscode: `${extensionsDir}/ms-ceintl.vscode-language-pack-es-1.70.0/translations/main.i18n.json`, + }, + label: "español", + }, + } + + // NOTE@jsjoeio - code-server should automatically generate the languagepacks.json for + // using different display languages. This is a temporary workaround until we fix that. + await fs.writeFile(path.join(dir, "languagepacks.json"), JSON.stringify(languagepacksContent)) + return dir + } + + /** + * Spawn a new code-server process with its own workspace and data + * directories. + */ + private async spawn(): Promise { + const dir = await this.createWorkspace() + const args = await this.argsWithDefaults([ + "--auth", + "none", + // The workspace to open. + ...(this.args.includes("--ignore-last-opened") ? [] : [dir]), + ...this.args, + // Using port zero will spawn on a random port. + "--bind-addr", + "127.0.0.1:0", + ]) + return new Promise((resolve, reject) => { + this.logger.debug("spawning `node " + args.join(" ") + "`") + const proc = cp.spawn("node", args, { + cwd: path.join(__dirname, "../../.."), + env: { + ...process.env, + ...this.env, + // Prevent code-server from using the existing instance when running + // the e2e tests from an integrated terminal. + VSCODE_IPC_HOOK_CLI: "", + PASSWORD, + }, + }) + + const timer = idleTimer("Failed to extract address; did the format change?", reject) + + proc.on("error", (error) => { + this.logger.error(error.message) + timer.dispose() + reject(error) + }) + + proc.on("close", (code) => { + const error = new Error("code-server closed unexpectedly. Try running with LOG_LEVEL=debug to see more info.") + if (!this.closed) { + this.logger.error(error.message, field("code", code)) + } + timer.dispose() + reject(error) + }) + + // Tracks when the HTTP and session servers are ready. + let httpAddress: string | undefined + let sessionAddress: string | undefined + + let resolved = false + proc.stdout.setEncoding("utf8") + onLine(proc, (line) => { + // As long as we are actively getting input reset the timer. If we stop + // getting input and still have not found the addresses the timer will + // reject. + timer.reset() + + // Log the line without the timestamp. + this.logger.debug(line.replace(/\[.+\]/, "")) + if (resolved) { + return + } + + let match = line.trim().match(/HTTPS? server listening on (https?:\/\/[.:\d]+)\/?$/) + if (match) { + // Cookies don't seem to work on IP addresses so swap to localhost. + // TODO: Investigate whether this is a bug with code-server. + httpAddress = match[1].replace("127.0.0.1", "localhost") + } + + match = line.trim().match(/Session server listening on (.+)$/) + if (match) { + sessionAddress = match[1] + } + + if (typeof httpAddress !== "undefined" && typeof sessionAddress !== "undefined") { + resolved = true + timer.dispose() + this.logger.debug(`code-server is ready: ${httpAddress} ${sessionAddress}`) + resolve({ process: proc, address: httpAddress }) + } + }) + }) + } + + /** + * Execute a short-lived command. + */ + async run(args: string[]): Promise { + args = await this.argsWithDefaults(args) + this.logger.debug("executing `node " + args.join(" ") + "`") + await util.promisify(cp.exec)("node " + args.join(" "), { + cwd: path.join(__dirname, "../../.."), + env: { + ...process.env, + ...this.env, + // Prevent code-server from using the existing instance when running + // the e2e tests from an integrated terminal. + VSCODE_IPC_HOOK_CLI: "", + }, + }) + } + + /** + * Combine arguments with defaults. + */ + private async argsWithDefaults(args: string[]): Promise { + // This will be used both as the workspace and data directory to ensure + // instances don't bleed into each other. + const dir = await this.workspaceDir + return [ + this.entry, + "--extensions-dir", + path.join(dir, "extensions"), + ...args, + // Setting the XDG variables would be easier and more thorough but the + // modules we import ignores those variables for non-Linux operating + // systems so use these flags instead. + "--config", + path.join(dir, "config.yaml"), + "--user-data-dir", + dir, + ] + } + + /** + * Close the code-server process. + */ + async close(): Promise { + logger.debug("closing") + if (this.process) { + const proc = (await this.process).process + this.closed = true // To prevent the close handler from erroring. + proc.kill() + } + } + + /** + * Whether or not authentication is enabled. + */ + authEnabled(): boolean { + return this.args.includes("password") + } +} + +/** + * This is a "Page Object Model" (https://playwright.dev/docs/pom/) meant to + * wrap over a page and represent actions on that page in a more readable way. + * This targets a specific code-server instance which must be passed in. + * Navigation and setup performed by this model will cause the code-server + * process to spawn if it hasn't yet. + */ +export class CodeServerPage { + private readonly editorSelector = "div.monaco-workbench" + + constructor( + private readonly codeServer: CodeServer, + public readonly page: Page, + ) { + this.page.on("console", (message) => { + this.codeServer.logger.debug(message.text()) + }) + this.page.on("pageerror", (error) => { + logError(this.codeServer.logger, "page", error) + }) + } + + address() { + return this.codeServer.address() + } + + /** + * The workspace directory code-server opens with. + */ + get workspaceDir() { + return this.codeServer.workspaceDir + } + + /** + * Navigate to a code-server endpoint (root by default). Then wait for the + * editor to become available. + */ + async navigate(endpoint = "/") { + const address = await getMaybeProxiedCodeServer(this.codeServer) + const noramlizedUrl = normalize(address + endpoint, true) + const to = new URL(noramlizedUrl) + + this.codeServer.logger.info(`navigating to ${to}`) + await this.page.goto(to.toString()) + + // Only reload editor if auth is not enabled. Otherwise we'll get stuck + // reloading the login page. + if (!this.codeServer.authEnabled()) { + await this.reloadUntilEditorIsReady() + } + } + + /** + * Checks if the editor is visible + * and that we are connected to the host + * + * Reload until both checks pass + */ + async reloadUntilEditorIsReady() { + this.codeServer.logger.debug("Waiting for editor to be ready...") + + const editorIsVisible = await this.isEditorVisible() + let reloadCount = 0 + + // Occassionally code-server timeouts in Firefox + // we're not sure why + // but usually a reload or two fixes it + // TODO@jsjoeio @oxy look into Firefox reconnection/timeout issues + while (!editorIsVisible) { + // When a reload happens, we want to wait for all resources to be + // loaded completely. Hence why we use that instead of DOMContentLoaded + // Read more: https://thisthat.dev/dom-content-loaded-vs-load/ + await this.page.waitForLoadState("load") + // Give it an extra second just in case it's feeling extra slow + await this.page.waitForTimeout(1000) + reloadCount += 1 + if (await this.isEditorVisible()) { + this.codeServer.logger.debug(`editor became ready after ${reloadCount} reloads`) + break + } + await this.page.reload() + } + + this.codeServer.logger.debug("Editor is ready!") + } + + /** + * Checks if the editor is visible + */ + async isEditorVisible() { + this.codeServer.logger.debug("Waiting for editor to be visible...") + // Make sure the editor actually loaded + await this.page.waitForSelector(this.editorSelector) + const visible = await this.page.isVisible(this.editorSelector) + + this.codeServer.logger.debug(`Editor is ${visible ? "not visible" : "visible"}!`) + + return visible + } + + /** + * Checks if the test extension loaded by waiting for its notification. Once + * it appears, dismiss the notification. + */ + async waitForTestExtensionLoaded(): Promise { + this.codeServer.logger.debug("Waiting for test extension to load...") + const locator = this.page.getByRole("dialog", { name: "Info: test extension loaded" }) + await locator.hover() + await locator.getByLabel("Clear Notification (Del)").click() + } + + /** + * Focuses the integrated terminal by navigating through the command palette. + * + * This should focus the terminal no matter if it already has focus and/or is + * or isn't visible already. It will always create a new terminal to avoid + * clobbering parallel tests. + */ + async focusTerminal() { + const doFocus = async (): Promise => { + await this.executeCommandViaMenus("Terminal: Create New Terminal") + try { + await this.page.waitForLoadState("load") + await this.page.waitForSelector("textarea.xterm-helper-textarea:focus-within", { timeout: 5000 }) + return true + } catch (error) { + return false + } + } + + let attempts = 1 + while (!(await doFocus())) { + ++attempts + this.codeServer.logger.debug(`no focused terminal textarea, retrying (${attempts}/∞)`) + } + + this.codeServer.logger.debug(`opening terminal took ${attempts} ${plural(attempts, "attempt")}`) + } + + /** + * Open a file by using menus. + */ + async openFile(file: string) { + await this.navigateMenus(["File", "Open File..."]) + await this.navigateQuickInput([path.basename(file)]) + await this.waitForTab(file) + } + + /** + * Open a file through an external command. + */ + async openFileExternally(file: string) { + await this.codeServer.run(["--reuse-window", file]) + } + + /** + * Wait for a tab to open for the specified file. + */ + async waitForTab(file: string): Promise { + await this.page.waitForSelector(`.tab :text("${path.basename(file)}")`) + } + + /** + * See if the specified tab is open. + */ + async tabIsVisible(file: string): Promise { + return this.page.isVisible(`.tab :text("${path.basename(file)}")`) + } + + /** + * Navigate to the command palette via menus then execute a command by typing + * it then clicking the match from the results. + */ + async executeCommandViaMenus(command: string) { + await this.navigateMenus(["View", "Command Palette..."]) + + await this.page.waitForSelector(".quick-input-widget:focus-within") + await this.page.keyboard.type(command) + + await this.page.hover(`text=${command}`) + await this.page.click(`text=${command}`) + } + + /** + * Navigate through the items in the selector. `open` is a function that will + * open the menu/popup containing the items through which to navigation. + */ + async navigateItems(items: string[], selector: string, open?: (selector: string) => void): Promise { + const logger = this.codeServer.logger.named(selector) + + /** + * If the selector loses focus or gets removed this will resolve with false, + * signaling we need to try again. + */ + const openThenWaitClose = async (ctx: Context) => { + if (open) { + await open(selector) + } + this.codeServer.logger.debug(`watching ${selector}`) + try { + await this.page.waitForSelector(`${selector}:not(:focus-within)`) + } catch (error) { + if (!ctx.finished()) { + this.codeServer.logger.debug(`${selector} navigation: ${(error as any).message || error}`) + } + } + return false + } + + /** + * This will step through each item, aborting and returning false if + * canceled or if any navigation step has an error which signals we need to + * try again. + */ + const navigate = async (ctx: Context) => { + const steps: Array<{ fn: () => Promise; name: string }> = [ + { + fn: () => this.page.waitForSelector(`${selector}:focus-within`), + name: "focus", + }, + ] + + for (const item of items) { + // Normally these will wait for the item to be visible and then execute + // the action. The problem is that if the menu closes these will still + // be waiting and continue to execute once the menu is visible again, + // potentially conflicting with the new set of navigations (for example + // if the old promise clicks logout before the new one can). By + // splitting them into two steps each we can cancel before running the + // action. + steps.push({ + fn: () => this.page.hover(`${selector} :text-is("${item}")`, { trial: true }), + name: `${item}:hover:trial`, + }) + steps.push({ + fn: () => this.page.hover(`${selector} :text-is("${item}")`, { force: true }), + name: `${item}:hover:force`, + }) + steps.push({ + fn: () => this.page.click(`${selector} :text-is("${item}")`, { trial: true }), + name: `${item}:click:trial`, + }) + steps.push({ + fn: () => this.page.click(`${selector} :text-is("${item}")`, { force: true }), + name: `${item}:click:force`, + }) + } + + for (const step of steps) { + try { + logger.debug(`navigation step: ${step.name}`) + await step.fn() + if (ctx.canceled()) { + logger.debug("navigation canceled") + return false + } + } catch (error) { + logger.debug(`navigation: ${(error as any).message || error}`) + return false + } + } + return true + } + + // We are seeing the menu closing after opening if we open it too soon and + // the picker getting recreated in the middle of trying to select an item. + // To counter this we will keep trying to navigate through the items every + // time we lose focus or there is an error. + let attempts = 1 + let context = new Context() + while (!(await Promise.race([openThenWaitClose(context), navigate(context)]))) { + ++attempts + logger.debug(`closed, retrying (${attempts}/∞)`) + context.cancel() + context = new Context() + } + + context.finish() + logger.debug(`navigation took ${attempts} ${plural(attempts, "attempt")}`) + } + + /** + * Navigate through a currently opened "quick input" widget, retrying on + * failure. + */ + async navigateQuickInput(items: string[]): Promise { + await this.navigateItems(items, ".quick-input-widget") + } + + /** + * Navigate through the menu, retrying on failure. + */ + async navigateMenus(menus: string[]): Promise { + await this.navigateItems(menus, '[aria-label="Application Menu"]', async (selector) => { + await this.page.click(selector) + }) + } + + /** + * Open context menu on the specified selector. + */ + async openContextMenu(selector: string): Promise { + const el = await this.page.waitForSelector(selector) + await el.click({ button: "right" }) + await this.page.waitForSelector(".context-view-block") + } + + /** + * Execute a command in the root of the instance's workspace directory. + */ + async exec(command: string): Promise { + await util.promisify(cp.exec)(command, { + cwd: await this.workspaceDir, + }) + } + + /** + * Install an extension by ID to the instance's temporary extension + * directory. + */ + async installExtension(id: string): Promise { + const dir = path.join(await this.workspaceDir, "extensions") + await util.promisify(cp.exec)(`node . --install-extension ${id} --extensions-dir ${dir}`, { + cwd: path.join(__dirname, "../../.."), + }) + } + + /** + * Wait for state to be flushed to the database. + */ + async stateFlush(): Promise { + // If we reload too quickly VS Code will be unable to save the state changes + // so wait until those have been written to the database. It flushes every + // five seconds so we need to wait at least that long. + // TODO@asher: There must be a better way. + await this.page.waitForTimeout(5500) + } +} diff --git a/test/e2e/openHelpAbout.test.ts b/test/e2e/openHelpAbout.test.ts new file mode 100644 index 000000000000..b21fca35ea41 --- /dev/null +++ b/test/e2e/openHelpAbout.test.ts @@ -0,0 +1,17 @@ +import { version } from "../../src/node/constants" +import { describe, test, expect } from "./baseFixture" + +describe("Open Help > About", ["--disable-workspace-trust"], {}, () => { + test("should see code-server version in about dialog", async ({ codeServerPage }) => { + // Open using the menu. + await codeServerPage.navigateMenus(["Help", "About"]) + + const isDevMode = process.env.VSCODE_DEV === "1" + + // Look for code-server info div. + const element = await codeServerPage.page.waitForSelector( + `div[role="dialog"] >> text=code-server: ${isDevMode ? "Unknown" : "v" + version}`, + ) + expect(element).not.toBeNull() + }) +}) diff --git a/test/e2e/routes.test.ts b/test/e2e/routes.test.ts new file mode 100644 index 000000000000..39c19697e9b9 --- /dev/null +++ b/test/e2e/routes.test.ts @@ -0,0 +1,125 @@ +import { clean, getMaybeProxiedPathname } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" + +const routes = { + "/": [ + /\.\/manifest.json/, + /\.\/_static\//, + /[a-z]+-[0-9a-z]+\/static\//, + /http:\/\/localhost:[0-9]+\/[a-z]+-[0-9a-z]+\/static\//, + ], + "/vscode": [ + /\.\/vscode\/manifest.json/, + /\.\/_static\//, + /vscode\/[a-z]+-[0-9a-z]+\/static\//, + /http:\/\/localhost:[0-9]+\/vscode\/[a-z]+-[0-9a-z]+\/static\//, + ], + "/vscode/": [ + /\.\/manifest.json/, + /\.\/\.\.\/_static\//, + /[a-z]+-[0-9a-z]+\/static\//, + /http:\/\/localhost:[0-9]+\/vscode\/[a-z]+-[0-9a-z]+\/static\//, + ], +} + +describe("VS Code Routes", ["--disable-workspace-trust"], {}, async () => { + const testName = "vscode-routes-default" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should load all route variations", async ({ codeServerPage }) => { + for (const [route, matchers] of Object.entries(routes)) { + await codeServerPage.navigate(route) + + // Check there were no redirections + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe(route) + + // Check that assets are pointing to the right spot. Some will be + // relative, without a leading dot (VS Code's assets). Some will be + // relative with a leading dot (our assets). Others will have been + // resolved against the origin. + const elements = await codeServerPage.page.locator("[src]").all() + for (const element of elements) { + const src = await element.getAttribute("src") + if (src && !matchers.some((m) => m.test(src))) { + throw new Error(`${src} did not match any validators for route ${route}`) + } + } + } + }) +}) + +const CODE_WORKSPACE_DIR = process.env.CODE_WORKSPACE_DIR || "" +describe("VS Code Routes with code-workspace", ["--disable-workspace-trust", CODE_WORKSPACE_DIR], {}, async () => { + test("should redirect to the passed in workspace using human-readable query", async ({ codeServerPage }) => { + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe("/") + expect(url.search).toBe(`?workspace=${CODE_WORKSPACE_DIR}`) + }) +}) + +const CODE_FOLDER_DIR = process.env.CODE_FOLDER_DIR || "" +describe("VS Code Routes with code-workspace", ["--disable-workspace-trust", CODE_FOLDER_DIR], {}, async () => { + test("should redirect to the passed in folder using human-readable query", async ({ codeServerPage }) => { + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe("/") + expect(url.search).toBe(`?folder=${CODE_FOLDER_DIR}`) + }) +}) + +describe( + "VS Code Routes with ignore-last-opened", + ["--disable-workspace-trust", "--ignore-last-opened"], + {}, + async () => { + test("should not redirect", async ({ codeServerPage }) => { + const folder = process.env.CODE_FOLDER_DIR + + await codeServerPage.navigate(`/?folder=${folder}`) + await codeServerPage.navigate(`/`) + + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe("/") + expect(url.search).toBe("") + }) + }, +) + +describe("VS Code Routes with no workspace or folder", ["--disable-workspace-trust"], {}, async () => { + test("should redirect to last query folder/workspace", async ({ codeServerPage }) => { + const folder = process.env.CODE_FOLDER_DIR + const workspace = process.env.CODE_WORKSPACE_DIR + await codeServerPage.navigate(`/?folder=${folder}&workspace=${workspace}`) + + // If you visit again without query parameters it will re-attach them by + // redirecting. It should always redirect to the same route. + for (const route of Object.keys(routes)) { + await codeServerPage.navigate(route) + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe(route) + expect(url.search).toBe(`?folder=${folder}&workspace=${workspace}`) + } + }) +}) + +describe("VS Code Routes with no workspace or folder", ["--disable-workspace-trust"], {}, async () => { + test("should not redirect if ew passed in", async ({ codeServerPage }) => { + const folder = process.env.CODE_FOLDER_DIR + const workspace = process.env.CODE_WORKSPACE_DIR + await codeServerPage.navigate(`/?folder=${folder}&workspace=${workspace}`) + + // Closing the folder should stop the redirecting. + await codeServerPage.navigate("/?ew=true") + const url = new URL(codeServerPage.page.url()) + const pathname = getMaybeProxiedPathname(url) + expect(pathname).toBe("/") + expect(url.search).toBe("?ew=true") + }) +}) diff --git a/test/e2e/settings.test.ts b/test/e2e/settings.test.ts new file mode 100644 index 000000000000..3e595479e409 --- /dev/null +++ b/test/e2e/settings.test.ts @@ -0,0 +1,17 @@ +import { clean } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" + +describe("settings", ["--disable-workspace-trust"], {}, () => { + const testName = "settings-local" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should see startup editor set to none", async ({ codeServerPage }) => { + await codeServerPage.navigateMenus(["File", "Preferences", "Settings"]) + await codeServerPage.page.waitForSelector(".settings-editor") + await codeServerPage.page.keyboard.type("startupEditor") + const el = codeServerPage.page.getByLabel("workbench.startupEditor") + await expect(el).toHaveValue("none") + }) +}) diff --git a/test/e2e/storage.test.ts b/test/e2e/storage.test.ts new file mode 100644 index 000000000000..d0a43d6f5b27 --- /dev/null +++ b/test/e2e/storage.test.ts @@ -0,0 +1,61 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { describe, test, expect } from "./baseFixture" + +const tests = [ + { + name: "browser storage", + args: [], + }, + { + name: "remote storage", + args: ["--enable-remote-storage"], + }, +] + +for (const tc of tests) { + const args = ["--disable-workspace-trust", "--extensions-dir", path.join(__dirname, "./extensions"), ...tc.args] + describe(tc.name, args, {}, () => { + test("should store workbench state and secrets", async ({ codeServerPage }) => { + // Create and open a file. + const dir = await codeServerPage.workspaceDir + const file = path.join(dir, "foo") + await fs.writeFile(file, "bar") + await codeServerPage.openFile(file) + + // Store a secret. + const secret = "foo-bar-baz" + await codeServerPage.waitForTestExtensionLoaded() + await codeServerPage.executeCommandViaMenus("code-server: Set test secret") + await codeServerPage.page.waitForSelector(".quick-input-widget:focus-within") + await codeServerPage.page.keyboard.type(secret) + await codeServerPage.page.keyboard.press("Enter") + await expect(codeServerPage.page.getByText(`Info: set secret: ${secret}`)).toBeVisible() + + // There should be a workspace storage directory. + const userDir = path.join(dir, "User/workspaceStorage") + const dirs = await fs.readdir(userDir) + expect(dirs.length).toBe(1) + + const storageFile = path.join(userDir, dirs[0], "state.vscdb") + if (tc.args.includes("--enable-remote-storage")) { + // The sqlite database should exist. + fs.stat(storageFile) + } else { + // But no sqlite database. + expect(() => fs.stat(storageFile)).rejects.toThrow("ENOENT") + } + + // Reload using a command so it has a chance to flush storage. + await codeServerPage.executeCommandViaMenus("Developer: Reload Window") + await codeServerPage.waitForTestExtensionLoaded() + + // Should see the same file. + await codeServerPage.waitForTab(file) + + // Should be able to retrieve the secret. + await codeServerPage.executeCommandViaMenus("code-server: Get test secret") + await expect(codeServerPage.page.getByText(`Info: get secret: ${secret}`)).toBeVisible() + }) + }) +} diff --git a/test/e2e/terminal.test.ts b/test/e2e/terminal.test.ts new file mode 100644 index 000000000000..0de4f222a2a3 --- /dev/null +++ b/test/e2e/terminal.test.ts @@ -0,0 +1,53 @@ +import * as cp from "child_process" +import { promises as fs } from "fs" +import * as path from "path" +import util from "util" +import { clean, getMaybeProxiedCodeServer, tmpdir } from "../utils/helpers" +import { describe, expect, test } from "./baseFixture" + +describe("Integrated Terminal", ["--disable-workspace-trust"], {}, () => { + const testName = "integrated-terminal" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should have access to VSCODE_PROXY_URI", async ({ codeServerPage }) => { + const tmpFolderPath = await tmpdir(testName) + const tmpFile = path.join(tmpFolderPath, "pipe") + + const command = `mkfifo '${tmpFile}' && cat '${tmpFile}'` + const exec = util.promisify(cp.exec) + const output = exec(command, { encoding: "utf8" }) + + // Open terminal and type in value + await codeServerPage.focusTerminal() + + await codeServerPage.page.keyboard.type(`printenv VSCODE_PROXY_URI > ${tmpFile}`) + await codeServerPage.page.keyboard.press("Enter") + + const { stdout } = await output + const address = await getMaybeProxiedCodeServer(codeServerPage) + expect(stdout).toMatch(address) + }) + + // TODO@jsjoeio - add test to make sure full code-server path works + test("should be able to invoke `code-server` to open a file", async ({ codeServerPage }) => { + const tmpFolderPath = await tmpdir(testName) + const tmpFile = path.join(tmpFolderPath, "test-file") + await fs.writeFile(tmpFile, "test") + + await codeServerPage.focusTerminal() + + await codeServerPage.page.keyboard.type(`code-server ${tmpFile}`) + await codeServerPage.page.keyboard.press("Enter") + + await codeServerPage.waitForTab(path.basename(tmpFile)) + + const externalTmpFile = path.join(tmpFolderPath, "test-external-file") + await fs.writeFile(externalTmpFile, "foobar") + + await codeServerPage.openFileExternally(externalTmpFile) + + await codeServerPage.waitForTab(path.basename(externalTmpFile)) + }) +}) diff --git a/test/e2e/typescript.test.ts b/test/e2e/typescript.test.ts new file mode 100644 index 000000000000..5a2d5c760290 --- /dev/null +++ b/test/e2e/typescript.test.ts @@ -0,0 +1,19 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { describe, test, expect } from "./baseFixture" + +const args = ["--disable-workspace-trust"] + +describe("typescript extension", args, {}, () => { + test("should load as a workspace extension", async ({ codeServerPage }) => { + const dir = await codeServerPage.workspaceDir + const file = path.join(dir, "foo.ts") + await fs.writeFile(file, 'const n: number = "x"') + await codeServerPage.openFile(file) + + await codeServerPage.executeCommandViaMenus("Developer: Show Running Extensions") + await expect( + codeServerPage.page.getByLabel("typescript-language-features").getByText(/localhost:\d+/), + ).toBeVisible() + }) +}) diff --git a/test/e2e/uploads.test.ts b/test/e2e/uploads.test.ts new file mode 100644 index 000000000000..05bb9ffd98a3 --- /dev/null +++ b/test/e2e/uploads.test.ts @@ -0,0 +1,56 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { clean } from "../utils/helpers" +import { describe, test, expect } from "./baseFixture" + +describe("Uploads (enabled)", ["--disable-workspace-trust"], {}, () => { + const testName = "uploads-enabled" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should see the 'Upload...' option", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const tmpDirPath = path.join(workspaceDir, "test-directory") + await fs.mkdir(tmpDirPath) + + // Action + await codeServerPage.openContextMenu('span:has-text("test-directory")') + + await expect(codeServerPage.page.locator("text=Upload...")).toBeVisible() + }) + + test("should see the 'Show Local' button on Open File", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "Open File..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).toBeVisible() + }) +}) + +describe("Uploads (disabled)", ["--disable-workspace-trust", "--disable-file-uploads"], {}, () => { + const testName = "uploads-disabled" + test.beforeAll(async () => { + await clean(testName) + }) + + test("should not see the 'Upload...' option", async ({ codeServerPage }) => { + // Setup + const workspaceDir = await codeServerPage.workspaceDir + const tmpDirPath = path.join(workspaceDir, "test-directory") + await fs.mkdir(tmpDirPath) + + // Action + await codeServerPage.openContextMenu('span:has-text("test-directory")') + + await expect(codeServerPage.page.locator("text=Upload...")).not.toBeVisible() + }) + + test("should not see the 'Show Local' button on Open File", async ({ codeServerPage }) => { + // Action + await codeServerPage.navigateMenus(["File", "Open File..."]) + await codeServerPage.page.waitForSelector(".quick-input-widget") + await expect(codeServerPage.page.locator("text=Show Local")).not.toBeVisible() + }) +}) diff --git a/test/e2e/webview.test.ts b/test/e2e/webview.test.ts new file mode 100644 index 000000000000..e5a783f37322 --- /dev/null +++ b/test/e2e/webview.test.ts @@ -0,0 +1,25 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { describe, test, expect } from "./baseFixture" + +describe("Webviews", ["--disable-workspace-trust"], {}, () => { + test("should preview a Markdown file", async ({ codeServerPage }) => { + // Create Markdown file + const heading = "Hello world" + const dir = await codeServerPage.workspaceDir + const file = path.join(dir, "text.md") + await fs.writeFile(file, `# ${heading}`) + await codeServerPage.openFile(file) + + // Open Preview + await codeServerPage.executeCommandViaMenus("Markdown: Open Preview to the Side") + // Wait for the iframe to open and load + await codeServerPage.waitForTab(`Preview ${file}`) + + // It's an iframe within an iframe + // so we have to do .frameLocator twice + await expect( + codeServerPage.page.frameLocator("iframe.webview.ready").frameLocator("#active-frame").getByText("Hello world"), + ).toBeVisible() + }) +}) diff --git a/test/integration/help.test.ts b/test/integration/help.test.ts new file mode 100644 index 000000000000..12786f282524 --- /dev/null +++ b/test/integration/help.test.ts @@ -0,0 +1,13 @@ +import { runCodeServerCommand } from "../utils/runCodeServerCommand" + +// NOTE@jsjoeio +// We have this test to ensure that native modules +// work as expected. If this is called on the wrong +// platform, the test will fail. +describe("--help", () => { + it("should list code-server usage", async () => { + const expectedOutput = "Usage: code-server [options] [path]" + const { stdout } = await runCodeServerCommand(["--help"]) + expect(stdout).toMatch(expectedOutput) + }, 20000) +}) diff --git a/test/integration/installExtension.test.ts b/test/integration/installExtension.test.ts new file mode 100644 index 000000000000..5986c964e912 --- /dev/null +++ b/test/integration/installExtension.test.ts @@ -0,0 +1,22 @@ +import { clean, tmpdir } from "../utils/helpers" +import { runCodeServerCommand } from "../utils/runCodeServerCommand" + +describe("--install-extension", () => { + const testName = "installExtension" + let tempDir: string + let setupFlags: string[] + + beforeEach(async () => { + await clean(testName) + tempDir = await tmpdir(testName) + setupFlags = ["--extensions-dir", tempDir] + }) + it("should use EXTENSIONS_GALLERY when set", async () => { + const extName = "author.extension" + await expect( + runCodeServerCommand([...setupFlags, "--install-extension", extName], { + EXTENSIONS_GALLERY: "{}", + }), + ).rejects.toThrow("No extension gallery service configured") + }) +}) diff --git a/test/package-lock.json b/test/package-lock.json new file mode 100644 index 000000000000..8c89e338e888 --- /dev/null +++ b/test/package-lock.json @@ -0,0 +1,4925 @@ +{ + "name": "test", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "license": "MIT", + "devDependencies": { + "@jest-mock/express": "^1.4.5", + "@playwright/test": "^1.61.0", + "@types/jest": "^27.0.2", + "@types/jsdom": "^16.2.13", + "@types/node-fetch": "^2.5.8", + "@types/wtfnode": "^0.7.0", + "argon2": "^0.44.0", + "extract-zip": "^2.0.1", + "jest": "^27.3.1", + "jest-fetch-mock": "^3.0.3", + "jsdom": "^16.4.0", + "node-fetch": "^2.6.7", + "playwright": "^1.61.0", + "ts-jest": "^27.0.7", + "wtfnode": "^0.9.1" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.7.tgz", + "integrity": "sha512-Aup7aUOfpbAUg2ROOJN6Iw5f9DMBlzu0mIkm/malLQFN/YQgO48wCj0Kxa3sEHJvPVFg7siR+qRInwXd2qhQKw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.29.7", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/compat-data": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.7.tgz", + "integrity": "sha512-locTkQyKvwIEgBzVrn8693ebc97F2U8ZHjbXwDXJ5Fn2TCpNwTlKcaKLkdHop5c/icOFE7qt7Q9JC5hnKNa6Gg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.7.tgz", + "integrity": "sha512-RgHBCvtjbOK2gXSNBNIkNoEc9qoVEtau3hj8gEqKQuL3HZAibKarWFEI3Lfm6EYKkLalOh8eSrj9b+ch9H/VBA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.7", + "@babel/helper-compilation-targets": "^7.29.7", + "@babel/helper-module-transforms": "^7.29.7", + "@babel/helpers": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/template": "^7.29.7", + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7", + "@jridgewell/remapping": "^2.3.5", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/core/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/generator": { + "version": "7.29.8", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.8.tgz", + "integrity": "sha512-gZbepsdh3WDtgZKWL+vTPh71LSBrm/Y4/QDZBVCcYfmeTEEuoOYwlSy+G1StfJg+/Zy550u/3TATbm7qDbbMtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.8", + "@babel/types": "^7.29.8", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.29.7.tgz", + "integrity": "sha512-wem6WaBj4NaVYVdNhLPPVacES6ZJ+KBBfSkTMD3YZxbP3rm3Di85tJU5ljaUNhaOynt+Aj0xruhYuzQBt8n71g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.29.7", + "@babel/helper-validator-option": "^7.29.7", + "browserslist": "^4.24.0", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/@babel/helper-globals": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.29.7.tgz", + "integrity": "sha512-3nQVUAtvkKH9zahfWgw96Jc/uFOmjACE1kQz82E2lqWmHBgjzbNlsC22nuQTfahmWeQtTq5nQ/4Nnd2A1wj4zA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.29.7.tgz", + "integrity": "sha512-ejHwrQQYcm9xnTivShn2IDOlIzInN34AXskvq9QicvCtEzq1Vzclu/tKF8Jq1Cg8JG2GL6/EmjgsCT7lXepE3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.29.7", + "@babel/types": "^7.29.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.29.7.tgz", + "integrity": "sha512-UPUVSyXbOh627KiCIGQSgwWzGeBKLkaJ9PJEdrngIwMSzxLR4jS4+f1f1jb7VzBbg8nFLaYotvVPFCTqdrmTAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7", + "@babel/traverse": "^7.29.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.25.7", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.25.7.tgz", + "integrity": "sha512-eaPZai0PiqCi09pPs3pAFfl/zYgGaE6IdXtYvmf0qlcDTd3WCtO7JWCcRd64e0EQrcYgiHibEZnOGsSY4QSgaw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.29.7.tgz", + "integrity": "sha512-Pb5ijPrZ89GDH8223L4UP8i6QApWxs04RbPQJTeWDV0/keR2E36MeKnyr6LYmUUvqRRI+Iv87SuF1W6ErINzYw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.29.7.tgz", + "integrity": "sha512-qehxGkRj55h/ff8EMaJ+cYhyaKlHIxqYDn682wQD7RNp9UujOQsHog2uS0r2vzr4pW+sXf90NeeayjcNaX3fFg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.29.7.tgz", + "integrity": "sha512-N9ZErrD+yW5geCDtBqnOoxmR8+tNKiGuxKlDpuJxfsqpa2dFcexaziGAE/qoHLiDDreVNMupxGmSoNlyvsA3gw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.29.10", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.10.tgz", + "integrity": "sha512-EMCx3AGZ3WfAl6ht7AyQoPm2Lh+BGYEMdc4Q6Hf7uSCDOZFuLq44qNwL+iaim8VlyYhRAo4X43+weadK8ZB4Yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.8" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.29.9", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.9.tgz", + "integrity": "sha512-CjXrNHTnvqBVqHgdBysY3vk2T8tpJHb5/RMeHJBTyVa9xgugCB0CJTx/3oO8RV2QRQP391RWpB7D6hLjm8V9uA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.29.8" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-syntax-async-generators": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", + "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-bigint": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz", + "integrity": "sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-properties": { + "version": "7.12.13", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", + "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.12.13" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-static-block": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", + "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.25.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.25.7.tgz", + "integrity": "sha512-AqVo+dguCgmpi/3mYBdu9lkngOBlQ2w2vnNpa6gfiCxQZLzV4ZbhsXitJ2Yblkoe1VQwtHSaNmIaGll/26YWRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-meta": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", + "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-json-strings": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", + "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-logical-assignment-operators": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", + "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", + "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-numeric-separator": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", + "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-object-rest-spread": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", + "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-catch-binding": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", + "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-chaining": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", + "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-private-property-in-object": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", + "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-top-level-await": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", + "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.25.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.7.tgz", + "integrity": "sha512-rR+5FDjpCHqqZN2bzZm18bVYGaejGq5ZkpVCJLXor/+zlSrSoc4KWcHI0URVWjl/68Dyr1uwZUz/1njycEAv9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/template": { + "version": "7.29.7", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.29.7.tgz", + "integrity": "sha512-puq+Gf35oI24FeN11LkoUQFqv9uwNeWpxXZi/Ji3rRIoKAzKnxRaZ+Gkj0vKS9ZCiTESfng1N9LyOyXvo+m+Gg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.7", + "@babel/parser": "^7.29.7", + "@babel/types": "^7.29.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.29.10", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.10.tgz", + "integrity": "sha512-B3lYAs2nkKskbgQ1nfy8Ma9ao9Q1rntTAQHrzzyDuj+TSO+X3le6PfWwqDvodsb+OumE10eMFfuMCTQSQ5iuIQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.29.7", + "@babel/generator": "^7.29.8", + "@babel/helper-globals": "^7.29.7", + "@babel/parser": "^7.29.9", + "@babel/template": "^7.29.7", + "@babel/types": "^7.29.8", + "debug": "^4.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.29.8", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.8.tgz", + "integrity": "sha512-Vj1jF3cPfxg7OAfoI7QnVKLoILlm2JF9pnVHrX8qx7AHMiYWT+NDAA7jChlNgRS4WTLc/fD1lXLmPixluj+3Gg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.29.7", + "@babel/helper-validator-identifier": "^7.29.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@epic-web/invariant": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@epic-web/invariant/-/invariant-1.0.0.tgz", + "integrity": "sha512-lrTPqgvfFQtR/eY/qkIzp98OGdNJu0m5ji3q/nJI8v3SXkRKEnWiOxMmbvcSoAIzv/cGiuvRy57k4suKQSAdwA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@istanbuljs/load-nyc-config": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", + "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.3.1", + "find-up": "^4.1.0", + "get-package-type": "^0.1.0", + "js-yaml": "^3.13.1", + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/schema": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", + "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/@jest-mock/express": { + "version": "1.4.5", + "resolved": "https://registry.npmjs.org/@jest-mock/express/-/express-1.4.5.tgz", + "integrity": "sha512-bERM1jnutyH7VMahdaOHAKy7lgX47zJ7+RTz2eMz0wlCttd9CkhsKFEyoWmJBSz/ow0nVj3lCuRqLem4QDYFkQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jest/console": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.5.1.tgz", + "integrity": "sha512-kZ/tNpS3NXn0mlXXXPNuDZnb4c0oZ20r4K5eemM2k30ZC3G0T02nXUvyhf5YdbXWHPEJLc9qGLxEZ216MdL+Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "jest-message-util": "^27.5.1", + "jest-util": "^27.5.1", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/core": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.5.1.tgz", + "integrity": "sha512-AK6/UTrvQD0Cd24NSqmIA6rKsu0tKIxfiCducZvqxYdmMisOYAsdItspT+fQDQYARPf8XgjAFZi0ogW2agH5nQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/reporters": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "emittery": "^0.8.1", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "jest-changed-files": "^27.5.1", + "jest-config": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-resolve-dependencies": "^27.5.1", + "jest-runner": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "jest-watcher": "^27.5.1", + "micromatch": "^4.0.4", + "rimraf": "^3.0.0", + "slash": "^3.0.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/environment": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.5.1.tgz", + "integrity": "sha512-/WQjhPJe3/ghaol/4Bq480JKXV/Rfw8nQdN7f41fM8VDHLcxKXou6QyXAh3EFr9/bVG3x74z1NWDkP87EiY8gA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/fake-timers": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.5.1.tgz", + "integrity": "sha512-/aPowoolwa07k7/oM3aASneNeBGCmGQsc3ugN4u6s4C/+s5M64MFo/+djTdiwcbQlRfFElGuDXWzaWj6QgKObQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@sinonjs/fake-timers": "^8.0.1", + "@types/node": "*", + "jest-message-util": "^27.5.1", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/globals": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.5.1.tgz", + "integrity": "sha512-ZEJNB41OBQQgGzgyInAv0UUfDDj3upmHydjieSxFvTRuZElrx7tXg/uVQ5hYVEwiXs3+aMsAeEc9X7xiSKCm4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/types": "^27.5.1", + "expect": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/reporters": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.5.1.tgz", + "integrity": "sha512-cPXh9hWIlVJMQkVk84aIvXuBB4uQQmFqZiacloFuGiP3ah1sbCxCosidXFDfqG8+6fO1oR2dTJTlsOy4VFmUfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@bcoe/v8-coverage": "^0.2.3", + "@jest/console": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "collect-v8-coverage": "^1.0.0", + "exit": "^0.1.2", + "glob": "^7.1.2", + "graceful-fs": "^4.2.9", + "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-instrument": "^5.1.0", + "istanbul-lib-report": "^3.0.0", + "istanbul-lib-source-maps": "^4.0.0", + "istanbul-reports": "^3.1.3", + "jest-haste-map": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "slash": "^3.0.0", + "source-map": "^0.6.0", + "string-length": "^4.0.1", + "terminal-link": "^2.0.0", + "v8-to-istanbul": "^8.1.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/source-map": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.5.1.tgz", + "integrity": "sha512-y9NIHUYF3PJRlHk98NdC/N1gl88BL08aQQgu4k4ZopQkCw9t9cV8mtl3TV8b/YCB8XaVTFrmUTAJvjsntDireg==", + "dev": true, + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0", + "graceful-fs": "^4.2.9", + "source-map": "^0.6.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/test-result": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.5.1.tgz", + "integrity": "sha512-EW35l2RYFUcUQxFJz5Cv5MTOxlJIQs4I7gxzi2zVU7PJhOwfYq1MdC5nhSmYjX1gmMmLPvB3sIaC+BkcHRBfag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/istanbul-lib-coverage": "^2.0.0", + "collect-v8-coverage": "^1.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/test-sequencer": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.5.1.tgz", + "integrity": "sha512-LCheJF7WB2+9JuCS7VB/EmGIdQuhtqjRNI9A43idHv3E4KltCTsPsLxvdaubFHSYwY/fNjMWjl6vNRhDiN7vpQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^27.5.1", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-runtime": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/transform": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.5.1.tgz", + "integrity": "sha512-ipON6WtYgl/1329g5AIJVbUuEh0wZVbdpGwC99Jw4LwuoBNS95MVphU6zOeD9pDkon+LLbFL7lOQRapbB8SCHw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.1.0", + "@jest/types": "^27.5.1", + "babel-plugin-istanbul": "^6.1.1", + "chalk": "^4.0.0", + "convert-source-map": "^1.4.0", + "fast-json-stable-stringify": "^2.0.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-util": "^27.5.1", + "micromatch": "^4.0.4", + "pirates": "^4.0.4", + "slash": "^3.0.0", + "source-map": "^0.6.1", + "write-file-atomic": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/types": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.5.1.tgz", + "integrity": "sha512-Cx46iJ9QpwQTjIdq5VJu2QTMMs3QlEjI0x1QbBP5W1+nMzyc2XmimiRR/CbX9TO0cPTeUlxWMOu8mslYsJ8DEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^16.0.0", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.6.0.tgz", + "integrity": "sha512-T7jf+5zgsZHwNJ4lvQ7/aezbyk0nNX+zJVWpmHA7VYsEx7a7qr5Rg5IbtJFqkgze5Y2sruq1RUY8Q837Od7iFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@phc/format": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@phc/format/-/format-1.0.0.tgz", + "integrity": "sha512-m7X9U6BG2+J+R1lSOdCiITLLrxm+cWlNI3HUFA92oLO77ObGNzaKdh8pMLqdZcshtkKuV84olNNXDfMc4FezBQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/@playwright/test": { + "version": "1.61.0", + "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.61.0.tgz", + "integrity": "sha512-cKA5B6lpFEMyMGjxF54QihfYpB4FkEGH+qZhtArDEG+wezQAJY8Pq6C7T1SjWz+FFzt3TbyoXBQYk/0292TdJA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "playwright": "1.61.0" + }, + "bin": { + "playwright": "cli.js" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/@sinonjs/commons": { + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.6.tgz", + "integrity": "sha512-Ky+XkAkqPZSm3NLBeUng77EBQl3cmeJhITaGHdYH8kjVB+aun3S4XBRti2zt17mtt0mIUDiNxYeoJm6drVvBJQ==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "type-detect": "4.0.8" + } + }, + "node_modules/@sinonjs/fake-timers": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz", + "integrity": "sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1.7.0" + } + }, + "node_modules/@tootallnate/once": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz", + "integrity": "sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/@types/babel__core": { + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", + "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.20.7", + "@babel/types": "^7.20.7", + "@types/babel__generator": "*", + "@types/babel__template": "*", + "@types/babel__traverse": "*" + } + }, + "node_modules/@types/babel__generator": { + "version": "7.6.8", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.8.tgz", + "integrity": "sha512-ASsj+tpEDsEiFr1arWrlN6V3mdfjRMZt6LtK/Vp/kreFLnr5QH5+DhvD5nINYZXzwJvXeGq+05iUXcAzVrqWtw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__template": { + "version": "7.4.4", + "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", + "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.1.0", + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__traverse": { + "version": "7.20.6", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.6.tgz", + "integrity": "sha512-r1bzfrm0tomOI8g1SzvCaQHo6Lcv6zu0EA+W2kHrt8dyrHQxGzBBL4kdkzIS+jBMV+EYcMAEAqXqYaLJq5rOZg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.20.7" + } + }, + "node_modules/@types/graceful-fs": { + "version": "4.1.9", + "resolved": "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.9.tgz", + "integrity": "sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/jest": { + "version": "27.5.2", + "resolved": "https://registry.npmjs.org/@types/jest/-/jest-27.5.2.tgz", + "integrity": "sha512-mpT8LJJ4CMeeahobofYWIjFo0xonRS/HfxnVEPMPFSQdGUt1uHCnoPT7Zhb+sjDU2wz0oKV0OLUR0WzrHNgfeA==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-matcher-utils": "^27.0.0", + "pretty-format": "^27.0.0" + } + }, + "node_modules/@types/jsdom": { + "version": "16.2.15", + "resolved": "https://registry.npmjs.org/@types/jsdom/-/jsdom-16.2.15.tgz", + "integrity": "sha512-nwF87yjBKuX/roqGYerZZM0Nv1pZDMAT5YhOHYeM/72Fic+VEqJh4nyoqoapzJnW3pUlfxPY5FhgsJtM+dRnQQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "@types/parse5": "^6.0.3", + "@types/tough-cookie": "*" + } + }, + "node_modules/@types/node": { + "version": "22.7.4", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.4.tgz", + "integrity": "sha512-y+NPi1rFzDs1NdQHHToqeiX2TIS79SWEAw9GYhkkx8bD0ChpfqC+n2j5OXOCpzfojBEBt6DnEnnG9MY0zk1XLg==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.19.2" + } + }, + "node_modules/@types/node-fetch": { + "version": "2.6.11", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.11.tgz", + "integrity": "sha512-24xFj9R5+rfQJLRyM56qh+wnVSYhyXC2tkoBndtY0U+vubqNsYXGjufB2nn8Q6gt0LrARwL6UBtMCSVCwl4B1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "form-data": "^4.0.0" + } + }, + "node_modules/@types/parse5": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/@types/parse5/-/parse5-6.0.3.tgz", + "integrity": "sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/prettier": { + "version": "2.7.3", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.3.tgz", + "integrity": "sha512-+68kP9yzs4LMp7VNh8gdzMSPZFL44MLGqiHWvttYJe+6qnuVr4Ek9wSBQoveqY/r+LwjCcU29kNVkidwim+kYA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/stack-utils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz", + "integrity": "sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/tough-cookie": { + "version": "4.0.5", + "resolved": "https://registry.npmjs.org/@types/tough-cookie/-/tough-cookie-4.0.5.tgz", + "integrity": "sha512-/Ad8+nIOV7Rl++6f1BdKxFSMgmoqEoYbHRpPcx3JEfv8VRsQe9Z4mCXeJBzxs7mbHY/XOZZuXlRNfhpVPbs6ZA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/wtfnode": { + "version": "0.7.3", + "resolved": "https://registry.npmjs.org/@types/wtfnode/-/wtfnode-0.7.3.tgz", + "integrity": "sha512-UMkHpx+o2xRWLJ7PmT3bBzvIA9/0oFw80oPtY/xO4jfdq+Gznn4wP7K9B/JjMxyxy+wF+5oRPIykxeBbEDjwRg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/yargs": { + "version": "16.0.9", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-16.0.9.tgz", + "integrity": "sha512-tHhzvkFXZQeTECenFoRljLBYPZJ7jAVxqqtEI0qTLOmuultnFp4I9yKE17vTuhf7BkhCu7I4XuemPgikDVuYqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/yauzl": { + "version": "2.10.3", + "resolved": "https://registry.npmjs.org/@types/yauzl/-/yauzl-2.10.3.tgz", + "integrity": "sha512-oJoftv0LSuaDZE3Le4DbKX+KS9G36NzOeSap90UIK0yMA/NhKJhqlSGtNDORNRaIbQfzjXDrQa0ytJ6mNRGz/Q==", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/abab": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.6.tgz", + "integrity": "sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==", + "deprecated": "Use your platform's native atob() and btoa() methods instead", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/acorn": { + "version": "8.12.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.1.tgz", + "integrity": "sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-globals": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-6.0.0.tgz", + "integrity": "sha512-ZQl7LOWaF5ePqqcX4hLuv/bLXYQNfNWw2c0/yX/TsPRKamzHcTGQnlCjHT3TsmkOUVEPS3crCxiPfdzE/Trlhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^7.1.1", + "acorn-walk": "^7.1.1" + } + }, + "node_modules/acorn-globals/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-7.2.0.tgz", + "integrity": "sha512-OPdCF6GsMIP+Az+aWfAAOEt2/+iVDKE7oy6lJ098aoe59oAmK76qV6Gw60SbZ8jHuG2wH058GF4pLFbYamYrVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/agent-base": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dev": true, + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/argon2": { + "version": "0.44.0", + "resolved": "https://registry.npmjs.org/argon2/-/argon2-0.44.0.tgz", + "integrity": "sha512-zHPGN3S55sihSQo0dBbK0A5qpi2R31z7HZDZnry3ifOyj8bZZnpZND2gpmhnRGO1V/d555RwBqIK5W4Mrmv3ig==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "dependencies": { + "@phc/format": "^1.0.0", + "cross-env": "^10.0.0", + "node-addon-api": "^8.5.0", + "node-gyp-build": "^4.8.4" + }, + "engines": { + "node": ">=16.17.0" + } + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/babel-jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.5.1.tgz", + "integrity": "sha512-cdQ5dXjGRd0IBRATiQ4mZGlGlRE8kJpjPOixdNRdT+m3UcNqmYWN6rK6nvtXYfY3D76cb8s/O1Ss8ea24PIwcg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/babel__core": "^7.1.14", + "babel-plugin-istanbul": "^6.1.1", + "babel-preset-jest": "^27.5.1", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.8.0" + } + }, + "node_modules/babel-plugin-istanbul": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz", + "integrity": "sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@istanbuljs/load-nyc-config": "^1.0.0", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-instrument": "^5.0.4", + "test-exclude": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/babel-plugin-jest-hoist": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.5.1.tgz", + "integrity": "sha512-50wCwD5EMNW4aRpOwtqzyZHIewTYNxLA4nhB+09d8BIssfNfzBRhkBIHiaPv1Si226TQSvp8gxAJm2iY2qs2hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.3.3", + "@babel/types": "^7.3.3", + "@types/babel__core": "^7.0.0", + "@types/babel__traverse": "^7.0.6" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/babel-preset-current-node-syntax": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz", + "integrity": "sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-bigint": "^7.8.3", + "@babel/plugin-syntax-class-properties": "^7.12.13", + "@babel/plugin-syntax-class-static-block": "^7.14.5", + "@babel/plugin-syntax-import-attributes": "^7.24.7", + "@babel/plugin-syntax-import-meta": "^7.10.4", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.10.4", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5", + "@babel/plugin-syntax-top-level-await": "^7.14.5" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/babel-preset-jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.5.1.tgz", + "integrity": "sha512-Nptf2FzlPCWYuJg41HBqXVT8ym6bXOevuCTbhxlUpjwtysGaIWFvDEjp4y+G7fl13FgOdjs7P/DmErqH7da0Ag==", + "dev": true, + "license": "MIT", + "dependencies": { + "babel-plugin-jest-hoist": "^27.5.1", + "babel-preset-current-node-syntax": "^1.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.11.27", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.27.tgz", + "integrity": "sha512-ElY12DaROGuan+lMmZ8Cvo/ZUbXPe7Enc/9VU/b1T3Kp4dwytRcNdR8DoSJN5SNJT/CuvcCA0DHDVmMOCePdRQ==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.21", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.21.tgz", + "integrity": "sha512-9zeA+KLZNNzglF2TPKRQEDyx6Yby7daAkuy8MiPzpXPsYDWi/DRM8jmwUDxokQjYqBpv5DgPiwD4h4ZZSy1Ujw==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browser-process-hrtime": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz", + "integrity": "sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/browserslist": { + "version": "4.29.3", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.29.3.tgz", + "integrity": "sha512-1R4kiYKXGViqEN0CnoDrXc1StD9niAwu+j2dukWzrD4bJgsD4lDmEp0CRbc6E/vYJIfTHwPmwyaKtVSudICdPA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "baseline-browser-mapping": "^2.11.26", + "caniuse-lite": "^1.0.30001813", + "electron-to-chromium": "^1.5.439", + "node-releases": "^2.0.57", + "update-browserslist-db": "^1.3.3" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/bs-logger": { + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/bs-logger/-/bs-logger-0.2.6.tgz", + "integrity": "sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-json-stable-stringify": "2.x" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/bser": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz", + "integrity": "sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "node-int64": "^0.4.0" + } + }, + "node_modules/buffer-crc32": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/buffer-crc32/-/buffer-crc32-0.2.13.tgz", + "integrity": "sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001815", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001815.tgz", + "integrity": "sha512-uDybUEyfgbyJJ93J1vikTylBX31AkdVYeVPeffMQpf8XN7hSfr0oZOn4VFOIMNvtU5+rHvC5Udg2TgtJKHm23Q==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cjs-module-lexer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.1.tgz", + "integrity": "sha512-cuSVIHi9/9E/+821Qjdvngor+xpnlwnuwIyZOaLmHBVdXL+gP+I6QQB9VkO7RI77YIcTV+S1W9AreJ5eN63JBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/co": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", + "integrity": "sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">= 1.0.0", + "node": ">= 0.12.0" + } + }, + "node_modules/collect-v8-coverage": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz", + "integrity": "sha512-lHl4d5/ONEbLlJvaJNtsF/Lz+WvB07u2ycqTYbdrq7UypDXailES4valYb2eWiJFxZlVmpGekfqoxQhzyFdT4Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true, + "license": "MIT" + }, + "node_modules/convert-source-map": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.9.0.tgz", + "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", + "dev": true, + "license": "MIT" + }, + "node_modules/cross-env": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/cross-env/-/cross-env-10.1.0.tgz", + "integrity": "sha512-GsYosgnACZTADcmEyJctkJIoqAhHjttw7RsFrVoJNXbsWWqaq6Ym+7kZjq6mS45O0jij6vtiReppKQEtqWy6Dw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@epic-web/invariant": "^1.0.0", + "cross-spawn": "^7.0.6" + }, + "bin": { + "cross-env": "dist/bin/cross-env.js", + "cross-env-shell": "dist/bin/cross-env-shell.js" + }, + "engines": { + "node": ">=20" + } + }, + "node_modules/cross-fetch": { + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.8.tgz", + "integrity": "sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==", + "dev": true, + "license": "MIT", + "dependencies": { + "node-fetch": "^2.6.12" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/cssom": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.4.4.tgz", + "integrity": "sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw==", + "dev": true, + "license": "MIT" + }, + "node_modules/cssstyle": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-2.3.0.tgz", + "integrity": "sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A==", + "dev": true, + "license": "MIT", + "dependencies": { + "cssom": "~0.3.6" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cssstyle/node_modules/cssom": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz", + "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", + "dev": true, + "license": "MIT" + }, + "node_modules/data-urls": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-2.0.0.tgz", + "integrity": "sha512-X5eWTSXO/BJmpdIKCRuKUgSCgAN0OwliVK3yPKbwIWU1Tdw5BRajxlzMidvh+gwko9AfQ9zIj52pzF91Q3YAvQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.3", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/debug": { + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", + "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decimal.js": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.4.3.tgz", + "integrity": "sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA==", + "dev": true, + "license": "MIT" + }, + "node_modules/dedent": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz", + "integrity": "sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==", + "dev": true, + "license": "MIT" + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/detect-newline": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", + "integrity": "sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/diff-sequences": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.5.1.tgz", + "integrity": "sha512-k1gCAXAsNgLwEL+Y8Wvl+M6oEFj5bgazfZULpS5CneoPPXRaCCW7dm+q21Ky2VEE5X+VeRDBVg1Pcvvsr4TtNQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/domexception": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/domexception/-/domexception-2.0.1.tgz", + "integrity": "sha512-yxJ2mFy/sibVQlu5qHjOkf9J3K6zgmCxgJ94u2EdvDOV09H+32LtRswEcUsmUWN72pVLOEnTSRaIVVzVQgS0dg==", + "deprecated": "Use your platform's native DOMException instead", + "dev": true, + "license": "MIT", + "dependencies": { + "webidl-conversions": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/domexception/node_modules/webidl-conversions": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-5.0.0.tgz", + "integrity": "sha512-VlZwKPCkYKxQgeSbH5EyngOmRp7Ww7I9rQLERETtf5ofd9pGeswWiOtogpEO850jziPRarreGxn5QIiTqpb2wA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.451", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.451.tgz", + "integrity": "sha512-vUNKPrUzw8ByEMOxloq0a71iD/mPuPxVkbDm3G5YhnxTzOw/I6qAg2MUS0cYj/c267lWmw26yW4Vv7foxTxPLg==", + "dev": true, + "license": "ISC" + }, + "node_modules/emittery": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/emittery/-/emittery-0.8.1.tgz", + "integrity": "sha512-uDfvUjVrfGJJhymx/kz6prltenw1u7WrCg1oa94zYY8xxVpLLUu045LAT0dhDZdXG58/EpPL/5kA180fQ/qudg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/emittery?sponsor=1" + } + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, + "license": "MIT" + }, + "node_modules/end-of-stream": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "once": "^1.4.0" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", + "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.6", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/escodegen": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-2.1.0.tgz", + "integrity": "sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esprima": "^4.0.1", + "estraverse": "^5.2.0", + "esutils": "^2.0.2" + }, + "bin": { + "escodegen": "bin/escodegen.js", + "esgenerate": "bin/esgenerate.js" + }, + "engines": { + "node": ">=6.0" + }, + "optionalDependencies": { + "source-map": "~0.6.1" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/execa/node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/exit": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz", + "integrity": "sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/expect": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/expect/-/expect-27.5.1.tgz", + "integrity": "sha512-E1q5hSUG2AmYQwQJ041nvgpkODHQvB+RKlB4IYdru6uJsyFTRyZAP463M+1lINorwbqAmUggi6+WwkD8lCS/Dw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/extract-zip": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/extract-zip/-/extract-zip-2.0.1.tgz", + "integrity": "sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "debug": "^4.1.1", + "get-stream": "^5.1.0", + "yauzl": "^2.10.0" + }, + "bin": { + "extract-zip": "cli.js" + }, + "engines": { + "node": ">= 10.17.0" + }, + "optionalDependencies": { + "@types/yauzl": "^2.9.1" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/fb-watchman": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", + "integrity": "sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "bser": "2.1.1" + } + }, + "node_modules/fd-slicer": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.1.0.tgz", + "integrity": "sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "pend": "~1.2.0" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/form-data": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.6.tgz", + "integrity": "sha512-vKatAh4SlVfgbv+YtmhiRjhEMJsYpsG1Y2rMQtR+SVSbytsSD1YGzDIcrAJmdFec88u/+VoGmxnl+80gL1tRCQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "es-set-tostringtag": "^2.1.0", + "hasown": "^2.0.4", + "mime-types": "^2.1.35" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true, + "license": "ISC" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-package-type": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", + "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/get-stream": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", + "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", + "dev": true, + "license": "MIT", + "dependencies": { + "pump": "^3.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.4.tgz", + "integrity": "sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/html-encoding-sniffer": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-2.0.1.tgz", + "integrity": "sha512-D5JbOMBIR/TVZkubHT+OyT2705QvogUW4IBn6nHd756OwieSF9aDYFj4dv6HHEVGYbHaLETa3WggZYWWMyy3ZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-encoding": "^1.0.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true, + "license": "MIT" + }, + "node_modules/http-proxy-agent": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz", + "integrity": "sha512-k0zdNgqWTGA6aeIRVpvfVob4fL52dTfaehylg0Y4UvSySvOq/Y+BOyPrgpUrA7HylqvU8vIZGsRuXmspskV0Tg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@tootallnate/once": "1", + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/https-proxy-agent": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/import-local": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.2.0.tgz", + "integrity": "sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA==", + "dev": true, + "license": "MIT", + "dependencies": { + "pkg-dir": "^4.2.0", + "resolve-cwd": "^3.0.0" + }, + "bin": { + "import-local-fixture": "fixtures/cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "dev": true, + "license": "ISC", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-core-module": { + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-generator-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-generator-fn/-/is-generator-fn-2.1.0.tgz", + "integrity": "sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-potential-custom-element-name": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", + "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "dev": true, + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true, + "license": "ISC" + }, + "node_modules/istanbul-lib-coverage": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", + "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz", + "integrity": "sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/core": "^7.12.3", + "@babel/parser": "^7.14.7", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-coverage": "^3.2.0", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/istanbul-lib-report": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", + "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^4.0.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-report/node_modules/make-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", + "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.5.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/istanbul-lib-source-maps": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz", + "integrity": "sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0", + "source-map": "^0.6.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-reports": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", + "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest/-/jest-27.5.1.tgz", + "integrity": "sha512-Yn0mADZB89zTtjkPJEXwrac3LHudkQMR+Paqa8uxJHCBr9agxztUifWCyiYrjhMPBoUVBjyny0I7XH6ozDr7QQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^27.5.1", + "import-local": "^3.0.2", + "jest-cli": "^27.5.1" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-changed-files": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.5.1.tgz", + "integrity": "sha512-buBLMiByfWGCoMsLLzGUUSpAmIAGnbR2KJoMN10ziLhOLvP4e0SlypHnAel8iqQXTrcbmfEY9sSqae5sgUsTvw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "execa": "^5.0.0", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-circus": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.5.1.tgz", + "integrity": "sha512-D95R7x5UtlMA5iBYsOHFFbMD/GVA4R/Kdq15f7xYWUfWHBto9NYRsOvnSauTgdF+ogCpJ4tyKOXhUifxS65gdw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "co": "^4.6.0", + "dedent": "^0.7.0", + "expect": "^27.5.1", + "is-generator-fn": "^2.0.0", + "jest-each": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "stack-utils": "^2.0.3", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-cli": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.5.1.tgz", + "integrity": "sha512-Hc6HOOwYq4/74/c62dEE3r5elx8wjYqxY0r0G/nFrLDPMFRu6RA/u8qINOIkvhxG7mMQ5EJsOGfRpI8L6eFUVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "import-local": "^3.0.2", + "jest-config": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "prompts": "^2.0.1", + "yargs": "^16.2.0" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-config": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.5.1.tgz", + "integrity": "sha512-5sAsjm6tGdsVbW9ahcChPAFCk4IlkQUknH5AvKjuLTSlcO/wCZKyFdn7Rg0EkC+OGgWODEy2hDpWB1PgzH0JNA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.8.0", + "@jest/test-sequencer": "^27.5.1", + "@jest/types": "^27.5.1", + "babel-jest": "^27.5.1", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "deepmerge": "^4.2.2", + "glob": "^7.1.1", + "graceful-fs": "^4.2.9", + "jest-circus": "^27.5.1", + "jest-environment-jsdom": "^27.5.1", + "jest-environment-node": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-jasmine2": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-runner": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "micromatch": "^4.0.4", + "parse-json": "^5.2.0", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "ts-node": ">=9.0.0" + }, + "peerDependenciesMeta": { + "ts-node": { + "optional": true + } + } + }, + "node_modules/jest-diff": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.5.1.tgz", + "integrity": "sha512-m0NvkX55LDt9T4mctTEgnZk3fmEg3NRYutvMPWM/0iPnkFj2wIeF45O1718cMSOFO1vINkqmxqD8vE37uTEbqw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "diff-sequences": "^27.5.1", + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-docblock": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.5.1.tgz", + "integrity": "sha512-rl7hlABeTsRYxKiUfpHrQrG4e2obOiTQWfMEH3PxPjOtdsfLQO4ReWSZaQ7DETm4xu07rl4q/h4zcKXyU0/OzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "detect-newline": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-each": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.5.1.tgz", + "integrity": "sha512-1Ff6p+FbhT/bXQnEouYy00bkNSY7OUpfIcmdl8vZ31A1UUaurOLPA8a8BbJOF2RDUElwJhmeaV7LnagI+5UwNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "jest-get-type": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-environment-jsdom": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.5.1.tgz", + "integrity": "sha512-TFBvkTC1Hnnnrka/fUb56atfDtJ9VMZ94JkjTbggl1PEpwrYtUBKMezB3inLmWqQsXYLcMwNoDQwoBTAvFfsfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1", + "jsdom": "^16.6.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-environment-node": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.5.1.tgz", + "integrity": "sha512-Jt4ZUnxdOsTGwSRAfKEnE6BcwsSPNOijjwifq5sDFSA2kesnXTvNqKHYgM0hDq3549Uf/KzdXNYn4wMZJPlFLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-fetch-mock": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/jest-fetch-mock/-/jest-fetch-mock-3.0.3.tgz", + "integrity": "sha512-Ux1nWprtLrdrH4XwE7O7InRY6psIi3GOsqNESJgMJ+M5cv4A8Lh7SN9d2V2kKRZ8ebAfcd1LNyZguAOb6JiDqw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-fetch": "^3.0.4", + "promise-polyfill": "^8.1.3" + } + }, + "node_modules/jest-get-type": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.5.1.tgz", + "integrity": "sha512-2KY95ksYSaK7DMBWQn6dQz3kqAf3BB64y2udeG+hv4KfSOb9qwcYQstTJc1KCbsix+wLZWZYN8t7nwX3GOBLRw==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-haste-map": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.5.1.tgz", + "integrity": "sha512-7GgkZ4Fw4NFbMSDSpZwXeBiIbx+t/46nJ2QitkOjvwPYyZmqttu2TDSimMHP1EkPOi4xUZAN1doE5Vd25H4Jng==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/graceful-fs": "^4.1.2", + "@types/node": "*", + "anymatch": "^3.0.3", + "fb-watchman": "^2.0.0", + "graceful-fs": "^4.2.9", + "jest-regex-util": "^27.5.1", + "jest-serializer": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "micromatch": "^4.0.4", + "walker": "^1.0.7" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "optionalDependencies": { + "fsevents": "^2.3.2" + } + }, + "node_modules/jest-jasmine2": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.5.1.tgz", + "integrity": "sha512-jtq7VVyG8SqAorDpApwiJJImd0V2wv1xzdheGHRGyuT7gZm6gG47QEskOlzsN1PG/6WNaCo5pmwMHDf3AkG2pQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/source-map": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "co": "^4.6.0", + "expect": "^27.5.1", + "is-generator-fn": "^2.0.0", + "jest-each": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-leak-detector": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.5.1.tgz", + "integrity": "sha512-POXfWAMvfU6WMUXftV4HolnJfnPOGEu10fscNCA76KBpRRhcMN2c8d3iT2pxQS3HLbA+5X4sOUPzYO2NUyIlHQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-matcher-utils": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.5.1.tgz", + "integrity": "sha512-z2uTx/T6LBaCoNWNFWwChLBKYxTMcGBRjAt+2SbP929/Fflb9aa5LGma654Rz8z9HLxsrUaYzxE9T/EFIL/PAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "jest-diff": "^27.5.1", + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-message-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.5.1.tgz", + "integrity": "sha512-rMyFe1+jnyAAf+NHwTclDz0eAaLkVDdKVHHBFWsBWHnnh5YeJMNWWsv7AbFYXfK3oTqvL7VTWkhNLu1jX24D+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.12.13", + "@jest/types": "^27.5.1", + "@types/stack-utils": "^2.0.0", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "micromatch": "^4.0.4", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "stack-utils": "^2.0.3" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-mock": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.5.1.tgz", + "integrity": "sha512-K4jKbY1d4ENhbrG2zuPWaQBvDly+iZ2yAW+T1fATN78hc0sInwn7wZB8XtlNnvHug5RMwV897Xm4LqmPM4e2Og==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-pnp-resolver": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz", + "integrity": "sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + }, + "peerDependencies": { + "jest-resolve": "*" + }, + "peerDependenciesMeta": { + "jest-resolve": { + "optional": true + } + } + }, + "node_modules/jest-regex-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.5.1.tgz", + "integrity": "sha512-4bfKq2zie+x16okqDXjXn9ql2B0dScQu+vcwe4TvFVhkVyuWLqpZrZtXxLLWoXYgn0E87I6r6GRYHF7wFZBUvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-resolve": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.5.1.tgz", + "integrity": "sha512-FFDy8/9E6CV83IMbDpcjOhumAQPDyETnU2KZ1O98DwTnz8AOBsW/Xv3GySr1mOZdItLR+zDZ7I/UdTFbgSOVCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-pnp-resolver": "^1.2.2", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "resolve": "^1.20.0", + "resolve.exports": "^1.1.0", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-resolve-dependencies": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.5.1.tgz", + "integrity": "sha512-QQOOdY4PE39iawDn5rzbIePNigfe5B9Z91GDD1ae/xNDlu9kaat8QQ5EKnNmVWPV54hUdxCVwwj6YMgR2O7IOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-snapshot": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-runner": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.5.1.tgz", + "integrity": "sha512-g4NPsM4mFCOwFKXO4p/H/kWGdJp9V8kURY2lX8Me2drgXqG7rrZAx5kv+5H7wtt/cdFIjhqYx1HrlqWHaOvDaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/environment": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "emittery": "^0.8.1", + "graceful-fs": "^4.2.9", + "jest-docblock": "^27.5.1", + "jest-environment-jsdom": "^27.5.1", + "jest-environment-node": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-leak-detector": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "source-map-support": "^0.5.6", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-runtime": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.5.1.tgz", + "integrity": "sha512-o7gxw3Gf+H2IGt8fv0RiyE1+r83FJBRruoA+FXrlHw6xEyBsU8ugA6IPfTdVyA0w8HClpbK+DGJxH59UrNMx8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/globals": "^27.5.1", + "@jest/source-map": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "cjs-module-lexer": "^1.0.0", + "collect-v8-coverage": "^1.0.0", + "execa": "^5.0.0", + "glob": "^7.1.3", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-mock": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "slash": "^3.0.0", + "strip-bom": "^4.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-serializer": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.5.1.tgz", + "integrity": "sha512-jZCyo6iIxO1aqUxpuBlwTDMkzOAJS4a3eYz3YzgxxVQFwLeSA7Jfq5cbqCY+JLvTDrWirgusI/0KwxKMgrdf7w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "graceful-fs": "^4.2.9" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-snapshot": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.5.1.tgz", + "integrity": "sha512-yYykXI5a0I31xX67mgeLw1DZ0bJB+gpq5IpSuCAoyDi0+BhgU/RIrL+RTzDmkNTchvDFWKP8lp+w/42Z3us5sA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.7.2", + "@babel/generator": "^7.7.2", + "@babel/plugin-syntax-typescript": "^7.7.2", + "@babel/traverse": "^7.7.2", + "@babel/types": "^7.0.0", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/babel__traverse": "^7.0.4", + "@types/prettier": "^2.1.5", + "babel-preset-current-node-syntax": "^1.0.0", + "chalk": "^4.0.0", + "expect": "^27.5.1", + "graceful-fs": "^4.2.9", + "jest-diff": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-util": "^27.5.1", + "natural-compare": "^1.4.0", + "pretty-format": "^27.5.1", + "semver": "^7.3.2" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.5.1.tgz", + "integrity": "sha512-Kv2o/8jNvX1MQ0KGtw480E/w4fBCDOnH6+6DmeKi6LZUIlKA5kwY0YNdlzaWTiVgxqAqik11QyxDOKk543aKXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-validate": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.5.1.tgz", + "integrity": "sha512-thkNli0LYTmOI1tDB3FI1S1RTp/Bqyd9pTarJwL87OIBFuqEb5Apv5EaApEudYg4g86e3CT6kM0RowkhtEnCBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "camelcase": "^6.2.0", + "chalk": "^4.0.0", + "jest-get-type": "^27.5.1", + "leven": "^3.1.0", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-validate/node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-watcher": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.5.1.tgz", + "integrity": "sha512-z676SuD6Z8o8qbmEGhoEUFOM1+jfEiL3DXHK/xgEiG2EyNYfFG60jluWcupY6dATjfEsKQuibReS1djInQnoVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "jest-util": "^27.5.1", + "string-length": "^4.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "3.15.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.2.tgz", + "integrity": "sha512-6EuL879VkRA+1Cz578mKMiKvjPNEuk6+r1JaFzoSWejZmtf7xWbIyw1e3KkxlkzTIt9Taw6JBhEppG7utc1P+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsdom": { + "version": "16.7.0", + "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-16.7.0.tgz", + "integrity": "sha512-u9Smc2G1USStM+s/x1ru5Sxrl6mPYCbByG1U/hUmqaVsm4tbNyS7CicOSRyuGQYZhTu0h84qkZZQ/I+dzizSVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.5", + "acorn": "^8.2.4", + "acorn-globals": "^6.0.0", + "cssom": "^0.4.4", + "cssstyle": "^2.3.0", + "data-urls": "^2.0.0", + "decimal.js": "^10.2.1", + "domexception": "^2.0.1", + "escodegen": "^2.0.0", + "form-data": "^3.0.0", + "html-encoding-sniffer": "^2.0.1", + "http-proxy-agent": "^4.0.1", + "https-proxy-agent": "^5.0.0", + "is-potential-custom-element-name": "^1.0.1", + "nwsapi": "^2.2.0", + "parse5": "6.0.1", + "saxes": "^5.0.1", + "symbol-tree": "^3.2.4", + "tough-cookie": "^4.0.0", + "w3c-hr-time": "^1.0.2", + "w3c-xmlserializer": "^2.0.0", + "webidl-conversions": "^6.1.0", + "whatwg-encoding": "^1.0.5", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.5.0", + "ws": "^7.4.6", + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "peerDependencies": { + "canvas": "^2.5.0" + }, + "peerDependenciesMeta": { + "canvas": { + "optional": true + } + } + }, + "node_modules/jsdom/node_modules/form-data": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.5.tgz", + "integrity": "sha512-j23EibVLnp4zNXGW7LjryXYa2X6U/M96yoOX+ybZxwkYajdxRNEqYY3zhh7y0i6kfISKS2jr+EJq1YTUDEv5+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "es-set-tostringtag": "^2.1.0", + "hasown": "^2.0.4", + "mime-types": "^2.1.35" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/jsesc": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz", + "integrity": "sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==", + "dev": true, + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true, + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "dev": true, + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true, + "license": "MIT" + }, + "node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/lodash": { + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz", + "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.memoize": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", + "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==", + "dev": true, + "license": "MIT" + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true, + "license": "ISC" + }, + "node_modules/makeerror": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", + "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "tmpl": "1.0.5" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true, + "license": "MIT" + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/minimatch": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-addon-api": { + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-8.5.0.tgz", + "integrity": "sha512-/bRZty2mXUIFY/xU5HLvveNHlswNJej+RnxBjOMkidWfwZzgTbPG1E3K5TOxRLOR+5hX7bSofy8yf1hZevMS8A==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18 || ^20 || >= 21" + } + }, + "node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/node-fetch/node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-fetch/node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/node-fetch/node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "node_modules/node-gyp-build": { + "version": "4.8.4", + "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.8.4.tgz", + "integrity": "sha512-LA4ZjwlnUblHVgq0oBF3Jl/6h/Nvs5fzBLwdEF4nuxnFdsfajde4WfxtJr3CaiH+F6ewcIB/q4jQ4UzPyid+CQ==", + "dev": true, + "license": "MIT", + "bin": { + "node-gyp-build": "bin.js", + "node-gyp-build-optional": "optional.js", + "node-gyp-build-test": "build-test.js" + } + }, + "node_modules/node-int64": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", + "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-releases": { + "version": "2.0.57", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.57.tgz", + "integrity": "sha512-kQK9LGGFiHtrWiNhZtA7Qbw17AQz+dmsEKODRIVTXA9+e5MS/2gZEBhYJt13GrAz5/IOZKddH/0Z3TP/Zgo+yw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nwsapi": { + "version": "2.2.13", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.13.tgz", + "integrity": "sha512-cTGB9ptp9dY9A5VbMSe7fQBcl/tt22Vcqdq8+eN93rblOuE0aCFu4aZ2vMwct/2t+lFnosm8RkQW1I0Omb1UtQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse5": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", + "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", + "dev": true, + "license": "MIT" + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true, + "license": "MIT" + }, + "node_modules/pend": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/pend/-/pend-1.2.0.tgz", + "integrity": "sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==", + "dev": true, + "license": "MIT" + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pirates": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.6.tgz", + "integrity": "sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/pkg-dir": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", + "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/playwright": { + "version": "1.61.0", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.61.0.tgz", + "integrity": "sha512-Z+7BeeqQPRRzklHsVFP4KTGIyMxKUmfeRA4WisM6G3/XW6nwGeX6fX9qYaDa+CiUqpOkb2f6X3nar05R3kSuJQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "playwright-core": "1.61.0" + }, + "bin": { + "playwright": "cli.js" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "fsevents": "2.3.2" + } + }, + "node_modules/playwright-core": { + "version": "1.61.0", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.61.0.tgz", + "integrity": "sha512-caX7TrY3Ml6egyDX0WUcTHDxodl/b51y5wJOdCEA36QviK/s2g081hvmGs8eaE3DWb6NYZQ6BjO/QkNRPenoPA==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "playwright-core": "cli.js" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/playwright/node_modules/fsevents": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz", + "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/promise-polyfill": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-8.3.0.tgz", + "integrity": "sha512-H5oELycFml5yto/atYqmjyigJoAo3+OXwolYiH7OfQuYlAqhxNvTfiNMbV9hsC6Yp83yE5r2KTVmtrG6R9i6Pg==", + "dev": true, + "license": "MIT" + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/psl": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz", + "integrity": "sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==", + "dev": true, + "license": "MIT" + }, + "node_modules/pump": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.2.tgz", + "integrity": "sha512-tUPXtzlGM8FE3P0ZL6DVs/3P58k9nk8/jZeQCurTJylQA8qFYzHFfhBJkuqyE0FifOsQ0uKWekiZ5g8wtr28cw==", + "dev": true, + "license": "MIT", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/querystringify": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/querystringify/-/querystringify-2.2.0.tgz", + "integrity": "sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/resolve": { + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-cwd": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", + "integrity": "sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve.exports": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-1.1.1.tgz", + "integrity": "sha512-/NtpHNDN7jWhAaQ9BvBUYZ6YTXsRBgfqWFWP7BZBaoMJO/I3G5OFzvTuWNlZC3aPjins1F+TNrLKsGbH4rfsRQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "deprecated": "Rimraf versions prior to v4 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true, + "license": "MIT" + }, + "node_modules/saxes": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/saxes/-/saxes-5.0.1.tgz", + "integrity": "sha512-5LBh1Tls8c9xgGjw3QrMwETmTMVk0oFgvrFSvWx62llR2hcEInrKNZ2GZCCuuy2lvWrdl5jhbpeqc5hRYKFOcw==", + "dev": true, + "license": "ISC", + "dependencies": { + "xmlchars": "^2.2.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "dev": true, + "license": "MIT" + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/stack-utils": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", + "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/string-length": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", + "integrity": "sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "char-regex": "^1.0.2", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", + "integrity": "sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-hyperlinks": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz", + "integrity": "sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0", + "supports-color": "^7.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/symbol-tree": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz", + "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", + "dev": true, + "license": "MIT" + }, + "node_modules/terminal-link": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/terminal-link/-/terminal-link-2.1.1.tgz", + "integrity": "sha512-un0FmiRUQNr5PJqy9kP7c40F5BOfpGlYTrxonDChEZB7pzZxRNp/bt+ymiy9/npwXya9KH99nJ/GXFIiUkYGFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-escapes": "^4.2.1", + "supports-hyperlinks": "^2.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/test-exclude": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/throat": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/throat/-/throat-6.0.2.tgz", + "integrity": "sha512-WKexMoJj3vEuK0yFEapj8y64V0A6xcuPuK9Gt1d0R+dzCSJc0lHqQytAbSB4cDAK0dWh4T0E2ETkoLE2WZ41OQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/tmpl": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", + "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/tough-cookie": { + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.4.tgz", + "integrity": "sha512-Loo5UUvLD9ScZ6jh8beX1T6sO1w2/MpCRpEP7V280GKMVUQ0Jzar2U3UJPsrdbziLEMMhu3Ujnq//rhiFuIeag==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.2.0", + "url-parse": "^1.5.3" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/tr46": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-2.1.0.tgz", + "integrity": "sha512-15Ih7phfcdP5YxqiB+iDtLoaTz4Nd35+IiAv0kQ5FNKHzXgdWqPoTIqEDDJmXceQt4JZk6lVPT8lnDlPpGDppw==", + "dev": true, + "license": "MIT", + "dependencies": { + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ts-jest": { + "version": "27.1.5", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-27.1.5.tgz", + "integrity": "sha512-Xv6jBQPoBEvBq/5i2TeSG9tt/nqkbpcurrEG1b+2yfBrcJelOZF9Ml6dmyMh7bcW9JyFbRYpR5rxROSlBLTZHA==", + "dev": true, + "license": "MIT", + "dependencies": { + "bs-logger": "0.x", + "fast-json-stable-stringify": "2.x", + "jest-util": "^27.0.0", + "json5": "2.x", + "lodash.memoize": "4.x", + "make-error": "1.x", + "semver": "7.x", + "yargs-parser": "20.x" + }, + "bin": { + "ts-jest": "cli.js" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "@babel/core": ">=7.0.0-beta.0 <8", + "@types/jest": "^27.0.0", + "babel-jest": ">=27.0.0 <28", + "jest": "^27.0.0", + "typescript": ">=3.8 <5.0" + }, + "peerDependenciesMeta": { + "@babel/core": { + "optional": true + }, + "@types/jest": { + "optional": true + }, + "babel-jest": { + "optional": true + }, + "esbuild": { + "optional": true + } + } + }, + "node_modules/type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "dev": true, + "license": "Apache-2.0", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true, + "license": "MIT" + }, + "node_modules/universalify": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", + "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.3.4.tgz", + "integrity": "sha512-t8wonIOdQyOjtPd2VktlBu6QjTVTks6v8bSi7kd0r2Vll8TK1JYDZtRRdbmCHOAMphkZgrzK+L+vXK4pyZ8t4A==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/url-parse": { + "version": "1.5.10", + "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.10.tgz", + "integrity": "sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "querystringify": "^2.1.1", + "requires-port": "^1.0.0" + } + }, + "node_modules/v8-to-istanbul": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-8.1.1.tgz", + "integrity": "sha512-FGtKtv3xIpR6BYhvgH8MI/y78oT7d8Au3ww4QIxymrCtZEh5b8gCw2siywE+puhEmuWKDtmfrvF5UlB298ut3w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@types/istanbul-lib-coverage": "^2.0.1", + "convert-source-map": "^1.6.0", + "source-map": "^0.7.3" + }, + "engines": { + "node": ">=10.12.0" + } + }, + "node_modules/v8-to-istanbul/node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">= 8" + } + }, + "node_modules/w3c-hr-time": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", + "integrity": "sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ==", + "deprecated": "Use your platform's native performance.now() and performance.timeOrigin.", + "dev": true, + "license": "MIT", + "dependencies": { + "browser-process-hrtime": "^1.0.0" + } + }, + "node_modules/w3c-xmlserializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-2.0.0.tgz", + "integrity": "sha512-4tzD0mF8iSiMiNs30BiLO3EpfGLZUT2MSX/G+o7ZywDzliWQ3OPtTZ0PTC3B3ca1UAf4cJMHB+2Bf56EriJuRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/walker": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", + "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "makeerror": "1.0.12" + } + }, + "node_modules/webidl-conversions": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-6.1.0.tgz", + "integrity": "sha512-qBIvFLGiBpLjfwmYAaHPXsn+ho5xZnGvyGvsarywGNc8VyQJUMHJ8OBKGGrPER0okBeMDaan4mNBlgBROxuI8w==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=10.4" + } + }, + "node_modules/whatwg-encoding": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-1.0.5.tgz", + "integrity": "sha512-b5lim54JOPN9HtzvK9HFXvBma/rnfFeqsic0hSpjtDbVxR3dJKLc+KB4V6GgiGOvl7CY/KNh8rxSo9DKQrnUEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "iconv-lite": "0.4.24" + } + }, + "node_modules/whatwg-mimetype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz", + "integrity": "sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g==", + "dev": true, + "license": "MIT" + }, + "node_modules/whatwg-url": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-8.7.0.tgz", + "integrity": "sha512-gAojqb/m9Q8a5IV96E3fHJM70AzCkgt4uXYX2O7EmuyOnLrViCQlsEBmF9UQIu3/aeAIp2U17rtbpZWNntQqdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", + "dev": true, + "license": "ISC", + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.13", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.13.tgz", + "integrity": "sha512-rsKI6xDBFVf4r/x8XyChGK04QR/XHroxs/jUcoWvtEZM8TPU/X/uIY9B1CsSzYws9ZJb/6bbBu7dPhFW00CAoA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/wtfnode": { + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/wtfnode/-/wtfnode-0.9.3.tgz", + "integrity": "sha512-MXjgxJovNVYUkD85JBZTKT5S5ng/e56sNuRZlid7HcGTNrIODa5UPtqE3i0daj7fJ2SGj5Um2VmiphQVyVKK5A==", + "dev": true, + "license": "ISC", + "bin": { + "wtfnode": "proxy.js" + } + }, + "node_modules/xml-name-validator": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz", + "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/xmlchars": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", + "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", + "dev": true, + "license": "MIT" + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yauzl": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-2.10.0.tgz", + "integrity": "sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-crc32": "~0.2.3", + "fd-slicer": "~1.1.0" + } + } + } +} diff --git a/test/package.json b/test/package.json new file mode 100644 index 000000000000..46ae308fda52 --- /dev/null +++ b/test/package.json @@ -0,0 +1,28 @@ +{ + "license": "MIT", + "#": "We must put jest in a sub-directory otherwise VS Code somehow picks up the types and generates conflicts with mocha.", + "devDependencies": { + "@jest-mock/express": "^1.4.5", + "@playwright/test": "^1.61.0", + "@types/jest": "^27.0.2", + "@types/jsdom": "^16.2.13", + "@types/node-fetch": "^2.5.8", + "@types/wtfnode": "^0.7.0", + "argon2": "^0.44.0", + "extract-zip": "^2.0.1", + "jest": "^27.3.1", + "jest-fetch-mock": "^3.0.3", + "jsdom": "^16.4.0", + "node-fetch": "^2.6.7", + "playwright": "^1.61.0", + "ts-jest": "^27.0.7", + "wtfnode": "^0.9.1" + }, + "resolutions": { + "ansi-regex": "^5.0.1", + "set-value": "^4.0.1", + "tmpl": "^1.0.5", + "path-parse": "^1.0.7", + "json-schema": "^0.4.0" + } +} diff --git a/test/playwright.config.ts b/test/playwright.config.ts new file mode 100644 index 000000000000..1de4b92ca3b6 --- /dev/null +++ b/test/playwright.config.ts @@ -0,0 +1,45 @@ +import { PlaywrightTestConfig } from "@playwright/test" + +import path from "path" + +// The default configuration runs all tests in three browsers with workers equal +// to half the available threads. See 'npm run test:e2e --help' to customize +// from the command line. For example: +// npm run test:e2e -- --workers 1 # Run with one worker +// npm run test:e2e -- --project Chromium # Only run on Chromium +// npm run test:e2e -- --grep login # Run tests matching "login" +// PWDEBUG=1 npm run test:e2e # Run Playwright inspector +const config: PlaywrightTestConfig = { + testDir: path.join(__dirname, "e2e"), // Search for tests in this directory. + timeout: 60000, // Each test is given 60 seconds. + retries: process.env.CI ? 2 : 1, // Retry in CI due to flakiness. + // Limit the number of failures on CI to save resources + maxFailures: process.env.CI ? 3 : undefined, + globalSetup: require.resolve("./utils/globalE2eSetup.ts"), + reporter: "list", + // Put any shared options on the top level. + use: { + headless: true, // Run tests in headless browsers. + video: "retain-on-failure", + }, + + projects: [ + { + name: "Chromium", + use: { browserName: "chromium" }, + }, + // Firefox seems to have bugs with opening context menus in the file tree. + // { + // name: "Firefox", + // use: { browserName: "firefox" }, + // }, + // Keeps failing with "Underlying ArrayBuffer has been detached from the view or out-of-bounds" + // Not sure what we can do about it...so skip for now. + // { + // name: "WebKit", + // use: { browserName: "webkit" }, + // }, + ], +} + +export default config diff --git a/test/scripts/build-lib.bats b/test/scripts/build-lib.bats new file mode 100644 index 000000000000..e855f270a1ff --- /dev/null +++ b/test/scripts/build-lib.bats @@ -0,0 +1,21 @@ +#!/usr/bin/env bats + +SCRIPT_NAME="build-lib.sh" +SCRIPT="$BATS_TEST_DIRNAME/../../ci/build/$SCRIPT_NAME" + +source "$SCRIPT" + +@test "get_nfpm_arch should return armhfp for rpm on armv7l" { + run get_nfpm_arch rpm armv7l + [ "$output" = "armhfp" ] +} + +@test "get_nfpm_arch should return armhf for deb on armv7l" { + run get_nfpm_arch deb armv7l + [ "$output" = "armhf" ] +} + +@test "get_nfpm_arch should return arch if no arch override exists " { + run get_nfpm_arch deb i386 + [ "$output" = "i386" ] +} \ No newline at end of file diff --git a/test/scripts/install.bats b/test/scripts/install.bats new file mode 100644 index 000000000000..67e64c9192a3 --- /dev/null +++ b/test/scripts/install.bats @@ -0,0 +1,163 @@ +#!/usr/bin/env bats + +SCRIPT_NAME="install.sh" +SCRIPT="$BATS_TEST_DIRNAME/../../$SCRIPT_NAME" + +# Override version so it doesn't have to curl and to avoid caching in case the +# user already has the latest version installed. +export VERSION="9999.99.9" + +function should-use-deb() { + DISTRO=$1 ARCH=$2 OS=linux run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing v$VERSION of the $2 deb package from GitHub." ] + [ "${lines[-6]}" = "deb package has been installed." ] +} + +function should-use-rpm() { + DISTRO=$1 ARCH=$2 OS=linux run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing v$VERSION of the $2 rpm package from GitHub." ] + [ "${lines[-6]}" = "rpm package has been installed." ] +} + +function should-fallback-npm() { + YARN_PATH=true DISTRO=$1 ARCH=$2 OS=linux run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "No standalone releases for $2." ] + [ "${lines[2]}" = "Falling back to installation from npm." ] + [ "${lines[3]}" = "Installing v$VERSION from npm." ] + [ "${lines[-6]}" = "npm package has been installed." ] +} + +function should-use-npm() { + YARN_PATH=true DISTRO=$1 ARCH=$2 OS=linux run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing v$VERSION from npm." ] + [ "${lines[-6]}" = "npm package has been installed." ] +} + +function should-use-aur() { + DISTRO=$1 ARCH=$2 OS=linux run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing latest from the AUR." ] + [ "${lines[-6]}" = "AUR package has been installed." ] +} + +function should-fallback-npm-brew() { + YARN_PATH=true BREW_PATH= OS=macos ARCH=$1 run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Homebrew not installed." ] + [ "${lines[2]}" = "Falling back to standalone installation." ] + [ "${lines[3]}" = "No standalone releases for $1." ] + [ "${lines[4]}" = "Falling back to installation from npm." ] + [ "${lines[5]}" = "Installing v$VERSION from npm." ] + [ "${lines[-6]}" = "npm package has been installed." ] +} + +function should-use-brew() { + BREW_PATH=true OS=macos ARCH=$1 run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing latest from Homebrew." ] + [ "${lines[-4]}" = "Brew release has been installed." ] +} + +function should-use-standalone() { + DISTRO=$1 ARCH=$2 OS=$3 run "$SCRIPT" --method standalone --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Installing v$VERSION of the $2 release from GitHub." ] + [[ "${lines[-6]}" = "Standalone release has been installed"* ]] +} + +@test "$SCRIPT_NAME: usage with --help" { + run "$SCRIPT" --help + [ "$status" -eq 0 ] + [ "${lines[0]}" = "Installs code-server." ] + [[ "${lines[-1]}" = "More installation docs are at"* ]] +} + +# These use the deb but fall back to npm for unsupported architectures. +@test "$SCRIPT_NAME: debian arm64" { + should-use-deb "debian" "arm64" +} +@test "$SCRIPT_NAME: debian amd64" { + should-use-deb "debian" "amd64" +} +@test "$SCRIPT_NAME: debian i386" { + should-fallback-npm "debian" "i386" +} + +# These use the rpm but fall back to npm for unsupported architectures. +@test "$SCRIPT_NAME: fedora arm64" { + should-use-rpm "fedora" "arm64" +} +@test "$SCRIPT_NAME: fedora amd64" { + should-use-rpm "fedora" "amd64" +} +@test "$SCRIPT_NAME: fedora i386" { + should-fallback-npm "fedora" "i386" +} + +# These always use npm regardless of the architecture. +@test "$SCRIPT_NAME: alpine arm64" { + should-use-npm "alpine" "arm64" +} +@test "$SCRIPT_NAME: alpine amd64" { + should-use-npm "alpine" "amd64" +} +@test "$SCRIPT_NAME: alpine i386" { + should-use-npm "alpine" "i386" +} + +@test "$SCRIPT_NAME: freebsd arm64" { + should-use-npm "freebsd" "arm64" +} +@test "$SCRIPT_NAME: freebsd amd64" { + should-use-npm "freebsd" "amd64" +} +@test "$SCRIPT_NAME: freebsd i386" { + should-use-npm "freebsd" "i386" +} + +# Arch Linux uses AUR but falls back to npm for unsuppported architectures. +@test "$SCRIPT_NAME: arch arm64" { + should-use-aur "arch" "arm64" +} +@test "$SCRIPT_NAME: arch amd64" { + should-use-aur "arch" "amd64" +} +@test "$SCRIPT_NAME: arch i386" { + should-fallback-npm "arch" "i386" +} + +# macOS use homebrew but falls back to standalone when brew is unavailable then +# to npm for unsupported architectures. +@test "$SCRIPT_NAME: macos amd64 (no brew)" { + should-fallback-npm-brew "amd64" +} +@test "$SCRIPT_NAME: macos arm64 (no brew)" { + BREW_PATH= OS=macos ARCH=arm64 run "$SCRIPT" --dry-run + [ "$status" -eq 0 ] + [ "${lines[1]}" = "Homebrew not installed." ] + [ "${lines[2]}" = "Falling back to standalone installation." ] + [ "${lines[3]}" = "Installing v$VERSION of the arm64 release from GitHub." ] + [[ "${lines[-6]}" = "Standalone release has been installed"* ]] +} +@test "$SCRIPT_NAME: macos i386 (no brew)" { + should-fallback-npm-brew "i386" +} + +@test "$SCRIPT_NAME: macos arm64 (brew)" { + should-use-brew "arm64" +} +@test "$SCRIPT_NAME: macos amd64 (brew)" { + should-use-brew "amd64" +} +@test "$SCRIPT_NAME: macos i386 (brew)" { + should-use-brew "i386" +} + +# Force standalone. +@test "$SCRIPT_NAME: debian amd64 --method standalone" { + should-use-standalone "debian" "amd64" "linux" +} diff --git a/test/scripts/steps-lib.bats b/test/scripts/steps-lib.bats new file mode 100644 index 000000000000..2071a062ea9f --- /dev/null +++ b/test/scripts/steps-lib.bats @@ -0,0 +1,46 @@ +#!/usr/bin/env bats + +SCRIPT_NAME="steps-lib.sh" +SCRIPT="$BATS_TEST_DIRNAME/../../ci/steps/$SCRIPT_NAME" + +source "$SCRIPT" + +@test "is_env_var_set should return 1 if env var is not set" { + run is_env_var_set "ASDF_TEST_SET" + [ "$status" = 1 ] +} + +@test "is_env_var_set should return 0 if env var is set" { + ASDF_TEST_SET="test" run is_env_var_set "ASDF_TEST_SET" + [ "$status" = 0 ] +} + +@test "directory_exists should 1 if directory doesn't exist" { + run directory_exists "/tmp/asdfasdfasdf" + [ "$status" = 1 ] +} + +@test "directory_exists should 0 if directory exists" { + run directory_exists "$(pwd)" + [ "$status" = 0 ] +} + +@test "file_exists should 1 if file doesn't exist" { + run file_exists "hello-asfd.sh" + [ "$status" = 1 ] +} + +@test "file_exists should 0 if file exists" { + run file_exists "$SCRIPT" + [ "$status" = 0 ] +} + +@test "is_executable should 1 if file isn't executable" { + run is_executable "hello-asfd.sh" + [ "$status" = 1 ] +} + +@test "is_executable should 0 if file is executable" { + run is_executable "$SCRIPT" + [ "$status" = 0 ] +} \ No newline at end of file diff --git a/test/tsconfig.json b/test/tsconfig.json new file mode 100644 index 000000000000..5197ce2769f4 --- /dev/null +++ b/test/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../tsconfig.json", + "include": ["./**/*.ts"] +} diff --git a/test/unit/common/emitter.test.ts b/test/unit/common/emitter.test.ts new file mode 100644 index 000000000000..cec5fa611610 --- /dev/null +++ b/test/unit/common/emitter.test.ts @@ -0,0 +1,84 @@ +import { logger } from "@coder/logger" +import { Emitter } from "../../../src/common/emitter" +import { mockLogger } from "../../utils/helpers" + +describe("emitter", () => { + beforeEach(() => { + mockLogger() + }) + + afterEach(() => { + jest.clearAllMocks() + }) + + it("should run the correct callbacks", async () => { + const HELLO_WORLD = "HELLO_WORLD" + const GOODBYE_WORLD = "GOODBYE_WORLD" + const mockCallback = jest.fn(() => "Mock function called") + const mockSecondCallback = jest.fn(() => undefined) + + const emitter = new Emitter<{ event: string; callback: () => void }>() + + const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => { + if (event === HELLO_WORLD) { + callback() + } + } + + const onGoodbyeWorld = ({ event, callback }: { event: string; callback: () => void }): void => { + if (event === GOODBYE_WORLD) { + callback() + } + } + + // Register the onHelloWorld listener + // and the onGoodbyeWorld + const _onHelloWorld = emitter.event(onHelloWorld) + emitter.event(onGoodbyeWorld) + + await emitter.emit({ event: HELLO_WORLD, callback: mockCallback }) + + // Double-check that our callback is called only once + expect(mockCallback).toHaveBeenCalled() + expect(mockCallback).toHaveBeenCalledTimes(1) + + await emitter.emit({ event: GOODBYE_WORLD, callback: mockSecondCallback }) + + // Check that it works with multiple listeners + expect(mockSecondCallback).toHaveBeenCalled() + expect(mockSecondCallback).toHaveBeenCalledTimes(1) + + // Dispose of individual listener + _onHelloWorld.dispose() + + // Try disposing twice + _onHelloWorld.dispose() + + // Dispose of all the listeners + emitter.dispose() + }) + + it("should log an error if something goes wrong", async () => { + const HELLO_WORLD = "HELLO_WORLD" + const mockCallback = jest.fn(() => "Mock function called") + const message = "You don't have access to that folder." + + const emitter = new Emitter<{ event: string; callback: () => void }>() + + const onHelloWorld = ({ event, callback }: { event: string; callback: () => void }): void => { + if (event === HELLO_WORLD) { + callback() + throw new Error(message) + } + } + + emitter.event(onHelloWorld) + + await emitter.emit({ event: HELLO_WORLD, callback: mockCallback }) + + // Check that error was called + expect(logger.error).toHaveBeenCalled() + expect(logger.error).toHaveBeenCalledTimes(1) + expect(logger.error).toHaveBeenCalledWith(message) + }) +}) diff --git a/test/unit/common/http.test.ts b/test/unit/common/http.test.ts new file mode 100644 index 000000000000..ba4981377498 --- /dev/null +++ b/test/unit/common/http.test.ts @@ -0,0 +1,35 @@ +import { HttpCode, HttpError } from "../../../src/common/http" + +describe("http", () => { + describe("HttpCode", () => { + it("should return the correct HTTP codes", () => { + expect(HttpCode.Ok).toBe(200) + expect(HttpCode.Redirect).toBe(302) + expect(HttpCode.NotFound).toBe(404) + expect(HttpCode.BadRequest).toBe(400) + expect(HttpCode.Unauthorized).toBe(401) + expect(HttpCode.LargePayload).toBe(413) + expect(HttpCode.ServerError).toBe(500) + }) + }) + + describe("HttpError", () => { + it("should work as expected", () => { + const message = "Bad request from client" + const httpError = new HttpError(message, HttpCode.BadRequest) + + expect(httpError.message).toBe(message) + expect(httpError.statusCode).toBe(400) + expect(httpError.details).toBeUndefined() + }) + it("should have details if provided", () => { + const details = { + message: "User needs to be signed-in in order to perform action", + } + const message = "Unauthorized" + const httpError = new HttpError(message, HttpCode.BadRequest, details) + + expect(httpError.details).toStrictEqual(details) + }) + }) +}) diff --git a/test/unit/common/util.test.ts b/test/unit/common/util.test.ts new file mode 100644 index 000000000000..9e17b5734691 --- /dev/null +++ b/test/unit/common/util.test.ts @@ -0,0 +1,76 @@ +import { logger } from "@coder/logger" +import { JSDOM } from "jsdom" +import * as util from "../../../src/common/util" +import { mockLogger } from "../../utils/helpers" + +const dom = new JSDOM() +global.document = dom.window.document + +export type LocationLike = Pick + +describe("util", () => { + describe("normalize", () => { + it("should remove multiple slashes", () => { + expect(util.normalize("//foo//bar//baz///mumble")).toBe("/foo/bar/baz/mumble") + }) + + it("should remove trailing slashes", () => { + expect(util.normalize("qux///")).toBe("qux") + }) + + it("should preserve trailing slash if it exists", () => { + expect(util.normalize("qux///", true)).toBe("qux/") + expect(util.normalize("qux", true)).toBe("qux") + }) + }) + + describe("plural", () => { + it("should add an s if count is greater than 1", () => { + expect(util.plural(2, "dog")).toBe("dogs") + }) + it("should NOT add an s if the count is 1", () => { + expect(util.plural(1, "dog")).toBe("dog") + }) + }) + + describe("generateUuid", () => { + it("should generate a unique uuid", () => { + const uuid = util.generateUuid() + const uuid2 = util.generateUuid() + expect(uuid).toHaveLength(24) + expect(typeof uuid).toBe("string") + expect(uuid).not.toBe(uuid2) + }) + it("should generate a uuid of a specific length", () => { + const uuid = util.generateUuid(10) + expect(uuid).toHaveLength(10) + }) + }) + + describe("logError", () => { + beforeAll(() => { + mockLogger() + }) + + afterEach(() => { + jest.clearAllMocks() + }) + + it("should log an error with the message and stack trace", () => { + const message = "You don't have access to that folder." + const error = new Error(message) + + util.logError(logger, "ui", error) + + expect(logger.error).toHaveBeenCalled() + expect(logger.error).toHaveBeenCalledWith(`ui: ${error.message} ${error.stack}`) + }) + + it("should log an error, even if not an instance of error", () => { + util.logError(logger, "api", "oh no") + + expect(logger.error).toHaveBeenCalled() + expect(logger.error).toHaveBeenCalledWith("api: oh no") + }) + }) +}) diff --git a/test/unit/helpers.test.ts b/test/unit/helpers.test.ts new file mode 100644 index 000000000000..033449e9b160 --- /dev/null +++ b/test/unit/helpers.test.ts @@ -0,0 +1,78 @@ +import { promises as fs } from "fs" +import { clean, getAvailablePort, getMaybeProxiedPathname, tmpdir, useEnv } from "../../test/utils/helpers" +import { REVERSE_PROXY_BASE_PATH } from "../utils/constants" + +/** + * This file is for testing test helpers (not core code). + */ +describe("test helpers", () => { + const testName = "temp-dir" + beforeAll(async () => { + await clean(testName) + }) + + it("should return a temp directory", async () => { + const pathToTempDir = await tmpdir(testName) + expect(pathToTempDir).toContain(testName) + expect(fs.access(pathToTempDir)).resolves.toStrictEqual(undefined) + }) +}) + +describe("useEnv", () => { + beforeAll(() => { + jest.resetModules() + process.env.TEST_USE_ENV = "test environment variable" + }) + afterAll(() => { + delete process.env.TEST_USE_ENV + }) + it("should set and reset the env var", () => { + const envKey = "TEST_ENV_VAR" + const [setValue, resetValue] = useEnv(envKey) + setValue("hello-world") + expect(process.env[envKey]).toEqual("hello-world") + resetValue() + expect(process.env[envKey]).toEqual(undefined) + }) + it("should set and reset the env var where a value was already set", () => { + const envKey = "TEST_USE_ENV" + expect(process.env[envKey]).toEqual("test environment variable") + const [setValue, resetValue] = useEnv(envKey) + setValue("hello there") + expect(process.env[envKey]).toEqual("hello there") + resetValue() + expect(process.env[envKey]).toEqual("test environment variable") + }) +}) + +describe("getAvailablePort", () => { + it("should return a valid port", async () => { + const port = await getAvailablePort() + expect(port).toBeGreaterThan(0) + expect(port).toBeLessThanOrEqual(65535) + }) + it("should return different ports for different calls", async () => { + const portOne = await getAvailablePort() + const portTwo = await getAvailablePort() + expect(portOne).not.toEqual(portTwo) + }) +}) + +describe("getMaybeProxiedPathname", () => { + it("should return the route", () => { + const route = "/vscode" + const url = new URL(`http://localhost:3000${route}`) + const actual = getMaybeProxiedPathname(url) + expect(actual).toBe(route) + }) + it("should strip proxy if env var set", () => { + const envKey = "USE_PROXY" + const [setValue, resetValue] = useEnv(envKey) + setValue("1") + const route = "/vscode" + const url = new URL(`http://localhost:3000/8000/${REVERSE_PROXY_BASE_PATH}${route}`) + const actual = getMaybeProxiedPathname(url) + expect(actual).toBe(route) + resetValue() + }) +}) diff --git a/test/unit/node/app.test.ts b/test/unit/node/app.test.ts new file mode 100644 index 000000000000..54e245aec86c --- /dev/null +++ b/test/unit/node/app.test.ts @@ -0,0 +1,307 @@ +import { logger } from "@coder/logger" +import { promises } from "fs" +import * as http from "http" +import * as https from "https" +import * as path from "path" +import { createApp, ensureAddress, handleArgsSocketCatchError, isFdOpts, listen } from "../../../src/node/app" +import { OptionalString, setDefaults } from "../../../src/node/cli" +import { generateCertificate } from "../../../src/node/util" +import { clean, mockLogger, getAvailablePort, tmpdir } from "../../utils/helpers" + +describe("createApp", () => { + let unlinkSpy: jest.SpyInstance + let port: number + let tmpDirPath: string + let tmpFilePath: string + + beforeAll(async () => { + mockLogger() + + const testName = "app" + await clean(testName) + tmpDirPath = await tmpdir(testName) + tmpFilePath = path.join(tmpDirPath, "unlink-socket-file") + }) + + beforeEach(async () => { + // NOTE:@jsjoeio + // Be mindful when spying. + // You can't spy on fs functions if you do import * as fs + // You have to import individually, like we do here with promises + // then you can spy on those modules methods, like unlink. + // See: https://github.com/aelbore/esbuild-jest/issues/26#issuecomment-893763840 + unlinkSpy = jest.spyOn(promises, "unlink") + port = await getAvailablePort() + }) + + afterEach(() => { + jest.clearAllMocks() + }) + + it("should return an Express app, a WebSockets Express app and an http server", async () => { + const defaultArgs = await setDefaults({ + port, + }) + const app = await createApp(defaultArgs) + + // This doesn't check much, but it's a good sanity check + // to ensure we actually get back values from createApp + expect(app.router).not.toBeNull() + expect(app.wsRouter).not.toBeNull() + expect(app.server).toBeInstanceOf(http.Server) + + // Cleanup + app.dispose() + }) + + it("should handle error events on the server", async () => { + const defaultArgs = await setDefaults({ + port, + }) + + const app = await createApp(defaultArgs) + + const testError = new Error("Test error") + // We can easily test how the server handles errors + // By emitting an error event + // Ref: https://stackoverflow.com/a/33872506/3015595 + app.server.emit("error", testError) + expect(logger.error).toHaveBeenCalledTimes(1) + expect(logger.error).toHaveBeenCalledWith(`http server error: ${testError.message} ${testError.stack}`) + + // Cleanup + app.dispose() + }) + + it("should reject errors that happen before the server can listen", async () => { + // We listen on an invalid port + // causing the app to reject the Promise called at startup + const port = 2 + const defaultArgs = await setDefaults({ + port, + }) + + async function masterBall() { + const app = await createApp(defaultArgs) + + const testError = new Error("Test error") + + app.server.emit("error", testError) + + // Cleanup + app.dispose() + } + + expect(() => masterBall()).rejects.toThrow("listen EACCES: permission denied") + }) + + it("should unlink a socket before listening on the socket", async () => { + await promises.writeFile(tmpFilePath, "") + const defaultArgs = await setDefaults({ + socket: tmpFilePath, + }) + + const app = await createApp(defaultArgs) + + expect(unlinkSpy).toHaveBeenCalledWith(tmpFilePath) + app.dispose() + }) + + it("should change the file mode of a socket", async () => { + const defaultArgs = await setDefaults({ + socket: tmpFilePath, + "socket-mode": "777", + }) + + const app = await createApp(defaultArgs) + + expect((await promises.stat(tmpFilePath)).mode & 0o777).toBe(0o777) + app.dispose() + }) + + it("should create an https server if args.cert exists", async () => { + const testCertificate = await generateCertificate("localhost") + const cert = new OptionalString(testCertificate.cert) + const defaultArgs = await setDefaults({ + port, + cert, + ["cert-key"]: testCertificate.certKey, + }) + const app = await createApp(defaultArgs) + + // This doesn't check much, but it's a good sanity check + // to ensure we actually get an https.Server + expect(app.server).toBeInstanceOf(https.Server) + + // Cleanup + app.dispose() + }) +}) + +describe("ensureAddress", () => { + let mockServer: http.Server + + beforeEach(() => { + mockServer = http.createServer() + }) + + afterEach(() => { + mockServer.close() + }) + + it("should throw and error if no address", () => { + expect(() => ensureAddress(mockServer, "http")).toThrow("Server has no address") + }) + it("should return the address if it's a string", async () => { + mockServer.address = () => "/path/to/unix.sock" + const address = ensureAddress(mockServer, "http") + expect(address.toString()).toBe(`/path/to/unix.sock`) + }) + it("should construct URL with an IPv4 address", async () => { + mockServer.address = () => ({ address: "1.2.3.4", port: 5678, family: "IPv4" }) + const address = ensureAddress(mockServer, "http") + expect(address.toString()).toBe(`http://1.2.3.4:5678/`) + }) + it("should construct URL with an IPv6 address", async () => { + mockServer.address = () => ({ address: "a:b:c:d::1234", port: 5678, family: "IPv6" }) + const address = ensureAddress(mockServer, "http") + expect(address.toString()).toBe(`http://[a:b:c:d::1234]:5678/`) + }) +}) + +describe("handleArgsSocketCatchError", () => { + beforeAll(() => { + mockLogger() + }) + + afterEach(() => { + jest.clearAllMocks() + }) + + it("should log an error if its not an NodeJS.ErrnoException", () => { + const message = "other message" + const error = new Error(message) + + expect(() => { + handleArgsSocketCatchError(error) + }).toThrowError(error) + }) + + it("should log an error if its not an NodeJS.ErrnoException (and the error has a message)", () => { + const errorMessage = "handleArgsSocketCatchError Error" + const error = new Error(errorMessage) + + expect(() => { + handleArgsSocketCatchError(error) + }).toThrowError(error) + }) + + it("should not log an error if its a NodeJS.ErrnoException", () => { + const code = "ENOENT" + const error: NodeJS.ErrnoException = new Error(code) + error.code = code + + handleArgsSocketCatchError(error) + + expect(() => { + handleArgsSocketCatchError(error) + }).not.toThrowError() + }) + + it("should log an error if the code is not ENOENT (and the error has a message)", () => { + const errorMessage = "no access" + const error: NodeJS.ErrnoException = new Error() + error.code = "EACCESS" + error.message = errorMessage + + expect(() => { + handleArgsSocketCatchError(error) + }).toThrowError(error) + }) + + it("should log an error if the code is not ENOENT", () => { + const code = "EACCESS" + const error: NodeJS.ErrnoException = new Error(code) + error.code = code + + expect(() => { + handleArgsSocketCatchError(error) + }).toThrowError(error) + }) +}) + +describe("listen", () => { + let tmpDirPath: string + let mockServer: http.Server + + const testName = "listen" + + beforeEach(async () => { + await clean(testName) + mockLogger() + tmpDirPath = await tmpdir(testName) + mockServer = http.createServer() + }) + + afterEach(() => { + mockServer.close() + jest.clearAllMocks() + }) + + it("should throw an error if a directory is passed in instead of a file", async () => { + const errorMessage = "EISDIR: illegal operation on a directory, unlink" + const port = await getAvailablePort() + const mockArgs = { port, host: "0.0.0.0", socket: tmpDirPath } + + try { + await listen(mockServer, mockArgs) + } catch (error) { + expect(error).toBeInstanceOf(Error) + expect((error as any).message).toMatch(errorMessage) + } + }) +}) + +describe("listen (socket-fd)", () => { + // Wrap a bound-but-not-yet-listening TCP socket so we get a real file + // descriptor that listen({ fd }) can adopt, mirroring the systemd socket + // activation case where the process inherits an fd and calls listen(2) on it. + // Using a live net.Server's fd instead fails with EEXIST because the socket + // is already listening in-process. + // eslint-disable-next-line @typescript-eslint/no-var-requires + const { TCP, constants: TCPConstants } = (process as any).binding("tcp_wrap") + + let inherited: any + let httpServer: http.Server + let unlinkSpy: jest.SpyInstance + + beforeEach(async () => { + mockLogger() + unlinkSpy = jest.spyOn(promises, "unlink") + inherited = new TCP(TCPConstants.SERVER) + inherited.bind("127.0.0.1", 0) + httpServer = http.createServer() + }) + + afterEach(() => { + httpServer.close() + try { + inherited.close() + } catch { + // The fd is adopted by httpServer.close() above; ignore double-close. + } + jest.clearAllMocks() + }) + + it("isFdOpts detects a numeric socket-fd", () => { + expect(isFdOpts({ "socket-fd": 3 })).toBe(true) + expect(isFdOpts({ socket: "/tmp/x.sock" } as any)).toBe(false) + }) + + it("listens on an inherited fd without unlinking", async () => { + const fd = inherited.fd as number + await listen(httpServer, { "socket-fd": fd }) + expect(httpServer.address()).not.toBeNull() + expect(unlinkSpy).not.toHaveBeenCalled() + }) +}) diff --git a/test/unit/node/cli.test.ts b/test/unit/node/cli.test.ts new file mode 100644 index 000000000000..d31a35fbe2d9 --- /dev/null +++ b/test/unit/node/cli.test.ts @@ -0,0 +1,1208 @@ +import { Level, logger } from "@coder/logger" +import { promises as fs } from "fs" +import * as os from "os" +import * as path from "path" +import { + UserProvidedArgs, + bindAddrFromArgs, + defaultConfigFile, + defaultSessionSocket, + parse, + parseConfigFile, + setDefaults, + shouldOpenInExistingInstance, + toCodeArgs, + optionDescriptions, + options, + Options, + AuthType, + OptionalString, +} from "../../../src/node/cli" +import { shouldSpawnCliProcess } from "../../../src/node/main" +import { generatePassword, paths } from "../../../src/node/util" +import { + EditorSessionManager, + EditorSessionManagerClient, + makeEditorSessionManagerServer, +} from "../../../src/node/vscodeSocket" +import { clean, useEnv, tmpdir, listenOn } from "../../utils/helpers" + +// The parser should not set any defaults so the caller can determine what +// values the user actually set. These are only set after explicitly calling +// `setDefaults`. +const defaults = { + auth: "password", + host: "localhost", + port: 8080, + "proxy-domain": [], + usingEnvPassword: false, + usingEnvHashedPassword: false, + "extensions-dir": path.join(paths.data, "extensions"), + "user-data-dir": paths.data, + "session-socket": defaultSessionSocket(paths.data), + "app-name": "code-server", + _: [], +} + +describe("parser", () => { + beforeEach(() => { + delete process.env.LOG_LEVEL + delete process.env.PASSWORD + delete process.env.CS_DISABLE_FILE_DOWNLOADS + delete process.env.CS_DISABLE_GETTING_STARTED_OVERRIDE + delete process.env.CODE_SERVER_RECONNECTION_GRACE_TIME + delete process.env.VSCODE_PROXY_URI + delete process.env.CS_DISABLE_PROXY + delete process.env.VSCODE_OPTIONS + console.log = jest.fn() + }) + + it("should parse nothing", async () => { + expect(parse([])).toStrictEqual({}) + }) + + it("should parse all available options", async () => { + expect( + parse( + [ + ["--enable", "feature1"], + ["--enable", "feature2"], + + "--bind-addr=192.169.0.1:8080", + + ["--auth", "none"], + + ["--extensions-dir", "path/to/ext/dir"], + + ["--builtin-extensions-dir", "path/to/builtin/ext/dir"], + + "1", + "--verbose", + ["--app-name", "custom instance name"], + ["--welcome-text", "welcome to code"], + ["--i18n", "path/to/custom-strings.json"], + "2", + + ["--locale", "ja"], + + ["--log", "error"], + + "--help", + + "--open", + + "--socket=mumble", + + "--socket-mode=777", + + "3", + + ["--user-data-dir", "path/to/user/dir"], + + ["--cert=path/to/cert", "--cert-key", "path/to/cert/key"], + + "--version", + + "--json", + + "--port=8081", + + "--disable-file-downloads", + + "--disable-getting-started-override", + + "--disable-proxy", + + ["--abs-proxy-base-path", "/codeserver/app1"], + + "--skip-auth-preflight", + + ["--session-socket", "/tmp/override-code-server-ipc-socket"], + + ["--reconnection-grace-time", "86400"], + + ["--host", "0.0.0.0"], + "4", + "--", + "--5", + ].flat(), + ), + ).toEqual({ + _: ["1", "2", "3", "4", "--5"], + auth: "none", + "builtin-extensions-dir": path.resolve("path/to/builtin/ext/dir"), + "extensions-dir": path.resolve("path/to/ext/dir"), + "user-data-dir": path.resolve("path/to/user/dir"), + "cert-key": path.resolve("path/to/cert/key"), + cert: { + value: path.resolve("path/to/cert"), + }, + "disable-file-downloads": true, + "disable-getting-started-override": true, + "disable-proxy": true, + enable: ["feature1", "feature2"], + help: true, + host: "0.0.0.0", + json: true, + locale: "ja", + log: "error", + open: true, + port: 8081, + socket: path.resolve("mumble"), + "socket-mode": "777", + verbose: true, + "app-name": "custom instance name", + "welcome-text": "welcome to code", + i18n: path.resolve("path/to/custom-strings.json"), + version: true, + "bind-addr": "192.169.0.1:8080", + "session-socket": "/tmp/override-code-server-ipc-socket", + "reconnection-grace-time": "86400", + "abs-proxy-base-path": "/codeserver/app1", + "skip-auth-preflight": true, + }) + }) + + it("should work with short options", async () => { + expect(parse(["-vvv", "-v"])).toEqual({ + verbose: true, + version: true, + }) + }) + + it("should use log level env var", async () => { + const args = parse([]) + expect(args).toEqual({}) + + process.env.LOG_LEVEL = "debug" + const defaults = await setDefaults(args) + expect(defaults).toStrictEqual({ + ...defaults, + log: "debug", + verbose: false, + }) + expect(process.env.LOG_LEVEL).toEqual("debug") + expect(logger.level).toEqual(Level.Debug) + + process.env.LOG_LEVEL = "trace" + const updated = await setDefaults(args) + expect(updated).toStrictEqual({ + ...updated, + log: "trace", + verbose: true, + }) + expect(process.env.LOG_LEVEL).toEqual("trace") + expect(logger.level).toEqual(Level.Trace) + }) + + it("should prefer --log to env var and --verbose to --log", async () => { + let args = parse(["--log", "info"]) + expect(args).toEqual({ + log: "info", + }) + + process.env.LOG_LEVEL = "debug" + const defaults = await setDefaults(args) + expect(defaults).toEqual({ + ...defaults, + log: "info", + verbose: false, + }) + expect(process.env.LOG_LEVEL).toEqual("info") + expect(logger.level).toEqual(Level.Info) + + process.env.LOG_LEVEL = "trace" + const updated = await setDefaults(args) + expect(updated).toEqual({ + ...defaults, + log: "info", + verbose: false, + }) + expect(process.env.LOG_LEVEL).toEqual("info") + expect(logger.level).toEqual(Level.Info) + + args = parse(["--log", "info", "--verbose"]) + expect(args).toEqual({ + log: "info", + verbose: true, + }) + + process.env.LOG_LEVEL = "warn" + const updatedAgain = await setDefaults(args) + expect(updatedAgain).toEqual({ + ...defaults, + log: "trace", + verbose: true, + }) + expect(process.env.LOG_LEVEL).toEqual("trace") + expect(logger.level).toEqual(Level.Trace) + }) + + it("should set valid log level env var", async () => { + process.env.LOG_LEVEL = "error" + const defaults = await setDefaults(parse([])) + expect(defaults).toEqual({ + ...defaults, + log: "error", + }) + }) + + it("should ignore invalid log level env var", async () => { + process.env.LOG_LEVEL = "bogus" + const defaults = await setDefaults(parse([])) + expect(defaults).toEqual({ + ...defaults, + }) + }) + + it("should error if value isn't provided", () => { + expect(() => parse(["--auth"])).toThrowError(/--auth requires a value/) + expect(() => parse(["--auth=", "--log=debug"])).toThrowError(/--auth requires a value/) + expect(() => parse(["--auth", "--log"])).toThrowError(/--auth requires a value/) + expect(() => parse(["--auth", "--invalid"])).toThrowError(/--auth requires a value/) + expect(() => parse(["--bind-addr"])).toThrowError(/--bind-addr requires a value/) + }) + + it("should error if value is invalid", () => { + expect(() => parse(["--port", "foo"])).toThrowError(/--port must be a number/) + expect(() => parse(["--auth", "invalid"])).toThrowError(/--auth valid values: \[password, none\]/) + expect(() => parse(["--log", "invalid"])).toThrowError(/--log valid values: \[trace, debug, info, warn, error\]/) + }) + + it("should error if idle-timeout-seconds is too low", () => { + expect(() => parse(["--idle-timeout-seconds=60"])).toThrowError( + /--idle-timeout-seconds must be greater than 60 seconds/, + ) + expect(() => parse(["--idle-timeout-seconds", "60"])).toThrowError( + /--idle-timeout-seconds must be greater than 60 seconds/, + ) + expect(parse(["--idle-timeout-seconds", "61"])).toEqual({ "idle-timeout-seconds": 61 }) + }) + + it("should error if the option doesn't exist", () => { + expect(() => parse(["--foo"])).toThrowError(/Unknown option --foo/) + }) + + it("should not error if the value is optional", async () => { + expect(parse(["--cert"])).toEqual({ + cert: { + value: undefined, + }, + }) + }) + + it("should not allow option-like values", () => { + expect(() => parse(["--socket", "--socket-path-value"])).toThrowError(/--socket requires a value/) + // If you actually had a path like this you would do this instead: + expect(parse(["--socket", "./--socket-path-value"])).toEqual({ + socket: path.resolve("--socket-path-value"), + }) + expect(() => parse(["--cert", "--socket-path-value"])).toThrowError(/Unknown option --socket-path-value/) + }) + + it("should allow positional arguments before options", async () => { + expect(parse(["test", "--auth", "none"])).toEqual({ + _: ["test"], + auth: "none", + }) + }) + + it("should support repeatable flags", async () => { + expect(() => parse(["--proxy-domain", ""])).toThrowError(/--proxy-domain requires a value/) + expect(parse(["--proxy-domain", "*.coder.com"])).toEqual({ + "proxy-domain": ["*.coder.com"], + }) + expect(parse(["--proxy-domain", "*.coder.com", "--proxy-domain", "test.com"])).toEqual({ + "proxy-domain": ["*.coder.com", "test.com"], + }) + // Commas are literal, at the moment. + expect(parse(["--proxy-domain", "*.coder.com,test.com"])).toEqual({ + "proxy-domain": ["*.coder.com,test.com"], + }) + }) + + it("should enforce cert-key with cert value or otherwise generate one", async () => { + const args = parse(["--cert"]) + expect(args).toEqual({ + cert: { + value: undefined, + }, + }) + expect(() => parse(["--cert", "test"])).toThrowError(/--cert-key is missing/) + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + cert: { + value: path.join(paths.data, "localhost.crt"), + }, + "cert-key": path.join(paths.data, "localhost.key"), + }) + }) + + it("should use env var password", async () => { + process.env.PASSWORD = "test" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + password: "test", + usingEnvPassword: true, + }) + }) + + it("should use env var hashed password", async () => { + process.env.HASHED_PASSWORD = + "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY" // test + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "hashed-password": + "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY", + usingEnvHashedPassword: true, + }) + }) + + it("should parse i18n flag with file path", async () => { + // Test with file path (no validation at CLI parsing level) + const args = parse(["--i18n", "/path/to/custom-strings.json"]) + expect(args).toEqual({ + i18n: "/path/to/custom-strings.json", + }) + }) + + it("should parse i18n flag with relative file path", async () => { + // Test with relative file path + expect(() => parse(["--i18n", "./custom-strings.json"])).not.toThrow() + expect(() => parse(["--i18n", "strings.json"])).not.toThrow() + }) + + it("should support app-name and deprecated welcome-text flags", async () => { + const args = parse(["--app-name", "My App", "--welcome-text", "Welcome!"]) + expect(args).toEqual({ + "app-name": "My App", + "welcome-text": "Welcome!", + }) + }) + + it("should use env var github token", async () => { + process.env.GITHUB_TOKEN = "ga-foo" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "github-auth": "ga-foo", + }) + expect(process.env.GITHUB_TOKEN).toBe(undefined) + }) + + it("should use env var CS_DISABLE_FILE_DOWNLOADS", async () => { + process.env.CS_DISABLE_FILE_DOWNLOADS = "1" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-file-downloads": true, + }) + }) + + it("should use env var CS_DISABLE_FILE_DOWNLOADS set to true", async () => { + process.env.CS_DISABLE_FILE_DOWNLOADS = "true" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-file-downloads": true, + }) + }) + + it("should use env var VSCODE_OPTIONS", async () => { + process.env.VSCODE_OPTIONS = "--enable-sandbox agents=true" + const args = parse(["--vscode-option", "verbose-logging"]) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "vscode-option": ["verbose-logging", "--enable-sandbox", "agents=true"], + }) + }) + + it("should use env var CS_DISABLE_GETTING_STARTED_OVERRIDE", async () => { + process.env.CS_DISABLE_GETTING_STARTED_OVERRIDE = "1" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-getting-started-override": true, + }) + }) + + it("should use env var CS_DISABLE_GETTING_STARTED_OVERRIDE set to true", async () => { + process.env.CS_DISABLE_GETTING_STARTED_OVERRIDE = "true" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-getting-started-override": true, + }) + }) + + it("should use env var CS_DISABLE_PROXY", async () => { + process.env.CS_DISABLE_PROXY = "1" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-proxy": true, + }) + }) + + it("should use env var CS_DISABLE_PROXY set to true", async () => { + process.env.CS_DISABLE_PROXY = "true" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "disable-proxy": true, + }) + }) + + it("should use env var CODE_SERVER_RECONNECTION_GRACE_TIME for reconnection grace time", async () => { + process.env.CODE_SERVER_RECONNECTION_GRACE_TIME = "86400" + const args = parse([]) + expect(args).toEqual({}) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "reconnection-grace-time": "86400", + }) + delete process.env.CODE_SERVER_RECONNECTION_GRACE_TIME + }) + + it("should error if password passed in", () => { + expect(() => parse(["--password", "supersecret123"])).toThrowError( + "--password can only be set in the config file or passed in via $PASSWORD", + ) + }) + + it("should error if hashed-password passed in", () => { + expect(() => parse(["--hashed-password", "fdas423fs8a"])).toThrowError( + "--hashed-password can only be set in the config file or passed in via $HASHED_PASSWORD", + ) + }) + + it("should error if github-auth passed in", () => { + expect(() => parse(["--github-auth", "fdas423fs8a"])).toThrowError( + "--github-auth can only be set in the config file or passed in via $GITHUB_TOKEN", + ) + }) + + it("should filter proxy domains", async () => { + const args = parse(["--proxy-domain", "*.coder.com", "--proxy-domain", "coder.com", "--proxy-domain", "coder.org"]) + expect(args).toEqual({ + "proxy-domain": ["*.coder.com", "coder.com", "coder.org"], + }) + + const defaultArgs = await setDefaults(args) + expect(defaultArgs).toEqual({ + ...defaults, + "proxy-domain": ["{{port}}.coder.com", "{{port}}.coder.org"], + }) + }) + it("should allow '=,$/' in strings", async () => { + const args = parse([ + "--disable-update-check", + "$argon2i$v=19$m=4096,t=3,p=1$0qr/o+0t00hsbjfqcksfdq$ofcm4rl6o+b7oxpua4qlxubypbbpsf+8l531u7p9hyy", + ]) + expect(args).toEqual({ + "disable-update-check": true, + _: ["$argon2i$v=19$m=4096,t=3,p=1$0qr/o+0t00hsbjfqcksfdq$ofcm4rl6o+b7oxpua4qlxubypbbpsf+8l531u7p9hyy"], + }) + }) + it("should parse options with double-dash and multiple equal signs ", async () => { + const args = parse( + [ + "--hashed-password=$argon2i$v=19$m=4096,t=3,p=1$0qr/o+0t00hsbjfqcksfdq$ofcm4rl6o+b7oxpua4qlxubypbbpsf+8l531u7p9hyy", + ], + { + configFile: "/pathtoconfig", + }, + ) + expect(args).toEqual({ + "hashed-password": + "$argon2i$v=19$m=4096,t=3,p=1$0qr/o+0t00hsbjfqcksfdq$ofcm4rl6o+b7oxpua4qlxubypbbpsf+8l531u7p9hyy", + }) + }) + it("should throw an error for invalid config values", async () => { + const fakePath = "/fake-config-path" + const expectedErrMsg = `error reading ${fakePath}: ` + + expect(() => + parse(["--foo"], { + configFile: fakePath, + }), + ).toThrowError(expectedErrMsg) + }) + it("should fail to parse invalid config", () => { + expect(() => parseConfigFile("test", "/fake-config-path")).toThrowError("invalid config: test") + }) + it("should parse repeatable options", () => { + const configContents = ` + install-extension: + - extension.number1 + - extension.number2 + ` + expect(parseConfigFile(configContents, "/fake-config-path")).toEqual({ + config: "/fake-config-path", + "install-extension": ["extension.number1", "extension.number2"], + }) + }) + it("should expand ~ in path options from the config file", () => { + const configContents = ` + user-data-dir: ~/.config/code-server-data + extensions-dir: ~/extensions + ` + expect(parseConfigFile(configContents, "/fake-config-path")).toEqual({ + config: "/fake-config-path", + "user-data-dir": path.join(os.homedir(), ".config/code-server-data"), + "extensions-dir": path.join(os.homedir(), "extensions"), + }) + }) + it("should ignore optional strings set to false", async () => { + expect(parse(["--cert=false"])).toEqual({}) + }) + it("should ignore booleans set to false", async () => { + expect(parse(["--disable-telemetry=false"])).toEqual({}) + }) + it("should parse booleans set to false in the config file", () => { + const configContents = ` + disable-telemetry: false + disable-update-check: true + ` + expect(parseConfigFile(configContents, "/fake-config-path")).toEqual({ + config: "/fake-config-path", + "disable-update-check": true, + }) + }) + it("should use last flag", async () => { + expect(parse(["--port", "8081", "--port", "8082"])).toEqual({ + port: 8082, + }) + }) + + it("should not set proxy uri", async () => { + await setDefaults(parse([])) + expect(process.env.VSCODE_PROXY_URI).toBeUndefined() + }) + + it("should set proxy uri", async () => { + await setDefaults(parse(["--proxy-domain", "coder.org"])) + expect(process.env.VSCODE_PROXY_URI).toEqual("//{{port}}.coder.org") + }) + + it("should set proxy uri to first domain", async () => { + await setDefaults( + parse(["--proxy-domain", "*.coder.com", "--proxy-domain", "coder.com", "--proxy-domain", "coder.org"]), + ) + expect(process.env.VSCODE_PROXY_URI).toEqual("//{{port}}.coder.com") + }) + + it("should not override existing proxy uri", async () => { + process.env.VSCODE_PROXY_URI = "foo" + await setDefaults( + parse(["--proxy-domain", "*.coder.com", "--proxy-domain", "coder.com", "--proxy-domain", "coder.org"]), + ) + expect(process.env.VSCODE_PROXY_URI).toEqual("foo") + }) +}) + +describe("cli", () => { + const testName = "cli" + let tmpDirPath: string + + beforeAll(async () => { + await clean(testName) + }) + + beforeEach(async () => { + delete process.env.VSCODE_IPC_HOOK_CLI + tmpDirPath = await tmpdir(testName) + }) + + it("should use existing if inside code-server", async () => { + process.env.VSCODE_IPC_HOOK_CLI = "test" + const args: UserProvidedArgs = {} + expect(await shouldOpenInExistingInstance(args, "")).toStrictEqual("test") + + args.port = 8081 + args._ = ["./file"] + expect(await shouldOpenInExistingInstance(args, "")).toStrictEqual("test") + }) + + it("should use existing if --reuse-window is set", async () => { + const sessionSocket = path.join(tmpDirPath, "session-socket") + const server = await makeEditorSessionManagerServer(sessionSocket, new EditorSessionManager()) + + const args: UserProvidedArgs = {} + args["reuse-window"] = true + await expect(shouldOpenInExistingInstance(args, sessionSocket)).rejects.toThrow() + + const socketPath = path.join(tmpDirPath, "socket") + const client = new EditorSessionManagerClient(sessionSocket) + await client.addSession({ + entry: { + workspace: { + id: "aaa", + folders: [ + { + uri: { + path: "/aaa", + }, + }, + ], + }, + socketPath, + }, + }) + const vscodeSockets = listenOn(socketPath) + + await expect(shouldOpenInExistingInstance(args, sessionSocket)).resolves.toStrictEqual(socketPath) + + args.port = 8081 + await expect(shouldOpenInExistingInstance(args, sessionSocket)).resolves.toStrictEqual(socketPath) + + server.close() + vscodeSockets.close() + }) + + it("should use existing if --new-window is set", async () => { + const sessionSocket = path.join(tmpDirPath, "session-socket") + const server = await makeEditorSessionManagerServer(sessionSocket, new EditorSessionManager()) + + const args: UserProvidedArgs = {} + args["new-window"] = true + await expect(shouldOpenInExistingInstance(args, sessionSocket)).rejects.toThrow() + + const socketPath = path.join(tmpDirPath, "socket") + const client = new EditorSessionManagerClient(sessionSocket) + await client.addSession({ + entry: { + workspace: { + id: "aaa", + folders: [ + { + uri: { + path: "/aaa", + }, + }, + ], + }, + socketPath, + }, + }) + const vscodeSockets = listenOn(socketPath) + + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(socketPath) + + args.port = 8081 + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(socketPath) + + server.close() + vscodeSockets.close() + }) + + it("should use existing if no unrelated flags are set, has positional, and socket is active", async () => { + const sessionSocket = path.join(tmpDirPath, "session-socket") + const server = await makeEditorSessionManagerServer(sessionSocket, new EditorSessionManager()) + + const args: UserProvidedArgs = {} + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(undefined) + + args._ = ["./file"] + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(undefined) + + const client = new EditorSessionManagerClient(sessionSocket) + const socketPath = path.join(tmpDirPath, "socket") + await client.addSession({ + entry: { + workspace: { + id: "aaa", + folders: [ + { + uri: { + path: "/aaa", + }, + }, + ], + }, + socketPath, + }, + }) + const vscodeSockets = listenOn(socketPath) + + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(socketPath) + + args.port = 8081 + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(undefined) + + server.close() + vscodeSockets.close() + }) + + it("should prefer matching sessions for only the first path", async () => { + const sessionSocket = path.join(tmpDirPath, "session-socket") + const server = await makeEditorSessionManagerServer(sessionSocket, new EditorSessionManager()) + const client = new EditorSessionManagerClient(sessionSocket) + await client.addSession({ + entry: { + workspace: { + id: "aaa", + folders: [ + { + uri: { + path: "/aaa", + }, + }, + ], + }, + socketPath: `${tmpDirPath}/vscode-ipc-aaa.sock`, + }, + }) + await client.addSession({ + entry: { + workspace: { + id: "bbb", + folders: [ + { + uri: { + path: "/bbb", + }, + }, + ], + }, + socketPath: `${tmpDirPath}/vscode-ipc-bbb.sock`, + }, + }) + listenOn(`${tmpDirPath}/vscode-ipc-aaa.sock`, `${tmpDirPath}/vscode-ipc-bbb.sock`) + + const args: UserProvidedArgs = {} + args._ = ["/aaa/file", "/bbb/file"] + expect(await shouldOpenInExistingInstance(args, sessionSocket)).toStrictEqual(`${tmpDirPath}/vscode-ipc-aaa.sock`) + + server.close() + }) +}) + +describe("shouldSpawnCliProcess", () => { + it("should return false if no 'extension' related args passed in", async () => { + const args = {} + const actual = await shouldSpawnCliProcess(args) + const expected = false + + expect(actual).toBe(expected) + }) + + it("should return true if 'list-extensions' passed in", async () => { + const args = { + ["list-extensions"]: true, + } + const actual = await shouldSpawnCliProcess(args) + const expected = true + + expect(actual).toBe(expected) + }) + + it("should return true if 'install-extension' passed in", async () => { + const args = { + ["install-extension"]: ["hello.world"], + } + const actual = await shouldSpawnCliProcess(args) + const expected = true + + expect(actual).toBe(expected) + }) + + it("should return true if 'uninstall-extension' passed in", async () => { + const args: UserProvidedArgs = { + ["uninstall-extension"]: ["hello.world"], + } + const actual = await shouldSpawnCliProcess(args) + const expected = true + + expect(actual).toBe(expected) + }) +}) + +describe("bindAddrFromArgs", () => { + it("should return the bind address", () => { + const args: UserProvidedArgs = {} + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = addr + + expect(actual).toStrictEqual(expected) + }) + + it("should use the bind-address if set in args", () => { + const args: UserProvidedArgs = { + ["bind-addr"]: "localhost:3000", + } + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "localhost", + port: 3000, + } + + expect(actual).toStrictEqual(expected) + }) + + it("should use the host if set in args", () => { + const args: UserProvidedArgs = { + ["host"]: "coder", + } + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "coder", + port: 8080, + } + + expect(actual).toStrictEqual(expected) + }) + + it("should use process.env.CODE_SERVER_HOST if set", () => { + const [setValue, resetValue] = useEnv("CODE_SERVER_HOST") + setValue("coder") + + const args: UserProvidedArgs = {} + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "coder", + port: 8080, + } + + expect(actual).toStrictEqual(expected) + resetValue() + }) + + it("should use the args.host over process.env.CODE_SERVER_HOST if both set", () => { + const [setValue, resetValue] = useEnv("CODE_SERVER_HOST") + setValue("coder") + + const args: UserProvidedArgs = { + host: "123.123.123.123", + } + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "123.123.123.123", + port: 8080, + } + + expect(actual).toStrictEqual(expected) + resetValue() + }) + + it("should use process.env.PORT if set", () => { + const [setValue, resetValue] = useEnv("PORT") + setValue("8000") + + const args: UserProvidedArgs = {} + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "localhost", + port: 8000, + } + + expect(actual).toStrictEqual(expected) + resetValue() + }) + + it("should set port if in args", () => { + const args: UserProvidedArgs = { + port: 3000, + } + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "localhost", + port: 3000, + } + + expect(actual).toStrictEqual(expected) + }) + + it("should use the args.port over process.env.PORT if both set", () => { + const [setValue, resetValue] = useEnv("PORT") + setValue("8000") + + const args: UserProvidedArgs = { + port: 3000, + } + + const addr = { + host: "localhost", + port: 8080, + } + + const actual = bindAddrFromArgs(addr, args) + const expected = { + host: "localhost", + port: 3000, + } + + expect(actual).toStrictEqual(expected) + resetValue() + }) +}) + +describe("defaultSessionSocket", () => { + const dataDir = path.join("/home/coder/.local/share", "code-server") + + it("should put the socket in the user data directory", () => { + expect(defaultSessionSocket(dataDir, "linux")).toBe(path.join(dataDir, "code-server-ipc.sock")) + }) + + it("should use a named pipe on windows", () => { + expect(defaultSessionSocket(dataDir, "win32")).toMatch(/^\\\\\.\\pipe\\code-server-ipc-[0-9a-f]{16}$/) + }) + + it("should give separate data directories separate pipes", () => { + expect(defaultSessionSocket(dataDir, "win32")).not.toBe(defaultSessionSocket(dataDir + "-other", "win32")) + }) + + it("should give one data directory one pipe however it is spelled", () => { + expect(defaultSessionSocket(dataDir.toUpperCase(), "win32")).toBe(defaultSessionSocket(dataDir, "win32")) + }) +}) + +describe("defaultConfigFile", () => { + it("should return the default config file as a string", async () => { + const password = await generatePassword() + const actual = defaultConfigFile(password) + + expect(actual).toMatch(`bind-addr: 127.0.0.1:8080 +auth: password +password: ${password} +cert: false`) + }) +}) + +describe("toCodeArgs", () => { + const vscodeDefaults = { + ...defaults, + help: false, + port: "8080", + version: false, + log: undefined, + } + + const testName = "vscode-args" + beforeAll(async () => { + // Clean up temporary directories from the previous run. + await clean(testName) + }) + + it("should convert empty args", async () => { + expect(await toCodeArgs(await setDefaults(parse([])))).toStrictEqual({ + ...vscodeDefaults, + }) + }) + + it("should ignore regular file", async () => { + const file = path.join(await tmpdir(testName), "file") + await fs.writeFile(file, "foobar") + expect(await toCodeArgs(await setDefaults(parse([file])))).toStrictEqual({ + ...vscodeDefaults, + _: [file], + }) + }) + + it("should pass through --vscode-option", async () => { + const args = parse([ + "--vscode-option", + "enable-sandbox", + "--vscode-option", + "agents=true", + "--vscode-option", + "enable-smoke-test-driver=false", + ]) + expect(await toCodeArgs(await setDefaults(args))).toStrictEqual({ + ...vscodeDefaults, + "enable-sandbox": true, + agents: true, + "enable-smoke-test-driver": false, + }) + }) + + it("should pass through --enable-remote-storage", async () => { + expect(await toCodeArgs(await setDefaults(parse(["--enable-remote-storage"])))).toStrictEqual({ + ...vscodeDefaults, + "enable-remote-storage": true, + }) + }) + + it("should collect a repeated --vscode-option into an array", async () => { + const args = parse([ + "--vscode-option", + "locate-extension=a", + "--vscode-option", + "locate-extension=b", + "--vscode-option", + "locate-extension=c", + ]) + expect(await toCodeArgs(await setDefaults(args))).toStrictEqual({ + ...vscodeDefaults, + "locate-extension": ["a", "b", "c"], + }) + }) + + it("should error if --vscode-option has no flag", async () => { + await expect(toCodeArgs(await setDefaults(parse(["--vscode-option", "=nothing"])))).rejects.toThrow( + "--vscode-option requires a flag name", + ) + }) +}) + +describe("optionDescriptions", () => { + it("should return the descriptions of all the available options", () => { + const expectedOptionDescriptions = Object.entries(options) + .flat() + .filter((item: any) => { + if (item.description) { + return item.description + } + }) + .map((item: any) => item.description) + const actualOptionDescriptions = optionDescriptions() + // We need both the expected and the actual + // Both of these are string[] + // We then loop through the expectedOptionDescriptions + // and check that this expectedDescription exists in the + // actualOptionDescriptions + + // To do that we need to loop through actualOptionDescriptions + // and make sure we have a substring match + expectedOptionDescriptions.forEach((expectedDescription) => { + const exists = actualOptionDescriptions.find((desc) => { + if ( + desc.replace(/\n/g, " ").replace(/ /g, "").includes(expectedDescription.replace(/\n/g, " ").replace(/ /g, "")) + ) { + return true + } + return false + }) + expect(exists).toBeTruthy() + }) + }) + it("should visually align multiple options", () => { + const opts: Partial>> = { + "cert-key": { type: "string", path: true, description: "Path to certificate key when using non-generated cert." }, + "cert-host": { + type: "string", + description: "Hostname to use when generating a self signed certificate.", + }, + "disable-update-check": { + type: "boolean", + description: + "Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and \n" + + "then notifies you once every week that a new release is available.", + }, + } + expect(optionDescriptions(opts)).toStrictEqual([ + " --cert-key Path to certificate key when using non-generated cert.", + " --cert-host Hostname to use when generating a self signed certificate.", + ` --disable-update-check Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and + then notifies you once every week that a new release is available.`, + ]) + }) + it("should add all valid options for enumerated types", () => { + const opts: Partial>> = { + auth: { type: AuthType, description: "The type of authentication to use." }, + } + expect(optionDescriptions(opts)).toStrictEqual([" --auth The type of authentication to use. [password, none]"]) + }) + + it("should show if an option is deprecated", () => { + const opts: Partial>> = { + cert: { + type: OptionalString, + description: "foo", + deprecated: true, + }, + } + expect(optionDescriptions(opts)).toStrictEqual([" --cert (deprecated) foo"]) + }) + + it("should show newlines in description", () => { + const opts: Partial>> = { + "install-extension": { + type: "string[]", + description: + "Install or update a VS Code extension by id or vsix. The identifier of an extension is `${publisher}.${name}`.\n" + + "To install a specific version provide `@${version}`. For example: 'vscode.csharp@1.2.3'.", + }, + } + expect(optionDescriptions(opts)).toStrictEqual([ + ` --install-extension Install or update a VS Code extension by id or vsix. The identifier of an extension is \`\${publisher}.\${name}\`. + To install a specific version provide \`@\${version}\`. For example: 'vscode.csharp@1.2.3'.`, + ]) + }) +}) diff --git a/test/unit/node/constants.test.ts b/test/unit/node/constants.test.ts new file mode 100644 index 000000000000..2ed963f87ba3 --- /dev/null +++ b/test/unit/node/constants.test.ts @@ -0,0 +1,143 @@ +import { logger } from "@coder/logger" +import path from "path" +import * as semver from "semver" +import { mockLogger } from "../../utils/helpers" + +describe("constants", () => { + let constants: typeof import("../../../src/node/constants") + + describe("with package.json defined", () => { + const mockPackageJson = { + name: "mock-code-server", + description: "Run VS Code on a remote server.", + repository: "https://github.com/coder/code-server", + version: "1.0.0", + commit: "f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b", + } + + const mockCodePackageJson = { + name: "mock-vscode", + version: "1.2.3", + } + + beforeAll(() => { + jest.clearAllMocks() + mockLogger() + jest.mock(path.resolve(__dirname, "../../../package.json"), () => mockPackageJson, { virtual: true }) + jest.mock(path.resolve(__dirname, "../../../lib/vscode/package.json"), () => mockCodePackageJson, { + virtual: true, + }) + constants = require("../../../src/node/constants") + }) + + afterAll(() => { + jest.resetModules() + }) + + it("should provide the commit", () => { + expect(constants.commit).toBe(mockPackageJson.commit) + }) + + it("should return the package.json version", () => { + expect(constants.version).toBe(mockPackageJson.version) + + // Ensure the version is parseable as semver and equal + const actual = semver.parse(constants.version) + const expected = semver.parse(mockPackageJson.version) + expect(actual).toBeTruthy() + expect(actual).toStrictEqual(expected) + }) + + it("should include embedded Code version information", () => { + expect(constants.codeVersion).toBe(mockCodePackageJson.version) + + // Ensure the version is parseable as semver and equal + const actual = semver.parse(constants.codeVersion) + const expected = semver.parse(mockCodePackageJson.version) + expect(actual).toBeTruthy() + expect(actual).toStrictEqual(expected) + }) + + it("should return a human-readable version string", () => { + expect(constants.getVersionString()).toStrictEqual( + `${mockPackageJson.version} ${mockPackageJson.commit} with Code ${mockCodePackageJson.version}`, + ) + }) + + it("should return a machine-readable version string", () => { + expect(constants.getVersionJsonString()).toStrictEqual( + JSON.stringify({ + codeServer: mockPackageJson.version, + commit: mockPackageJson.commit, + vscode: mockCodePackageJson.version, + }), + ) + }) + + describe("getPackageJson", () => { + it("should log a warning if package.json not found", () => { + const expectedErrorMessage = "Cannot find module './package.json' from 'src/node/constants.ts'" + + constants.getPackageJson("./package.json") + + expect(logger.warn).toHaveBeenCalled() + expect(logger.warn).toHaveBeenCalledWith(expectedErrorMessage) + }) + + it("should find the package.json", () => { + // the function calls require from src/node/constants + // so to get the root package.json we need to use ../../ + const packageJson = constants.getPackageJson("../../package.json") + expect(packageJson).toStrictEqual(mockPackageJson) + + const codePackageJson = constants.getPackageJson("../../lib/vscode/package.json") + expect(codePackageJson).toStrictEqual(mockCodePackageJson) + }) + }) + }) + + describe("with incomplete package.json", () => { + const mockPackageJson = { + name: "mock-code-server", + } + const mockCodePackageJson = { + name: "mock-vscode", + } + + beforeAll(() => { + jest.clearAllMocks() + jest.mock(path.resolve(__dirname, "../../../package.json"), () => mockPackageJson, { virtual: true }) + jest.mock(path.resolve(__dirname, "../../../lib/vscode/package.json"), () => mockCodePackageJson, { + virtual: true, + }) + constants = require("../../../src/node/constants") + }) + + afterAll(() => { + jest.resetModules() + }) + + it("version should return 'development'", () => { + expect(constants.version).toBe("development") + }) + + it("commit should return 'development'", () => { + expect(constants.commit).toBe("development") + }) + + it("should return a human-readable version string", () => { + // this string is not super useful + expect(constants.getVersionString()).toStrictEqual("development development with Code development") + }) + + it("should return a machine-readable version string", () => { + expect(constants.getVersionJsonString()).toStrictEqual( + JSON.stringify({ + codeServer: "development", + commit: "development", + vscode: "development", + }), + ) + }) + }) +}) diff --git a/test/unit/node/heart.test.ts b/test/unit/node/heart.test.ts new file mode 100644 index 000000000000..85b1945e3760 --- /dev/null +++ b/test/unit/node/heart.test.ts @@ -0,0 +1,188 @@ +import { logger } from "@coder/logger" +import { readFile, writeFile, stat, utimes } from "fs/promises" +import { setImmediate } from "timers" +import { Heart } from "../../../src/node/heart" +import { clean, mockLogger, tmpdir } from "../../utils/helpers" + +describe("Heart", () => { + const testName = "heartTests" + let testDir = "" + let heart: Heart + + beforeAll(async () => { + mockLogger() + await clean(testName) + testDir = await tmpdir(testName) + }) + + afterAll(() => { + jest.restoreAllMocks() + }) + + beforeEach(() => { + heart = new Heart(`${testDir}/shutdown.txt`, jest.fn().mockResolvedValue(true)) + }) + + afterEach(() => { + jest.resetAllMocks() + jest.useRealTimers() + if (heart) { + heart.dispose() + } + }) + + it("should write to a file when given a valid file path", async () => { + // Set up heartbeat file with contents + const text = "test" + const pathToFile = `${testDir}/file.txt` + await writeFile(pathToFile, text) + const fileContents = await readFile(pathToFile, { encoding: "utf8" }) + // Explicitly set the modified time to 0 so that we can check + // that the file was indeed modified after calling heart.beat(). + // This works around any potential race conditions. + // Docs: https://nodejs.org/api/fs.html#fspromisesutimespath-atime-mtime + await utimes(pathToFile, 0, 0) + + expect(fileContents).toBe(text) + + heart = new Heart(pathToFile, jest.fn().mockResolvedValue(true)) + await heart.beat() + // Check that the heart wrote to the heartbeatFilePath and overwrote our text + const fileContentsAfterBeat = await readFile(pathToFile, { encoding: "utf8" }) + expect(fileContentsAfterBeat).not.toBe(text) + // Make sure the modified timestamp was updated. + const fileStatusAfterEdit = await stat(pathToFile) + expect(fileStatusAfterEdit.mtimeMs).toBeGreaterThan(0) + }) + + it("should log a warning when given an invalid file path", async () => { + heart = new Heart(`fakeDir/fake.txt`, jest.fn().mockResolvedValue(false)) + await heart.beat() + expect(logger.warn).toHaveBeenCalled() + }) + + it("should be active after calling beat", async () => { + await heart.beat() + + const isAlive = heart.alive() + expect(isAlive).toBe(true) + }) + + it("should not be active after dispose is called", () => { + heart.dispose() + + const isAlive = heart.alive() + expect(isAlive).toBe(false) + }) + + it("should beat twice without warnings", async () => { + heart = new Heart(`${testDir}/hello.txt`, jest.fn().mockResolvedValue(true)) + await heart.beat() + jest.runAllTimers() + expect(logger.warn).not.toHaveBeenCalled() + }) +}) + +describe("heartbeatTimer", () => { + const testName = "heartbeatTimer" + let testDir = "" + + beforeAll(async () => { + await clean(testName) + testDir = await tmpdir(testName) + mockLogger() + }) + + afterAll(() => { + jest.restoreAllMocks() + }) + + beforeEach(() => { + jest.useFakeTimers() + }) + + afterEach(() => { + jest.resetAllMocks() + jest.clearAllTimers() + jest.useRealTimers() + }) + + it("should call isActive when timeout expires", async () => { + const mockIsActive = jest.fn().mockResolvedValue(true) + const heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive) + await heart.beat() + jest.advanceTimersByTime(60 * 1000) + expect(mockIsActive).toHaveBeenCalled() + }) + + it("should log a warning when isActive rejects", async () => { + const error = new Error("oh no") + const mockIsActive = jest.fn().mockRejectedValue(error) + const heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive) + await heart.beat() + jest.advanceTimersByTime(60 * 1000) + expect(mockIsActive).toHaveBeenCalled() + + // The timer callback waits on mockIsActive, so we need to yield to let the + // callback finish. + await new Promise((resolve) => setImmediate(resolve)) + + expect(logger.warn).toHaveBeenCalledWith(error.message) + }) +}) + +describe("stateChange", () => { + const testName = "stateChange" + let testDir = "" + let heart: Heart + + beforeAll(async () => { + await clean(testName) + testDir = await tmpdir(testName) + mockLogger() + }) + + afterAll(() => { + jest.restoreAllMocks() + }) + + beforeEach(() => { + jest.useFakeTimers() + }) + + afterEach(() => { + jest.resetAllMocks() + jest.useRealTimers() + if (heart) { + heart.dispose() + } + }) + + it("should change to alive after a beat", async () => { + const mockIsActive = jest.fn().mockResolvedValue(true) + heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive) + const mockOnChange = jest.fn() + heart.onChange(mockOnChange) + + await heart.beat() + + expect(mockOnChange.mock.calls[0][0]).toBe("alive") + }) + + it("should change to expired when not active", async () => { + const mockIsActive = jest.fn().mockResolvedValue(false) + heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive) + const mockOnChange = jest.fn() + heart.onChange(mockOnChange) + + await heart.beat() + jest.advanceTimersByTime(60 * 1000) + expect(mockIsActive).toHaveBeenCalled() + + // The timer callback waits on the isActive promise, so we need to yield to + // let the callback finish. + await new Promise((resolve) => setImmediate(resolve)) + + expect(mockOnChange.mock.calls[1][0]).toBe("expired") + }) +}) diff --git a/test/unit/node/http.test.ts b/test/unit/node/http.test.ts new file mode 100644 index 000000000000..26fe9be7940b --- /dev/null +++ b/test/unit/node/http.test.ts @@ -0,0 +1,169 @@ +import { getMockReq } from "@jest-mock/express" +import * as http from "../../../src/node/http" +import { mockLogger } from "../../utils/helpers" + +describe("http", () => { + beforeEach(() => { + mockLogger() + }) + + afterEach(() => { + jest.clearAllMocks() + }) + + it("should construct a relative path to the root", () => { + expect(http.relativeRoot("/")).toStrictEqual(".") + expect(http.relativeRoot("/foo")).toStrictEqual(".") + expect(http.relativeRoot("/foo/")).toStrictEqual("./..") + expect(http.relativeRoot("/foo/bar ")).toStrictEqual("./..") + expect(http.relativeRoot("/foo/bar/")).toStrictEqual("./../..") + }) + + describe("isTrustedOrigin", () => { + it("should match exact origins", () => { + expect(http.isTrustedOrigin("localhost:8080", ["localhost:8080"])).toBe(true) + expect(http.isTrustedOrigin("example.com", ["example.com"])).toBe(true) + expect(http.isTrustedOrigin("example.com", ["other.com"])).toBe(false) + }) + + it("should match the wildcard *", () => { + expect(http.isTrustedOrigin("anything.example.com", ["*"])).toBe(true) + expect(http.isTrustedOrigin("localhost:8080", ["*"])).toBe(true) + }) + + it("should match *.example.com wildcard (same style as --proxy-domain)", () => { + expect(http.isTrustedOrigin("sub.example.com", ["*.example.com"])).toBe(true) + expect(http.isTrustedOrigin("example.com", ["*.example.com"])).toBe(true) + expect(http.isTrustedOrigin("evil.com", ["*.example.com"])).toBe(false) + expect(http.isTrustedOrigin("example.com.evil.com", ["*.example.com"])).toBe(false) + }) + + it("should return false for an empty trusted origins list", () => { + expect(http.isTrustedOrigin("example.com", [])).toBe(false) + }) + }) + + describe("origin", () => { + ;[ + { + origin: "", + host: "", + }, + { + origin: "http://localhost:8080", + host: "", + expected: "no host headers", + }, + { + origin: "http://localhost:8080", + host: " ", + expected: "does not match", + }, + { + origin: "http://localhost:8080", + host: "localhost:8080", + }, + { + origin: "http://localhost:8080", + host: "localhost:8081", + expected: "does not match", + }, + { + origin: "localhost:8080", + host: "localhost:8080", + expected: "does not match", // Gets parsed as host: localhost and path: 8080. + }, + { + origin: "test.org", + host: "localhost:8080", + expected: "malformed", // Parsing fails completely. + }, + { + origin: "http://sub.example.com", + host: "other.com", + trustedOrigins: ["*.example.com"], + }, + { + origin: "http://evil.com", + host: "other.com", + trustedOrigins: ["*.example.com"], + expected: "does not match", + }, + { + origin: "http://sub.example.com", + host: "other.com", + trustedOrigins: ["*"], + }, + ].forEach((test) => { + ;[ + ["host", test.host], + ["x-forwarded-host", test.host], + ["x-forwarded-host", `${test.host}, ${test.host}`], + ["forwarded", `for=127.0.0.1, host=${test.host}, proto=http`], + ["forwarded", `for=127.0.0.1;proto=http;host=${test.host}`], + ["forwarded", `proto=http;host=${test.host}, for=127.0.0.1`], + ].forEach(([key, value]) => { + it(`${test.origin} -> [${key}: ${value}]`, () => { + const req = getMockReq({ + originalUrl: "localhost:8080", + headers: { + origin: test.origin, + [key]: value, + }, + args: { + "trusted-origins": (test as { trustedOrigins?: string[] }).trustedOrigins, + }, + }) + if (typeof test.expected === "string") { + expect(() => http.authenticateOrigin(req)).toThrow(test.expected) + } else { + expect(() => http.authenticateOrigin(req)).not.toThrow() + } + }) + }) + }) + }) + + describe("constructRedirectPath", () => { + it("should preserve slashes in queryString so they are human-readable", () => { + const mockReq = getMockReq({ + originalUrl: "localhost:8080", + }) + const mockQueryParams = { folder: "/Users/jp/dev/coder" } + const mockTo = "" + const actual = http.constructRedirectPath(mockReq, mockQueryParams, mockTo) + const expected = "./?folder=/Users/jp/dev/coder" + expect(actual).toBe(expected) + }) + it("should use an empty string if no query params", () => { + const mockReq = getMockReq({ + originalUrl: "localhost:8080", + }) + const mockQueryParams = {} + const mockTo = "" + const actual = http.constructRedirectPath(mockReq, mockQueryParams, mockTo) + const expected = "./" + expect(actual).toBe(expected) + }) + it("should append the 'to' path relative to the originalUrl", () => { + const mockReq = getMockReq({ + originalUrl: "localhost:8080", + }) + const mockQueryParams = {} + const mockTo = "vscode" + const actual = http.constructRedirectPath(mockReq, mockQueryParams, mockTo) + const expected = "./vscode" + expect(actual).toBe(expected) + }) + it("should append append queryParams after 'to' path", () => { + const mockReq = getMockReq({ + originalUrl: "localhost:8080", + }) + const mockQueryParams = { folder: "/Users/jp/dev/coder" } + const mockTo = "vscode" + const actual = http.constructRedirectPath(mockReq, mockQueryParams, mockTo) + const expected = "./vscode?folder=/Users/jp/dev/coder" + expect(actual).toBe(expected) + }) + }) +}) diff --git a/test/unit/node/i18n.test.ts b/test/unit/node/i18n.test.ts new file mode 100644 index 000000000000..8670f55a194c --- /dev/null +++ b/test/unit/node/i18n.test.ts @@ -0,0 +1,158 @@ +import { promises as fs } from "fs" +import * as os from "os" +import * as path from "path" +import i18n, { loadCustomStrings } from "../../../src/node/i18n" + +describe("i18n", () => { + it("includes Turkish translations", () => { + expect(i18n.getResource("tr", "translation", "WELCOME")).toBe("{{app}} uygulamasına hoş geldiniz") + }) + + let tempDir: string + let validJsonFile: string + let invalidJsonFile: string + let nonExistentFile: string + + beforeEach(async () => { + // Create temporary directory for test files + tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "code-server-i18n-test-")) + + // Create test files + validJsonFile = path.join(tempDir, "valid.json") + invalidJsonFile = path.join(tempDir, "invalid.json") + nonExistentFile = path.join(tempDir, "does-not-exist.json") + + // Write valid JSON file + await fs.writeFile( + validJsonFile, + JSON.stringify({ + WELCOME: "Custom Welcome", + LOGIN_TITLE: "My Custom App", + LOGIN_BELOW: "Please log in to continue", + }), + ) + + // Write invalid JSON file + await fs.writeFile(invalidJsonFile, '{"WELCOME": "Missing closing quote}') + }) + + afterEach(async () => { + // Clean up temporary directory + await fs.rmdir(tempDir, { recursive: true }) + }) + + describe("loadCustomStrings", () => { + it("should load valid JSON file successfully", async () => { + // Should not throw an error + await expect(loadCustomStrings(validJsonFile)).resolves.toBeUndefined() + }) + + it("should throw clear error for non-existent file", async () => { + await expect(loadCustomStrings(nonExistentFile)).rejects.toThrow( + `Custom strings file not found: ${nonExistentFile}\nPlease ensure the file exists and is readable.`, + ) + }) + + it("should throw clear error for invalid JSON", async () => { + await expect(loadCustomStrings(invalidJsonFile)).rejects.toThrow( + `Invalid JSON in custom strings file: ${invalidJsonFile}`, + ) + }) + + it("should handle empty JSON object", async () => { + const emptyJsonFile = path.join(tempDir, "empty.json") + await fs.writeFile(emptyJsonFile, "{}") + + await expect(loadCustomStrings(emptyJsonFile)).resolves.toBeUndefined() + }) + + it("should handle nested JSON objects", async () => { + const nestedJsonFile = path.join(tempDir, "nested.json") + await fs.writeFile( + nestedJsonFile, + JSON.stringify({ + WELCOME: "Hello World", + NESTED: { + KEY: "Value", + }, + }), + ) + + await expect(loadCustomStrings(nestedJsonFile)).resolves.toBeUndefined() + }) + + it("should handle special characters and unicode", async () => { + const unicodeJsonFile = path.join(tempDir, "unicode.json") + await fs.writeFile( + unicodeJsonFile, + JSON.stringify({ + WELCOME: "欢迎来到 code-server", + LOGIN_TITLE: "Willkommen bei {{app}}", + SPECIAL: "Special chars: àáâãäåæçèéêë 🚀 ♠️ ∆", + }), + "utf8", + ) + + await expect(loadCustomStrings(unicodeJsonFile)).resolves.toBeUndefined() + }) + + it("should handle generic errors that are not ENOENT or SyntaxError", async () => { + const testFile = path.join(tempDir, "test.json") + await fs.writeFile(testFile, "{}") + + // Mock fs.readFile to throw a generic error + const originalReadFile = fs.readFile + const mockError = new Error("Permission denied") + fs.readFile = jest.fn().mockRejectedValue(mockError) + + await expect(loadCustomStrings(testFile)).rejects.toThrow( + `Failed to load custom strings from ${testFile}: Permission denied`, + ) + + // Restore original function + fs.readFile = originalReadFile + }) + + it("should handle errors that are not Error instances", async () => { + const testFile = path.join(tempDir, "test.json") + await fs.writeFile(testFile, "{}") + + // Mock fs.readFile to throw a non-Error object + const originalReadFile = fs.readFile + fs.readFile = jest.fn().mockRejectedValue("String error") + + await expect(loadCustomStrings(testFile)).rejects.toThrow( + `Failed to load custom strings from ${testFile}: String error`, + ) + + // Restore original function + fs.readFile = originalReadFile + }) + + it("should handle null/undefined errors", async () => { + const testFile = path.join(tempDir, "test.json") + await fs.writeFile(testFile, "{}") + + // Mock fs.readFile to throw null + const originalReadFile = fs.readFile + fs.readFile = jest.fn().mockRejectedValue(null) + + await expect(loadCustomStrings(testFile)).rejects.toThrow(`Failed to load custom strings from ${testFile}: null`) + + // Restore original function + fs.readFile = originalReadFile + }) + + it("should complete without errors for valid input", async () => { + const testFile = path.join(tempDir, "resource-test.json") + const customStrings = { + WELCOME: "Custom Welcome Message", + LOGIN_TITLE: "Custom Login Title", + } + await fs.writeFile(testFile, JSON.stringify(customStrings)) + + // Should not throw any errors + await expect(loadCustomStrings(testFile)).resolves.toBeUndefined() + }) + }) +}) diff --git a/test/unit/node/main.test.ts b/test/unit/node/main.test.ts new file mode 100644 index 000000000000..39ba2ca8bf9b --- /dev/null +++ b/test/unit/node/main.test.ts @@ -0,0 +1,176 @@ +import { promises as fs } from "fs" +import * as path from "path" +import { setDefaults, parse } from "../../../src/node/cli" +import { loadCustomStrings } from "../../../src/node/i18n" +import { tmpdir } from "../../utils/helpers" + +// Mock the i18n module +jest.mock("../../../src/node/i18n", () => ({ + loadCustomStrings: jest.fn(), +})) + +// Mock logger to avoid console output during tests +jest.mock("@coder/logger", () => ({ + logger: { + info: jest.fn(), + debug: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + named: jest.fn(), + level: 0, + }, + field: jest.fn(), + Level: { + Trace: 0, + Debug: 1, + Info: 2, + Warn: 3, + Error: 4, + }, +})) + +const mockedLoadCustomStrings = loadCustomStrings as jest.MockedFunction + +describe("main", () => { + let tempDir: string + let mockServer: any + + beforeEach(async () => { + tempDir = await tmpdir("code-server-main-test") + + // Reset mocks + jest.clearAllMocks() + + // Mock the server creation to avoid actually starting a server + mockServer = { + server: { + listen: jest.fn(), + address: jest.fn(() => ({ address: "127.0.0.1", port: 8080 })), + close: jest.fn(), + }, + editorSessionManagerServer: { + address: jest.fn(() => null), + }, + dispose: jest.fn(), + } + }) + + afterEach(async () => { + // Clean up temp directory + try { + await fs.rmdir(tempDir, { recursive: true }) + } catch (error) { + // Ignore cleanup errors + } + }) + + describe("runCodeServer", () => { + it("should load custom strings when i18n flag is provided", async () => { + // Create a test custom strings file + const customStringsFile = path.join(tempDir, "custom-strings.json") + await fs.writeFile( + customStringsFile, + JSON.stringify({ + WELCOME: "Custom Welcome", + LOGIN_TITLE: "My App", + }), + ) + + // Create args with i18n flag + const cliArgs = parse([ + `--config=${path.join(tempDir, "config.yaml")}`, + `--user-data-dir=${tempDir}`, + "--bind-addr=localhost:0", + "--log=warn", + "--auth=none", + `--i18n=${customStringsFile}`, + ]) + const args = await setDefaults(cliArgs) + + // Mock the app module + jest.doMock("../../../src/node/app", () => ({ + createApp: jest.fn().mockResolvedValue(mockServer), + ensureAddress: jest.fn().mockReturnValue(new URL("http://localhost:8080")), + })) + + // Mock routes module + jest.doMock("../../../src/node/routes", () => ({ + register: jest.fn().mockResolvedValue({ disposeRoutes: jest.fn() }), + })) + + // Mock loadCustomStrings to succeed + mockedLoadCustomStrings.mockResolvedValue(undefined) + + // Import runCodeServer after mocking + const mainModule = await import("../../../src/node/main") + const result = await mainModule.runCodeServer(args) + + // Verify that loadCustomStrings was called with the correct file path + expect(mockedLoadCustomStrings).toHaveBeenCalledWith(customStringsFile) + expect(mockedLoadCustomStrings).toHaveBeenCalledTimes(1) + + // Clean up + await result.dispose() + }) + + it("should not load custom strings when i18n flag is not provided", async () => { + // Create args without i18n flag + const cliArgs = parse([ + `--config=${path.join(tempDir, "config.yaml")}`, + `--user-data-dir=${tempDir}`, + "--bind-addr=localhost:0", + "--log=warn", + "--auth=none", + ]) + const args = await setDefaults(cliArgs) + + // Mock the app module + jest.doMock("../../../src/node/app", () => ({ + createApp: jest.fn().mockResolvedValue(mockServer), + ensureAddress: jest.fn().mockReturnValue(new URL("http://localhost:8080")), + })) + + // Mock routes module + jest.doMock("../../../src/node/routes", () => ({ + register: jest.fn().mockResolvedValue({ disposeRoutes: jest.fn() }), + })) + + // Import runCodeServer after mocking + const mainModule = await import("../../../src/node/main") + const result = await mainModule.runCodeServer(args) + + // Verify that loadCustomStrings was NOT called + expect(mockedLoadCustomStrings).not.toHaveBeenCalled() + + // Clean up + await result.dispose() + }) + + it("should handle errors when loadCustomStrings fails", async () => { + // Create args with i18n flag pointing to non-existent file + const nonExistentFile = path.join(tempDir, "does-not-exist.json") + const cliArgs = parse([ + `--config=${path.join(tempDir, "config.yaml")}`, + `--user-data-dir=${tempDir}`, + "--bind-addr=localhost:0", + "--log=warn", + "--auth=none", + `--i18n=${nonExistentFile}`, + ]) + const args = await setDefaults(cliArgs) + + // Mock loadCustomStrings to throw an error + const mockError = new Error("Custom strings file not found") + mockedLoadCustomStrings.mockRejectedValue(mockError) + + // Import runCodeServer after mocking + const mainModule = await import("../../../src/node/main") + + // Verify that runCodeServer throws the error from loadCustomStrings + await expect(mainModule.runCodeServer(args)).rejects.toThrow("Custom strings file not found") + + // Verify that loadCustomStrings was called + expect(mockedLoadCustomStrings).toHaveBeenCalledWith(nonExistentFile) + }) + }) +}) diff --git a/test/unit/node/proxy.test.ts b/test/unit/node/proxy.test.ts new file mode 100644 index 000000000000..4c3320a07b93 --- /dev/null +++ b/test/unit/node/proxy.test.ts @@ -0,0 +1,341 @@ +import * as express from "express" +import { HttpCode } from "../../../src/common/http" +import { wss, Router as WsRouter } from "../../../src/node/wsRouter" +import { mockLogger } from "../../utils/helpers" +import * as httpserver from "../../utils/httpserver" +import * as integration from "../../utils/integration" + +describe("proxy", () => { + const proxyTarget = new httpserver.HttpServer() + const wsApp = express.default() + const wsRouter = WsRouter() + let codeServer: httpserver.HttpServer | undefined + let proxyPath: string + let absProxyPath: string + let e: express.Express + + beforeAll(async () => { + wsApp.use("/", wsRouter.router) + await proxyTarget.listen((req, res) => { + e(req, res) + }) + proxyTarget.listenUpgrade(wsApp) + proxyPath = `/proxy/${proxyTarget.port()}/wsup` + absProxyPath = proxyPath.replace("/proxy/", "/absproxy/") + }) + + afterAll(async () => { + await proxyTarget.dispose() + }) + + beforeEach(() => { + e = express.default() + mockLogger() + delete process.env.PASSWORD + }) + + afterEach(async () => { + if (codeServer) { + await codeServer.dispose() + codeServer = undefined + } + jest.clearAllMocks() + }) + + it("should return 403 Forbidden if proxy is disabled", async () => { + e.get("/wsup", (req, res) => { + res.json("you cannot see this") + }) + codeServer = await integration.setup(["--auth=none", "--disable-proxy"], "") + const resp = await codeServer.fetch(proxyPath) + expect(resp.status).toBe(403) + const json = await resp.json() + expect(json).toEqual({ error: "Forbidden" }) + }) + + it("should rewrite the base path", async () => { + e.get("/wsup", (req, res) => { + res.json("asher is the best") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath) + expect(resp.status).toBe(200) + const json = await resp.json() + expect(json).toBe("asher is the best") + }) + + it("should not rewrite the base path", async () => { + e.get(absProxyPath, (req, res) => { + res.json("joe is the best") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(absProxyPath) + expect(resp.status).toBe(200) + const json = await resp.json() + expect(json).toBe("joe is the best") + }) + + it("should rewrite redirects", async () => { + e.post("/wsup", (req, res) => { + res.redirect(307, "/finale") + }) + e.post("/finale", (req, res) => { + res.json("redirect success") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath, { + method: "POST", + }) + expect(resp.status).toBe(200) + expect(await resp.json()).toBe("redirect success") + }) + + it("should not rewrite redirects", async () => { + const finalePath = absProxyPath.replace("/wsup", "/finale") + e.post(absProxyPath, (req, res) => { + res.redirect(307, finalePath) + }) + e.post(finalePath, (req, res) => { + res.json("redirect success") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(absProxyPath, { + method: "POST", + }) + expect(resp.status).toBe(200) + expect(await resp.json()).toBe("redirect success") + }) + + it("should allow post bodies", async () => { + e.use(express.json({ strict: false })) + e.post("/wsup", (req, res) => { + res.json(req.body) + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath, { + method: "post", + body: JSON.stringify("coder is the best"), + headers: { + "Content-Type": "application/json", + }, + }) + expect(resp.status).toBe(200) + expect(await resp.json()).toBe("coder is the best") + }) + + it("should handle bad requests", async () => { + e.use(express.json({ strict: false })) + e.post("/wsup", (req, res) => { + res.json(req.body) + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath, { + method: "post", + body: "coder is the best", + headers: { + "Content-Type": "application/json", + }, + }) + expect(resp.status).toBe(400) + expect(resp.statusText).toMatch("Bad Request") + }) + + it("should handle invalid routes", async () => { + e.post("/wsup", (req, res) => { + res.json(req.body) + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(`${proxyPath}/hello`) + expect(resp.status).toBe(404) + expect(resp.statusText).toMatch("Not Found") + }) + + it("should handle errors", async () => { + e.use(express.json({ strict: false })) + e.post("/wsup", (req, res) => { + throw new Error("BROKEN") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath, { + method: "post", + body: JSON.stringify("coder is the best"), + headers: { + "Content-Type": "application/json", + }, + }) + expect(resp.status).toBe(500) + expect(resp.statusText).toMatch("Internal Server Error") + }) + + it("should pass origin check", async () => { + wsRouter.ws("/wsup", async (req) => { + wss.handleUpgrade(req, req.ws, req.head, (ws) => { + ws.send("hello") + req.ws.resume() + }) + }) + codeServer = await integration.setup(["--auth=none"], "") + const ws = await codeServer.wsWait(proxyPath, { + headers: { + host: "localhost:8080", + origin: "https://localhost:8080", + }, + }) + ws.terminate() + }) + + it("should fail origin check", async () => { + await expect(async () => { + codeServer = await integration.setup(["--auth=none"], "") + await codeServer.wsWait(proxyPath, { + headers: { + host: "localhost:8080", + origin: "https://evil.org", + }, + }) + }).rejects.toThrow() + }) + + it("should proxy non-ASCII", async () => { + e.get(/.*/, (req, res) => { + res.json("ほげ") + }) + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(proxyPath.replace("wsup", "ほげ")) + expect(resp.status).toBe(200) + const json = await resp.json() + expect(json).toBe("ほげ") + }) + + it("should not double-encode query variables", async () => { + const spy = jest.fn() + e.get(/.*/, (req, res) => { + spy([req.originalUrl, req.query]) + res.end() + }) + codeServer = await integration.setup(["--auth=none"], "") + for (const test of [ + { + endpoint: proxyPath, + query: { foo: "bar with spaces" }, + expected: "/wsup?foo=bar+with+spaces", + }, + { + endpoint: absProxyPath, + query: { foo: "bar with spaces" }, + expected: absProxyPath + "?foo=bar+with+spaces", + }, + { + endpoint: proxyPath, + query: { foo: "with-&-ampersand" }, + expected: "/wsup?foo=with-%26-ampersand", + }, + { + endpoint: absProxyPath, + query: { foo: "with-&-ampersand" }, + expected: absProxyPath + "?foo=with-%26-ampersand", + }, + { + endpoint: absProxyPath, + query: { foo: "ほげ ほげ" }, + expected: absProxyPath + "?foo=%E3%81%BB%E3%81%92+%E3%81%BB%E3%81%92", + }, + { + endpoint: proxyPath, + query: { foo: "ほげ ほげ" }, + expected: "/wsup?foo=%E3%81%BB%E3%81%92+%E3%81%BB%E3%81%92", + }, + ]) { + spy.mockClear() + const resp = await codeServer.fetch(test.endpoint, undefined, test.query) + expect(resp.status).toBe(200) + await resp.text() + expect(spy).toHaveBeenCalledTimes(1) + expect(spy).toHaveBeenCalledWith([test.expected, test.query]) + } + }) + + it("should allow specifying an absproxy path", async () => { + const prefixedPath = `/codeserver/app1${absProxyPath}` + e.get(prefixedPath, (req, res) => { + res.send("app being served behind a prefixed path") + }) + codeServer = await integration.setup(["--auth=none", "--abs-proxy-base-path=/codeserver/app1"], "") + const resp = await codeServer.fetch(absProxyPath) + expect(resp.status).toBe(200) + const text = await resp.text() + expect(text).toBe("app being served behind a prefixed path") + }) + + it("should not allow OPTIONS without authentication by default", async () => { + process.env.PASSWORD = "test" + codeServer = await integration.setup(["--auth=password"]) + const resp = await codeServer.fetch(proxyPath, { method: "OPTIONS" }) + expect(resp.status).toBe(401) + }) + + it("should allow OPTIONS with `skip-auth-preflight` flag", async () => { + process.env.PASSWORD = "test" + codeServer = await integration.setup(["--auth=password", "--skip-auth-preflight"]) + e.post("/wsup", (req, res) => {}) + const resp = await codeServer.fetch(proxyPath, { method: "OPTIONS" }) + expect(resp.status).toBe(200) + }) + + it("should return a 500 when no target is running ", async () => { + const target = new httpserver.HttpServer() + await target.listen(() => {}) + const port = target.port() + target.dispose() + codeServer = await integration.setup(["--auth=none"], "") + const resp = await codeServer.fetch(`/proxy/${port}/wsup`) + expect(resp.status).toBe(HttpCode.ServerError) + expect(resp.statusText).toBe("Internal Server Error") + }) + + it("should strip token cookie", async () => { + const token = "my-super-secure-token" + process.env.HASHED_PASSWORD = token + codeServer = await integration.setup(["--auth=password"]) + + e.get("/wsup/cookies", (req, res) => { + res.writeHead(HttpCode.Ok, { "Content-Type": "text/plain" }) + res.end(req.headers.cookie) + }) + + const cookies = [ + "cookie2=hello", + // Cookies should pass through unchanged, neither encoded nor decoded. + `cookie1=${encodeURIComponent("hello=there")}`, + "cookie3=foo|bar", + `cookie4=${encodeURIComponent("foo|bar")}`, + `cookie5=${encodeURIComponent("bar;baz")}`, + ] + + // Test each slot to ensure the token is found anywhere. + for (let i = 0; i <= cookies.length; ++i) { + const left = cookies.slice(0, i) + const right = cookies.slice(i) + const resp = await codeServer.fetch(proxyPath + "/cookies", { + headers: { + cookie: [...left, `code-server-session=${token}`, ...right].join("; "), + }, + }) + expect(resp.status).toBe(200) + expect(await resp.text()).toBe(cookies.join("; ")) + } + }) + + it("should proxy when no cookies", async () => { + codeServer = await integration.setup(["--auth=none"]) + + e.get("/wsup/cookies", (req, res) => { + res.writeHead(HttpCode.Ok, { "Content-Type": "text/plain" }) + res.end(req.headers.cookie || "no cookies") + }) + + const resp = await codeServer.fetch(proxyPath + "/cookies") + expect(resp.status).toBe(200) + expect(await resp.text()).toBe("no cookies") + }) +}) diff --git a/test/unit/node/routes/errors.test.ts b/test/unit/node/routes/errors.test.ts new file mode 100644 index 000000000000..94657abf9f92 --- /dev/null +++ b/test/unit/node/routes/errors.test.ts @@ -0,0 +1,69 @@ +import express from "express" +import { UserProvidedArgs, setDefaults } from "../../../../src/node/cli" +import { errorHandler } from "../../../../src/node/routes/errors" + +describe("error page is rendered for text/html requests", () => { + it("escapes any html in the error messages", async () => { + const next = jest.fn() + const err = { + code: "ENOENT", + statusCode: 404, + message: ";>hello", + } + const req = await createRequest() + const res = { + status: jest.fn().mockReturnValue(this), + send: jest.fn().mockReturnValue(this), + set: jest.fn().mockReturnValue(this), + } as unknown as express.Response + + await errorHandler(err, req, res, next) + expect(res.status).toHaveBeenCalledWith(404) + expect(res.send).toHaveBeenCalledWith(expect.not.stringContaining("