- Notifications
You must be signed in to change notification settings - Fork34
Add support for CLI global flag configurations#577
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletionsCHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletionspackage.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
8 changes: 3 additions & 5 deletionssrc/api.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -13,7 +13,7 @@ import * as ws from "ws"; | ||
| import { errToStr } from "./api-helper"; | ||
| import { CertificateError } from "./error"; | ||
| import { FeatureSet } from "./featureSet"; | ||
| import {getGlobalFlags } from "./globalFlags"; | ||
| import { getProxyForUrl } from "./proxy"; | ||
| import { Storage } from "./storage"; | ||
| import { expandPath } from "./util"; | ||
| @@ -186,9 +186,7 @@ export async function startWorkspaceIfStoppedOrFailed( | ||
| return new Promise((resolve, reject) => { | ||
| const startArgs = [ | ||
| ...getGlobalFlags(vscode.workspace.getConfiguration(), globalConfigDir), | ||
| "start", | ||
| "--yes", | ||
| workspace.owner_name + "/" + workspace.name, | ||
| @@ -197,7 +195,7 @@ export async function startWorkspaceIfStoppedOrFailed( | ||
| startArgs.push(...["--reason", "vscode_connection"]); | ||
| } | ||
| const startProcess = spawn(binPath, startArgs, { shell: true }); | ||
EhabY marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| startProcess.stdout.on("data", (data: Buffer) => { | ||
| data | ||
17 changes: 11 additions & 6 deletionssrc/commands.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -10,8 +10,9 @@ import * as vscode from "vscode"; | ||
| import { makeCoderSdk, needToken } from "./api"; | ||
| import { extractAgents } from "./api-helper"; | ||
| import { CertificateError } from "./error"; | ||
| import { getGlobalFlags } from "./globalFlags"; | ||
| import { Storage } from "./storage"; | ||
| import {escapeCommandArg,toRemoteAuthority, toSafeHost } from "./util"; | ||
| import { | ||
| AgentTreeItem, | ||
| WorkspaceTreeItem, | ||
| @@ -503,12 +504,16 @@ export class Commands { | ||
| this.restClient, | ||
| toSafeHost(url), | ||
| ); | ||
| const configDir = path.dirname( | ||
| this.storage.getSessionTokenPath(toSafeHost(url)), | ||
| ); | ||
| const globalFlags = getGlobalFlags( | ||
| vscode.workspace.getConfiguration(), | ||
| configDir, | ||
| ); | ||
| terminal.sendText( | ||
code-asher marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| `${escapeCommandArg(binary)}${` ${globalFlags.join(" ")}`} ssh ${app.workspace_name}`, | ||
| ); | ||
| await new Promise((resolve) => setTimeout(resolve, 5000)); | ||
| terminal.sendText(app.command ?? ""); | ||
78 changes: 78 additions & 0 deletionssrc/globalFlags.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import { it, expect, describe } from "vitest"; | ||
| import { WorkspaceConfiguration } from "vscode"; | ||
| import { getGlobalFlags } from "./globalFlags"; | ||
| describe("Global flags suite", () => { | ||
| it("should return global-config and header args when no global flags configured", () => { | ||
| const config = { | ||
| get: () => undefined, | ||
| } as unknown as WorkspaceConfiguration; | ||
| expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ | ||
| "--global-config", | ||
| '"/config/dir"', | ||
| ]); | ||
| }); | ||
| it("should return global flags from config with global-config appended", () => { | ||
| const config = { | ||
| get: (key: string) => | ||
| key === "coder.globalFlags" | ||
| ? ["--verbose", "--disable-direct-connections"] | ||
| : undefined, | ||
| } as unknown as WorkspaceConfiguration; | ||
| expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ | ||
| "--verbose", | ||
| "--disable-direct-connections", | ||
| "--global-config", | ||
| '"/config/dir"', | ||
| ]); | ||
| }); | ||
| it("should not filter duplicate global-config flags, last takes precedence", () => { | ||
| const config = { | ||
| get: (key: string) => | ||
| key === "coder.globalFlags" | ||
| ? [ | ||
| "-v", | ||
| "--global-config /path/to/ignored", | ||
| "--disable-direct-connections", | ||
| ] | ||
| : undefined, | ||
| } as unknown as WorkspaceConfiguration; | ||
| expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ | ||
| "-v", | ||
| "--global-config /path/to/ignored", | ||
| "--disable-direct-connections", | ||
| "--global-config", | ||
| '"/config/dir"', | ||
| ]); | ||
| }); | ||
| it("should not filter header-command flags, header args appended at end", () => { | ||
| const config = { | ||
| get: (key: string) => { | ||
| if (key === "coder.headerCommand") { | ||
| return "echo test"; | ||
| } | ||
| if (key === "coder.globalFlags") { | ||
| return ["-v", "--header-command custom", "--no-feature-warning"]; | ||
| } | ||
| return undefined; | ||
| }, | ||
| } as unknown as WorkspaceConfiguration; | ||
| const result = getGlobalFlags(config, "/config/dir"); | ||
| expect(result).toStrictEqual([ | ||
| "-v", | ||
| "--header-command custom", // ignored by CLI | ||
| "--no-feature-warning", | ||
| "--global-config", | ||
| '"/config/dir"', | ||
| "--header-command", | ||
| "'echo test'", | ||
| ]); | ||
| }); | ||
| }); |
19 changes: 19 additions & 0 deletionssrc/globalFlags.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import { WorkspaceConfiguration } from "vscode"; | ||
| import { getHeaderArgs } from "./headers"; | ||
| import { escapeCommandArg } from "./util"; | ||
| /** | ||
| * Returns global configuration flags for Coder CLI commands. | ||
| * Always includes the `--global-config` argument with the specified config directory. | ||
| */ | ||
| export function getGlobalFlags( | ||
| configs: WorkspaceConfiguration, | ||
| configDir: string, | ||
| ): string[] { | ||
| // Last takes precedence/overrides previous ones | ||
| return [ | ||
| ...(configs.get<string[]>("coder.globalFlags") || []), | ||
| ...["--global-config", escapeCommandArg(configDir)], | ||
| ...getHeaderArgs(configs), | ||
| ]; | ||
| } |
23 changes: 14 additions & 9 deletionssrc/remote.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -26,7 +26,7 @@ import { extractAgents } from "./api-helper"; | ||
| import * as cli from "./cliManager"; | ||
| import { Commands } from "./commands"; | ||
| import { featureSetForVersion, FeatureSet } from "./featureSet"; | ||
| import {getGlobalFlags } from "./globalFlags"; | ||
| import { Inbox } from "./inbox"; | ||
| import { SSHConfig, SSHValues, mergeSSHConfigValues } from "./sshConfig"; | ||
| import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"; | ||
| @@ -758,19 +758,15 @@ export class Remote { | ||
| const sshConfig = new SSHConfig(sshConfigFile); | ||
| await sshConfig.load(); | ||
| const hostPrefix = label | ||
| ? `${AuthorityPrefix}.${label}--` | ||
| : `${AuthorityPrefix}--`; | ||
| const globalConfigs = this.globalConfigs(label); | ||
| const proxyCommand = featureSet.wildcardSSH | ||
code-asher marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| ? `${escapeCommandArg(binaryPath)}${globalConfigs} ssh --stdio --usage-app=vscode --disable-autostart --network-info-dir ${escapeCommandArg(this.storage.getNetworkInfoPath())}${await this.formatLogArg(logDir)} --ssh-host-prefix ${hostPrefix} %h` | ||
| : `${escapeCommandArg(binaryPath)}${globalConfigs} vscodessh --network-info-dir ${escapeCommandArg( | ||
| this.storage.getNetworkInfoPath(), | ||
| )}${await this.formatLogArg(logDir)} --session-token-file ${escapeCommandArg(this.storage.getSessionTokenPath(label))} --url-file ${escapeCommandArg( | ||
| this.storage.getUrlPath(label), | ||
| @@ -828,6 +824,15 @@ export class Remote { | ||
| return sshConfig.getRaw(); | ||
| } | ||
| private globalConfigs(label: string): string { | ||
| const vscodeConfig = vscode.workspace.getConfiguration(); | ||
| const args = getGlobalFlags( | ||
| vscodeConfig, | ||
| path.dirname(this.storage.getSessionTokenPath(label)), | ||
| ); | ||
| return ` ${args.join(" ")}`; | ||
| } | ||
| // showNetworkUpdates finds the SSH process ID that is being used by this | ||
| // workspace and reads the file being created by the Coder CLI. | ||
| private showNetworkUpdates(sshPid: number): vscode.Disposable { | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.