Merge branch 'main' into code-update-1.68

Author: code-asher

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -66,11 +66,13 @@ body:
       required: false
   - type: checkboxes
     attributes:
-      label: Does this issue happen in VS Code?
-      description: Please try reproducing this issue in VS Code
+      label: Does this issue happen in VS Code or GitHub Codespaces?
+      description: Please try reproducing this issue in VS Code or GitHub Codespaces
       options:
         - label: I cannot reproduce this in VS Code.
           required: true
+        - label: I cannot reproduce this in GitHub Codespaces.
+          required: true
   - type: checkboxes
     attributes:
       label: Are you accessing code-server over HTTPS?

.github/workflows/ci.yaml

@@ -509,7 +509,7 @@ jobs:
           fetch-depth: 0
 
       - name: Run Trivy vulnerability scanner in repo mode
-        uses: aquasecurity/trivy-action@df3fb7d00b594d641478ba45b867f5cbb32108be
+        uses: aquasecurity/trivy-action@e27605859b9550f81ddd818eb816c8cb83cf9650
         with:
           scan-type: "fs"
           scan-ref: "."

.github/workflows/docker.yaml

@@ -47,11 +47,11 @@ jobs:
         run: echo "::set-output name=version::$(jq -r .version package.json)"
 
       - name: Download release artifacts
-        uses: robinraju/release-downloader@v1.3
+        uses: robinraju/release-downloader@v1.4
         with:
           repository: "coder/code-server"
           tag: v${{ steps.version.outputs.version }}
-          fileName: "*"
+          fileName: "*.deb"
           out-file-path: "release-packages"
 
       - name: Publish to Docker

.github/workflows/trivy-docker.yaml

@@ -51,7 +51,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Run Trivy vulnerability scanner in image mode
-        uses: aquasecurity/trivy-action@df3fb7d00b594d641478ba45b867f5cbb32108be
+        uses: aquasecurity/trivy-action@e27605859b9550f81ddd818eb816c8cb83cf9650
         with:
           image-ref: "docker.io/codercom/code-server:latest"
           ignore-unfixed: true

docs/README.md

@@ -14,8 +14,9 @@ access it in the browser.
 - Preserve battery life when you're on the go; all intensive tasks run on your
   server
 
