Merge branch 'main' into watcher-improvements

Author: Teffen

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:

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

@@ -141,7 +141,7 @@ export const register = async (app: App, args: DefaultedArgs): Promise<Disposabl
   const vsServerRouteHandler = new CodeServerRouteWrapper()
 
   // Note that the root route is replaced in Coder Enterprise by the plugin API.
-  for (const routePrefix of ["/", "/vscode"]) {
+  for (const routePrefix of ["/vscode", "/"]) {
     app.router.use(routePrefix, vsServerRouteHandler.router)
     app.wsRouter.use(routePrefix, vsServerRouteHandler.wsRouter)
   }

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) {

src/node/util.ts

@@ -90,16 +90,17 @@ export function getEnvPaths(): Paths {
 }
 
 /**
- * humanPath replaces the home directory in p with ~.
+ * humanPath replaces the home directory in path with ~.
  * Makes it more readable.
  *
- * @param p
+ * @param homedir - the home directory(i.e. `os.homedir()`)
+ * @param path - a file path
  */
-export function humanPath(p?: string): string {
-  if (!p) {
+export function humanPath(homedir: string, path?: string): string {
+  if (!path) {
     return ""
   }
-  return p.replace(os.homedir(), "~")
+  return path.replace(homedir, "~")
 }
 
 export const generateCertificate = async (hostname: string): Promise<{ cert: string; certKey: string }> => {

test/unit/node/util.test.ts

@@ -476,3 +476,19 @@ describe("isFile", () => {
     expect(await util.isFile(pathToFile)).toBe(true)
   })
 })
+
+describe("humanPath", () => {
+  it("should return an empty string if no path provided", () => {
+    const mockHomedir = "/home/coder"
+    const actual = util.humanPath(mockHomedir)
+    const expected = ""
+    expect(actual).toBe(expected)
+  })
+  it("should replace the homedir with ~", () => {
+    const mockHomedir = "/home/coder"
+    const path = `${mockHomedir}/code-server`
+    const actual = util.humanPath(mockHomedir, path)
+    const expected = "~/code-server"
+    expect(actual).toBe(expected)
+  })
+})