Merge branch 'main' into renovate/minor-dependency-updates

Author: jsjoeio

ci/dev/watch.ts

@@ -106,19 +106,10 @@ class Watcher {
       plugin.stderr.on("data", (d) => process.stderr.write(d))
     }
 
-    let startingVscode = false
-    let startedVscode = false
     onLine(vscode, (line, original) => {
       console.log("[vscode]", original)
-      // Wait for watch-client since "Finished compilation" will appear multiple
-      // times before the client starts building.
-      if (!startingVscode && line.includes("Starting watch-client")) {
-        startingVscode = true
-      } else if (startingVscode && line.includes("Finished compilation")) {
-        if (startedVscode) {
-          restartServer()
-        }
-        startedVscode = true
+      if (line.includes("Finished compilation")) {
+        restartServer()
       }
     })
 

ci/helm-chart/templates/NOTES.txt

@@ -15,9 +15,8 @@
   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 }}
-  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "code-server.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
   echo "Visit http://127.0.0.1:8080 to use your application"
-  kubectl port-forward $POD_NAME 8080:80
+  kubectl port-forward --namespace {{ .Release.Namespace }} service/{{ include "code-server.fullname" . }} 8080:http
 {{- end }}
 
 Administrator credentials:

docs/CONTRIBUTING.md

