Move integration types into code-server

This will be easier to maintain than to have it as a patch.

Author: code-asher

src/node/cli.ts

@@ -31,21 +31,40 @@ export enum LogLevel {
 
 export class OptionalString extends Optional<string> {}
 
+/**
+ * Code flags provided by the user.
+ */
+export interface UserProvidedCodeArgs {
+  "disable-telemetry"?: boolean
+  force?: boolean
+  "user-data-dir"?: string
+  "enable-proposed-api"?: string[]
+  "extensions-dir"?: string
+  "builtin-extensions-dir"?: string
+  "install-extension"?: string[]
+  "uninstall-extension"?: string[]
+  "list-extensions"?: boolean
+  "locate-extension"?: string[]
+  "show-versions"?: boolean
+  category?: string
+  "github-auth"?: string
+  "disable-update-check"?: boolean
+}
+
 /**
  * Arguments that the user explicitly provided on the command line.  All
  * arguments must be optional.
  *
  * For arguments with defaults see DefaultedArgs.
  */
-export interface UserProvidedArgs {
+export interface UserProvidedArgs extends UserProvidedCodeArgs {
   config?: string
   auth?: AuthType
   password?: string
   "hashed-password"?: string
   cert?: OptionalString
   "cert-host"?: string
   "cert-key"?: string
-  "disable-update-check"?: boolean
   enable?: string[]
   help?: boolean
   host?: string
@@ -66,21 +85,6 @@ export interface UserProvidedArgs {
   verbose?: boolean
   /* Positional arguments. */
   _?: string[]
-
-  // VS Code flags.
-  "disable-telemetry"?: boolean
-  force?: boolean
-  "user-data-dir"?: string
-  "enable-proposed-api"?: string[]
-  "extensions-dir"?: string
-  "builtin-extensions-dir"?: string
-  "install-extension"?: string[]
-  "uninstall-extension"?: string[]
-  "list-extensions"?: boolean
-  "locate-extension"?: string[]
-  "show-versions"?: boolean
-  category?: string
-  "github-auth"?: string
 }
 
 interface Option<T> {
@@ -761,10 +765,27 @@ export const shouldOpenInExistingInstance = async (args: UserProvidedArgs): Prom
   return undefined
 }
 
+/**
+ * Arguments for running Code's server.
+ */
+export interface CodeArgs extends UserProvidedCodeArgs {
+  "accept-server-license-terms"?: boolean
+  "connection-token"?: string
+  help: boolean
+  port: string
+  version: boolean
+  "without-browser-env-var"?: boolean
+}
+
+/**
+ * Spawn the Code CLI.
+ */
+export type SpawnCli = (args: CodeArgs) => Promise<void>
+
 /**
  * Convert our arguments to VS Code server arguments.
  */
-export const toVsCodeArgs = async (args: DefaultedArgs): Promise<CodeServerLib.ServerParsedArgs> => {
+export const toCodeArgs = async (args: DefaultedArgs): Promise<CodeArgs> => {
   return {
     "connection-token": "0000",
     ...args,

src/node/entry.ts

@@ -1,7 +1,7 @@
 import { logger } from "@coder/logger"
 import { optionDescriptions, parse, readConfigFile, setDefaults, shouldOpenInExistingInstance } from "./cli"
 import { getVersionString, getVersionJsonString } from "./constants"
-import { openInExistingInstance, runCodeServer, runVsCodeCli, shouldSpawnCliProcess } from "./main"
+import { openInExistingInstance, runCodeServer, runCodeCli, shouldSpawnCliProcess } from "./main"
 import { isChild, wrapper } from "./wrapper"
 
 async function entry(): Promise<void> {
@@ -48,7 +48,7 @@ async function entry(): Promise<void> {
 
   if (shouldSpawnCliProcess(args)) {
     logger.debug("Found VS Code arguments; spawning VS Code CLI")
-    return runVsCodeCli(args)
+    return runCodeCli(args)
   }
 
   const socketPath = await shouldOpenInExistingInstance(cliArgs)

src/node/main.ts

@@ -5,7 +5,7 @@ import path from "path"
 import { Disposable } from "../common/emitter"
 import { plural } from "../common/util"
 import { createApp, ensureAddress } from "./app"
-import { AuthType, DefaultedArgs, Feature, toVsCodeArgs, UserProvidedArgs } from "./cli"
+import { AuthType, DefaultedArgs, Feature, SpawnCli, toCodeArgs, UserProvidedArgs } from "./cli"
 import { coderCloudBind } from "./coder_cloud"
 import { commit, version } from "./constants"
 import { register } from "./routes"
@@ -23,28 +23,38 @@ export const shouldSpawnCliProcess = (args: UserProvidedArgs): boolean => {
   )
 }
 
+export interface OpenCommandPipeArgs {
+  type: "open"
+  fileURIs?: string[]
+  folderURIs: string[]
+  forceNewWindow?: boolean
+  diffMode?: boolean
+  addMode?: boolean
+  gotoLineMode?: boolean
+  forceReuseWindow?: boolean
+  waitMarkerFilePath?: string
+}
+
 /**
- * This is useful when an CLI arg should be passed to VS Code directly,
- * such as when managing extensions.
- * @deprecated This should be removed when code-server merges with lib/vscode.
+ * Run Code's CLI for things like managing extensions.
  */
-export const runVsCodeCli = async (args: DefaultedArgs): Promise<void> => {
-  logger.debug("Running VS Code CLI")
+export const runCodeCli = async (args: DefaultedArgs): Promise<void> => {
+  logger.debug("Running Code CLI")
 
   // See ../../lib/vscode/src/vs/server/node/server.main.js.
-  const spawnCli = await loadAMDModule<CodeServerLib.SpawnCli>("vs/server/node/server.main", "spawnCli")
+  const spawnCli = await loadAMDModule<SpawnCli>("vs/server/node/server.main", "spawnCli")
 
   try {
-    await spawnCli(await toVsCodeArgs(args))
+    await spawnCli(await toCodeArgs(args))
   } catch (error: any) {
-    logger.error("Got error from VS Code", error)
+    logger.error("Got error from Code", error)
   }
 
   process.exit(0)
 }
 
 export const openInExistingInstance = async (args: DefaultedArgs, socketPath: string): Promise<void> => {
-  const pipeArgs: CodeServerLib.OpenCommandPipeArgs & { fileURIs: string[] } = {
+  const pipeArgs: OpenCommandPipeArgs & { fileURIs: string[] } = {
     type: "open",
     folderURIs: [],
     fileURIs: [],
@@ -76,12 +86,12 @@ export const openInExistingInstance = async (args: DefaultedArgs, socketPath: st
     },
     (response) => {
       response.on("data", (message) => {
-        logger.debug("got message from VS Code", field("message", message.toString()))
+        logger.debug("got message from Code", field("message", message.toString()))
       })
     },
   )
   vscode.on("error", (error: unknown) => {
-    logger.error("got error from VS Code", field("error", error))
+    logger.error("got error from Code", field("error", error))
   })
   vscode.write(JSON.stringify(pipeArgs))
   vscode.end()

src/node/routes/vscode.ts

@@ -1,19 +1,30 @@
 import { logger } from "@coder/logger"
 import * as express from "express"
+import * as http from "http"
+import * as net from "net"
 import * as path from "path"
 import { WebsocketRequest } from "../../../typings/pluginapi"
 import { logError } from "../../common/util"
-import { toVsCodeArgs } from "../cli"
+import { CodeArgs, toCodeArgs } from "../cli"
 import { isDevMode } from "../constants"
 import { authenticated, ensureAuthenticated, redirect, self } from "../http"
 import { SocketProxyProvider } from "../socket"
 import { isFile, loadAMDModule } from "../util"
 import { Router as WsRouter } from "../wsRouter"
 import { errorHandler } from "./errors"
 
+export interface IServerAPI {
+  handleRequest(req: http.IncomingMessage, res: http.ServerResponse): Promise<void>
+  handleUpgrade(req: http.IncomingMessage, socket: net.Socket): void
+  handleServerError(err: Error): void
+  dispose(): void
+}
+
+export type CreateServer = (address: string | net.AddressInfo | null, args: CodeArgs) => Promise<IServerAPI>
+
 export class CodeServerRouteWrapper {
   /** Assigned in `ensureCodeServerLoaded` */
-  private _codeServerMain!: CodeServerLib.IServerAPI
+  private _codeServerMain!: IServerAPI
   private _wsRouterWrapper = WsRouter()
   private _socketProxyProvider = new SocketProxyProvider()
   public router = express.Router()
@@ -120,11 +131,11 @@ export class CodeServerRouteWrapper {
     /**
      * @file ../../../lib/vscode/src/vs/server/node/server.main.js
      */
-    const createVSServer = await loadAMDModule<CodeServerLib.CreateServer>("vs/server/node/server.main", "createServer")
+    const createVSServer = await loadAMDModule<CreateServer>("vs/server/node/server.main", "createServer")
 
     try {
       this._codeServerMain = await createVSServer(null, {
-        ...(await toVsCodeArgs(args)),
+        ...(await toCodeArgs(args)),
         // TODO: Make the browser helper script work.
         "without-browser-env-var": true,
       })

test/unit/node/cli.test.ts

@@ -12,7 +12,7 @@ import {
   setDefaults,
   shouldOpenInExistingInstance,
   splitOnFirstEquals,
-  toVsCodeArgs,
+  toCodeArgs,
   optionDescriptions,
   options,
   Options,