-| 🔔 code-server is a free browser-based IDE while [Coder](https://coder.com/) is our enterprise developer workspace platform. For more information, visit [Coder.com](https://coder.com/docs/comparison)
-| ---
+> **Note**
+> To manage multiple IDEs, workspaces, and teams, see
+> our new project: [coder/coder](http://cdr.co/coder-github)
 
 ## Requirements
 

package.json

@@ -100,7 +100,7 @@
     "limiter": "^1.1.5",
     "pem": "^1.14.2",
     "proxy-agent": "^5.0.0",
-    "qs": "6.10.3",
+    "qs": "6.10.5",
     "rotating-file-stream": "^3.0.0",
     "safe-buffer": "^5.1.1",
     "safe-compare": "^1.1.4",

src/node/util.ts

@@ -377,11 +377,62 @@ export const getMediaMime = (filePath?: string): string => {
   return (filePath && mimeTypes[path.extname(filePath)]) || "text/plain"
 }
 
-export const isWsl = async (): Promise<boolean> => {
-  return (
-    (process.platform === "linux" && os.release().toLowerCase().indexOf("microsoft") !== -1) ||
-    (await fs.readFile("/proc/version", "utf8")).toLowerCase().indexOf("microsoft") !== -1
-  )
+/**
+ * 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<boolean> => {
+  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,
+  }
 }
 
 /**
@@ -396,16 +447,10 @@ export const open = async (address: URL | string): Promise<void> => {
   if (url.hostname === "0.0.0.0") {
     url.hostname = "localhost"
   }
-  const args = [] as string[]
-  const options = {} as cp.SpawnOptions
-  const platform = (await isWsl()) ? "wsl" : process.platform
-  let command = platform === "darwin" ? "open" : "xdg-open"
-  if (platform === "win32" || platform === "wsl") {
-    command = platform === "wsl" ? "cmd.exe" : "cmd"
-    args.push("/c", "start", '""', "/b")
-    url.search = url.search.replace(/&/g, "^&")
-  }
-  const proc = cp.spawn(command, [...args, url.toString()], options)
+  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<void>((resolve, reject) => {
     proc.on("error", reject)
     proc.on("close", (code) => {

test/unit/node/util.test.ts

@@ -4,6 +4,7 @@ import * as path from "path"
 import { generateUuid } from "../../../src/common/util"
 import { tmpdir } from "../../../src/node/constants"
 import * as util from "../../../src/node/util"
+import { clean, tmpdir as tempDirHelper } from "../../utils/helpers"
 
 describe("getEnvPaths", () => {
   describe("on darwin", () => {
@@ -482,3 +483,98 @@ describe("humanPath", () => {
     expect(actual).toBe(expected)
   })
 })
+
+describe("isWsl", () => {
+  const testName = "wsl"
+
+  beforeAll(async () => {
+    await clean(testName)
+  })
+
+  describe("on Linux (microsoft)", () => {
+    it("should return true", async () => {
+      const fileName = "proc-version"
+      const osRelease = "5.4.0-1066-gke"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      await fs.writeFile(
+        pathToFile,
+        "Linux version 3.4.0-Microsoft (Microsoft@Microsoft.com) (gcc version 4.7 (GCC) ) #1 SMP PREEMPT Wed Dec 31 14:42:53 PST 2014",
+      )
+      expect(await util.isWsl("linux", osRelease, pathToFile)).toBe(true)
+    })
+  })
+  describe("on Linux (non-microsoft)", () => {
+    it("should return false", async () => {
+      const fileName = "proc-version2"
+      const osRelease = "Linux"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      await fs.writeFile(
+        pathToFile,
+        "Linux version 5.4.0-1066-gke (buildd@lcy02-amd64-039) (gcc version 9.4.0 (Ubuntu 9.4.0-1ubuntu1~20.04)) #69-Ubuntu SMP Fri Mar 11 13:52:45 UTC 202",
+      )
+      expect(await util.isWsl("linux", osRelease, pathToFile)).toBe(false)
+    })
+  })
+  describe("on Win32 with microsoft in /proc/version", () => {
+    it("should return false", async () => {
+      const fileName = "proc-version3"
+      const osRelease = "3.4.0-Microsoft"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      await fs.writeFile(
+        pathToFile,
+        "Linux version 3.4.0-Microsoft (Microsoft@Microsoft.com) (gcc version 4.7 (GCC) ) #1 SMP PREEMPT Wed Dec 31 14:42:53 PST 2014",
+      )
+      expect(await util.isWsl("win32", osRelease, pathToFile)).toBe(false)
+    })
+  })
+  describe("on Darwin", () => {
+    it("should return false", async () => {
+      const fileName = "proc-version4"
+      const osRelease =
+        "Darwin Roadrunner.local 10.3.0 Darwin Kernel Version 10.3.0: Fri Feb 26 11:58:09 PST 2010; root:xnu-1504.3.12~1/RELEASE_I386 i386"
+      const pathToFile = path.join(await tempDirHelper(testName), fileName)
+      expect(await util.isWsl("darwin", osRelease, pathToFile)).toBe(false)
+    })
+  })
+})
+
+describe("open", () => {
+  it("should throw an error if address is a string", async () => {
+    const address = "localhost:3000"
+    await expect(util.open(address)).rejects.toThrow("Cannot open socket paths")
+  })
+})
+describe("constructOpenOptions", () => {
+  it("should return options for darwin", () => {
+    const platform: NodeJS.Platform | "wsl" = "darwin"
+    const url = new URL("localhost:8080")
+    const { args, command, urlSearch } = util.constructOpenOptions(platform, url.search)
+    expect(args).toStrictEqual([])
+    expect(command).toBe("open")
+    expect(urlSearch).toBe("")
+  })
+  it("should return options for linux", () => {
+    const platform: NodeJS.Platform | "wsl" = "linux"
+    const url = new URL("localhost:8080")
+    const { args, command, urlSearch } = util.constructOpenOptions(platform, url.search)
+    expect(args).toStrictEqual([])
+    expect(command).toBe("xdg-open")
+    expect(urlSearch).toBe("")
+  })
+  it("should return options for win32", () => {
+    const platform: NodeJS.Platform | "wsl" = "win32"
+    const url = new URL("localhost:8080?q=&test")
+    const { args, command, urlSearch } = util.constructOpenOptions(platform, url.search)
+    expect(args).toStrictEqual(["/c", "start", '""', "/b"])
+    expect(command).toBe("cmd")
+    expect(urlSearch).toBe("?q=^&test")
+  })
+  it("should return options for wsl", () => {
+    const platform: NodeJS.Platform | "wsl" = "wsl"
+    const url = new URL("localhost:8080?q=&test")
+    const { args, command, urlSearch } = util.constructOpenOptions(platform, url.search)
+    expect(args).toStrictEqual(["/c", "start", '""', "/b"])
+    expect(command).toBe("cmd.exe")
+    expect(urlSearch).toBe("?q=^&test")
+  })
+})

yarn.lock

@@ -3513,10 +3513,10 @@ punycode@^2.1.0:
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec"
   integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==
 
-qs@6.10.3:
-  version "6.10.3"
-  resolved "https://registry.yarnpkg.com/qs/-/qs-6.10.3.tgz#d6cde1b2ffca87b5aa57889816c5f81535e22e8e"
-  integrity sha512-wr7M2E0OFRfIfJZjKGieI8lBKb7fRCH4Fv5KNPEs7gJ8jadvotdsS08PzOKR7opXhZ/Xkjtt3WF9g38drmyRqQ==
+qs@6.10.5:
+  version "6.10.5"
+  resolved "https://registry.yarnpkg.com/qs/-/qs-6.10.5.tgz#974715920a80ff6a262264acd2c7e6c2a53282b4"
+  integrity sha512-O5RlPh0VFtR78y79rgcgKK4wbAI0C5zGVLztOIdpWX6ep368q5Hv6XRxDvXuZ9q3C6v+e3n8UfZZJw7IIG27eQ==
   dependencies:
     side-channel "^1.0.4"