Repository: coder/code-server Branch: main Commit: d7599ae36090 Files: 232 Total size: 813.5 KB Directory structure: gitextract_zegt8ql3/ ├── .dockerignore ├── .editorconfig ├── .git-blame-ignore-revs ├── .gitattributes ├── .github/ │ ├── CODEOWNERS │ ├── ISSUE_TEMPLATE/ │ │ ├── bug-report.yml │ │ ├── config.yml │ │ ├── doc.md │ │ └── feature-request.md │ ├── PULL_REQUEST_TEMPLATE.md │ ├── codecov.yml │ ├── codeql-config.yml │ ├── dependabot.yaml │ ├── semantic.yaml │ ├── stale.yml │ └── workflows/ │ ├── build.yaml │ ├── installer.yaml │ ├── publish.yaml │ ├── release.yaml │ ├── scripts.yaml │ ├── security.yaml │ └── trivy-docker.yaml ├── .gitignore ├── .gitmodules ├── .node-version ├── .prettierignore ├── .prettierrc.yaml ├── .tours/ │ ├── contributing.tour │ └── start-development.tour ├── CHANGELOG.md ├── LICENSE ├── ThirdPartyNotices.txt ├── ci/ │ ├── Caddyfile │ ├── README.md │ ├── build/ │ │ ├── build-code-server.sh │ │ ├── build-lib.sh │ │ ├── build-packages.sh │ │ ├── build-release.sh │ │ ├── build-standalone-release.sh │ │ ├── build-vscode.sh │ │ ├── clean.sh │ │ ├── code-server-nfpm.sh │ │ ├── code-server-user.service │ │ ├── code-server.sh │ │ ├── code-server@.service │ │ ├── nfpm.yaml │ │ └── npm-postinstall.sh │ ├── dev/ │ │ ├── doctoc.sh │ │ ├── gen_icons.sh │ │ ├── lint-scripts.sh │ │ ├── postinstall.sh │ │ ├── preinstall.js │ │ ├── test-e2e.sh │ │ ├── test-integration.sh │ │ ├── test-native.sh │ │ ├── test-scripts.sh │ │ ├── test-unit.sh │ │ └── watch.ts │ ├── helm-chart/ │ │ ├── .helmignore │ │ ├── Chart.yaml │ │ ├── templates/ │ │ │ ├── NOTES.txt │ │ │ ├── _helpers.tpl │ │ │ ├── deployment.yaml │ │ │ ├── ingress.yaml │ │ │ ├── pvc.yaml │ │ │ ├── secrets.yaml │ │ │ ├── service.yaml │ │ │ ├── serviceaccount.yaml │ │ │ └── tests/ │ │ │ └── test-connection.yaml │ │ └── values.yaml │ ├── lib.sh │ ├── release-image/ │ │ ├── Dockerfile │ │ ├── Dockerfile.fedora │ │ ├── Dockerfile.opensuse │ │ ├── docker-bake.hcl │ │ ├── entrypoint-catatonit.sh │ │ └── entrypoint.sh │ └── steps/ │ ├── brew-bump.sh │ ├── docker-buildx-push.sh │ ├── publish-npm.sh │ └── steps-lib.sh ├── docs/ │ ├── CODE_OF_CONDUCT.md │ ├── CONTRIBUTING.md │ ├── FAQ.md │ ├── MAINTAINING.md │ ├── README.md │ ├── SECURITY.md │ ├── android.md │ ├── coder.md │ ├── collaboration.md │ ├── guide.md │ ├── helm.md │ ├── install.md │ ├── ios.md │ ├── ipad.md │ ├── manifest.json │ ├── npm.md │ ├── requirements.md │ ├── termux.md │ ├── triage.md │ └── upgrade.md ├── eslint.config.mjs ├── flake.nix ├── install.sh ├── package.json ├── patches/ │ ├── base-path.diff │ ├── cli-window-open.diff │ ├── clipboard.diff │ ├── disable-builtin-ext-update.diff │ ├── display-language.diff │ ├── external-file-actions.diff │ ├── fix-build.diff │ ├── getting-started.diff │ ├── insecure-notification.diff │ ├── integration.diff │ ├── keepalive.diff │ ├── local-storage.diff │ ├── logout.diff │ ├── marketplace.diff │ ├── proposed-api.diff │ ├── proxy-uri.diff │ ├── series │ ├── service-worker.diff │ ├── signature-verification.diff │ ├── sourcemaps.diff │ ├── store-socket.diff │ ├── telemetry.diff │ ├── trusted-domains.diff │ ├── unique-db.diff │ ├── update-check.diff │ └── webview.diff ├── renovate.json ├── src/ │ ├── browser/ │ │ ├── pages/ │ │ │ ├── error.css │ │ │ ├── error.html │ │ │ ├── global.css │ │ │ ├── login.css │ │ │ └── login.html │ │ ├── robots.txt │ │ ├── security.txt │ │ └── serviceWorker.ts │ ├── common/ │ │ ├── emitter.ts │ │ ├── http.ts │ │ └── util.ts │ └── node/ │ ├── app.ts │ ├── cli.ts │ ├── constants.ts │ ├── entry.ts │ ├── heart.ts │ ├── http.ts │ ├── i18n/ │ │ ├── index.ts │ │ └── locales/ │ │ ├── en.json │ │ ├── ja.json │ │ ├── th.json │ │ ├── ur.json │ │ └── zh-cn.json │ ├── main.ts │ ├── proxy.ts │ ├── routes/ │ │ ├── domainProxy.ts │ │ ├── errors.ts │ │ ├── health.ts │ │ ├── index.ts │ │ ├── login.ts │ │ ├── logout.ts │ │ ├── pathProxy.ts │ │ ├── update.ts │ │ └── vscode.ts │ ├── settings.ts │ ├── socket.ts │ ├── update.ts │ ├── util.ts │ ├── vscodeSocket.ts │ ├── wrapper.ts │ └── wsRouter.ts ├── test/ │ ├── e2e/ │ │ ├── baseFixture.ts │ │ ├── codeServer.test.ts │ │ ├── downloads.test.ts │ │ ├── extensions/ │ │ │ └── test-extension/ │ │ │ ├── .gitignore │ │ │ ├── extension.ts │ │ │ ├── package.json │ │ │ └── tsconfig.json │ │ ├── extensions.test.ts │ │ ├── github.test.ts │ │ ├── login.test.ts │ │ ├── logout.test.ts │ │ ├── models/ │ │ │ └── CodeServer.ts │ │ ├── openHelpAbout.test.ts │ │ ├── routes.test.ts │ │ ├── terminal.test.ts │ │ ├── uploads.test.ts │ │ └── webview.test.ts │ ├── integration/ │ │ ├── help.test.ts │ │ └── installExtension.test.ts │ ├── package.json │ ├── playwright.config.ts │ ├── scripts/ │ │ ├── build-lib.bats │ │ ├── install.bats │ │ └── steps-lib.bats │ ├── tsconfig.json │ ├── unit/ │ │ ├── common/ │ │ │ ├── emitter.test.ts │ │ │ ├── http.test.ts │ │ │ └── util.test.ts │ │ ├── helpers.test.ts │ │ └── node/ │ │ ├── app.test.ts │ │ ├── cli.test.ts │ │ ├── constants.test.ts │ │ ├── heart.test.ts │ │ ├── http.test.ts │ │ ├── i18n.test.ts │ │ ├── main.test.ts │ │ ├── proxy.test.ts │ │ ├── routes/ │ │ │ ├── errors.test.ts │ │ │ ├── health.test.ts │ │ │ ├── login.test.ts │ │ │ ├── static.test.ts │ │ │ └── vscode.test.ts │ │ ├── settings.test.ts │ │ ├── socket.test.ts │ │ ├── update.test.ts │ │ ├── util.test.ts │ │ ├── vscodeSocket.test.ts │ │ └── wrapper.test.ts │ └── utils/ │ ├── constants.ts │ ├── cssStub.ts │ ├── globalE2eSetup.ts │ ├── globalUnitSetup.ts │ ├── helpers.ts │ ├── httpserver.ts │ ├── integration.ts │ ├── runCodeServerCommand.ts │ └── wtfnode.ts ├── tsconfig.json └── typings/ └── httpolyglot/ └── index.d.ts ================================================ FILE CONTENTS ================================================ ================================================ FILE: .dockerignore ================================================ ** !release-packages !ci ================================================ FILE: .editorconfig ================================================ root = true [*] indent_style = space trim_trailing_whitespace = true indent_size = 2 ================================================ FILE: .git-blame-ignore-revs ================================================ # Prettier 3.4.2 9b0340a09276f93c054d705d1b9a5f24cc5dbc97 ================================================ FILE: .gitattributes ================================================ *.afdesign filter=lfs diff=lfs merge=lfs -text ================================================ FILE: .github/CODEOWNERS ================================================ * @coder/code-server ci/helm-chart/ @Matthew-Beckett @alexgorbatchev docs/install.md @GNUxeava src/node/i18n/locales/zh-cn.json @zhaozhiming ================================================ FILE: .github/ISSUE_TEMPLATE/bug-report.yml ================================================ 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 ================================================ FILE: .github/ISSUE_TEMPLATE/config.yml ================================================ 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 ================================================ FILE: .github/ISSUE_TEMPLATE/doc.md ================================================ --- 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? ================================================ FILE: .github/ISSUE_TEMPLATE/feature-request.md ================================================ --- 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? ================================================ FILE: .github/PULL_REQUEST_TEMPLATE.md ================================================ Fixes # ================================================ FILE: .github/codecov.yml ================================================ 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 ================================================ FILE: .github/codeql-config.yml ================================================ name: "code-server CodeQL config" ================================================ FILE: .github/dependabot.yaml ================================================ version: 2 updates: - package-ecosystem: "github-actions" directory: "/" schedule: interval: "monthly" time: "06:00" timezone: "America/Chicago" labels: [] commit-message: prefix: "chore" - package-ecosystem: "npm" directory: "/" schedule: interval: "monthly" time: "06:00" timezone: "America/Chicago" commit-message: prefix: "chore" 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 ================================================ FILE: .github/semantic.yaml ================================================ ############################################################################### # This file configures "Semantic Pull Requests", which is documented here: # https://github.com/zeke/semantic-pull-requests ############################################################################### # Scopes are optionally supplied after a 'type'. For example, in # # feat(docs): autostart ui # # '(docs)' is the scope. Scopes are used to signify where the change occurred. scopes: # docs: changes to the code-server documentation. - docs # vendor: changes to vendored dependencies. - vendor # deps: changes to code-server's dependencies. - deps # cs: changes to code specific to code-server. - cs # cli: changes to the command-line interface. - cli # We only check that the PR title is semantic. The PR title is automatically # applied to the "Squash & Merge" flow as the suggested commit message, so this # should suffice unless someone drastically alters the message in that flow. titleOnly: true # Types are the 'tag' types in a commit or PR title. For example, in # # chore: fix thing # # 'chore' is the type. types: # A build of any kind. - build # A user-facing change that corrects a defect in code-server. - fix # Any code task that is ignored for changelog purposes. Examples include # devbin scripts and internal-only configurations. - chore # Any work performed on CI. - ci # Work that directly implements or supports the implementation of a feature. - feat # A refactor changes code structure without any behavioral change. - refactor # A git revert for any style of commit. - revert # Adding tests of any kind. Should be separate from feature or fix # implementations. For example, if a commit adds a fix + test, it's a fix # commit. If a commit is simply bumping coverage, it's a test commit. - test # A new release. - release ================================================ FILE: .github/stale.yml ================================================ # 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 ================================================ FILE: .github/workflows/build.yaml ================================================ 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' }} # Note: if: success() is used in several jobs - # this ensures that it only executes if all previous jobs succeeded. # if: steps.cache-node-modules.outputs.cache-hit != 'true' # will skip running `npm install` if it successfully fetched from cache jobs: changes: runs-on: ubuntu-latest outputs: ci: ${{ steps.filter.outputs.ci }} code: ${{ steps.filter.outputs.code }} deps: ${{ steps.filter.outputs.deps }} docs: ${{ steps.filter.outputs.docs }} helm: ${{ steps.filter.outputs.helm }} steps: - name: Checkout repo uses: actions/checkout@v6 - name: Check changed files uses: dorny/paths-filter@v3 id: filter with: filters: | ci: - ".github/**" - "ci/**" docs: - "docs/**" - "README.md" - "CHANGELOG.md" helm: - "ci/helm-chart/**" code: - "src/**" - "test/**" deps: - "lib/**" - "patches/**" - "package-lock.json" - "test/package-lock.json" - id: debug run: | echo "${{ toJSON(steps.filter )}}" prettier: name: Run prettier check runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v6 - uses: actions/setup-node@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@v6 - uses: actions/setup-node@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@v6 - uses: azure/setup-helm@v4 with: token: ${{ secrets.GITHUB_TOKEN }} - run: helm plugin install https://github.com/instrumenta/helm-kubeval - run: helm kubeval ci/helm-chart lint-ts: name: Lint TypeScript files runs-on: ubuntu-22.04 needs: changes if: needs.changes.outputs.code == 'true' steps: - uses: actions/checkout@v6 - uses: actions/setup-node@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@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' steps: - uses: actions/checkout@v6 - uses: actions/setup-node@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@v5 if: success() with: token: ${{ secrets.CODECOV_TOKEN }} build: name: Build code-server runs-on: ubuntu-22.04 env: CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} DISABLE_V8_COMPILE_CACHE: 1 steps: - uses: actions/checkout@v6 with: submodules: true - run: sudo apt update && sudo apt install -y libkrb5-dev - uses: awalsh128/cache-apt-pkgs-action@latest with: packages: quilt version: 1.0 - run: quilt push -a - uses: actions/setup-node@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 build env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # 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 Code package from cache id: cache-vscode uses: actions/cache@v4 with: path: lib/vscode-reh-web-* key: vscode-reh-package-${{ secrets.VSCODE_CACHE_VERSION }}-${{ steps.vscode-rev.outputs.rev }}-${{ hashFiles('patches/*.diff', 'ci/build/build-vscode.sh') }} - name: Build vscode env: VERSION: "0.0.0" if: steps.cache-vscode.outputs.cache-hit != 'true' run: | pushd lib/vscode npm ci popd npm run build:vscode # The release package does not contain any native modules # and is neutral to architecture/os/libc version. - run: npm run release if: success() # https://github.com/actions/upload-artifact/issues/38 - run: tar -czf package.tar.gz release - uses: actions/upload-artifact@v7 with: name: npm-package path: ./package.tar.gz test-e2e: name: Run e2e tests runs-on: ubuntu-22.04 needs: [changes, build] if: needs.changes.outputs.code == 'true' || needs.changes.outputs.deps == 'true' steps: - uses: actions/checkout@v6 - run: sudo apt update && sudo apt install -y libkrb5-dev - uses: actions/setup-node@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 - uses: actions/download-artifact@v8 with: name: npm-package - run: tar -xzf package.tar.gz - run: cd release && npm install --unsafe-perm --omit=dev - name: Install Playwright OS dependencies run: | ./test/node_modules/.bin/playwright install-deps ./test/node_modules/.bin/playwright install - run: CODE_SERVER_TEST_ENTRY=./release npm run test:e2e - uses: actions/upload-artifact@v7 if: always() with: name: failed-test-videos path: ./test/test-results - run: rm -rf ./release ./test/test-results test-e2e-proxy: name: Run e2e tests behind proxy runs-on: ubuntu-22.04 needs: [changes, build] if: needs.changes.outputs.code == 'true' || needs.changes.outputs.deps == 'true' steps: - uses: actions/checkout@v6 - run: sudo apt update && sudo apt install -y libkrb5-dev - uses: actions/setup-node@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 - uses: actions/download-artifact@v8 with: name: npm-package - run: tar -xzf package.tar.gz - run: cd release && npm install --unsafe-perm --omit=dev - name: Install Playwright OS dependencies run: | ./test/node_modules/.bin/playwright install-deps ./test/node_modules/.bin/playwright install - name: Cache Caddy uses: actions/cache@v4 id: caddy-cache with: path: | ~/.cache/caddy key: cache-caddy-2.5.2 - name: Install Caddy env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} 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 - 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@v7 if: always() with: name: failed-test-videos-proxy path: ./test/test-results ================================================ FILE: .github/workflows/installer.yaml ================================================ 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@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@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@v6 - name: Install code-server run: ./install.sh - name: Test code-server was installed globally run: code-server --help ================================================ FILE: .github/workflows/publish.yaml ================================================ 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: description: The version to publish (include "v", i.e. "v4.9.1"). 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 steps: - name: Checkout code-server uses: actions/checkout@v6 - name: Install Node.js uses: actions/setup-node@v6 with: node-version-file: .node-version - name: Download npm package from release artifacts uses: robinraju/release-downloader@v1.12 with: repository: "coder/code-server" tag: ${{ github.event.inputs.version || github.ref_name }} fileName: "package.tar.gz" out-file-path: "release-npm-package" # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ github.event.inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - run: npm run publish:npm env: VERSION: ${{ env.VERSION }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_ENVIRONMENT: "production" aur: runs-on: ubuntu-latest timeout-minutes: 10 env: GH_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} steps: # We need to checkout code-server so we can get the version - name: Checkout code-server uses: actions/checkout@v6 with: fetch-depth: 0 path: "./code-server" - name: Checkout code-server-aur repo uses: actions/checkout@v6 with: repository: "cdrci/code-server-aur" token: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} ref: "master" - name: Merge in master run: | git remote add upstream https://github.com/coder/code-server-aur.git git fetch upstream git merge upstream/master - name: Configure git run: | git config --global user.name cdrci git config --global user.email opensource@coder.com # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ github.event.inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - name: Validate package uses: heyhusen/archlinux-package-action@v3.0.0 env: VERSION: ${{ env.VERSION }} with: pkgver: ${{ env.VERSION }} updpkgsums: true srcinfo: true - name: Open PR # We need to git push -u otherwise gh will prompt # asking where to push the branch. env: VERSION: ${{ env.VERSION }} run: | git checkout -b update-version-${{ env.VERSION }} git add . git commit -m "chore: updating version to ${{ env.VERSION }}" git push -u origin $(git branch --show) gh pr create --repo coder/code-server-aur --title "chore: bump version to ${{ env.VERSION }}" --body "PR opened by @$GITHUB_ACTOR" --assignee $GITHUB_ACTOR docker: runs-on: ubuntu-latest steps: - name: Checkout code-server uses: actions/checkout@v6 - name: Set up QEMU uses: docker/setup-qemu-action@v3 - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - name: Login to Docker Hub uses: docker/login-action@v3 with: username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} - name: Login to GHCR uses: docker/login-action@v3 with: registry: ghcr.io username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ github.event.inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - name: Download deb artifacts uses: robinraju/release-downloader@v1.12 with: repository: "coder/code-server" tag: v${{ env.VERSION }} fileName: "*.deb" out-file-path: "release-packages" - name: Download rpm artifacts uses: robinraju/release-downloader@v1.12 with: repository: "coder/code-server" tag: v${{ env.VERSION }} fileName: "*.rpm" out-file-path: "release-packages" - name: Publish to Docker run: ./ci/steps/docker-buildx-push.sh env: VERSION: ${{ env.VERSION }} GITHUB_TOKEN: ${{ github.token }} ================================================ FILE: .github/workflows/release.yaml ================================================ name: Draft release on: workflow_dispatch: inputs: version: description: The version to publish (include "v", i.e. "v4.9.1"). type: string required: true 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-cross: name: ${{ matrix.prefix }} runs-on: ubuntu-latest timeout-minutes: 15 needs: npm-version container: "python:3.8-slim-buster" strategy: matrix: include: - prefix: x86_64-linux-gnu npm_arch: x64 apt_arch: amd64 package_arch: amd64 - prefix: aarch64-linux-gnu npm_arch: arm64 apt_arch: arm64 package_arch: arm64 - prefix: arm-linux-gnueabihf npm_arch: armv7l apt_arch: armhf package_arch: armv7l env: AR: ${{ format('{0}-ar', matrix.prefix) }} AS: ${{ format('{0}-as', matrix.prefix) }} CC: ${{ format('{0}-gcc', matrix.prefix) }} CPP: ${{ format('{0}-cpp', matrix.prefix) }} CXX: ${{ format('{0}-g++', matrix.prefix) }} FC: ${{ format('{0}-gfortran', matrix.prefix) }} LD: ${{ format('{0}-ld', matrix.prefix) }} STRIP: ${{ format('{0}-strip', matrix.prefix) }} PKG_CONFIG_PATH: ${{ format('/usr/lib/{0}/pkgconfig', matrix.prefix) }} TARGET_ARCH: ${{ matrix.apt_arch }} npm_config_arch: ${{ matrix.npm_arch }} PKG_ARCH: ${{ matrix.package_arch }} # Not building from source results in an x86_64 argon2, as if # npm_config_arch is being ignored. npm_config_build_from_source: true steps: - name: Checkout repo uses: actions/checkout@v6 - name: Install Node.js uses: actions/setup-node@v6 with: node-version-file: .node-version cache: npm cache-dependency-path: | package-lock.json test/package-lock.json - name: Install cross-compiler and system dependencies run: | sed -i 's/deb\.debian\.org/archive.debian.org/g' /etc/apt/sources.list dpkg --add-architecture $TARGET_ARCH apt update && apt install -y --no-install-recommends \ crossbuild-essential-$TARGET_ARCH \ libx11-dev:$TARGET_ARCH \ libx11-xcb-dev:$TARGET_ARCH \ libxkbfile-dev:$TARGET_ARCH \ libsecret-1-dev:$TARGET_ARCH \ libkrb5-dev:$TARGET_ARCH \ ca-certificates \ curl wget rsync gettext-base - run: SKIP_SUBMODULE_DEPS=1 npm ci - 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: Download npm package uses: actions/download-artifact@v8 with: name: npm-release-package - run: tar -xzf package.tar.gz - run: npm run release:standalone - name: Replace node with cross-compile equivalent run: | node_version=$(node --version) wget https://nodejs.org/dist/${node_version}/node-${node_version}-linux-${npm_config_arch}.tar.xz tar -xf node-${node_version}-linux-${npm_config_arch}.tar.xz node-${node_version}-linux-${npm_config_arch}/bin/node --strip-components=2 mv ./node ./release-standalone/lib/node # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - env: VERSION: ${{ env.VERSION }} run: npm run package $PKG_ARCH - uses: softprops/action-gh-release@v1 with: draft: true discussion_category_name: "📣 Announcements" files: ./release-packages/* package-macos-amd64: name: x86-64 macOS build runs-on: macos-15-intel timeout-minutes: 15 needs: npm-version env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - name: Checkout repo uses: actions/checkout@v6 - name: Install Node.js uses: actions/setup-node@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 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 # 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 - name: Download npm package uses: actions/download-artifact@v8 with: name: npm-release-package - run: tar -xzf package.tar.gz - run: npm run release:standalone - run: npm run test:native # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - name: Build packages with nfpm env: VERSION: ${{ env.VERSION }} run: npm run package - uses: softprops/action-gh-release@v1 with: draft: true discussion_category_name: "📣 Announcements" files: ./release-packages/* package-macos-arm64: name: arm64 macOS build runs-on: macos-latest timeout-minutes: 15 needs: npm-version env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - name: Checkout repo uses: actions/checkout@v6 - name: Install Node.js uses: actions/setup-node@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 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 # 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 - name: Download npm package uses: actions/download-artifact@v8 with: name: npm-release-package - run: tar -xzf package.tar.gz - run: npm run release:standalone - run: npm run test:native # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - name: Build packages with nfpm env: VERSION: ${{ env.VERSION }} run: npm run package - uses: softprops/action-gh-release@v1 with: draft: true discussion_category_name: "📣 Announcements" files: ./release-packages/* npm-package: name: Upload npm package runs-on: ubuntu-latest timeout-minutes: 15 needs: npm-version steps: - name: Download npm package uses: actions/download-artifact@v8 with: name: npm-release-package - uses: softprops/action-gh-release@v1 with: draft: true discussion_category_name: "📣 Announcements" files: ./package.tar.gz npm-version: name: Modify package.json version runs-on: ubuntu-latest timeout-minutes: 15 steps: - name: Download artifacts uses: dawidd6/action-download-artifact@v16 id: download with: branch: ${{ github.ref }} workflow: build.yaml workflow_conclusion: completed name: npm-package check_artifacts: false if_no_artifact_found: fail - run: tar -xzf package.tar.gz # Strip out the v (v4.9.1 -> 4.9.1). - name: Get and set VERSION run: | TAG="${{ inputs.version || github.ref_name }}" echo "VERSION=${TAG#v}" >> $GITHUB_ENV - name: Modify version env: VERSION: ${{ env.VERSION }} run: | echo "Updating version in root package.json" npm version --prefix release "$VERSION" echo "Updating version in lib/vscode/product.json" tmp=$(mktemp) jq ".codeServerVersion = \"$VERSION\"" release/lib/vscode/product.json > "$tmp" && mv "$tmp" release/lib/vscode/product.json # Ensure it has the same permissions as before chmod 644 release/lib/vscode/product.json - run: tar -czf package.tar.gz release - name: Upload npm package artifact uses: actions/upload-artifact@v7 with: name: npm-release-package path: ./package.tar.gz ================================================ FILE: .github/workflows/scripts.yaml ================================================ 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@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@v6 - name: Install lint utilities run: sudo apt install shellcheck - name: Lint shell files run: ./ci/dev/lint-scripts.sh ================================================ FILE: .github/workflows/security.yaml ================================================ 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@v6 with: fetch-depth: 0 - name: Install Node.js uses: actions/setup-node@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@v6 with: fetch-depth: 0 - name: Run Trivy vulnerability scanner in repo mode uses: aquasecurity/trivy-action@97e0b3872f55f89b95b2f65b3dbab56962816478 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@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@v6 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL uses: github/codeql-action/init@v4 with: config-file: ./.github/codeql-config.yml languages: javascript - name: Autobuild uses: github/codeql-action/autobuild@v4 - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v4 ================================================ FILE: .github/workflows/trivy-docker.yaml ================================================ 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: # Run at 10:15 am UTC (3:15am PT/5:15am CT) # Run at 0 minutes 0 hours of every day. - 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@v6 - name: Run Trivy vulnerability scanner in image mode uses: aquasecurity/trivy-action@97e0b3872f55f89b95b2f65b3dbab56962816478 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@v4 with: sarif_file: "trivy-image-results.sarif" ================================================ FILE: .gitignore ================================================ .tsbuildinfo .cache /out*/ release/ release-npm-package/ release-standalone/ release-packages/ release-gcp/ release-images/ node_modules /plugins /lib/coder-cloud-agent .home coverage **/.DS_Store # 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~ ================================================ FILE: .gitmodules ================================================ [submodule "lib/vscode"] path = lib/vscode url = https://github.com/microsoft/vscode ================================================ FILE: .node-version ================================================ 22.22.0 ================================================ FILE: .prettierignore ================================================ lib/vscode lib/vscode-reh-web-linux-x64 release-standalone release-packages release helm-chart test/scripts test/e2e/extensions/test-extension .pc package-lock.json ================================================ FILE: .prettierrc.yaml ================================================ printWidth: 120 semi: false trailingComma: all arrowParens: always singleQuote: false useTabs: false ================================================ FILE: .tours/contributing.tour ================================================ { "$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." } ] } ================================================ FILE: .tours/start-development.tour ================================================ { "$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)" } ] } ================================================ FILE: CHANGELOG.md ================================================ # 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.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). ================================================ FILE: LICENSE ================================================ The MIT License Copyright (c) 2019 Coder Technologies Inc. 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. ================================================ FILE: ThirdPartyNotices.txt ================================================ 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. ================================================ FILE: ci/Caddyfile ================================================ { 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 } } ================================================ FILE: ci/README.md ================================================ # ci This directory contains scripts used for code-server's continuous integration infrastructure. Some of these scripts contain more detailed documentation and options in header comments. Any file or directory in this subdirectory should be documented here. - [./ci/lib.sh](./lib.sh) - Contains code duplicated across these scripts. ## dev This directory contains scripts used for the development of code-server. - [./ci/dev/image](./dev/image) - See [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md) for docs on the development container. - [./ci/dev/fmt.sh](./dev/fmt.sh) (`npm run fmt`) - Runs formatters. - [./ci/dev/lint.sh](./dev/lint.sh) (`npm run lint`) - Runs linters. - [./ci/dev/test-unit.sh](./dev/test-unit.sh) (`npm run test:unit`) - Runs unit tests. - [./ci/dev/test-e2e.sh](./dev/test-e2e.sh) (`npm run test:e2e`) - Runs end-to-end tests. - [./ci/dev/watch.ts](./dev/watch.ts) (`npm run watch`) - Starts a process to build and launch code-server and restart on any code changes. - Example usage in [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md). - [./ci/dev/gen_icons.sh](./dev/gen_icons.sh) (`npm run icons`) - Generates the various icons from a single `.svg` favicon in `src/browser/media/favicon.svg`. - Requires [imagemagick](https://imagemagick.org/index.php) ## build This directory contains the scripts used to build and release code-server. You can disable minification by setting `MINIFY=`. - [./ci/build/build-code-server.sh](./build/build-code-server.sh) (`npm run build`) - Builds code-server into `./out` and bundles the frontend into `./dist`. - [./ci/build/build-vscode.sh](./build/build-vscode.sh) (`npm run build:vscode`) - Builds vscode into `./lib/vscode/out-vscode`. - [./ci/build/build-release.sh](./build/build-release.sh) (`npm run release`) - Bundles the output of the above two scripts into a single node module at `./release`. - [./ci/build/clean.sh](./build/clean.sh) (`npm run clean`) - Removes all build artifacts. - Useful to do a clean build. - [./ci/build/code-server.sh](./build/code-server.sh) - Copied into standalone releases to run code-server with the bundled node binary. - [./ci/build/test-standalone-release.sh](./build/test-standalone-release.sh) (`npm run test:standalone-release`) - Ensures code-server in the `./release-standalone` directory works by installing an extension. - [./ci/build/build-packages.sh](./build/build-packages.sh) (`npm run package`) - Packages `./release-standalone` into a `.tar.gz` archive in `./release-packages`. - If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate `.deb` and `.rpm`. - [./ci/build/nfpm.yaml](./build/nfpm.yaml) - Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate `.deb` and `.rpm`. - [./ci/build/code-server-nfpm.sh](./build/code-server-nfpm.sh) - Entrypoint script for code-server for `.deb` and `.rpm`. - [./ci/build/code-server.service](./build/code-server.service) - systemd user service packaged into the `.deb` and `.rpm`. - [./ci/build/release-github-draft.sh](./build/release-github-draft.sh) (`npm run release:github-draft`) - Uses [gh](https://github.com/cli/cli) to create a draft release with a template description. - [./ci/build/release-github-assets.sh](./build/release-github-assets.sh) (`npm run release:github-assets`) - Downloads the release-package artifacts for the current commit from CI. - Uses [gh](https://github.com/cli/cli) to upload the artifacts to the release specified in `package.json`. - [./ci/build/npm-postinstall.sh](./build/npm-postinstall.sh) - Post install script for the npm package. - Bundled by`npm run release`. ## release-image This directory contains the release docker container image. - [./ci/steps/build-docker-buildx-push.sh](./steps/docker-buildx-push.sh) - Builds the release containers with tags `codercom/code-server-$ARCH:$VERSION` for amd64 and arm64 with `docker buildx` and pushes them. - Assumes debian releases are ready in `./release-packages`. ## images This directory contains the images for CI. ## steps This directory contains the scripts used in CI. Helps avoid clobbering the CI configuration. - [./steps/fmt.sh](./steps/fmt.sh) - Runs `npm run fmt`. - [./steps/lint.sh](./steps/lint.sh) - Runs `npm run lint`. - [./steps/test-unit.sh](./steps/test-unit.sh) - Runs `npm run test:unit`. - [./steps/test-integration.sh](./steps/test-integration.sh) - Runs `npm run test:integration`. - [./steps/test-e2e.sh](./steps/test-e2e.sh) - Runs `npm run test:e2e`. - [./steps/release.sh](./steps/release.sh) - Runs the release process. - Generates the npm package at `./release`. - [./steps/release-packages.sh](./steps/release-packages.sh) - Takes the output of the previous script and generates a standalone release and release packages into `./release-packages`. - [./steps/publish-npm.sh](./steps/publish-npm.sh) - Grabs the `npm-package` release artifact for the current commit and publishes it on npm. - [./steps/docker-buildx-push.sh](./steps/docker-buildx-push.sh) - Builds the docker image and then pushes it. - [./steps/push-docker-manifest.sh](./steps/push-docker-manifest.sh) - Loads all images in `./release-images` and then builds and pushes a multi architecture docker manifest for the amd64 and arm64 images to `codercom/code-server:$VERSION` and `codercom/code-server:latest`. ================================================ FILE: ci/build/build-code-server.sh ================================================ #!/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 "$@" ================================================ FILE: ci/build/build-lib.sh ================================================ #!/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 } ================================================ FILE: ci/build/build-packages.sh ================================================ #!/usr/bin/env bash set -euo pipefail # Given a platform-specific release found in ./release-standalone, generate an # compressed archives and bundles (as appropriate for the platform) named after # the platform's architecture and OS and place them in ./release-packages and # ./release-gcp. main() { cd "$(dirname "${0}")/../.." source ./ci/lib.sh source ./ci/build/build-lib.sh # Allow us to override architecture # we use this for our Linux ARM64 cross compile builds if [ "$#" -eq 1 ] && [ "$1" ]; then ARCH=$1 fi 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" ]]; then tar -czf "release-packages/$release_name.tar.gz" --owner=0 --group=0 --transform "s/^\.\/release-standalone/$release_name/" ./release-standalone else tar -czf "release-packages/$release_name.tar.gz" -s "/^release-standalone/$release_name/" release-standalone 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 PKG_FORMAT="deb" NFPM_ARCH="$(get_nfpm_arch $PKG_FORMAT "$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" PKG_FORMAT="rpm" NFPM_ARCH="$(get_nfpm_arch $PKG_FORMAT "$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 "$@" ================================================ FILE: ci/build/build-release.sh ================================================ #!/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 published to NPM and also use to compile platform-specific packages. # 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. 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" } 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 { "commit": "$(git rev-parse HEAD)", "scripts": { "postinstall": "sh ./postinstall.sh" } } EOF ) > "$RELEASE_PATH/package.json" mv npm-shrinkwrap.json "$RELEASE_PATH" rsync ci/build/npm-postinstall.sh "$RELEASE_PATH/postinstall.sh" if [ "$KEEP_MODULES" = 1 ]; then rsync node_modules/ "$RELEASE_PATH/node_modules" fi } bundle_vscode() { mkdir -p "$VSCODE_OUT_PATH" local rsync_opts=() 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 as we will add it ourselves for the standalone and will not # need it for the npm package. rsync_opts+=(--exclude /node) # Exclude Node modules. if [[ $KEEP_MODULES = 0 ]]; then rsync_opts+=(--exclude node_modules) fi rsync "${rsync_opts[@]}" ./lib/vscode-reh-web-*/ "$VSCODE_OUT_PATH" # Merge the package.json for the web/remote server so we can include # dependencies, since we want to ship this via NPM. jq --slurp '.[0] * .[1]' \ "$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 "$@" ================================================ FILE: ci/build/build-standalone-release.sh ================================================ #!/usr/bin/env bash set -euo pipefail # Once we have an NPM package, use this script to copy it to a separate # directory (./release-standalone) and install the dependencies. This new # directory can then be packaged as a platform-specific release. main() { cd "$(dirname "${0}")/../.." source ./ci/lib.sh rsync "$RELEASE_PATH/" "$RELEASE_PATH-standalone" RELEASE_PATH+=-standalone # Package managers may shim their own "node" wrapper into the PATH, so run # node and ask it for its true path. local node_path node_path="$(node -p process.execPath)" mkdir -p "$RELEASE_PATH/bin" mkdir -p "$RELEASE_PATH/lib" rsync ./ci/build/code-server.sh "$RELEASE_PATH/bin/code-server" rsync "$node_path" "$RELEASE_PATH/lib/node" chmod 755 "$RELEASE_PATH/lib/node" pushd "$RELEASE_PATH" npm install --unsafe-perm --omit=dev # Code deletes some files from the extension node_modules directory which # leaves broken symlinks in the corresponding .bin directory. nfpm will fail # on these broken symlinks so clean them up. rm -fr "./lib/vscode/extensions/node_modules/.bin" popd } main "$@" ================================================ FILE: ci/build/build-vscode.sh ================================================ #!/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} delete-bin-script() { rm -f "lib/vscode-reh-web-linux-x64/bin/$1" } copy-bin-script() { local script="$1" local dest="lib/vscode-reh-web-linux-x64/bin/$script" cp "lib/vscode/resources/server/bin/$script" "$dest" sed -i.bak "s/@@VERSION@@/$(vscode_version)/g" "$dest" sed -i.bak "s/@@COMMIT@@/$BUILD_SOURCEVERSION/g" "$dest" sed -i.bak "s/@@APPNAME@@/code-server/g" "$dest" # 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' "$dest" sed -i.bak 's/ROOT\/out/VSROOT\/out/g' "$dest" # 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' "$dest" # Fix Node path on Windows. sed -i.bak 's/^set ROOT_DIR=\(.*\)$/set ROOT_DIR=%~dp0..\\..\\..\\..\r\nset VSROOT_DIR=\1/g' "$dest" sed -i.bak 's/%ROOT_DIR%\\out/%VSROOT_DIR%\\out/g' "$dest" chmod +x "$dest" rm "$dest.bak" } 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 # Add the date, our name, links, enable telemetry (this just makes telemetry # available; telemetry can still be disabled by flag or setting), and # configure trusted extensions (since some, like github.copilot-chat, never # ask to be trusted and this is the only way to get auth working). # # 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" } } EOF ) > product.json # Any platform here works since we will do our own packaging. We have to do # this because we have an NPM package that could be installed on any platform. # The correct platform dependencies and scripts will be installed as part of # the post-install during `npm install` or when building a standalone release. node --max-old-space-size=16384 --optimize-for-size \ ./node_modules/gulp/bin/gulp.js \ "vscode-reh-web-linux-x64${MINIFY:+-min}" # 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-linux-x64 # 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 # These provide a `code-server` command in the integrated terminal to open # files in the current instance. delete-bin-script remote-cli/code-server 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. delete-bin-script helpers/browser.sh copy-bin-script helpers/browser-darwin.sh copy-bin-script helpers/browser-linux.sh copy-bin-script helpers/browser.cmd } main "$@" ================================================ FILE: ci/build/clean.sh ================================================ #!/usr/bin/env bash set -euo pipefail main() { cd "$(dirname "${0}")/../.." source ./ci/lib.sh git clean -Xffd } main "$@" ================================================ FILE: ci/build/code-server-nfpm.sh ================================================ #!/usr/bin/env sh exec /usr/lib/code-server/bin/code-server "$@" ================================================ FILE: ci/build/code-server-user.service ================================================ [Unit] Description=code-server After=network.target [Service] Type=exec ExecStart=/usr/bin/code-server Restart=always [Install] WantedBy=default.target ================================================ FILE: ci/build/code-server.sh ================================================ #!/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" "$@" ================================================ FILE: ci/build/code-server@.service ================================================ [Unit] Description=code-server After=network.target [Service] Type=exec ExecStart=/usr/bin/code-server Restart=always User=%i [Install] WantedBy=default.target ================================================ FILE: ci/build/nfpm.yaml ================================================ 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-standalone/* dst: /usr/lib/code-server ================================================ FILE: ci/build/npm-postinstall.sh ================================================ #!/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) mklink /J "$dest" "$source" ;; *) ln -s "$source" "$dest" ;; esac } # VS Code bundles some modules into an asar which is an archive format that # works like tar. It then seems to get unpacked into node_modules.asar. # # I don't know why they do this but all the dependencies they bundle already # exist in node_modules so just symlink it. We have to do this since not only # Code itself but also extensions will look specifically in this directory for # files (like the ripgrep binary or the oniguruma wasm). symlink_asar() { symlink node_modules node_modules.asar } # 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:-22}" ]; then echo "ERROR: code-server currently requires node v22." 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 # Under npm, if we are running as root, we need --unsafe-perm otherwise # post-install scripts will not have sufficient permissions to do their thing. if is_root; then case "${npm_config_user_agent-}" in npm*) if [ "${npm_config_unsafe_perm-}" != "true" ]; then echo "Please pass --unsafe-perm to npm to install code-server" echo "Otherwise post-install scripts will not have permissions to run" echo "See https://docs.npmjs.com/misc/config#unsafe-perm" echo "See https://stackoverflow.com/questions/49084929/npm-sudo-global-installation-unsafe-perm" exit 1 fi ;; esac 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 --unsafe-perm --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_asar 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 "$@" ================================================ FILE: ci/dev/doctoc.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/gen_icons.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/lint-scripts.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/postinstall.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/preinstall.js ================================================ if (process.env.npm_execpath.includes("yarn")) { throw new Error("`yarn` is no longer supported; please use `npm install` instead") } ================================================ FILE: ci/dev/test-e2e.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/test-integration.sh ================================================ #!/usr/bin/env bash set -euo pipefail help() { echo >&2 " You can build the standalone release with 'npm run release:standalone'" 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-standalone 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-standalone/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 "$@" ================================================ FILE: ci/dev/test-native.sh ================================================ #!/usr/bin/env bash set -euo pipefail help() { echo >&2 " You can build the standalone release with 'npm run release:standalone'" 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-standalone 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-standalone/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 "$@" ================================================ FILE: ci/dev/test-scripts.sh ================================================ #!/usr/bin/env bash set -euo pipefail main() { cd "$(dirname "$0")/../.." bats ./test/scripts } main "$@" ================================================ FILE: ci/dev/test-unit.sh ================================================ #!/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 "$@" ================================================ FILE: ci/dev/watch.ts ================================================ 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() ================================================ FILE: ci/helm-chart/.helmignore ================================================ # 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/ ================================================ FILE: ci/helm-chart/Chart.yaml ================================================ 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.33.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.109.5 ================================================ FILE: ci/helm-chart/templates/NOTES.txt ================================================ 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) ================================================ FILE: ci/helm-chart/templates/_helpers.tpl ================================================ {{/* 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 -}} ================================================ FILE: ci/helm-chart/templates/deployment.yaml ================================================ 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: replicas: {{ .Values.replicaCount | default 1 }} 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 }} ================================================ FILE: ci/helm-chart/templates/ingress.yaml ================================================ {{- 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 }} ================================================ FILE: ci/helm-chart/templates/pvc.yaml ================================================ {{- 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 }} ================================================ FILE: ci/helm-chart/templates/secrets.yaml ================================================ {{- 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 }} ================================================ FILE: ci/helm-chart/templates/service.yaml ================================================ 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 }} ================================================ FILE: ci/helm-chart/templates/serviceaccount.yaml ================================================ {{- if or .Values.serviceAccount.create -}} apiVersion: v1 kind: ServiceAccount metadata: labels: {{- include "code-server.labels" . | nindent 4 }} name: {{ template "code-server.serviceAccountName" . }} {{- end -}} ================================================ FILE: ci/helm-chart/templates/tests/test-connection.yaml ================================================ 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 ================================================ FILE: ci/helm-chart/values.yaml ================================================ # 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.109.5' 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: {} 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 ================================================ FILE: ci/lib.sh ================================================ #!/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 "$@" } ARCH="$(arch)" export ARCH OS=$(os) export OS # RELEASE_PATH is the destination directory for the release from the root. # Defaults to release RELEASE_PATH="${RELEASE_PATH-release}" ================================================ FILE: ci/release-image/Dockerfile ================================================ # syntax=docker/dockerfile:experimental ARG BASE=debian:12 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", "."] ================================================ FILE: ci/release-image/Dockerfile.fedora ================================================ # 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", "."] ================================================ FILE: ci/release-image/Dockerfile.opensuse ================================================ # 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", "."] ================================================ FILE: ci/release-image/docker-bake.hcl ================================================ # 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-12", "code-server-ubuntu-focal", "code-server-ubuntu-noble", "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-12" { 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("bookworm"), ) platforms = ["linux/amd64", "linux/arm64"] } target "code-server-ubuntu-focal" { dockerfile = "ci/release-image/Dockerfile" tags = concat( gen_tags_for_docker_and_ghcr("ubuntu"), 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"), ) args = { BASE = "ubuntu:noble" } 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"] } ================================================ FILE: ci/release-image/entrypoint-catatonit.sh ================================================ #!/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 "$@" ================================================ FILE: ci/release-image/entrypoint.sh ================================================ #!/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 "$@" ================================================ FILE: ci/steps/brew-bump.sh ================================================ #!/usr/bin/env bash set -euo pipefail main() { # Only sourcing this so we get access to $VERSION source ./ci/lib.sh source ./ci/steps/steps-lib.sh echo "Checking environment variables" # We need VERSION to bump the brew formula if ! is_env_var_set "VERSION"; then echo "VERSION is not set" exit 1 fi # We need HOMEBREW_GITHUB_API_TOKEN to push up commits if ! is_env_var_set "HOMEBREW_GITHUB_API_TOKEN"; then echo "HOMEBREW_GITHUB_API_TOKEN is not set" exit 1 fi # Find the docs for bump-formula-pr here # https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-cmd/bump-formula-pr.rb#L18 local output if ! output=$(brew bump-formula-pr --version="${VERSION}" code-server --no-browse --no-audit --message="PR opened by @${GITHUB_ACTOR}" 2>&1); then if [[ $output == *"Duplicate PRs should not be opened"* ]]; then echo "$VERSION is already submitted" exit 0 else echo "$output" exit 1 fi fi } main "$@" ================================================ FILE: ci/steps/docker-buildx-push.sh ================================================ #!/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 "$@" ================================================ FILE: ci/steps/publish-npm.sh ================================================ #!/usr/bin/env bash set -euo pipefail main() { cd "$(dirname "$0")/../.." source ./ci/lib.sh source ./ci/steps/steps-lib.sh ## Authentication tokens # Needed to publish on NPM if ! is_env_var_set "NPM_TOKEN"; then echo "NPM_TOKEN is not set. Cannot publish to npm without credentials." exit 1 fi ## Publishing Information # All the variables below are used to determine how we should publish # the npm package. We also use this information for bumping the version. # This is because npm won't publish your package unless it's a new version. # i.e. for development, we bump the version to -- # example: "version": "4.0.1-4769-ad7b23cfe6ffd72914e34781ef7721b129a23040" # We use this to grab the PR_NUMBER if ! is_env_var_set "GITHUB_REF"; then echo "GITHUB_REF is not set. Are you running this locally? We rely on values provided by GitHub." exit 1 fi # We use this when setting NPM_VERSION if ! is_env_var_set "GITHUB_SHA"; then echo "GITHUB_SHA is not set. Are you running this locally? We rely on values provided by GitHub." exit 1 fi # We use this to determine the NPM_ENVIRONMENT if ! is_env_var_set "GITHUB_EVENT_NAME"; then echo "GITHUB_EVENT_NAME is not set. Are you running this locally? We rely on values provided by GitHub." exit 1 fi # Check that we're using at least v7 of npm CLI if ! command -v jq &> /dev/null; then echo "Couldn't find jq" echo "We need this in order to modify the package.json for dev builds." exit 1 fi # This allows us to publish to npm in CI workflows if [[ ${CI-} ]]; then echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc fi ## Environment # This string is used to determine how we should tag the npm release. # Environment can be one of three choices: # "development" - this means we tag with the PR number, allowing # a developer to install this version with `npm install code-server@` # "staging" - this means we tag with `beta`, allowing # a developer to install this version with `npm install code-server@beta` # "production" - this means we tag with `latest` (default), allowing # a developer to install this version with `npm install code-server@latest` if ! is_env_var_set "NPM_ENVIRONMENT"; then echo "NPM_ENVIRONMENT is not set." echo "Determining in script based on GITHUB environment variables." if [[ "$GITHUB_EVENT_NAME" == 'push' && "$GITHUB_REF" == 'refs/heads/main' ]]; then NPM_ENVIRONMENT="staging" else NPM_ENVIRONMENT="development" fi fi # NOTE@jsjoeio - this script assumes we have the artifact downloaded on disk # That happens in CI as a step before we run this. # https://github.com/actions/upload-artifact/issues/38 tar -xzf release-npm-package/package.tar.gz # We use this to set the name of the package in the # package.json PACKAGE_NAME="code-server" # NOTES:@jsjoeio # We only need to run npm version for "development" and "staging". # This is because our release:prep script automatically bumps the version # in the package.json and we commit it as part of the release PR. if [[ "$NPM_ENVIRONMENT" == "production" ]]; then NPM_VERSION="$VERSION" # This means the npm version will be published as "stable" # and installed when a user runs `npm install code-server` NPM_TAG="latest" else COMMIT_SHA="$GITHUB_SHA" if [[ "$NPM_ENVIRONMENT" == "staging" ]]; then NPM_VERSION="$VERSION-beta-$COMMIT_SHA" # This means the npm version will be tagged with "beta" # and installed when a user runs `npm install code-server@beta` NPM_TAG="beta" PACKAGE_NAME="@coder/code-server-pr" fi if [[ "$NPM_ENVIRONMENT" == "development" ]]; then # Source: https://github.com/actions/checkout/issues/58#issuecomment-614041550 PR_NUMBER=$(echo "$GITHUB_REF" | awk 'BEGIN { FS = "/" } ; { print $3 }') NPM_VERSION="$VERSION-$PR_NUMBER-$COMMIT_SHA" PACKAGE_NAME="@coder/code-server-pr" # This means the npm version will be tagged with "" # and installed when a user runs `npm install code-server@` NPM_TAG="$PR_NUMBER" fi echo "- tag: $NPM_TAG" echo "- version: $NPM_VERSION" echo "- package name: $PACKAGE_NAME" echo "- npm environment: $NPM_ENVIRONMENT" # We modify the version in the package.json # to be the current version + the PR number + commit SHA # or we use current version + beta + commit SHA # Example: "version": "4.0.1-4769-ad7b23cfe6ffd72914e34781ef7721b129a23040" # Example: "version": "4.0.1-beta-ad7b23cfe6ffd72914e34781ef7721b129a23040" pushd release npm version "$NPM_VERSION" # Use the development package name # This is so we don't clutter the code-server versions on npm # with development versions. # jq can't edit in place so we must store in memory and echo local contents contents="$(jq ".name |= \"$PACKAGE_NAME\"" package.json)" echo "${contents}" > package.json popd fi # We need to make sure we haven't already published the version. # If we get error, continue with script because we want to publish # If version is valid, we check if we're publishing the same one local hasVersion if hasVersion=$(npm view "$PACKAGE_NAME@$NPM_VERSION" version 2> /dev/null) && [[ $hasVersion == "$NPM_VERSION" ]]; then echo "$NPM_VERSION is already published under $PACKAGE_NAME" return fi # Since the dev builds are scoped to @coder # We pass --access public to ensure npm knows it's not private. cd release npm publish --tag "$NPM_TAG" --access public } main "$@" ================================================ FILE: ci/steps/steps-lib.sh ================================================ #!/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 } ================================================ FILE: docs/CODE_OF_CONDUCT.md ================================================ # 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 ================================================ FILE: docs/CONTRIBUTING.md ================================================ # 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) - [Creating a Standalone Release](#creating-a-standalone-release) - [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` v22.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 1. Remove any patches with `quilt pop -a`. 2. Update the `lib/vscode` submodule to the desired upstream version branch. 1. `cd lib/vscode && git checkout release/1.66 && cd ../..` 2. `git add lib && git commit -m "chore: update to Code "` 3. Apply the patches one at a time (`quilt push`). If the application succeeds but the lines changed, update the patch with `quilt refresh`. If there are conflicts, then force apply with `quilt push -f`, manually add back the rejected code, then run `quilt refresh`. 4. From the code-server **project root**, run `npm install`. 5. Check the Node.js version that's used by Electron (which is shipped with VS Code. If necessary, update our version of Node.js to match. ### 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 as follows: ```shell git submodule update --init quilt push -a npm install npm run build VERSION=0.0.0 npm run build:vscode npm run release ``` This does not keep `node_modules`. If you want them to be kept, use `KEEP_MODULES=1 npm run release` Run your build: ```shell cd release npm install --omit=dev # Skip if you used KEEP_MODULES=1 # Runs the built JavaScript with Node. node . ``` Then, to build the release package: ```shell npm run release:standalone npm run test:integration 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. #### Creating a Standalone Release Part of the build process involves creating standalone releases. At the time of writing, we do this for the following platforms/architectures: - Linux amd64 (.tar.gz, .deb, and .rpm) - Linux arm64 (.tar.gz, .deb, and .rpm) - Linux arm7l (.tar.gz) - Linux armhf.deb - Linux armhf.rpm - macOS arm64.tar.gz Currently, these are compiled in CI using the `npm run release:standalone` command in the `release.yaml` workflow. We then upload them to the draft release and distribute via GitHub Releases. ### 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 ================================================ FILE: docs/FAQ.md ================================================ # 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) - [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 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) ## 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 ## 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 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` ================================================ FILE: docs/MAINTAINING.md ================================================ # Maintaining - [Releasing](#releasing) - [Release Candidates](#release-candidates) - [AUR](#aur) - [Docker](#docker) - [Homebrew](#homebrew) - [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. Update the changelog with the release date. 4. Go to GitHub Actions > Draft release > Run workflow on the commit you want to release. Make sure CI has finished the build workflow on that commit or this will fail. 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. 5. CI will automatically grab the build artifact on that commit (which is why CI has to have completed), inject the provided version into the `package.json`, put together platform-specific packages, and upload those packages to a draft release. 6. Update the resulting draft release with the changelog contents. 7. Publish the draft release after validating it. 8. Bump the Helm chart version once the Docker images have published. #### 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. #### Homebrew We publish code-server on Homebrew [here](https://github.com/Homebrew/homebrew-core/blob/master/Formula/code-server.rb). This is currently automated with the release process (but may fail occasionally). If it does, run this locally: ```shell # Replace VERSION with version brew bump-formula-pr --version="${VERSION}" code-server --no-browse --no-audit ``` #### 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 ================================================ FILE: docs/README.md ================================================ # 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. ================================================ FILE: docs/SECURITY.md ================================================ # 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. ================================================ FILE: docs/android.md ================================================ # 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 22: ```shell nvm install 22 nvm use 22 ``` 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 ================================================ FILE: docs/coder.md ================================================ # 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) - [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. ## External authentication If you want to use external authentication mechanism (e.g., Sign in with Google), you can do this with a reverse proxy such as: - [Pomerium](https://www.pomerium.com/docs/guides/code-server.html) - [oauth2-proxy](https://oauth2-proxy.github.io/oauth2-proxy/) - [Cloudflare Access](https://www.cloudflare.com/zero-trust/products/access/) ## HTTPS and self-signed certificates For HTTPS, you can use a self-signed certificate by: - Passing in `--cert` - Passing in an existing certificate by providing the path to `--cert` and the path to the key with `--cert-key` The self signed certificate will be generated to `~/.local/share/code-server/self-signed.crt`. If you pass a certificate to code-server, it will respond to HTTPS requests and redirect all HTTP requests to HTTPS. > You can use [Let's Encrypt](https://letsencrypt.org/) to get a TLS certificate > for free. Note: if you set `proxy_set_header Host $host;` in your reverse proxy config, it will change the address displayed in the green section of code-server in the bottom left to show the correct address. ## Accessing web services If you're working on web services and want to access them locally, code-server can proxy to any port using either a subdomain or a subpath, allowing you to securely access these services using code-server's built-in authentication. ### Using a subdomain You will need a DNS entry that points to your server for each port you want to access. You can either set up a wildcard DNS entry for `*.` if your domain name registrar supports it, or you can create one for every port you want to access (`3000.`, `8080.`, etc). You should also set up TLS certificates for these subdomains, either using a wildcard certificate for `*.` or individual certificates for each port. To set your domain, start code-server with the `--proxy-domain` flag: ```console code-server --proxy-domain ``` For instance, if you have code-server exposed on `domain.tld` and a Python server running on port 8080 of the same machine code-server is running on, you could run code-server with `--proxy-domain domain.tld` and access the Python server via `8080.domain.tld`. Note that this uses the host header, so ensure your reverse proxy (if you're using one) forwards that information. ### Using a subpath Simply browse to `/proxy//`. For instance, if you have code-server exposed on `domain.tld` and a Python server running on port 8080 of the same machine code-server is running on, you could access the Python server via `domain.tld/proxy/8000`. ### Using your own proxy You can make extensions and the ports panel use your own proxy by setting `VSCODE_PROXY_URI`. For example if you set `VSCODE_PROXY_URI=https://{{port}}.kyle.dev` when an application is detected running on port 3000 of the same machine code-server is running on the ports panel will create a link to https://3000.kyle.dev instead of pointing to the built-in subpath-based proxy. Note: relative paths are also supported i.e. `VSCODE_PROXY_URI=./proxy/{{port}}` ### Stripping `/proxy/` from the request path You may notice that the code-server proxy strips `/proxy/` from the request path. HTTP servers should use relative URLs to avoid the need to be coupled to the absolute path at which they are served. This means you must [use trailing slashes on all paths with subpaths](https://blog.cdivilly.com/2019/02/28/uri-trailing-slashes). This reasoning is why the default behavior is to strip `/proxy/` from the base path. If your application uses relative URLs and does not assume the absolute path at which it is being served, it will just work no matter what port you decide to serve it off or if you put it in behind code-server or any other proxy. However, some prefer the cleaner aesthetic of no trailing slashes. Omitting the trailing slashes couples you to the base path, since you cannot use relative redirects correctly anymore. If you're okay with this tradeoff, use `/absproxy` instead and the path will be passed as is (e.g., `/absproxy/3000/my-app-path`). ### Proxying to create a React app You must use `/absproxy/` with `create-react-app` (see [#2565](https://github.com/coder/code-server/issues/2565) and [#2222](https://github.com/coder/code-server/issues/2222) for more information). You will need to inform `create-react-app` of the path at which you are serving via `$PUBLIC_URL` and webpack via `$WDS_SOCKET_PATH`: ```sh PUBLIC_URL=/absproxy/3000 \ WDS_SOCKET_PATH=$PUBLIC_URL/sockjs-node \ BROWSER=none yarn start ``` You should then be able to visit `https://my-code-server-address.io/absproxy/3000` to see your app exposed through code-server. > We highly recommend using the subdomain approach instead to avoid this class of issue. ### Proxying to a Vue app Similar to the situation with React apps, you have to make a few modifications to proxy a Vue app. 1. add `vue.config.js` 2. update the values to match this (you can use any free port): ```js module.exports = { devServer: { port: 3454, sockPath: "sockjs-node", }, publicPath: "/absproxy/3454", } ``` 3. access app at `/absproxy/3454` e.g. `http://localhost:8080/absproxy/3454` Read more about `publicPath` in the [Vue.js docs](https://cli.vuejs.org/config/#publicpath) ### Proxying to an Angular app In order to use code-server's built-in proxy with Angular, you need to make the following changes in your app: 1. use `` in `src/index.html` 2. add `--serve-path /absproxy/4200` to `ng serve` in your `package.json` For additional context, see [this GitHub Discussion](https://github.com/coder/code-server/discussions/5439#discussioncomment-3371983). ### Proxying to a Svelte app In order to use code-server's built-in proxy with Svelte, you need to make the following changes in your app: 1. Add `svelte.config.js` if you don't already have one 2. Update the values to match this (you can use any free port): ```js const config = { kit: { paths: { base: "/absproxy/5173", }, }, } ``` 3. Access app at `/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/ For additional context, see [this Github Issue](https://github.com/sveltejs/kit/issues/2958) ### Prefixing `/absproxy/` with a path This is a case where you need to serve an application via `absproxy` as explained above while serving code-server itself from a path other than the root in your domain. For example: `http://my-code-server.com/user/123/workspace/my-app`. To achieve this result: 1. Start code-server with the switch `--abs-proxy-base-path=/user/123/workspace` 2. Follow one of the instructions above for your framework. ### Preflight requests By default, if you have auth enabled, code-server will authenticate all proxied requests including preflight requests. This can cause issues because preflight requests do not typically include credentials. To allow all preflight requests through the proxy without authentication, use `--skip-auth-preflight`. ## Internationalization and customization code-server allows you to provide a JSON file to configure certain strings. This can be used for both internationalization and customization. Create a JSON file with your custom strings: ```json { "WELCOME": "Welcome to {{app}}", "LOGIN_TITLE": "{{app}} Access Portal", "LOGIN_BELOW": "Please log in to continue", "PASSWORD_PLACEHOLDER": "Enter Password" } ``` Then reference the file: ```shell code-server --i18n /path/to/custom-strings.json ``` Or this can be done in the config file: ```yaml i18n: /path/to/custom-strings.json ``` You can combine this with the `--locale` flag to configure language support for both code-server and VS Code in cases where code-server has no support but VS Code does. If you are using this for internationalization, please consider sending us a pull request to contribute it to `src/node/i18n/locales`. ### Available keys and placeholders Refer to [../src/node/i18n/locales/en.json](../src/node/i18n/locales/en.json) for a full list of the available keys for translations. Note that the only placeholders supported for each key are the ones used in the default string. The `--app-name` flag controls the `{{app}}` placeholder in templates. If you want to change the name, you can either: 1. Set `--app-name` (potentially alongside `--i18n`) 2. Use `--i18n` and hardcode the name in your strings ### Legacy flag The `--welcome-text` flag is now deprecated. Use the `WELCOME` key instead. ================================================ FILE: docs/helm.md ================================================ # code-server Helm Chart [![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square)](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) [![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)](https://img.shields.io/badge/Type-application-informational?style=flat-square) [![AppVersion: 4.8.0](https://img.shields.io/badge/AppVersion-4.8.0-informational?style=flat-square)](https://img.shields.io/badge/AppVersion-4.8.0-informational?style=flat-square) [code-server](https://github.com/coder/code-server) code-server is VS Code running on a remote server, accessible through the browser. This chart is community maintained by [@Matthew-Beckett](https://github.com/Matthew-Beckett) and [@alexgorbatchev](https://github.com/alexgorbatchev) ## Quickstart ```console $ git clone https://github.com/coder/code-server $ cd code-server $ helm upgrade --install code-server ci/helm-chart ``` ## Introduction This chart bootstraps a code-server deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.6+ ## Installing the Chart To install the chart with the release name `code-server`: ```console $ git clone https://github.com/coder/code-server $ cd code-server $ helm upgrade --install code-server ci/helm-chart ``` The command deploys code-server on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. > **Tip**: List all releases using `helm list` ## Uninstalling the Chart To uninstall/delete the `code-server` deployment: ```console $ helm delete code-server ``` The command removes all the Kubernetes components associated with the chart and deletes the release. ## Configuration The following table lists the configurable parameters of the code-server chart and their default values. ## Values | Key | Type | Default | | ------------------------------------------- | ------ | ------------------------ | | affinity | object | `{}` | | extraArgs | list | `[]` | | extraConfigmapMounts | list | `[]` | | extraContainers | string | `""` | | extraInitContainers | string | `""` | | extraSecretMounts | list | `[]` | | extraVars | list | `[]` | | extraVolumeMounts | list | `[]` | | fullnameOverride | string | `""` | | hostnameOverride | string | `""` | | image.pullPolicy | string | `"Always"` | | image.repository | string | `"codercom/code-server"` | | image.tag | string | `"4.8.0"` | | imagePullSecrets | list | `[]` | | ingress.enabled | bool | `false` | | nameOverride | string | `""` | | nodeSelector | object | `{}` | | persistence.accessMode | string | `"ReadWriteOnce"` | | persistence.annotations | object | `{}` | | persistence.enabled | bool | `true` | | persistence.size | string | `"1Gi"` | | podAnnotations | object | `{}` | | podSecurityContext | object | `{}` | | replicaCount | int | `1` | | resources | object | `{}` | | securityContext.enabled | bool | `true` | | securityContext.fsGroup | int | `1000` | | securityContext.runAsUser | int | `1000` | | service.port | int | `8443` | | service.type | string | `"ClusterIP"` | | serviceAccount.create | bool | `true` | | serviceAccount.name | string | `nil` | | tolerations | list | `[]` | | volumePermissions.enabled | bool | `true` | | volumePermissions.securityContext.runAsUser | int | `0` | Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console $ helm upgrade --install code-server \ ci/helm-chart \ --set persistence.enabled=false ``` The above command sets the the persistence storage to false. Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, ```console $ helm upgrade --install code-server ci/helm-chart -f values.yaml ``` > **Tip**: You can use the default [values.yaml](values.yaml) # Extra Containers There are two parameters which allow to add more containers to pod. Use `extraContainers` to add regular containers and `extraInitContainers` to add init containers. You can read more about init containers in [k8s documentation](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/). Both parameters accept strings and use them as a templates Example of using `extraInitContainers`: ```yaml 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 ``` With this yaml in file `init.yaml`, you can execute ```console $ helm upgrade --install code-server \ ci/helm-chart \ --values init.yaml ``` to deploy code-server with python and golang extensions preinstalled before main container have started. ================================================ FILE: docs/install.md ================================================ # Install - [install.sh](#installsh) - [Detection reference](#detection-reference) - [npm](#npm) - [Standalone releases](#standalone-releases) - [Debian, Ubuntu](#debian-ubuntu) - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse) - [Arch Linux](#arch-linux) - [Artix Linux](#artix-linux) - [macOS](#macos) - [Docker](#docker) - [Helm](#helm) - [Windows](#windows) - [Raspberry Pi](#raspberry-pi) - [Termux](#termux) - [Cloud providers](#cloud-providers) - [Uninstall](#uninstall) - [install.sh](#installsh-1) - [Homebrew](#homebrew) - [npm](#npm-1) - [Debian, Ubuntu](#debian-ubuntu-1) This document demonstrates how to install `code-server` on various distros and operating systems. ## install.sh The easiest way to install code-server is to use our [install script](https://github.com/coder/code-server/blob/main/install.sh) for Linux, macOS and FreeBSD. The install script [attempts to use the system package manager](#detection-reference) if possible. 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 ``` You can modify the installation process by including one or more of the following flags: - `--dry-run`: echo the commands for the install process without running them. - `--method`: choose the installation method. - `--method=detect`: detect the package manager but fallback to `--method=standalone`. - `--method=standalone`: install a standalone release archive into `~/.local`. - `--prefix=/usr/local`: install a standalone release archive system-wide. - `--version=X.X.X`: install version `X.X.X` instead of latest version. - `--help`: see usage docs. - `--edge`: install the latest edge version (i.e. pre-release) When done, the install script prints out instructions for running and starting code-server. > If you're concerned about the install script's use of `curl | sh` and the > security implications, please see [this blog > post](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) > by [sandstorm.io](https://sandstorm.io). If you prefer to install code-server manually, despite the [detection references](#detection-reference) and `--dry-run` feature, then continue on for information on how to do this. The [`install.sh`](https://github.com/coder/code-server/blob/main/install.sh) script runs the _exact_ same commands presented in the rest of this document. ### Detection reference - For Debian and Ubuntu, code-server will install the latest deb package. - For Fedora, CentOS, RHEL and openSUSE, code-server will install the latest RPM package. - For Arch Linux, code-server will install the AUR package. - For any unrecognized Linux operating system, code-server will install the latest standalone release into `~/.local`. - Ensure that you add `~/.local/bin` to your `$PATH` to run code-server. - For macOS, code-server will install the Homebrew package (if you don't have Homebrew installed, code-server will install the latest standalone release into `~/.local`). - Ensure that you add `~/.local/bin` to your `$PATH` to run code-server. - For FreeBSD, code-server will install the [npm package](#npm) with `npm` - If you're installing code-server onto architecture with no releases, code-server will install the [npm package](#npm) with `npm` - We currently offer releases for amd64 and arm64. - The [npm package](#npm) builds the native modules on post-install. ## npm We recommend installing with `npm` when: 1. You aren't using a machine with `amd64` or `arm64`. 2. You are installing code-server on Windows. 3. You're on Linux with `glibc` < v2.28 or `glibcxx` < v3.4.21. 4. You're running Alpine Linux or are using a non-glibc libc. See [#1430](https://github.com/coder/code-server/issues/1430#issuecomment-629883198) for more information. Installing code-server with `npm` builds native modules on install. This process requires C dependencies; see our guide on [installing with npm](./npm.md) for more information. ## Standalone releases We publish self-contained `.tar.gz` archives for every release on [GitHub](https://github.com/coder/code-server/releases). The archives bundle the node binary and node modules. We create the standalone releases using the [npm package](#npm), and we then create the remaining releases using the standalone version. The only requirement to use the standalone release is `glibc` >= 2.28 and `glibcxx` >= v3.4.21 on Linux (for macOS, there is no minimum system requirement). To use a standalone release: 1. Download the latest release archive for your system from [GitHub](https://github.com/coder/code-server/releases). 2. Unpack the release. 3. Run code-server by executing `./bin/code-server`. You can add `./bin/code-server` to your `$PATH` so that you can execute `code-server` without providing full path each time. Here is a sample script for installing and using a standalone code-server release on Linux: ```bash mkdir -p ~/.local/lib ~/.local/bin curl -fL https://github.com/coder/code-server/releases/download/v$VERSION/code-server-$VERSION-linux-amd64.tar.gz \ | tar -C ~/.local/lib -xz mv ~/.local/lib/code-server-$VERSION-linux-amd64 ~/.local/lib/code-server-$VERSION ln -s ~/.local/lib/code-server-$VERSION/bin/code-server ~/.local/bin/code-server PATH="~/.local/bin:$PATH" code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Debian, Ubuntu > The standalone arm64 .deb does not support Ubuntu 16.04 or earlier. Please > upgrade or [build with npm](#npm). ```bash curl -fOL https://github.com/coder/code-server/releases/download/v$VERSION/code-server_${VERSION}_amd64.deb sudo dpkg -i code-server_${VERSION}_amd64.deb sudo systemctl enable --now code-server@$USER # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Fedora, CentOS, RHEL, SUSE > The standalone arm64 .rpm does not support CentOS 7. Please upgrade or [build > with npm](#npm). ```bash curl -fOL https://github.com/coder/code-server/releases/download/v$VERSION/code-server-$VERSION-amd64.rpm sudo rpm -i code-server-$VERSION-amd64.rpm sudo systemctl enable --now code-server@$USER # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Arch Linux ```bash # Install code-server from the AUR using yay. yay -S code-server sudo systemctl enable --now code-server@$USER # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ```bash # Install code-server from the AUR with plain makepkg. git clone https://aur.archlinux.org/code-server.git cd code-server makepkg -si sudo systemctl enable --now code-server@$USER # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Artix Linux ```bash # Install code-server from the AUR git clone https://aur.archlinux.org/code-server.git cd code-server makepkg -si ``` Save the file as `code-server` in `/etc/init.d/` and make it executable with `chmod +x code-server`. Put your username in line 3. ```bash #!/sbin/openrc-run name=$RC_SVCNAME description="$name - VS Code on a remote server" user="" # your username here homedir="/home/$user" command="$(which code-server)" # Just because you can do this does not mean you should. Use ~/.config/code-server/config.yaml instead #command_args="--extensions-dir $homedir/.local/share/$name/extensions --user-data-dir $homedir/.local/share/$name --disable-telemetry" command_user="$user:$user" pidfile="/run/$name/$name.pid" command_background="yes" extra_commands="report" depend() { use logger dns need net } start_pre() { checkpath --directory --owner $command_user --mode 0755 /run/$name /var/log/$name } start() { default_start report } stop() { default_stop } status() { default_status report } report() { # Report to the user einfo "Reading configuration from ~/.config/code-server/config.yaml" } ``` Start on boot with default runlevel ``` rc-update add code-server default ``` Start the service immediately ``` rc-service code-server start ``` ## macOS ```bash brew install code-server brew services start code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Docker ```bash # This will start a code-server container and expose it at http://127.0.0.1:8080. # It will also mount your current directory into the container as `/home/coder/project` # and forward your UID/GID so that all file system operations occur as your user outside # the container. # # Your $HOME/.config is mounted at $HOME/.config within the container to ensure you can # easily access/modify your code-server config in $HOME/.config/code-server/config.json # outside the container. mkdir -p ~/.config docker run -it --name code-server -p 127.0.0.1:8080:8080 \ -v "$HOME/.local:/home/coder/.local" \ -v "$HOME/.config:/home/coder/.config" \ -v "$PWD:/home/coder/project" \ -u "$(id -u):$(id -g)" \ -e "DOCKER_USER=$USER" \ codercom/code-server:latest ``` Our official image supports `amd64` and `arm64`. For `arm32` support, you can use a [community-maintained code-server alternative](https://hub.docker.com/r/linuxserver/code-server). ## Helm You can install code-server using the [Helm package manager](https://coder.com/docs/code-server/latest/helm). ## Windows We currently [do not publish Windows releases](https://github.com/coder/code-server/issues/1397). We recommend installing code-server onto Windows with [`npm`](#npm). ## Raspberry Pi We recommend installing code-server onto Raspberry Pi with [`npm`](#npm). If you see an error related to `node-gyp` during installation, See [#5174](https://github.com/coder/code-server/issues/5174) for more information. ## Termux Please see code-server's [Termux docs](./termux.md#installation) for more information. ## Cloud providers We maintain [one-click apps and install scripts for cloud providers](https://github.com/coder/deploy-code-server) such as DigitalOcean, Railway, Heroku, and Azure. ## Uninstall code-server can be completely uninstalled by removing the application directory, and your user configuration directory. To delete settings and data: ```shell rm -rf ~/.local/share/code-server ~/.config/code-server ``` ### install.sh If you installed with the install script, by default code-server will be in `~/.local/lib/code-server-` and you can remove it with `rm -rf`. e.g. ```shell rm -rf ~/.local/lib/code-server-* ``` ### Homebrew To remove the code-server homebrew package, run: ```shell brew remove code-server # Alternatively brew uninstall code-server ``` ### npm To remove the code-server global module, run: ```shell npm uninstall --global code-server ``` ### Debian, Ubuntu To uninstall, run: ```shell sudo apt remove code-server ``` ================================================ FILE: docs/ios.md ================================================ # Using code-server on iOS with iSH 1. Install iSH from the [App Store](https://apps.apple.com/us/app/ish-shell/id1436902243) 2. Install `curl` and `nano` with `apk add curl nano` 3. Configure iSH to use an earlier version of NodeJS with `nano /etc/apk/repositories` and edit `v3.14` to `v3.12` on both repository links. 4. Install `nodejs` and `npm` with `apk add nodejs npm` 5. Install code-server with `curl -fsSL https://code-server.dev/install.sh | sh` 6. Run code-server with `code-server` 7. Access on localhost:8080 in your browser ================================================ FILE: docs/ipad.md ================================================ # iPad - [Using the code-server progressive web app (PWA)](#using-the-code-server-progressive-web-app-pwa) - [Access code-server using Servediter](#access-code-server-using-servediter) - [Raspberry Pi USB-C network](#raspberry-pi-usb-c-network) - [Recommendations](#recommendations) - [Known issues](#known-issues) - [Workaround for issue with `ctrl+c` not stopping a running process in the terminal](#workaround-for-issue-with-ctrlc-not-stopping-a-running-process-in-the-terminal) - [Access code-server with a self-signed certificate on an iPad](#access-code-server-with-a-self-signed-certificate-on-an-ipad) - [Certificate requirements](#certificate-requirements) - [Sharing a self-signed certificate with an iPad](#sharing-a-self-signed-certificate-with-an-ipad) Once you've installed code-server, you can access it from an iPad. ## Using the code-server progressive web app (PWA) To use code-server on an iPad, we recommend installing the code-server progressive web app (PWA): 1. Open code-server in Safari. 2. Click the **Share** icon. 3. Click **Add to Home Screen**. You can now open code-server from the Home screen, and when you do, you'll be using the PWA. Running code-server as a PWA gets you more screen real estate and access to top-level keyboard shortcuts since its running like a native app. For example, you can use `cmd+w` to close an active file in the workbench. You can add this to `keybindings.json`: 1. Open code-server 2. Go to **Command Palette** > **Open Keyboard Shortcuts (JSON)** 3. Add the following to `keybindings.json` ```json { "key": "cmd+w", "command": "workbench.action.closeActiveEditor" } ``` 4. Test the command by using `cmd+w` to close an active file. ## Access code-server using Servediter If you are unable to get the self-signed certificate working, or you do not have a domain name to use, you can use [Servediter for code-server](https://apps.apple.com/us/app/servediter-for-code-server/id1504491325). > Servediter for code-server is **not** officially supported by the code-server team! To use Servediter: 1. Download the app from the App Store. 2. When prompted, provide your server information. If you are running a local server or a [Raspberry Pi connected via USB-C](#raspberry-pi-usb-c-network), you will input your settings into **Self Hosted Server**. ## Raspberry Pi USB-C network We've heard of users having great success using code-server on an iPad connected to a Raspberry Pi via USB-C (the Raspberry Pi provides both power and direct network access). Setting this up requires you to turn on **Network over USB-C** on the Raspberry Pi, then continuing with code-server as usual on the iPad. For more information, see: - [General introduction to Pi as an iPad accessory](https://www.youtube.com/watch?v=IR6sDcKo3V8) - [iPad with Pi FAQ](https://www.youtube.com/watch?v=SPSlyqo5Q2Q) - [Technical guide to connecting a Raspberry Pi to an iPad](https://www.geeky-gadgets.com/connect-a-raspberry-pi-4-to-an-ipad-pro-21-01-2020/) You may also find the following tips from [Acker Apple](http://github.com/ackerapple/) helpful: > Here are my keys to success. I bought a 4" touch screen with fan included that > attaches as a case to the Pi. I use the touch screen for anytime I have > connection issues, otherwise I turn off the Pi screen. I gave my Pi a network > name so I can easily connect at home on wifi or when on go with 1 usb-c cable > that supplys both power and network connectivity. Lastly, not all usb-c cables > are equal and not all will work so try different usb-c cables if you are going > mad (confirm over wifi first then move to cable). ## Recommendations Once you can access code-server on your iPad, you may find the following tips and tricks helpful: - Use multi-task mode to make code changes and see the browser at the same time - This prevents the iOS background from dropping an app's state if you are switching between code-server and browser (with both in full-screen) - Be sure you are using the debug/terminal that is built into VS Code so that you don’t need another terminal app running - This also prevents switching between full screen apps and losing your view due to iOS' background app memory management ## Known issues - Getting self-signed certificates to work [is an involved process](#access-code-server-with-a-self-signed-certificate-on-an-ipad) - Keyboard issues: - The keyboard disappear sometimes [#979](https://github.com/coder/code-server/issues/979) - Some expectations regarding shortcuts may not be met: - `cmd + n` opens new browser window instead of new file, and it's difficult to set alternative as a workaround - In general, expect to edit your keyboard shortcuts - There's no escape key by default on the Magic Keyboard, so most users set the globe key to be an escape key - Trackpad scrolling does not work on iPadOS < 14.5 ([#1455](https://github.com/coder/code-server/issues/1455)) - [WebKit fix](https://bugs.webkit.org/show_bug.cgi?id=210071#c13) - Keyboard may lose focus in Safari / split view [#4182](https://github.com/coder/code-server/issues/4182) - Terminal text does not appear by default [#3824](https://github.com/coder/code-server/issues/3824) - Copy & paste in terminal does not work well with keyboard shortcuts [#3491](https://github.com/coder/code-server/issues/3491) - `ctrl+c` does not stop a long-running process in the browser - Tracking upstream issue here: [#114009](https://github.com/microsoft/vscode/issues/114009) - See [workaround](#ctrl-c-workaround) Additionally, see [issues in the code-server repo that are tagged with the `os-ios` label](https://github.com/coder/code-server/issues?q=is%3Aopen+is%3Aissue+label%3Aos-ios) for more information. ### Workaround for issue with `ctrl+c` not stopping a running process in the terminal This's currently an issue with `ctrl+c` not stopping a running process in the integrated terminal. We have filed an issue upstream and are tracking [here](https://github.com/microsoft/vscode/issues/114009). In the meantime, you can manually define a shortcut as a workaround: 1. Open the Command Palette 2. Look for **Preferences: Open Keyboard Shortcuts (JSON)** 3. Add the following snippet: ```json { "key": "ctrl+c", "command": "workbench.action.terminal.sendSequence", "args": { "text": "\u0003" }, "when": "terminalFocus" } ``` _Source: [StackOverflow](https://stackoverflow.com/a/52735954/3015595)_ ## Access code-server with a self-signed certificate on an iPad If you've installed code-server and are [running it with a self-signed certificate](./guide.md#using-a-self-signed-certificate), you may see multiple security warnings from Safari. To fix this, you'll need to install the self-signed certificate generated by code-server as a profile on your device (you'll also need to do this to enable WebSocket connections). ### Certificate requirements - We're assuming that you're using the self-signed certificate code-server generates for you (if not, make sure that your certificate [abides by the guidelines issued by Apple](https://support.apple.com/en-us/HT210176)). - We've noticed that the certificate has to include `basicConstraints=CA:true`. - Your certificate must have a subject alt name that matches the hostname you'll use to access code-server from the iPad. You can pass this name to code-server so that it generates the certificate correctly using `--cert-host`. ### Sharing a self-signed certificate with an iPad To share a self-signed certificate with an iPad: 1. Get the location of the certificate code-server generated; code-server prints the certificate's location in its logs: ```console [2020-10-30T08:55:45.139Z] info - Using generated certificate and key for HTTPS: ~/.local/share/code-server/mymbp_local.crt ``` 2. Send the certificate to the iPad, either by emailing it to yourself or using Apple's Airdrop feature. 3. Open the `*.crt` file so that you're prompted to go into Settings to install. 4. Go to **Settings** > **General** > **Profile**, and select the profile. Tap **Install**. 5. Go to **Settings** > **About** > **Certificate Trust Settings** and [enable full trust for your certificate](https://support.apple.com/en-us/HT204477). You should be able to access code-server without all of Safari's warnings now. **warning**: Your iPad must access code-server via a domain name. It could be local DNS like `mymacbookpro.local`, but it must be a domain name. Otherwise, Safari will not allow WebSockets connections. ================================================ FILE: docs/manifest.json ================================================ { "versions": ["v4.8.0"], "routes": [ { "title": "Home", "description": "Learn how to install and run code-server.", "path": "./README.md", "icon_path": "assets/images/icons/home.svg" }, { "title": "Requirements", "description": "Learn about what you need to run code-server.", "icon_path": "assets/images/icons/requirements.svg", "path": "./requirements.md" }, { "title": "Install", "description": "How to install code-server.", "icon_path": "assets/images/icons/wrench.svg", "path": "./install.md", "children": [ { "title": "npm", "description": "How to install code-server using npm", "path": "./npm.md" }, { "title": "Helm", "description": "How to install code-server using the Helm package manager", "path": "./helm.md" } ] }, { "title": "Usage", "description": "How to set up and use code-server.", "icon_path": "assets/images/icons/usage.svg", "path": "./guide.md", "children": [ { "title": "Coder", "description": "How to run code-server in Coder", "path": "./coder.md" }, { "title": "iPad", "description": "How to access your code-server installation using an iPad.", "path": "./ipad.md" }, { "title": "Termux", "description": "How to install Termux to run code-server on an Android device.", "path": "./termux.md" }, { "title": "iOS", "description": "How to use code-server on iOS with iSH.", "path": "./ios.md" }, { "title": "Android", "description": "How to run code-server on an Android device using UserLAnd.", "path": "./android.md" } ] }, { "title": "Collaboration", "description": "How to setup real time collaboration using code server.", "icon_path": "assets/images/icons/collab.svg", "path": "./collaboration.md" }, { "title": "Upgrade", "description": "How to upgrade code-server.", "icon_path": "assets/images/icons/upgrade.svg", "path": "./upgrade.md" }, { "title": "FAQ", "description": "Frequently asked questions on installing and running code-server.", "icon_path": "assets/images/icons/faq.svg", "path": "./FAQ.md" }, { "title": "Contributing", "description": "How to contribute to code-server.", "icon_path": "assets/images/icons/contributing.svg", "path": "./CONTRIBUTING.md", "children": [ { "title": "Code of conduct", "description": "Coder expects contributors to code-server to behave in a manner that creates an open and welcoming environment.", "path": "./CODE_OF_CONDUCT.md" }, { "title": "Maintenance", "description": "Learn about the workflow followed by code-server's maintainers.", "path": "./MAINTAINING.md" }, { "title": "Triage", "description": "How the maintainers triage issues with code-server.", "path": "./triage.md" }, { "title": "Security", "description": "Learn about the tools used to detect vulnerabilities in code-server, and how you can report vulnerabilities.", "path": "./SECURITY.md" } ] } ] } ================================================ FILE: docs/npm.md ================================================ # npm Install Requirements - [Node.js version](#nodejs-version) - [Ubuntu, Debian](#ubuntu-debian) - [Fedora, CentOS, RHEL](#fedora-centos-rhel) - [Alpine](#alpine) - [macOS](#macos) - [FreeBSD](#freebsd) - [Windows](#windows) - [Installing](#installing) - [Troubleshooting](#troubleshooting) - [Issues with Node.js after version upgrades](#issues-with-nodejs-after-version-upgrades) - [Debugging install issues with npm](#debugging-install-issues-with-npm) If you're installing code-server via `npm`, you'll need to install additional dependencies required to build the native modules used by VS Code. This article includes installing instructions based on your operating system. > **WARNING**: Do not use `yarn` to install code-server. Unlike `npm`, it does not respect > lockfiles for distributed applications. It will instead use the latest version > available at installation time - which might not be the one used for a given > code-server release, and [might lead to unexpected behavior](https://github.com/coder/code-server/issues/4927). ## Node.js version We use the same major version of Node.js shipped with Code's remote, which is currently `22.x`. VS Code also [lists Node.js requirements](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites). Using other versions of Node.js [may lead to unexpected behavior](https://github.com/coder/code-server/issues/1633). ## Ubuntu, Debian ```bash sudo apt-get install -y \ build-essential \ pkg-config \ python3 npm config set python python3 ``` Proceed to [installing](#installing) ## Fedora, CentOS, RHEL ```bash sudo yum groupinstall -y 'Development Tools' sudo yum config-manager --set-enabled PowerTools # unnecessary on CentOS 7 sudo yum install -y python2 npm config set python python2 ``` Proceed to [installing](#installing) ## Alpine ```bash apk add alpine-sdk bash libstdc++ libc6-compat python3 krb5-dev ``` Proceed to [installing](#installing) ## macOS ```bash xcode-select --install ``` Proceed to [installing](#installing) ## FreeBSD ```sh pkg install -y git python npm-node22 pkgconf pkg install -y libinotify ``` Proceed to [installing](#installing) ## Windows Installing code-server requires all of the [prerequisites for VS Code development](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). When installing the C++ compiler tool chain, we recommend using "Option 2: Visual Studio 2019" for best results. Next, install code-server with: ```bash npm install --global code-server code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` A `postinstall.sh` script will attempt to run. Select your terminal (e.g., Git bash) as the default shell for npm run-scripts. If an additional dialog does not appear, run the install command again. If the `code-server` command is not found, you'll need to [add a directory to your PATH](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/). To find the directory, use the following command: ```shell npm config get prefix ``` For help and additional troubleshooting, see [#1397](https://github.com/coder/code-server/issues/1397). ## Installing After adding the dependencies for your OS, install the code-server package globally: ```bash npm install --global code-server code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` ## Troubleshooting If you need further assistance, post on our [GitHub Discussions page](https://github.com/coder/code-server/discussions). ### Issues with Node.js after version upgrades Occasionally, you may run into issues with Node.js. If you install code-server using `npm`, and you upgrade your Node.js version, you may need to reinstall code-server to recompile native modules. Sometimes, you can get around this by navigating into code-server's `lib/vscode` directory and running `npm rebuild` to recompile the modules. A step-by-step example of how you might do this is: 1. Install code-server: `brew install code-server` 2. Navigate into the directory: `cd /usr/local/Cellar/code-server//libexec/lib/vscode/` 3. Recompile the native modules: `npm rebuild` 4. Restart code-server ### Debugging install issues with npm To debug installation issues, install with `npm`: ```shell # Uninstall npm uninstall --global code-server > /dev/null 2>&1 # Install with logging npm install --loglevel verbose --global code-server ``` ================================================ FILE: docs/requirements.md ================================================ # Requirements You'll need a machine on which you can run code-server. You can use a physical machine you have, or you can use a VM on GCP/AWS. At the minimum, we recommend: - 1 GB of RAM - 2 CPU cores You can use any Linux distribution, but [our docs](https://coder.com/docs/code-server/latest/guide) assume that you're using Debian hosted by Google Cloud (see the following section for instructions on setting this up). Your environment must have WebSockets enabled, since code-server uses WebSockets for communication between the browser and the server. ## Set up a VM on Google Cloud The following steps walk you through setting up a VM running Debian using Google Cloud (though you are welcome to use any machine or VM provider). If you're [signing up with Google](https://console.cloud.google.com/getting-started) for the first time, you should get a 3-month trial with \$300 of credits. After you sign up and create a new Google Cloud Provider (GCP) project, create a new Compute Engine VM instance: 1. Using the sidebar, navigate to **Compute Engine** > **VM Instances**. 2. Click **Create Instance**. 3. Provide a **name** for new instance. 4. Choose the **region** that's closest to you based on [GCP ping](https://gcping.com/). 5. Choose a **zone** (any option is fine). 6. We recommend choosing an **E2 series instance** from the [general-purpose family](https://cloud.google.com/compute/docs/machine-types#general_purpose). 7. Change the instance type to **custom** and set at least **2 cores** and **2 GB of RAM**. You can add more resources if desired, though you can also edit your instance at a later point. 8. Though optional, we highly recommend switching the persistent disk to an SSD with at least 32 GB. To do so, click **change** under **Boot Disk**. Then, change the type to **SSD Persistent Disk**, and set the size to **32**. (You can also grow your disk at a later date). 9. Go to **Networking** > **Networking Interfaces** and edit the existing interface to use a static internal IP. Click **Done** to save. 10. If you don't have a [project-wide SSH key](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys#project-wide), go to **Security** > **SSH Keys** to add your public key. 11. Click **Create** to proceed. Notes: - To lower costs, you can shut down your server when you're not using it. - We recommend using the `gcloud cli` to avoid using the GCP Dashboard if possible. - For serving code-server over HTTPS, we recommend using an external domain name along with a service such as Let's Encrypt ================================================ FILE: docs/termux.md ================================================ # Termux - [Install](#install) - [NPM Installation](#npm-installation) - [Upgrade](#upgrade) - [Known Issues](#known-issues) - [Git won't work in `/sdcard`](#git-wont-work-in-sdcard) - [Many extensions including language packs fail to install](#many-extensions-including-language-packs-fail-to-install) - [Extra](#extra) - [Keyboard Shortcuts and Tab Key](#keyboard-shortcuts-and-tab-key) - [Create a new user](#create-a-new-user) - [Install Go](#install-go) - [Install Python](#install-python) ## Install 1. Get [Termux](https://f-droid.org/en/packages/com.termux/) from **F-Droid**. 2. Run `pkg install tur-repo` 3. Run `pkg install code-server` 4. You can now start code server by simply running `code-server`. ## NPM Installation 1. Get [Termux](https://f-droid.org/en/packages/com.termux/) from **F-Droid**. 2. We will now change using the following command. ```sh termux-change-repo ``` Now select `Main Repository` then change repo to `Mirrors by Grimler Hosted on grimler.se`. 3. After successfully updating of repository update and upgrade all the packages by the following command ```sh pkg update pkg upgrade -y ``` 4. Now let's install requirement dependancy. ```sh pkg install -y \ build-essential \ binutils \ pkg-config \ python3 \ nodejs-lts npm config set python python3 node -v ``` you will get Node version `v22` 5. Now install code-server following our guide on [installing with npm](./npm.md) 6. Congratulation code-server is installed on your device using the following command. ```sh code-server --auth none ``` 7. If already installed then use the following command for upgradation. ``` npm update --global code-server ``` ## Upgrade 1. Remove all previous installs `rm -rf ~/.local/lib/code-server-*` 2. Run the install script again `curl -fsSL https://code-server.dev/install.sh | sh` ## Known Issues ### Git won't work in `/sdcard` Issue : Using git in the `/sdcard` directory will fail during cloning/commit/staging/etc...\ Fix : None\ Potential Workaround : 1. Create a soft-link from the debian-fs to your folder in `/sdcard` 2. Use git from termux (preferred) ### Many extensions including language packs fail to install Issue: Android is not seen as a Linux environment but as a separate, unsupported platform, so code-server only allows [Web Extensions](https://code.visualstudio.com/api/extension-guides/web-extensions), refusing to download extensions that run on the server.\ Fix: None\ Potential workarounds : Either - Manually download extensions as `.vsix` file and install them via `Extensions: Install from VSIX...` in the Command Palette. - Use an override to pretend the platform is Linux: Create a JS script that patches `process.platform`: ```js // android-as-linux.js Object.defineProperty(process, "platform", { get() { return "linux" }, }) ``` Then use Node's `--require` option to make sure it is loaded before `code-server` starts: ```sh NODE_OPTIONS="--require /path/to/android-as-linux.js" code-server ``` ⚠️ Note that Android and Linux are not 100% compatible, so use these workarounds at your own risk. Extensions that have native dependencies other than Node or that directly interact with the OS might cause issues. ## Extra ### Keyboard Shortcuts and Tab Key In order to support the tab key and use keyboard shortcuts, add this to your settings.json: ```json { "keyboard.dispatch": "keyCode" } ``` ### Create a new user To create a new user follow these simple steps - 1. Create a new user by running `useradd -m`. 2. Change the password by running `passwd `. 3. Give your new user sudo access by running `visudo`, scroll down to `User privilege specification` and add the following line after root `username ALL=(ALL:ALL) ALL`. 4. Now edit the `/etc/passwd` file with your command line editor of choice and at the end of the line that specifies your user change `/bin/sh` to `/bin/bash`. 5. Now switch users by running `su - ` - Remember the `-` betweeen `su` and username is required to execute `/etc/profile`,\ since `/etc/profile` may have some necessary things to be executed you should always add a `-`. ### Install Go > From https://golang.org/doc/install 1. Go to https://golang.org/dl/ and copy the download link for `linux arm` and run the following: ```bash wget download_link ``` 2. Extract the downloaded archive. (This step will erase all previous GO installs, make sure to create a backup if you have previously installed GO) ```bash rm -rf /usr/local/go && tar -C /usr/local -xzf archive_name ``` 3. Run `nano /etc/profile` and add the following line `export PATH=$PATH:/usr/local/go/bin`. 4. Now run `exit` (depending on if you have switched users or not, you may have to run `exit` multiple times to get to normal termux shell) and start Debian again. 5. Check if your install was successful by running `go version` ### Install Python > Run these commands as root 1. Run the following commands to install required packages to build python: ```bash sudo apt-get update sudo apt-get install make build-essential libssl-dev zlib1g-dev \ libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \ libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev ``` 2. Install [pyenv](https://github.com/pyenv/pyenv/) from [pyenv-installer](https://github.com/pyenv/pyenv-installer) by running: ```bash curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash ``` 3. Run `nano /etc/profile` and add the following: ```bash export PYENV_ROOT="/root/.pyenv" export PATH="/root/.pyenv/bin:$PATH" eval "$(pyenv init --path)" eval "$(pyenv virtualenv-init -)" ``` 4. Exit and start Debian again. 5. Run `pyenv versions` to list all installable versions. 6. Run `pyenv install version` to install the desired python version. > The build process may take some time (an hour or 2 depending on your device). 7. Run `touch /root/.pyenv/version && echo "your_version_here" > /root/.pyenv/version` 8. (You may have to start Debian again) Run `python3 -V` to verify if PATH works or not. > If `python3` doesn't work but pyenv says that the install was successful in step 6 then try running `$PYENV_ROOT/versions/your_version/bin/python3`. ================================================ FILE: docs/triage.md ================================================ # Triage Triaging code-server issues is done with the following issue filter: ```text is:issue is:open no:project sort:created-asc -label:blocked -label:upstream -label:waiting-for-info -label:extension-request ``` This will show issues that: 1. Are open. 1. Have no assigned project. 1. Are not `blocked` or tagged for work by `upstream` (the VS Code core team). If an upstream issue is detrimental to the code-server experience we may fix it in our patch instead of waiting for the VS Code team to fix it. Someone should periodically go through these issues to see if they can be unblocked! 1. Are not labeled `waiting-for-info`. 1. Are not extension requests. ## Triage process 1. If an issue is a question/discussion, it should be converted into a GitHub discussion. 1. Otherwise, give the issue the appropriate labels (feel free to create new ones if necessary). There are no hard and set rules for labels. We don't have many so look through and see how they've been used throughout the repository. They all also have descriptions. 1. If more information is required, please ask the submitter and tag as `waiting-for-info` and wait. 1. Finally, the issue should be moved into the [code-server](https://github.com/coder/code-server/projects/1) project where we pick out issues to fix and track their progress. We also use [milestones](https://github.com/coder/code-server/milestones) to track what issues are planned/or were closed for what release. ================================================ FILE: docs/upgrade.md ================================================ # Upgrade To upgrade code-server, install the new version over the old version. All user data is in `~/.local/share/code-server`, so they are preserved between installations. ================================================ FILE: eslint.config.mjs ================================================ import { fixupConfigRules } from "@eslint/compat" import globals from "globals" import tsParser from "@typescript-eslint/parser" import path from "node:path" import { fileURLToPath } from "node:url" import js from "@eslint/js" import { FlatCompat } from "@eslint/eslintrc" const __filename = fileURLToPath(import.meta.url) const __dirname = path.dirname(__filename) const compat = new FlatCompat({ baseDirectory: __dirname, recommendedConfig: js.configs.recommended, allConfig: js.configs.all, }) export default [ ...fixupConfigRules( compat.extends( "eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:import/recommended", "plugin:import/typescript", "plugin:prettier/recommended", "prettier", ), ), { languageOptions: { globals: { ...globals.browser, ...globals.jest, ...globals.node, }, parser: tsParser, ecmaVersion: 2018, sourceType: "module", }, settings: { "import/resolver": { typescript: { alwaysTryTypes: true, }, }, }, rules: { "@typescript-eslint/no-unused-vars": [ "error", { args: "none", }, ], "no-dupe-class-members": "off", "@typescript-eslint/no-use-before-define": "off", "@typescript-eslint/no-non-null-assertion": "off", "@typescript-eslint/ban-types": "off", "@typescript-eslint/no-var-requires": "off", "@typescript-eslint/explicit-module-boundary-types": "off", "@typescript-eslint/no-explicit-any": "off", "@typescript-eslint/no-extra-semi": "off", "@typescript-eslint/no-require-imports": "off", "@typescript-eslint/no-unused-vars": "off", // TODO: Fix these. "@typescript-eslint/no-empty-object-type": "off", eqeqeq: "error", "import/order": [ "error", { alphabetize: { order: "asc", }, groups: [["builtin", "external", "internal"], "parent", "sibling"], }, ], "no-async-promise-executor": "off", }, }, ] ================================================ FILE: flake.nix ================================================ { description = "code-server"; inputs = { nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable-small"; flake-utils.url = "github:numtide/flake-utils"; }; outputs = { self, nixpkgs, flake-utils }: flake-utils.lib.eachDefaultSystem (system: let pkgs = nixpkgs.legacyPackages.${system}; nodejs = pkgs.nodejs_22; in { devShells.default = pkgs.mkShell { nativeBuildInputs = with pkgs; [ imagemagick nodejs python3 pkg-config git rsync jq moreutils quilt bats openssl ]; buildInputs = with pkgs; (lib.optionals (!stdenv.isDarwin) [ libsecret libkrb5 ] ++ (with xorg; [ libX11 libxkbfile ]) ++ lib.optionals stdenv.isDarwin (with pkgs.darwin.apple_sdk.frameworks; [ AppKit Cocoa CoreServices Security xcbuild ])); }; } ); } ================================================ FILE: install.sh ================================================ #!/bin/sh set -eu # code-server's automatic install script. # See https://coder.com/docs/code-server/latest/install usage() { arg0="$0" if [ "$0" = sh ]; then arg0="curl -fsSL https://code-server.dev/install.sh | sh -s --" else not_curl_usage="The latest script is available at https://code-server.dev/install.sh " fi cath << EOF Installs code-server. It tries to use the system package manager if possible. After successful installation it explains how to start using code-server. Pass in user@host to install code-server on user@host over ssh. The remote host must have internet access. ${not_curl_usage-} Usage: $arg0 [--dry-run] [--version X.X.X] [--edge] [--method detect] \ [--prefix ~/.local] [--rsh ssh] [user@host] --dry-run Echo the commands for the install process without running them. --version X.X.X Install a specific version instead of the latest. --edge Install the latest edge version instead of the latest stable version. --method [detect | standalone] Choose the installation method. Defaults to detect. - detect detects the system package manager and tries to use it. Full reference on the process is further below. - standalone installs a standalone release archive into ~/.local Add ~/.local/bin to your \$PATH to use it. --prefix Sets the prefix used by standalone release archives. Defaults to ~/.local The release is unarchived into ~/.local/lib/code-server-X.X.X and the binary symlinked into ~/.local/bin/code-server To install system wide pass --prefix=/usr/local --rsh Specifies the remote shell for remote installation. Defaults to ssh. The detection method works as follows: - Debian, Ubuntu, Raspbian: install the deb package from GitHub. - Fedora, CentOS, RHEL, openSUSE: install the rpm package from GitHub. - Arch Linux: install from the AUR (which pulls releases from GitHub). - FreeBSD, Alpine: install from npm. - macOS: install using Homebrew if installed otherwise install from GitHub. - All others: install the release from GitHub. We only build releases on GitHub for amd64 and arm64 on Linux and amd64 for macOS. When the detection method tries to pull a release from GitHub it will fall back to installing from npm when there is no matching release for the system's operating system and architecture. The standalone method will force installion using GitHub releases. It will not fall back to npm so on architectures without pre-built releases this will error. The installer will cache all downloaded assets into ~/.cache/code-server More installation docs are at https://coder.com/docs/code-server/latest/install EOF } echo_latest_version() { if [ "${EDGE-}" ]; then version="$(curl -fsSL https://api.github.com/repos/coder/code-server/releases | awk 'match($0,/.*"html_url": "(.*\/releases\/tag\/.*)".*/)' | head -n 1 | awk -F '"' '{print $4}')" else # https://gist.github.com/lukechilds/a83e1d7127b78fef38c2914c4ececc3c#gistcomment-2758860 version="$(curl -fsSLI -o /dev/null -w "%{url_effective}" https://github.com/coder/code-server/releases/latest)" fi version="${version#https://github.com/coder/code-server/releases/tag/}" version="${version#v}" echo "$version" } echo_npm_postinstall() { echoh cath << EOF npm package has been installed. Extend your path to use code-server: PATH="$NPM_BIN_DIR:\$PATH" Then run with: code-server EOF } echo_standalone_postinstall() { echoh cath << EOF Standalone release has been installed into $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION Extend your path to use code-server: PATH="$STANDALONE_INSTALL_PREFIX/bin:\$PATH" Then run with: code-server EOF } echo_brew_postinstall() { echoh cath << EOF Brew release has been installed. Run with: code-server EOF } echo_systemd_postinstall() { echoh cath << EOF $1 package has been installed. To have systemd start code-server now and restart on boot: sudo systemctl enable --now code-server@\$USER Or, if you don't want/need a background service you can run: code-server EOF } echo_coder_postinstall() { echoh echoh "Deploy code-server for your team with Coder: https://github.com/coder/coder" } main() { if [ "${TRACE-}" ]; then set -x fi unset \ DRY_RUN \ METHOD \ OPTIONAL \ ALL_FLAGS \ RSH_ARGS \ EDGE \ RSH ALL_FLAGS="" while [ "$#" -gt 0 ]; do case "$1" in -*) ALL_FLAGS="${ALL_FLAGS} $1" ;; esac case "$1" in --dry-run) DRY_RUN=1 ;; --method) METHOD="$(parse_arg "$@")" shift ;; --method=*) METHOD="$(parse_arg "$@")" ;; --prefix) STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")" shift ;; --prefix=*) STANDALONE_INSTALL_PREFIX="$(parse_arg "$@")" ;; --version) VERSION="$(parse_arg "$@")" shift ;; --version=*) VERSION="$(parse_arg "$@")" ;; --edge) EDGE=1 ;; --rsh) RSH="$(parse_arg "$@")" shift ;; --rsh=*) RSH="$(parse_arg "$@")" ;; -h | --h | -help | --help) usage exit 0 ;; --) shift # We remove the -- added above. ALL_FLAGS="${ALL_FLAGS% --}" RSH_ARGS="$*" break ;; -*) echoerr "Unknown flag $1" echoerr "Run with --help to see usage." exit 1 ;; *) RSH_ARGS="$*" break ;; esac shift done if [ "${RSH_ARGS-}" ]; then RSH="${RSH-ssh}" echoh "Installing remotely with $RSH $RSH_ARGS" curl -fsSL https://code-server.dev/install.sh | prefix "$RSH_ARGS" "$RSH" "$RSH_ARGS" sh -s -- "$ALL_FLAGS" return fi METHOD="${METHOD-detect}" if [ "$METHOD" != detect ] && [ "$METHOD" != standalone ]; then echoerr "Unknown install method \"$METHOD\"" echoerr "Run with --help to see usage." exit 1 fi # These are used by the various install_* functions that make use of GitHub # releases in order to download and unpack the right release. CACHE_DIR=$(echo_cache_dir) STANDALONE_INSTALL_PREFIX=${STANDALONE_INSTALL_PREFIX:-$HOME/.local} VERSION=${VERSION:-$(echo_latest_version)} # These can be overridden for testing but shouldn't normally be used as it can # result in a broken code-server. OS=${OS:-$(os)} ARCH=${ARCH:-$(arch)} distro_name # Standalone installs by pulling pre-built releases from GitHub. if [ "$METHOD" = standalone ]; then if has_standalone; then install_standalone echo_coder_postinstall exit 0 else echoerr "There are no standalone releases for $ARCH" echoerr "Please try again without '--method standalone'" exit 1 fi fi # DISTRO can be overridden for testing but shouldn't normally be used as it # can result in a broken code-server. DISTRO=${DISTRO:-$(distro)} case $DISTRO in # macOS uses brew when available and falls back to standalone. We only have # amd64 for macOS so for anything else use npm. macos) BREW_PATH="${BREW_PATH-brew}" if command_exists "$BREW_PATH"; then install_brew else echoh "Homebrew not installed." echoh "Falling back to standalone installation." npm_fallback install_standalone fi ;; # The .deb and .rpm files are pulled from GitHub and we only have amd64 and # arm64 there and need to fall back to npm otherwise. debian) npm_fallback install_deb ;; fedora | opensuse) npm_fallback install_rpm ;; # Arch uses the AUR package which only supports amd64 and arm64 since it # pulls releases from GitHub so we need to fall back to npm. arch) npm_fallback install_aur ;; # We don't have GitHub releases that work on Alpine or FreeBSD so we have no # choice but to use npm here. alpine | freebsd) install_npm ;; # For anything else we'll try to install standalone but fall back to npm if # we don't have releases for the architecture. *) echoh "Unsupported package manager." echoh "Falling back to standalone installation." npm_fallback install_standalone ;; esac echo_coder_postinstall } parse_arg() { case "$1" in *=*) # Remove everything after first equal sign. opt="${1%%=*}" # Remove everything before first equal sign. optarg="${1#*=}" if [ ! "$optarg" ] && [ ! "${OPTIONAL-}" ]; then echoerr "$opt requires an argument" echoerr "Run with --help to see usage." exit 1 fi echo "$optarg" return ;; esac case "${2-}" in "" | -*) if [ ! "${OPTIONAL-}" ]; then echoerr "$1 requires an argument" echoerr "Run with --help to see usage." exit 1 fi ;; *) echo "$2" return ;; esac } fetch() { URL="$1" FILE="$2" if [ -e "$FILE" ]; then echoh "+ Reusing $FILE" return fi sh_c mkdir -p "$CACHE_DIR" sh_c curl \ -#fL \ -o "$FILE.incomplete" \ -C - \ "$URL" sh_c mv "$FILE.incomplete" "$FILE" } install_brew() { echoh "Installing latest from Homebrew." echoh sh_c "$BREW_PATH" install code-server echo_brew_postinstall } install_deb() { echoh "Installing v$VERSION of the $ARCH deb package from GitHub." echoh fetch "https://github.com/coder/code-server/releases/download/v$VERSION/code-server_${VERSION}_$ARCH.deb" \ "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb" sudo_sh_c dpkg -i "$CACHE_DIR/code-server_${VERSION}_$ARCH.deb" echo_systemd_postinstall deb } install_rpm() { echoh "Installing v$VERSION of the $ARCH rpm package from GitHub." echoh fetch "https://github.com/coder/code-server/releases/download/v$VERSION/code-server-$VERSION-$ARCH.rpm" \ "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm" sudo_sh_c rpm -U "$CACHE_DIR/code-server-$VERSION-$ARCH.rpm" echo_systemd_postinstall rpm } install_aur() { echoh "Installing latest from the AUR." echoh sh_c mkdir -p "$CACHE_DIR/code-server-aur" sh_c "curl -#fsSL https://aur.archlinux.org/cgit/aur.git/snapshot/code-server.tar.gz | tar -xzC $CACHE_DIR/code-server-aur --strip-components 1" echo "+ cd $CACHE_DIR/code-server-aur" if [ ! "${DRY_RUN-}" ]; then cd "$CACHE_DIR/code-server-aur" fi sh_c makepkg -si --noconfirm echo_systemd_postinstall AUR } install_standalone() { echoh "Installing v$VERSION of the $ARCH release from GitHub." echoh fetch "https://github.com/coder/code-server/releases/download/v$VERSION/code-server-$VERSION-$OS-$ARCH.tar.gz" \ "$CACHE_DIR/code-server-$VERSION-$OS-$ARCH.tar.gz" # -w only works if the directory exists so try creating it first. If this # fails we can ignore the error as the -w check will then swap us to sudo. sh_c mkdir -p "$STANDALONE_INSTALL_PREFIX" 2> /dev/null || true sh_c="sh_c" if [ ! -w "$STANDALONE_INSTALL_PREFIX" ]; then sh_c="sudo_sh_c" fi if [ -e "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION" ]; then echoh echoh "code-server-$VERSION is already installed at $STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION" echoh "Remove it to reinstall." exit 0 fi "$sh_c" mkdir -p "$STANDALONE_INSTALL_PREFIX/lib" "$STANDALONE_INSTALL_PREFIX/bin" "$sh_c" tar -C "$STANDALONE_INSTALL_PREFIX/lib" -xzf "$CACHE_DIR/code-server-$VERSION-$OS-$ARCH.tar.gz" "$sh_c" mv -f "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION-$OS-$ARCH" "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION" "$sh_c" ln -fs "$STANDALONE_INSTALL_PREFIX/lib/code-server-$VERSION/bin/code-server" "$STANDALONE_INSTALL_PREFIX/bin/code-server" echo_standalone_postinstall } install_npm() { echoh "Installing v$VERSION from npm." echoh NPM_PATH="${YARN_PATH-npm}" if command_exists "$NPM_PATH"; then sh_c="sh_c" if [ ! "${DRY_RUN-}" ] && [ ! -w "$(NPM_PATH config get prefix)" ]; then sh_c="sudo_sh_c" fi echoh "Installing with npm." echoh "$sh_c" "$NPM_PATH" install -g "code-server@$VERSION" --unsafe-perm NPM_BIN_DIR="\$($NPM_PATH bin -g)" echo_npm_postinstall return fi echoerr "Please install npm to install code-server!" echoerr "You will need at least node v20 and a few C dependencies." echoerr "See the docs https://coder.com/docs/code-server/latest/install#npm" exit 1 } # Run $1 if we have a standalone otherwise run install_npm. npm_fallback() { if has_standalone; then $1 else echoh "No standalone releases for $ARCH." echoh "Falling back to installation from npm." install_npm fi } # Determine if we have standalone releases on GitHub for the system's arch. has_standalone() { case $ARCH in arm64) return 0 ;; # We only have arm64 for macOS. amd64) [ "$(distro)" != macos ] return ;; *) return 1 ;; esac } os() { uname="$(uname)" case $uname in Linux) echo linux ;; Darwin) echo macos ;; FreeBSD) echo freebsd ;; *) echo "$uname" ;; esac } # Print the detected Linux distro, otherwise print the OS name. # # Example outputs: # - macos -> macos # - freebsd -> freebsd # - ubuntu, raspbian, debian ... -> debian # - amzn, centos, rhel, fedora, ... -> fedora # - opensuse-{leap,tumbleweed} -> opensuse # - alpine -> alpine # - arch, manjaro, endeavouros, ... -> arch # # Inspired by https://github.com/docker/docker-install/blob/26ff363bcf3b3f5a00498ac43694bf1c7d9ce16c/install.sh#L111-L120. distro() { if [ "$OS" = "macos" ] || [ "$OS" = "freebsd" ]; then echo "$OS" return fi if [ -f /etc/os-release ]; then ( . /etc/os-release if [ "${ID_LIKE-}" ]; then for id_like in $ID_LIKE; do case "$id_like" in debian | fedora | opensuse | arch) echo "$id_like" return ;; esac done fi echo "$ID" ) return fi } # Print a human-readable name for the OS/distro. distro_name() { if [ "$(uname)" = "Darwin" ]; then echo "macOS v$(sw_vers -productVersion)" return fi if [ -f /etc/os-release ]; then ( . /etc/os-release echo "$PRETTY_NAME" ) return fi # Prints something like: Linux 4.19.0-9-amd64 uname -sr } arch() { uname_m=$(uname -m) case $uname_m in aarch64) echo arm64 ;; x86_64) echo amd64 ;; *) echo "$uname_m" ;; esac } command_exists() { if [ ! "$1" ]; then return 1; fi command -v "$@" > /dev/null } sh_c() { echoh "+ $*" if [ ! "${DRY_RUN-}" ]; then sh -c "$*" fi } sudo_sh_c() { if [ "$(id -u)" = 0 ]; then sh_c "$@" elif command_exists doas; then sh_c "doas $*" elif command_exists sudo; then sh_c "sudo $*" elif command_exists su; then sh_c "su root -c '$*'" else echoh echoerr "This script needs to run the following command as root." echoerr " $*" echoerr "Please install doas, sudo, or su." exit 1 fi } echo_cache_dir() { if [ "${XDG_CACHE_HOME-}" ]; then echo "$XDG_CACHE_HOME/code-server" elif [ "${HOME-}" ]; then echo "$HOME/.cache/code-server" else echo "/tmp/code-server-cache" fi } echoh() { echo "$@" | humanpath } cath() { humanpath } echoerr() { echoh "$@" >&2 } # humanpath replaces all occurrences of " $HOME" with " ~" # and all occurrences of '"$HOME' with the literal '"$HOME'. humanpath() { sed "s# $HOME# ~#g; s#\"$HOME#\"\$HOME#g" } # We need to make sure we exit with a non zero exit if the command fails. # /bin/sh does not support -o pipefail unfortunately. prefix() { PREFIX="$1" shift fifo="$(mktemp -d)/fifo" mkfifo "$fifo" sed -e "s#^#$PREFIX: #" "$fifo" & "$@" > "$fifo" 2>&1 } main "$@" ================================================ FILE: package.json ================================================ { "name": "code-server", "license": "MIT", "version": "0.0.0", "description": "Run VS Code on a remote server.", "homepage": "https://github.com/coder/code-server", "bugs": { "url": "https://github.com/coder/code-server/issues" }, "repository": "https://github.com/coder/code-server", "scripts": { "clean": "./ci/build/clean.sh", "build": "./ci/build/build-code-server.sh", "build:vscode": "./ci/build/build-vscode.sh", "doctoc": "./ci/dev/doctoc.sh", "release": "./ci/build/build-release.sh", "release:standalone": "./ci/build/build-standalone-release.sh", "release:prep": "./ci/build/release-prep.sh", "test:e2e": "VSCODE_IPC_HOOK_CLI= ./ci/dev/test-e2e.sh", "test:e2e:proxy": "USE_PROXY=1 ./ci/dev/test-e2e.sh", "test:unit": "./ci/dev/test-unit.sh --forceExit --detectOpenHandles", "test:integration": "./ci/dev/test-integration.sh", "test:native": "./ci/dev/test-native.sh", "test:scripts": "./ci/dev/test-scripts.sh", "package": "./ci/build/build-packages.sh", "prettier": "prettier --write --log-level=warn --cache .", "preinstall": "node ./ci/dev/preinstall.js", "postinstall": "./ci/dev/postinstall.sh", "publish:npm": "./ci/steps/publish-npm.sh", "publish:docker": "./ci/steps/docker-buildx-push.sh", "fmt": "npm run prettier && ./ci/dev/doctoc.sh", "lint:scripts": "./ci/dev/lint-scripts.sh", "lint:ts": "eslint --max-warnings=0 --fix $(git ls-files '*.ts' '*.js' | grep -v 'lib/vscode')", "test": "echo 'Run npm run test:unit or npm run test:e2e' && exit 1", "watch": "VSCODE_DEV=1 VSCODE_IPC_HOOK_CLI= NODE_OPTIONS='--max_old_space_size=32384 --trace-warnings' ts-node ./ci/dev/watch.ts", "icons": "./ci/dev/gen_icons.sh" }, "main": "out/node/entry.js", "devDependencies": { "@eslint/compat": "^1.2.0", "@eslint/eslintrc": "^3.1.0", "@eslint/js": "^9.12.0", "@schemastore/package": "^0.0.10", "@types/compression": "^1.7.3", "@types/cookie-parser": "^1.4.4", "@types/eslint__js": "^8.42.3", "@types/express": "^5.0.0", "@types/http-proxy": "1.17.7", "@types/js-yaml": "^4.0.6", "@types/node": "22.x", "@types/pem": "^1.14.1", "@types/proxy-from-env": "^1.0.1", "@types/safe-compare": "^1.1.0", "@types/semver": "^7.5.2", "@types/trusted-types": "^2.0.4", "@types/ws": "^8.5.5", "doctoc": "^2.2.1", "eslint": "^9.12.0", "eslint-config-prettier": "^10.1.8", "eslint-import-resolver-typescript": "^4.4.4", "eslint-plugin-import": "^2.28.1", "eslint-plugin-prettier": "^5.0.0", "globals": "^16.1.0", "prettier": "3.6.2", "prettier-plugin-sh": "^0.18.0", "ts-node": "^10.9.1", "typescript": "^5.6.2", "typescript-eslint": "^8.8.0" }, "dependencies": { "@coder/logger": "^3.0.1", "argon2": "^0.44.0", "compression": "^1.7.4", "cookie-parser": "^1.4.6", "env-paths": "^2.2.1", "express": "^5.0.1", "http-proxy": "^1.18.1", "httpolyglot": "^0.1.2", "i18next": "^25.8.3", "js-yaml": "^4.1.0", "limiter": "^2.1.0", "pem": "^1.14.8", "proxy-agent": "^6.3.1", "qs": "^6.15.0", "rotating-file-stream": "^3.1.1", "safe-compare": "^1.1.4", "semver": "^7.5.4", "ws": "^8.14.2", "xdg-basedir": "^4.0.0" }, "resolutions": { "@types/node": "22.x" }, "bin": { "code-server": "out/node/entry.js" }, "keywords": [ "vscode", "development", "ide", "coder", "vscode-remote", "browser-ide", "remote-development" ], "engines": { "node": "22" }, "jest": { "transform": { "^.+\\.ts$": "/test/node_modules/ts-jest" }, "testEnvironment": "node", "testPathIgnorePatterns": [ "/node_modules/", "/lib/", "/out/", "test/e2e" ], "collectCoverage": true, "collectCoverageFrom": [ "/src/**/*.ts" ], "coverageDirectory": "/coverage", "coverageReporters": [ "json", "json-summary", "text", "clover" ], "coveragePathIgnorePatterns": [ "/out" ], "coverageThreshold": { "global": { "lines": 60 } }, "modulePathIgnorePatterns": [ "/release-packages", "/release", "/release-standalone", "/release-npm-package", "/release-gcp", "/release-images", "/lib" ], "moduleNameMapper": { "^.+\\.(css|less)$": "/test/utils/cssStub.ts" }, "globalSetup": "/test/utils/globalUnitSetup.ts" } } ================================================ FILE: patches/base-path.diff ================================================ Add base path support Some users will host code-server behind a path-rewriting reverse proxy, for example domain.tld/my/base/path. This patch adds support for that since Code assumes everything is on / by default. To test this serve code-server behind a reverse proxy with a path like /code. Index: code-server/lib/vscode/src/vs/base/common/network.ts =================================================================== --- code-server.orig/lib/vscode/src/vs/base/common/network.ts +++ code-server/lib/vscode/src/vs/base/common/network.ts @@ -245,7 +245,9 @@ class RemoteAuthoritiesImpl { return URI.from({ scheme: platform.isWeb ? this._preferredWebSchema : Schemas.vscodeRemoteResource, authority: `${host}:${port}`, - path: this._remoteResourcesPath, + path: platform.isWeb + ? (window.location.pathname + "/" + this._remoteResourcesPath).replace(/\/\/+/g, "/") + : this._remoteResourcesPath, query }); } Index: code-server/lib/vscode/src/vs/code/browser/workbench/workbench-dev.html =================================================================== --- code-server.orig/lib/vscode/src/vs/code/browser/workbench/workbench-dev.html +++ code-server/lib/vscode/src/vs/code/browser/workbench/workbench-dev.html @@ -11,8 +11,8 @@ - - + + @@ -27,9 +27,9 @@ - - - + + + @@ -39,7 +39,7 @@ ================================================ FILE: src/browser/robots.txt ================================================ User-agent: * Disallow: / ================================================ FILE: src/browser/security.txt ================================================ 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 ================================================ FILE: src/browser/serviceWorker.ts ================================================ 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. }) ================================================ FILE: src/common/emitter.ts ================================================ 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 = [] } } ================================================ FILE: src/common/http.ts ================================================ 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" } ================================================ FILE: src/common/util.ts ================================================ /** * 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}`) } } ================================================ FILE: src/node/app.ts ================================================ 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 ListenOptions = DefaultedArgs | SocketOptions 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 listen = async (server: http.Server, opts: ListenOptions) => { if (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 (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 (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) } } ================================================ FILE: src/node/cli.ts ================================================ import { field, Level, logger } from "@coder/logger" import { promises as fs } from "fs" import { load } from "js-yaml" import * as path from "path" import { 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 "disable-update-check"?: boolean "disable-file-downloads"?: boolean "disable-file-uploads"?: boolean "disable-workspace-trust"?: boolean "disable-getting-started-override"?: boolean "disable-proxy"?: boolean "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-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 /* 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-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).", }, "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.", }, } 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") } if (key === "idle-timeout-seconds" && Number(value) <= 60) { throw new Error("--idle-timeout-seconds must be greater than 60 seconds.") } const option = options[key] if (option.type === "boolean") { ;(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 (option.type === OptionalString && value === "false") { continue } if (option.path) { value = path.resolve(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"] = path.join(args["user-data-dir"], "code-server-ipc.sock") } 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_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 if (!args["app-name"]) { args["app-name"] = "code-server" } args._ = getResolvedPathsFromArgs(args) return { ...args, usingEnvPassword, usingEnvHashedPassword, } as DefaultedArgs // TODO: Technically no guarantee this is fulfilled. } 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 } function bindAddrFromAllSources(...argsConfig: UserProvidedArgs[]): Addr { let addr: Addr = { host: "localhost", port: 8080, } for (const args of argsConfig) { addr = bindAddrFromArgs(addr, args) } return addr } /** * 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 } /** * 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[] } /** * Convert our arguments to equivalent VS Code server arguments. * Does not add any extra arguments. */ export const toCodeArgs = async (args: DefaultedArgs): Promise => { return { ...args, /** Type casting. */ help: !!args.help, version: !!args.version, port: args.port?.toString(), log: args.log ? [args.log] : undefined, } } ================================================ FILE: src/node/constants.ts ================================================ import { logger } from "@coder/logger" import type { JSONSchemaForNPMPackageJsonFiles } from "@schemastore/package" import * as os from "os" import * as path from "path" export function getPackageJson(relativePath: string): JSONSchemaForNPMPackageJsonFiles { let pkg = {} try { pkg = require(relativePath) } catch (error: any) { logger.warn(error.message) } return pkg } 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, }) } ================================================ FILE: src/node/entry.ts ================================================ 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) }) ================================================ FILE: src/node/heart.ts ================================================ 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) } } } ================================================ FILE: src/node/http.ts ================================================ 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) } } /** * 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 (trustedOrigins.includes(origin) || trustedOrigins.includes("*")) { 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 } ================================================ FILE: src/node/i18n/index.ts ================================================ 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 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, }, 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, showSupportNotice: false, }) export default i18next ================================================ FILE: src/node/i18n/locales/en.json ================================================ { "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" } ================================================ FILE: src/node/i18n/locales/ja.json ================================================ { "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": "パスワードが間違っています。" } ================================================ FILE: src/node/i18n/locales/th.json ================================================ { "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": "รหัสผ่านไม่ถูกต้อง" } ================================================ FILE: src/node/i18n/locales/ur.json ================================================ { "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": "غلط پاس ورڈ" } ================================================ FILE: src/node/i18n/locales/zh-cn.json ================================================ { "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": "密码不正确" } ================================================ FILE: src/node/main.ts ================================================ 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() }, } } ================================================ FILE: src/node/proxy.ts ================================================ import proxyServer from "http-proxy" import { 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`) } }) // 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 } }) ================================================ FILE: src/node/routes/domainProxy.ts ================================================ 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}`, }) }) ================================================ FILE: src/node/routes/errors.ts ================================================ 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`) } ================================================ FILE: src/node/routes/health.ts ================================================ 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() }) }) ================================================ FILE: src/node/routes/index.ts ================================================ 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, } } ================================================ FILE: src/node/routes/login.ts ================================================ 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) } }) ================================================ FILE: src/node/routes/logout.ts ================================================ 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 }) }) ================================================ FILE: src/node/routes/pathProxy.ts ================================================ 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), }) } ================================================ FILE: src/node/routes/update.ts ================================================ 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), }) }) ================================================ FILE: src/node/routes/vscode.ts ================================================ 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", 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() } ================================================ FILE: src/node/settings.ts ================================================ 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 } ================================================ FILE: src/node/socket.ts ================================================ 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 } } ================================================ FILE: src/node/update.ts ================================================ 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" export interface Update { checked: number version: string } export interface LatestResponse { name: string } /** * Provide update information. */ export class UpdateProvider { private update?: Promise private updateInterval = 1000 * 60 * 60 * 24 // Milliseconds between update checks. 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, ) {} /** * 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)) } return this.update } 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", } } } /** * 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 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)) }) }) } 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"}`)) } 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)) } resolve(response) }) client.on("error", reject) } request(uri) }) } } ================================================ FILE: src/node/util.ts ================================================ 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 && 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]] } ================================================ FILE: src/node/vscodeSocket.ts ================================================ 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() }) } } ================================================ FILE: src/node/wrapper.ts ================================================ 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) } }) ================================================ FILE: src/node/wsRouter.ts ================================================ 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 }) ================================================ FILE: test/e2e/baseFixture.ts ================================================ 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 ================================================ FILE: test/e2e/codeServer.test.ts ================================================ 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() expect(await codeServerPage.page.isVisible("#terminal")).toBe(true) }) 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) }) }) ================================================ FILE: test/e2e/downloads.test.ts ================================================ 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") expect(await codeServerPage.page.isVisible("text=Download...")).toBe(true) }) 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.page.click(".tab") 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(true) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(true) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(true) }) }) 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") expect(await codeServerPage.page.isVisible("text=Download...")).toBe(false) }) 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.page.click(".tab") await codeServerPage.navigateMenus(["File", "Save As..."]) expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(false) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(false) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(false) }) }) ================================================ FILE: test/e2e/extensions/test-extension/.gitignore ================================================ /extension.js ================================================ FILE: test/e2e/extensions/test-extension/extension.ts ================================================ import * as vscode from "vscode" export function activate(context: vscode.ExtensionContext) { vscode.window.showInformationMessage("test extension loaded") // Test extension 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") } }), ) // asExternalUri extension 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.`) } }), ) } ================================================ FILE: test/e2e/extensions/test-extension/package.json ================================================ { "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" } ] }, "devDependencies": { "@types/vscode": "^1.56.0", "typescript": "^5.6.2" }, "scripts": { "build": "tsc" } } ================================================ FILE: test/e2e/extensions/test-extension/tsconfig.json ================================================ { "compilerOptions": { "target": "es2020", "module": "commonjs", "outDir": ".", "strict": true, "baseUrl": "./", "skipLibCheck": true }, "include": ["./extension.ts"], "exclude": ["node_modules"] } ================================================ FILE: test/e2e/extensions.test.ts ================================================ 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 codeServerPage.page.getByText(`Info: proxyUri: ${normalizedAddress}/proxy/{{port}}/`) }) } const flags = ["--disable-workspace-trust", "--extensions-dir", path.join(__dirname, "./extensions")] describe("Extensions", flags, {}, () => { runTestExtensionTests() }) 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. }) }) } ================================================ FILE: test/e2e/github.test.ts ================================================ 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. expect(await codeServerPage.page.isVisible("text=Select an account")).toBe(false) }) }) 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). expect(await codeServerPage.page.isVisible("text=GitHub Personal Access Token")).toBe(false) }) }) } else { base.describe("GitHub token", () => { base.skip("skipped because GITHUB_TOKEN is not set", () => { // Playwright will not show this without a function. }) }) } ================================================ FILE: test/e2e/login.test.ts ================================================ 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") await codeServerPage.page.waitForLoadState("networkidle") expect(await codeServerPage.page.isVisible("text=Missing password")) }) 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") expect(await codeServerPage.page.isVisible("text=Incorrect password")) }) test("should hit the rate limiter for too many unsuccessful logins", async ({ codeServerPage }) => { // Type in password await codeServerPage.page.fill(".password", "password123") // 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.click(".submit") await codeServerPage.page.waitForLoadState("networkidle") // We double-check that the correct error message shows // which should be for incorrect password expect(await codeServerPage.page.isVisible("text=Incorrect password")) } // The 15th should fail for a different reason: // login rate await codeServerPage.page.click(".submit") await codeServerPage.page.waitForLoadState("networkidle") expect(await codeServerPage.page.isVisible("text=Login rate limited!")) }) }) ================================================ FILE: test/e2e/logout.test.ts ================================================ // 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`) // }) // }) ================================================ FILE: test/e2e/models/CodeServer.ts ================================================ 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, "Machine"), { recursive: true }) await fs.writeFile( path.join(dir, "Machine/settings.json"), JSON.stringify({ "workbench.startupEditor": "none", }), "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 */ async waitForTestExtensionLoaded(): Promise { const selector = "text=test extension loaded" this.codeServer.logger.debug("Waiting for test extension to load...") await this.page.waitForSelector(selector) } /** * 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.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) } } ================================================ FILE: test/e2e/openHelpAbout.test.ts ================================================ 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() }) }) ================================================ FILE: test/e2e/routes.test.ts ================================================ 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") }) }) ================================================ FILE: test/e2e/terminal.test.ts ================================================ 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)) }) }) ================================================ FILE: test/e2e/uploads.test.ts ================================================ 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")') expect(await codeServerPage.page.isVisible("text=Upload...")).toBe(true) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(true) }) }) 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")') expect(await codeServerPage.page.isVisible("text=Upload...")).toBe(false) }) 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") expect(await codeServerPage.page.isVisible("text=Show Local")).toBe(false) }) }) ================================================ FILE: test/e2e/webview.test.ts ================================================ 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() }) }) ================================================ FILE: test/integration/help.test.ts ================================================ 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) }) ================================================ FILE: test/integration/installExtension.test.ts ================================================ 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") }) }) ================================================ FILE: test/package.json ================================================ { "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.56.1", "@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.56.1", "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" } } ================================================ FILE: test/playwright.config.ts ================================================ 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" }, // }, { name: "WebKit", use: { browserName: "webkit" }, }, ], } export default config ================================================ FILE: test/scripts/build-lib.bats ================================================ #!/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" ] } ================================================ FILE: test/scripts/install.bats ================================================ #!/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" } ================================================ FILE: test/scripts/steps-lib.bats ================================================ #!/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 ] } ================================================ FILE: test/tsconfig.json ================================================ { "extends": "../tsconfig.json", "include": ["./**/*.ts"] } ================================================ FILE: test/unit/common/emitter.test.ts ================================================ 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) }) }) ================================================ FILE: test/unit/common/http.test.ts ================================================ 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) }) }) }) ================================================ FILE: test/unit/common/util.test.ts ================================================ 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") }) }) }) ================================================ FILE: test/unit/helpers.test.ts ================================================ 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() }) }) ================================================ FILE: test/unit/node/app.test.ts ================================================ 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, 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) } }) }) ================================================ FILE: test/unit/node/cli.test.ts ================================================ import { Level, logger } from "@coder/logger" import { promises as fs } from "fs" import * as path from "path" import { UserProvidedArgs, bindAddrFromArgs, defaultConfigFile, 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": path.join(paths.data, "code-server-ipc.sock"), "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.VSCODE_PROXY_URI delete process.env.CS_DISABLE_PROXY 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"], ["--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", "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 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 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 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 ignore optional strings set to false", async () => { expect(parse(["--cert=false"])).toEqual({}) }) 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("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], }) }) }) 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'.`, ]) }) }) ================================================ FILE: test/unit/node/constants.test.ts ================================================ 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", }), ) }) }) }) ================================================ FILE: test/unit/node/heart.test.ts ================================================ import { logger } from "@coder/logger" import { readFile, writeFile, stat, utimes } from "fs/promises" import { Heart } from "../../../src/node/heart" import { clean, mockLogger, tmpdir } from "../../utils/helpers" const mockIsActive = (resolveTo: boolean) => jest.fn().mockResolvedValue(resolveTo) describe("Heart", () => { const testName = "heartTests" let testDir = "" let heart: Heart beforeAll(async () => { mockLogger() await clean(testName) testDir = await tmpdir(testName) }) beforeEach(() => { heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive(true)) }) afterAll(() => { jest.restoreAllMocks() }) 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, mockIsActive(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`, mockIsActive(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 () => { // Use fake timers so we can speed up setTimeout jest.useFakeTimers() heart = new Heart(`${testDir}/hello.txt`, mockIsActive(true)) await heart.beat() // we need to speed up clocks, timeouts // call heartbeat again (and it won't be alive I think) // then assert no warnings were called 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 isActive = true const mockIsActive = jest.fn().mockResolvedValue(isActive) 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 errorMsg = "oh no" const error = new Error(errorMsg) const mockIsActive = jest.fn().mockRejectedValue(error) const heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive) await heart.beat() jest.advanceTimersByTime(60 * 1000) expect(mockIsActive).toHaveBeenCalled() expect(logger.warn).toHaveBeenCalledWith(errorMsg) }) }) describe("stateChange", () => { const testName = "stateChange" let testDir = "" let heart: Heart beforeAll(async () => { await clean(testName) testDir = await tmpdir(testName) mockLogger() }) afterAll(() => { jest.restoreAllMocks() }) afterEach(() => { jest.resetAllMocks() if (heart) { heart.dispose() } }) it("should change to alive after a beat", async () => { heart = new Heart(`${testDir}/shutdown.txt`, mockIsActive(true)) const mockOnChange = jest.fn() heart.onChange(mockOnChange) await heart.beat() expect(mockOnChange.mock.calls[0][0]).toBe("alive") }) it.only("should change to expired when not active", async () => { jest.useFakeTimers() heart = new Heart(`${testDir}/shutdown.txt`, () => new Promise((resolve) => resolve(false))) const mockOnChange = jest.fn() heart.onChange(mockOnChange) await heart.beat() await jest.advanceTimersByTime(60 * 1000) expect(mockOnChange.mock.calls[1][0]).toBe("expired") jest.clearAllTimers() jest.useRealTimers() }) }) ================================================ FILE: test/unit/node/http.test.ts ================================================ 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("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. }, ].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: {}, }) 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) }) }) }) ================================================ FILE: test/unit/node/i18n.test.ts ================================================ import { promises as fs } from "fs" import * as os from "os" import * as path from "path" import { loadCustomStrings } from "../../../src/node/i18n" describe("i18n", () => { 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() }) }) }) ================================================ FILE: test/unit/node/main.test.ts ================================================ 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) }) }) }) ================================================ FILE: test/unit/node/proxy.test.ts ================================================ import * as express from "express" import * as http from "http" import nodeFetch from "node-fetch" import { HttpCode } from "../../../src/common/http" import { proxy } from "../../../src/node/proxy" import { wss, Router as WsRouter } from "../../../src/node/wsRouter" import { getAvailablePort, mockLogger } from "../../utils/helpers" import * as httpserver from "../../utils/httpserver" import * as integration from "../../utils/integration" describe("proxy", () => { const nhooyrDevServer = 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 nhooyrDevServer.listen((req, res) => { e(req, res) }) nhooyrDevServer.listenUpgrade(wsApp) proxyPath = `/proxy/${nhooyrDevServer.port()}/wsup` absProxyPath = proxyPath.replace("/proxy/", "/absproxy/") }) afterAll(async () => { await nhooyrDevServer.dispose() }) beforeEach(() => { e = express.default() mockLogger() }) 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) }) }) // NOTE@jsjoeio // Both this test suite and the one above it are very similar // The main difference is this one uses http and node-fetch // and specifically tests the proxy in isolation vs. using // the httpserver abstraction we've built. // // Leaving this as a separate test suite for now because // we may consider refactoring the httpserver abstraction // in the future. // // If you're writing a test specifically for code in // src/node/proxy.ts, you should probably add it to // this test suite. describe("proxy (standalone)", () => { let URL = "" let PROXY_URL = "" let testServer: http.Server let proxyTarget: http.Server beforeEach(async () => { const PORT = await getAvailablePort() const PROXY_PORT = await getAvailablePort() URL = `http://localhost:${PORT}` PROXY_URL = `http://localhost:${PROXY_PORT}` // Define server and a proxy server testServer = http.createServer((req, res) => { proxy.web(req, res, { target: PROXY_URL, }) }) proxyTarget = http.createServer((req, res) => { res.writeHead(200, { "Content-Type": "text/plain" }) res.end() }) // Start both servers proxyTarget.listen(PROXY_PORT) testServer.listen(PORT) }) afterEach(async () => { testServer.close() proxyTarget.close() }) it("should return a 500 when proxy target errors ", async () => { // Close the proxy target so that proxy errors proxyTarget.close() const errorResp = await nodeFetch(`${URL}/error`) expect(errorResp.status).toBe(HttpCode.ServerError) expect(errorResp.statusText).toBe("Internal Server Error") }) it("should proxy correctly", async () => { const resp = await nodeFetch(`${URL}/route`) expect(resp.status).toBe(200) expect(resp.statusText).toBe("OK") }) }) ================================================ FILE: test/unit/node/routes/errors.test.ts ================================================ 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("