Merge branch 'main' into patch-2

Author: jsjoeio

.eslintrc.yaml

@@ -36,11 +36,8 @@ rules:
   import/order:
     [error, { alphabetize: { order: "asc" }, groups: [["builtin", "external", "internal"], "parent", "sibling"] }]
   no-async-promise-executor: off
-  # This isn't a real module, just types, which apparently doesn't resolve.
-  import/no-unresolved: [error, { ignore: ["express-serve-static-core"] }]
 
 settings:
-  # Does not work with CommonJS unfortunately.
-  import/ignore:
-    - env-paths
-    - xdg-basedir
+  import/resolver:
+    typescript:
+      alwaysTryTypes: true

ci/dev/watch.ts

@@ -2,7 +2,7 @@ import { spawn, fork, ChildProcess } from "child_process"
 import del from "del"
 import { promises as fs } from "fs"
 import * as path from "path"
-import { CompilationStats, onLine, OnLineCallback, VSCodeCompileStatus } from "../../src/node/util"
+import { CompilationStats, onLine, OnLineCallback } from "../../src/node/util"
 
 interface DevelopmentCompilers {
   [key: string]: ChildProcess | undefined
@@ -52,24 +52,18 @@ class Watcher {
     plugins: this.paths.pluginDir ? spawn("yarn", ["build", "--watch"], { cwd: this.paths.pluginDir }) : undefined,
   }
 
-  private vscodeCompileStatus = VSCodeCompileStatus.Loading
-
   public async initialize(): Promise<void> {
     for (const event of ["SIGINT", "SIGTERM"]) {
       process.on(event, () => this.dispose(0))
     }
 
-    if (!this.hasVerboseLogging) {
-      console.log("\n[Watcher]", "Compiler logs will be minimal. Pass --log to show all output.")
-    }
-
     this.cleanFiles()
 
     for (const [processName, devProcess] of Object.entries(this.compilers)) {
       if (!devProcess) continue
 
       devProcess.on("exit", (code) => {
-        this.log(`[${processName}]`, "Terminated unexpectedly")
+        console.log(`[${processName}]`, "Terminated unexpectedly")
         this.dispose(code)
       })
 
@@ -91,33 +85,14 @@ class Watcher {
   //#region Line Parsers
 
   private parseVSCodeLine: OnLineCallback = (strippedLine, originalLine) => {
-    if (!strippedLine.includes("watch-extensions") || this.hasVerboseLogging) {
-      console.log("[VS Code]", originalLine)
-    }
+    if (!strippedLine.length) return
+
+    console.log("[VS Code]", originalLine)
 
-    switch (this.vscodeCompileStatus) {
-      case VSCodeCompileStatus.Loading:
-        // Wait for watch-client since "Finished compilation" will appear multiple
-        // times before the client starts building.
-        if (strippedLine.includes("Starting 'watch-client'")) {
-          console.log("[VS Code] 🚧 Compiling 🚧", "(This may take a moment!)")
-          this.vscodeCompileStatus = VSCodeCompileStatus.Compiling
-        }
-        break
-      case VSCodeCompileStatus.Compiling:
-        if (strippedLine.includes("Finished compilation")) {
-          console.log("[VS Code] ✨ Finished compiling! ✨", "(Refresh your web browser ♻️)")
-          this.vscodeCompileStatus = VSCodeCompileStatus.Compiled
-
-          this.emitCompilationStats()
-          this.reloadWebServer()
-        }
-        break
-      case VSCodeCompileStatus.Compiled:
-        console.log("[VS Code] 🔔 Finished recompiling! 🔔", "(Refresh your web browser ♻️)")
-        this.emitCompilationStats()
-        this.reloadWebServer()
-        break
+    if (strippedLine.includes("Finished compilation with")) {
+      console.log("[VS Code] ✨ Finished compiling! ✨", "(Refresh your web browser ♻️)")
+      this.emitCompilationStats()
+      this.reloadWebServer()
     }
   }
 
@@ -128,7 +103,6 @@ class Watcher {
 
     if (strippedLine.includes("Watching for file changes")) {
       console.log("[Compiler][Code Server]", "Finished compiling!", "(Refresh your web browser ♻️)")
-
       this.reloadWebServer()
     }
   }
@@ -153,11 +127,7 @@ class Watcher {
   private cleanFiles(): Promise<string[]> {
     console.log("[Watcher]", "Cleaning files from previous builds...")
 
-    return del([
-      "out/**/*",
-      // Included because the cache can sometimes enter bad state when debugging compiled files.
-      ".cache/**/*",
-    ])
+    return del(["out/**/*"])
   }
 
   /**
@@ -166,31 +136,22 @@ class Watcher {
    */
   private emitCompilationStats(): Promise<void> {
     const stats: CompilationStats = {
-      status: this.vscodeCompileStatus,
       lastCompiledAt: new Date(),
     }
 
-    this.log("Writing watcher stats...")
+    console.log("Writing watcher stats...")
     return fs.writeFile(this.paths.compilationStatsFile, JSON.stringify(stats, null, 2))
   }
 
-  private log(...entries: string[]) {
-    process.stdout.write(entries.join(" "))
-  }
-
   private dispose(code: number | null): void {
     for (const [processName, devProcess] of Object.entries(this.compilers)) {
-      this.log(`[${processName}]`, "Killing...\n")
+      console.log(`[${processName}]`, "Killing...\n")
       devProcess?.removeAllListeners()
       devProcess?.kill()
     }
     process.exit(typeof code === "number" ? code : 0)
   }
 
-  private get hasVerboseLogging() {
-    return process.argv.includes("--log")
-  }
-
   //#endregion
 }
 

docs/CONTRIBUTING.md

@@ -84,32 +84,31 @@ Here are these steps you should follow to get your dev environment setup:
 
 1. `git clone https://github.com/cdr/code-server.git` - Clone `code-server`
 2. `git clone https://github.com/cdr/vscode.git` - Clone `vscode`
-3. `cd vscode && git checkout code-server-v2` - checkout the branch we use (not the default)
-4. `cd vscode && yarn install` - install the dependencies in the `vscode` repo
-5. `cd code-server && yarn install` - install the dependencies in the `code-server` repo
-6. `cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package)
-7. `cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server
-8. `cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source.
+3. `cd vscode && yarn install` - install the dependencies in the `vscode` repo
+4. `cd code-server && yarn install` - install the dependencies in the `code-server` repo
+5. `cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package)
+6. `cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server
+7. `cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source.
 
 ### Updates to VS Code
 
-If changes are made and merged into `code-server-v2` in the `cdr/vscode` repo, then you'll need to update the version in the `code-server` repo by following these steps:
+If changes are made and merged into `main` in the [`cdr/vscode`](https://github.com/cdr/vscode) repo, then you'll need to update the version in the `code-server` repo by following these steps:
 
 1. Update the package tag listed in `vendor/package.json`:
 
 ```json
 {
   "devDependencies": {
-    "vscode": "cdr/vscode#X.XX.X-code-server"
+    "vscode": "cdr/vscode#<latest-commit-sha>"
   }
 }
 ```
 
-1. From the code-server **project root**, run `yarn install`.
+2. From the code-server **project root**, run `yarn install`.
    Then, test code-server locally to make sure everything works.
-1. Check the Node.js version that's used by Electron (which is shipped with VS
+3. Check the Node.js version that's used by Electron (which is shipped with VS
    Code. If necessary, update your version of Node.js to match.
-1. Open a PR
+4. Open a PR
 
 > Watch for updates to
 > `vendor/modules/code-oss-dev/src/vs/code/browser/workbench/workbench.html`. You may need to

docs/MAINTAINING.md

@@ -19,6 +19,7 @@
     - [Docker](#docker)
     - [Homebrew](#homebrew)
     - [npm](#npm)
+- [Syncing with Upstream VS Code](#syncing-with-upstream-vs-code)
 - [Testing](#testing)
 - [Documentation](#documentation)
   - [Troubleshooting](#troubleshooting)
@@ -126,8 +127,7 @@ the issue.
 
 ### Merge strategies
 
-For most things, we recommend the **squash and merge** strategy. If you're
-updating `lib/vscode`, we suggest using the **rebase and merge** strategy. There
+For most things, we recommend the **squash and merge** strategy. There
 may be times where **creating a merge commit** makes sense as well. Use your
 best judgment. If you're unsure, you can always discuss in the PR with the team.
 
@@ -215,6 +215,18 @@ We publish code-server as a npm package [here](https://www.npmjs.com/package/cod
 
 This is currently automated with the release process.
 
+## Syncing with Upstream VS Code
+
+The VS Code portion of code-server lives under [`cdr/vscode`](https://github.com/cdr/vscode). To update VS Code for code-server, follow these steps:
+
+1. `git checkout -b vscode-update` - Create a new branch locally based off `main`
+2. `git fetch upstream` - Fetch upstream (VS Code)'s latest `main` branch
+3. `git merge upstream/main` - Merge it locally
+   1. If there are merge conflicts, fix them locally
+4. Open a PR merging your branch (`vscode-update`) into `main` and add the code-server review team
+
+Ideally, our fork stays as close to upstream as possible. See the differences between our fork and upstream [here](https://github.com/microsoft/vscode/compare/main...cdr:main).
+
 ## Testing
 
 Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).

package.json

@@ -56,7 +56,7 @@
     "doctoc": "^2.0.0",
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.1.0",
-    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-prettier": "^4.0.0",
     "prettier": "^2.2.1",
@@ -94,7 +94,7 @@
     "pem": "^1.14.2",
     "proxy-agent": "^5.0.0",
     "proxy-from-env": "^1.1.0",
-    "qs": "6.10.1",
+    "qs": "6.10.2",
     "rotating-file-stream": "^3.0.0",
     "safe-buffer": "^5.1.1",
     "safe-compare": "^1.1.4",

src/node/entry.ts

@@ -1,32 +1,13 @@
 import { logger } from "@coder/logger"
 import { optionDescriptions, parse, readConfigFile, setDefaults, shouldOpenInExistingInstance } from "./cli"
-import { commit, pkgName, version } from "./constants"
+import { commit, version } from "./constants"
 import { openInExistingInstance, runCodeServer, runVsCodeCli, shouldSpawnCliProcess } from "./main"
 import { monkeyPatchProxyProtocols } from "./proxy_agent"
-import { loadAMDModule } from "./util"
 import { isChild, wrapper } from "./wrapper"
 
-const cliPipe = process.env["VSCODE_IPC_HOOK_CLI"] as string
-const cliCommand = process.env["VSCODE_CLIENT_COMMAND"] as string
-
 async function entry(): Promise<void> {
   monkeyPatchProxyProtocols()
 
-  if (cliPipe || cliCommand) {
-    const remoteAgentMain = await loadAMDModule<CodeServerLib.RemoteCLIMain>("vs/server/remoteCli", "main")
-
-    remoteAgentMain(
-      {
-        productName: pkgName,
-        version,
-        commit,
-        executableName: pkgName,
-      },
-      process.argv.slice(2),
-    )
-    return
-  }
-
   // 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

src/node/http.ts

@@ -4,7 +4,7 @@ import * as expressCore from "express-serve-static-core"
 import * as http from "http"
 import * as net from "net"
 import path from "path"
-import qs from "qs"
+import * as qs from "qs"
 import { Disposable } from "../common/emitter"
 import { CookieKeys, HttpCode, HttpError } from "../common/http"
 import { normalize } from "../common/util"

src/node/routes/pathProxy.ts

@@ -1,6 +1,6 @@
 import { Request, Response } from "express"
 import * as path from "path"
-import qs from "qs"
+import * as qs from "qs"
 import * as pluginapi from "../../../typings/pluginapi"
 import { HttpCode, HttpError } from "../../common/http"
 import { normalize } from "../../common/util"

src/node/util.ts

@@ -524,14 +524,7 @@ export const loadAMDModule = async <T>(amdPath: string, exportName: string): Pro
   return module[exportName] as T
 }
 
-export const enum VSCodeCompileStatus {
-  Loading = "Loading",
-  Compiling = "Compiling",
-  Compiled = "Compiled",
-}
-
 export interface CompilationStats {
-  status: VSCodeCompileStatus
   lastCompiledAt: Date
 }
 

src/node/wsRouter.ts

@@ -50,4 +50,5 @@ export function Router(): WebsocketRouter {
   return new WebsocketRouter()
 }
 
+// eslint-disable-next-line import/no-named-as-default-member -- the typings are not updated correctly
 export const wss = new Websocket.Server({ noServer: true })

test/unit/node/proxy.test.ts

@@ -1,4 +1,4 @@
-import bodyParser from "body-parser"
+import * as bodyParser from "body-parser"
 import * as express from "express"
 import * as http from "http"
 import nodeFetch from "node-fetch"

test/unit/node/test-plugin/.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  settings: {
+    "import/resolver": {
+      typescript: {
+        project: __dirname,
+      },
+    },
+  },
+}

test/unit/node/test-plugin/.eslintrc.yaml

@@ -7,6 +7,6 @@
     "postinstall": "./postinstall.sh"
   },
   "devDependencies": {
-    "code-oss-dev": "cdr/vscode#5e0c6f3b95ed032e62c49101ae502a46c62ef202"
+    "code-oss-dev": "cdr/vscode#c2a251c6afaa13fbebf97fcd8a68192f8cf46031"
   }
 }

vendor/package.json

@@ -296,9 +296,9 @@ clone-response@^1.0.2:
   dependencies:
     mimic-response "^1.0.0"
 
-code-oss-dev@cdr/vscode#5e0c6f3b95ed032e62c49101ae502a46c62ef202:
+code-oss-dev@cdr/vscode#c2a251c6afaa13fbebf97fcd8a68192f8cf46031:
   version "1.61.1"
-  resolved "https://codeload.github.com/cdr/vscode/tar.gz/5e0c6f3b95ed032e62c49101ae502a46c62ef202"
+  resolved "https://codeload.github.com/cdr/vscode/tar.gz/c2a251c6afaa13fbebf97fcd8a68192f8cf46031"
   dependencies:
     "@microsoft/applicationinsights-web" "^2.6.4"
     "@vscode/sqlite3" "4.0.12"