@@ -9,6 +9,7 @@
 - [Development workflow](#development-workflow)
   - [Updates to VS Code](#updates-to-vs-code)
   - [Build](#build)
+  - [Help](#help)
 - [Test](#test)
   - [Unit tests](#unit-tests)
   - [Script tests](#script-tests)
@@ -77,16 +78,23 @@ we'll guide you.
 
 ## Development workflow
 
-```shell
-yarn
-yarn watch
-# Visit http://localhost:8080 once the build is completed.
-```
+The current development workflow is a bit tricky because we have this repo and we use our `cdr/vscode` fork inside it with [`yarn link`](https://classic.yarnpkg.com/lang/en/docs/cli/link/).
+
+Here are these steps you should follow to get your dev environment setup:
 
-`yarn watch` will live reload changes to the source.
+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.
 
 ### 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:
+
 1. Update the package tag listed in `vendor/package.json`:
 
 ```json
@@ -97,7 +105,7 @@ yarn watch
 }
 ```
 
-2. From the code-server **project root**, run `yarn install`.
+1. 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
    Code. If necessary, update your version of Node.js to match.
@@ -139,6 +147,10 @@ yarn package
 > If you need your builds to support older distros, run the build commands
 > inside a Docker container with all the build requirements installed.
 
+### Help
+
+If you get stuck or need help, you can always start a new GitHub Discussion [here](https://github.com/cdr/code-server/discussions). One of the maintainers will respond and help you out.
+
 ## Test
 
 There are four kinds of tests in code-server:

docs/termux.md

@@ -5,67 +5,144 @@
 - [Install](#install)
 - [Upgrade](#upgrade)
 - [Known Issues](#known-issues)
-  - [Search doesn't work](#search-doesnt-work)
-  - [Backspace doesn't work](#backspace-doesnt-work)
+  - [Git won't work in `/sdcard`](#git-wont-work-in-sdcard)
+- [Extra](#extra)
+  - [Create a new user](#create-a-new-user)
+  - [Install Go](#install-go)
+  - [Install Python](#install-python)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-Termux is a terminal application and Linux environment that you can also use to
-run code-server from your Android phone.
-
 ## Install
 
-1. Install Termux from [F-Droid](https://f-droid.org/en/packages/com.termux/).
-1. Make sure it's up-to-date: `apt update && apt upgrade`
-1. Install required packages: `apt install build-essential python git nodejs-lts yarn`
-1. Install code-server: `yarn global add code-server`
-1. Run code-server: `code-server` and navigate to localhost:8080 in your browser
+1. Get [Termux](https://f-droid.org/en/packages/com.termux/) from **F-Droid**.
+2. Install Debian by running the following.
+   - Run `termux-setup-storage` to allow storage access, or else code-server won't be able to read from `/sdcard`.\
+      If you used the Andronix command then you may have to edit the `start-debian.sh` script to mount `/sdcard` just as simple as uncommenting the `command+=" -b /sdcard"` line.
+     > The following command was extracted from [Andronix](https://andronix.app/) you can also use [proot-distro](https://github.com/termux/proot-distro).
+     > After Debian is installed the `~ $` will change to `root@localhost`.
+
+```bash
+pkg update -y && pkg install wget curl proot tar -y && wget https://raw.githubusercontent.com/AndronixApp/AndronixOrigin/master/Installer/Debian/debian.sh -O debian.sh && chmod +x debian.sh && bash debian.sh
+```
+
+3. Run the following commands to setup Debian.
+
+```bash
+apt update
+apt upgrade -y
+apt-get install nano vim sudo curl wget git -y
+```
+
+4. Install [NVM](https://github.com/nvm-sh/nvm) by following the install guide in the README, just a curl/wget command.
+5. Set up NVM for multi-user. After installing NVM it automatically adds the necessary commands for it to work, but it will only work if you are logged in as root;
+
+   - Copy the lines NVM asks you to run after running the install script.
+   - Run `nano /root/.bashrc` and comment out those lines by adding a `#` at the start.
+   - Run `nano /etc/profile` and paste those lines at the end and make sure to replace `$HOME` with `/root`
+   - Now run `exit` and start Debain again.
+
+6. After following the instructions and setting up NVM you can now install the [required node version](https://coder.com/docs/code-server/latest/npm#nodejs-version) using `nvm install version_here`.
+7. To install `code-server` run the following.
+   > To check the install process (Will not actually install code-server)
+   > If it all looks good, you can install code-server by running the second command
+
+```bash
+curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
+```
+
+```bash
+curl -fsSL https://code-server.dev/install.sh | sh
+```
+
+8. You can now start code server by simply running `code-server`.
+
+> Consider using a new user instead of root, read [here](https://www.howtogeek.com/124950/htg-explains-why-you-shouldnt-log-into-your-linux-system-as-root/) why using root is not recommended.\
+> Learn how to add a user [here](#create-a-new-user).
 
 ## Upgrade
 
-To upgrade run: `yarn global upgrade code-server --latest`
+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
 
-The following details known issues and suggested workarounds for using
-code-server with Termux.
+### 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)
+
+## Extra
+
+### Create a new user
+
+To create a new user follow these simple steps -
+
+1. Create a new user by running `useradd username -m`.
+2. Change the password by running `passwd username`.
+3. Give your new user sudo access by runnning `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 commadline 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 - username`
+
+- 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
 
-### Search doesn't work
+> From https://golang.org/doc/install
 
-There is a known issue with search not working on Android because it's missing
-`bin/rg` ([context](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979)). To fix this:
+1. Go to https://golang.org/dl/ and copy the download link for `linux arm` and run the following.
 
-1. Install `ripgrep` with `pkg`
+```bash
+wget download_link
+```
 
-   ```sh
-   pkg install ripgrep
-   ```
+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)
 
-1. Make a soft link using `ln -s`
+```bash
+rm -rf /usr/local/go && tar -C /usr/local -xzf archive_name
+```
 
-   ```sh
-   # run this command inside the code-server directory
-   ln -s $PREFIX/bin/rg ./vendor/modules/code-oss-dev/vscode-ripgrep/bin/rg
-   ```
+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`
 
-### Backspace doesn't work
+### Install Python
 
-When using Android's on-screen keyboard, the backspace key doesn't work
-properly. This is a known upstream issue:
+> Run these commands as root
 
-- [Issues with backspace in Codespaces on Android (Surface Duo)](https://github.com/microsoft/vscode/issues/107602)
-- [Support mobile platforms](https://github.com/xtermjs/xterm.js/issues/1101)
+1. Run the following command to install required packages to build python.
 
-There are two workarounds.
+```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
+```
 
-**Option 1:** Modify keyboard dispatch settings
+2. Install [pyenv](https://github.com/pyenv/pyenv/) from [pyenv-installer](https://github.com/pyenv/pyenv-installer) by running.
 
-1. Open the Command Palette
-2. Search for **Preferences: Open Settings (JSON)**
-3. Add `"keyboard.dispatch": "keyCode"`
+```bash
+curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash
+```
 
-The backspace button should work at this point.
+3. Run `nano /etc/profile` and add the following
 
-_Thanks to @Nefomemes for the [suggestion](https://github.com/cdr/code-server/issues/1141#issuecomment-789463707)!_
+```bash
+export PYENV_ROOT="/root/.pyenv"
+export PATH="/root/.pyenv/bin:$PATH"
+eval "$(pyenv init --path)"
+eval "$(pyenv virtualenv-init -)"
+```
 
-**Option 2:** Use a Bluetooth keyboard.
+4. Exit 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`.

src/node/cli.ts

@@ -606,7 +606,7 @@ export async function readConfigFile(configPath?: string): Promise<ConfigArgs> {
     await fs.writeFile(configPath, defaultConfigFile(generatedPassword), {
       flag: "wx", // wx means to fail if the path exists.
     })
-    logger.info(`Wrote default config file to ${humanPath(configPath)}`)
+    logger.info(`Wrote default config file to ${humanPath(os.homedir(), configPath)}`)
   } catch (error: any) {
     // EEXIST is fine; we don't want to overwrite existing configurations.
     if (error.code !== "EEXIST") {

src/node/main.ts

@@ -1,4 +1,5 @@
 import { field, logger } from "@coder/logger"
+import * as os from "os"
 import http from "http"
 import path from "path"
 import { Disposable } from "../common/emitter"
@@ -95,8 +96,8 @@ export const runCodeServer = async (
 ): Promise<{ dispose: Disposable["dispose"]; server: http.Server }> => {
   logger.info(`code-server ${version} ${commit}`)
 
-  logger.info(`Using user-data-dir ${humanPath(args["user-data-dir"])}`)
-  logger.trace(`Using extensions-dir ${humanPath(args["extensions-dir"])}`)
+  logger.info(`Using user-data-dir ${humanPath(os.homedir(), args["user-data-dir"])}`)
+  logger.trace(`Using extensions-dir ${humanPath(os.homedir(), args["extensions-dir"])}`)
 
   if (args.auth === AuthType.Password && !args.password && !args["hashed-password"]) {
     throw new Error(
@@ -109,7 +110,7 @@ export const runCodeServer = async (
   const serverAddress = ensureAddress(app.server, protocol)
   const disposeRoutes = await register(app, args)
 
-  logger.info(`Using config file ${humanPath(args.config)}`)
+  logger.info(`Using config file ${humanPath(os.homedir(), args.config)}`)
   logger.info(
     `${protocol.toUpperCase()} server listening on ${serverAddress.toString()} ${
       args.link ? "(randomized by --link)" : ""
@@ -123,14 +124,14 @@ export const runCodeServer = async (
     } else if (args.usingEnvHashedPassword) {
       logger.info("    - Using password from $HASHED_PASSWORD")
     } else {
-      logger.info(`    - Using password from ${humanPath(args.config)}`)
+      logger.info(`    - Using password from ${humanPath(os.homedir(), args.config)}`)
     }
   } else {
     logger.info(`  - Authentication is disabled ${args.link ? "(disabled by --link)" : ""}`)
   }
 
   if (args.cert) {
-    logger.info(`  - Using certificate for HTTPS: ${humanPath(args.cert.value)}`)
+    logger.info(`  - Using certificate for HTTPS: ${humanPath(os.homedir(), args.cert.value)}`)
   } else {
     logger.info(`  - Not serving HTTPS ${args.link ? "(disabled by --link)" : ""}`)
   }

src/node/routes/index.ts

@@ -10,7 +10,7 @@ import { HttpCode, HttpError } from "../../common/http"
 import { plural } from "../../common/util"
 import { App } from "../app"
 import { AuthType, DefaultedArgs } from "../cli"
-import { commit, isDevMode, rootPath } from "../constants"
+import { commit, rootPath } from "../constants"
 import { Heart } from "../heart"
 import { ensureAuthenticated, redirect } from "../http"
 import { PluginAPI } from "../plugin"
@@ -23,7 +23,7 @@ import * as login from "./login"
 import * as logout from "./logout"
 import * as pathProxy from "./pathProxy"
 import * as update from "./update"
-import { createVSServerRouter, VSServerResult } from "./vscode"
+import { CodeServerRouteWrapper } from "./vscode"
 
 /**
  * Register all routes and middleware.
@@ -138,20 +138,12 @@ export const register = async (app: App, args: DefaultedArgs): Promise<Disposabl
 
   app.router.use("/update", update.router)
 
-  let vscode: VSServerResult
-  try {
-    vscode = await createVSServerRouter(args)
-    app.router.use("/", vscode.router)
-    app.wsRouter.use("/", vscode.wsRouter.router)
-    app.router.use("/vscode", vscode.router)
-    app.wsRouter.use("/vscode", vscode.wsRouter.router)
-  } catch (error: any) {
-    if (isDevMode) {
-      logger.warn(error)
-      logger.warn("VS Server router may still be compiling.")
-    } else {
-      throw error
-    }
+  const vsServerRouteHandler = new CodeServerRouteWrapper()
+
+  // Note that the root route is replaced in Coder Enterprise by the plugin API.
+  for (const routePrefix of ["/vscode", "/"]) {
+    app.router.use(routePrefix, vsServerRouteHandler.router)
+    app.wsRouter.use(routePrefix, vsServerRouteHandler.wsRouter)
   }
 
   app.router.use(() => {
@@ -164,6 +156,6 @@ export const register = async (app: App, args: DefaultedArgs): Promise<Disposabl
   return () => {
     heart.dispose()
     pluginApi?.dispose()
-    vscode?.codeServerMain.dispose()
+    vsServerRouteHandler.dispose()
   }
 }

src/node/routes/login.ts

@@ -1,6 +1,7 @@
 import { Router, Request } from "express"
 import { promises as fs } from "fs"
 import { RateLimiter as Limiter } from "limiter"
+import * as os from "os"
 import * as path from "path"
 import { rootPath } from "../constants"
 import { authenticated, getCookieDomain, redirect, replaceTemplates } from "../http"
@@ -30,7 +31,7 @@ export class RateLimiter {
 
 const getRoot = async (req: Request, error?: Error): Promise<string> => {
   const content = await fs.readFile(path.join(rootPath, "src/browser/pages/login.html"), "utf8")
-  let passwordMsg = `Check the config file at ${humanPath(req.args.config)} for the password.`
+  let passwordMsg = `Check the config file at ${humanPath(os.homedir(), req.args.config)} for the password.`
   if (req.args.usingEnvPassword) {
     passwordMsg = "Password was set from $PASSWORD."
   } else if (req.args.usingEnvHashedPassword) {