Skip to content

Add separate function for VS Code arguments #4599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 35 additions & 20 deletions src/node/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,10 @@ export const parse = (
throw new Error("--cert-key is missing")
}

logger.debug(() => ["parsed command line", field("args", { ...args, password: undefined })])
logger.debug(() => [
`parsed ${opts?.configFile ? "config" : "command line"}`,
field("args", { ...args, password: undefined }),
])

return args
}
Expand All @@ -430,8 +433,6 @@ export interface DefaultedArgs extends ConfigArgs {
"user-data-dir": string
/* Positional arguments. */
_: []
folder: string
workspace: string
}

/**
Expand Down Expand Up @@ -539,25 +540,8 @@ export async function setDefaults(cliArgs: UserProvidedArgs, configArgs?: Config
args._ = []
}

let workspace = ""
let folder = ""
if (args._.length) {
const lastEntry = path.resolve(process.cwd(), args._[args._.length - 1])
const entryIsFile = await isFile(lastEntry)

if (entryIsFile && path.extname(lastEntry) === ".code-workspace") {
workspace = lastEntry
args._.pop()
} else if (!entryIsFile) {
folder = lastEntry
args._.pop()
}
}

return {
...args,
workspace,
folder,
usingEnvPassword,
usingEnvHashedPassword,
} as DefaultedArgs // TODO: Technically no guarantee this is fulfilled.
Expand Down Expand Up @@ -760,3 +744,34 @@ export const shouldOpenInExistingInstance = async (args: UserProvidedArgs): Prom

return undefined
}

/**
* Convert our arguments to VS Code server arguments.
*/
export const toVsCodeArgs = async (args: DefaultedArgs): Promise<CodeServerLib.ServerParsedArgs> => {
let workspace = ""
let folder = ""
if (args._.length) {
const lastEntry = path.resolve(args._[args._.length - 1])
const entryIsFile = await isFile(lastEntry)
if (entryIsFile && path.extname(lastEntry) === ".code-workspace") {
workspace = lastEntry
} else if (!entryIsFile) {
folder = lastEntry
}
// Otherwise it is a regular file. Spawning VS Code with a file is not yet
// supported but it can be done separately after code-server spawns.
}

return {
"connection-token": "0000",
...args,
workspace,
folder,
"accept-server-license-terms": true,
/** Type casting. */
help: !!args.help,
version: !!args.version,
port: args.port?.toString(),
}
}
11 changes: 2 additions & 9 deletions src/node/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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, UserProvidedArgs } from "./cli"
import { AuthType, DefaultedArgs, Feature, toVsCodeArgs, UserProvidedArgs } from "./cli"
import { coderCloudBind } from "./coder_cloud"
import { commit, version } from "./constants"
import { register } from "./routes"
Expand Down Expand Up @@ -35,14 +35,7 @@ export const runVsCodeCli = async (args: DefaultedArgs): Promise<void> => {
const spawnCli = await loadAMDModule<CodeServerLib.SpawnCli>("vs/server/remoteExtensionHostAgent", "spawnCli")

try {
await spawnCli({
...args,
/** Type casting. */
"accept-server-license-terms": true,
help: !!args.help,
version: !!args.version,
port: args.port?.toString(),
})
await spawnCli(await toVsCodeArgs(args))
} catch (error: any) {
logger.error("Got error from VS Code", error)
}
Expand Down
11 changes: 2 additions & 9 deletions src/node/routes/vscode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import * as express from "express"
import { WebsocketRequest } from "../../../typings/pluginapi"
import { logError } from "../../common/util"
import { isDevMode } from "../constants"
import { toVsCodeArgs } from "../cli"
import { ensureAuthenticated, authenticated, redirect } from "../http"
import { loadAMDModule, readCompilationStats } from "../util"
import { Router as WsRouter } from "../wsRouter"
Expand Down Expand Up @@ -87,15 +88,7 @@ export class CodeServerRouteWrapper {
)

try {
this._codeServerMain = await createVSServer(null, {
"connection-token": "0000",
"accept-server-license-terms": true,
...args,
/** Type casting. */
help: !!args.help,
version: !!args.version,
port: args.port?.toString(),
})
this._codeServerMain = await createVSServer(null, await toVsCodeArgs(args))
} catch (createServerError) {
logError(logger, "CodeServerRouteWrapper", createServerError)
return next(createServerError)
Expand Down
91 changes: 73 additions & 18 deletions test/unit/node/cli.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,26 @@ import {
setDefaults,
shouldOpenInExistingInstance,
splitOnFirstEquals,
toVsCodeArgs,
} from "../../../src/node/cli"
import { shouldSpawnCliProcess } from "../../../src/node/main"
import { generatePassword, paths } from "../../../src/node/util"
import { useEnv, tmpdir } from "../../utils/helpers"
import { clean, useEnv, tmpdir } from "../../utils/helpers"

// The parser should not set any defaults so the caller can determine what
// values the user actually set. These are only set after explicitly calling
// `setDefaults`.
const defaults = {
auth: "password",
host: "localhost",
port: 8080,
"proxy-domain": [],
usingEnvPassword: false,
usingEnvHashedPassword: false,
"extensions-dir": path.join(paths.data, "extensions"),
"user-data-dir": paths.data,
_: [],
}

describe("parser", () => {
beforeEach(() => {
Expand All @@ -24,23 +40,6 @@ describe("parser", () => {
console.log = jest.fn()
})

// The parser should not set any defaults so the caller can determine what
// values the user actually set. These are only set after explicitly calling
// `setDefaults`.
const defaults = {
auth: "password",
host: "localhost",
port: 8080,
"proxy-domain": [],
usingEnvPassword: false,
usingEnvHashedPassword: false,
"extensions-dir": path.join(paths.data, "extensions"),
"user-data-dir": paths.data,
_: [],
workspace: "",
folder: "",
}

it("should parse nothing", async () => {
expect(parse([])).toStrictEqual({})
})
Expand Down Expand Up @@ -667,3 +666,59 @@ describe("readSocketPath", () => {
expect(contents2).toBe(contents1)
})
})

describe("toVsCodeArgs", () => {
const vscodeDefaults = {
...defaults,
"connection-token": "0000",
"accept-server-license-terms": true,
help: false,
port: "8080",
version: false,
}

beforeAll(async () => {
// Clean up temporary directories from the previous run.
await clean("vscode-args")
})

it("should convert empty args", async () => {
expect(await toVsCodeArgs(await setDefaults(parse([])))).toStrictEqual({
...vscodeDefaults,
folder: "",
workspace: "",
})
})

it("should convert with workspace", async () => {
const workspace = path.join(await tmpdir("vscode-args"), "test.code-workspace")
await fs.writeFile(workspace, "foobar")
expect(await toVsCodeArgs(await setDefaults(parse([workspace])))).toStrictEqual({
...vscodeDefaults,
workspace,
folder: "",
_: [workspace],
})
})

it("should convert with folder", async () => {
const folder = await tmpdir("vscode-args")
expect(await toVsCodeArgs(await setDefaults(parse([folder])))).toStrictEqual({
...vscodeDefaults,
folder,
workspace: "",
_: [folder],
})
})

it("should ignore regular file", async () => {
const file = path.join(await tmpdir("vscode-args"), "file")
await fs.writeFile(file, "foobar")
expect(await toVsCodeArgs(await setDefaults(parse([file])))).toStrictEqual({
...vscodeDefaults,
folder: "",
workspace: "",
_: [file],
})
})
})
2 changes: 0 additions & 2 deletions test/unit/node/plugin.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ describe("plugin", () => {
usingEnvHashedPassword: false,
"extensions-dir": "",
"user-data-dir": "",
workspace: "",
folder: "",
}
next()
}
Expand Down