Merge branch 'main' into oxy/docker-buildx

Author: Akash Satheesan

.github/workflows/ci.yaml

@@ -409,7 +409,7 @@ jobs:
         uses: actions/checkout@v2
       - name: Run Trivy vulnerability scanner in repo mode
         #Commit SHA for v0.0.17
-        uses: aquasecurity/trivy-action@ac8de07fd168680dd0331bef43681c0e150e9ad1
+        uses: aquasecurity/trivy-action@9438b49cc3156b2e8c77c1ba8ffbaa3bae24e3c2
         with:
           scan-type: "fs"
           scan-ref: "."

docs/install.md

@@ -15,6 +15,11 @@
 - [Raspberry Pi](#raspberry-pi)
 - [Termux](#termux)
 - [Cloud providers](#cloud-providers)
+- [Uninstall](#uninstall)
+  - [install.sh](#installsh-1)
+  - [Homebrew](#homebrew)
+  - [yarn, npm](#yarn-npm-1)
+  - [Debian, Ubuntu](#debian-ubuntu-1)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -246,3 +251,54 @@ information.
 We maintain [one-click apps and install scripts for cloud
 providers](https://github.com/cdr/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-<version>` 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
+```
+
+### yarn, npm
+
+To remove the code-server global module, run:
+
+```shell
+yarn global remove code-server
+```
+
+or
+
+```shell
+npm uninstall -g code-server
+```
+
+### Debian, Ubuntu
+
+To uninstall, run:
+
+```shell
+sudo apt remove code-server
+```

docs/manifest.json

@@ -0,0 +1,88 @@
+{
+  "versions": ["v3.11.0", "v3.10.2"],
+  "routes": [
+    {
+      "title": "Home",
+      "description": "Learn how to install and run code-server.",
+      "path": "./README.md",
+      "icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16px\" xml:space=\"preserve\"><path d=\"M15.45,7L14,5.551V2c0-0.55-0.45-1-1-1h-1c-0.55,0-1,0.45-1,1v0.553L9,0.555C8.727,0.297,8.477,0,8,0S7.273,0.297,7,0.555  L0.55,7C0.238,7.325,0,7.562,0,8c0,0.563,0.432,1,1,1h1v6c0,0.55,0.45,1,1,1h3v-5c0-0.55,0.45-1,1-1h2c0.55,0,1,0.45,1,1v5h3  c0.55,0,1-0.45,1-1V9h1c0.568,0,1-0.437,1-1C16,7.562,15.762,7.325,15.45,7z\"></path></svg>"
+    },
+    {
+      "title": "Requirements",
+      "description": "Learn about what you need to run code-server.",
+      "icon": "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M6 2V11H2V15C2 16.7 3.3 18 5 18H15C16.7 18 18 16.7 18 15V2H6ZM16 15C16 15.6 15.6 16 15 16H8V4H16V15Z\" /><path d=\"M14 7H10V9H14V7Z\" /><path d=\"M14 11H10V13H14V11Z\" /></svg>",
+      "path": "./requirements.md"
+    },
+    {
+      "title": "Install",
+      "description": "How to install code-server.",
+      "icon": "<svg class=\"MuiSvgIcon-root jss172\" focusable=\"false\" viewBox=\"0 0 24 24\" aria-hidden=\"true\"><path d=\"M22.7 19l-9.1-9.1c.9-2.3.4-5-1.5-6.9-2-2-5-2.4-7.4-1.3L9 6 6 9 1.6 4.7C.4 7.1.9 10.1 2.9 12.1c1.9 1.9 4.6 2.4 6.9 1.5l9.1 9.1c.4.4 1 .4 1.4 0l2.3-2.3c.5-.4.5-1.1.1-1.4z\"></path></svg>",
+      "path": "./install.md",
+      "children": [
+        {
+          "title": "npm",
+          "description": "How to install code-server using npm or yarn",
+          "path": "./npm.md"
+        }
+      ]
+    },
+    {
+      "title": "Usage",
+      "description": "How to set up and use code-server.",
+      "icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6zm16-4H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z\"></path></svg>",
+      "path": "./guide.md",
+      "children": [
+        {
+          "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": "Upgrade",
+      "description": "How to upgrade code-server.",
+      "icon": "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M17.8049 2.19795C17.7385 2.1311 17.6587 2.07899 17.5708 2.04504C17.4829 2.01108 17.3889 1.99604 17.2948 2.00089C7.89216 2.49153 4.4188 10.8673 4.38528 10.9517C4.33624 11.0736 4.32406 11.2071 4.35028 11.3358C4.3765 11.4645 4.43995 11.5827 4.53274 11.6756L8.32449 15.4674C8.41787 15.5606 8.53669 15.6242 8.66606 15.6502C8.79543 15.6762 8.92959 15.6634 9.05174 15.6135C9.13552 15.5793 17.4664 12.0671 17.9986 2.7087C18.0039 2.61474 17.9895 2.5207 17.9561 2.4327C17.9227 2.3447 17.8712 2.26471 17.8049 2.19795ZM12.3314 9.56427C12.1439 9.75179 11.9051 9.87951 11.645 9.93126C11.385 9.98302 11.1154 9.9565 10.8704 9.85505C10.6254 9.7536 10.4161 9.58178 10.2687 9.36131C10.1214 9.14085 10.0428 8.88166 10.0428 8.6165C10.0428 8.35135 10.1214 8.09215 10.2687 7.87169C10.4161 7.65123 10.6254 7.47941 10.8704 7.37796C11.1154 7.27651 11.385 7.24998 11.645 7.30174C11.9051 7.3535 12.1439 7.48121 12.3314 7.66873C12.5827 7.92012 12.7239 8.26104 12.7239 8.6165C12.7239 8.97197 12.5827 9.31288 12.3314 9.56427Z\"/><path d=\"M2.74602 14.5444C2.92281 14.3664 3.133 14.2251 3.36454 14.1285C3.59608 14.0319 3.8444 13.9819 4.09529 13.9815C4.34617 13.9811 4.59466 14.0302 4.82653 14.126C5.05839 14.2218 5.26907 14.3624 5.44647 14.5398C5.62386 14.7172 5.7645 14.9279 5.86031 15.1598C5.95612 15.3916 6.00522 15.6401 6.00479 15.891C6.00437 16.1419 5.95442 16.3902 5.85782 16.6218C5.76122 16.8533 5.61987 17.0635 5.44186 17.2403C4.69719 17.985 2 18.0004 2 18.0004C2 18.0004 2 15.2884 2.74602 14.5444Z\"/><path d=\"M8.9416 3.48269C7.99688 3.31826 7.02645 3.38371 6.11237 3.67352C5.19828 3.96332 4.36741 4.46894 3.68999 5.14765C3.33153 5.50944 3.01988 5.91477 2.76233 6.35415C2.68692 6.4822 2.6562 6.63169 2.67501 6.77911C2.69381 6.92652 2.76108 7.06351 2.86623 7.16853L4.1994 8.50238C5.43822 6.53634 7.04911 4.83119 8.9416 3.48269Z\"/><path d=\"M16.5181 11.0585C16.6825 12.0033 16.6171 12.9737 16.3273 13.8878C16.0375 14.8019 15.5318 15.6327 14.8531 16.3101C14.4914 16.6686 14.086 16.9803 13.6466 17.2378C13.5186 17.3132 13.3691 17.3439 13.2217 17.3251C13.0743 17.3063 12.9373 17.2391 12.8323 17.1339L11.4984 15.8007C13.4645 14.5619 15.1696 12.951 16.5181 11.0585Z\"/></svg>",
+      "path": "./upgrade.md"
+    },
+    {
+      "title": "FAQ",
+      "description": "Frequently asked questions on installing and running code-server.",
+      "icon": "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M10.0001 18.3333C14.6025 18.3333 18.3334 14.6024 18.3334 10C18.3334 5.39762 14.6025 1.66666 10.0001 1.66666C5.39771 1.66666 1.66675 5.39762 1.66675 10C1.66675 14.6024 5.39771 18.3333 10.0001 18.3333Z\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M7.57495 7.5C7.77087 6.94306 8.15758 6.47342 8.66658 6.17428C9.17558 5.87513 9.77403 5.76578 10.3559 5.86559C10.9378 5.96541 11.4656 6.26794 11.8458 6.71961C12.2261 7.17128 12.4342 7.74294 12.4333 8.33333C12.4333 10 9.93328 10.8333 9.93328 10.8333\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M10 14.1667H10.0083\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/></svg>",
+      "path": "./FAQ.md"
+    },
+    {
+      "title": "Contributing",
+      "description": "How to contribute to code-server.",
+      "icon": "<svg width=\"20\" height=\"20\" fill=\"none\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M5 2.5V12.5\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M15 7.5C16.3807 7.5 17.5 6.38071 17.5 5C17.5 3.61929 16.3807 2.5 15 2.5C13.6193 2.5 12.5 3.61929 12.5 5C12.5 6.38071 13.6193 7.5 15 7.5Z\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M5 17.5C6.38071 17.5 7.5 16.3807 7.5 15C7.5 13.6193 6.38071 12.5 5 12.5C3.61929 12.5 2.5 13.6193 2.5 15C2.5 16.3807 3.61929 17.5 5 17.5Z\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/><path d=\"M15 7.5C15 9.48912 14.2098 11.3968 12.8033 12.8033C11.3968 14.2098 9.48912 15 7.5 15\" stroke=\"currentColor\" fill=\"none\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/></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"
+        }
+      ]
+    }
+  ]
+}

package.json

@@ -96,7 +96,7 @@
     "pem": "^1.14.2",
     "proxy-agent": "^5.0.0",
     "proxy-from-env": "^1.1.0",
-    "qs": "6.7.0",
+    "qs": "6.10.1",
     "rotating-file-stream": "^2.1.1",
     "safe-buffer": "^5.1.1",
     "safe-compare": "^1.1.4",

src/browser/register.ts

@@ -5,7 +5,7 @@ export async function registerServiceWorker(): Promise<void> {
   const options = getOptions()
   logger.level = options.logLevel
 
-  const path = normalize(`${options.csStaticBase}/dist/serviceWorker.js`)
+  const path = normalize(`${options.csStaticBase}/out/browser/serviceWorker.js`)
   try {
     await navigator.serviceWorker.register(path, {
       scope: options.base + "/",

src/node/proxy_agent.ts

@@ -62,7 +62,7 @@ function newProxyAgent(inVSCode: boolean): http.Agent {
 
 // If they have $NO_PROXY set to example.com then this check won't work!
 // But that's drastically unlikely.
-function shouldEnableProxy(): boolean {
+export function shouldEnableProxy(): boolean {
   let shouldEnable = false
 
   const httpProxy = proxyFromEnv.getProxyForUrl(`http://example.com`)

test/unit/browser/register.test.ts

@@ -155,7 +155,7 @@ describe("register", () => {
       await registerServiceWorker()
 
       expect(mockFn).toBeCalled()
-      expect(serviceWorkerPath).toMatch(`${csStaticBasePath}/dist/serviceWorker.js`)
+      expect(serviceWorkerPath).toMatch(`${csStaticBasePath}/out/browser/serviceWorker.js`)
       expect(serviceWorkerScope).toMatch("/")
     })
     it("should register when options.base is defined", async () => {
@@ -176,7 +176,7 @@ describe("register", () => {
       await registerServiceWorker()
 
       expect(mockFn).toBeCalled()
-      expect(serviceWorkerPath).toMatch(`/dist/serviceWorker.js`)
+      expect(serviceWorkerPath).toMatch(`/out/browser/serviceWorker.js`)
       expect(serviceWorkerScope).toMatch("/")
     })
   })

test/unit/helpers.test.ts

@@ -1,5 +1,5 @@
 import { promises as fs } from "fs"
-import { tmpdir } from "../../test/utils/helpers"
+import { tmpdir, useEnv } from "../../test/utils/helpers"
 
 /**
  * This file is for testing test helpers (not core code).
@@ -12,3 +12,30 @@ describe("test helpers", () => {
     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")
+  })
+})

test/unit/node/proxy_agent.test.ts

@@ -0,0 +1,39 @@
+import { shouldEnableProxy } from "../../../src/node/proxy_agent"
+import { useEnv } from "../../utils/helpers"
+
+describe("shouldEnableProxy", () => {
+  const [setHTTPProxy, resetHTTPProxy] = useEnv("HTTP_PROXY")
+  const [setHTTPSProxy, resetHTTPSProxy] = useEnv("HTTPS_PROXY")
+  const [setNoProxy, resetNoProxy] = useEnv("NO_PROXY")
+
+  beforeEach(() => {
+    jest.resetModules() // Most important - it clears the cache
+    resetHTTPProxy()
+    resetNoProxy()
+    resetHTTPSProxy()
+  })
+
+  it("returns true when HTTP_PROXY is set", () => {
+    setHTTPProxy("http://proxy.example.com")
+    expect(shouldEnableProxy()).toBe(true)
+  })
+  it("returns true when HTTPS_PROXY is set", () => {
+    setHTTPSProxy("https://proxy.example.com")
+    expect(shouldEnableProxy()).toBe(true)
+  })
+  it("returns false when NO_PROXY is set", () => {
+    setNoProxy("*")
+    expect(shouldEnableProxy()).toBe(false)
+  })
+  it("should return false when neither HTTP_PROXY nor HTTPS_PROXY is set", () => {
+    expect(shouldEnableProxy()).toBe(false)
+  })
+  it("should return false when NO_PROXY is set to https://example.com", () => {
+    setNoProxy("https://example.com")
+    expect(shouldEnableProxy()).toBe(false)
+  })
+  it("should return false when NO_PROXY is set to http://example.com", () => {
+    setNoProxy("http://example.com")
+    expect(shouldEnableProxy()).toBe(false)
+  })
+})

test/utils/helpers.ts

@@ -37,3 +37,27 @@ export async function tmpdir(testName: string): Promise<string> {
 
   return await fs.mkdtemp(path.join(dir, `${testName}-`), { encoding: "utf8" })
 }
+
+/**
+ * @description Helper function to use an environment variable.
+ *
+ * @returns an array (similar to useState in React) with a function
+ * to set the value and reset the value
+ */
+export function useEnv(key: string): [(nextValue: string | undefined) => string | undefined, () => void] {
+  const initialValue = process.env[key]
+  const setValue = (nextValue: string | undefined) => (process.env[key] = nextValue)
+  // Node automatically converts undefined to string 'undefined'
+  // when assigning an environment variable.
+  // which is why we need to delete it if it's supposed to be undefined
+  // Source: https://stackoverflow.com/a/60147167
+  const resetValue = () => {
+    if (initialValue !== undefined) {
+      process.env[key] = initialValue
+    } else {
+      delete process.env[key]
+    }
+  }
+
+  return [setValue, resetValue]
+}