From a4018052e3c11fc97d1e98d4d3ab006399a8a1f1 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 13 Oct 2025 23:49:14 +0300 Subject: [PATCH 01/55] Fixed WebSocket connections not receiving headers from the configured header command (#619) Closes #618 --- CHANGELOG.md | 5 ++ src/{ => api}/agentMetadataHelper.ts | 10 ++-- src/api/coderApi.ts | 30 +++++++---- src/api/utils.ts | 18 +++++-- src/api/workspace.ts | 10 ++-- src/headers.ts | 25 +++++----- src/inbox.ts | 48 ++++++++++++------ src/remote/remote.ts | 39 +++++++-------- src/workspace/workspaceMonitor.ts | 74 ++++++++++++++++++---------- src/workspace/workspacesProvider.ts | 15 ++++-- 10 files changed, 167 insertions(+), 107 deletions(-) rename src/{ => api}/agentMetadataHelper.ts (91%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 52a8801a..ef80cd1a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## Unreleased +### Fixed + +- Fixed WebSocket connections not receiving headers from the configured header command + (`coder.headerCommand`), which could cause authentication failures with remote workspaces. + ## [v1.11.2](https://github.com/coder/vscode-coder/releases/tag/v1.11.2) 2025-10-07 ### Changed diff --git a/src/agentMetadataHelper.ts b/src/api/agentMetadataHelper.ts similarity index 91% rename from src/agentMetadataHelper.ts rename to src/api/agentMetadataHelper.ts index 0a976411..4de804ad 100644 --- a/src/agentMetadataHelper.ts +++ b/src/api/agentMetadataHelper.ts @@ -5,8 +5,8 @@ import { type AgentMetadataEvent, AgentMetadataEventSchemaArray, errToStr, -} from "./api/api-helper"; -import { type CoderApi } from "./api/coderApi"; +} from "./api-helper"; +import { type CoderApi } from "./coderApi"; export type AgentMetadataWatcher = { onChange: vscode.EventEmitter["event"]; @@ -19,11 +19,11 @@ export type AgentMetadataWatcher = { * Opens a websocket connection to watch metadata for a given workspace agent. * Emits onChange when metadata updates or an error occurs. */ -export function createAgentMetadataWatcher( +export async function createAgentMetadataWatcher( agentId: WorkspaceAgent["id"], client: CoderApi, -): AgentMetadataWatcher { - const socket = client.watchAgentMetadata(agentId); +): Promise { + const socket = await client.watchAgentMetadata(agentId); let disposed = false; const onChange = new vscode.EventEmitter(); diff --git a/src/api/coderApi.ts b/src/api/coderApi.ts index 1d523b60..99976ff7 100644 --- a/src/api/coderApi.ts +++ b/src/api/coderApi.ts @@ -67,7 +67,7 @@ export class CoderApi extends Api { return client; } - watchInboxNotifications = ( + watchInboxNotifications = async ( watchTemplates: string[], watchTargets: string[], options?: ClientOptions, @@ -83,14 +83,14 @@ export class CoderApi extends Api { }); }; - watchWorkspace = (workspace: Workspace, options?: ClientOptions) => { + watchWorkspace = async (workspace: Workspace, options?: ClientOptions) => { return this.createWebSocket({ apiRoute: `/api/v2/workspaces/${workspace.id}/watch-ws`, options, }); }; - watchAgentMetadata = ( + watchAgentMetadata = async ( agentId: WorkspaceAgent["id"], options?: ClientOptions, ) => { @@ -100,21 +100,22 @@ export class CoderApi extends Api { }); }; - watchBuildLogsByBuildId = (buildId: string, logs: ProvisionerJobLog[]) => { + watchBuildLogsByBuildId = async ( + buildId: string, + logs: ProvisionerJobLog[], + ) => { const searchParams = new URLSearchParams({ follow: "true" }); if (logs.length) { searchParams.append("after", logs[logs.length - 1].id.toString()); } - const socket = this.createWebSocket({ + return this.createWebSocket({ apiRoute: `/api/v2/workspacebuilds/${buildId}/logs`, searchParams, }); - - return socket; }; - private createWebSocket( + private async createWebSocket( configs: Omit, ) { const baseUrlRaw = this.getAxiosInstance().defaults.baseURL; @@ -127,7 +128,15 @@ export class CoderApi extends Api { coderSessionTokenHeader ] as string | undefined; - const httpAgent = createHttpAgent(vscode.workspace.getConfiguration()); + const headers = await getHeaders( + baseUrlRaw, + getHeaderCommand(vscode.workspace.getConfiguration()), + this.output, + ); + + const httpAgent = await createHttpAgent( + vscode.workspace.getConfiguration(), + ); const webSocket = new OneWayWebSocket({ location: baseUrl, ...configs, @@ -137,6 +146,7 @@ export class CoderApi extends Api { headers: { ...(token ? { [coderSessionTokenHeader]: token } : {}), ...configs.options?.headers, + ...headers, }, ...configs.options, }, @@ -191,7 +201,7 @@ function setupInterceptors( // Configure proxy and TLS. // Note that by default VS Code overrides the agent. To prevent this, set // `http.proxySupport` to `on` or `off`. - const agent = createHttpAgent(vscode.workspace.getConfiguration()); + const agent = await createHttpAgent(vscode.workspace.getConfiguration()); config.httpsAgent = agent; config.httpAgent = agent; config.proxy = false; diff --git a/src/api/utils.ts b/src/api/utils.ts index 91a18885..0f13288e 100644 --- a/src/api/utils.ts +++ b/src/api/utils.ts @@ -1,4 +1,4 @@ -import fs from "fs"; +import fs from "fs/promises"; import { ProxyAgent } from "proxy-agent"; import { type WorkspaceConfiguration } from "vscode"; @@ -23,7 +23,9 @@ export function needToken(cfg: WorkspaceConfiguration): boolean { * Create a new HTTP agent based on the current VS Code settings. * Configures proxy, TLS certificates, and security options. */ -export function createHttpAgent(cfg: WorkspaceConfiguration): ProxyAgent { +export async function createHttpAgent( + cfg: WorkspaceConfiguration, +): Promise { const insecure = Boolean(cfg.get("coder.insecure")); const certFile = expandPath( String(cfg.get("coder.tlsCertFile") ?? "").trim(), @@ -32,6 +34,12 @@ export function createHttpAgent(cfg: WorkspaceConfiguration): ProxyAgent { const caFile = expandPath(String(cfg.get("coder.tlsCaFile") ?? "").trim()); const altHost = expandPath(String(cfg.get("coder.tlsAltHost") ?? "").trim()); + const [cert, key, ca] = await Promise.all([ + certFile === "" ? Promise.resolve(undefined) : fs.readFile(certFile), + keyFile === "" ? Promise.resolve(undefined) : fs.readFile(keyFile), + caFile === "" ? Promise.resolve(undefined) : fs.readFile(caFile), + ]); + return new ProxyAgent({ // Called each time a request is made. getProxyForUrl: (url: string) => { @@ -41,9 +49,9 @@ export function createHttpAgent(cfg: WorkspaceConfiguration): ProxyAgent { cfg.get("coder.proxyBypass"), ); }, - cert: certFile === "" ? undefined : fs.readFileSync(certFile), - key: keyFile === "" ? undefined : fs.readFileSync(keyFile), - ca: caFile === "" ? undefined : fs.readFileSync(caFile), + cert, + key, + ca, servername: altHost === "" ? undefined : altHost, // rejectUnauthorized defaults to true, so we need to explicitly set it to // false if we want to allow self-signed certificates. diff --git a/src/api/workspace.ts b/src/api/workspace.ts index c2e20c0c..cb03d9fc 100644 --- a/src/api/workspace.ts +++ b/src/api/workspace.ts @@ -95,12 +95,12 @@ export async function waitForBuild( const logs = await client.getWorkspaceBuildLogs(workspace.latest_build.id); logs.forEach((log) => writeEmitter.fire(log.output + "\r\n")); - await new Promise((resolve, reject) => { - const socket = client.watchBuildLogsByBuildId( - workspace.latest_build.id, - logs, - ); + const socket = await client.watchBuildLogsByBuildId( + workspace.latest_build.id, + logs, + ); + await new Promise((resolve, reject) => { socket.addEventListener("message", (data) => { if (data.parseError) { writeEmitter.fire( diff --git a/src/headers.ts b/src/headers.ts index f5f45301..6c69258c 100644 --- a/src/headers.ts +++ b/src/headers.ts @@ -24,7 +24,7 @@ export function getHeaderCommand( config.get("coder.headerCommand")?.trim() || process.env.CODER_HEADER_COMMAND?.trim(); - return cmd ? cmd : undefined; + return cmd || undefined; } export function getHeaderArgs(config: WorkspaceConfiguration): string[] { @@ -44,16 +44,13 @@ export function getHeaderArgs(config: WorkspaceConfiguration): string[] { return ["--header-command", escapeSubcommand(command)]; } -// TODO: getHeaders might make more sense to directly implement on Storage -// but it is difficult to test Storage right now since we use vitest instead of -// the standard extension testing framework which would give us access to vscode -// APIs. We should revert the testing framework then consider moving this. - -// getHeaders executes the header command and parses the headers from stdout. -// Both stdout and stderr are logged on error but stderr is otherwise ignored. -// Throws an error if the process exits with non-zero or the JSON is invalid. -// Returns undefined if there is no header command set. No effort is made to -// validate the JSON other than making sure it can be parsed. +/** + * getHeaders executes the header command and parses the headers from stdout. + * Both stdout and stderr are logged on error but stderr is otherwise ignored. + * Throws an error if the process exits with non-zero or the JSON is invalid. + * Returns undefined if there is no header command set. No effort is made to + * validate the JSON other than making sure it can be parsed. + */ export async function getHeaders( url: string | undefined, command: string | undefined, @@ -90,8 +87,8 @@ export async function getHeaders( return headers; } const lines = result.stdout.replace(/\r?\n$/, "").split(/\r?\n/); - for (let i = 0; i < lines.length; ++i) { - const [key, value] = lines[i].split(/=(.*)/); + for (const line of lines) { + const [key, value] = line.split(/=(.*)/); // Header names cannot be blank or contain whitespace and the Coder CLI // requires that there be an equals sign (the value can be blank though). if ( @@ -100,7 +97,7 @@ export async function getHeaders( typeof value === "undefined" ) { throw new Error( - `Malformed line from header command: [${lines[i]}] (out: ${result.stdout})`, + `Malformed line from header command: [${line}] (out: ${result.stdout})`, ); } headers[key] = value; diff --git a/src/inbox.ts b/src/inbox.ts index 61a780bb..8dff573f 100644 --- a/src/inbox.ts +++ b/src/inbox.ts @@ -16,12 +16,21 @@ const TEMPLATE_WORKSPACE_OUT_OF_MEMORY = "a9d027b4-ac49-4fb1-9f6d-45af15f64e7a"; const TEMPLATE_WORKSPACE_OUT_OF_DISK = "f047f6a3-5713-40f7-85aa-0394cce9fa3a"; export class Inbox implements vscode.Disposable { - readonly #logger: Logger; - #disposed = false; - #socket: OneWayWebSocket; + private socket: OneWayWebSocket | undefined; + private disposed = false; - constructor(workspace: Workspace, client: CoderApi, logger: Logger) { - this.#logger = logger; + private constructor(private readonly logger: Logger) {} + + /** + * Factory method to create and initialize an Inbox. + * Use this instead of the constructor to properly handle async websocket initialization. + */ + static async create( + workspace: Workspace, + client: CoderApi, + logger: Logger, + ): Promise { + const inbox = new Inbox(logger); const watchTemplates = [ TEMPLATE_WORKSPACE_OUT_OF_DISK, @@ -30,33 +39,40 @@ export class Inbox implements vscode.Disposable { const watchTargets = [workspace.id]; - this.#socket = client.watchInboxNotifications(watchTemplates, watchTargets); + const socket = await client.watchInboxNotifications( + watchTemplates, + watchTargets, + ); - this.#socket.addEventListener("open", () => { - this.#logger.info("Listening to Coder Inbox"); + socket.addEventListener("open", () => { + logger.info("Listening to Coder Inbox"); }); - this.#socket.addEventListener("error", () => { + socket.addEventListener("error", () => { // Errors are already logged internally - this.dispose(); + inbox.dispose(); }); - this.#socket.addEventListener("message", (data) => { + socket.addEventListener("message", (data) => { if (data.parseError) { - this.#logger.error("Failed to parse inbox message", data.parseError); + logger.error("Failed to parse inbox message", data.parseError); } else { vscode.window.showInformationMessage( data.parsedMessage.notification.title, ); } }); + + inbox.socket = socket; + + return inbox; } dispose() { - if (!this.#disposed) { - this.#logger.info("No longer listening to Coder Inbox"); - this.#socket.close(); - this.#disposed = true; + if (!this.disposed) { + this.logger.info("No longer listening to Coder Inbox"); + this.socket?.close(); + this.disposed = true; } } } diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 832a8086..97cb858e 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -18,7 +18,7 @@ import { getEventValue, formatEventLabel, formatMetadataError, -} from "../agentMetadataHelper"; +} from "../api/agentMetadataHelper"; import { createWorkspaceIdentifier, extractAgents } from "../api/api-helper"; import { CoderApi } from "../api/coderApi"; import { needToken } from "../api/utils"; @@ -135,9 +135,7 @@ export class Remote { let attempts = 0; function initWriteEmitterAndTerminal(): vscode.EventEmitter { - if (!writeEmitter) { - writeEmitter = new vscode.EventEmitter(); - } + writeEmitter ??= new vscode.EventEmitter(); if (!terminal) { terminal = vscode.window.createTerminal({ name: "Build Log", @@ -295,16 +293,14 @@ export class Remote { if (result.type === "login") { return this.setup(remoteAuthority, firstConnect); + } else if (!result.userChoice) { + // User declined to log in. + await this.closeRemote(); + return; } else { - if (!result.userChoice) { - // User declined to log in. - await this.closeRemote(); - return; - } else { - // Log in then try again. - await this.commands.login({ url: baseUrlRaw, label: parts.label }); - return this.setup(remoteAuthority, firstConnect); - } + // Log in then try again. + await this.commands.login({ url: baseUrlRaw, label: parts.label }); + return this.setup(remoteAuthority, firstConnect); } }; @@ -543,7 +539,7 @@ export class Remote { } // Watch the workspace for changes. - const monitor = new WorkspaceMonitor( + const monitor = await WorkspaceMonitor.create( workspace, workspaceClient, this.logger, @@ -556,7 +552,7 @@ export class Remote { ); // Watch coder inbox for messages - const inbox = new Inbox(workspace, workspaceClient, this.logger); + const inbox = await Inbox.create(workspace, workspaceClient, this.logger); disposables.push(inbox); // Wait for the agent to connect. @@ -668,7 +664,7 @@ export class Remote { agent.name, ); }), - ...this.createAgentMetadataStatusBar(agent, workspaceClient), + ...(await this.createAgentMetadataStatusBar(agent, workspaceClient)), ); } catch (ex) { // Whatever error happens, make sure we clean up the disposables in case of failure @@ -858,8 +854,7 @@ export class Remote { "UserKnownHostsFile", "StrictHostKeyChecking", ]; - for (let i = 0; i < keysToMatch.length; i++) { - const key = keysToMatch[i]; + for (const key of keysToMatch) { if (computedProperties[key] === sshValues[key]) { continue; } @@ -1005,7 +1000,7 @@ export class Remote { // this to find the SSH process that is powering this connection. That SSH // process will be logging network information periodically to a file. const text = await fs.readFile(logPath, "utf8"); - const port = await findPort(text); + const port = findPort(text); if (!port) { return; } @@ -1064,16 +1059,16 @@ export class Remote { * The status bar item updates dynamically based on changes to the agent's metadata, * and hides itself if no metadata is available or an error occurs. */ - private createAgentMetadataStatusBar( + private async createAgentMetadataStatusBar( agent: WorkspaceAgent, client: CoderApi, - ): vscode.Disposable[] { + ): Promise { const statusBarItem = vscode.window.createStatusBarItem( "agentMetadata", vscode.StatusBarAlignment.Left, ); - const agentWatcher = createAgentMetadataWatcher(agent.id, client); + const agentWatcher = await createAgentMetadataWatcher(agent.id, client); const onChangeDisposable = agentWatcher.onChange(() => { if (agentWatcher.error) { diff --git a/src/workspace/workspaceMonitor.ts b/src/workspace/workspaceMonitor.ts index 0b154f75..a761249a 100644 --- a/src/workspace/workspaceMonitor.ts +++ b/src/workspace/workspaceMonitor.ts @@ -17,12 +17,12 @@ import { type OneWayWebSocket } from "../websocket/oneWayWebSocket"; * workspace status is also shown in the status bar menu. */ export class WorkspaceMonitor implements vscode.Disposable { - private socket: OneWayWebSocket; + private socket: OneWayWebSocket | undefined; private disposed = false; // How soon in advance to notify about autostop and deletion. - private autostopNotifyTime = 1000 * 60 * 30; // 30 minutes. - private deletionNotifyTime = 1000 * 60 * 60 * 24; // 24 hours. + private readonly autostopNotifyTime = 1000 * 60 * 30; // 30 minutes. + private readonly deletionNotifyTime = 1000 * 60 * 60 * 24; // 24 hours. // Only notify once. private notifiedAutostop = false; @@ -36,7 +36,7 @@ export class WorkspaceMonitor implements vscode.Disposable { // For logging. private readonly name: string; - constructor( + private constructor( workspace: Workspace, private readonly client: CoderApi, private readonly logger: Logger, @@ -45,43 +45,67 @@ export class WorkspaceMonitor implements vscode.Disposable { private readonly contextManager: ContextManager, ) { this.name = createWorkspaceIdentifier(workspace); - const socket = this.client.watchWorkspace(workspace); + + const statusBarItem = vscode.window.createStatusBarItem( + vscode.StatusBarAlignment.Left, + 999, + ); + statusBarItem.name = "Coder Workspace Update"; + statusBarItem.text = "$(fold-up) Update Workspace"; + statusBarItem.command = "coder.workspace.update"; + + // Store so we can update when the workspace data updates. + this.statusBarItem = statusBarItem; + + this.update(workspace); // Set initial state. + } + + /** + * Factory method to create and initialize a WorkspaceMonitor. + * Use this instead of the constructor to properly handle async websocket initialization. + */ + static async create( + workspace: Workspace, + client: CoderApi, + logger: Logger, + vscodeProposed: typeof vscode, + contextManager: ContextManager, + ): Promise { + const monitor = new WorkspaceMonitor( + workspace, + client, + logger, + vscodeProposed, + contextManager, + ); + + // Initialize websocket connection + const socket = await client.watchWorkspace(workspace); socket.addEventListener("open", () => { - this.logger.info(`Monitoring ${this.name}...`); + logger.info(`Monitoring ${monitor.name}...`); }); socket.addEventListener("message", (event) => { try { if (event.parseError) { - this.notifyError(event.parseError); + monitor.notifyError(event.parseError); return; } // Perhaps we need to parse this and validate it. const newWorkspaceData = event.parsedMessage.data as Workspace; - this.update(newWorkspaceData); - this.maybeNotify(newWorkspaceData); - this.onChange.fire(newWorkspaceData); + monitor.update(newWorkspaceData); + monitor.maybeNotify(newWorkspaceData); + monitor.onChange.fire(newWorkspaceData); } catch (error) { - this.notifyError(error); + monitor.notifyError(error); } }); // Store so we can close in dispose(). - this.socket = socket; - - const statusBarItem = vscode.window.createStatusBarItem( - vscode.StatusBarAlignment.Left, - 999, - ); - statusBarItem.name = "Coder Workspace Update"; - statusBarItem.text = "$(fold-up) Update Workspace"; - statusBarItem.command = "coder.workspace.update"; + monitor.socket = socket; - // Store so we can update when the workspace data updates. - this.statusBarItem = statusBarItem; - - this.update(workspace); // Set initial state. + return monitor; } /** @@ -91,7 +115,7 @@ export class WorkspaceMonitor implements vscode.Disposable { if (!this.disposed) { this.logger.info(`Unmonitoring ${this.name}...`); this.statusBarItem.dispose(); - this.socket.close(); + this.socket?.close(); this.disposed = true; } } diff --git a/src/workspace/workspacesProvider.ts b/src/workspace/workspacesProvider.ts index b83e4f84..2dffec13 100644 --- a/src/workspace/workspacesProvider.ts +++ b/src/workspace/workspacesProvider.ts @@ -11,7 +11,7 @@ import { createAgentMetadataWatcher, formatEventLabel, formatMetadataError, -} from "../agentMetadataHelper"; +} from "../api/agentMetadataHelper"; import { type AgentMetadataEvent, extractAgents, @@ -38,8 +38,10 @@ export class WorkspaceProvider { // Undefined if we have never fetched workspaces before. private workspaces: WorkspaceTreeItem[] | undefined; - private agentWatchers: Map = - new Map(); + private readonly agentWatchers: Map< + WorkspaceAgent["id"], + AgentMetadataWatcher + > = new Map(); private timeout: NodeJS.Timeout | undefined; private fetching = false; private visible = false; @@ -130,14 +132,17 @@ export class WorkspaceProvider const showMetadata = this.getWorkspacesQuery === WorkspaceQuery.Mine; if (showMetadata) { const agents = extractAllAgents(resp.workspaces); - agents.forEach((agent) => { + agents.forEach(async (agent) => { // If we have an existing watcher, re-use it. const oldWatcher = this.agentWatchers.get(agent.id); if (oldWatcher) { reusedWatcherIds.push(agent.id); } else { // Otherwise create a new watcher. - const watcher = createAgentMetadataWatcher(agent.id, this.client); + const watcher = await createAgentMetadataWatcher( + agent.id, + this.client, + ); watcher.onChange(() => this.refresh()); this.agentWatchers.set(agent.id, watcher); } From 5165adeaccfd069069f0532ee44e7f5b3fb69d26 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 14 Oct 2025 11:23:43 +0300 Subject: [PATCH 02/55] Fix unit tests on windows (#617) Closes #604 --- package.json | 2 +- test/fixtures/{ => scripts}/bin.bash | 0 test/fixtures/{ => scripts}/bin.old.bash | 0 test/unit/core/cliManager.test.ts | 34 ++-- test/unit/core/cliUtils.test.ts | 14 +- test/unit/core/pathResolver.test.ts | 28 ++- test/unit/globalFlags.test.ts | 13 +- test/unit/headers.test.ts | 243 ++++++++++++----------- test/utils/platform.test.ts | 86 ++++++++ test/utils/platform.ts | 46 +++++ vitest.config.ts | 9 +- 11 files changed, 315 insertions(+), 160 deletions(-) rename test/fixtures/{ => scripts}/bin.bash (100%) rename test/fixtures/{ => scripts}/bin.old.bash (100%) create mode 100644 test/utils/platform.test.ts create mode 100644 test/utils/platform.ts diff --git a/package.json b/package.json index 9d2ea2a3..02a6ddc3 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "lint:fix": "yarn lint --fix", "package": "webpack --mode production --devtool hidden-source-map", "package:prerelease": "npx vsce package --pre-release", - "pretest": "tsc -p . --outDir out && yarn run build && yarn run lint", + "pretest": "tsc -p . --outDir out && tsc -p test --outDir out && yarn run build && yarn run lint", "test": "vitest", "test:ci": "CI=true yarn test", "test:integration": "vscode-test", diff --git a/test/fixtures/bin.bash b/test/fixtures/scripts/bin.bash similarity index 100% rename from test/fixtures/bin.bash rename to test/fixtures/scripts/bin.bash diff --git a/test/fixtures/bin.old.bash b/test/fixtures/scripts/bin.old.bash similarity index 100% rename from test/fixtures/bin.old.bash rename to test/fixtures/scripts/bin.old.bash diff --git a/test/unit/core/cliManager.test.ts b/test/unit/core/cliManager.test.ts index 3e1dfb0d..f2a2c2e5 100644 --- a/test/unit/core/cliManager.test.ts +++ b/test/unit/core/cliManager.test.ts @@ -20,6 +20,7 @@ import { MockProgressReporter, MockUserInteraction, } from "../../mocks/testHelpers"; +import { expectPathsEqual } from "../../utils/platform"; vi.mock("os"); vi.mock("axios"); @@ -213,7 +214,7 @@ describe("CliManager", () => { it("accepts valid semver versions", async () => { withExistingBinary(TEST_VERSION); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); }); }); @@ -226,7 +227,7 @@ describe("CliManager", () => { it("reuses matching binary without downloading", async () => { withExistingBinary(TEST_VERSION); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).not.toHaveBeenCalled(); // Verify binary still exists expect(memfs.existsSync(BINARY_PATH)).toBe(true); @@ -236,7 +237,7 @@ describe("CliManager", () => { withExistingBinary("1.0.0"); withSuccessfulDownload(); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).toHaveBeenCalled(); // Verify new binary exists expect(memfs.existsSync(BINARY_PATH)).toBe(true); @@ -249,7 +250,7 @@ describe("CliManager", () => { mockConfig.set("coder.enableDownloads", false); withExistingBinary("1.0.0"); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).not.toHaveBeenCalled(); // Should still have the old version expect(memfs.existsSync(BINARY_PATH)).toBe(true); @@ -262,7 +263,7 @@ describe("CliManager", () => { withCorruptedBinary(); withSuccessfulDownload(); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).toHaveBeenCalled(); expect(memfs.existsSync(BINARY_PATH)).toBe(true); expect(memfs.readFileSync(BINARY_PATH).toString()).toBe( @@ -276,7 +277,7 @@ describe("CliManager", () => { withSuccessfulDownload(); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).toHaveBeenCalled(); // Verify directory was created and binary exists @@ -392,7 +393,7 @@ describe("CliManager", () => { withExistingBinary("1.0.0"); withHttpResponse(304); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); // No change expect(memfs.readFileSync(BINARY_PATH).toString()).toBe( mockBinaryContent("1.0.0"), @@ -460,7 +461,7 @@ describe("CliManager", () => { it("handles missing content-length", async () => { withSuccessfulDownload({ headers: {} }); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(memfs.existsSync(BINARY_PATH)).toBe(true); }); }); @@ -494,7 +495,7 @@ describe("CliManager", () => { withSuccessfulDownload(); withSignatureResponses([200]); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(pgp.verifySignature).toHaveBeenCalled(); const sigFile = expectFileInDir(BINARY_DIR, ".asc"); expect(sigFile).toBeDefined(); @@ -505,7 +506,7 @@ describe("CliManager", () => { withSignatureResponses([404, 200]); mockUI.setResponse("Signature not found", "Download signature"); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(mockAxios.get).toHaveBeenCalledTimes(3); const sigFile = expectFileInDir(BINARY_DIR, ".asc"); expect(sigFile).toBeDefined(); @@ -519,7 +520,7 @@ describe("CliManager", () => { ); mockUI.setResponse("Signature does not match", "Run anyway"); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(memfs.existsSync(BINARY_PATH)).toBe(true); }); @@ -539,7 +540,7 @@ describe("CliManager", () => { mockConfig.set("coder.disableSignatureVerification", true); withSuccessfulDownload(); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(pgp.verifySignature).not.toHaveBeenCalled(); const files = readdir(BINARY_DIR); expect(files.find((file) => file.includes(".asc"))).toBeUndefined(); @@ -553,7 +554,7 @@ describe("CliManager", () => { withHttpResponse(status); mockUI.setResponse(message, "Run without verification"); const result = await manager.fetchBinary(mockApi, "test"); - expect(result).toBe(BINARY_PATH); + expectPathsEqual(result, BINARY_PATH); expect(pgp.verifySignature).not.toHaveBeenCalled(); }); @@ -615,13 +616,16 @@ describe("CliManager", () => { withSuccessfulDownload(); const result = await manager.fetchBinary(mockApi, "test label"); - expect(result).toBe(`${pathWithSpaces}/test label/bin/${BINARY_NAME}`); + expectPathsEqual( + result, + `${pathWithSpaces}/test label/bin/${BINARY_NAME}`, + ); }); it("handles empty deployment label", async () => { withExistingBinary(TEST_VERSION, "/path/base/bin"); const result = await manager.fetchBinary(mockApi, ""); - expect(result).toBe(path.join(BASE_PATH, "bin", BINARY_NAME)); + expectPathsEqual(result, path.join(BASE_PATH, "bin", BINARY_NAME)); }); }); diff --git a/test/unit/core/cliUtils.test.ts b/test/unit/core/cliUtils.test.ts index d63ddd87..dd1c56f0 100644 --- a/test/unit/core/cliUtils.test.ts +++ b/test/unit/core/cliUtils.test.ts @@ -6,6 +6,7 @@ import { beforeAll, describe, expect, it } from "vitest"; import * as cliUtils from "@/core/cliUtils"; import { getFixturePath } from "../../utils/fixtures"; +import { isWindows } from "../../utils/platform"; describe("CliUtils", () => { const tmp = path.join(os.tmpdir(), "vscode-coder-tests"); @@ -28,12 +29,14 @@ describe("CliUtils", () => { expect((await cliUtils.stat(binPath))?.size).toBe(4); }); - // TODO: CI only runs on Linux but we should run it on Windows too. - it("version", async () => { + it.skipIf(isWindows())("version", async () => { const binPath = path.join(tmp, "version"); await expect(cliUtils.version(binPath)).rejects.toThrow("ENOENT"); - const binTmpl = await fs.readFile(getFixturePath("bin.bash"), "utf8"); + const binTmpl = await fs.readFile( + getFixturePath("scripts", "bin.bash"), + "utf8", + ); await fs.writeFile(binPath, binTmpl.replace("$ECHO", "hello")); await expect(cliUtils.version(binPath)).rejects.toThrow("EACCES"); @@ -56,7 +59,10 @@ describe("CliUtils", () => { ); expect(await cliUtils.version(binPath)).toBe("v0.0.0"); - const oldTmpl = await fs.readFile(getFixturePath("bin.old.bash"), "utf8"); + const oldTmpl = await fs.readFile( + getFixturePath("scripts", "bin.old.bash"), + "utf8", + ); const old = (stderr: string, stdout: string): string => { return oldTmpl.replace("$STDERR", stderr).replace("$STDOUT", stdout); }; diff --git a/test/unit/core/pathResolver.test.ts b/test/unit/core/pathResolver.test.ts index e0e3b4d6..2930fb7e 100644 --- a/test/unit/core/pathResolver.test.ts +++ b/test/unit/core/pathResolver.test.ts @@ -1,9 +1,10 @@ import * as path from "path"; -import { beforeEach, describe, expect, it, vi } from "vitest"; +import { beforeEach, describe, it, vi } from "vitest"; import { PathResolver } from "@/core/pathResolver"; import { MockConfigurationProvider } from "../../mocks/testHelpers"; +import { expectPathsEqual } from "../../utils/platform"; describe("PathResolver", () => { const basePath = @@ -19,17 +20,19 @@ describe("PathResolver", () => { }); it("should use base path for empty labels", () => { - expect(pathResolver.getGlobalConfigDir("")).toBe(basePath); - expect(pathResolver.getSessionTokenPath("")).toBe( + expectPathsEqual(pathResolver.getGlobalConfigDir(""), basePath); + expectPathsEqual( + pathResolver.getSessionTokenPath(""), path.join(basePath, "session"), ); - expect(pathResolver.getUrlPath("")).toBe(path.join(basePath, "url")); + expectPathsEqual(pathResolver.getUrlPath(""), path.join(basePath, "url")); }); describe("getBinaryCachePath", () => { it("should use custom binary destination when configured", () => { mockConfig.set("coder.binaryDestination", "/custom/binary/path"); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), "/custom/binary/path", ); }); @@ -37,14 +40,16 @@ describe("PathResolver", () => { it("should use default path when custom destination is empty or whitespace", () => { vi.stubEnv("CODER_BINARY_DESTINATION", " "); mockConfig.set("coder.binaryDestination", " "); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), path.join(basePath, "deployment", "bin"), ); }); it("should normalize custom paths", () => { mockConfig.set("coder.binaryDestination", "/custom/../binary/./path"); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), "/binary/path", ); }); @@ -53,19 +58,22 @@ describe("PathResolver", () => { // Use the global storage when the environment variable and setting are unset/blank vi.stubEnv("CODER_BINARY_DESTINATION", ""); mockConfig.set("coder.binaryDestination", ""); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), path.join(basePath, "deployment", "bin"), ); // Test environment variable takes precedence over global storage vi.stubEnv("CODER_BINARY_DESTINATION", " /env/binary/path "); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), "/env/binary/path", ); // Test setting takes precedence over environment variable mockConfig.set("coder.binaryDestination", " /setting/path "); - expect(pathResolver.getBinaryCachePath("deployment")).toBe( + expectPathsEqual( + pathResolver.getBinaryCachePath("deployment"), "/setting/path", ); }); diff --git a/test/unit/globalFlags.test.ts b/test/unit/globalFlags.test.ts index d570d609..94c89dba 100644 --- a/test/unit/globalFlags.test.ts +++ b/test/unit/globalFlags.test.ts @@ -3,6 +3,8 @@ import { type WorkspaceConfiguration } from "vscode"; import { getGlobalFlags } from "@/globalFlags"; +import { isWindows } from "../utils/platform"; + describe("Global flags suite", () => { it("should return global-config and header args when no global flags configured", () => { const config = { @@ -53,10 +55,11 @@ describe("Global flags suite", () => { }); it("should not filter header-command flags, header args appended at end", () => { + const headerCommand = "echo test"; const config = { get: (key: string) => { if (key === "coder.headerCommand") { - return "echo test"; + return headerCommand; } if (key === "coder.globalFlags") { return ["-v", "--header-command custom", "--no-feature-warning"]; @@ -73,7 +76,13 @@ describe("Global flags suite", () => { "--global-config", '"/config/dir"', "--header-command", - "'echo test'", + quoteCommand(headerCommand), ]); }); }); + +function quoteCommand(value: string): string { + // Used to escape environment variables in commands. See `getHeaderArgs` in src/headers.ts + const quote = isWindows() ? '"' : "'"; + return `${quote}${value}${quote}`; +} diff --git a/test/unit/headers.test.ts b/test/unit/headers.test.ts index b2c29e22..f5812ec1 100644 --- a/test/unit/headers.test.ts +++ b/test/unit/headers.test.ts @@ -1,10 +1,11 @@ -import * as os from "os"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { type WorkspaceConfiguration } from "vscode"; import { getHeaderCommand, getHeaders } from "@/headers"; import { type Logger } from "@/logging/logger"; +import { printCommand, exitCommand, printEnvCommand } from "../utils/platform"; + const logger: Logger = { trace: () => {}, debug: () => {}, @@ -13,142 +14,142 @@ const logger: Logger = { error: () => {}, }; -it("should return no headers", async () => { - await expect(getHeaders(undefined, undefined, logger)).resolves.toStrictEqual( - {}, - ); - await expect( - getHeaders("localhost", undefined, logger), - ).resolves.toStrictEqual({}); - await expect(getHeaders(undefined, "command", logger)).resolves.toStrictEqual( - {}, - ); - await expect(getHeaders("localhost", "", logger)).resolves.toStrictEqual({}); - await expect(getHeaders("", "command", logger)).resolves.toStrictEqual({}); - await expect(getHeaders("localhost", " ", logger)).resolves.toStrictEqual( - {}, - ); - await expect(getHeaders(" ", "command", logger)).resolves.toStrictEqual({}); - await expect( - getHeaders("localhost", "printf ''", logger), - ).resolves.toStrictEqual({}); -}); - -it("should return headers", async () => { - await expect( - getHeaders("localhost", "printf 'foo=bar\\nbaz=qux'", logger), - ).resolves.toStrictEqual({ - foo: "bar", - baz: "qux", - }); - await expect( - getHeaders("localhost", "printf 'foo=bar\\r\\nbaz=qux'", logger), - ).resolves.toStrictEqual({ - foo: "bar", - baz: "qux", +describe("Headers", () => { + it("should return no headers", async () => { + await expect( + getHeaders(undefined, undefined, logger), + ).resolves.toStrictEqual({}); + await expect( + getHeaders("localhost", undefined, logger), + ).resolves.toStrictEqual({}); + await expect( + getHeaders(undefined, "command", logger), + ).resolves.toStrictEqual({}); + await expect(getHeaders("localhost", "", logger)).resolves.toStrictEqual( + {}, + ); + await expect(getHeaders("", "command", logger)).resolves.toStrictEqual({}); + await expect(getHeaders("localhost", " ", logger)).resolves.toStrictEqual( + {}, + ); + await expect(getHeaders(" ", "command", logger)).resolves.toStrictEqual( + {}, + ); + await expect( + getHeaders("localhost", printCommand(""), logger), + ).resolves.toStrictEqual({}); }); - await expect( - getHeaders("localhost", "printf 'foo=bar\\r\\n'", logger), - ).resolves.toStrictEqual({ foo: "bar" }); - await expect( - getHeaders("localhost", "printf 'foo=bar'", logger), - ).resolves.toStrictEqual({ foo: "bar" }); - await expect( - getHeaders("localhost", "printf 'foo=bar='", logger), - ).resolves.toStrictEqual({ foo: "bar=" }); - await expect( - getHeaders("localhost", "printf 'foo=bar=baz'", logger), - ).resolves.toStrictEqual({ foo: "bar=baz" }); - await expect( - getHeaders("localhost", "printf 'foo='", logger), - ).resolves.toStrictEqual({ foo: "" }); -}); - -it("should error on malformed or empty lines", async () => { - await expect( - getHeaders("localhost", "printf 'foo=bar\\r\\n\\r\\n'", logger), - ).rejects.toThrow(/Malformed/); - await expect( - getHeaders("localhost", "printf '\\r\\nfoo=bar'", logger), - ).rejects.toThrow(/Malformed/); - await expect( - getHeaders("localhost", "printf '=foo'", logger), - ).rejects.toThrow(/Malformed/); - await expect(getHeaders("localhost", "printf 'foo'", logger)).rejects.toThrow( - /Malformed/, - ); - await expect( - getHeaders("localhost", "printf ' =foo'", logger), - ).rejects.toThrow(/Malformed/); - await expect( - getHeaders("localhost", "printf 'foo =bar'", logger), - ).rejects.toThrow(/Malformed/); - await expect( - getHeaders("localhost", "printf 'foo foo=bar'", logger), - ).rejects.toThrow(/Malformed/); -}); -it("should have access to environment variables", async () => { - const coderUrl = "dev.coder.com"; - await expect( - getHeaders( - coderUrl, - os.platform() === "win32" - ? "printf url=%CODER_URL%" - : "printf url=$CODER_URL", - logger, - ), - ).resolves.toStrictEqual({ url: coderUrl }); -}); + it("should return headers", async () => { + await expect( + getHeaders("localhost", printCommand("foo=bar\nbaz=qux"), logger), + ).resolves.toStrictEqual({ + foo: "bar", + baz: "qux", + }); + await expect( + getHeaders("localhost", printCommand("foo=bar\r\nbaz=qux"), logger), + ).resolves.toStrictEqual({ + foo: "bar", + baz: "qux", + }); + await expect( + getHeaders("localhost", printCommand("foo=bar\r\n"), logger), + ).resolves.toStrictEqual({ foo: "bar" }); + await expect( + getHeaders("localhost", printCommand("foo=bar"), logger), + ).resolves.toStrictEqual({ foo: "bar" }); + await expect( + getHeaders("localhost", printCommand("foo=bar="), logger), + ).resolves.toStrictEqual({ foo: "bar=" }); + await expect( + getHeaders("localhost", printCommand("foo=bar=baz"), logger), + ).resolves.toStrictEqual({ foo: "bar=baz" }); + await expect( + getHeaders("localhost", printCommand("foo="), logger), + ).resolves.toStrictEqual({ foo: "" }); + }); -it("should error on non-zero exit", async () => { - await expect(getHeaders("localhost", "exit 10", logger)).rejects.toThrow( - /exited unexpectedly with code 10/, - ); -}); + it("should error on malformed or empty lines", async () => { + await expect( + getHeaders("localhost", printCommand("foo=bar\r\n\r\n"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand("\r\nfoo=bar"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand("=foo"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand("foo"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand(" =foo"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand("foo =bar"), logger), + ).rejects.toThrow(/Malformed/); + await expect( + getHeaders("localhost", printCommand("foo foo=bar"), logger), + ).rejects.toThrow(/Malformed/); + }); -describe("getHeaderCommand", () => { - beforeEach(() => { - vi.stubEnv("CODER_HEADER_COMMAND", ""); + it("should have access to environment variables", async () => { + const coderUrl = "dev.coder.com"; + await expect( + getHeaders(coderUrl, printEnvCommand("url", "CODER_URL"), logger), + ).resolves.toStrictEqual({ url: coderUrl }); }); - afterEach(() => { - vi.unstubAllEnvs(); + it("should error on non-zero exit", async () => { + await expect( + getHeaders("localhost", exitCommand(10), logger), + ).rejects.toThrow(/exited unexpectedly with code 10/); }); - it("should return undefined if coder.headerCommand is not set in config", () => { - const config = { - get: () => undefined, - } as unknown as WorkspaceConfiguration; + describe("getHeaderCommand", () => { + beforeEach(() => { + vi.stubEnv("CODER_HEADER_COMMAND", ""); + }); - expect(getHeaderCommand(config)).toBeUndefined(); - }); + afterEach(() => { + vi.unstubAllEnvs(); + }); - it("should return undefined if coder.headerCommand is a blank string", () => { - const config = { - get: () => " ", - } as unknown as WorkspaceConfiguration; + it("should return undefined if coder.headerCommand is not set in config", () => { + const config = { + get: () => undefined, + } as unknown as WorkspaceConfiguration; - expect(getHeaderCommand(config)).toBeUndefined(); - }); + expect(getHeaderCommand(config)).toBeUndefined(); + }); - it("should return coder.headerCommand if set in config", () => { - vi.stubEnv("CODER_HEADER_COMMAND", "printf 'x=y'"); + it("should return undefined if coder.headerCommand is a blank string", () => { + const config = { + get: () => " ", + } as unknown as WorkspaceConfiguration; - const config = { - get: () => "printf 'foo=bar'", - } as unknown as WorkspaceConfiguration; + expect(getHeaderCommand(config)).toBeUndefined(); + }); - expect(getHeaderCommand(config)).toBe("printf 'foo=bar'"); - }); + it("should return coder.headerCommand if set in config", () => { + vi.stubEnv("CODER_HEADER_COMMAND", "printf 'x=y'"); + + const config = { + get: () => "printf 'foo=bar'", + } as unknown as WorkspaceConfiguration; + + expect(getHeaderCommand(config)).toBe("printf 'foo=bar'"); + }); - it("should return CODER_HEADER_COMMAND if coder.headerCommand is not set in config and CODER_HEADER_COMMAND is set in environment", () => { - vi.stubEnv("CODER_HEADER_COMMAND", "printf 'x=y'"); + it("should return CODER_HEADER_COMMAND if coder.headerCommand is not set in config and CODER_HEADER_COMMAND is set in environment", () => { + vi.stubEnv("CODER_HEADER_COMMAND", "printf 'x=y'"); - const config = { - get: () => undefined, - } as unknown as WorkspaceConfiguration; + const config = { + get: () => undefined, + } as unknown as WorkspaceConfiguration; - expect(getHeaderCommand(config)).toBe("printf 'x=y'"); + expect(getHeaderCommand(config)).toBe("printf 'x=y'"); + }); }); }); diff --git a/test/utils/platform.test.ts b/test/utils/platform.test.ts new file mode 100644 index 00000000..c04820d6 --- /dev/null +++ b/test/utils/platform.test.ts @@ -0,0 +1,86 @@ +import { describe, expect, it } from "vitest"; + +import { + expectPathsEqual, + exitCommand, + printCommand, + printEnvCommand, + isWindows, +} from "./platform"; + +describe("platform utils", () => { + describe("printCommand", () => { + it("should generate a simple node command", () => { + const result = printCommand("hello world"); + expect(result).toBe("node -e \"process.stdout.write('hello world')\""); + }); + + it("should escape special characters", () => { + const result = printCommand('path\\to\\file\'s "name"\nline2\rcarriage'); + expect(result).toBe( + 'node -e "process.stdout.write(\'path\\\\to\\\\file\\\'s \\"name\\"\\nline2\\rcarriage\')"', + ); + }); + }); + + describe("exitCommand", () => { + it("should generate node commands with various exit codes", () => { + expect(exitCommand(0)).toBe('node -e "process.exit(0)"'); + expect(exitCommand(1)).toBe('node -e "process.exit(1)"'); + expect(exitCommand(42)).toBe('node -e "process.exit(42)"'); + expect(exitCommand(-1)).toBe('node -e "process.exit(-1)"'); + }); + }); + + describe("printEnvCommand", () => { + it("should generate node commands that print env variables", () => { + expect(printEnvCommand("url", "CODER_URL")).toBe( + "node -e \"process.stdout.write('url=' + process.env.CODER_URL)\"", + ); + expect(printEnvCommand("token", "CODER_TOKEN")).toBe( + "node -e \"process.stdout.write('token=' + process.env.CODER_TOKEN)\"", + ); + // Will fail to execute but that's fine + expect(printEnvCommand("", "")).toBe( + "node -e \"process.stdout.write('=' + process.env.)\"", + ); + }); + }); + + describe("expectPathsEqual", () => { + it("should consider identical paths equal", () => { + expectPathsEqual("same/path", "same/path"); + }); + + it("should throw when paths are different", () => { + expect(() => + expectPathsEqual("path/to/file1", "path/to/file2"), + ).toThrow(); + }); + + it("should handle empty paths", () => { + expectPathsEqual("", ""); + }); + + it.runIf(isWindows())( + "should consider paths with different separators equal on Windows", + () => { + expectPathsEqual("path/to/file", "path\\to\\file"); + expectPathsEqual("C:/path/to/file", "C:\\path\\to\\file"); + expectPathsEqual( + "C:/path with spaces/file", + "C:\\path with spaces\\file", + ); + }, + ); + + it.skipIf(isWindows())( + "should consider backslash as literal on non-Windows", + () => { + expect(() => + expectPathsEqual("path/to/file", "path\\to\\file"), + ).toThrow(); + }, + ); + }); +}); diff --git a/test/utils/platform.ts b/test/utils/platform.ts new file mode 100644 index 00000000..b0abc660 --- /dev/null +++ b/test/utils/platform.ts @@ -0,0 +1,46 @@ +import os from "node:os"; +import path from "node:path"; +import { expect } from "vitest"; + +export function isWindows(): boolean { + return os.platform() === "win32"; +} + +/** + * Returns a platform-independent command that outputs the given text. + * Uses Node.js which is guaranteed to be available during tests. + */ +export function printCommand(output: string): string { + const escaped = output + .replace(/\\/g, "\\\\") // Escape backslashes first + .replace(/'/g, "\\'") // Escape single quotes + .replace(/"/g, '\\"') // Escape double quotes + .replace(/\r/g, "\\r") // Preserve carriage returns + .replace(/\n/g, "\\n"); // Preserve newlines + + return `node -e "process.stdout.write('${escaped}')"`; +} + +/** + * Returns a platform-independent command that exits with the given code. + */ +export function exitCommand(code: number): string { + return `node -e "process.exit(${code})"`; +} + +/** + * Returns a platform-independent command that prints an environment variable. + * @param key The key for the header (e.g., "url" to output "url=value") + * @param varName The environment variable name to access + */ +export function printEnvCommand(key: string, varName: string): string { + return `node -e "process.stdout.write('${key}=' + process.env.${varName})"`; +} + +export function expectPathsEqual(actual: string, expected: string) { + expect(normalizePath(actual)).toBe(normalizePath(expected)); +} + +function normalizePath(p: string): string { + return p.replaceAll(path.sep, path.posix.sep); +} diff --git a/vitest.config.ts b/vitest.config.ts index 01e3896a..40c5f958 100644 --- a/vitest.config.ts +++ b/vitest.config.ts @@ -5,13 +5,8 @@ export default defineConfig({ test: { globals: true, environment: "node", - include: ["test/unit/**/*.test.ts", "test/integration/**/*.test.ts"], - exclude: [ - "test/integration/**", - "**/node_modules/**", - "**/out/**", - "**/*.d.ts", - ], + include: ["test/unit/**/*.test.ts", "test/utils/**/*.test.ts"], + exclude: ["**/node_modules/**", "**/out/**", "**/*.d.ts"], pool: "threads", fileParallelism: true, coverage: { From f9b1f2516638afb466b11a0ccdb6747459900c27 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Fri, 17 Oct 2025 11:34:38 +0300 Subject: [PATCH 03/55] Add SSE fallback to some one way WS connections (#623) Add SSE fallback to some WS connections: * `/api/v2/workspaces/${workspace.id}/watch-ws` -> `/api/v2/workspaceagents/${agentId}/watch-metadata` * `/api/v2/workspaceagents/${agentId}/watch-metadata-ws` -> `/api/v2/workspaceagents/${agentId}/watch-metadata` Restored the previous code regarding `createStreamingFetchAdapter` to stream in SSE events. * Implemented a unified interface for WS and SSE to be similar to the `OneWayWebSocket`. * Added unified logging for WS and SSE. * Fixed issue with headers order precedence * Add tests for `CoderApi` Closes #620 --- src/api/coderApi.ts | 171 +++++-- src/api/streamingFetchAdapter.ts | 71 +++ .../{wsLogger.ts => eventStreamLogger.ts} | 16 +- src/websocket/eventStreamConnection.ts | 51 +++ src/websocket/oneWayWebSocket.ts | 69 +-- src/websocket/sseConnection.ts | 221 +++++++++ src/websocket/utils.ts | 15 + src/workspace/workspaceMonitor.ts | 14 +- test/unit/api/coderApi.test.ts | 431 ++++++++++++++++++ ...gger.test.ts => eventStreamLogger.test.ts} | 62 ++- 10 files changed, 1005 insertions(+), 116 deletions(-) create mode 100644 src/api/streamingFetchAdapter.ts rename src/logging/{wsLogger.ts => eventStreamLogger.ts} (77%) create mode 100644 src/websocket/eventStreamConnection.ts create mode 100644 src/websocket/sseConnection.ts create mode 100644 src/websocket/utils.ts create mode 100644 test/unit/api/coderApi.test.ts rename test/unit/logging/{wsLogger.test.ts => eventStreamLogger.test.ts} (50%) diff --git a/src/api/coderApi.ts b/src/api/coderApi.ts index 99976ff7..6509ac67 100644 --- a/src/api/coderApi.ts +++ b/src/api/coderApi.ts @@ -6,17 +6,18 @@ import { } from "axios"; import { Api } from "coder/site/src/api/api"; import { + type ServerSentEvent, type GetInboxNotificationResponse, type ProvisionerJobLog, - type ServerSentEvent, type Workspace, type WorkspaceAgent, } from "coder/site/src/api/typesGenerated"; import * as vscode from "vscode"; -import { type ClientOptions } from "ws"; +import { type ClientOptions, type CloseEvent, type ErrorEvent } from "ws"; import { CertificateError } from "../error"; import { getHeaderCommand, getHeaders } from "../headers"; +import { EventStreamLogger } from "../logging/eventStreamLogger"; import { createRequestMeta, logRequest, @@ -29,11 +30,12 @@ import { HttpClientLogLevel, } from "../logging/types"; import { sizeOf } from "../logging/utils"; -import { WsLogger } from "../logging/wsLogger"; +import { type UnidirectionalStream } from "../websocket/eventStreamConnection"; import { OneWayWebSocket, type OneWayWebSocketInit, } from "../websocket/oneWayWebSocket"; +import { SseConnection } from "../websocket/sseConnection"; import { createHttpAgent } from "./utils"; @@ -84,8 +86,9 @@ export class CoderApi extends Api { }; watchWorkspace = async (workspace: Workspace, options?: ClientOptions) => { - return this.createWebSocket({ + return this.createWebSocketWithFallback({ apiRoute: `/api/v2/workspaces/${workspace.id}/watch-ws`, + fallbackApiRoute: `/api/v2/workspaces/${workspace.id}/watch`, options, }); }; @@ -94,8 +97,9 @@ export class CoderApi extends Api { agentId: WorkspaceAgent["id"], options?: ClientOptions, ) => { - return this.createWebSocket({ + return this.createWebSocketWithFallback({ apiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata-ws`, + fallbackApiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata`, options, }); }; @@ -103,6 +107,7 @@ export class CoderApi extends Api { watchBuildLogsByBuildId = async ( buildId: string, logs: ProvisionerJobLog[], + options?: ClientOptions, ) => { const searchParams = new URLSearchParams({ follow: "true" }); if (logs.length) { @@ -112,6 +117,7 @@ export class CoderApi extends Api { return this.createWebSocket({ apiRoute: `/api/v2/workspacebuilds/${buildId}/logs`, searchParams, + options, }); }; @@ -128,7 +134,7 @@ export class CoderApi extends Api { coderSessionTokenHeader ] as string | undefined; - const headers = await getHeaders( + const headersFromCommand = await getHeaders( baseUrlRaw, getHeaderCommand(vscode.workspace.getConfiguration()), this.output, @@ -137,43 +143,154 @@ export class CoderApi extends Api { const httpAgent = await createHttpAgent( vscode.workspace.getConfiguration(), ); + + /** + * Similar to the REST client, we want to prioritize headers in this order (highest to lowest): + * 1. Headers from the header command + * 2. Any headers passed directly to this function + * 3. Coder session token from the Api client (if set) + */ + const headers = { + ...(token ? { [coderSessionTokenHeader]: token } : {}), + ...configs.options?.headers, + ...headersFromCommand, + }; + const webSocket = new OneWayWebSocket({ location: baseUrl, ...configs, options: { + ...configs.options, agent: httpAgent, followRedirects: true, - headers: { - ...(token ? { [coderSessionTokenHeader]: token } : {}), - ...configs.options?.headers, - ...headers, - }, - ...configs.options, + headers, }, }); - const wsUrl = new URL(webSocket.url); - const pathWithQuery = wsUrl.pathname + wsUrl.search; - const wsLogger = new WsLogger(this.output, pathWithQuery); - wsLogger.logConnecting(); + this.attachStreamLogger(webSocket); + return webSocket; + } - webSocket.addEventListener("open", () => { - wsLogger.logOpen(); - }); + private attachStreamLogger( + connection: UnidirectionalStream, + ): void { + const url = new URL(connection.url); + const logger = new EventStreamLogger( + this.output, + url.pathname + url.search, + url.protocol.startsWith("http") ? "SSE" : "WS", + ); + logger.logConnecting(); - webSocket.addEventListener("message", (event) => { - wsLogger.logMessage(event.sourceEvent.data); - }); + connection.addEventListener("open", () => logger.logOpen()); + connection.addEventListener("close", (event: CloseEvent) => + logger.logClose(event.code, event.reason), + ); + connection.addEventListener("error", (event: ErrorEvent) => + logger.logError(event.error, event.message), + ); + connection.addEventListener("message", (event) => + logger.logMessage(event.sourceEvent.data), + ); + } - webSocket.addEventListener("close", (event) => { - wsLogger.logClose(event.code, event.reason); + /** + * Create a WebSocket connection with SSE fallback on 404. + * + * Note: The fallback on SSE ignores all passed client options except the headers. + */ + private async createWebSocketWithFallback(configs: { + apiRoute: string; + fallbackApiRoute: string; + searchParams?: Record | URLSearchParams; + options?: ClientOptions; + }): Promise> { + let webSocket: OneWayWebSocket; + try { + webSocket = await this.createWebSocket({ + apiRoute: configs.apiRoute, + searchParams: configs.searchParams, + options: configs.options, + }); + } catch { + // Failed to create WebSocket, use SSE fallback + return this.createSseFallback( + configs.fallbackApiRoute, + configs.searchParams, + configs.options?.headers, + ); + } + + return this.waitForConnection(webSocket, () => + this.createSseFallback( + configs.fallbackApiRoute, + configs.searchParams, + configs.options?.headers, + ), + ); + } + + private waitForConnection( + connection: UnidirectionalStream, + onNotFound?: () => Promise>, + ): Promise> { + return new Promise((resolve, reject) => { + const cleanup = () => { + connection.removeEventListener("open", handleOpen); + connection.removeEventListener("error", handleError); + }; + + const handleOpen = () => { + cleanup(); + resolve(connection); + }; + + const handleError = (event: ErrorEvent) => { + cleanup(); + const is404 = + event.message?.includes("404") || + event.error?.message?.includes("404"); + + if (is404 && onNotFound) { + connection.close(); + onNotFound().then(resolve).catch(reject); + } else { + reject(event.error || new Error(event.message)); + } + }; + + connection.addEventListener("open", handleOpen); + connection.addEventListener("error", handleError); }); + } + + /** + * Create SSE fallback connection + */ + private async createSseFallback( + apiRoute: string, + searchParams?: Record | URLSearchParams, + optionsHeaders?: Record, + ): Promise> { + this.output.warn(`WebSocket failed, using SSE fallback: ${apiRoute}`); + + const baseUrlRaw = this.getAxiosInstance().defaults.baseURL; + if (!baseUrlRaw) { + throw new Error("No base URL set on REST client"); + } - webSocket.addEventListener("error", (event) => { - wsLogger.logError(event.error, event.message); + const baseUrl = new URL(baseUrlRaw); + const sseConnection = new SseConnection({ + location: baseUrl, + apiRoute, + searchParams, + axiosInstance: this.getAxiosInstance(), + optionsHeaders: optionsHeaders, + logger: this.output, }); - return webSocket; + this.attachStreamLogger(sseConnection); + return this.waitForConnection(sseConnection); } } diff --git a/src/api/streamingFetchAdapter.ts b/src/api/streamingFetchAdapter.ts new file mode 100644 index 00000000..f0730535 --- /dev/null +++ b/src/api/streamingFetchAdapter.ts @@ -0,0 +1,71 @@ +import { type AxiosInstance } from "axios"; +import { type FetchLikeInit, type FetchLikeResponse } from "eventsource"; +import { type IncomingMessage } from "http"; + +/** + * Creates a fetch adapter using an Axios instance that returns streaming responses. + * This is used by EventSource to make authenticated SSE connections. + */ +export function createStreamingFetchAdapter( + axiosInstance: AxiosInstance, + configHeaders?: Record, +): (url: string | URL, init?: FetchLikeInit) => Promise { + return async ( + url: string | URL, + init?: FetchLikeInit, + ): Promise => { + const urlStr = url.toString(); + + const response = await axiosInstance.request({ + url: urlStr, + signal: init?.signal, + headers: { ...init?.headers, ...configHeaders }, + responseType: "stream", + validateStatus: () => true, // Don't throw on any status code + }); + + const stream = new ReadableStream({ + start(controller) { + response.data.on("data", (chunk: Buffer) => { + try { + controller.enqueue(chunk); + } catch { + // Stream already closed or errored, ignore + } + }); + + response.data.on("end", () => { + try { + controller.close(); + } catch { + // Stream already closed, ignore + } + }); + + response.data.on("error", (err: Error) => { + controller.error(err); + }); + }, + + cancel() { + response.data.destroy(); + return Promise.resolve(); + }, + }); + + return { + body: { + getReader: () => stream.getReader(), + }, + url: urlStr, + status: response.status, + redirected: response.request?.res?.responseUrl !== urlStr, + headers: { + get: (name: string) => { + const value = response.headers[name.toLowerCase()]; + return value === undefined ? null : String(value); + }, + }, + }; + }; +} diff --git a/src/logging/wsLogger.ts b/src/logging/eventStreamLogger.ts similarity index 77% rename from src/logging/wsLogger.ts rename to src/logging/eventStreamLogger.ts index fd6acd00..224f52b7 100644 --- a/src/logging/wsLogger.ts +++ b/src/logging/eventStreamLogger.ts @@ -12,31 +12,35 @@ const numFormatter = new Intl.NumberFormat("en", { compactDisplay: "short", }); -export class WsLogger { +export class EventStreamLogger { private readonly logger: Logger; private readonly url: string; private readonly id: string; + private readonly protocol: string; private readonly startedAt: number; private openedAt?: number; private msgCount = 0; private byteCount = 0; private unknownByteCount = false; - constructor(logger: Logger, url: string) { + constructor(logger: Logger, url: string, protocol: "WS" | "SSE") { this.logger = logger; this.url = url; + this.protocol = protocol; this.id = createRequestId(); this.startedAt = Date.now(); } logConnecting(): void { - this.logger.trace(`→ WS ${shortId(this.id)} ${this.url}`); + this.logger.trace(`→ ${this.protocol} ${shortId(this.id)} ${this.url}`); } logOpen(): void { this.openedAt = Date.now(); const time = formatTime(this.openedAt - this.startedAt); - this.logger.trace(`← WS ${shortId(this.id)} connected ${this.url} ${time}`); + this.logger.trace( + `← ${this.protocol} ${shortId(this.id)} connected ${this.url} ${time}`, + ); } logMessage(data: unknown): void { @@ -62,7 +66,7 @@ export class WsLogger { const statsStr = ` [${stats.join(", ")}]`; this.logger.trace( - `▣ WS ${shortId(this.id)} closed ${this.url}${codeStr}${reasonStr}${statsStr}`, + `▣ ${this.protocol} ${shortId(this.id)} closed ${this.url}${codeStr}${reasonStr}${statsStr}`, ); } @@ -70,7 +74,7 @@ export class WsLogger { const time = formatTime(Date.now() - this.startedAt); const errorMsg = message || errToStr(error, "connection error"); this.logger.error( - `✗ WS ${shortId(this.id)} error ${this.url} ${time} - ${errorMsg}`, + `✗ ${this.protocol} ${shortId(this.id)} error ${this.url} ${time} - ${errorMsg}`, error, ); } diff --git a/src/websocket/eventStreamConnection.ts b/src/websocket/eventStreamConnection.ts new file mode 100644 index 00000000..2dc6514e --- /dev/null +++ b/src/websocket/eventStreamConnection.ts @@ -0,0 +1,51 @@ +import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; +import { + type CloseEvent, + type Event as WsEvent, + type ErrorEvent, + type MessageEvent, +} from "ws"; + +// Event payload types matching OneWayWebSocket +export type ParsedMessageEvent = Readonly< + | { + sourceEvent: MessageEvent; + parsedMessage: TData; + parseError: undefined; + } + | { + sourceEvent: MessageEvent; + parsedMessage: undefined; + parseError: Error; + } +>; + +export type EventPayloadMap = { + close: CloseEvent; + error: ErrorEvent; + message: ParsedMessageEvent; + open: WsEvent; +}; + +export type EventHandler = ( + payload: EventPayloadMap[TEvent], +) => void; + +/** + * Common interface for both WebSocket and SSE connections that handle event streams. + * Matches the OneWayWebSocket interface for compatibility. + */ +export interface UnidirectionalStream { + readonly url: string; + addEventListener( + eventType: TEvent, + callback: EventHandler, + ): void; + + removeEventListener( + eventType: TEvent, + callback: EventHandler, + ): void; + + close(code?: number, reason?: string): void; +} diff --git a/src/websocket/oneWayWebSocket.ts b/src/websocket/oneWayWebSocket.ts index 37965596..c27b1fe4 100644 --- a/src/websocket/oneWayWebSocket.ts +++ b/src/websocket/oneWayWebSocket.ts @@ -8,51 +8,13 @@ */ import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; -import Ws, { - type ClientOptions, - type CloseEvent, - type ErrorEvent, - type Event, - type MessageEvent, - type RawData, -} from "ws"; +import Ws, { type ClientOptions, type MessageEvent, type RawData } from "ws"; -export type OneWayMessageEvent = Readonly< - | { - sourceEvent: MessageEvent; - parsedMessage: TData; - parseError: undefined; - } - | { - sourceEvent: MessageEvent; - parsedMessage: undefined; - parseError: Error; - } ->; - -type OneWayEventPayloadMap = { - close: CloseEvent; - error: ErrorEvent; - message: OneWayMessageEvent; - open: Event; -}; - -type OneWayEventCallback = ( - payload: OneWayEventPayloadMap[TEvent], -) => void; - -interface OneWayWebSocketApi { - get url(): string; - addEventListener( - eventType: TEvent, - callback: OneWayEventCallback, - ): void; - removeEventListener( - eventType: TEvent, - callback: OneWayEventCallback, - ): void; - close(code?: number, reason?: string): void; -} +import { + type UnidirectionalStream, + type EventHandler, +} from "./eventStreamConnection"; +import { getQueryString } from "./utils"; export type OneWayWebSocketInit = { location: { protocol: string; host: string }; @@ -63,23 +25,18 @@ export type OneWayWebSocketInit = { }; export class OneWayWebSocket - implements OneWayWebSocketApi + implements UnidirectionalStream { readonly #socket: Ws; readonly #messageCallbacks = new Map< - OneWayEventCallback, + EventHandler, (data: RawData) => void >(); constructor(init: OneWayWebSocketInit) { const { location, apiRoute, protocols, options, searchParams } = init; - const formattedParams = - searchParams instanceof URLSearchParams - ? searchParams - : new URLSearchParams(searchParams); - const paramsString = formattedParams.toString(); - const paramsSuffix = paramsString ? `?${paramsString}` : ""; + const paramsSuffix = getQueryString(searchParams); const wsProtocol = location.protocol === "https:" ? "wss:" : "ws:"; const url = `${wsProtocol}//${location.host}${apiRoute}${paramsSuffix}`; @@ -92,10 +49,10 @@ export class OneWayWebSocket addEventListener( event: TEvent, - callback: OneWayEventCallback, + callback: EventHandler, ): void { if (event === "message") { - const messageCallback = callback as OneWayEventCallback; + const messageCallback = callback as EventHandler; if (this.#messageCallbacks.has(messageCallback)) { return; @@ -128,10 +85,10 @@ export class OneWayWebSocket removeEventListener( event: TEvent, - callback: OneWayEventCallback, + callback: EventHandler, ): void { if (event === "message") { - const messageCallback = callback as OneWayEventCallback; + const messageCallback = callback as EventHandler; const wrapper = this.#messageCallbacks.get(messageCallback); if (wrapper) { diff --git a/src/websocket/sseConnection.ts b/src/websocket/sseConnection.ts new file mode 100644 index 00000000..834100aa --- /dev/null +++ b/src/websocket/sseConnection.ts @@ -0,0 +1,221 @@ +import { type AxiosInstance } from "axios"; +import { type ServerSentEvent } from "coder/site/src/api/typesGenerated"; +import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; +import { EventSource } from "eventsource"; + +import { createStreamingFetchAdapter } from "../api/streamingFetchAdapter"; +import { type Logger } from "../logging/logger"; + +import { getQueryString } from "./utils"; + +import type { + CloseEvent as WsCloseEvent, + ErrorEvent as WsErrorEvent, + Event as WsEvent, + MessageEvent as WsMessageEvent, +} from "ws"; + +import type { + UnidirectionalStream, + ParsedMessageEvent, + EventHandler, +} from "./eventStreamConnection"; + +export type SseConnectionInit = { + location: { protocol: string; host: string }; + apiRoute: string; + searchParams?: Record | URLSearchParams; + optionsHeaders?: Record; + axiosInstance: AxiosInstance; + logger: Logger; +}; + +export class SseConnection implements UnidirectionalStream { + private readonly eventSource: EventSource; + private readonly logger: Logger; + private readonly callbacks = { + open: new Set>(), + close: new Set>(), + error: new Set>(), + }; + // Original callback -> wrapped callback + private readonly messageWrappers = new Map< + EventHandler, + (event: MessageEvent) => void + >(); + + public readonly url: string; + + public constructor(init: SseConnectionInit) { + this.logger = init.logger; + this.url = this.buildUrl(init); + this.eventSource = new EventSource(this.url, { + fetch: createStreamingFetchAdapter( + init.axiosInstance, + init.optionsHeaders, + ), + }); + this.setupEventHandlers(); + } + + private buildUrl(init: SseConnectionInit): string { + const { location, apiRoute, searchParams } = init; + const queryString = getQueryString(searchParams); + return `${location.protocol}//${location.host}${apiRoute}${queryString}`; + } + + private setupEventHandlers(): void { + this.eventSource.addEventListener("open", () => + this.invokeCallbacks(this.callbacks.open, {} as WsEvent, "open"), + ); + + this.eventSource.addEventListener("data", (event: MessageEvent) => { + this.invokeCallbacks(this.messageWrappers.values(), event, "message"); + }); + + this.eventSource.addEventListener("error", (error: Event | ErrorEvent) => { + this.invokeCallbacks( + this.callbacks.error, + this.createErrorEvent(error), + "error", + ); + + if (this.eventSource.readyState === EventSource.CLOSED) { + this.invokeCallbacks( + this.callbacks.close, + { + code: 1006, + reason: "Connection lost", + wasClean: false, + } as WsCloseEvent, + "close", + ); + } + }); + } + + private invokeCallbacks( + callbacks: Iterable<(event: T) => void>, + event: T, + eventType: string, + ): void { + for (const cb of callbacks) { + try { + cb(event); + } catch (err) { + this.logger.error(`Error in SSE ${eventType} callback:`, err); + } + } + } + + private createErrorEvent(event: Event | ErrorEvent): WsErrorEvent { + const errorMessage = + event instanceof ErrorEvent && event.message + ? event.message + : "SSE connection error"; + const error = event instanceof ErrorEvent ? event.error : undefined; + + return { + error: error, + message: errorMessage, + } as WsErrorEvent; + } + + public addEventListener( + event: TEvent, + callback: EventHandler, + ): void { + switch (event) { + case "close": + this.callbacks.close.add( + callback as EventHandler, + ); + break; + case "error": + this.callbacks.error.add( + callback as EventHandler, + ); + break; + case "message": { + const messageCallback = callback as EventHandler< + ServerSentEvent, + "message" + >; + if (!this.messageWrappers.has(messageCallback)) { + this.messageWrappers.set(messageCallback, (event: MessageEvent) => { + messageCallback(this.parseMessage(event)); + }); + } + break; + } + case "open": + this.callbacks.open.add( + callback as EventHandler, + ); + break; + } + } + + private parseMessage( + event: MessageEvent, + ): ParsedMessageEvent { + const wsEvent = { data: event.data } as WsMessageEvent; + try { + return { + sourceEvent: wsEvent, + parsedMessage: { type: "data", data: JSON.parse(event.data) }, + parseError: undefined, + }; + } catch (err) { + return { + sourceEvent: wsEvent, + parsedMessage: undefined, + parseError: err as Error, + }; + } + } + + public removeEventListener( + event: TEvent, + callback: EventHandler, + ): void { + switch (event) { + case "close": + this.callbacks.close.delete( + callback as EventHandler, + ); + break; + case "error": + this.callbacks.error.delete( + callback as EventHandler, + ); + break; + case "message": + this.messageWrappers.delete( + callback as EventHandler, + ); + break; + case "open": + this.callbacks.open.delete( + callback as EventHandler, + ); + break; + } + } + + public close(code?: number, reason?: string): void { + this.eventSource.close(); + this.invokeCallbacks( + this.callbacks.close, + { + code: code ?? 1000, + reason: reason ?? "Normal closure", + wasClean: true, + } as WsCloseEvent, + "close", + ); + + Object.values(this.callbacks).forEach((callbackSet) => callbackSet.clear()); + this.messageWrappers.clear(); + } +} diff --git a/src/websocket/utils.ts b/src/websocket/utils.ts new file mode 100644 index 00000000..592ce45e --- /dev/null +++ b/src/websocket/utils.ts @@ -0,0 +1,15 @@ +/** + * Converts params to a query string. Returns empty string if no params, + * otherwise returns params prefixed with '?'. + */ +export function getQueryString( + params: Record | URLSearchParams | undefined, +): string { + if (!params) { + return ""; + } + const searchParams = + params instanceof URLSearchParams ? params : new URLSearchParams(params); + const str = searchParams.toString(); + return str ? `?${str}` : ""; +} diff --git a/src/workspace/workspaceMonitor.ts b/src/workspace/workspaceMonitor.ts index a761249a..ceea8a91 100644 --- a/src/workspace/workspaceMonitor.ts +++ b/src/workspace/workspaceMonitor.ts @@ -9,7 +9,7 @@ import { createWorkspaceIdentifier, errToStr } from "../api/api-helper"; import { type CoderApi } from "../api/coderApi"; import { type ContextManager } from "../core/contextManager"; import { type Logger } from "../logging/logger"; -import { type OneWayWebSocket } from "../websocket/oneWayWebSocket"; +import { type UnidirectionalStream } from "../websocket/eventStreamConnection"; /** * Monitor a single workspace using a WebSocket for events like shutdown and deletion. @@ -17,7 +17,7 @@ import { type OneWayWebSocket } from "../websocket/oneWayWebSocket"; * workspace status is also shown in the status bar menu. */ export class WorkspaceMonitor implements vscode.Disposable { - private socket: OneWayWebSocket | undefined; + private socket: UnidirectionalStream | undefined; private disposed = false; // How soon in advance to notify about autostop and deletion. @@ -93,10 +93,12 @@ export class WorkspaceMonitor implements vscode.Disposable { return; } // Perhaps we need to parse this and validate it. - const newWorkspaceData = event.parsedMessage.data as Workspace; - monitor.update(newWorkspaceData); - monitor.maybeNotify(newWorkspaceData); - monitor.onChange.fire(newWorkspaceData); + const newWorkspaceData = event.parsedMessage.data as Workspace | null; + if (newWorkspaceData) { + monitor.update(newWorkspaceData); + monitor.maybeNotify(newWorkspaceData); + monitor.onChange.fire(newWorkspaceData); + } } catch (error) { monitor.notifyError(error); } diff --git a/test/unit/api/coderApi.test.ts b/test/unit/api/coderApi.test.ts new file mode 100644 index 00000000..0336d564 --- /dev/null +++ b/test/unit/api/coderApi.test.ts @@ -0,0 +1,431 @@ +import axios, { AxiosError, AxiosHeaders } from "axios"; +import { type ProvisionerJobLog } from "coder/site/src/api/typesGenerated"; +import { EventSource } from "eventsource"; +import { ProxyAgent } from "proxy-agent"; +import { describe, it, expect, vi, beforeEach } from "vitest"; +import Ws from "ws"; + +import { CoderApi } from "@/api/coderApi"; +import { createHttpAgent } from "@/api/utils"; +import { CertificateError } from "@/error"; +import { getHeaders } from "@/headers"; +import { type RequestConfigWithMeta } from "@/logging/types"; +import { OneWayWebSocket } from "@/websocket/oneWayWebSocket"; +import { SseConnection } from "@/websocket/sseConnection"; + +import { + createMockLogger, + MockConfigurationProvider, +} from "../../mocks/testHelpers"; + +const CODER_URL = "https://coder.example.com"; +const AXIOS_TOKEN = "passed-token"; +const BUILD_ID = "build-123"; +const AGENT_ID = "agent-123"; + +vi.mock("ws"); +vi.mock("eventsource"); +vi.mock("proxy-agent"); + +vi.mock("axios", async () => { + const actual = await vi.importActual("axios"); + + const mockAdapter = vi.fn(mockAdapterImpl); + + const mockDefault = { + ...actual.default, + create: vi.fn((config) => { + const instance = actual.default.create({ + ...config, + adapter: mockAdapter, + }); + return instance; + }), + __mockAdapter: mockAdapter, + }; + + return { + ...actual, + default: mockDefault, + }; +}); + +vi.mock("@/headers", () => ({ + getHeaders: vi.fn().mockResolvedValue({}), + getHeaderCommand: vi.fn(), +})); + +vi.mock("@/api/utils", () => ({ + createHttpAgent: vi.fn(), +})); + +vi.mock("@/api/streamingFetchAdapter", () => ({ + createStreamingFetchAdapter: vi.fn(() => fetch), +})); + +describe("CoderApi", () => { + let mockLogger: ReturnType; + let mockConfig: MockConfigurationProvider; + let mockAdapter: ReturnType; + let api: CoderApi; + + const createApi = (url = CODER_URL, token = AXIOS_TOKEN) => { + return CoderApi.create(url, token, mockLogger); + }; + + beforeEach(() => { + vi.resetAllMocks(); + + const axiosMock = axios as typeof axios & { + __mockAdapter: ReturnType; + }; + mockAdapter = axiosMock.__mockAdapter; + mockAdapter.mockImplementation(mockAdapterImpl); + + vi.mocked(getHeaders).mockResolvedValue({}); + mockLogger = createMockLogger(); + mockConfig = new MockConfigurationProvider(); + mockConfig.set("coder.httpClientLogLevel", "BASIC"); + }); + + describe("HTTP Interceptors", () => { + it("adds custom headers and HTTP agent to requests", async () => { + const mockAgent = new ProxyAgent(); + vi.mocked(createHttpAgent).mockResolvedValue(mockAgent); + vi.mocked(getHeaders).mockResolvedValue({ + "X-Custom-Header": "custom-value", + "X-Another-Header": "another-value", + }); + + const api = createApi(); + const response = await api.getAxiosInstance().get("/api/v2/users/me"); + + expect(response.config.headers["X-Custom-Header"]).toBe("custom-value"); + expect(response.config.headers["X-Another-Header"]).toBe("another-value"); + expect(response.config.httpsAgent).toBe(mockAgent); + expect(response.config.httpAgent).toBe(mockAgent); + expect(response.config.proxy).toBe(false); + }); + + it("wraps certificate errors in response interceptor", async () => { + const api = createApi(); + const certError = new AxiosError( + "self signed certificate", + "DEPTH_ZERO_SELF_SIGNED_CERT", + ); + mockAdapter.mockRejectedValueOnce(certError); + + const thrownError = await api + .getAxiosInstance() + .get("/api/v2/users/me") + .catch((e) => e); + + expect(thrownError).toBeInstanceOf(CertificateError); + expect(thrownError.message).toContain("Secure connection"); + expect(thrownError.x509Err).toBeDefined(); + }); + + it("applies headers in correct precedence order (command > config > axios default)", async () => { + const api = createApi(CODER_URL, AXIOS_TOKEN); + + // Test 1: Headers from config, default token from API creation + const response = await api.getAxiosInstance().get("/api/v2/users/me", { + headers: new AxiosHeaders({ + "X-Custom-Header": "from-config", + "X-Extra": "extra-value", + }), + }); + + expect(response.config.headers["X-Custom-Header"]).toBe("from-config"); + expect(response.config.headers["X-Extra"]).toBe("extra-value"); + expect(response.config.headers["Coder-Session-Token"]).toBe(AXIOS_TOKEN); + + // Test 2: Token from request options overrides default + const responseWithToken = await api + .getAxiosInstance() + .get("/api/v2/users/me", { + headers: new AxiosHeaders({ + "Coder-Session-Token": "from-options", + }), + }); + + expect(responseWithToken.config.headers["Coder-Session-Token"]).toBe( + "from-options", + ); + + // Test 3: Header command overrides everything + vi.mocked(getHeaders).mockResolvedValue({ + "Coder-Session-Token": "from-header-command", + }); + + const responseWithHeaderCommand = await api + .getAxiosInstance() + .get("/api/v2/users/me", { + headers: new AxiosHeaders({ + "Coder-Session-Token": "from-options", + }), + }); + + expect( + responseWithHeaderCommand.config.headers["Coder-Session-Token"], + ).toBe("from-header-command"); + }); + + it("logs requests and responses", async () => { + const api = createApi(); + + await api.getWorkspaces({}); + + expect(mockLogger.trace).toHaveBeenCalledWith( + expect.stringContaining("/api/v2/workspaces"), + ); + }); + + it("calculates request and response sizes in transforms", async () => { + const api = createApi(); + const response = await api + .getAxiosInstance() + .post("/api/v2/workspaces", { name: "test" }); + + expect((response.config as RequestConfigWithMeta).rawRequestSize).toBe( + 15, + ); + // We return the same data we sent in the mock adapter + expect((response.config as RequestConfigWithMeta).rawResponseSize).toBe( + 15, + ); + }); + }); + + describe("WebSocket Creation", () => { + const wsUrl = `wss://${CODER_URL.replace("https://", "")}/api/v2/workspacebuilds/${BUILD_ID}/logs?follow=true`; + + beforeEach(() => { + api = createApi(CODER_URL, AXIOS_TOKEN); + const mockWs = createMockWebSocket(wsUrl); + setupWebSocketMock(mockWs); + }); + + it("creates WebSocket with proper headers and configuration", async () => { + const mockAgent = new ProxyAgent(); + vi.mocked(getHeaders).mockResolvedValue({ + "X-Custom-Header": "custom-value", + }); + vi.mocked(createHttpAgent).mockResolvedValue(mockAgent); + + await api.watchBuildLogsByBuildId(BUILD_ID, []); + + expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, { + agent: mockAgent, + followRedirects: true, + headers: { + "X-Custom-Header": "custom-value", + "Coder-Session-Token": AXIOS_TOKEN, + }, + }); + }); + + it("applies headers in correct precedence order (command > config > axios default)", async () => { + // Test 1: Default token from API creation + await api.watchBuildLogsByBuildId(BUILD_ID, []); + + expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, { + agent: undefined, + followRedirects: true, + headers: { + "Coder-Session-Token": AXIOS_TOKEN, + }, + }); + + // Test 2: Token from config options overrides default + await api.watchBuildLogsByBuildId(BUILD_ID, [], { + headers: { + "X-Config-Header": "config-value", + "Coder-Session-Token": "from-config", + }, + }); + + expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, { + agent: undefined, + followRedirects: true, + headers: { + "Coder-Session-Token": "from-config", + "X-Config-Header": "config-value", + }, + }); + + // Test 3: Header command overrides everything + vi.mocked(getHeaders).mockResolvedValue({ + "Coder-Session-Token": "from-header-command", + }); + + await api.watchBuildLogsByBuildId(BUILD_ID, [], { + headers: { + "Coder-Session-Token": "from-config", + }, + }); + + expect(Ws).toHaveBeenCalledWith(wsUrl, undefined, { + agent: undefined, + followRedirects: true, + headers: { + "Coder-Session-Token": "from-header-command", + }, + }); + }); + + it("logs WebSocket connections", async () => { + await api.watchBuildLogsByBuildId(BUILD_ID, []); + + expect(mockLogger.trace).toHaveBeenCalledWith( + expect.stringContaining(BUILD_ID), + ); + }); + + it("'watchBuildLogsByBuildId' includes after parameter for existing logs", async () => { + const jobLog: ProvisionerJobLog = { + created_at: new Date().toISOString(), + id: 1, + output: "log1", + log_source: "provisioner", + log_level: "info", + stage: "stage1", + }; + const existingLogs = [ + jobLog, + { ...jobLog, id: 20 }, + { ...jobLog, id: 5 }, + ]; + + await api.watchBuildLogsByBuildId(BUILD_ID, existingLogs); + + expect(Ws).toHaveBeenCalledWith( + expect.stringContaining("after=5"), + undefined, + expect.any(Object), + ); + }); + }); + + describe("SSE Fallback", () => { + beforeEach(() => { + api = createApi(); + const mockEventSource = createMockEventSource( + `${CODER_URL}/api/v2/workspaces/123/watch`, + ); + setupEventSourceMock(mockEventSource); + }); + + it("uses WebSocket when no errors occur", async () => { + const mockWs = createMockWebSocket( + `wss://${CODER_URL.replace("https://", "")}/api/v2/workspaceagents/${AGENT_ID}/watch-metadata`, + { + on: vi.fn((event, handler) => { + if (event === "open") { + setImmediate(() => handler()); + } + return mockWs as Ws; + }), + }, + ); + setupWebSocketMock(mockWs); + + const connection = await api.watchAgentMetadata(AGENT_ID); + + expect(connection).toBeInstanceOf(OneWayWebSocket); + expect(EventSource).not.toHaveBeenCalled(); + }); + + it("falls back to SSE when WebSocket creation fails", async () => { + vi.mocked(Ws).mockImplementation(() => { + throw new Error("WebSocket creation failed"); + }); + + const connection = await api.watchAgentMetadata(AGENT_ID); + + expect(connection).toBeInstanceOf(SseConnection); + expect(EventSource).toHaveBeenCalled(); + }); + + it("falls back to SSE on 404 error from WebSocket", async () => { + const mockWs = createMockWebSocket( + `wss://${CODER_URL.replace("https://", "")}/api/v2/test`, + { + on: vi.fn((event: string, handler: (e: unknown) => void) => { + if (event === "error") { + setImmediate(() => { + handler({ + error: new Error("404 Not Found"), + message: "404 Not Found", + }); + }); + } + return mockWs as Ws; + }), + }, + ); + setupWebSocketMock(mockWs); + + const connection = await api.watchAgentMetadata(AGENT_ID); + + expect(connection).toBeInstanceOf(SseConnection); + expect(EventSource).toHaveBeenCalled(); + }); + }); + + describe("Error Handling", () => { + it("throws error when no base URL is set", async () => { + const api = createApi(); + api.getAxiosInstance().defaults.baseURL = undefined; + + await expect(api.watchBuildLogsByBuildId(BUILD_ID, [])).rejects.toThrow( + "No base URL set on REST client", + ); + }); + }); +}); + +const mockAdapterImpl = vi.hoisted(() => (config: Record) => { + return Promise.resolve({ + data: config.data || "{}", + status: 200, + statusText: "OK", + headers: {}, + config, + }); +}); + +function createMockWebSocket( + url: string, + overrides?: Partial, +): Partial { + return { + url, + on: vi.fn(), + off: vi.fn(), + close: vi.fn(), + ...overrides, + }; +} + +function createMockEventSource(url: string): Partial { + return { + url, + readyState: EventSource.CONNECTING, + addEventListener: vi.fn((event, handler) => { + if (event === "open") { + setImmediate(() => handler(new Event("open"))); + } + }), + removeEventListener: vi.fn(), + close: vi.fn(), + }; +} + +function setupWebSocketMock(ws: Partial): void { + vi.mocked(Ws).mockImplementation(() => ws as Ws); +} + +function setupEventSourceMock(es: Partial): void { + vi.mocked(EventSource).mockImplementation(() => es as EventSource); +} diff --git a/test/unit/logging/wsLogger.test.ts b/test/unit/logging/eventStreamLogger.test.ts similarity index 50% rename from test/unit/logging/wsLogger.test.ts rename to test/unit/logging/eventStreamLogger.test.ts index 5bf9d5b1..352ccaac 100644 --- a/test/unit/logging/wsLogger.test.ts +++ b/test/unit/logging/eventStreamLogger.test.ts @@ -1,19 +1,23 @@ import { describe, expect, it } from "vitest"; -import { WsLogger } from "@/logging/wsLogger"; +import { EventStreamLogger } from "@/logging/eventStreamLogger"; import { createMockLogger } from "../../mocks/testHelpers"; -describe("WS Logger", () => { +describe("EventStreamLogger", () => { it("tracks message count and byte size", () => { const logger = createMockLogger(); - const wsLogger = new WsLogger(logger, "wss://example.com"); + const eventStreamLogger = new EventStreamLogger( + logger, + "wss://example.com", + "WS", + ); - wsLogger.logOpen(); - wsLogger.logMessage("hello"); - wsLogger.logMessage("world"); - wsLogger.logMessage(Buffer.from("test")); - wsLogger.logClose(); + eventStreamLogger.logOpen(); + eventStreamLogger.logMessage("hello"); + eventStreamLogger.logMessage("world"); + eventStreamLogger.logMessage(Buffer.from("test")); + eventStreamLogger.logClose(); expect(logger.trace).toHaveBeenCalledWith( expect.stringContaining("3 msgs"), @@ -23,12 +27,16 @@ describe("WS Logger", () => { it("handles unknown byte sizes with >= indicator", () => { const logger = createMockLogger(); - const wsLogger = new WsLogger(logger, "wss://example.com"); + const eventStreamLogger = new EventStreamLogger( + logger, + "wss://example.com", + "WS", + ); - wsLogger.logOpen(); - wsLogger.logMessage({ complex: "object" }); // Unknown size - no estimation - wsLogger.logMessage("known"); - wsLogger.logClose(); + eventStreamLogger.logOpen(); + eventStreamLogger.logMessage({ complex: "object" }); // Unknown size - no estimation + eventStreamLogger.logMessage("known"); + eventStreamLogger.logClose(); expect(logger.trace).toHaveBeenLastCalledWith( expect.stringContaining(">= 5 B"), @@ -37,22 +45,30 @@ describe("WS Logger", () => { it("handles close before open gracefully", () => { const logger = createMockLogger(); - const wsLogger = new WsLogger(logger, "wss://example.com"); + const eventStreamLogger = new EventStreamLogger( + logger, + "wss://example.com", + "WS", + ); // Closing without opening should not throw - expect(() => wsLogger.logClose()).not.toThrow(); + expect(() => eventStreamLogger.logClose()).not.toThrow(); expect(logger.trace).toHaveBeenCalled(); }); it("formats large message counts with compact notation", () => { const logger = createMockLogger(); - const wsLogger = new WsLogger(logger, "wss://example.com"); + const eventStreamLogger = new EventStreamLogger( + logger, + "wss://example.com", + "WS", + ); - wsLogger.logOpen(); + eventStreamLogger.logOpen(); for (let i = 0; i < 1100; i++) { - wsLogger.logMessage("x"); + eventStreamLogger.logMessage("x"); } - wsLogger.logClose(); + eventStreamLogger.logClose(); expect(logger.trace).toHaveBeenLastCalledWith( expect.stringMatching(/1[.,]1K\s*msgs/), @@ -61,10 +77,14 @@ describe("WS Logger", () => { it("logs errors with error object", () => { const logger = createMockLogger(); - const wsLogger = new WsLogger(logger, "wss://example.com"); + const eventStreamLogger = new EventStreamLogger( + logger, + "wss://example.com", + "WS", + ); const error = new Error("Connection failed"); - wsLogger.logError(error, "Failed to connect"); + eventStreamLogger.logError(error, "Failed to connect"); expect(logger.error).toHaveBeenCalledWith(expect.any(String), error); }); From 3c499bafbd0a1a278684e45c0262c3b0837c8917 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 21 Oct 2025 12:19:06 +0300 Subject: [PATCH 04/55] Add SSE Connection and streamingFetchAdapter tests (#625) --- src/api/coderApi.ts | 11 +- src/api/streamingFetchAdapter.ts | 2 +- src/websocket/sseConnection.ts | 9 +- test/unit/api/coderApi.test.ts | 4 +- test/unit/api/streamingFetchAdapter.test.ts | 220 ++++++++++++ test/unit/core/cliManager.test.ts | 5 +- test/unit/logging/utils.test.ts | 3 +- test/unit/websocket/sseConnection.test.ts | 356 ++++++++++++++++++++ vitest.config.ts | 2 +- 9 files changed, 595 insertions(+), 17 deletions(-) create mode 100644 test/unit/api/streamingFetchAdapter.test.ts create mode 100644 test/unit/websocket/sseConnection.test.ts diff --git a/src/api/coderApi.ts b/src/api/coderApi.ts index 6509ac67..da624bad 100644 --- a/src/api/coderApi.ts +++ b/src/api/coderApi.ts @@ -110,8 +110,9 @@ export class CoderApi extends Api { options?: ClientOptions, ) => { const searchParams = new URLSearchParams({ follow: "true" }); - if (logs.length) { - searchParams.append("after", logs[logs.length - 1].id.toString()); + const lastLog = logs.at(-1); + if (lastLog) { + searchParams.append("after", lastLog.id.toString()); } return this.createWebSocket({ @@ -311,9 +312,9 @@ function setupInterceptors( output, ); // Add headers from the header command. - Object.entries(headers).forEach(([key, value]) => { + for (const [key, value] of Object.entries(headers)) { config.headers[key] = value; - }); + } // Configure proxy and TLS. // Note that by default VS Code overrides the agent. To prevent this, set @@ -425,7 +426,7 @@ function wrapResponseTransform( function getSize(headers: AxiosHeaders, data: unknown): number | undefined { const contentLength = headers["content-length"]; if (contentLength !== undefined) { - return parseInt(contentLength, 10); + return Number.parseInt(contentLength, 10); } return sizeOf(data); diff --git a/src/api/streamingFetchAdapter.ts b/src/api/streamingFetchAdapter.ts index f0730535..f23ef1a7 100644 --- a/src/api/streamingFetchAdapter.ts +++ b/src/api/streamingFetchAdapter.ts @@ -1,6 +1,6 @@ import { type AxiosInstance } from "axios"; import { type FetchLikeInit, type FetchLikeResponse } from "eventsource"; -import { type IncomingMessage } from "http"; +import { type IncomingMessage } from "node:http"; /** * Creates a fetch adapter using an Axios instance that returns streaming responses. diff --git a/src/websocket/sseConnection.ts b/src/websocket/sseConnection.ts index 834100aa..5a71d303 100644 --- a/src/websocket/sseConnection.ts +++ b/src/websocket/sseConnection.ts @@ -109,11 +109,10 @@ export class SseConnection implements UnidirectionalStream { } private createErrorEvent(event: Event | ErrorEvent): WsErrorEvent { - const errorMessage = - event instanceof ErrorEvent && event.message - ? event.message - : "SSE connection error"; - const error = event instanceof ErrorEvent ? event.error : undefined; + // Check for properties instead of instanceof to avoid browser-only ErrorEvent global + const eventWithMessage = event as { message?: string; error?: unknown }; + const errorMessage = eventWithMessage.message || "SSE connection error"; + const error = eventWithMessage.error; return { error: error, diff --git a/test/unit/api/coderApi.test.ts b/test/unit/api/coderApi.test.ts index 0336d564..f133a72d 100644 --- a/test/unit/api/coderApi.test.ts +++ b/test/unit/api/coderApi.test.ts @@ -125,7 +125,7 @@ describe("CoderApi", () => { expect(thrownError.x509Err).toBeDefined(); }); - it("applies headers in correct precedence order (command > config > axios default)", async () => { + it("applies headers in correct precedence order (command overrides config overrides axios default)", async () => { const api = createApi(CODER_URL, AXIOS_TOKEN); // Test 1: Headers from config, default token from API creation @@ -225,7 +225,7 @@ describe("CoderApi", () => { }); }); - it("applies headers in correct precedence order (command > config > axios default)", async () => { + it("applies headers in correct precedence order (command overrides config overrides axios default)", async () => { // Test 1: Default token from API creation await api.watchBuildLogsByBuildId(BUILD_ID, []); diff --git a/test/unit/api/streamingFetchAdapter.test.ts b/test/unit/api/streamingFetchAdapter.test.ts new file mode 100644 index 00000000..0ba8437b --- /dev/null +++ b/test/unit/api/streamingFetchAdapter.test.ts @@ -0,0 +1,220 @@ +import { type AxiosInstance, type AxiosResponse } from "axios"; +import { type ReaderLike } from "eventsource"; +import { EventEmitter } from "node:events"; +import { type IncomingMessage } from "node:http"; +import { describe, it, expect, vi } from "vitest"; + +import { createStreamingFetchAdapter } from "@/api/streamingFetchAdapter"; + +const TEST_URL = "https://example.com/api"; + +describe("createStreamingFetchAdapter", () => { + describe("Request Handling", () => { + it("passes URL, signal, and responseType to axios", async () => { + const mockAxios = createAxiosMock(); + const mockStream = createMockStream(); + setupAxiosResponse(mockAxios, 200, {}, mockStream); + + const adapter = createStreamingFetchAdapter(mockAxios); + const signal = new AbortController().signal; + + await adapter(TEST_URL, { signal }); + + expect(mockAxios.request).toHaveBeenCalledWith({ + url: TEST_URL, + signal, // correctly passes signal + headers: {}, + responseType: "stream", + validateStatus: expect.any(Function), + }); + }); + + it("applies headers in correct precedence order (config overrides init)", async () => { + const mockAxios = createAxiosMock(); + const mockStream = createMockStream(); + setupAxiosResponse(mockAxios, 200, {}, mockStream); + + // Test 1: No config headers, only init headers + const adapter1 = createStreamingFetchAdapter(mockAxios); + await adapter1(TEST_URL, { + headers: { "X-Init": "init-value" }, + }); + + expect(mockAxios.request).toHaveBeenCalledWith( + expect.objectContaining({ + headers: { "X-Init": "init-value" }, + }), + ); + + // Test 2: Config headers merge with init headers + const adapter2 = createStreamingFetchAdapter(mockAxios, { + "X-Config": "config-value", + }); + await adapter2(TEST_URL, { + headers: { "X-Init": "init-value" }, + }); + + expect(mockAxios.request).toHaveBeenCalledWith( + expect.objectContaining({ + headers: { + "X-Init": "init-value", + "X-Config": "config-value", + }, + }), + ); + + // Test 3: Config headers override init headers + const adapter3 = createStreamingFetchAdapter(mockAxios, { + "X-Header": "config-value", + }); + await adapter3(TEST_URL, { + headers: { "X-Header": "init-value" }, + }); + + expect(mockAxios.request).toHaveBeenCalledWith( + expect.objectContaining({ + headers: { "X-Header": "config-value" }, + }), + ); + }); + }); + + describe("Response Properties", () => { + it("returns response with correct properties", async () => { + const mockAxios = createAxiosMock(); + const mockStream = createMockStream(); + setupAxiosResponse( + mockAxios, + 200, + { "content-type": "text/event-stream" }, + mockStream, + ); + + const adapter = createStreamingFetchAdapter(mockAxios); + const response = await adapter(TEST_URL); + + expect(response.url).toBe(TEST_URL); + expect(response.status).toBe(200); + expect(response.headers.get("content-type")).toBe("text/event-stream"); + // Headers are lowercased when we retrieve them + expect(response.headers.get("CoNtEnT-TyPe")).toBe("text/event-stream"); + expect(response.body?.getReader).toBeDefined(); + }); + + it("detects redirected requests", async () => { + const mockAxios = createAxiosMock(); + const mockStream = createMockStream(); + const mockResponse = { + status: 200, + headers: {}, + data: mockStream, + request: { + res: { + responseUrl: "https://redirect.com/api", + }, + }, + } as AxiosResponse; + vi.mocked(mockAxios.request).mockResolvedValue(mockResponse); + + const adapter = createStreamingFetchAdapter(mockAxios); + const response = await adapter(TEST_URL); + + expect(response.redirected).toBe(true); + }); + }); + + describe("Stream Handling", () => { + it("enqueues data chunks from stream", async () => { + const { mockStream, reader } = await setupReaderTest(); + + const chunk1 = Buffer.from("data1"); + const chunk2 = Buffer.from("data2"); + mockStream.emit("data", chunk1); + mockStream.emit("data", chunk2); + mockStream.emit("end"); + + const result1 = await reader.read(); + expect(result1.value).toEqual(chunk1); + expect(result1.done).toBe(false); + + const result2 = await reader.read(); + expect(result2.value).toEqual(chunk2); + expect(result2.done).toBe(false); + + const result3 = await reader.read(); + // Closed after end + expect(result3.done).toBe(true); + }); + + it("propagates stream errors", async () => { + const { mockStream, reader } = await setupReaderTest(); + + const error = new Error("Stream error"); + mockStream.emit("error", error); + + await expect(reader.read()).rejects.toThrow("Stream error"); + }); + + it("handles errors after stream is closed", async () => { + const { mockStream, reader } = await setupReaderTest(); + + mockStream.emit("end"); + await reader.read(); + + // Emit events after stream is closed - should not throw + expect(() => mockStream.emit("data", Buffer.from("late"))).not.toThrow(); + expect(() => mockStream.emit("end")).not.toThrow(); + }); + + it("destroys stream on cancel", async () => { + const { mockStream, reader } = await setupReaderTest(); + + await reader.cancel(); + + expect(mockStream.destroy).toHaveBeenCalled(); + }); + }); +}); + +function createAxiosMock(): AxiosInstance { + return { + request: vi.fn(), + } as unknown as AxiosInstance; +} + +function createMockStream(): IncomingMessage { + const stream = new EventEmitter() as IncomingMessage; + stream.destroy = vi.fn(); + return stream; +} + +function setupAxiosResponse( + axios: AxiosInstance, + status: number, + headers: Record, + stream: IncomingMessage, +): void { + vi.mocked(axios.request).mockResolvedValue({ + status, + headers, + data: stream, + }); +} + +async function setupReaderTest(): Promise<{ + mockStream: IncomingMessage; + reader: ReaderLike | ReadableStreamDefaultReader>; +}> { + const mockAxios = createAxiosMock(); + const mockStream = createMockStream(); + setupAxiosResponse(mockAxios, 200, {}, mockStream); + + const adapter = createStreamingFetchAdapter(mockAxios); + const response = await adapter(TEST_URL); + const reader = response.body?.getReader(); + if (reader === undefined) { + throw new Error("Reader is undefined"); + } + + return { mockStream, reader }; +} diff --git a/test/unit/core/cliManager.test.ts b/test/unit/core/cliManager.test.ts index f2a2c2e5..d4f16c87 100644 --- a/test/unit/core/cliManager.test.ts +++ b/test/unit/core/cliManager.test.ts @@ -546,7 +546,8 @@ describe("CliManager", () => { expect(files.find((file) => file.includes(".asc"))).toBeUndefined(); }); - it.each([ + type SignatureErrorTestCase = [status: number, message: string]; + it.each([ [404, "Signature not found"], [500, "Failed to download signature"], ])("allows skipping verification on %i", async (status, message) => { @@ -558,7 +559,7 @@ describe("CliManager", () => { expect(pgp.verifySignature).not.toHaveBeenCalled(); }); - it.each([ + it.each([ [404, "Signature not found"], [500, "Failed to download signature"], ])( diff --git a/test/unit/logging/utils.test.ts b/test/unit/logging/utils.test.ts index 4d0f71eb..989a23e1 100644 --- a/test/unit/logging/utils.test.ts +++ b/test/unit/logging/utils.test.ts @@ -23,7 +23,8 @@ describe("Logging utils", () => { }); describe("sizeOf", () => { - it.each([ + type SizeOfTestCase = [data: unknown, bytes: number | undefined]; + it.each([ // Primitives return a fixed value [null, 0], [undefined, 0], diff --git a/test/unit/websocket/sseConnection.test.ts b/test/unit/websocket/sseConnection.test.ts new file mode 100644 index 00000000..61cfce4d --- /dev/null +++ b/test/unit/websocket/sseConnection.test.ts @@ -0,0 +1,356 @@ +import axios, { type AxiosInstance } from "axios"; +import { type ServerSentEvent } from "coder/site/src/api/typesGenerated"; +import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; +import { EventSource } from "eventsource"; +import { describe, it, expect, vi } from "vitest"; +import { type CloseEvent, type ErrorEvent } from "ws"; + +import { type Logger } from "@/logging/logger"; +import { type ParsedMessageEvent } from "@/websocket/eventStreamConnection"; +import { SseConnection } from "@/websocket/sseConnection"; + +import { createMockLogger } from "../../mocks/testHelpers"; + +const TEST_URL = "https://coder.example.com"; +const API_ROUTE = "/api/v2/workspaces/123/watch"; + +vi.mock("eventsource"); +vi.mock("axios"); + +vi.mock("@/api/streamingFetchAdapter", () => ({ + createStreamingFetchAdapter: vi.fn(() => fetch), +})); + +describe("SseConnection", () => { + describe("URL Building", () => { + type UrlBuildingTestCase = [ + searchParams: Record | URLSearchParams | undefined, + expectedUrl: string, + ]; + it.each([ + [undefined, `${TEST_URL}${API_ROUTE}`], + [ + { follow: "true", after: "123" }, + `${TEST_URL}${API_ROUTE}?follow=true&after=123`, + ], + [new URLSearchParams({ foo: "bar" }), `${TEST_URL}${API_ROUTE}?foo=bar`], + ])("constructs URL with %s search params", (searchParams, expectedUrl) => { + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const mockES = createMockEventSource(); + setupEventSourceMock(mockES); + + const connection = new SseConnection({ + location: { protocol: "https:", host: "coder.example.com" }, + apiRoute: API_ROUTE, + searchParams, + axiosInstance: mockAxios, + logger: mockLogger, + }); + expect(connection.url).toBe(expectedUrl); + }); + }); + + describe("Event Handling", () => { + it("fires open event and supports multiple listeners", async () => { + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + if (event === "open") { + setImmediate(() => handler(new Event("open"))); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events1: object[] = []; + const events2: object[] = []; + connection.addEventListener("open", (event) => events1.push(event)); + connection.addEventListener("open", (event) => events2.push(event)); + + await waitForNextTick(); + expect(events1).toEqual([{}]); + expect(events2).toEqual([{}]); + }); + + it("fires message event with parsed JSON and handles parse errors", async () => { + const testData = { type: "data", workspace: { status: "running" } }; + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + if (event === "data") { + setImmediate(() => { + // Send valid JSON + handler( + new MessageEvent("data", { data: JSON.stringify(testData) }), + ); + // Send invalid JSON + handler(new MessageEvent("data", { data: "not-valid-json" })); + }); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: ParsedMessageEvent[] = []; + connection.addEventListener("message", (event) => events.push(event)); + + await waitForNextTick(); + expect(events).toEqual([ + { + sourceEvent: { data: JSON.stringify(testData) }, + parsedMessage: { type: "data", data: testData }, + parseError: undefined, + }, + { + sourceEvent: { data: "not-valid-json" }, + parsedMessage: undefined, + parseError: expect.any(Error), + }, + ]); + }); + + it("fires error event when connection fails", async () => { + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + if (event === "error") { + const error = { + message: "Connection failed", + error: new Error("Network error"), + }; + setImmediate(() => handler(error)); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: ErrorEvent[] = []; + connection.addEventListener("error", (event) => events.push(event)); + + await waitForNextTick(); + expect(events).toEqual([ + { + error: expect.any(Error), + message: "Connection failed", + }, + ]); + }); + + it("fires close event when connection closes on error", async () => { + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + if (event === "error") { + setImmediate(() => { + // A bit hacky but readyState is a readonly property so we have to override that here + const esWithReadyState = mockES as { readyState: number }; + // Simulate EventSource behavior: state transitions to CLOSED when error occurs + esWithReadyState.readyState = EventSource.CLOSED; + handler(new Event("error")); + }); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: CloseEvent[] = []; + connection.addEventListener("close", (event) => events.push(event)); + + await waitForNextTick(); + expect(events).toEqual([ + { + code: 1006, + reason: "Connection lost", + wasClean: false, + }, + ]); + }); + }); + + describe("Event Listener Management", () => { + it("removes event listener without affecting others", async () => { + const data = '{"test": true}'; + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + if (event === "data") { + setImmediate(() => handler(new MessageEvent("data", { data }))); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: ParsedMessageEvent[] = []; + + const removedHandler = () => { + throw new Error("Removed handler should not have been called!"); + }; + const keptHandler = (event: ParsedMessageEvent) => + events.push(event); + + connection.addEventListener("message", removedHandler); + connection.addEventListener("message", keptHandler); + connection.removeEventListener("message", removedHandler); + + await waitForNextTick(); + // One message event + expect(events).toEqual([ + { + parseError: undefined, + parsedMessage: { + data: JSON.parse(data), + type: "data", + }, + sourceEvent: { data }, + }, + ]); + expect(mockLogger.error).not.toHaveBeenCalled(); + }); + }); + + describe("Close Handling", () => { + type CloseHandlingTestCase = [ + code: number | undefined, + reason: string | undefined, + closeEvent: Omit, + ]; + it.each([ + [ + undefined, + undefined, + { code: 1000, reason: "Normal closure", wasClean: true }, + ], + [ + 4000, + "Custom close", + { code: 4000, reason: "Custom close", wasClean: true }, + ], + ])( + "closes EventSource with code '%s' and reason '%s'", + (code, reason, closeEvent) => { + const mockES = createMockEventSource(); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: CloseEvent[] = []; + connection.addEventListener("close", (event) => events.push(event)); + connection.addEventListener("open", () => {}); + + connection.close(code, reason); + expect(mockES.close).toHaveBeenCalled(); + expect(events).toEqual([closeEvent]); + }, + ); + }); + + describe("Callback Error Handling", () => { + type CallbackErrorTestCase = [ + sseEvent: WebSocketEventType, + eventData: Event | MessageEvent, + ]; + it.each([ + ["open", new Event("open")], + ["message", new MessageEvent("data", { data: '{"test": true}' })], + ["error", new Event("error")], + ])( + "logs error and continues when %s callback throws", + async (sseEvent, eventData) => { + const mockES = createMockEventSource({ + addEventListener: vi.fn((event, handler) => { + // All SSE events are streaming data and attach a listener on the "data" type in the EventSource + const esEvent = sseEvent === "message" ? "data" : sseEvent; + if (event === esEvent) { + setImmediate(() => handler(eventData)); + } + }), + }); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + const events: unknown[] = []; + + connection.addEventListener(sseEvent, () => { + throw new Error("Handler error"); + }); + connection.addEventListener(sseEvent, (event: unknown) => + events.push(event), + ); + + await waitForNextTick(); + expect(events).toHaveLength(1); + expect(mockLogger.error).toHaveBeenCalledWith( + `Error in SSE ${sseEvent} callback:`, + expect.any(Error), + ); + }, + ); + + it("completes cleanup when close callback throws", () => { + const mockES = createMockEventSource(); + setupEventSourceMock(mockES); + + const mockAxios = axios.create(); + const mockLogger = createMockLogger(); + const connection = createConnection(mockAxios, mockLogger); + connection.addEventListener("close", () => { + throw new Error("Handler error"); + }); + + connection.close(); + + expect(mockES.close).toHaveBeenCalled(); + expect(mockLogger.error).toHaveBeenCalledWith( + "Error in SSE close callback:", + expect.any(Error), + ); + }); + }); +}); + +function createConnection( + mockAxios: AxiosInstance, + mockLogger: Logger, +): SseConnection { + return new SseConnection({ + location: { protocol: "https:", host: "coder.example.com" }, + apiRoute: API_ROUTE, + axiosInstance: mockAxios, + logger: mockLogger, + }); +} + +function createMockEventSource( + overrides?: Partial, +): Partial { + return { + url: `${TEST_URL}${API_ROUTE}`, + readyState: EventSource.CONNECTING, + addEventListener: vi.fn(), + removeEventListener: vi.fn(), + close: vi.fn(), + ...overrides, + }; +} + +function setupEventSourceMock(es: Partial): void { + vi.mocked(EventSource).mockImplementation(() => es as EventSource); +} + +function waitForNextTick(): Promise { + return new Promise((resolve) => setImmediate(resolve)); +} diff --git a/vitest.config.ts b/vitest.config.ts index 40c5f958..a3fcd089 100644 --- a/vitest.config.ts +++ b/vitest.config.ts @@ -1,4 +1,4 @@ -import path from "path"; +import path from "node:path"; import { defineConfig } from "vitest/config"; export default defineConfig({ From e64350fd448e63ceb982e1894668816bd091b42e Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 21 Oct 2025 12:33:36 +0300 Subject: [PATCH 05/55] Update CLAUDE.md (#628) --- CLAUDE.md | 51 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 04c75edc..6aa4c61d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,5 +1,40 @@ # Coder Extension Development Guidelines +## Working Style + +You're an experienced, pragmatic engineer. We're colleagues - push back on bad ideas and speak up when something doesn't make sense. Honesty over agreeableness. + +- Simple solutions over clever ones. Readability is a primary concern. +- YAGNI - don't add features we don't need right now +- Make the smallest reasonable changes to achieve the goal +- Reduce code duplication, even if it takes extra effort +- Match the style of surrounding code - consistency within a file matters +- Fix bugs immediately when you find them + +## Naming and Comments + +Names should describe what code does, not how it's implemented. + +Comments explain what code does or why it exists: + +- Never add comments about what used to be there or how things changed +- Never use temporal terms like "new", "improved", "refactored", "legacy" +- Code should be evergreen - describe it as it is +- Do not add comments when you can instead use proper variable/function naming + +## Testing and Debugging + +- Tests must comprehensively cover functionality +- Never mock behavior in end-to-end tests - use real data +- Mock as little as possible in unit tests - try to use real data +- Find root causes, not symptoms. Read error messages carefully before attempting fixes. + +## Version Control + +- Commit frequently throughout development +- Never skip or disable pre-commit hooks +- Check `git status` before using `git add` + ## Build and Test Commands - Build: `yarn build` @@ -8,20 +43,20 @@ - Lint: `yarn lint` - Lint with auto-fix: `yarn lint:fix` - Run all tests: `yarn test` -- Run specific test: `vitest ./src/filename.test.ts` -- CI test mode: `yarn test:ci` +- Unit tests: `yarn test:ci` - Integration tests: `yarn test:integration` +- Run specific unit test: `yarn test:ci ./test/unit/filename.test.ts` +- Run specific integration test: `yarn test:integration ./test/integration/filename.test.ts` -## Code Style Guidelines +## Code Style - TypeScript with strict typing -- No semicolons (see `.prettierrc`) -- Trailing commas for all multi-line lists -- 120 character line width +- Use Prettier for code formatting and ESLint for code linting - Use ES6 features (arrow functions, destructuring, etc.) - Use `const` by default; `let` only when necessary +- Never use `any`, and use exact types when you can - Prefix unused variables with underscore (e.g., `_unused`) -- Sort imports alphabetically in groups: external → parent → sibling - Error handling: wrap and type errors appropriately - Use async/await for promises, avoid explicit Promise construction where possible -- Test files must be named `*.test.ts` and use Vitest +- Unit test files must be named `*.test.ts` and use Vitest, they should be placed in `./test/unit/` +- Never disable ESLint rules without user approval From ee0a964ba1cc6d353cd27fac453197fec2dcfd01 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:35:20 +0300 Subject: [PATCH 06/55] chore(deps): bump vite from 7.1.5 to 7.1.11 (#631) --- yarn.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yarn.lock b/yarn.lock index a067635f..f951b225 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8775,9 +8775,9 @@ vite-node@3.2.4: vite "^5.0.0 || ^6.0.0 || ^7.0.0-0" "vite@^5.0.0 || ^6.0.0 || ^7.0.0-0": - version "7.1.5" - resolved "https://registry.yarnpkg.com/vite/-/vite-7.1.5.tgz#4dbcb48c6313116689be540466fc80faa377be38" - integrity sha512-4cKBO9wR75r0BeIWWWId9XK9Lj6La5X846Zw9dFfzMRw38IlTk2iCcUt6hsyiDRcPidc55ZParFYDXi0nXOeLQ== + version "7.1.11" + resolved "https://registry.yarnpkg.com/vite/-/vite-7.1.11.tgz#4d006746112fee056df64985191e846ebfb6007e" + integrity sha512-uzcxnSDVjAopEUjljkWh8EIrg6tlzrjFUfMcR1EVsRDGwf/ccef0qQPRyOrROwhrTDaApueq+ja+KLPlzR/zdg== dependencies: esbuild "^0.25.0" fdir "^6.5.0" From b9be79b7daf38a2c81e72c785b63451f9f72773c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:40:02 +0300 Subject: [PATCH 07/55] chore(deps): bump openpgp from 6.2.0 to 6.2.2 (#611) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 02a6ddc3..95da87d2 100644 --- a/package.json +++ b/package.json @@ -349,7 +349,7 @@ "find-process": "https://github.com/coder/find-process#fix/sequoia-compat", "jsonc-parser": "^3.3.1", "node-forge": "^1.3.1", - "openpgp": "^6.2.0", + "openpgp": "^6.2.2", "pretty-bytes": "^7.0.0", "proxy-agent": "^6.5.0", "semver": "^7.7.1", diff --git a/yarn.lock b/yarn.lock index f951b225..814d8e9c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6056,10 +6056,10 @@ open@^10.1.0: is-inside-container "^1.0.0" wsl-utils "^0.1.0" -openpgp@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/openpgp/-/openpgp-6.2.0.tgz#f9ce7b4fa298c9d1c4c51f8d1bd0d6cb00372144" - integrity sha512-zKbgazxMeGrTqUEWicKufbdcjv2E0om3YVxw+I3hRykp8ODp+yQOJIDqIr1UXJjP8vR2fky3bNQwYoQXyFkYMA== +openpgp@^6.2.2: + version "6.2.2" + resolved "https://registry.yarnpkg.com/openpgp/-/openpgp-6.2.2.tgz#329f4fab075f9746a94e584df8cfbda70a0dcaf3" + integrity sha512-P/dyEqQ3gfwOCo+xsqffzXjmUhGn4AZTOJ1LCcN21S23vAk+EAvMJOQTsb/C8krL6GjOSBxqGYckhik7+hneNw== optionator@^0.8.3: version "0.8.3" From f543fa4bb9bad01b9b98733024983f0e56b08b87 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:42:27 +0300 Subject: [PATCH 08/55] chore(deps): bump ws from 8.18.2 to 8.18.3 (#610) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 95da87d2..218849a5 100644 --- a/package.json +++ b/package.json @@ -354,7 +354,7 @@ "proxy-agent": "^6.5.0", "semver": "^7.7.1", "ua-parser-js": "1.0.40", - "ws": "^8.18.2", + "ws": "^8.18.3", "zod": "^3.25.65" }, "devDependencies": { diff --git a/yarn.lock b/yarn.lock index 814d8e9c..a18ff730 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9113,10 +9113,10 @@ write@1.0.3: dependencies: mkdirp "^0.5.1" -ws@^8.18.2: - version "8.18.2" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.2.tgz#42738b2be57ced85f46154320aabb51ab003705a" - integrity sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ== +ws@^8.18.3: + version "8.18.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.18.3.tgz#b56b88abffde62791c639170400c93dcb0c95472" + integrity sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg== wsl-utils@^0.1.0: version "0.1.0" From 591a74bcc5b0349734673ffee19836d3fc6b8402 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:45:22 +0300 Subject: [PATCH 09/55] chore(deps-dev): bump typescript from 5.9.2 to 5.9.3 (#612) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 218849a5..3e8c9b8d 100644 --- a/package.json +++ b/package.json @@ -389,7 +389,7 @@ "nyc": "^17.1.0", "prettier": "^3.5.3", "ts-loader": "^9.5.1", - "typescript": "^5.9.2", + "typescript": "^5.9.3", "utf-8-validate": "^6.0.5", "vitest": "^3.2.4", "vscode-test": "^1.5.0", diff --git a/yarn.lock b/yarn.lock index a18ff730..c8d1ff6a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8490,10 +8490,10 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" -typescript@^5.9.2: - version "5.9.2" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.9.2.tgz#d93450cddec5154a2d5cabe3b8102b83316fb2a6" - integrity sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A== +typescript@^5.9.3: + version "5.9.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.9.3.tgz#5b4f59e15310ab17a216f5d6cf53ee476ede670f" + integrity sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw== ua-parser-js@1.0.40: version "1.0.40" From d5c65e852f89f27fc64d0a93db03d5870ae06131 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:49:50 +0300 Subject: [PATCH 10/55] chore(deps-dev): bump memfs from 4.47.0 to 4.49.0 (#622) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 3e8c9b8d..1c6abd4e 100644 --- a/package.json +++ b/package.json @@ -385,7 +385,7 @@ "glob": "^10.4.2", "jsonc-eslint-parser": "^2.4.0", "markdown-eslint-parser": "^1.2.1", - "memfs": "^4.47.0", + "memfs": "^4.49.0", "nyc": "^17.1.0", "prettier": "^3.5.3", "ts-loader": "^9.5.1", diff --git a/yarn.lock b/yarn.lock index c8d1ff6a..47f44b96 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5672,10 +5672,10 @@ mdurl@^2.0.0: resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-2.0.0.tgz#80676ec0433025dd3e17ee983d0fe8de5a2237e0" integrity sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w== -memfs@^4.47.0: - version "4.47.0" - resolved "https://registry.yarnpkg.com/memfs/-/memfs-4.47.0.tgz#410291da6dcce89a0d6c9cab23b135231a5ed44c" - integrity sha512-Xey8IZA57tfotV/TN4d6BmccQuhFP+CqRiI7TTNdipZdZBzF2WnzUcH//Cudw6X4zJiUbo/LTuU/HPA/iC/pNg== +memfs@^4.49.0: + version "4.49.0" + resolved "https://registry.yarnpkg.com/memfs/-/memfs-4.49.0.tgz#bc35069570d41a31c62e31f1a6ec6057a8ea82f0" + integrity sha512-L9uC9vGuc4xFybbdOpRLoOAOq1YEBBsocCs5NVW32DfU+CZWWIn3OVF+lB8Gp4ttBVSMazwrTrjv8ussX/e3VQ== dependencies: "@jsonjoy.com/json-pack" "^1.11.0" "@jsonjoy.com/util" "^1.9.0" From 1bb05c5c7aca8516843c256556f92375bf0a8c32 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 11:17:52 +0300 Subject: [PATCH 11/55] chore(deps): bump semver from 7.7.1 to 7.7.3 (#621) --- package.json | 4 ++-- yarn.lock | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package.json b/package.json index 1c6abd4e..363119d5 100644 --- a/package.json +++ b/package.json @@ -338,7 +338,7 @@ "onUri" ], "resolutions": { - "semver": "7.7.1", + "semver": "7.7.3", "trim": "0.0.3", "word-wrap": "1.2.5" }, @@ -352,7 +352,7 @@ "openpgp": "^6.2.2", "pretty-bytes": "^7.0.0", "proxy-agent": "^6.5.0", - "semver": "^7.7.1", + "semver": "^7.7.3", "ua-parser-js": "1.0.40", "ws": "^8.18.3", "zod": "^3.25.65" diff --git a/yarn.lock b/yarn.lock index 47f44b96..3e38b6a6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7462,10 +7462,10 @@ secretlint@^10.1.1: globby "^14.1.0" read-pkg "^9.0.1" -semver@7.7.1, semver@^5.1.0, semver@^5.5.0, semver@^6.0.0, semver@^6.1.2, semver@^6.3.1, semver@^7.3.4, semver@^7.3.5, semver@^7.5.2, semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.6.2, semver@^7.7.1, semver@^7.7.2: - version "7.7.1" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.1.tgz#abd5098d82b18c6c81f6074ff2647fd3e7220c9f" - integrity sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA== +semver@7.7.3, semver@^5.1.0, semver@^5.5.0, semver@^6.0.0, semver@^6.1.2, semver@^6.3.1, semver@^7.3.4, semver@^7.3.5, semver@^7.5.2, semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.6.2, semver@^7.7.1, semver@^7.7.2, semver@^7.7.3: + version "7.7.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" + integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== serialize-javascript@^6.0.2: version "6.0.2" From 9c884dfd728b47174b297008740ddd66767b4bb7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 11:20:48 +0300 Subject: [PATCH 12/55] chore(deps): bump actions/setup-node from 5 to 6 (#630) --- .github/workflows/ci.yaml | 4 ++-- .github/workflows/release.yaml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 59a03e0a..87a03723 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -16,7 +16,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: actions/setup-node@v5 + - uses: actions/setup-node@v6 with: node-version: "22" @@ -34,7 +34,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: actions/setup-node@v5 + - uses: actions/setup-node@v6 with: node-version: "22" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 27214dcc..28f8fdf0 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -16,7 +16,7 @@ jobs: steps: - uses: actions/checkout@v5 - - uses: actions/setup-node@v5 + - uses: actions/setup-node@v6 with: node-version: "22" From 930d54329f26ce13793c59f8521d8281be8b55ef Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Thu, 23 Oct 2025 02:35:44 +0300 Subject: [PATCH 13/55] Automatically publish extension and add pre-release version (#624) - Automatically publish the pre-release when pushing a `v*-pre` tag to `main`. - Automatically publish the stable release when pushing a `v*` tag to `main`. - Package VSIX on every PR and merge to main. For PRs, it is retained for 7 days, but for main it's retained indefinitely. - Skips publishing if the secret for that platform is not set. Closes #97 --- .github/workflows/ci.yaml | 59 ++++++++++- .github/workflows/pre-release.yaml | 78 ++++++++++++++ .github/workflows/publish-extension.yaml | 125 +++++++++++++++++++++++ .github/workflows/release.yaml | 67 ++++++++++-- 4 files changed, 317 insertions(+), 12 deletions(-) create mode 100644 .github/workflows/pre-release.yaml create mode 100644 .github/workflows/publish-extension.yaml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 87a03723..a878f9f2 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -1,4 +1,4 @@ -name: ci +name: CI on: push: @@ -11,6 +11,7 @@ on: jobs: lint: + name: Lint runs-on: ubuntu-22.04 steps: @@ -19,6 +20,7 @@ jobs: - uses: actions/setup-node@v6 with: node-version: "22" + cache: "yarn" - run: yarn @@ -29,6 +31,7 @@ jobs: - run: yarn build test: + name: Test runs-on: ubuntu-22.04 steps: @@ -37,7 +40,61 @@ jobs: - uses: actions/setup-node@v6 with: node-version: "22" + cache: "yarn" - run: yarn - run: yarn test:ci + + package: + name: Package + runs-on: ubuntu-22.04 + needs: [lint, test] + steps: + - uses: actions/checkout@v5 + + - uses: actions/setup-node@v6 + with: + node-version: "22" + cache: "yarn" + + - name: Install dependencies + run: | + yarn + npm install -g @vscode/vsce + + - name: Get version from package.json + id: version + run: | + VERSION=$(node -e "console.log(require('./package.json').version)") + echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "Version: $VERSION" + + - name: Setup package path + id: setup + run: | + EXTENSION_NAME=$(node -e "console.log(require('./package.json').name)") + # Add commit SHA for CI builds + SHORT_SHA=$(git rev-parse --short HEAD) + PACKAGE_NAME="${EXTENSION_NAME}-${{ steps.version.outputs.version }}-${SHORT_SHA}.vsix" + echo "packageName=$PACKAGE_NAME" >> $GITHUB_OUTPUT + + - name: Package extension + run: vsce package --out "${{ steps.setup.outputs.packageName }}" + + - name: Upload artifact (PR) + if: github.event_name == 'pull_request' + uses: actions/upload-artifact@v4 + with: + name: extension-pr-${{ github.event.pull_request.number }} + path: ${{ steps.setup.outputs.packageName }} + if-no-files-found: error + retention-days: 7 + + - name: Upload artifact (main) + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + uses: actions/upload-artifact@v4 + with: + name: extension-main-${{ github.sha }} + path: ${{ steps.setup.outputs.packageName }} + if-no-files-found: error diff --git a/.github/workflows/pre-release.yaml b/.github/workflows/pre-release.yaml new file mode 100644 index 00000000..61761700 --- /dev/null +++ b/.github/workflows/pre-release.yaml @@ -0,0 +1,78 @@ +name: Pre-Release +on: + push: + tags: + - "v*-pre" + +permissions: + # Required to publish a release + contents: write + pull-requests: read + +jobs: + package: + name: Package + runs-on: ubuntu-22.04 + outputs: + version: ${{ steps.version.outputs.version }} + steps: + - uses: actions/checkout@v5 + + - uses: actions/setup-node@v6 + with: + node-version: "22" + + - name: Extract version from tag + id: version + run: | + # Extract version from tag (remove 'v' prefix and '-pre' suffix) + TAG_NAME=${GITHUB_REF#refs/tags/v} + VERSION=${TAG_NAME%-pre} + echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "Pre-release version: $VERSION" + + - name: Validate version matches package.json + run: | + TAG_VERSION="${{ steps.version.outputs.version }}" + PACKAGE_VERSION=$(node -e "console.log(require('./package.json').version)") + + if [ "$TAG_VERSION" != "$PACKAGE_VERSION" ]; then + echo "Error: Tag version ($TAG_VERSION) does not match package.json version ($PACKAGE_VERSION)" + echo "Please ensure the tag version matches the version in package.json" + exit 1 + fi + + echo "Version validation successful: $TAG_VERSION" + + - name: Install dependencies + run: | + yarn + npm install -g @vscode/vsce + + - name: Setup package path + id: setup + run: | + EXTENSION_NAME=$(node -e "console.log(require('./package.json').name)") + PACKAGE_NAME="${EXTENSION_NAME}-${{ steps.version.outputs.version }}-pre.vsix" + echo "packageName=$PACKAGE_NAME" >> $GITHUB_OUTPUT + + - name: Package extension + run: vsce package --pre-release --out "${{ steps.setup.outputs.packageName }}" + + - name: Upload artifact + uses: actions/upload-artifact@v4 + with: + name: extension-${{ steps.version.outputs.version }} + path: ${{ steps.setup.outputs.packageName }} + if-no-files-found: error + + publish: + name: Publish Extension and Create Pre-Release + needs: package + uses: ./.github/workflows/publish-extension.yaml + with: + version: ${{ needs.package.outputs.version }} + isPreRelease: true + secrets: + VSCE_PAT: ${{ secrets.VSCE_PAT }} + OVSX_PAT: ${{ secrets.OVSX_PAT }} diff --git a/.github/workflows/publish-extension.yaml b/.github/workflows/publish-extension.yaml new file mode 100644 index 00000000..cf93d6ba --- /dev/null +++ b/.github/workflows/publish-extension.yaml @@ -0,0 +1,125 @@ +name: Publish Extension + +on: + workflow_call: + inputs: + version: + required: true + type: string + description: "Version to publish" + isPreRelease: + required: false + type: boolean + default: false + description: "Whether this is a pre-release" + secrets: + VSCE_PAT: + required: false + OVSX_PAT: + required: false + +jobs: + setup: + name: Setup + runs-on: ubuntu-22.04 + outputs: + packageName: ${{ steps.package.outputs.packageName }} + hasVscePat: ${{ steps.check-secrets.outputs.hasVscePat }} + hasOvsxPat: ${{ steps.check-secrets.outputs.hasOvsxPat }} + steps: + - uses: actions/checkout@v5 + + - uses: actions/setup-node@v6 + with: + node-version: "22" + + - name: Construct package name + id: package + run: | + EXTENSION_NAME=$(node -e "console.log(require('./package.json').name)") + if [ "${{ inputs.isPreRelease }}" = "true" ]; then + PACKAGE_NAME="${EXTENSION_NAME}-${{ inputs.version }}-pre.vsix" + else + PACKAGE_NAME="${EXTENSION_NAME}-${{ inputs.version }}.vsix" + fi + echo "packageName=$PACKAGE_NAME" >> $GITHUB_OUTPUT + echo "Package name: $PACKAGE_NAME" + + - name: Check secrets + id: check-secrets + env: + VSCE_PAT: ${{ secrets.VSCE_PAT }} + OVSX_PAT: ${{ secrets.OVSX_PAT }} + run: | + echo "hasVscePat=$([ -n "$VSCE_PAT" ] && echo true || echo false)" >> $GITHUB_OUTPUT + echo "hasOvsxPat=$([ -n "$OVSX_PAT" ] && echo true || echo false)" >> $GITHUB_OUTPUT + + publishMS: + name: Publish to VS Marketplace + needs: setup + runs-on: ubuntu-22.04 + if: ${{ needs.setup.outputs.hasVscePat == 'true' }} + steps: + - uses: actions/setup-node@v6 + with: + node-version: "22" + + - name: Install vsce + run: npm install -g @vscode/vsce + + - uses: actions/download-artifact@v5 + with: + name: extension-${{ inputs.version }} + + - name: Publish to VS Marketplace + run: | + echo "Publishing version ${{ inputs.version }} to VS Marketplace" + if [ "${{ inputs.isPreRelease }}" = "true" ]; then + vsce publish --pre-release --packagePath "./${{ needs.setup.outputs.packageName }}" -p ${{ secrets.VSCE_PAT }} + else + vsce publish --packagePath "./${{ needs.setup.outputs.packageName }}" -p ${{ secrets.VSCE_PAT }} + fi + + publishOVSX: + name: Publish to Open VSX + needs: setup + runs-on: ubuntu-22.04 + if: ${{ needs.setup.outputs.hasOvsxPat == 'true' }} + steps: + - uses: actions/setup-node@v6 + with: + node-version: "22" + + - name: Install ovsx + run: npm install -g ovsx + + - uses: actions/download-artifact@v5 + with: + name: extension-${{ inputs.version }} + + - name: Publish to Open VSX + run: | + echo "Publishing version ${{ inputs.version }} to Open VSX" + if [ "${{ inputs.isPreRelease }}" = "true" ]; then + ovsx publish "./${{ needs.setup.outputs.packageName }}" --pre-release -p ${{ secrets.OVSX_PAT }} + else + ovsx publish "./${{ needs.setup.outputs.packageName }}" -p ${{ secrets.OVSX_PAT }} + fi + + publishGH: + name: Create GitHub ${{ inputs.isPreRelease && 'Pre-' || '' }}Release + needs: setup + runs-on: ubuntu-22.04 + steps: + - uses: actions/download-artifact@v5 + with: + name: extension-${{ inputs.version }} + + - name: Create ${{ inputs.isPreRelease && 'Pre-' || '' }}Release + uses: marvinpinto/action-automatic-releases@latest + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + prerelease: ${{ inputs.isPreRelease }} + draft: true + title: "${{ inputs.isPreRelease && 'Pre-' || '' }}Release v${{ inputs.version }}" + files: ${{ needs.setup.outputs.packageName }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 28f8fdf0..51d9ff97 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,18 +1,21 @@ +name: Release on: push: tags: - "v*" - -name: release + - "!v*-pre" permissions: # Required to publish a release contents: write - pull-requests: "read" + pull-requests: read jobs: package: + name: Package runs-on: ubuntu-22.04 + outputs: + version: ${{ steps.version.outputs.version }} steps: - uses: actions/checkout@v5 @@ -20,14 +23,56 @@ jobs: with: node-version: "22" - - run: yarn + - name: Extract version from tag + id: version + run: | + # Extract version from tag (remove 'v' prefix) + VERSION=${GITHUB_REF#refs/tags/v} + echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "Release version: $VERSION" + + - name: Validate version matches package.json + run: | + TAG_VERSION="${{ steps.version.outputs.version }}" + PACKAGE_VERSION=$(node -e "console.log(require('./package.json').version)") + + if [ "$TAG_VERSION" != "$PACKAGE_VERSION" ]; then + echo "Error: Tag version ($TAG_VERSION) does not match package.json version ($PACKAGE_VERSION)" + echo "Please ensure the tag version matches the version in package.json" + exit 1 + fi + + echo "Version validation successful: $TAG_VERSION" - - run: npx @vscode/vsce package + - name: Install dependencies + run: | + yarn + npm install -g @vscode/vsce - - uses: "marvinpinto/action-automatic-releases@latest" + - name: Setup package path + id: setup + run: | + EXTENSION_NAME=$(node -e "console.log(require('./package.json').name)") + PACKAGE_NAME="${EXTENSION_NAME}-${{ steps.version.outputs.version }}.vsix" + echo "packageName=$PACKAGE_NAME" >> $GITHUB_OUTPUT + + - name: Package extension + run: vsce package --out "${{ steps.setup.outputs.packageName }}" + + - name: Upload artifact + uses: actions/upload-artifact@v4 with: - repo_token: "${{ secrets.GITHUB_TOKEN }}" - prerelease: false - draft: true - files: | - *.vsix + name: extension-${{ steps.version.outputs.version }} + path: ${{ steps.setup.outputs.packageName }} + if-no-files-found: error + + publish: + name: Publish Extension and Create Release + needs: package + uses: ./.github/workflows/publish-extension.yaml + with: + version: ${{ needs.package.outputs.version }} + isPreRelease: false + secrets: + VSCE_PAT: ${{ secrets.VSCE_PAT }} + OVSX_PAT: ${{ secrets.OVSX_PAT }} From c1206b2497e20cbde7ccde895c948f109c4789fc Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Thu, 23 Oct 2025 13:10:47 +0300 Subject: [PATCH 14/55] v1.11.3 (#632) --- CHANGELOG.md | 2 ++ package.json | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ef80cd1a..927d6d12 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +## [v1.11.3](https://github.com/coder/vscode-coder/releases/tag/v1.11.3) 2025-10-22 + ### Fixed - Fixed WebSocket connections not receiving headers from the configured header command diff --git a/package.json b/package.json index 363119d5..25db26f1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "coder-remote", "displayName": "Coder", - "version": "1.11.2", + "version": "1.11.3", "description": "Open any workspace with a single click.", "categories": [ "Other" From ffe0182de549792080c9a54c2a1c72d269ca7e36 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 29 Oct 2025 12:54:19 -0800 Subject: [PATCH 15/55] chore(deps-dev): bump @typescript-eslint/parser from 8.44.1 to 8.46.2 (#634) --- package.json | 2 +- yarn.lock | 86 +++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 66 insertions(+), 22 deletions(-) diff --git a/package.json b/package.json index 25db26f1..56e9e1af 100644 --- a/package.json +++ b/package.json @@ -367,7 +367,7 @@ "@types/vscode": "^1.73.0", "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.44.0", - "@typescript-eslint/parser": "^8.44.0", + "@typescript-eslint/parser": "^8.46.2", "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.11", "@vscode/test-electron": "^2.5.2", diff --git a/yarn.lock b/yarn.lock index 3e38b6a6..019cbe01 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1168,15 +1168,15 @@ natural-compare "^1.4.0" ts-api-utils "^2.1.0" -"@typescript-eslint/parser@^8.44.0": - version "8.44.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.44.1.tgz#d4c85791389462823596ad46e2b90d34845e05eb" - integrity sha512-EHrrEsyhOhxYt8MTg4zTF+DJMuNBzWwgvvOYNj/zm1vnaD/IC5zCXFehZv94Piqa2cRFfXrTFxIvO95L7Qc/cw== - dependencies: - "@typescript-eslint/scope-manager" "8.44.1" - "@typescript-eslint/types" "8.44.1" - "@typescript-eslint/typescript-estree" "8.44.1" - "@typescript-eslint/visitor-keys" "8.44.1" +"@typescript-eslint/parser@^8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.46.2.tgz#dd938d45d581ac8ffa9d8a418a50282b306f7ebf" + integrity sha512-BnOroVl1SgrPLywqxyqdJ4l3S2MsKVLDVxZvjI1Eoe8ev2r3kGDo+PcMihNmDE+6/KjkTubSJnmqGZZjQSBq/g== + dependencies: + "@typescript-eslint/scope-manager" "8.46.2" + "@typescript-eslint/types" "8.46.2" + "@typescript-eslint/typescript-estree" "8.46.2" + "@typescript-eslint/visitor-keys" "8.46.2" debug "^4.3.4" "@typescript-eslint/project-service@8.44.1": @@ -1188,6 +1188,15 @@ "@typescript-eslint/types" "^8.44.1" debug "^4.3.4" +"@typescript-eslint/project-service@8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.46.2.tgz#ab2f02a0de4da6a7eeb885af5e059be57819d608" + integrity sha512-PULOLZ9iqwI7hXcmL4fVfIsBi6AN9YxRc0frbvmg8f+4hQAjQ5GYNKK0DIArNo+rOKmR/iBYwkpBmnIwin4wBg== + dependencies: + "@typescript-eslint/tsconfig-utils" "^8.46.2" + "@typescript-eslint/types" "^8.46.2" + debug "^4.3.4" + "@typescript-eslint/scope-manager@8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.44.1.tgz#31c27f92e4aed8d0f4d6fe2b9e5187d1d8797bd7" @@ -1196,11 +1205,24 @@ "@typescript-eslint/types" "8.44.1" "@typescript-eslint/visitor-keys" "8.44.1" +"@typescript-eslint/scope-manager@8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.46.2.tgz#7d37df2493c404450589acb3b5d0c69cc0670a88" + integrity sha512-LF4b/NmGvdWEHD2H4MsHD8ny6JpiVNDzrSZr3CsckEgCbAGZbYM4Cqxvi9L+WqDMT+51Ozy7lt2M+d0JLEuBqA== + dependencies: + "@typescript-eslint/types" "8.46.2" + "@typescript-eslint/visitor-keys" "8.46.2" + "@typescript-eslint/tsconfig-utils@8.44.1", "@typescript-eslint/tsconfig-utils@^8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.44.1.tgz#e1d9d047078fac37d3e638484ab3b56215963342" integrity sha512-B5OyACouEjuIvof3o86lRMvyDsFwZm+4fBOqFHccIctYgBjqR3qT39FBYGN87khcgf0ExpdCBeGKpKRhSFTjKQ== +"@typescript-eslint/tsconfig-utils@8.46.2", "@typescript-eslint/tsconfig-utils@^8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.46.2.tgz#d110451cb93bbd189865206ea37ef677c196828c" + integrity sha512-a7QH6fw4S57+F5y2FIxxSDyi5M4UfGF+Jl1bCGd7+L4KsaUY80GsiF/t0UoRFDHAguKlBaACWJRmdrc6Xfkkag== + "@typescript-eslint/type-utils@8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.44.1.tgz#be9d31e0f911d17ee8ac99921bb74cf1f9df3906" @@ -1212,11 +1234,16 @@ debug "^4.3.4" ts-api-utils "^2.1.0" -"@typescript-eslint/types@8.44.1", "@typescript-eslint/types@^8.44.1": +"@typescript-eslint/types@8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.44.1.tgz#85d1cad1290a003ff60420388797e85d1c3f76ff" integrity sha512-Lk7uj7y9uQUOEguiDIDLYLJOrYHQa7oBiURYVFqIpGxclAFQ78f6VUOM8lI2XEuNOKNB7XuvM2+2cMXAoq4ALQ== +"@typescript-eslint/types@8.46.2", "@typescript-eslint/types@^8.44.1", "@typescript-eslint/types@^8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.46.2.tgz#2bad7348511b31e6e42579820e62b73145635763" + integrity sha512-lNCWCbq7rpg7qDsQrd3D6NyWYu+gkTENkG5IKYhUIcxSb59SQC/hEQ+MrG4sTgBVghTonNWq42bA/d4yYumldQ== + "@typescript-eslint/typescript-estree@8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.44.1.tgz#4f17650e5adabecfcc13cd8c517937a4ef5cd424" @@ -1233,6 +1260,22 @@ semver "^7.6.0" ts-api-utils "^2.1.0" +"@typescript-eslint/typescript-estree@8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.46.2.tgz#ab547a27e4222bb6a3281cb7e98705272e2c7d08" + integrity sha512-f7rW7LJ2b7Uh2EiQ+7sza6RDZnajbNbemn54Ob6fRwQbgcIn+GWfyuHDHRYgRoZu1P4AayVScrRW+YfbTvPQoQ== + dependencies: + "@typescript-eslint/project-service" "8.46.2" + "@typescript-eslint/tsconfig-utils" "8.46.2" + "@typescript-eslint/types" "8.46.2" + "@typescript-eslint/visitor-keys" "8.46.2" + debug "^4.3.4" + fast-glob "^3.3.2" + is-glob "^4.0.3" + minimatch "^9.0.4" + semver "^7.6.0" + ts-api-utils "^2.1.0" + "@typescript-eslint/utils@8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.44.1.tgz#f23d48eb90791a821dc17d4f67bb96faeb75d63d" @@ -1251,6 +1294,14 @@ "@typescript-eslint/types" "8.44.1" eslint-visitor-keys "^4.2.1" +"@typescript-eslint/visitor-keys@8.46.2": + version "8.46.2" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.46.2.tgz#803fa298948c39acf810af21bdce6f8babfa9738" + integrity sha512-tUFMXI4gxzzMXt4xpGJEsBsTox0XbNQ1y94EwlD/CuZwFcQP79xfQqMhau9HsRc/J0cAPA/HZt1dZPtGn9V/7w== + dependencies: + "@typescript-eslint/types" "8.46.2" + eslint-visitor-keys "^4.2.1" + "@typespec/ts-http-runtime@^0.3.0": version "0.3.0" resolved "https://registry.yarnpkg.com/@typespec/ts-http-runtime/-/ts-http-runtime-0.3.0.tgz#f506ff2170e594a257f8e78aa196088f3a46a22d" @@ -2728,10 +2779,10 @@ dayjs@^1.11.13: resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.13.tgz#92430b0139055c3ebb60150aa13e860a4b5a366c" integrity sha512-oaMBel6gjolK862uaPQOVTA7q3TZhuSvuMQAAglQDOWYO9A91IrAOUJEyKVlqJlHE0vq5p5UXxzdPfMH/x6xNg== -debug@4, debug@^4.0.1, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4: - version "4.3.7" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.7.tgz#87945b4151a011d76d95a198d7111c865c360a52" - integrity sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ== +debug@4, debug@^4.0.1, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4, debug@^4.3.5, debug@^4.4.1: + version "4.4.1" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.1.tgz#e5a8bc6cbc4c6cd3e64308b0693a3d4fa550189b" + integrity sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ== dependencies: ms "^2.1.3" @@ -2742,13 +2793,6 @@ debug@^3.2.7: dependencies: ms "^2.1.1" -debug@^4.3.5, debug@^4.4.1: - version "4.4.1" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.1.tgz#e5a8bc6cbc4c6cd3e64308b0693a3d4fa550189b" - integrity sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ== - dependencies: - ms "^2.1.3" - decamelize@^1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" From 17e2cd164ed2a1a8e0facad95069dfa6899b3500 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 29 Oct 2025 12:54:48 -0800 Subject: [PATCH 16/55] chore(deps-dev): bump @vscode/vsce from 3.6.0 to 3.6.2 (#639) --- package.json | 2 +- yarn.lock | 171 +++++++++++++++++++++++++-------------------------- 2 files changed, 84 insertions(+), 89 deletions(-) diff --git a/package.json b/package.json index 56e9e1af..b7b63433 100644 --- a/package.json +++ b/package.json @@ -371,7 +371,7 @@ "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.11", "@vscode/test-electron": "^2.5.2", - "@vscode/vsce": "^3.6.0", + "@vscode/vsce": "^3.6.2", "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", "dayjs": "^1.11.13", diff --git a/yarn.lock b/yarn.lock index 019cbe01..f7a7155f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -863,42 +863,42 @@ resolved "https://registry.yarnpkg.com/@rtsao/scc/-/scc-1.1.0.tgz#927dd2fae9bc3361403ac2c7a00c32ddce9ad7e8" integrity sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g== -"@secretlint/config-creator@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/config-creator/-/config-creator-10.2.1.tgz#867c88741f8cb22988708919e480330e5fa66a44" - integrity sha512-nyuRy8uo2+mXPIRLJ93wizD1HbcdDIsVfgCT01p/zGVFrtvmiL7wqsl4KgZH0QFBM/KRLDLeog3/eaM5ASjtvw== +"@secretlint/config-creator@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/config-creator/-/config-creator-10.2.2.tgz#5d646e83bb2aacfbd5218968ceb358420b4c2cb3" + integrity sha512-BynOBe7Hn3LJjb3CqCHZjeNB09s/vgf0baBaHVw67w7gHF0d25c3ZsZ5+vv8TgwSchRdUCRrbbcq5i2B1fJ2QQ== dependencies: - "@secretlint/types" "^10.2.1" + "@secretlint/types" "^10.2.2" -"@secretlint/config-loader@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/config-loader/-/config-loader-10.2.1.tgz#8acff15b4f52a9569e403cef99fee28d330041aa" - integrity sha512-ob1PwhuSw/Hc6Y4TA63NWj6o++rZTRJOwPZG82o6tgEURqkrAN44fXH9GIouLsOxKa8fbCRLMeGmSBtJLdSqtw== +"@secretlint/config-loader@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/config-loader/-/config-loader-10.2.2.tgz#a7790c8d0301db4f6d47e6fb0f0f9482fe652d9a" + integrity sha512-ndjjQNgLg4DIcMJp4iaRD6xb9ijWQZVbd9694Ol2IszBIbGPPkwZHzJYKICbTBmh6AH/pLr0CiCaWdGJU7RbpQ== dependencies: - "@secretlint/profiler" "^10.2.1" - "@secretlint/resolver" "^10.2.1" - "@secretlint/types" "^10.2.1" + "@secretlint/profiler" "^10.2.2" + "@secretlint/resolver" "^10.2.2" + "@secretlint/types" "^10.2.2" ajv "^8.17.1" debug "^4.4.1" rc-config-loader "^4.1.3" -"@secretlint/core@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/core/-/core-10.2.1.tgz#a727174fbfd7b7f5d8f63b46470c1405bbe85cab" - integrity sha512-2sPp5IE7pM5Q+f1/NK6nJ49FKuqh+e3fZq5MVbtVjegiD4NMhjcoML1Cg7atCBgXPufhXRHY1DWhIhkGzOx/cw== +"@secretlint/core@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/core/-/core-10.2.2.tgz#cd41d5c27ba07c217f0af4e0e24dbdfe5ef62042" + integrity sha512-6rdwBwLP9+TO3rRjMVW1tX+lQeo5gBbxl1I5F8nh8bgGtKwdlCMhMKsBWzWg1ostxx/tIG7OjZI0/BxsP8bUgw== dependencies: - "@secretlint/profiler" "^10.2.1" - "@secretlint/types" "^10.2.1" + "@secretlint/profiler" "^10.2.2" + "@secretlint/types" "^10.2.2" debug "^4.4.1" structured-source "^4.0.0" -"@secretlint/formatter@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/formatter/-/formatter-10.2.1.tgz#a09ed00dbb91a17476dc3cf885387722b5225881" - integrity sha512-0A7ho3j0Y4ysK0mREB3O6FKQtScD4rQgfzuI4Slv9Cut1ynQOI7JXAoIFm4XVzhNcgtmEPeD3pQB206VFphBgQ== +"@secretlint/formatter@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/formatter/-/formatter-10.2.2.tgz#c8ce35803ad0d841cc9b6e703d6fab68a144e9c0" + integrity sha512-10f/eKV+8YdGKNQmoDUD1QnYL7TzhI2kzyx95vsJKbEa8akzLAR5ZrWIZ3LbcMmBLzxlSQMMccRmi05yDQ5YDA== dependencies: - "@secretlint/resolver" "^10.2.1" - "@secretlint/types" "^10.2.1" + "@secretlint/resolver" "^10.2.2" + "@secretlint/types" "^10.2.2" "@textlint/linter-formatter" "^15.2.0" "@textlint/module-interop" "^15.2.0" "@textlint/types" "^15.2.0" @@ -909,61 +909,61 @@ table "^6.9.0" terminal-link "^4.0.0" -"@secretlint/node@^10.1.1", "@secretlint/node@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/node/-/node-10.2.1.tgz#4ff09a244500ec9c5f9d2a512bd047ebbfa9cb97" - integrity sha512-MQFte7C+5ZHINQGSo6+eUECcUCGvKR9PVgZcTsRj524xsbpeBqF1q1dHsUsdGb9r2jlvf40Q14MRZwMcpmLXWQ== - dependencies: - "@secretlint/config-loader" "^10.2.1" - "@secretlint/core" "^10.2.1" - "@secretlint/formatter" "^10.2.1" - "@secretlint/profiler" "^10.2.1" - "@secretlint/source-creator" "^10.2.1" - "@secretlint/types" "^10.2.1" +"@secretlint/node@^10.1.2", "@secretlint/node@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/node/-/node-10.2.2.tgz#1d8a6ed620170bf4f29829a3a91878682c43c4d9" + integrity sha512-eZGJQgcg/3WRBwX1bRnss7RmHHK/YlP/l7zOQsrjexYt6l+JJa5YhUmHbuGXS94yW0++3YkEJp0kQGYhiw1DMQ== + dependencies: + "@secretlint/config-loader" "^10.2.2" + "@secretlint/core" "^10.2.2" + "@secretlint/formatter" "^10.2.2" + "@secretlint/profiler" "^10.2.2" + "@secretlint/source-creator" "^10.2.2" + "@secretlint/types" "^10.2.2" debug "^4.4.1" p-map "^7.0.3" -"@secretlint/profiler@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/profiler/-/profiler-10.2.1.tgz#eb532c7549b68c639de399760c654529d8327e51" - integrity sha512-gOlfPZ1ASc5mP5cqsL809uMJGp85t+AJZg1ZPscWvB/m5UFFgeNTZcOawggb1S5ExDvR388sIJxagx5hyDZ34g== +"@secretlint/profiler@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/profiler/-/profiler-10.2.2.tgz#82c085ab1966806763bbf6edb830987f25d4e797" + integrity sha512-qm9rWfkh/o8OvzMIfY8a5bCmgIniSpltbVlUVl983zDG1bUuQNd1/5lUEeWx5o/WJ99bXxS7yNI4/KIXfHexig== -"@secretlint/resolver@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/resolver/-/resolver-10.2.1.tgz#513e2e4916d09fd96ead8f7020808a5373794cb8" - integrity sha512-AuwehKwnE2uxKaJVv2Z5a8FzGezBmlNhtLKm70Cvsvtwd0oAtenxCSTKXkiPGYC0+S91fAw3lrX7CUkyr9cTCA== +"@secretlint/resolver@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/resolver/-/resolver-10.2.2.tgz#9c3c3e2fef00679fcce99793e76e19e575b75721" + integrity sha512-3md0cp12e+Ae5V+crPQYGd6aaO7ahw95s28OlULGyclyyUtf861UoRGS2prnUrKh7MZb23kdDOyGCYb9br5e4w== -"@secretlint/secretlint-formatter-sarif@^10.1.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/secretlint-formatter-sarif/-/secretlint-formatter-sarif-10.2.1.tgz#65e77f5313914041b353ad221613341a89d5bb80" - integrity sha512-qOZUYBesLkhCBP7YVMv0l1Pypt8e3V2rX2PT2Q5aJhJvKTcMiP9YTHG/3H9Zb7Gq3UIwZLEAGXRqJOu1XlE0Fg== +"@secretlint/secretlint-formatter-sarif@^10.1.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/secretlint-formatter-sarif/-/secretlint-formatter-sarif-10.2.2.tgz#5c4044a6a6c9d95e2f57270d6184931f0979d649" + integrity sha512-ojiF9TGRKJJw308DnYBucHxkpNovDNu1XvPh7IfUp0A12gzTtxuWDqdpuVezL7/IP8Ua7mp5/VkDMN9OLp1doQ== dependencies: node-sarif-builder "^3.2.0" -"@secretlint/secretlint-rule-no-dotenv@^10.1.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/secretlint-rule-no-dotenv/-/secretlint-rule-no-dotenv-10.2.1.tgz#2c272beecd6c262b6d57413c72fe7aae57f1b3eb" - integrity sha512-XwPjc9Wwe2QljerfvGlBmLJAJVATLvoXXw1fnKyCDNgvY33cu1Z561Kxg93xfRB5LSep0S5hQrAfZRJw6x7MBQ== +"@secretlint/secretlint-rule-no-dotenv@^10.1.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/secretlint-rule-no-dotenv/-/secretlint-rule-no-dotenv-10.2.2.tgz#ea43dcc2abd1dac3288b056610361f319f5ce6e9" + integrity sha512-KJRbIShA9DVc5Va3yArtJ6QDzGjg3PRa1uYp9As4RsyKtKSSZjI64jVca57FZ8gbuk4em0/0Jq+uy6485wxIdg== dependencies: - "@secretlint/types" "^10.2.1" + "@secretlint/types" "^10.2.2" -"@secretlint/secretlint-rule-preset-recommend@^10.1.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/secretlint-rule-preset-recommend/-/secretlint-rule-preset-recommend-10.2.1.tgz#c00fbd2257328ec909da43431826cdfb729a2185" - integrity sha512-/kj3UOpFbJt80dqoeEaUVv5nbeW1jPqPExA447FItthiybnaDse5C5HYcfNA2ywEInr399ELdcmpEMRe+ld1iQ== +"@secretlint/secretlint-rule-preset-recommend@^10.1.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/secretlint-rule-preset-recommend/-/secretlint-rule-preset-recommend-10.2.2.tgz#27b17c38b360c6788826d28fcda28ac6e9772d0b" + integrity sha512-K3jPqjva8bQndDKJqctnGfwuAxU2n9XNCPtbXVI5JvC7FnQiNg/yWlQPbMUlBXtBoBGFYp08A94m6fvtc9v+zA== -"@secretlint/source-creator@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/source-creator/-/source-creator-10.2.1.tgz#1b1c1c64db677034e29c1a3db78dccd60da89d32" - integrity sha512-1CgO+hsRx8KdA5R/LEMNTJkujjomwSQQVV0BcuKynpOefV/rRlIDVQJOU0tJOZdqUMC15oAAwQXs9tMwWLu4JQ== +"@secretlint/source-creator@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/source-creator/-/source-creator-10.2.2.tgz#d600b6d4487859cdd39bbb1cf8cf744540b3f7a1" + integrity sha512-h6I87xJfwfUTgQ7irWq7UTdq/Bm1RuQ/fYhA3dtTIAop5BwSFmZyrchph4WcoEvbN460BWKmk4RYSvPElIIvxw== dependencies: - "@secretlint/types" "^10.2.1" + "@secretlint/types" "^10.2.2" istextorbinary "^9.5.0" -"@secretlint/types@^10.2.1": - version "10.2.1" - resolved "https://registry.yarnpkg.com/@secretlint/types/-/types-10.2.1.tgz#018f252a3754a9ff2371b3e132226d281be8515b" - integrity sha512-F5k1qpoMoUe7rrZossOBgJ3jWKv/FGDBZIwepqnefgPmNienBdInxhtZeXiGwjcxXHVhsdgp6I5Fi/M8PMgwcw== +"@secretlint/types@^10.2.2": + version "10.2.2" + resolved "https://registry.yarnpkg.com/@secretlint/types/-/types-10.2.2.tgz#1412d8f699fd900182cbf4c2923a9df9eb321ca7" + integrity sha512-Nqc90v4lWCXyakD6xNyNACBJNJ0tNCwj2WNk/7ivyacYHxiITVgmLUFXTBOeCdy79iz6HtN9Y31uw/jbLrdOAg== "@sindresorhus/merge-streams@^2.1.0": version "2.3.0" @@ -1579,16 +1579,16 @@ "@vscode/vsce-sign-win32-arm64" "2.0.5" "@vscode/vsce-sign-win32-x64" "2.0.5" -"@vscode/vsce@^3.6.0": - version "3.6.0" - resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.6.0.tgz#7102cb846db83ed70ec7119986af7d7c69cf3538" - integrity sha512-u2ZoMfymRNJb14aHNawnXJtXHLXDVKc1oKZaH4VELKT/9iWKRVgtQOdwxCgtwSxJoqYvuK4hGlBWQJ05wxADhg== +"@vscode/vsce@^3.6.2": + version "3.6.2" + resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.6.2.tgz#cefd2802f1dec24fca51293ae563e11912f545fd" + integrity sha512-gvBfarWF+Ii20ESqjA3dpnPJpQJ8fFJYtcWtjwbRADommCzGg1emtmb34E+DKKhECYvaVyAl+TF9lWS/3GSPvg== dependencies: "@azure/identity" "^4.1.0" - "@secretlint/node" "^10.1.1" - "@secretlint/secretlint-formatter-sarif" "^10.1.1" - "@secretlint/secretlint-rule-no-dotenv" "^10.1.1" - "@secretlint/secretlint-rule-preset-recommend" "^10.1.1" + "@secretlint/node" "^10.1.2" + "@secretlint/secretlint-formatter-sarif" "^10.1.2" + "@secretlint/secretlint-rule-no-dotenv" "^10.1.2" + "@secretlint/secretlint-rule-preset-recommend" "^10.1.2" "@vscode/vsce-sign" "^2.0.0" azure-devops-node-api "^12.5.0" chalk "^4.1.2" @@ -1605,7 +1605,7 @@ minimatch "^3.0.3" parse-semver "^1.1.1" read "^1.0.7" - secretlint "^10.1.1" + secretlint "^10.1.2" semver "^7.5.2" tmp "^0.2.3" typed-rest-client "^1.8.4" @@ -2408,12 +2408,7 @@ chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.2, chalk@~4.1.2: ansi-styles "^4.1.0" supports-color "^7.1.0" -chalk@^5.3.0: - version "5.3.0" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.3.0.tgz#67c20a7ebef70e7f3970a01f90fa210cb6860385" - integrity sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w== - -chalk@^5.4.1: +chalk@^5.3.0, chalk@^5.4.1: version "5.4.1" resolved "https://registry.yarnpkg.com/chalk/-/chalk-5.4.1.tgz#1b48bf0963ec158dce2aacf69c093ae2dd2092d8" integrity sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w== @@ -7493,15 +7488,15 @@ schema-utils@^4.3.0, schema-utils@^4.3.2: ajv-formats "^2.1.1" ajv-keywords "^5.1.0" -secretlint@^10.1.1: - version "10.2.1" - resolved "https://registry.yarnpkg.com/secretlint/-/secretlint-10.2.1.tgz#021ea25bb77f23efba22ce778d1a001b15de77b1" - integrity sha512-3BghQkIGrDz3xJklX/COxgKbxHz2CAsGkXH4oh8MxeYVLlhA3L/TLhAxZiTyqeril+CnDGg8MUEZdX1dZNsxVA== +secretlint@^10.1.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/secretlint/-/secretlint-10.2.2.tgz#c0cf997153a2bef0b653874dc87030daa6a35140" + integrity sha512-xVpkeHV/aoWe4vP4TansF622nBEImzCY73y/0042DuJ29iKIaqgoJ8fGxre3rVSHHbxar4FdJobmTnLp9AU0eg== dependencies: - "@secretlint/config-creator" "^10.2.1" - "@secretlint/formatter" "^10.2.1" - "@secretlint/node" "^10.2.1" - "@secretlint/profiler" "^10.2.1" + "@secretlint/config-creator" "^10.2.2" + "@secretlint/formatter" "^10.2.2" + "@secretlint/node" "^10.2.2" + "@secretlint/profiler" "^10.2.2" debug "^4.4.1" globby "^14.1.0" read-pkg "^9.0.1" From 159ffcb151974ba0de7a4f6de31923308f770ade Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 29 Oct 2025 12:55:46 -0800 Subject: [PATCH 17/55] chore(deps-dev): bump eslint-plugin-package-json from 0.56.3 to 0.59.0 (#635) --- package.json | 2 +- yarn.lock | 41 +++++++++++++++++++++++------------------ 2 files changed, 24 insertions(+), 19 deletions(-) diff --git a/package.json b/package.json index b7b63433..5db1a2a9 100644 --- a/package.json +++ b/package.json @@ -380,7 +380,7 @@ "eslint-import-resolver-typescript": "^4.4.4", "eslint-plugin-import": "^2.32.0", "eslint-plugin-md": "^1.0.19", - "eslint-plugin-package-json": "^0.56.3", + "eslint-plugin-package-json": "^0.59.0", "eslint-plugin-prettier": "^5.5.4", "glob": "^10.4.2", "jsonc-eslint-parser": "^2.4.0", diff --git a/yarn.lock b/yarn.lock index f7a7155f..ffdcadb0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2903,10 +2903,10 @@ delayed-stream@~1.0.0: resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ== -detect-indent@^7.0.1: - version "7.0.1" - resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-7.0.1.tgz#cbb060a12842b9c4d333f1cac4aa4da1bb66bc25" - integrity sha512-Mc7QhQ8s+cLrnUfU/Ji94vG/r8M26m8f++vyres4ZoojaRDpZ1eSIh/EpzLNwlWuvzSZ3UbDFspjFvTDXe6e/g== +detect-indent@^7.0.1, detect-indent@^7.0.2: + version "7.0.2" + resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-7.0.2.tgz#16c516bf75d4b2f759f68214554996d467c8d648" + integrity sha512-y+8xyqdGLL+6sh0tVeHcfP/QDd8gUgbasolJJpY7NgeQGSZ739bDtSiaiDgtoicy+mtYB81dKLxO9xRhCyIB3A== detect-libc@^2.0.0: version "2.0.1" @@ -3503,20 +3503,20 @@ eslint-plugin-md@^1.0.19: remark-preset-lint-markdown-style-guide "^2.1.3" requireindex "~1.1.0" -eslint-plugin-package-json@^0.56.3: - version "0.56.3" - resolved "https://registry.yarnpkg.com/eslint-plugin-package-json/-/eslint-plugin-package-json-0.56.3.tgz#dcf50aaf3a3bc377396d3df72bb63819b02e8d73" - integrity sha512-ArN3wnOAsduM/6a0egB83DQQfF/4KzxE53U8qcvELCXT929TnBy2IeCli4+in3QSHxcVYSIDa2Y5T2vVAXbe6A== +eslint-plugin-package-json@^0.59.0: + version "0.59.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-package-json/-/eslint-plugin-package-json-0.59.0.tgz#fb847e54742a3465de2e6c813608f95c88075c24" + integrity sha512-4xdVhL3b7LqQQh8cvN3hX8HkAVM6cxZoXqyN4ZE4kN9NuJ21sgnj1IGS19/bmIgCdGBhmsWGXbbyD1H9mjZfMA== dependencies: "@altano/repository-tools" "^2.0.1" change-case "^5.4.4" - detect-indent "^7.0.1" + detect-indent "^7.0.2" detect-newline "^4.0.1" eslint-fix-utils "~0.4.0" - package-json-validator "~0.30.0" - semver "^7.5.4" - sort-object-keys "^1.1.3" - sort-package-json "^3.3.0" + package-json-validator "~0.31.0" + semver "^7.7.3" + sort-object-keys "^2.0.0" + sort-package-json "^3.4.0" validate-npm-package-name "^6.0.2" eslint-plugin-prettier@^5.5.4: @@ -6235,10 +6235,10 @@ package-json-from-dist@^1.0.0: resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz#e501cd3094b278495eb4258d4c9f6d5ac3019f00" integrity sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw== -package-json-validator@~0.30.0: - version "0.30.0" - resolved "https://registry.yarnpkg.com/package-json-validator/-/package-json-validator-0.30.0.tgz#31613a3e4a2455599c7ad3a97f134707f13de1e0" - integrity sha512-gOLW+BBye32t+IB2trIALIcL3DZBy3s4G4ZV6dAgDM+qLs/7jUNOV7iO7PwXqyf+3izI12qHBwtS4kOSJp5Tdg== +package-json-validator@~0.31.0: + version "0.31.0" + resolved "https://registry.yarnpkg.com/package-json-validator/-/package-json-validator-0.31.0.tgz#c5a693e6db3ee9ca6dddfd5d07a79807f340dc77" + integrity sha512-kAVO0fNFWI2xpmthogYHnHjCtg0nJvwm9yjd9nnrR5OKIts5fmNMK2OhhjnLD1/ohJNodhCa5tZm8AolOgkfMg== dependencies: semver "^7.7.2" validate-npm-package-license "^3.0.4" @@ -7738,7 +7738,12 @@ sort-object-keys@^1.1.3: resolved "https://registry.yarnpkg.com/sort-object-keys/-/sort-object-keys-1.1.3.tgz#bff833fe85cab147b34742e45863453c1e190b45" integrity sha512-855pvK+VkU7PaKYPc+Jjnmt4EzejQHyhhF33q31qG8x7maDzkeFhAAThdCYay11CISO+qAMwjOBP+fPZe0IPyg== -sort-package-json@^3.3.0: +sort-object-keys@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/sort-object-keys/-/sort-object-keys-2.0.0.tgz#e5dc3d75d07d4efe73ba6ac55f2f1a4380fdedf8" + integrity sha512-FTUWjmUumK0IGXn1INzkS3lS2Fqw81JuomcExd7LsFvQnNl+9+IZ575fC21F/AwrR/6lMrH7lTX0e7qLBk1wMg== + +sort-package-json@^3.4.0: version "3.4.0" resolved "https://registry.yarnpkg.com/sort-package-json/-/sort-package-json-3.4.0.tgz#98e42b78848c517736b069f8aa4fa322fae56677" integrity sha512-97oFRRMM2/Js4oEA9LJhjyMlde+2ewpZQf53pgue27UkbEXfHJnDzHlUxQ/DWUkzqmp7DFwJp8D+wi/TYeQhpA== From a2d9d56abbb5b50b44d268e7c3dc8d669e235a1b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 15:32:50 +0300 Subject: [PATCH 18/55] chore(deps): bump actions/upload-artifact from 4 to 5 (#638) --- .github/workflows/ci.yaml | 4 ++-- .github/workflows/pre-release.yaml | 2 +- .github/workflows/release.yaml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a878f9f2..64e85a15 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -84,7 +84,7 @@ jobs: - name: Upload artifact (PR) if: github.event_name == 'pull_request' - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: extension-pr-${{ github.event.pull_request.number }} path: ${{ steps.setup.outputs.packageName }} @@ -93,7 +93,7 @@ jobs: - name: Upload artifact (main) if: github.event_name == 'push' && github.ref == 'refs/heads/main' - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: extension-main-${{ github.sha }} path: ${{ steps.setup.outputs.packageName }} diff --git a/.github/workflows/pre-release.yaml b/.github/workflows/pre-release.yaml index 61761700..430aa2a1 100644 --- a/.github/workflows/pre-release.yaml +++ b/.github/workflows/pre-release.yaml @@ -60,7 +60,7 @@ jobs: run: vsce package --pre-release --out "${{ steps.setup.outputs.packageName }}" - name: Upload artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: extension-${{ steps.version.outputs.version }} path: ${{ steps.setup.outputs.packageName }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 51d9ff97..557586ec 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -60,7 +60,7 @@ jobs: run: vsce package --out "${{ steps.setup.outputs.packageName }}" - name: Upload artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v5 with: name: extension-${{ steps.version.outputs.version }} path: ${{ steps.setup.outputs.packageName }} From 8bff063eccac671c9eb0f6fd22c4e1b34f31d36f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 15:36:41 +0300 Subject: [PATCH 19/55] chore(deps): bump actions/download-artifact from 5 to 6 (#636) --- .github/workflows/publish-extension.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish-extension.yaml b/.github/workflows/publish-extension.yaml index cf93d6ba..e7d5dca7 100644 --- a/.github/workflows/publish-extension.yaml +++ b/.github/workflows/publish-extension.yaml @@ -67,7 +67,7 @@ jobs: - name: Install vsce run: npm install -g @vscode/vsce - - uses: actions/download-artifact@v5 + - uses: actions/download-artifact@v6 with: name: extension-${{ inputs.version }} @@ -93,7 +93,7 @@ jobs: - name: Install ovsx run: npm install -g ovsx - - uses: actions/download-artifact@v5 + - uses: actions/download-artifact@v6 with: name: extension-${{ inputs.version }} @@ -111,7 +111,7 @@ jobs: needs: setup runs-on: ubuntu-22.04 steps: - - uses: actions/download-artifact@v5 + - uses: actions/download-artifact@v6 with: name: extension-${{ inputs.version }} From 6ea816a9d4fc5c32cf31e0c55d367f1efec7c7d4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 15:38:59 +0300 Subject: [PATCH 20/55] chore(deps-dev): bump glob from 10.4.5 to 11.0.3 (#637) --- package.json | 2 +- yarn.lock | 14 +++----------- 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/package.json b/package.json index 5db1a2a9..dfb6da93 100644 --- a/package.json +++ b/package.json @@ -382,7 +382,7 @@ "eslint-plugin-md": "^1.0.19", "eslint-plugin-package-json": "^0.59.0", "eslint-plugin-prettier": "^5.5.4", - "glob": "^10.4.2", + "glob": "^11.0.3", "jsonc-eslint-parser": "^2.4.0", "markdown-eslint-parser": "^1.2.1", "memfs": "^4.49.0", diff --git a/yarn.lock b/yarn.lock index ffdcadb0..deda75ac 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3952,15 +3952,7 @@ foreground-child@^2.0.0: cross-spawn "^7.0.0" signal-exit "^3.0.2" -foreground-child@^3.1.0, foreground-child@^3.3.0: - version "3.3.0" - resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.3.0.tgz#0ac8644c06e431439f8561db8ecf29a7b5519c77" - integrity sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg== - dependencies: - cross-spawn "^7.0.0" - signal-exit "^4.0.1" - -foreground-child@^3.1.1, foreground-child@^3.3.1: +foreground-child@^3.1.0, foreground-child@^3.1.1, foreground-child@^3.3.0, foreground-child@^3.3.1: version "3.3.1" resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.3.1.tgz#32e8e9ed1b68a3497befb9ac2b6adf92a638576f" integrity sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw== @@ -4241,7 +4233,7 @@ glob-to-regexp@^0.4.1: resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e" integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw== -glob@^10.3.10, glob@^10.4.1, glob@^10.4.2, glob@^10.4.5: +glob@^10.3.10, glob@^10.4.1, glob@^10.4.5: version "10.4.5" resolved "https://registry.yarnpkg.com/glob/-/glob-10.4.5.tgz#f4d9f0b90ffdbab09c9d77f5f29b4262517b0956" integrity sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg== @@ -4253,7 +4245,7 @@ glob@^10.3.10, glob@^10.4.1, glob@^10.4.2, glob@^10.4.5: package-json-from-dist "^1.0.0" path-scurry "^1.11.1" -glob@^11.0.0: +glob@^11.0.0, glob@^11.0.3: version "11.0.3" resolved "https://registry.yarnpkg.com/glob/-/glob-11.0.3.tgz#9d8087e6d72ddb3c4707b1d2778f80ea3eaefcd6" integrity sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA== From a1ad85e03e1f92116a2771a67a3d34561d9a807c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 15:43:08 +0300 Subject: [PATCH 21/55] chore(deps): bump zod from 3.25.65 to 4.1.12 (#640) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index dfb6da93..49844183 100644 --- a/package.json +++ b/package.json @@ -355,7 +355,7 @@ "semver": "^7.7.3", "ua-parser-js": "1.0.40", "ws": "^8.18.3", - "zod": "^3.25.65" + "zod": "^4.1.12" }, "devDependencies": { "@types/eventsource": "^3.0.0", diff --git a/yarn.lock b/yarn.lock index deda75ac..cecbf92d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9289,7 +9289,7 @@ yocto-queue@^0.1.0: resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== -zod@^3.25.65: - version "3.25.65" - resolved "https://registry.yarnpkg.com/zod/-/zod-3.25.65.tgz#190cb604e1b45e0f789a315f65463953d4d4beee" - integrity sha512-kMyE2qsXK1p+TAvO7zsf5wMFiCejU3obrUDs9bR1q5CBKykfvp7QhhXrycUylMoOow0iEUSyjLlZZdCsHwSldQ== +zod@^4.1.12: + version "4.1.12" + resolved "https://registry.yarnpkg.com/zod/-/zod-4.1.12.tgz#64f1ea53d00eab91853195653b5af9eee68970f0" + integrity sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ== From 35387f2fdd0e30700e2beb8669408655fb912eb2 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 11 Nov 2025 14:46:51 +0300 Subject: [PATCH 22/55] Add workspace and agent state machines with improved progress tracking (#627) Introduces state machines to manage workspace and agent lifecycle transitions during connection. Improves user experience with clearer progress messages, enhanced websocket-based log streaming, and proper handling of blocking startup scripts. Previously, the extension would connect before startup scripts completed, leaving users waiting with no indication. Now it waits for scripts to finish and shows clear progress throughout the connection process. Closes #626 --- CHANGELOG.md | 6 + src/api/coderApi.ts | 31 ++- src/api/workspace.ts | 125 ++++++---- src/commands.ts | 130 +---------- src/extension.ts | 7 +- src/promptUtils.ts | 131 +++++++++++ src/remote/remote.ts | 342 ++++++++-------------------- src/remote/terminalSession.ts | 39 ++++ src/remote/workspaceStateMachine.ts | 254 +++++++++++++++++++++ src/workspace/workspaceMonitor.ts | 20 +- 10 files changed, 654 insertions(+), 431 deletions(-) create mode 100644 src/promptUtils.ts create mode 100644 src/remote/terminalSession.ts create mode 100644 src/remote/workspaceStateMachine.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 927d6d12..fa31dd73 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Unreleased +### Changed + +- Improved workspace connection progress messages and enhanced the workspace build terminal + with better log streaming. The extension now also waits for blocking startup scripts to + complete before connecting, providing clear progress indicators during the wait. + ## [v1.11.3](https://github.com/coder/vscode-coder/releases/tag/v1.11.3) 2025-10-22 ### Fixed diff --git a/src/api/coderApi.ts b/src/api/coderApi.ts index da624bad..ef120ce4 100644 --- a/src/api/coderApi.ts +++ b/src/api/coderApi.ts @@ -11,6 +11,7 @@ import { type ProvisionerJobLog, type Workspace, type WorkspaceAgent, + type WorkspaceAgentLog, } from "coder/site/src/api/typesGenerated"; import * as vscode from "vscode"; import { type ClientOptions, type CloseEvent, type ErrorEvent } from "ws"; @@ -109,18 +110,42 @@ export class CoderApi extends Api { logs: ProvisionerJobLog[], options?: ClientOptions, ) => { + return this.watchLogs( + `/api/v2/workspacebuilds/${buildId}/logs`, + logs, + options, + ); + }; + + watchWorkspaceAgentLogs = async ( + agentId: string, + logs: WorkspaceAgentLog[], + options?: ClientOptions, + ) => { + return this.watchLogs( + `/api/v2/workspaceagents/${agentId}/logs`, + logs, + options, + ); + }; + + private async watchLogs( + apiRoute: string, + logs: { id: number }[], + options?: ClientOptions, + ) { const searchParams = new URLSearchParams({ follow: "true" }); const lastLog = logs.at(-1); if (lastLog) { searchParams.append("after", lastLog.id.toString()); } - return this.createWebSocket({ - apiRoute: `/api/v2/workspacebuilds/${buildId}/logs`, + return this.createWebSocket({ + apiRoute, searchParams, options, }); - }; + } private async createWebSocket( configs: Omit, diff --git a/src/api/workspace.ts b/src/api/workspace.ts index cb03d9fc..a24d3a64 100644 --- a/src/api/workspace.ts +++ b/src/api/workspace.ts @@ -1,11 +1,17 @@ -import { spawn } from "child_process"; import { type Api } from "coder/site/src/api/api"; -import { type Workspace } from "coder/site/src/api/typesGenerated"; +import { + type WorkspaceAgentLog, + type ProvisionerJobLog, + type Workspace, + type WorkspaceAgent, +} from "coder/site/src/api/typesGenerated"; +import { spawn } from "node:child_process"; import * as vscode from "vscode"; import { type FeatureSet } from "../featureSet"; import { getGlobalFlags } from "../globalFlags"; import { escapeCommandArg } from "../util"; +import { type OneWayWebSocket } from "../websocket/oneWayWebSocket"; import { errToStr, createWorkspaceIdentifier } from "./api-helper"; import { type CoderApi } from "./coderApi"; @@ -36,7 +42,7 @@ export async function startWorkspaceIfStoppedOrFailed( createWorkspaceIdentifier(workspace), ]; if (featureSet.buildReason) { - startArgs.push(...["--reason", "vscode_connection"]); + startArgs.push("--reason", "vscode_connection"); } // { shell: true } requires one shell-safe command string, otherwise we lose all escaping @@ -44,27 +50,25 @@ export async function startWorkspaceIfStoppedOrFailed( const startProcess = spawn(cmd, { shell: true }); startProcess.stdout.on("data", (data: Buffer) => { - data + const lines = data .toString() .split(/\r*\n/) - .forEach((line: string) => { - if (line !== "") { - writeEmitter.fire(line.toString() + "\r\n"); - } - }); + .filter((line) => line !== ""); + for (const line of lines) { + writeEmitter.fire(line.toString() + "\r\n"); + } }); let capturedStderr = ""; startProcess.stderr.on("data", (data: Buffer) => { - data + const lines = data .toString() .split(/\r*\n/) - .forEach((line: string) => { - if (line !== "") { - writeEmitter.fire(line.toString() + "\r\n"); - capturedStderr += line.toString() + "\n"; - } - }); + .filter((line) => line !== ""); + for (const line of lines) { + writeEmitter.fire(line.toString() + "\r\n"); + capturedStderr += line.toString() + "\n"; + } }); startProcess.on("close", (code: number) => { @@ -82,51 +86,72 @@ export async function startWorkspaceIfStoppedOrFailed( } /** - * Wait for the latest build to finish while streaming logs to the emitter. - * - * Once completed, fetch the workspace again and return it. + * Streams build logs to the emitter in real-time. + * Returns the websocket for lifecycle management. */ -export async function waitForBuild( +export async function streamBuildLogs( client: CoderApi, writeEmitter: vscode.EventEmitter, workspace: Workspace, -): Promise { - // This fetches the initial bunch of logs. - const logs = await client.getWorkspaceBuildLogs(workspace.latest_build.id); - logs.forEach((log) => writeEmitter.fire(log.output + "\r\n")); - +): Promise> { const socket = await client.watchBuildLogsByBuildId( workspace.latest_build.id, - logs, + [], ); - await new Promise((resolve, reject) => { - socket.addEventListener("message", (data) => { - if (data.parseError) { - writeEmitter.fire( - errToStr(data.parseError, "Failed to parse message") + "\r\n", - ); - } else { - writeEmitter.fire(data.parsedMessage.output + "\r\n"); - } - }); + socket.addEventListener("message", (data) => { + if (data.parseError) { + writeEmitter.fire( + errToStr(data.parseError, "Failed to parse message") + "\r\n", + ); + } else { + writeEmitter.fire(data.parsedMessage.output + "\r\n"); + } + }); + + socket.addEventListener("error", (error) => { + const baseUrlRaw = client.getAxiosInstance().defaults.baseURL; + writeEmitter.fire( + `Error watching workspace build logs on ${baseUrlRaw}: ${errToStr(error, "no further details")}\r\n`, + ); + }); + + socket.addEventListener("close", () => { + writeEmitter.fire("Build complete\r\n"); + }); + + return socket; +} - socket.addEventListener("error", (error) => { - const baseUrlRaw = client.getAxiosInstance().defaults.baseURL; - return reject( - new Error( - `Failed to watch workspace build on ${baseUrlRaw}: ${errToStr(error, "no further details")}`, - ), +/** + * Streams agent logs to the emitter in real-time. + * Returns the websocket for lifecycle management. + */ +export async function streamAgentLogs( + client: CoderApi, + writeEmitter: vscode.EventEmitter, + agent: WorkspaceAgent, +): Promise> { + const socket = await client.watchWorkspaceAgentLogs(agent.id, []); + + socket.addEventListener("message", (data) => { + if (data.parseError) { + writeEmitter.fire( + errToStr(data.parseError, "Failed to parse message") + "\r\n", ); - }); + } else { + for (const log of data.parsedMessage) { + writeEmitter.fire(log.output + "\r\n"); + } + } + }); - socket.addEventListener("close", () => resolve()); + socket.addEventListener("error", (error) => { + const baseUrlRaw = client.getAxiosInstance().defaults.baseURL; + writeEmitter.fire( + `Error watching agent logs on ${baseUrlRaw}: ${errToStr(error, "no further details")}\r\n`, + ); }); - writeEmitter.fire("Build complete\r\n"); - const updatedWorkspace = await client.getWorkspace(workspace.id); - writeEmitter.fire( - `Workspace is now ${updatedWorkspace.latest_build.status}\r\n`, - ); - return updatedWorkspace; + return socket; } diff --git a/src/commands.ts b/src/commands.ts index 5abeb026..682d745b 100644 --- a/src/commands.ts +++ b/src/commands.ts @@ -19,6 +19,7 @@ import { type SecretsManager } from "./core/secretsManager"; import { CertificateError } from "./error"; import { getGlobalFlags } from "./globalFlags"; import { type Logger } from "./logging/logger"; +import { maybeAskAgent, maybeAskUrl } from "./promptUtils"; import { escapeCommandArg, toRemoteAuthority, toSafeHost } from "./util"; import { AgentTreeItem, @@ -58,129 +59,6 @@ export class Commands { this.contextManager = serviceContainer.getContextManager(); } - /** - * Find the requested agent if specified, otherwise return the agent if there - * is only one or ask the user to pick if there are multiple. Return - * undefined if the user cancels. - */ - public async maybeAskAgent( - agents: WorkspaceAgent[], - filter?: string, - ): Promise { - const filteredAgents = filter - ? agents.filter((agent) => agent.name === filter) - : agents; - if (filteredAgents.length === 0) { - throw new Error("Workspace has no matching agents"); - } else if (filteredAgents.length === 1) { - return filteredAgents[0]; - } else { - const quickPick = vscode.window.createQuickPick(); - quickPick.title = "Select an agent"; - quickPick.busy = true; - const agentItems: vscode.QuickPickItem[] = filteredAgents.map((agent) => { - let icon = "$(debug-start)"; - if (agent.status !== "connected") { - icon = "$(debug-stop)"; - } - return { - alwaysShow: true, - label: `${icon} ${agent.name}`, - detail: `${agent.name} • Status: ${agent.status}`, - }; - }); - quickPick.items = agentItems; - quickPick.busy = false; - quickPick.show(); - - const selected = await new Promise( - (resolve) => { - quickPick.onDidHide(() => resolve(undefined)); - quickPick.onDidChangeSelection((selected) => { - if (selected.length < 1) { - return resolve(undefined); - } - const agent = filteredAgents[quickPick.items.indexOf(selected[0])]; - resolve(agent); - }); - }, - ); - quickPick.dispose(); - return selected; - } - } - - /** - * Ask the user for the URL, letting them choose from a list of recent URLs or - * CODER_URL or enter a new one. Undefined means the user aborted. - */ - private async askURL(selection?: string): Promise { - const defaultURL = vscode.workspace - .getConfiguration() - .get("coder.defaultUrl") - ?.trim(); - const quickPick = vscode.window.createQuickPick(); - quickPick.value = - selection || defaultURL || process.env.CODER_URL?.trim() || ""; - quickPick.placeholder = "https://example.coder.com"; - quickPick.title = "Enter the URL of your Coder deployment."; - - // Initial items. - quickPick.items = this.mementoManager - .withUrlHistory(defaultURL, process.env.CODER_URL) - .map((url) => ({ - alwaysShow: true, - label: url, - })); - - // Quick picks do not allow arbitrary values, so we add the value itself as - // an option in case the user wants to connect to something that is not in - // the list. - quickPick.onDidChangeValue((value) => { - quickPick.items = this.mementoManager - .withUrlHistory(defaultURL, process.env.CODER_URL, value) - .map((url) => ({ - alwaysShow: true, - label: url, - })); - }); - - quickPick.show(); - - const selected = await new Promise((resolve) => { - quickPick.onDidHide(() => resolve(undefined)); - quickPick.onDidChangeSelection((selected) => resolve(selected[0]?.label)); - }); - quickPick.dispose(); - return selected; - } - - /** - * Ask the user for the URL if it was not provided, letting them choose from a - * list of recent URLs or the default URL or CODER_URL or enter a new one, and - * normalizes the returned URL. Undefined means the user aborted. - */ - public async maybeAskUrl( - providedUrl: string | undefined | null, - lastUsedUrl?: string, - ): Promise { - let url = providedUrl || (await this.askURL(lastUsedUrl)); - if (!url) { - // User aborted. - return undefined; - } - - // Normalize URL. - if (!url.startsWith("http://") && !url.startsWith("https://")) { - // Default to HTTPS if not provided so URLs can be typed more easily. - url = "https://" + url; - } - while (url.endsWith("/")) { - url = url.substring(0, url.length - 1); - } - return url; - } - /** * Log into the provided deployment. If the deployment URL is not specified, * ask for it first with a menu showing recent URLs along with the default URL @@ -197,7 +75,7 @@ export class Commands { } this.logger.info("Logging in"); - const url = await this.maybeAskUrl(args?.url); + const url = await maybeAskUrl(this.mementoManager, args?.url); if (!url) { return; // The user aborted. } @@ -488,7 +366,7 @@ export class Commands { ); } else if (item instanceof WorkspaceTreeItem) { const agents = await this.extractAgentsWithFallback(item.workspace); - const agent = await this.maybeAskAgent(agents); + const agent = await maybeAskAgent(agents); if (!agent) { // User declined to pick an agent. return; @@ -611,7 +489,7 @@ export class Commands { } const agents = await this.extractAgentsWithFallback(workspace); - const agent = await this.maybeAskAgent(agents, agentName); + const agent = await maybeAskAgent(agents, agentName); if (!agent) { // User declined to pick an agent. return; diff --git a/src/extension.ts b/src/extension.ts index aba94cfe..cbb9e62e 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -12,6 +12,7 @@ import { Commands } from "./commands"; import { ServiceContainer } from "./core/container"; import { AuthAction } from "./core/secretsManager"; import { CertificateError, getErrorDetail } from "./error"; +import { maybeAskUrl } from "./promptUtils"; import { Remote } from "./remote/remote"; import { toSafeHost } from "./util"; import { @@ -147,7 +148,8 @@ export async function activate(ctx: vscode.ExtensionContext): Promise { // queries will default to localhost) so ask for it if missing. // Pre-populate in case we do have the right URL so the user can just // hit enter and move on. - const url = await commands.maybeAskUrl( + const url = await maybeAskUrl( + mementoManager, params.get("url"), mementoManager.getUrl(), ); @@ -230,7 +232,8 @@ export async function activate(ctx: vscode.ExtensionContext): Promise { // queries will default to localhost) so ask for it if missing. // Pre-populate in case we do have the right URL so the user can just // hit enter and move on. - const url = await commands.maybeAskUrl( + const url = await maybeAskUrl( + mementoManager, params.get("url"), mementoManager.getUrl(), ); diff --git a/src/promptUtils.ts b/src/promptUtils.ts new file mode 100644 index 00000000..4d058f12 --- /dev/null +++ b/src/promptUtils.ts @@ -0,0 +1,131 @@ +import { type WorkspaceAgent } from "coder/site/src/api/typesGenerated"; +import * as vscode from "vscode"; + +import { type MementoManager } from "./core/mementoManager"; + +/** + * Find the requested agent if specified, otherwise return the agent if there + * is only one or ask the user to pick if there are multiple. Return + * undefined if the user cancels. + */ +export async function maybeAskAgent( + agents: WorkspaceAgent[], + filter?: string, +): Promise { + const filteredAgents = filter + ? agents.filter((agent) => agent.name === filter) + : agents; + if (filteredAgents.length === 0) { + throw new Error("Workspace has no matching agents"); + } else if (filteredAgents.length === 1) { + return filteredAgents[0]; + } else { + const quickPick = vscode.window.createQuickPick(); + quickPick.title = "Select an agent"; + quickPick.busy = true; + const agentItems: vscode.QuickPickItem[] = filteredAgents.map((agent) => { + let icon = "$(debug-start)"; + if (agent.status !== "connected") { + icon = "$(debug-stop)"; + } + return { + alwaysShow: true, + label: `${icon} ${agent.name}`, + detail: `${agent.name} • Status: ${agent.status}`, + }; + }); + quickPick.items = agentItems; + quickPick.busy = false; + quickPick.show(); + + const selected = await new Promise( + (resolve) => { + quickPick.onDidHide(() => resolve(undefined)); + quickPick.onDidChangeSelection((selected) => { + if (selected.length < 1) { + return resolve(undefined); + } + const agent = filteredAgents[quickPick.items.indexOf(selected[0])]; + resolve(agent); + }); + }, + ); + quickPick.dispose(); + return selected; + } +} + +/** + * Ask the user for the URL, letting them choose from a list of recent URLs or + * CODER_URL or enter a new one. Undefined means the user aborted. + */ +async function askURL( + mementoManager: MementoManager, + selection?: string, +): Promise { + const defaultURL = vscode.workspace + .getConfiguration() + .get("coder.defaultUrl") + ?.trim(); + const quickPick = vscode.window.createQuickPick(); + quickPick.value = + selection || defaultURL || process.env.CODER_URL?.trim() || ""; + quickPick.placeholder = "https://example.coder.com"; + quickPick.title = "Enter the URL of your Coder deployment."; + + // Initial items. + quickPick.items = mementoManager + .withUrlHistory(defaultURL, process.env.CODER_URL) + .map((url) => ({ + alwaysShow: true, + label: url, + })); + + // Quick picks do not allow arbitrary values, so we add the value itself as + // an option in case the user wants to connect to something that is not in + // the list. + quickPick.onDidChangeValue((value) => { + quickPick.items = mementoManager + .withUrlHistory(defaultURL, process.env.CODER_URL, value) + .map((url) => ({ + alwaysShow: true, + label: url, + })); + }); + + quickPick.show(); + + const selected = await new Promise((resolve) => { + quickPick.onDidHide(() => resolve(undefined)); + quickPick.onDidChangeSelection((selected) => resolve(selected[0]?.label)); + }); + quickPick.dispose(); + return selected; +} + +/** + * Ask the user for the URL if it was not provided, letting them choose from a + * list of recent URLs or the default URL or CODER_URL or enter a new one, and + * normalizes the returned URL. Undefined means the user aborted. + */ +export async function maybeAskUrl( + mementoManager: MementoManager, + providedUrl: string | undefined | null, + lastUsedUrl?: string, +): Promise { + let url = providedUrl || (await askURL(mementoManager, lastUsedUrl)); + if (!url) { + // User aborted. + return undefined; + } + + // Normalize URL. + if (!url.startsWith("http://") && !url.startsWith("https://")) { + // Default to HTTPS if not provided so URLs can be typed more easily. + url = "https://" + url; + } + while (url.endsWith("/")) { + url = url.substring(0, url.length - 1); + } + return url; +} diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 97cb858e..0a9469c3 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -5,10 +5,10 @@ import { type WorkspaceAgent, } from "coder/site/src/api/typesGenerated"; import find from "find-process"; -import * as fs from "fs/promises"; import * as jsonc from "jsonc-parser"; -import * as os from "os"; -import * as path from "path"; +import * as fs from "node:fs/promises"; +import * as os from "node:os"; +import * as path from "node:path"; import prettyBytes from "pretty-bytes"; import * as semver from "semver"; import * as vscode from "vscode"; @@ -19,13 +19,9 @@ import { formatEventLabel, formatMetadataError, } from "../api/agentMetadataHelper"; -import { createWorkspaceIdentifier, extractAgents } from "../api/api-helper"; +import { extractAgents } from "../api/api-helper"; import { CoderApi } from "../api/coderApi"; import { needToken } from "../api/utils"; -import { - startWorkspaceIfStoppedOrFailed, - waitForBuild, -} from "../api/workspace"; import { type Commands } from "../commands"; import { type CliManager } from "../core/cliManager"; import * as cliUtils from "../core/cliUtils"; @@ -47,6 +43,7 @@ import { WorkspaceMonitor } from "../workspace/workspaceMonitor"; import { SSHConfig, type SSHValues, mergeSSHConfigValues } from "./sshConfig"; import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"; +import { WorkspaceStateMachine } from "./workspaceStateMachine"; export interface RemoteDetails extends vscode.Disposable { url: string; @@ -104,147 +101,6 @@ export class Remote { } } - private async confirmStart(workspaceName: string): Promise { - const action = await this.vscodeProposed.window.showInformationMessage( - `Unable to connect to the workspace ${workspaceName} because it is not running. Start the workspace?`, - { - useCustom: true, - modal: true, - }, - "Start", - ); - return action === "Start"; - } - - /** - * Try to get the workspace running. Return undefined if the user canceled. - */ - private async maybeWaitForRunning( - client: CoderApi, - workspace: Workspace, - label: string, - binPath: string, - featureSet: FeatureSet, - firstConnect: boolean, - ): Promise { - const workspaceName = createWorkspaceIdentifier(workspace); - - // A terminal will be used to stream the build, if one is necessary. - let writeEmitter: undefined | vscode.EventEmitter; - let terminal: undefined | vscode.Terminal; - let attempts = 0; - - function initWriteEmitterAndTerminal(): vscode.EventEmitter { - writeEmitter ??= new vscode.EventEmitter(); - if (!terminal) { - terminal = vscode.window.createTerminal({ - name: "Build Log", - location: vscode.TerminalLocation.Panel, - // Spin makes this gear icon spin! - iconPath: new vscode.ThemeIcon("gear~spin"), - pty: { - onDidWrite: writeEmitter.event, - close: () => undefined, - open: () => undefined, - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } as Partial as any, - }); - terminal.show(true); - } - return writeEmitter; - } - - try { - // Show a notification while we wait. - return await this.vscodeProposed.window.withProgress( - { - location: vscode.ProgressLocation.Notification, - cancellable: false, - title: "Waiting for workspace build...", - }, - async () => { - const globalConfigDir = this.pathResolver.getGlobalConfigDir(label); - while (workspace.latest_build.status !== "running") { - ++attempts; - switch (workspace.latest_build.status) { - case "pending": - case "starting": - case "stopping": - writeEmitter = initWriteEmitterAndTerminal(); - this.logger.info(`Waiting for ${workspaceName}...`); - workspace = await waitForBuild(client, writeEmitter, workspace); - break; - case "stopped": - if ( - !firstConnect && - !(await this.confirmStart(workspaceName)) - ) { - return undefined; - } - writeEmitter = initWriteEmitterAndTerminal(); - this.logger.info(`Starting ${workspaceName}...`); - workspace = await startWorkspaceIfStoppedOrFailed( - client, - globalConfigDir, - binPath, - workspace, - writeEmitter, - featureSet, - ); - break; - case "failed": - // On a first attempt, we will try starting a failed workspace - // (for example canceling a start seems to cause this state). - if (attempts === 1) { - if ( - !firstConnect && - !(await this.confirmStart(workspaceName)) - ) { - return undefined; - } - writeEmitter = initWriteEmitterAndTerminal(); - this.logger.info(`Starting ${workspaceName}...`); - workspace = await startWorkspaceIfStoppedOrFailed( - client, - globalConfigDir, - binPath, - workspace, - writeEmitter, - featureSet, - ); - break; - } - // Otherwise fall through and error. - case "canceled": - case "canceling": - case "deleted": - case "deleting": - default: { - const is = - workspace.latest_build.status === "failed" ? "has" : "is"; - throw new Error( - `${workspaceName} ${is} ${workspace.latest_build.status}`, - ); - } - } - this.logger.info( - `${workspaceName} status is now`, - workspace.latest_build.status, - ); - } - return workspace; - }, - ); - } finally { - if (writeEmitter) { - writeEmitter.dispose(); - } - if (terminal) { - terminal.dispose(); - } - } - } - /** * Ensure the workspace specified by the remote authority is ready to receive * SSH connections. Return undefined if the authority is not for a Coder @@ -427,36 +283,104 @@ export class Remote { dispose: () => labelFormatterDisposable.dispose(), }); - // If the workspace is not in a running state, try to get it running. - if (workspace.latest_build.status !== "running") { - const updatedWorkspace = await this.maybeWaitForRunning( - workspaceClient, - workspace, - parts.label, - binaryPath, - featureSet, - firstConnect, + // Watch the workspace for changes. + const monitor = await WorkspaceMonitor.create( + workspace, + workspaceClient, + this.logger, + this.vscodeProposed, + this.contextManager, + ); + disposables.push( + monitor, + monitor.onChange.event((w) => (this.commands.workspace = w)), + ); + + // Wait for workspace to be running and agent to be ready + const stateMachine = new WorkspaceStateMachine( + parts, + workspaceClient, + firstConnect, + binaryPath, + featureSet, + this.logger, + this.pathResolver, + this.vscodeProposed, + ); + disposables.push(stateMachine); + + try { + workspace = await this.vscodeProposed.window.withProgress( + { + location: vscode.ProgressLocation.Notification, + cancellable: false, + title: "Connecting to workspace", + }, + async (progress) => { + let inProgress = false; + let pendingWorkspace: Workspace | null = null; + + return new Promise((resolve, reject) => { + const processWorkspace = async (w: Workspace) => { + if (inProgress) { + // Process one workspace at a time, keeping only the last + pendingWorkspace = w; + return; + } + + inProgress = true; + try { + pendingWorkspace = null; + + const isReady = await stateMachine.processWorkspace( + w, + progress, + ); + if (isReady) { + subscription.dispose(); + resolve(w); + return; + } + } catch (error) { + subscription.dispose(); + reject(error); + } finally { + inProgress = false; + } + + if (pendingWorkspace) { + processWorkspace(pendingWorkspace); + } + }; + + processWorkspace(workspace); + const subscription = monitor.onChange.event(async (w) => + processWorkspace(w), + ); + }); + }, ); - if (!updatedWorkspace) { - // User declined to start the workspace. - await this.closeRemote(); - return; - } - workspace = updatedWorkspace; + } finally { + stateMachine.dispose(); } - this.commands.workspace = workspace; - // Pick an agent. - this.logger.info(`Finding agent for ${workspaceName}...`); + // Mark initial setup as complete so the monitor can start notifying about state changes + monitor.markInitialSetupComplete(); + const agents = extractAgents(workspace.latest_build.resources); - const gotAgent = await this.commands.maybeAskAgent(agents, parts.agent); - if (!gotAgent) { - // User declined to pick an agent. - await this.closeRemote(); - return; + const agent = agents.find( + (agent) => agent.id === stateMachine.getAgentId(), + ); + + if (!agent) { + throw new Error("Failed to get workspace or agent from state machine"); } - let agent = gotAgent; // Reassign so it cannot be undefined in callbacks. - this.logger.info(`Found agent ${agent.name} with status`, agent.status); + + this.commands.workspace = workspace; + + // Watch coder inbox for messages + const inbox = await Inbox.create(workspace, workspaceClient, this.logger); + disposables.push(inbox); // Do some janky setting manipulation. this.logger.info("Modifying settings..."); @@ -538,76 +462,6 @@ export class Remote { } } - // Watch the workspace for changes. - const monitor = await WorkspaceMonitor.create( - workspace, - workspaceClient, - this.logger, - this.vscodeProposed, - this.contextManager, - ); - disposables.push(monitor); - disposables.push( - monitor.onChange.event((w) => (this.commands.workspace = w)), - ); - - // Watch coder inbox for messages - const inbox = await Inbox.create(workspace, workspaceClient, this.logger); - disposables.push(inbox); - - // Wait for the agent to connect. - if (agent.status === "connecting") { - this.logger.info(`Waiting for ${workspaceName}/${agent.name}...`); - await vscode.window.withProgress( - { - title: "Waiting for the agent to connect...", - location: vscode.ProgressLocation.Notification, - }, - async () => { - await new Promise((resolve) => { - const updateEvent = monitor.onChange.event((workspace) => { - if (!agent) { - return; - } - const agents = extractAgents(workspace.latest_build.resources); - const found = agents.find((newAgent) => { - return newAgent.id === agent.id; - }); - if (!found) { - return; - } - agent = found; - if (agent.status === "connecting") { - return; - } - updateEvent.dispose(); - resolve(); - }); - }); - }, - ); - this.logger.info(`Agent ${agent.name} status is now`, agent.status); - } - - // Make sure the agent is connected. - // TODO: Should account for the lifecycle state as well? - if (agent.status !== "connected") { - const result = await this.vscodeProposed.window.showErrorMessage( - `${workspaceName}/${agent.name} ${agent.status}`, - { - useCustom: true, - modal: true, - detail: `The ${agent.name} agent failed to connect. Try restarting your workspace.`, - }, - ); - if (!result) { - await this.closeRemote(); - return; - } - await this.reloadWindow(); - return; - } - const logDir = this.getLogDir(featureSet); // This ensures the Remote SSH extension resolves the host to execute the diff --git a/src/remote/terminalSession.ts b/src/remote/terminalSession.ts new file mode 100644 index 00000000..358134a1 --- /dev/null +++ b/src/remote/terminalSession.ts @@ -0,0 +1,39 @@ +import * as vscode from "vscode"; + +/** + * Manages a terminal and its associated write emitter as a single unit. + * Ensures both are created together and disposed together properly. + */ +export class TerminalSession implements vscode.Disposable { + public readonly writeEmitter: vscode.EventEmitter; + public readonly terminal: vscode.Terminal; + + constructor(name: string) { + this.writeEmitter = new vscode.EventEmitter(); + this.terminal = vscode.window.createTerminal({ + name, + location: vscode.TerminalLocation.Panel, + // Spin makes this gear icon spin! + iconPath: new vscode.ThemeIcon("gear~spin"), + pty: { + onDidWrite: this.writeEmitter.event, + close: () => undefined, + open: () => undefined, + }, + }); + this.terminal.show(true); + } + + dispose(): void { + try { + this.writeEmitter.dispose(); + } catch { + // Ignore disposal errors + } + try { + this.terminal.dispose(); + } catch { + // Ignore disposal errors + } + } +} diff --git a/src/remote/workspaceStateMachine.ts b/src/remote/workspaceStateMachine.ts new file mode 100644 index 00000000..eb7aa335 --- /dev/null +++ b/src/remote/workspaceStateMachine.ts @@ -0,0 +1,254 @@ +import { type AuthorityParts } from "src/util"; + +import { createWorkspaceIdentifier, extractAgents } from "../api/api-helper"; +import { + startWorkspaceIfStoppedOrFailed, + streamAgentLogs, + streamBuildLogs, +} from "../api/workspace"; +import { maybeAskAgent } from "../promptUtils"; + +import { TerminalSession } from "./terminalSession"; + +import type { + ProvisionerJobLog, + Workspace, + WorkspaceAgentLog, +} from "coder/site/src/api/typesGenerated"; +import type * as vscode from "vscode"; + +import type { CoderApi } from "../api/coderApi"; +import type { PathResolver } from "../core/pathResolver"; +import type { FeatureSet } from "../featureSet"; +import type { Logger } from "../logging/logger"; +import type { OneWayWebSocket } from "../websocket/oneWayWebSocket"; + +/** + * Manages workspace and agent state transitions until ready for SSH connection. + * Streams build and agent logs, and handles socket lifecycle. + */ +export class WorkspaceStateMachine implements vscode.Disposable { + private readonly terminal: TerminalSession; + + private agent: { id: string; name: string } | undefined; + + private buildLogSocket: OneWayWebSocket | null = null; + + private agentLogSocket: OneWayWebSocket | null = null; + + constructor( + private readonly parts: AuthorityParts, + private readonly workspaceClient: CoderApi, + private readonly firstConnect: boolean, + private readonly binaryPath: string, + private readonly featureSet: FeatureSet, + private readonly logger: Logger, + private readonly pathResolver: PathResolver, + private readonly vscodeProposed: typeof vscode, + ) { + this.terminal = new TerminalSession("Workspace Build"); + } + + /** + * Process workspace state and determine if agent is ready. + * Reports progress updates and returns true if ready to connect, false if should wait for next event. + */ + async processWorkspace( + workspace: Workspace, + progress: vscode.Progress<{ message?: string }>, + ): Promise { + const workspaceName = createWorkspaceIdentifier(workspace); + + switch (workspace.latest_build.status) { + case "running": + this.closeBuildLogSocket(); + break; + + case "stopped": + case "failed": { + this.closeBuildLogSocket(); + + if (!this.firstConnect && !(await this.confirmStart(workspaceName))) { + throw new Error(`Workspace start cancelled`); + } + + progress.report({ message: `starting ${workspaceName}...` }); + this.logger.info(`Starting ${workspaceName}`); + const globalConfigDir = this.pathResolver.getGlobalConfigDir( + this.parts.label, + ); + await startWorkspaceIfStoppedOrFailed( + this.workspaceClient, + globalConfigDir, + this.binaryPath, + workspace, + this.terminal.writeEmitter, + this.featureSet, + ); + this.logger.info(`${workspaceName} status is now running`); + return false; + } + + case "pending": + case "starting": + case "stopping": + // Clear the agent since it's ID could change after a restart + this.agent = undefined; + this.closeAgentLogSocket(); + progress.report({ + message: `building ${workspaceName} (${workspace.latest_build.status})...`, + }); + this.logger.info(`Waiting for ${workspaceName}`); + + this.buildLogSocket ??= await streamBuildLogs( + this.workspaceClient, + this.terminal.writeEmitter, + workspace, + ); + return false; + + case "deleted": + case "deleting": + case "canceled": + case "canceling": + this.closeBuildLogSocket(); + throw new Error(`${workspaceName} is ${workspace.latest_build.status}`); + } + + const agents = extractAgents(workspace.latest_build.resources); + if (this.agent === undefined) { + this.logger.info(`Finding agent for ${workspaceName}`); + const gotAgent = await maybeAskAgent(agents, this.parts.agent); + if (!gotAgent) { + // User declined to pick an agent. + throw new Error("Agent selection cancelled"); + } + this.agent = { id: gotAgent.id, name: gotAgent.name }; + this.logger.info( + `Found agent ${gotAgent.name} with status`, + gotAgent.status, + ); + } + const agent = agents.find((a) => a.id === this.agent?.id); + if (!agent) { + throw new Error( + `Agent ${this.agent.name} not found in ${workspaceName} resources`, + ); + } + + switch (agent.status) { + case "connecting": + progress.report({ + message: `connecting to agent ${agent.name}...`, + }); + this.logger.debug(`Connecting to agent ${agent.name}`); + return false; + + case "disconnected": + throw new Error(`Agent ${workspaceName}/${agent.name} disconnected`); + + case "timeout": + progress.report({ + message: `agent ${agent.name} timed out, retrying...`, + }); + this.logger.debug(`Agent ${agent.name} timed out, retrying`); + return false; + + case "connected": + break; + } + + switch (agent.lifecycle_state) { + case "ready": + this.closeAgentLogSocket(); + return true; + + case "starting": { + const isBlocking = agent.scripts.some( + (script) => script.start_blocks_login, + ); + if (!isBlocking) { + return true; + } + + progress.report({ + message: `running agent ${agent.name} startup scripts...`, + }); + this.logger.debug(`Running agent ${agent.name} startup scripts`); + + this.agentLogSocket ??= await streamAgentLogs( + this.workspaceClient, + this.terminal.writeEmitter, + agent, + ); + return false; + } + + case "created": + progress.report({ + message: `starting agent ${agent.name}...`, + }); + this.logger.debug(`Starting agent ${agent.name}`); + return false; + + case "start_error": + this.closeAgentLogSocket(); + this.logger.info( + `Agent ${agent.name} startup scripts failed, but continuing`, + ); + return true; + + case "start_timeout": + this.closeAgentLogSocket(); + this.logger.info( + `Agent ${agent.name} startup scripts timed out, but continuing`, + ); + return true; + + case "shutting_down": + case "off": + case "shutdown_error": + case "shutdown_timeout": + this.closeAgentLogSocket(); + throw new Error( + `Invalid lifecycle state '${agent.lifecycle_state}' for ${workspaceName}/${agent.name}`, + ); + } + } + + private closeBuildLogSocket(): void { + if (this.buildLogSocket) { + this.buildLogSocket.close(); + this.buildLogSocket = null; + } + } + + private closeAgentLogSocket(): void { + if (this.agentLogSocket) { + this.agentLogSocket.close(); + this.agentLogSocket = null; + } + } + + private async confirmStart(workspaceName: string): Promise { + const action = await this.vscodeProposed.window.showInformationMessage( + `Unable to connect to the workspace ${workspaceName} because it is not running. Start the workspace?`, + { + useCustom: true, + modal: true, + }, + "Start", + ); + return action === "Start"; + } + + public getAgentId(): string | undefined { + return this.agent?.id; + } + + dispose(): void { + this.closeBuildLogSocket(); + this.closeAgentLogSocket(); + this.terminal.dispose(); + } +} diff --git a/src/workspace/workspaceMonitor.ts b/src/workspace/workspaceMonitor.ts index ceea8a91..1a332f4e 100644 --- a/src/workspace/workspaceMonitor.ts +++ b/src/workspace/workspaceMonitor.ts @@ -29,6 +29,7 @@ export class WorkspaceMonitor implements vscode.Disposable { private notifiedDeletion = false; private notifiedOutdated = false; private notifiedNotRunning = false; + private completedInitialSetup = false; readonly onChange = new vscode.EventEmitter(); private readonly statusBarItem: vscode.StatusBarItem; @@ -110,6 +111,10 @@ export class WorkspaceMonitor implements vscode.Disposable { return monitor; } + public markInitialSetupComplete(): void { + this.completedInitialSetup = true; + } + /** * Permanently close the websocket. */ @@ -130,8 +135,11 @@ export class WorkspaceMonitor implements vscode.Disposable { private maybeNotify(workspace: Workspace) { this.maybeNotifyOutdated(workspace); this.maybeNotifyAutostop(workspace); - this.maybeNotifyDeletion(workspace); - this.maybeNotifyNotRunning(workspace); + if (this.completedInitialSetup) { + // This instance might be created before the workspace is running + this.maybeNotifyDeletion(workspace); + this.maybeNotifyNotRunning(workspace); + } } private maybeNotifyAutostop(workspace: Workspace) { @@ -193,7 +201,7 @@ export class WorkspaceMonitor implements vscode.Disposable { } private isImpending(target: string, notifyTime: number): boolean { - const nowTime = new Date().getTime(); + const nowTime = Date.now(); const targetTime = new Date(target).getTime(); const timeLeft = targetTime - nowTime; return timeLeft >= 0 && timeLeft <= notifyTime; @@ -249,10 +257,10 @@ export class WorkspaceMonitor implements vscode.Disposable { } private updateStatusBar(workspace: Workspace) { - if (!workspace.outdated) { - this.statusBarItem.hide(); - } else { + if (workspace.outdated) { this.statusBarItem.show(); + } else { + this.statusBarItem.hide(); } } } From 11fffac430a1bb197c2a522c5767cced7ef47fce Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 15:52:42 +0300 Subject: [PATCH 23/55] chore(deps-dev): bump prettier from 3.5.3 to 3.6.2 (#644) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 49844183..c0e852f8 100644 --- a/package.json +++ b/package.json @@ -387,7 +387,7 @@ "markdown-eslint-parser": "^1.2.1", "memfs": "^4.49.0", "nyc": "^17.1.0", - "prettier": "^3.5.3", + "prettier": "^3.6.2", "ts-loader": "^9.5.1", "typescript": "^5.9.3", "utf-8-validate": "^6.0.5", diff --git a/yarn.lock b/yarn.lock index cecbf92d..85ab8d14 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6450,10 +6450,10 @@ prettier-linter-helpers@^1.0.0: dependencies: fast-diff "^1.1.2" -prettier@^3.5.3: - version "3.5.3" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.5.3.tgz#4fc2ce0d657e7a02e602549f053b239cb7dfe1b5" - integrity sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw== +prettier@^3.6.2: + version "3.6.2" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.6.2.tgz#ccda02a1003ebbb2bfda6f83a074978f608b9393" + integrity sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ== pretty-bytes@^7.0.0: version "7.0.0" From 729009e0382a3a0ee0d10613bc30ab378b0bd215 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 16:05:10 +0300 Subject: [PATCH 24/55] chore(deps-dev): bump ts-loader from 9.5.1 to 9.5.4 (#642) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index c0e852f8..b59e12ae 100644 --- a/package.json +++ b/package.json @@ -388,7 +388,7 @@ "memfs": "^4.49.0", "nyc": "^17.1.0", "prettier": "^3.6.2", - "ts-loader": "^9.5.1", + "ts-loader": "^9.5.4", "typescript": "^5.9.3", "utf-8-validate": "^6.0.5", "vitest": "^3.2.4", diff --git a/yarn.lock b/yarn.lock index 85ab8d14..6b8a35ee 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8305,10 +8305,10 @@ ts-api-utils@^2.1.0: resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-2.1.0.tgz#595f7094e46eed364c13fd23e75f9513d29baf91" integrity sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ== -ts-loader@^9.5.1: - version "9.5.1" - resolved "https://registry.yarnpkg.com/ts-loader/-/ts-loader-9.5.1.tgz#63d5912a86312f1fbe32cef0859fb8b2193d9b89" - integrity sha512-rNH3sK9kGZcH9dYzC7CewQm4NtxJTjSEVRJ2DyBZR7f8/wcta+iV44UPCXc5+nzDzivKtlzV6c9P4e+oFhDLYg== +ts-loader@^9.5.4: + version "9.5.4" + resolved "https://registry.yarnpkg.com/ts-loader/-/ts-loader-9.5.4.tgz#44b571165c10fb5a90744aa5b7e119233c4f4585" + integrity sha512-nCz0rEwunlTZiy6rXFByQU1kVVpCIgUpc/psFiKVrUwrizdnIbRFu8w7bxhUF0X613DYwT4XzrZHpVyMe758hQ== dependencies: chalk "^4.1.0" enhanced-resolve "^5.0.0" From 0ec0e8ad468ab7436abd010418014982adf54f4e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 16:09:56 +0300 Subject: [PATCH 25/55] chore(deps-dev): bump @vscode/test-cli from 0.0.11 to 0.0.12 (#641) --- package.json | 2 +- yarn.lock | 64 ++++++++++++++++++++++++---------------------------- 2 files changed, 31 insertions(+), 35 deletions(-) diff --git a/package.json b/package.json index b59e12ae..27088d07 100644 --- a/package.json +++ b/package.json @@ -369,7 +369,7 @@ "@typescript-eslint/eslint-plugin": "^8.44.0", "@typescript-eslint/parser": "^8.46.2", "@vitest/coverage-v8": "^3.2.4", - "@vscode/test-cli": "^0.0.11", + "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", "@vscode/vsce": "^3.6.2", "bufferutil": "^4.0.9", diff --git a/yarn.lock b/yarn.lock index 6b8a35ee..f36ad108 100644 --- a/yarn.lock +++ b/yarn.lock @@ -326,12 +326,7 @@ "@babel/helper-string-parser" "^7.25.9" "@babel/helper-validator-identifier" "^7.25.9" -"@bcoe/v8-coverage@^0.2.3": - version "0.2.3" - resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39" - integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw== - -"@bcoe/v8-coverage@^1.0.2": +"@bcoe/v8-coverage@^1.0.1", "@bcoe/v8-coverage@^1.0.2": version "1.0.2" resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz#bbe12dca5b4ef983a0d0af4b07b9bc90ea0ababa" integrity sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA== @@ -1097,7 +1092,7 @@ resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-5.1.2.tgz#07508b45797cb81ec3f273011b054cd0755eddca" integrity sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA== -"@types/mocha@^10.0.2": +"@types/mocha@^10.0.10": version "10.0.10" resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-10.0.10.tgz#91f62905e8d23cbd66225312f239454a23bebfa0" integrity sha512-xPyYSz1cMPnJQhl0CLMH68j3gprKZaTjG3s5Vi+fDgx+uhG9NOXwbVt52eFS8ECyXhyKcjDLCBEqBExKuiZb7Q== @@ -1493,19 +1488,19 @@ loupe "^3.1.4" tinyrainbow "^2.0.0" -"@vscode/test-cli@^0.0.11": - version "0.0.11" - resolved "https://registry.yarnpkg.com/@vscode/test-cli/-/test-cli-0.0.11.tgz#043b2c920ef1b115626eaabc5b02cd956044a51d" - integrity sha512-qO332yvzFqGhBMJrp6TdwbIydiHgCtxXc2Nl6M58mbH/Z+0CyLR76Jzv4YWPEthhrARprzCRJUqzFvTHFhTj7Q== +"@vscode/test-cli@^0.0.12": + version "0.0.12" + resolved "https://registry.yarnpkg.com/@vscode/test-cli/-/test-cli-0.0.12.tgz#38c1405436a1c960e1abc08790ea822fc9b3e412" + integrity sha512-iYN0fDg29+a2Xelle/Y56Xvv7Nc8Thzq4VwpzAF/SIE6918rDicqfsQxV6w1ttr2+SOm+10laGuY9FG2ptEKsQ== dependencies: - "@types/mocha" "^10.0.2" - c8 "^9.1.0" - chokidar "^3.5.3" - enhanced-resolve "^5.15.0" + "@types/mocha" "^10.0.10" + c8 "^10.1.3" + chokidar "^3.6.0" + enhanced-resolve "^5.18.3" glob "^10.3.10" minimatch "^9.0.3" - mocha "^11.1.0" - supports-color "^9.4.0" + mocha "^11.7.4" + supports-color "^10.2.2" yargs "^17.7.2" "@vscode/test-electron@^2.5.2": @@ -2262,19 +2257,19 @@ bundle-name@^4.1.0: dependencies: run-applescript "^7.0.0" -c8@^9.1.0: - version "9.1.0" - resolved "https://registry.yarnpkg.com/c8/-/c8-9.1.0.tgz#0e57ba3ab9e5960ab1d650b4a86f71e53cb68112" - integrity sha512-mBWcT5iqNir1zIkzSPyI3NCR9EZCVI3WUD+AVO17MVWTSFNyUueXE82qTeampNtTr+ilN/5Ua3j24LgbCKjDVg== +c8@^10.1.3: + version "10.1.3" + resolved "https://registry.yarnpkg.com/c8/-/c8-10.1.3.tgz#54afb25ebdcc7f3b00112482c6d90d7541ad2fcd" + integrity sha512-LvcyrOAaOnrrlMpW22n690PUvxiq4Uf9WMhQwNJ9vgagkL/ph1+D4uvjvDA5XCbykrc0sx+ay6pVi9YZ1GnhyA== dependencies: - "@bcoe/v8-coverage" "^0.2.3" + "@bcoe/v8-coverage" "^1.0.1" "@istanbuljs/schema" "^0.1.3" find-up "^5.0.0" foreground-child "^3.1.1" istanbul-lib-coverage "^3.2.0" istanbul-lib-report "^3.0.1" istanbul-reports "^3.1.6" - test-exclude "^6.0.0" + test-exclude "^7.0.1" v8-to-istanbul "^9.0.0" yargs "^17.7.2" yargs-parser "^21.1.1" @@ -2473,7 +2468,7 @@ cheerio@^1.0.0-rc.9: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" -chokidar@^3.5.3: +chokidar@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" integrity sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw== @@ -3034,7 +3029,7 @@ end-of-stream@^1.1.0, end-of-stream@^1.4.1: dependencies: once "^1.4.0" -enhanced-resolve@^5.0.0, enhanced-resolve@^5.15.0, enhanced-resolve@^5.17.3: +enhanced-resolve@^5.0.0, enhanced-resolve@^5.17.3, enhanced-resolve@^5.18.3: version "5.18.3" resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-5.18.3.tgz#9b5f4c5c076b8787c78fe540392ce76a88855b44" integrity sha512-d4lC8xfavMeBjzGr2vECC3fsGXziXZQyJxD868h2M/mBI3PwAuODxAkLkq5HYuvrPYcUtiLzsTo8U3PgX3Ocww== @@ -5808,10 +5803,10 @@ mkdirp-classic@^0.5.2, mkdirp-classic@^0.5.3: dependencies: minimist "^1.2.6" -mocha@^11.1.0: - version "11.7.2" - resolved "https://registry.yarnpkg.com/mocha/-/mocha-11.7.2.tgz#3c0079fe5cc2f8ea86d99124debcc42bb1ab22b5" - integrity sha512-lkqVJPmqqG/w5jmmFtiRvtA2jkDyNVUcefFJKb2uyX4dekk8Okgqop3cgbFiaIvj8uCRJVTP5x9dfxGyXm2jvQ== +mocha@^11.7.4: + version "11.7.4" + resolved "https://registry.yarnpkg.com/mocha/-/mocha-11.7.4.tgz#f161b17aeccb0762484b33bdb3f7ab9410ba5c82" + integrity sha512-1jYAaY8x0kAZ0XszLWu14pzsf4KV740Gld4HXkhNTXwcHx4AUEDkPzgEHg9CM5dVcW+zv036tjpsEbLraPJj4w== dependencies: browser-stdout "^1.3.1" chokidar "^4.0.1" @@ -5821,6 +5816,7 @@ mocha@^11.1.0: find-up "^5.0.0" glob "^10.4.5" he "^1.2.0" + is-path-inside "^3.0.3" js-yaml "^4.1.0" log-symbols "^4.1.0" minimatch "^9.0.5" @@ -8053,6 +8049,11 @@ structured-source@^4.0.0: dependencies: boundary "^2.0.0" +supports-color@^10.2.2: + version "10.2.2" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-10.2.2.tgz#466c2978cc5cd0052d542a0b576461c2b802ebb4" + integrity sha512-SS+jx45GF1QjgEXQx4NJZV9ImqmO2NPz5FNsIHrsDjh2YsHnawpan7SNQ1o8NuhrbHZy9AZhIoCUiCeaW/C80g== + supports-color@^5.3.0: version "5.5.0" resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" @@ -8074,11 +8075,6 @@ supports-color@^8.0.0, supports-color@^8.1.1: dependencies: has-flag "^4.0.0" -supports-color@^9.4.0: - version "9.4.0" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-9.4.0.tgz#17bfcf686288f531db3dea3215510621ccb55954" - integrity sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw== - supports-hyperlinks@^3.2.0: version "3.2.0" resolved "https://registry.yarnpkg.com/supports-hyperlinks/-/supports-hyperlinks-3.2.0.tgz#b8e485b179681dea496a1e7abdf8985bd3145461" From ebbbb9a9340dc47ff53b20537d46beb62192bf02 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Nov 2025 16:14:13 +0300 Subject: [PATCH 26/55] chore(deps): bump pretty-bytes from 7.0.0 to 7.1.0 (#643) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 27088d07..d7644974 100644 --- a/package.json +++ b/package.json @@ -350,7 +350,7 @@ "jsonc-parser": "^3.3.1", "node-forge": "^1.3.1", "openpgp": "^6.2.2", - "pretty-bytes": "^7.0.0", + "pretty-bytes": "^7.1.0", "proxy-agent": "^6.5.0", "semver": "^7.7.3", "ua-parser-js": "1.0.40", diff --git a/yarn.lock b/yarn.lock index f36ad108..b0817a48 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6451,10 +6451,10 @@ prettier@^3.6.2: resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.6.2.tgz#ccda02a1003ebbb2bfda6f83a074978f608b9393" integrity sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ== -pretty-bytes@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-7.0.0.tgz#8652cbf0aa81daeeaf72802e0fd059e5e1046cdb" - integrity sha512-U5otLYPR3L0SVjHGrkEUx5mf7MxV2ceXeE7VwWPk+hyzC5drNohsOGNPDZqxCqyX1lkbEN4kl1LiI8QFd7r0ZA== +pretty-bytes@^7.1.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-7.1.0.tgz#d788c9906241dbdcd4defab51b6d7470243db9bd" + integrity sha512-nODzvTiYVRGRqAOvE84Vk5JDPyyxsVk0/fbA/bq7RqlnhksGpset09XTxbpvLTIjoaF7K8Z8DG8yHtKGTPSYRw== process-nextick-args@~2.0.0: version "2.0.1" From fa2272a9c741740fb2c76f04b05cbe4202c8f573 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 17 Nov 2025 22:41:57 +0300 Subject: [PATCH 27/55] Remove node forge dependency (#648) Replaced `node-forge` with `@peculiar/x509` (more modern, lightweight, and widely adopted). Node.js's built-in `crypto` module was attempted first, but `keyUsage` returns `undefined`. **Testing in Electron** All vitest tests now run in Electron to mirror VS Code's environment. This adds a few seconds overhead vs Node.js. `electron` was added as dev dependency for BoringSSL compatibility (Node.js uses OpenSSL). --- .vscode/settings.json | 6 +- package.json | 6 +- src/error.ts | 48 ++-- src/remote/remote.ts | 1 + test/unit/error.test.ts | 73 +++--- yarn.lock | 490 +++++++++++++++++++++++++++++++++++++--- 6 files changed, 535 insertions(+), 89 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index daaef897..9dcd366b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,5 +10,9 @@ }, "[jsonc]": { "editor.defaultFormatter": "esbenp.prettier-vscode" - } + }, + "vitest.nodeEnv": { + "ELECTRON_RUN_AS_NODE": "1" + }, + "vitest.nodeExecutable": "node_modules/.bin/electron" } diff --git a/package.json b/package.json index d7644974..44865e25 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,7 @@ "package": "webpack --mode production --devtool hidden-source-map", "package:prerelease": "npx vsce package --pre-release", "pretest": "tsc -p . --outDir out && tsc -p test --outDir out && yarn run build && yarn run lint", - "test": "vitest", + "test": "ELECTRON_RUN_AS_NODE=1 electron node_modules/vitest/vitest.mjs", "test:ci": "CI=true yarn test", "test:integration": "vscode-test", "vscode:prepublish": "yarn package", @@ -343,12 +343,12 @@ "word-wrap": "1.2.5" }, "dependencies": { + "@peculiar/x509": "^1.14.0", "axios": "1.12.2", "date-fns": "^3.6.0", "eventsource": "^3.0.6", "find-process": "https://github.com/coder/find-process#fix/sequoia-compat", "jsonc-parser": "^3.3.1", - "node-forge": "^1.3.1", "openpgp": "^6.2.2", "pretty-bytes": "^7.1.0", "proxy-agent": "^6.5.0", @@ -361,7 +361,6 @@ "@types/eventsource": "^3.0.0", "@types/glob": "^7.1.3", "@types/node": "^22.14.1", - "@types/node-forge": "^1.3.14", "@types/semver": "^7.7.1", "@types/ua-parser-js": "0.7.36", "@types/vscode": "^1.73.0", @@ -375,6 +374,7 @@ "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", "dayjs": "^1.11.13", + "electron": "^39.1.2", "eslint": "^8.57.1", "eslint-config-prettier": "^10.1.8", "eslint-import-resolver-typescript": "^4.4.4", diff --git a/src/error.ts b/src/error.ts index 70448d76..09cf173a 100644 --- a/src/error.ts +++ b/src/error.ts @@ -1,7 +1,11 @@ +import { + X509Certificate, + KeyUsagesExtension, + KeyUsageFlags, +} from "@peculiar/x509"; import { isAxiosError } from "axios"; import { isApiError, isApiErrorResponse } from "coder/site/src/api/errors"; -import * as forge from "node-forge"; -import * as tls from "tls"; +import * as tls from "node:tls"; import * as vscode from "vscode"; import { type Logger } from "./logging/logger"; @@ -23,10 +27,6 @@ export enum X509_ERR { UNTRUSTED_CHAIN = "Your Coder deployment's certificate chain does not appear to be trusted by this system. The root of the certificate chain must be added to this system's trust store. ", } -interface KeyUsage { - keyCertSign: boolean; -} - export class CertificateError extends Error { public static ActionAllowInsecure = "Allow Insecure"; public static ActionOK = "OK"; @@ -80,7 +80,7 @@ export class CertificateError extends Error { const url = new URL(address); const socket = tls.connect( { - port: parseInt(url.port, 10) || 443, + port: Number.parseInt(url.port, 10) || 443, host: url.hostname, rejectUnauthorized: false, }, @@ -91,29 +91,27 @@ export class CertificateError extends Error { throw new Error("no peer certificate"); } - // We use node-forge for two reasons: - // 1. Node/Electron only provide extended key usage. - // 2. Electron's checkIssued() will fail because it suffers from same - // the key usage bug that we are trying to work around here in the - // first place. - const cert = forge.pki.certificateFromPem(x509.toString()); - if (!cert.issued(cert)) { + // We use "@peculiar/x509" because Node's x509 returns an undefined `keyUsage`. + const cert = new X509Certificate(x509.toString()); + const isSelfIssued = cert.subject === cert.issuer; + if (!isSelfIssued) { return resolve(X509_ERR.PARTIAL_CHAIN); } // The key usage needs to exist but not have cert signing to fail. - const keyUsage = cert.getExtension({ name: "keyUsage" }) as - | KeyUsage - | undefined; - if (keyUsage && !keyUsage.keyCertSign) { - return resolve(X509_ERR.NON_SIGNING); - } else { - // This branch is currently untested; it does not appear possible to - // get the error "unable to verify" with a self-signed certificate - // unless the key usage was the issue since it would have errored - // with "self-signed certificate" instead. - return resolve(X509_ERR.UNTRUSTED_LEAF); + const extension = cert.getExtension(KeyUsagesExtension); + if (extension) { + const hasKeyCertSign = + extension.usages & KeyUsageFlags.keyCertSign; + if (!hasKeyCertSign) { + return resolve(X509_ERR.NON_SIGNING); + } } + // This branch is currently untested; it does not appear possible to + // get the error "unable to verify" with a self-signed certificate + // unless the key usage was the issue since it would have errored + // with "self-signed certificate" instead. + return resolve(X509_ERR.UNTRUSTED_LEAF); }, ); socket.on("error", reject); diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 0a9469c3..1edf351c 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -344,6 +344,7 @@ export class Remote { } catch (error) { subscription.dispose(); reject(error); + return; } finally { inProgress = false; } diff --git a/test/unit/error.test.ts b/test/unit/error.test.ts index b606f875..7d239768 100644 --- a/test/unit/error.test.ts +++ b/test/unit/error.test.ts @@ -1,6 +1,11 @@ +import { + KeyUsagesExtension, + X509Certificate as X509CertificatePeculiar, +} from "@peculiar/x509"; import axios from "axios"; -import * as fs from "fs/promises"; -import https from "https"; +import { X509Certificate as X509CertificateNode } from "node:crypto"; +import * as fs from "node:fs/promises"; +import https from "node:https"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; import { CertificateError, X509_ERR, X509_ERR_CODE } from "@/error"; @@ -12,14 +17,11 @@ describe("Certificate errors", () => { // Before each test we make a request to sanity check that we really get the // error we are expecting, then we run it through CertificateError. - // TODO: These sanity checks need to be ran in an Electron environment to - // reflect real usage in VS Code. We should either revert back to the standard - // extension testing framework which I believe runs in a headless VS Code - // instead of using vitest or at least run the tests through Electron running as - // Node (for now I do this manually by shimming Node). - const isElectron = - (process.versions.electron || process.env.ELECTRON_RUN_AS_NODE) && - !process.env.VSCODE_PID; // Running from the test explorer in VS Code + // These tests run in Electron (BoringSSL) for accurate certificate validation testing. + + it("should run in Electron environment", () => { + expect(process.versions.electron).toBeTruthy(); + }); beforeAll(() => { vi.mock("vscode", () => { @@ -114,8 +116,7 @@ describe("Certificate errors", () => { }); // In Electron a self-issued certificate without the signing capability fails - // (again with the same "unable to verify" error) but in Node self-issued - // certificates are not required to have the signing capability. + // (again with the same "unable to verify" error) it("detects self-signed certificates without signing capability", async () => { const address = await startServer("no-signing"); const request = axios.get(address, { @@ -124,26 +125,16 @@ describe("Certificate errors", () => { servername: "localhost", }), }); - if (isElectron) { - await expect(request).rejects.toHaveProperty( - "code", - X509_ERR_CODE.UNABLE_TO_VERIFY_LEAF_SIGNATURE, - ); - try { - await request; - } catch (error) { - const wrapped = await CertificateError.maybeWrap( - error, - address, - logger, - ); - expect(wrapped instanceof CertificateError).toBeTruthy(); - expect((wrapped as CertificateError).x509Err).toBe( - X509_ERR.NON_SIGNING, - ); - } - } else { - await expect(request).resolves.toHaveProperty("data", "foobar"); + await expect(request).rejects.toHaveProperty( + "code", + X509_ERR_CODE.UNABLE_TO_VERIFY_LEAF_SIGNATURE, + ); + try { + await request; + } catch (error) { + const wrapped = await CertificateError.maybeWrap(error, address, logger); + expect(wrapped instanceof CertificateError).toBeTruthy(); + expect((wrapped as CertificateError).x509Err).toBe(X509_ERR.NON_SIGNING); } }); @@ -157,6 +148,24 @@ describe("Certificate errors", () => { await expect(request).resolves.toHaveProperty("data", "foobar"); }); + // Node's X509Certificate.keyUsage is unreliable, so use a third-party parser + it("parses no-signing cert keyUsage with third-party library", async () => { + const certPem = await fs.readFile( + getFixturePath("tls", "no-signing.crt"), + "utf-8", + ); + + // Node's implementation seems to always return `undefined` + const nodeCert = new X509CertificateNode(certPem); + expect(nodeCert.keyUsage).toBeUndefined(); + + // Here we can correctly get the KeyUsages + const peculiarCert = new X509CertificatePeculiar(certPem); + const extension = peculiarCert.getExtension(KeyUsagesExtension); + expect(extension).toBeDefined(); + expect(extension?.usages).toBeTruthy(); + }); + // Both environments give the same error code when a self-issued certificate is // untrusted. it("detects self-signed certificates", async () => { diff --git a/yarn.lock b/yarn.lock index b0817a48..ea35d101 100644 --- a/yarn.lock +++ b/yarn.lock @@ -336,6 +336,21 @@ resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.6.3.tgz#f13c7c205915eb91ae54c557f5e92bddd8be0e83" integrity sha512-4B4OijXeVNOPZlYA2oEwWOTkzyltLao+xbotHQeqN++Rv27Y6s818+n2Qkp8q+Fxhn0t/5lA5X1Mxktud8eayQ== +"@electron/get@^2.0.0": + version "2.0.3" + resolved "https://registry.yarnpkg.com/@electron/get/-/get-2.0.3.tgz#fba552683d387aebd9f3fcadbcafc8e12ee4f960" + integrity sha512-Qkzpg2s9GnVV2I2BjRksUi43U5e6+zaQMcjoJy0C+C5oxaKl+fmckGDQFtRpZpZV0NQekuZZ+tGz7EA9TVnQtQ== + dependencies: + debug "^4.1.1" + env-paths "^2.2.0" + fs-extra "^8.1.0" + got "^11.8.5" + progress "^2.0.3" + semver "^6.2.0" + sumchecker "^3.0.1" + optionalDependencies: + global-agent "^3.0.0" + "@emnapi/core@^1.4.3": version "1.5.0" resolved "https://registry.yarnpkg.com/@emnapi/core/-/core-1.5.0.tgz#85cd84537ec989cebb2343606a1ee663ce4edaf0" @@ -738,6 +753,129 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@peculiar/asn1-cms@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-cms/-/asn1-cms-2.5.0.tgz#3a7e857d86686898ce78efdbf481922bb805c68a" + integrity sha512-p0SjJ3TuuleIvjPM4aYfvYw8Fk1Hn/zAVyPJZTtZ2eE9/MIer6/18ROxX6N/e6edVSfvuZBqhxAj3YgsmSjQ/A== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-x509-attr" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-csr@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-csr/-/asn1-csr-2.5.0.tgz#4dd7534bd7d7db5bbbbde4d00d4836bf7e818d1c" + integrity sha512-ioigvA6WSYN9h/YssMmmoIwgl3RvZlAYx4A/9jD2qaqXZwGcNlAxaw54eSx2QG1Yu7YyBC5Rku3nNoHrQ16YsQ== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-ecc@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-ecc/-/asn1-ecc-2.5.0.tgz#3bbeaa3443567055be112b4c7e9d5562951242cf" + integrity sha512-t4eYGNhXtLRxaP50h3sfO6aJebUCDGQACoeexcelL4roMFRRVgB20yBIu2LxsPh/tdW9I282gNgMOyg3ywg/mg== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pfx@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pfx/-/asn1-pfx-2.5.0.tgz#22d12e676c063dfc6244278fe18eb75c2c121880" + integrity sha512-Vj0d0wxJZA+Ztqfb7W+/iu8Uasw6hhKtCdLKXLG/P3kEPIQpqGI4P4YXlROfl7gOCqFIbgsj1HzFIFwQ5s20ug== + dependencies: + "@peculiar/asn1-cms" "^2.5.0" + "@peculiar/asn1-pkcs8" "^2.5.0" + "@peculiar/asn1-rsa" "^2.5.0" + "@peculiar/asn1-schema" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pkcs8@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.5.0.tgz#1939643773e928a4802813b595e324a05b453709" + integrity sha512-L7599HTI2SLlitlpEP8oAPaJgYssByI4eCwQq2C9eC90otFpm8MRn66PpbKviweAlhinWQ3ZjDD2KIVtx7PaVw== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-pkcs9@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.5.0.tgz#8c5b873a721bb92b4fe758da9de1ead63165106d" + integrity sha512-UgqSMBLNLR5TzEZ5ZzxR45Nk6VJrammxd60WMSkofyNzd3DQLSNycGWSK5Xg3UTYbXcDFyG8pA/7/y/ztVCa6A== + dependencies: + "@peculiar/asn1-cms" "^2.5.0" + "@peculiar/asn1-pfx" "^2.5.0" + "@peculiar/asn1-pkcs8" "^2.5.0" + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-x509-attr" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-rsa@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-rsa/-/asn1-rsa-2.5.0.tgz#7283756ec596ccfbef23ff0e7eda0c37133ebed8" + integrity sha512-qMZ/vweiTHy9syrkkqWFvbT3eLoedvamcUdnnvwyyUNv5FgFXA3KP8td+ATibnlZ0EANW5PYRm8E6MJzEB/72Q== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-schema@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.5.0.tgz#4e58d7c3087c4259cebf5363e092f85b9cbf0ca1" + integrity sha512-YM/nFfskFJSlHqv59ed6dZlLZqtZQwjRVJ4bBAiWV08Oc+1rSd5lDZcBEx0lGDHfSoH3UziI2pXt2UM33KerPQ== + dependencies: + asn1js "^3.0.6" + pvtsutils "^1.3.6" + tslib "^2.8.1" + +"@peculiar/asn1-x509-attr@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.5.0.tgz#d413597dfe097620a00780e9e2ae851b06f32aed" + integrity sha512-9f0hPOxiJDoG/bfNLAFven+Bd4gwz/VzrCIIWc1025LEI4BXO0U5fOCTNDPbbp2ll+UzqKsZ3g61mpBp74gk9A== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + asn1js "^3.0.6" + tslib "^2.8.1" + +"@peculiar/asn1-x509@^2.5.0": + version "2.5.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509/-/asn1-x509-2.5.0.tgz#305f9cd534f4b6a723d27fc59363f382debf5500" + integrity sha512-CpwtMCTJvfvYTFMuiME5IH+8qmDe3yEWzKHe7OOADbGfq7ohxeLaXwQo0q4du3qs0AII3UbLCvb9NF/6q0oTKQ== + dependencies: + "@peculiar/asn1-schema" "^2.5.0" + asn1js "^3.0.6" + pvtsutils "^1.3.6" + tslib "^2.8.1" + +"@peculiar/x509@^1.14.0": + version "1.14.0" + resolved "https://registry.yarnpkg.com/@peculiar/x509/-/x509-1.14.0.tgz#4b1abdf7ca5e46f2cb303fba608ef0507762e84a" + integrity sha512-Yc4PDxN3OrxUPiXgU63c+ZRXKGE8YKF2McTciYhUHFtHVB0KMnjeFSU0qpztGhsp4P0uKix4+J2xEpIEDu8oXg== + dependencies: + "@peculiar/asn1-cms" "^2.5.0" + "@peculiar/asn1-csr" "^2.5.0" + "@peculiar/asn1-ecc" "^2.5.0" + "@peculiar/asn1-pkcs9" "^2.5.0" + "@peculiar/asn1-rsa" "^2.5.0" + "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-x509" "^2.5.0" + pvtsutils "^1.3.6" + reflect-metadata "^0.2.2" + tslib "^2.8.1" + tsyringe "^4.10.0" + "@pkgjs/parseargs@^0.11.0": version "0.11.0" resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33" @@ -960,11 +1098,23 @@ resolved "https://registry.yarnpkg.com/@secretlint/types/-/types-10.2.2.tgz#1412d8f699fd900182cbf4c2923a9df9eb321ca7" integrity sha512-Nqc90v4lWCXyakD6xNyNACBJNJ0tNCwj2WNk/7ivyacYHxiITVgmLUFXTBOeCdy79iz6HtN9Y31uw/jbLrdOAg== +"@sindresorhus/is@^4.0.0": + version "4.6.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-4.6.0.tgz#3c7c9c46e678feefe7a2e5bb609d3dbd665ffb3f" + integrity sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw== + "@sindresorhus/merge-streams@^2.1.0": version "2.3.0" resolved "https://registry.yarnpkg.com/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz#719df7fb41766bc143369eaa0dd56d8dc87c9958" integrity sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg== +"@szmarczak/http-timer@^4.0.5": + version "4.0.6" + resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-4.0.6.tgz#b4a914bb62e7c272d4e5989fe4440f812ab1d807" + integrity sha512-4BAffykYOgO+5nzBWYwE3W90sBgLJoUPRWWcL8wlyiM8IB8ipJz3UMJ9KXQd1RKQXpKp8Tutn80HZtWsu2u76w== + dependencies: + defer-to-connect "^2.0.0" + "@textlint/ast-node-types@15.2.1": version "15.2.1" resolved "https://registry.yarnpkg.com/@textlint/ast-node-types/-/ast-node-types-15.2.1.tgz#b98ce5bdf9e39941caa02e4cfcee459656c82b21" @@ -1024,6 +1174,16 @@ dependencies: tslib "^2.4.0" +"@types/cacheable-request@^6.0.1": + version "6.0.3" + resolved "https://registry.yarnpkg.com/@types/cacheable-request/-/cacheable-request-6.0.3.tgz#a430b3260466ca7b5ca5bfd735693b36e7a9d183" + integrity sha512-IQ3EbTzGxIigb1I3qPZc1rWJnH0BmSKv5QYTalEwweFvyBDLSAe24zP0le/hyi7ecGfZVlIVAg4BZqb8WBwKqw== + dependencies: + "@types/http-cache-semantics" "*" + "@types/keyv" "^3.1.4" + "@types/node" "*" + "@types/responselike" "^1.0.0" + "@types/chai@^5.2.2": version "5.2.2" resolved "https://registry.yarnpkg.com/@types/chai/-/chai-5.2.2.tgz#6f14cea18180ffc4416bc0fd12be05fdd73bdd6b" @@ -1072,6 +1232,11 @@ "@types/minimatch" "*" "@types/node" "*" +"@types/http-cache-semantics@*": + version "4.0.4" + resolved "https://registry.yarnpkg.com/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz#b979ebad3919799c979b17c72621c0bc0a31c6c4" + integrity sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA== + "@types/istanbul-lib-coverage@^2.0.1": version "2.0.6" resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz#7739c232a1fee9b4d3ce8985f314c0c6d33549d7" @@ -1087,6 +1252,13 @@ resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee" integrity sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ== +"@types/keyv@^3.1.4": + version "3.1.4" + resolved "https://registry.yarnpkg.com/@types/keyv/-/keyv-3.1.4.tgz#3ccdb1c6751b0c7e52300bcdacd5bcbf8faa75b6" + integrity sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg== + dependencies: + "@types/node" "*" + "@types/minimatch@*": version "5.1.2" resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-5.1.2.tgz#07508b45797cb81ec3f273011b054cd0755eddca" @@ -1097,13 +1269,6 @@ resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-10.0.10.tgz#91f62905e8d23cbd66225312f239454a23bebfa0" integrity sha512-xPyYSz1cMPnJQhl0CLMH68j3gprKZaTjG3s5Vi+fDgx+uhG9NOXwbVt52eFS8ECyXhyKcjDLCBEqBExKuiZb7Q== -"@types/node-forge@^1.3.14": - version "1.3.14" - resolved "https://registry.yarnpkg.com/@types/node-forge/-/node-forge-1.3.14.tgz#006c2616ccd65550560c2757d8472eb6d3ecea0b" - integrity sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw== - dependencies: - "@types/node" "*" - "@types/node@*", "@types/node@^22.14.1": version "22.14.1" resolved "https://registry.yarnpkg.com/@types/node/-/node-22.14.1.tgz#53b54585cec81c21eee3697521e31312d6ca1e6f" @@ -1111,11 +1276,25 @@ dependencies: undici-types "~6.21.0" +"@types/node@^22.7.7": + version "22.19.1" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.19.1.tgz#1188f1ddc9f46b4cc3aec76749050b4e1f459b7b" + integrity sha512-LCCV0HdSZZZb34qifBsyWlUmok6W7ouER+oQIGBScS8EsZsQbrtFTUrDX4hOl+CS6p7cnNC4td+qrSVGSCTUfQ== + dependencies: + undici-types "~6.21.0" + "@types/normalize-package-data@^2.4.3": version "2.4.4" resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz#56e2cc26c397c038fab0e3a917a12d5c5909e901" integrity sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA== +"@types/responselike@^1.0.0": + version "1.0.3" + resolved "https://registry.yarnpkg.com/@types/responselike/-/responselike-1.0.3.tgz#cc29706f0a397cfe6df89debfe4bf5cea159db50" + integrity sha512-H/+L+UkTV33uf49PH5pCAUBVPNj2nDBXTN+qS1dOwyyg24l3CcicicCA7ca+HMvJBZcFgl5r8e+RR6elsb4Lyw== + dependencies: + "@types/node" "*" + "@types/sarif@^2.1.7": version "2.1.7" resolved "https://registry.yarnpkg.com/@types/sarif/-/sarif-2.1.7.tgz#dab4d16ba7568e9846c454a8764f33c5d98e5524" @@ -1148,6 +1327,13 @@ dependencies: "@types/node" "*" +"@types/yauzl@^2.9.1": + version "2.10.3" + resolved "https://registry.yarnpkg.com/@types/yauzl/-/yauzl-2.10.3.tgz#e9b2808b4f109504a03cda958259876f61017999" + integrity sha512-oJoftv0LSuaDZE3Le4DbKX+KS9G36NzOeSap90UIK0yMA/NhKJhqlSGtNDORNRaIbQfzjXDrQa0ytJ6mNRGz/Q== + dependencies: + "@types/node" "*" + "@typescript-eslint/eslint-plugin@^8.44.0": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.44.1.tgz#011a2b5913d297b3d9d77f64fb78575bab01a1b3" @@ -2029,6 +2215,15 @@ arraybuffer.prototype.slice@^1.0.4: get-intrinsic "^1.2.6" is-array-buffer "^3.0.4" +asn1js@^3.0.6: + version "3.0.6" + resolved "https://registry.yarnpkg.com/asn1js/-/asn1js-3.0.6.tgz#53e002ebe00c5f7fd77c1c047c3557d7c04dce25" + integrity sha512-UOCGPYbl0tv8+006qks/dTgV9ajs97X2p0FAbyS2iyCRrmLSRolDaHdp+v/CLgnzHc3fVB+CwYiUmei7ndFcgA== + dependencies: + pvtsutils "^1.3.6" + pvutils "^1.1.3" + tslib "^2.8.1" + assertion-error@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/assertion-error/-/assertion-error-2.0.1.tgz#f641a196b335690b1070bf00b6e7593fec190bf7" @@ -2168,6 +2363,11 @@ boolbase@^1.0.0: resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e" integrity sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww== +boolean@^3.0.1: + version "3.2.0" + resolved "https://registry.yarnpkg.com/boolean/-/boolean-3.2.0.tgz#9e5294af4e98314494cbb17979fa54ca159f116b" + integrity sha512-d0II/GO9uf9lfUHH2BQsjxzRJZBdsjgsBiW4BvhWk/3qoKwQFjIDVN19PfX8F2D/r9PCMTtLWjYVCFrpeYUzsw== + boundary@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/boundary/-/boundary-2.0.0.tgz#169c8b1f0d44cf2c25938967a328f37e0a4e5efc" @@ -2279,6 +2479,24 @@ cac@^6.7.14: resolved "https://registry.yarnpkg.com/cac/-/cac-6.7.14.tgz#804e1e6f506ee363cb0e3ccbb09cad5dd9870959" integrity sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ== +cacheable-lookup@^5.0.3: + version "5.0.4" + resolved "https://registry.yarnpkg.com/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz#5a6b865b2c44357be3d5ebc2a467b032719a7005" + integrity sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA== + +cacheable-request@^7.0.2: + version "7.0.4" + resolved "https://registry.yarnpkg.com/cacheable-request/-/cacheable-request-7.0.4.tgz#7a33ebf08613178b403635be7b899d3e69bbe817" + integrity sha512-v+p6ongsrp0yTGbJXjgxPow2+DL93DASP4kXCDKb8/bwRtt9OEF3whggkkDkGNzgcWy2XaF4a8nZglC7uElscg== + dependencies: + clone-response "^1.0.2" + get-stream "^5.1.0" + http-cache-semantics "^4.0.0" + keyv "^4.0.0" + lowercase-keys "^2.0.0" + normalize-url "^6.0.1" + responselike "^2.0.0" + caching-transform@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/caching-transform/-/caching-transform-4.0.0.tgz#00d297a4206d71e2163c39eaffa8157ac0651f0f" @@ -2565,6 +2783,13 @@ clone-deep@^4.0.1: kind-of "^6.0.2" shallow-clone "^3.0.0" +clone-response@^1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/clone-response/-/clone-response-1.0.3.tgz#af2032aa47816399cf5f0a1d0db902f517abb8c3" + integrity sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA== + dependencies: + mimic-response "^1.0.0" + co@3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/co/-/co-3.1.0.tgz#4ea54ea5a08938153185e15210c68d9092bc1b78" @@ -2835,6 +3060,11 @@ default-require-extensions@^3.0.0: dependencies: strip-bom "^4.0.0" +defer-to-connect@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/defer-to-connect/-/defer-to-connect-2.0.1.tgz#8016bdb4143e4632b77a3449c6236277de520587" + integrity sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg== + define-data-property@^1.0.1: version "1.1.0" resolved "https://registry.yarnpkg.com/define-data-property/-/define-data-property-1.1.0.tgz#0db13540704e1d8d479a0656cf781267531b9451" @@ -2913,6 +3143,11 @@ detect-newline@^4.0.1: resolved "https://registry.yarnpkg.com/detect-newline/-/detect-newline-4.0.1.tgz#fcefdb5713e1fb8cb2839b8b6ee22e6716ab8f23" integrity sha512-qE3Veg1YXzGHQhlA6jzebZN2qVf6NX+A7m7qlhCGG30dJixrAQhYOsJjsnBjJkCSmuOPpCk30145fr8FV0bzog== +detect-node@^2.0.4: + version "2.1.0" + resolved "https://registry.yarnpkg.com/detect-node/-/detect-node-2.1.0.tgz#c9c70775a49c3d03bc2c06d9a73be550f978f8b1" + integrity sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g== + diff@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/diff/-/diff-7.0.0.tgz#3fb34d387cd76d803f6eebea67b921dab0182a9a" @@ -3002,6 +3237,15 @@ electron-to-chromium@^1.5.41: resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.50.tgz#d9ba818da7b2b5ef1f3dd32bce7046feb7e93234" integrity sha512-eMVObiUQ2LdgeO1F/ySTXsvqvxb6ZH2zPGaMYsWzRDdOddUa77tdmI0ltg+L16UpbWdhPmuF3wIQYyQq65WfZw== +electron@^39.1.2: + version "39.1.2" + resolved "https://registry.yarnpkg.com/electron/-/electron-39.1.2.tgz#8871c24c6795aeae8eefc08a9800a4bd0f04093c" + integrity sha512-+/TwT9NWxyQGTm5WemJEJy+bWCpnKJ4PLPswI1yn1P63bzM0/8yAeG05yS+NfFaWH4yNQtGXZmAv87Bxa5RlLg== + dependencies: + "@electron/get" "^2.0.0" + "@types/node" "^22.7.7" + extract-zip "^2.0.1" + emoji-regex@^10.3.0: version "10.4.0" resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-10.4.0.tgz#03553afea80b3975749cfcb36f776ca268e413d4" @@ -3042,6 +3286,11 @@ entities@^4.2.0, entities@^4.3.0, entities@^4.4.0: resolved "https://registry.yarnpkg.com/entities/-/entities-4.4.0.tgz#97bdaba170339446495e653cfd2db78962900174" integrity sha512-oYp7156SP8LkeGD0GF85ad1X9Ai79WtRsZ2gxJqtBuzH+98YUV6jkHEKlZkMbcrjJjIVJNIDP/3WL9wQkoPbWA== +env-paths@^2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/env-paths/-/env-paths-2.2.1.tgz#420399d416ce1fbe9bc0a07c62fa68d67fd0f8f2" + integrity sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A== + envinfo@^7.14.0: version "7.14.0" resolved "https://registry.yarnpkg.com/envinfo/-/envinfo-7.14.0.tgz#26dac5db54418f2a4c1159153a0b2ae980838aae" @@ -3350,7 +3599,7 @@ es-to-primitive@^1.3.0: is-date-object "^1.0.5" is-symbol "^1.0.4" -es6-error@^4.0.1: +es6-error@^4.0.1, es6-error@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/es6-error/-/es6-error-4.1.1.tgz#9e3af407459deed47e9a91f9b885a84eb05c561d" integrity sha512-Um/+FxMr9CISWh0bi5Zv0iOD+4cFh5qLeks1qhAopKVAJw3drgKbKySikp7wGhDL0HPeaja0P5ULZrxLkniUVg== @@ -3754,6 +4003,17 @@ external-editor@^3.0.3: iconv-lite "^0.4.24" tmp "^0.0.33" +extract-zip@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/extract-zip/-/extract-zip-2.0.1.tgz#663dca56fe46df890d5f131ef4a06d22bb8ba13a" + integrity sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg== + dependencies: + debug "^4.1.1" + get-stream "^5.1.0" + yauzl "^2.10.0" + optionalDependencies: + "@types/yauzl" "^2.9.1" + fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: version "3.1.3" resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" @@ -3999,6 +4259,15 @@ fs-extra@^11.2.0: jsonfile "^6.0.1" universalify "^2.0.0" +fs-extra@^8.1.0: + version "8.1.0" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-8.1.0.tgz#49d43c45a88cd9677668cb7be1b46efdb8d2e1c0" + integrity sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^4.0.0" + universalify "^0.1.0" + fs.realpath@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" @@ -4151,6 +4420,13 @@ get-proto@^1.0.0, get-proto@^1.0.1: dunder-proto "^1.0.1" es-object-atoms "^1.0.0" +get-stream@^5.1.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.2.0.tgz#4966a1795ee5ace65e706c4b7beb71257d6e22d3" + integrity sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA== + dependencies: + pump "^3.0.0" + get-symbol-description@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/get-symbol-description/-/get-symbol-description-1.0.0.tgz#7fdb81c900101fbd564dd5f1a30af5aadc1e58d6" @@ -4264,6 +4540,18 @@ glob@^7.1.3, glob@^7.1.4, glob@^7.1.6: once "^1.3.0" path-is-absolute "^1.0.0" +global-agent@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/global-agent/-/global-agent-3.0.0.tgz#ae7cd31bd3583b93c5a16437a1afe27cc33a1ab6" + integrity sha512-PT6XReJ+D07JvGoxQMkT6qji/jVNfX/h364XHZOWeRzy64sSFr+xJ5OX7LI3b4MPQzdL4H8Y8M0xzPpsVMwA8Q== + dependencies: + boolean "^3.0.1" + es6-error "^4.1.1" + matcher "^3.0.0" + roarr "^2.15.3" + semver "^7.3.2" + serialize-error "^7.0.1" + globals@^11.1.0: version "11.12.0" resolved "https://registry.yarnpkg.com/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e" @@ -4283,14 +4571,7 @@ globals@^13.19.0: dependencies: type-fest "^0.20.2" -globalthis@^1.0.3: - version "1.0.3" - resolved "https://registry.yarnpkg.com/globalthis/-/globalthis-1.0.3.tgz#5852882a52b80dc301b0660273e1ed082f0b6ccf" - integrity sha512-sFdI5LyBiNTHjRd7cGPWapiHWMOXKyuBNX/cWJ3NfzrZQVa8GI/8cofCl74AOVqq9W5kNmguTIzJ/1s2gyI9wA== - dependencies: - define-properties "^1.1.3" - -globalthis@^1.0.4: +globalthis@^1.0.1, globalthis@^1.0.4: version "1.0.4" resolved "https://registry.yarnpkg.com/globalthis/-/globalthis-1.0.4.tgz#7430ed3a975d97bfb59bcce41f5cabbafa651236" integrity sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ== @@ -4298,6 +4579,13 @@ globalthis@^1.0.4: define-properties "^1.2.1" gopd "^1.0.1" +globalthis@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/globalthis/-/globalthis-1.0.3.tgz#5852882a52b80dc301b0660273e1ed082f0b6ccf" + integrity sha512-sFdI5LyBiNTHjRd7cGPWapiHWMOXKyuBNX/cWJ3NfzrZQVa8GI/8cofCl74AOVqq9W5kNmguTIzJ/1s2gyI9wA== + dependencies: + define-properties "^1.1.3" + globby@^14.1.0: version "14.1.0" resolved "https://registry.yarnpkg.com/globby/-/globby-14.1.0.tgz#138b78e77cf5a8d794e327b15dce80bf1fb0a73e" @@ -4322,6 +4610,23 @@ gopd@^1.2.0: resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1" integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg== +got@^11.8.5: + version "11.8.6" + resolved "https://registry.yarnpkg.com/got/-/got-11.8.6.tgz#276e827ead8772eddbcfc97170590b841823233a" + integrity sha512-6tfZ91bOr7bOXnK7PRDCGBLa1H4U080YHNaAQ2KsMGlLEzRbk44nsZF2E1IeRc3vtJHPVbKCYgdFbaGO2ljd8g== + dependencies: + "@sindresorhus/is" "^4.0.0" + "@szmarczak/http-timer" "^4.0.5" + "@types/cacheable-request" "^6.0.1" + "@types/responselike" "^1.0.0" + cacheable-lookup "^5.0.3" + cacheable-request "^7.0.2" + decompress-response "^6.0.0" + http2-wrapper "^1.0.0-beta.5.2" + lowercase-keys "^2.0.0" + p-cancelable "^2.0.0" + responselike "^2.0.0" + graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.11, graceful-fs@^4.2.2, graceful-fs@^4.2.4: version "4.2.11" resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" @@ -4465,6 +4770,11 @@ htmlparser2@^8.0.1: domutils "^3.0.1" entities "^4.3.0" +http-cache-semantics@^4.0.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz#205f4db64f8562b76a4ff9235aa5279839a09dd5" + integrity sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ== + http-proxy-agent@^4.0.1: version "4.0.1" resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz#8a8c8ef7f5932ccf953c296ca8291b95aa74aa3a" @@ -4482,6 +4792,14 @@ http-proxy-agent@^7.0.0, http-proxy-agent@^7.0.1, http-proxy-agent@^7.0.2: agent-base "^7.1.0" debug "^4.3.4" +http2-wrapper@^1.0.0-beta.5.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/http2-wrapper/-/http2-wrapper-1.0.3.tgz#b8f55e0c1f25d4ebd08b3b0c2c079f9590800b3d" + integrity sha512-V+23sDMr12Wnz7iTcDeJr3O6AIxlnvT/bmaAAAP/Xda35C90p9599p0F1eHR/N1KILWSoWVAiOMFjBBXaXSMxg== + dependencies: + quick-lru "^5.1.1" + resolve-alpn "^1.0.0" + https-proxy-agent@^5.0.0: version "5.0.1" resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz#c59ef224a04fe8b754f3db0063a25ea30d0005d6" @@ -5329,6 +5647,11 @@ json-stable-stringify-without-jsonify@^1.0.1: resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651" integrity sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw== +json-stringify-safe@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb" + integrity sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA== + json5@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/json5/-/json5-1.0.2.tgz#63d98d60f21b313b77c4d6da18bfa69d80e1d593" @@ -5356,6 +5679,13 @@ jsonc-parser@^3.2.0, jsonc-parser@^3.3.1: resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.3.1.tgz#f2a524b4f7fd11e3d791e559977ad60b98b798b4" integrity sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ== +jsonfile@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb" + integrity sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg== + optionalDependencies: + graceful-fs "^4.1.6" + jsonfile@^6.0.1: version "6.1.0" resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" @@ -5416,7 +5746,7 @@ keytar@^7.7.0: node-addon-api "^4.3.0" prebuild-install "^7.0.1" -keyv@^4.5.3: +keyv@^4.0.0, keyv@^4.5.3: version "4.5.4" resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93" integrity sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw== @@ -5573,6 +5903,11 @@ loupe@^3.1.0, loupe@^3.1.4: resolved "https://registry.yarnpkg.com/loupe/-/loupe-3.2.1.tgz#0095cf56dc5b7a9a7c08ff5b1a8796ec8ad17e76" integrity sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ== +lowercase-keys@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-2.0.0.tgz#2603e78b7b4b0006cbca2fbcc8a3202558ac9479" + integrity sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA== + lru-cache@^10.0.1: version "10.4.3" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119" @@ -5666,6 +6001,13 @@ markdown-table@^1.1.0: resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-1.1.3.tgz#9fcb69bcfdb8717bfd0398c6ec2d93036ef8de60" integrity sha512-1RUZVgQlpJSPWYbFSpmudq5nHY1doEIv89gBtF0s4gW1GF2XorxcA/70M5vq7rLv0a6mhOUccRsqkwhwLCIQ2Q== +matcher@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/matcher/-/matcher-3.0.0.tgz#bd9060f4c5b70aa8041ccc6f80368760994f30ca" + integrity sha512-OkeDaAZ/bQCxeFAozM55PKcKU0yJMPGifLwV4Qgjitu+5MoAfSQN4lsLJeXZ1b8w0x+/Emda6MZgXS1jvsapng== + dependencies: + escape-string-regexp "^4.0.0" + math-intrinsics@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" @@ -5755,6 +6097,11 @@ mimic-function@^5.0.0: resolved "https://registry.yarnpkg.com/mimic-function/-/mimic-function-5.0.1.tgz#acbe2b3349f99b9deaca7fb70e48b83e94e67076" integrity sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA== +mimic-response@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-1.0.1.tgz#4923538878eef42063cb8a3e3b0798781487ab1b" + integrity sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ== + mimic-response@^3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-3.1.0.tgz#2d1d59af9c1b129815accc2c46a022a5ce1fa3c9" @@ -5887,11 +6234,6 @@ node-addon-api@^4.3.0: resolved "https://registry.yarnpkg.com/node-addon-api/-/node-addon-api-4.3.0.tgz#52a1a0b475193e0928e98e0426a0d1254782b77f" integrity sha512-73sE9+3UaLYYFmDsFZnqCInzPyh3MqIwZO9cw58yIqAZhONrrabrYyYe3TuIqtIiOuTXVhsGau8hcrhhwSsDIQ== -node-forge@^1.3.1: - version "1.3.1" - resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.1.tgz#be8da2af243b2417d5f646a770663a92b7e9ded3" - integrity sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA== - node-gyp-build@^4.3.0: version "4.6.0" resolved "https://registry.yarnpkg.com/node-gyp-build/-/node-gyp-build-4.6.0.tgz#0c52e4cbf54bbd28b709820ef7b6a3c2d6209055" @@ -5931,6 +6273,11 @@ normalize-path@^3.0.0, normalize-path@~3.0.0: resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== +normalize-url@^6.0.1: + version "6.1.0" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-6.1.0.tgz#40d0885b535deffe3f3147bec877d05fe4c5668a" + integrity sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A== + nth-check@^2.0.1: version "2.1.1" resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.1.1.tgz#c9eab428effce36cd6b92c924bdb000ef1f1ed1d" @@ -6141,6 +6488,11 @@ own-keys@^1.0.1: object-keys "^1.1.1" safe-push-apply "^1.0.0" +p-cancelable@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-2.1.1.tgz#aab7fbd416582fa32a3db49859c122487c5ed2cf" + integrity sha512-BZOr3nRQHOntUjTrH8+Lh54smKHoHyur8We1V8DSMVrl5A2malOOwuJRnKRDjSnkoeBh4at6BwEnb5I7Jl31wg== + p-limit@^2.2.0: version "2.3.0" resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" @@ -6468,7 +6820,7 @@ process-on-spawn@^1.0.0: dependencies: fromentries "^1.2.0" -progress@^2.0.0: +progress@^2.0.0, progress@^2.0.3: version "2.0.3" resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== @@ -6510,6 +6862,18 @@ punycode@^2.1.0: resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.0.tgz#f67fa67c94da8f4d0cfff981aee4118064199b8f" integrity sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA== +pvtsutils@^1.3.6: + version "1.3.6" + resolved "https://registry.yarnpkg.com/pvtsutils/-/pvtsutils-1.3.6.tgz#ec46e34db7422b9e4fdc5490578c1883657d6001" + integrity sha512-PLgQXQ6H2FWCaeRak8vvk1GW462lMxB5s3Jm673N82zI4vqtVUPuZdffdZbPDFRoU8kAhItWFtPCWiPpp4/EDg== + dependencies: + tslib "^2.8.1" + +pvutils@^1.1.3: + version "1.1.5" + resolved "https://registry.yarnpkg.com/pvutils/-/pvutils-1.1.5.tgz#84b0dea4a5d670249aa9800511804ee0b7c2809c" + integrity sha512-KTqnxsgGiQ6ZAzZCVlJH5eOjSnvlyEgx1m8bkRJfOhmGRqfo5KLvmAlACQkrjEtOQ4B7wF9TdSLIs9O90MX9xA== + qs@^6.9.1: version "6.11.0" resolved "https://registry.yarnpkg.com/qs/-/qs-6.11.0.tgz#fd0d963446f7a65e1367e01abd85429453f0c37a" @@ -6522,6 +6886,11 @@ queue-microtask@^1.2.2: resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== +quick-lru@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-5.1.1.tgz#366493e6b3e42a3a6885e2e99d18f80fb7a8c932" + integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== + randombytes@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a" @@ -6608,6 +6977,11 @@ rechoir@^0.8.0: dependencies: resolve "^1.20.0" +reflect-metadata@^0.2.2: + version "0.2.2" + resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.2.2.tgz#400c845b6cba87a21f2c65c4aeb158f4fa4d9c5b" + integrity sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q== + reflect.getprototypeof@^1.0.6, reflect.getprototypeof@^1.0.9: version "1.0.10" resolved "https://registry.yarnpkg.com/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz#c629219e78a3316d8b604c765ef68996964e7bf9" @@ -7244,6 +7618,11 @@ requireindex@~1.1.0: resolved "https://registry.yarnpkg.com/requireindex/-/requireindex-1.1.0.tgz#e5404b81557ef75db6e49c5a72004893fe03e162" integrity sha512-LBnkqsDE7BZKvqylbmn7lTIVdpx4K/QCduRATpO5R+wtPmky/a8pN1bO2D6wXppn1497AJF9mNjqAXr6bdl9jg== +resolve-alpn@^1.0.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/resolve-alpn/-/resolve-alpn-1.2.1.tgz#b7adbdac3546aaaec20b45e7d8265927072726f9" + integrity sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g== + resolve-cwd@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d" @@ -7284,6 +7663,13 @@ resolve@^1.22.4: path-parse "^1.0.7" supports-preserve-symlinks-flag "^1.0.0" +responselike@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/responselike/-/responselike-2.0.1.tgz#9a0bc8fdc252f3fb1cca68b016591059ba1422bc" + integrity sha512-4gl03wn3hj1HP3yzgdI7d3lCkF95F21Pz4BPGvKHinyQzALR5CapwC8yIi0Rh58DEMQ/SguC03wFj2k0M/mHhw== + dependencies: + lowercase-keys "^2.0.0" + restore-cursor@^3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-3.1.0.tgz#39f67c54b3a7a58cea5236d95cf0034239631f7e" @@ -7326,6 +7712,18 @@ rimraf@^3.0.0, rimraf@^3.0.2: dependencies: glob "^7.1.3" +roarr@^2.15.3: + version "2.15.4" + resolved "https://registry.yarnpkg.com/roarr/-/roarr-2.15.4.tgz#f5fe795b7b838ccfe35dc608e0282b9eba2e7afd" + integrity sha512-CHhPh+UNHD2GTXNYhPWLnU8ONHdI+5DI+4EYIAOaiD63rHeYlZvyh8P+in5999TTSFgUYuKUAjzRI4mdh/p+2A== + dependencies: + boolean "^3.0.1" + detect-node "^2.0.4" + globalthis "^1.0.1" + json-stringify-safe "^5.0.1" + semver-compare "^1.0.0" + sprintf-js "^1.1.2" + rollup@^4.43.0: version "4.50.2" resolved "https://registry.yarnpkg.com/rollup/-/rollup-4.50.2.tgz#938d898394939f3386d1e367ee6410a796b8f268" @@ -7489,11 +7887,23 @@ secretlint@^10.1.2: globby "^14.1.0" read-pkg "^9.0.1" -semver@7.7.3, semver@^5.1.0, semver@^5.5.0, semver@^6.0.0, semver@^6.1.2, semver@^6.3.1, semver@^7.3.4, semver@^7.3.5, semver@^7.5.2, semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.6.2, semver@^7.7.1, semver@^7.7.2, semver@^7.7.3: +semver-compare@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/semver-compare/-/semver-compare-1.0.0.tgz#0dee216a1c941ab37e9efb1788f6afc5ff5537fc" + integrity sha512-YM3/ITh2MJ5MtzaM429anh+x2jiLVjqILF4m4oyQB18W7Ggea7BfqdH/wGMK7dDiMghv/6WG7znWMwUDzJiXow== + +semver@7.7.3, semver@^5.1.0, semver@^5.5.0, semver@^6.0.0, semver@^6.1.2, semver@^6.2.0, semver@^6.3.1, semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.5.2, semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.6.2, semver@^7.7.1, semver@^7.7.2, semver@^7.7.3: version "7.7.3" resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== +serialize-error@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/serialize-error/-/serialize-error-7.0.1.tgz#f1360b0447f61ffb483ec4157c737fab7d778e18" + integrity sha512-8I8TjW5KMOKsZQTvoxjuSIa7foAwPWGOts+6o7sgjz41/qMD9VQHEDxi6PBvK2l0MXUmqZyNpUK+T2tQaaElvw== + dependencies: + type-fest "^0.13.1" + serialize-javascript@^6.0.2: version "6.0.2" resolved "https://registry.yarnpkg.com/serialize-javascript/-/serialize-javascript-6.0.2.tgz#defa1e055c83bf6d59ea805d8da862254eb6a6c2" @@ -7805,7 +8215,7 @@ spdx-license-ids@^3.0.0: resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.21.tgz#6d6e980c9df2b6fc905343a3b2d702a6239536c3" integrity sha512-Bvg/8F5XephndSK3JffaRqdT+gyhfqIPwDHpX80tJrF8QQRYMo8sNMeaZ2Dp5+jhwKnUmIOyFFQfHRkjJm5nXg== -sprintf-js@^1.1.3: +sprintf-js@^1.1.2, sprintf-js@^1.1.3: version "1.1.3" resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.1.3.tgz#4914b903a2f8b685d17fdf78a70e917e872e444a" integrity sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA== @@ -8049,6 +8459,13 @@ structured-source@^4.0.0: dependencies: boundary "^2.0.0" +sumchecker@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/sumchecker/-/sumchecker-3.0.1.tgz#6377e996795abb0b6d348e9b3e1dfb24345a8e42" + integrity sha512-MvjXzkz/BOfyVDkG0oFOtBxHX2u3gKbMHIF/dXblZsgD3BWOFLmHovIpZY7BykJdAjcqRCBi1WYBNdEC9yI7vg== + dependencies: + debug "^4.1.0" + supports-color@^10.2.2: version "10.2.2" resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-10.2.2.tgz#466c2978cc5cd0052d542a0b576461c2b802ebb4" @@ -8322,16 +8739,23 @@ tsconfig-paths@^3.15.0: minimist "^1.2.6" strip-bom "^3.0.0" -tslib@^1.9.0: +tslib@^1.9.0, tslib@^1.9.3: version "1.14.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== -tslib@^2.0.0, tslib@^2.0.1, tslib@^2.2.0, tslib@^2.4.0, tslib@^2.6.2: +tslib@^2.0.0, tslib@^2.0.1, tslib@^2.2.0, tslib@^2.4.0, tslib@^2.6.2, tslib@^2.8.1: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== +tsyringe@^4.10.0: + version "4.10.0" + resolved "https://registry.yarnpkg.com/tsyringe/-/tsyringe-4.10.0.tgz#d0c95815d584464214060285eaaadd94aa03299c" + integrity sha512-axr3IdNuVIxnaK5XGEUFTu3YmAQ6lllgrvqfEoR16g/HGnYY/6We4oWENtAnzK6/LpJ2ur9PAb80RBt7/U4ugw== + dependencies: + tslib "^1.9.3" + tunnel-agent@^0.6.0: version "0.6.0" resolved "https://registry.yarnpkg.com/tunnel-agent/-/tunnel-agent-0.6.0.tgz#27a5dea06b36b04a0a9966774b290868f0fc40fd" @@ -8358,6 +8782,11 @@ type-check@~0.3.2: dependencies: prelude-ls "~1.1.2" +type-fest@^0.13.1: + version "0.13.1" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.13.1.tgz#0172cb5bce80b0bd542ea348db50c7e21834d934" + integrity sha512-34R7HTnG0XIJcBSn5XhDd7nNFPRcXYRZrBB2O2jdKqYODldSzBAqzsWoZYYvduky73toYS/ESqxPvkDf/F0XMg== + type-fest@^0.20.2: version "0.20.2" resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4" @@ -8655,6 +9084,11 @@ unist-util-visit@^1.0.0, unist-util-visit@^1.1.0, unist-util-visit@^1.1.1, unist dependencies: unist-util-visit-parents "^2.0.0" +universalify@^0.1.0: + version "0.1.2" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66" + integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg== + universalify@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.0.tgz#75a4984efedc4b08975c5aeb73f530d02df25717" @@ -9265,7 +9699,7 @@ yargs@~18.0.0: y18n "^5.0.5" yargs-parser "^22.0.0" -yauzl@^2.3.1: +yauzl@^2.10.0, yauzl@^2.3.1: version "2.10.0" resolved "https://registry.yarnpkg.com/yauzl/-/yauzl-2.10.0.tgz#c7eb17c93e112cb1086fa6d8e51fb0667b79a5f9" integrity sha512-p4a9I6X6nu6IhoGmBqAcbJy1mlC4j27vEPZX9F4L4/vZT3Lyq1VkFHw/V/PUcB9Buo+DG3iHkT0x3Qya58zc3g== From c4204bad31c07ce30fda58f79a2c4ea259ced541 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Thu, 20 Nov 2025 18:17:22 +0300 Subject: [PATCH 28/55] Add support to Google Antigravity (#658) --- CHANGELOG.md | 4 ++++ src/extension.ts | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fa31dd73..7a381cf8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Fixed + +- Add support for `google.antigravity-remote-openssh` Remote SSH extension. + ### Changed - Improved workspace connection progress messages and enhanced the workspace build terminal diff --git a/src/extension.ts b/src/extension.ts index cbb9e62e..9751b0f7 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -37,7 +37,8 @@ export async function activate(ctx: vscode.ExtensionContext): Promise { vscode.extensions.getExtension("jeanp413.open-remote-ssh") || vscode.extensions.getExtension("codeium.windsurf-remote-openssh") || vscode.extensions.getExtension("anysphere.remote-ssh") || - vscode.extensions.getExtension("ms-vscode-remote.remote-ssh"); + vscode.extensions.getExtension("ms-vscode-remote.remote-ssh") || + vscode.extensions.getExtension("google.antigravity-remote-openssh"); let vscodeProposed: typeof vscode = vscode; From 118d50ab4a2ad9f3490a05cc17163838ab3de134 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Thu, 20 Nov 2025 18:28:46 +0300 Subject: [PATCH 29/55] v1.11.4 (#659) --- CHANGELOG.md | 2 ++ package.json | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a381cf8..35872866 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +## [v1.11.4](https://github.com/coder/vscode-coder/releases/tag/v1.11.4) 2025-11-20 + ### Fixed - Add support for `google.antigravity-remote-openssh` Remote SSH extension. diff --git a/package.json b/package.json index 44865e25..78d39819 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "coder-remote", "displayName": "Coder", - "version": "1.11.3", + "version": "1.11.4", "description": "Open any workspace with a single click.", "categories": [ "Other" From 9ef38a3cee1c07a4740f41ccaa79dac6224cd6e9 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 25 Nov 2025 12:34:02 +0300 Subject: [PATCH 30/55] Fix race condition in concurrent CLI binary downloads (#656) Implement file-based locking to prevent multiple VS Code windows from downloading the Coder CLI binary simultaneously. When one window is downloading, other windows now wait and display real-time progress from the active download. This prevents file corruption and download failures that could occur when opening multiple VS Code windows simultaneously. Closes #575 --- CHANGELOG.md | 6 + package.json | 2 + src/core/binaryLock.ts | 126 +++++ src/core/cliManager.ts | 462 ++++++++++++++----- src/core/cliUtils.ts | 73 ++- src/core/downloadProgress.ts | 44 ++ test/mocks/testHelpers.ts | 54 ++- test/unit/core/binaryLock.test.ts | 160 +++++++ test/unit/core/cliManager.concurrent.test.ts | 191 ++++++++ test/unit/core/cliManager.test.ts | 112 ++--- test/unit/core/downloadProgress.test.ts | 102 ++++ yarn.lock | 26 ++ 12 files changed, 1154 insertions(+), 204 deletions(-) create mode 100644 src/core/binaryLock.ts create mode 100644 src/core/downloadProgress.ts create mode 100644 test/unit/core/binaryLock.test.ts create mode 100644 test/unit/core/cliManager.concurrent.test.ts create mode 100644 test/unit/core/downloadProgress.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 35872866..760d3b64 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Unreleased +### Fixed + +- Fixed race condition when multiple VS Code windows download the Coder CLI binary simultaneously. + Other windows now wait and display real-time progress instead of attempting concurrent downloads, + preventing corruption and failures. + ## [v1.11.4](https://github.com/coder/vscode-coder/releases/tag/v1.11.4) 2025-11-20 ### Fixed diff --git a/package.json b/package.json index 78d39819..e1946da1 100644 --- a/package.json +++ b/package.json @@ -351,6 +351,7 @@ "jsonc-parser": "^3.3.1", "openpgp": "^6.2.2", "pretty-bytes": "^7.1.0", + "proper-lockfile": "^4.1.2", "proxy-agent": "^6.5.0", "semver": "^7.7.3", "ua-parser-js": "1.0.40", @@ -361,6 +362,7 @@ "@types/eventsource": "^3.0.0", "@types/glob": "^7.1.3", "@types/node": "^22.14.1", + "@types/proper-lockfile": "^4.1.4", "@types/semver": "^7.7.1", "@types/ua-parser-js": "0.7.36", "@types/vscode": "^1.73.0", diff --git a/src/core/binaryLock.ts b/src/core/binaryLock.ts new file mode 100644 index 00000000..6e334453 --- /dev/null +++ b/src/core/binaryLock.ts @@ -0,0 +1,126 @@ +import prettyBytes from "pretty-bytes"; +import * as lockfile from "proper-lockfile"; +import * as vscode from "vscode"; + +import { type Logger } from "../logging/logger"; + +import * as downloadProgress from "./downloadProgress"; + +/** + * Timeout to detect stale lock files and take over from stuck processes. + * This value is intentionally small so we can quickly takeover. + */ +const STALE_TIMEOUT_MS = 15000; + +const LOCK_POLL_INTERVAL_MS = 500; + +type LockRelease = () => Promise; + +/** + * Manages file locking for binary downloads to coordinate between multiple + * VS Code windows downloading the same binary. + */ +export class BinaryLock { + constructor( + private readonly vscodeProposed: typeof vscode, + private readonly output: Logger, + ) {} + + /** + * Acquire the lock, or wait for another process if the lock is held. + * Returns the lock release function and a flag indicating if we waited. + */ + async acquireLockOrWait( + binPath: string, + progressLogPath: string, + ): Promise<{ release: LockRelease; waited: boolean }> { + const release = await this.safeAcquireLock(binPath); + if (release) { + return { release, waited: false }; + } + + this.output.info( + "Another process is downloading the binary, monitoring progress", + ); + const newRelease = await this.monitorDownloadProgress( + binPath, + progressLogPath, + ); + return { release: newRelease, waited: true }; + } + + /** + * Attempt to acquire a lock on the binary file. + * Returns the release function if successful, null if lock is already held. + */ + private async safeAcquireLock(path: string): Promise { + try { + const release = await lockfile.lock(path, { + stale: STALE_TIMEOUT_MS, + retries: 0, + realpath: false, + }); + return release; + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ELOCKED") { + throw error; + } + return null; + } + } + + /** + * Monitor download progress from another process by polling the progress log + * and attempting to acquire the lock. Shows a VS Code progress notification. + * Returns the lock release function once the download completes. + */ + private async monitorDownloadProgress( + binPath: string, + progressLogPath: string, + ): Promise { + return await this.vscodeProposed.window.withProgress( + { + location: vscode.ProgressLocation.Notification, + title: "Another window is downloading the Coder CLI binary", + cancellable: false, + }, + async (progress) => { + return new Promise((resolve, reject) => { + const poll = async () => { + try { + await this.updateProgressMonitor(progressLogPath, progress); + const release = await this.safeAcquireLock(binPath); + if (release) { + return resolve(release); + } + // Schedule next poll only after current one completes + setTimeout(poll, LOCK_POLL_INTERVAL_MS); + } catch (error) { + reject(error); + } + }; + poll().catch((error) => reject(error)); + }); + }, + ); + } + + private async updateProgressMonitor( + progressLogPath: string, + progress: vscode.Progress<{ message?: string }>, + ): Promise { + const currentProgress = + await downloadProgress.readProgress(progressLogPath); + if (currentProgress) { + const totalBytesPretty = + currentProgress.totalBytes === null + ? "unknown" + : prettyBytes(currentProgress.totalBytes); + const message = + currentProgress.status === "verifying" + ? "Verifying signature..." + : `${prettyBytes(currentProgress.bytesDownloaded)} / ${totalBytesPretty}`; + progress.report({ message }); + } + } +} diff --git a/src/core/cliManager.ts b/src/core/cliManager.ts index 4e8833fe..5e0b3d26 100644 --- a/src/core/cliManager.ts +++ b/src/core/cliManager.ts @@ -3,10 +3,10 @@ import globalAxios, { type AxiosRequestConfig, } from "axios"; import { type Api } from "coder/site/src/api/api"; -import { createWriteStream, type WriteStream } from "fs"; -import fs from "fs/promises"; -import { type IncomingMessage } from "http"; -import path from "path"; +import { createWriteStream, type WriteStream } from "node:fs"; +import fs from "node:fs/promises"; +import { type IncomingMessage } from "node:http"; +import path from "node:path"; import prettyBytes from "pretty-bytes"; import * as semver from "semver"; import * as vscode from "vscode"; @@ -15,15 +15,21 @@ import { errToStr } from "../api/api-helper"; import { type Logger } from "../logging/logger"; import * as pgp from "../pgp"; +import { BinaryLock } from "./binaryLock"; import * as cliUtils from "./cliUtils"; +import * as downloadProgress from "./downloadProgress"; import { type PathResolver } from "./pathResolver"; export class CliManager { + private readonly binaryLock: BinaryLock; + constructor( private readonly vscodeProposed: typeof vscode, private readonly output: Logger, private readonly pathResolver: PathResolver, - ) {} + ) { + this.binaryLock = new BinaryLock(vscodeProposed, output); + } /** * Download and return the path to a working binary for the deployment with @@ -97,143 +103,342 @@ export class CliManager { throw new Error("Unable to download CLI because downloads are disabled"); } - // Remove any left-over old or temporary binaries and signatures. - const removed = await cliUtils.rmOld(binPath); - removed.forEach(({ fileName, error }) => { - if (error) { - this.output.warn("Failed to remove", fileName, error); - } else { - this.output.info("Removed", fileName); - } - }); - - // Figure out where to get the binary. - const binName = cliUtils.name(); - const configSource = cfg.get("binarySource"); - const binSource = - configSource && String(configSource).trim().length > 0 - ? String(configSource) - : "/bin/" + binName; - this.output.info("Downloading binary from", binSource); - - // Ideally we already caught that this was the right version and returned - // early, but just in case set the ETag. - const etag = stat !== undefined ? await cliUtils.eTag(binPath) : ""; - this.output.info("Using ETag", etag); - - // Download the binary to a temporary file. + // Create the `bin` folder if it doesn't exist await fs.mkdir(path.dirname(binPath), { recursive: true }); - const tempFile = - binPath + ".temp-" + Math.random().toString(36).substring(8); - const writeStream = createWriteStream(tempFile, { - autoClose: true, - mode: 0o755, - }); - const client = restClient.getAxiosInstance(); - const status = await this.download(client, binSource, writeStream, { - "Accept-Encoding": "gzip", - "If-None-Match": `"${etag}"`, - }); + const progressLogPath = binPath + ".progress.log"; + + let lockResult: + | { release: () => Promise; waited: boolean } + | undefined; + let latestVersion = parsedVersion; + try { + lockResult = await this.binaryLock.acquireLockOrWait( + binPath, + progressLogPath, + ); + this.output.info("Acquired download lock"); - switch (status) { - case 200: { - if (cfg.get("disableSignatureVerification")) { + // If we waited for another process, re-check if binary is now ready + if (lockResult.waited) { + const latestBuildInfo = await restClient.getBuildInfo(); + this.output.info("Got latest server version", latestBuildInfo.version); + + const recheckAfterWait = await this.checkBinaryVersion( + binPath, + latestBuildInfo.version, + ); + if (recheckAfterWait.matches) { this.output.info( - "Skipping binary signature verification due to settings", + "Using existing binary since it matches the latest server version", ); - } else { - await this.verifyBinarySignatures(client, tempFile, [ - // A signature placed at the same level as the binary. It must be - // named exactly the same with an appended `.asc` (such as - // coder-windows-amd64.exe.asc or coder-linux-amd64.asc). - binSource + ".asc", - // The releases.coder.com bucket does not include the leading "v", - // and unlike what we get from buildinfo it uses a truncated version - // with only major.minor.patch. The signature name follows the same - // rule as above. - `https://releases.coder.com/coder-cli/${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}/${binName}.asc`, - ]); + return binPath; } - // Move the old binary to a backup location first, just in case. And, - // on Linux at least, you cannot write onto a binary that is in use so - // moving first works around that (delete would also work). - if (stat !== undefined) { - const oldBinPath = - binPath + ".old-" + Math.random().toString(36).substring(8); - this.output.info( - "Moving existing binary to", - path.basename(oldBinPath), + // Parse the latest version for download + const latestParsedVersion = semver.parse(latestBuildInfo.version); + if (!latestParsedVersion) { + throw new Error( + `Got invalid version from deployment: ${latestBuildInfo.version}`, ); - await fs.rename(binPath, oldBinPath); } + latestVersion = latestParsedVersion; + } - // Then move the temporary binary into the right place. - this.output.info("Moving downloaded file to", path.basename(binPath)); - await fs.mkdir(path.dirname(binPath), { recursive: true }); - await fs.rename(tempFile, binPath); + return await this.performBinaryDownload( + restClient, + latestVersion, + binPath, + progressLogPath, + ); + } catch (error) { + // Unified error handling - check for fallback binaries and prompt user + return await this.handleAnyBinaryFailure( + error, + binPath, + buildInfo.version, + ); + } finally { + if (lockResult) { + await lockResult.release(); + this.output.info("Released download lock"); + } + } + } - // For debugging, to see if the binary only partially downloaded. - const newStat = await cliUtils.stat(binPath); + /** + * Check if a binary exists and matches the expected version. + */ + private async checkBinaryVersion( + binPath: string, + expectedVersion: string, + ): Promise<{ version: string | null; matches: boolean }> { + const stat = await cliUtils.stat(binPath); + if (!stat) { + return { version: null, matches: false }; + } + + try { + const version = await cliUtils.version(binPath); + return { + version, + matches: version === expectedVersion, + }; + } catch (error) { + this.output.warn(`Unable to get version of binary: ${errToStr(error)}`); + return { version: null, matches: false }; + } + } + + /** + * Prompt the user to use an existing binary version. + */ + private async promptUseExistingBinary( + version: string, + reason: string, + ): Promise { + const choice = await this.vscodeProposed.window.showErrorMessage( + `${reason}. Run version ${version} anyway?`, + "Run", + ); + return choice === "Run"; + } + + /** + * Replace the existing binary with the downloaded temp file. + * Throws WindowsFileLockError if binary is in use. + */ + private async replaceExistingBinary( + binPath: string, + tempFile: string, + ): Promise { + const oldBinPath = + binPath + ".old-" + Math.random().toString(36).substring(8); + + try { + // Step 1: Move existing binary to backup (if it exists) + const stat = await cliUtils.stat(binPath); + if (stat) { this.output.info( - "Downloaded binary size is", - prettyBytes(newStat?.size || 0), + "Moving existing binary to", + path.basename(oldBinPath), ); + await fs.rename(binPath, oldBinPath); + } - // Make sure we can execute this new binary. - const version = await cliUtils.version(binPath); - this.output.info("Downloaded binary version is", version); + // Step 2: Move temp to final location + this.output.info("Moving downloaded file to", path.basename(binPath)); + await fs.rename(tempFile, binPath); + } catch (error) { + throw cliUtils.maybeWrapFileLockError(error, binPath); + } + + // For debugging, to see if the binary only partially downloaded. + const newStat = await cliUtils.stat(binPath); + this.output.info( + "Downloaded binary size is", + prettyBytes(newStat?.size || 0), + ); + + // Make sure we can execute this new binary. + const version = await cliUtils.version(binPath); + this.output.info("Downloaded binary version is", version); + } + /** + * Unified handler for any binary-related failure. + * Checks for existing or old binaries and prompts user once. + */ + private async handleAnyBinaryFailure( + error: unknown, + binPath: string, + expectedVersion: string, + ): Promise { + const message = + error instanceof cliUtils.FileLockError + ? "Unable to update the Coder CLI binary because it's in use" + : "Failed to update CLI binary"; + + // Try existing binary first + const existingCheck = await this.checkBinaryVersion( + binPath, + expectedVersion, + ); + if (existingCheck.version) { + // Perfect match - use without prompting + if (existingCheck.matches) { return binPath; } - case 304: { - this.output.info("Using existing binary since server returned a 304"); + // Version mismatch - prompt user + if (await this.promptUseExistingBinary(existingCheck.version, message)) { return binPath; } - case 404: { - vscode.window - .showErrorMessage( - "Coder isn't supported for your platform. Please open an issue, we'd love to support it!", - "Open an Issue", - ) - .then((value) => { - if (!value) { - return; - } - const os = cliUtils.goos(); - const arch = cliUtils.goarch(); - const params = new URLSearchParams({ - title: `Support the \`${os}-${arch}\` platform`, - body: `I'd like to use the \`${os}-${arch}\` architecture with the VS Code extension.`, - }); - const uri = vscode.Uri.parse( - `https://github.com/coder/vscode-coder/issues/new?${params.toString()}`, - ); - vscode.env.openExternal(uri); - }); - throw new Error("Platform not supported"); + throw error; + } + + // Try .old-* binaries as fallback + const oldBinaries = await cliUtils.findOldBinaries(binPath); + if (oldBinaries.length > 0) { + const oldCheck = await this.checkBinaryVersion( + oldBinaries[0], + expectedVersion, + ); + if ( + oldCheck.version && + (oldCheck.matches || + (await this.promptUseExistingBinary(oldCheck.version, message))) + ) { + await fs.rename(oldBinaries[0], binPath); + return binPath; } - default: { - vscode.window - .showErrorMessage( - "Failed to download binary. Please open an issue.", - "Open an Issue", - ) - .then((value) => { - if (!value) { - return; - } - const params = new URLSearchParams({ - title: `Failed to download binary on \`${cliUtils.goos()}-${cliUtils.goarch()}\``, - body: `Received status code \`${status}\` when downloading the binary.`, - }); - const uri = vscode.Uri.parse( - `https://github.com/coder/vscode-coder/issues/new?${params.toString()}`, - ); - vscode.env.openExternal(uri); + } + + // No fallback available or user declined - re-throw original error + throw error; + } + + private async performBinaryDownload( + restClient: Api, + parsedVersion: semver.SemVer, + binPath: string, + progressLogPath: string, + ): Promise { + const cfg = vscode.workspace.getConfiguration("coder"); + const tempFile = + binPath + ".temp-" + Math.random().toString(36).substring(8); + + try { + const removed = await cliUtils.rmOld(binPath); + for (const { fileName, error } of removed) { + if (error) { + this.output.warn("Failed to remove", fileName, error); + } else { + this.output.info("Removed", fileName); + } + } + + // Figure out where to get the binary. + const binName = cliUtils.name(); + const configSource = cfg.get("binarySource"); + const binSource = configSource?.trim() ? configSource : "/bin/" + binName; + this.output.info("Downloading binary from", binSource); + + // Ideally we already caught that this was the right version and returned + // early, but just in case set the ETag. + const stat = await cliUtils.stat(binPath); + const etag = stat ? await cliUtils.eTag(binPath) : ""; + this.output.info("Using ETag", etag || ""); + + // Download the binary to a temporary file. + const writeStream = createWriteStream(tempFile, { + autoClose: true, + mode: 0o755, + }); + + const onProgress = async ( + bytesDownloaded: number, + totalBytes: number | null, + ) => { + await downloadProgress.writeProgress(progressLogPath, { + bytesDownloaded, + totalBytes, + status: "downloading", + }); + }; + + const client = restClient.getAxiosInstance(); + const status = await this.download( + client, + binSource, + writeStream, + { + "Accept-Encoding": "gzip", + "If-None-Match": `"${etag}"`, + }, + onProgress, + ); + + switch (status) { + case 200: { + await downloadProgress.writeProgress(progressLogPath, { + bytesDownloaded: 0, + totalBytes: null, + status: "verifying", }); - throw new Error("Failed to download binary"); + + if (cfg.get("disableSignatureVerification")) { + this.output.info( + "Skipping binary signature verification due to settings", + ); + } else { + await this.verifyBinarySignatures(client, tempFile, [ + // A signature placed at the same level as the binary. It must be + // named exactly the same with an appended `.asc` (such as + // coder-windows-amd64.exe.asc or coder-linux-amd64.asc). + binSource + ".asc", + // The releases.coder.com bucket does not include the leading "v", + // and unlike what we get from buildinfo it uses a truncated version + // with only major.minor.patch. The signature name follows the same + // rule as above. + `https://releases.coder.com/coder-cli/${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}/${binName}.asc`, + ]); + } + + // Replace existing binary (handles both renames + Windows lock) + await this.replaceExistingBinary(binPath, tempFile); + + return binPath; + } + case 304: { + this.output.info("Using existing binary since server returned a 304"); + return binPath; + } + case 404: { + vscode.window + .showErrorMessage( + "Coder isn't supported for your platform. Please open an issue, we'd love to support it!", + "Open an Issue", + ) + .then((value) => { + if (!value) { + return; + } + const os = cliUtils.goos(); + const arch = cliUtils.goarch(); + const params = new URLSearchParams({ + title: `Support the \`${os}-${arch}\` platform`, + body: `I'd like to use the \`${os}-${arch}\` architecture with the VS Code extension.`, + }); + const uri = vscode.Uri.parse( + `https://github.com/coder/vscode-coder/issues/new?${params.toString()}`, + ); + vscode.env.openExternal(uri); + }); + throw new Error("Platform not supported"); + } + default: { + vscode.window + .showErrorMessage( + "Failed to download binary. Please open an issue.", + "Open an Issue", + ) + .then((value) => { + if (!value) { + return; + } + const params = new URLSearchParams({ + title: `Failed to download binary on \`${cliUtils.goos()}-${cliUtils.goarch()}\``, + body: `Received status code \`${status}\` when downloading the binary.`, + }); + const uri = vscode.Uri.parse( + `https://github.com/coder/vscode-coder/issues/new?${params.toString()}`, + ); + vscode.env.openExternal(uri); + }); + throw new Error("Failed to download binary"); + } } + } finally { + await downloadProgress.clearProgress(progressLogPath); } } @@ -246,6 +451,10 @@ export class CliManager { source: string, writeStream: WriteStream, headers?: AxiosRequestConfig["headers"], + onProgress?: ( + bytesDownloaded: number, + totalBytes: number | null, + ) => Promise, ): Promise { const baseUrl = client.defaults.baseURL; @@ -306,6 +515,17 @@ export class CliManager { ? undefined : (buffer.byteLength / contentLength) * 100, }); + if (onProgress) { + onProgress( + written, + Number.isNaN(contentLength) ? null : contentLength, + ).catch((error) => { + this.output.warn( + "Failed to write progress log:", + errToStr(error), + ); + }); + } }); }); diff --git a/src/core/cliUtils.ts b/src/core/cliUtils.ts index cc92a345..2297cf77 100644 --- a/src/core/cliUtils.ts +++ b/src/core/cliUtils.ts @@ -1,10 +1,20 @@ -import { execFile, type ExecFileException } from "child_process"; -import * as crypto from "crypto"; -import { createReadStream, type Stats } from "fs"; -import fs from "fs/promises"; -import os from "os"; -import path from "path"; -import { promisify } from "util"; +import { execFile, type ExecFileException } from "node:child_process"; +import * as crypto from "node:crypto"; +import { createReadStream, type Stats } from "node:fs"; +import fs from "node:fs/promises"; +import os from "node:os"; +import path from "node:path"; +import { promisify } from "node:util"; + +/** + * Custom error thrown when a binary file is locked (typically on Windows). + */ +export class FileLockError extends Error { + constructor(binPath: string) { + super(`Binary is in use: ${binPath}`); + this.name = "WindowsFileLockError"; + } +} /** * Stat the path or undefined if the path does not exist. Throw if unable to @@ -77,7 +87,8 @@ export async function rmOld(binPath: string): Promise { if ( fileName.includes(".old-") || fileName.includes(".temp-") || - fileName.endsWith(".asc") + fileName.endsWith(".asc") || + fileName.endsWith(".progress.log") ) { try { await fs.rm(path.join(binDir, file), { force: true }); @@ -97,6 +108,52 @@ export async function rmOld(binPath: string): Promise { } } +/** + * Find all .old-* binaries in the same directory as the given binary path. + * Returns paths sorted by modification time (most recent first). + */ +export async function findOldBinaries(binPath: string): Promise { + const binDir = path.dirname(binPath); + const binName = path.basename(binPath); + try { + const files = await fs.readdir(binDir); + const oldBinaries = files + .filter((f) => f.startsWith(binName) && f.includes(".old-")) + .map((f) => path.join(binDir, f)); + + // Sort by modification time, most recent first + const stats = await Promise.allSettled( + oldBinaries.map(async (f) => ({ + path: f, + mtime: (await fs.stat(f)).mtime, + })), + ).then((result) => + result + .filter((promise) => promise.status === "fulfilled") + .map((promise) => promise.value), + ); + stats.sort((a, b) => b.mtime.getTime() - a.mtime.getTime()); + return stats.map((s) => s.path); + } catch (error) { + // If directory doesn't exist, return empty array + if ((error as NodeJS.ErrnoException)?.code === "ENOENT") { + return []; + } + throw error; + } +} + +export function maybeWrapFileLockError( + error: unknown, + binPath: string, +): unknown { + const code = (error as NodeJS.ErrnoException).code; + if (code === "EBUSY" || code === "EPERM") { + return new FileLockError(binPath); + } + return error; +} + /** * Return the etag (sha1) of the path. Throw if unable to hash the file. */ diff --git a/src/core/downloadProgress.ts b/src/core/downloadProgress.ts new file mode 100644 index 00000000..600c3139 --- /dev/null +++ b/src/core/downloadProgress.ts @@ -0,0 +1,44 @@ +import * as fs from "node:fs/promises"; +import * as path from "node:path"; + +export interface DownloadProgress { + bytesDownloaded: number; + totalBytes: number | null; + status: "downloading" | "verifying"; +} + +export async function writeProgress( + logPath: string, + progress: DownloadProgress, +): Promise { + await fs.mkdir(path.dirname(logPath), { recursive: true }); + await fs.writeFile(logPath, JSON.stringify({ ...progress }) + "\n"); +} + +export async function readProgress( + logPath: string, +): Promise { + try { + const content = await fs.readFile(logPath, "utf-8"); + const progress = JSON.parse(content) as DownloadProgress; + if ( + typeof progress.bytesDownloaded !== "number" || + (typeof progress.totalBytes !== "number" && + progress.totalBytes !== null) || + (progress.status !== "downloading" && progress.status !== "verifying") + ) { + return null; + } + return progress; + } catch { + return null; + } +} + +export async function clearProgress(logPath: string): Promise { + try { + await fs.rm(logPath, { force: true }); + } catch { + // If we cannot remove it now then we'll do it in the next startup + } +} diff --git a/test/mocks/testHelpers.ts b/test/mocks/testHelpers.ts index 2ef46716..faf2a72d 100644 --- a/test/mocks/testHelpers.ts +++ b/test/mocks/testHelpers.ts @@ -1,3 +1,4 @@ +import { type IncomingMessage } from "node:http"; import { vi } from "vitest"; import * as vscode from "vscode"; @@ -8,7 +9,7 @@ import { type Logger } from "@/logging/logger"; * Use this to set configuration values that will be returned by vscode.workspace.getConfiguration(). */ export class MockConfigurationProvider { - private config = new Map(); + private readonly config = new Map(); constructor() { this.setupVSCodeMock(); @@ -298,3 +299,54 @@ export function createMockLogger(): Logger { error: vi.fn(), }; } + +export function createMockStream( + content: string, + options: { + chunkSize?: number; + delay?: number; + // If defined will throw an error instead of closing normally + error?: NodeJS.ErrnoException; + } = {}, +): IncomingMessage { + const { chunkSize = 8, delay = 1, error } = options; + + const buffer = Buffer.from(content); + let position = 0; + let closeCallback: ((...args: unknown[]) => void) | null = null; + let errorCallback: ((error: Error) => void) | null = null; + + return { + on: vi.fn((event: string, callback: (...args: unknown[]) => void) => { + if (event === "data") { + const sendChunk = () => { + if (position < buffer.length) { + const chunk = buffer.subarray( + position, + Math.min(position + chunkSize, buffer.length), + ); + position += chunkSize; + callback(chunk); + if (position < buffer.length) { + setTimeout(sendChunk, delay); + } else { + setImmediate(() => { + if (error && errorCallback) { + errorCallback(error); + } else if (closeCallback) { + closeCallback(); + } + }); + } + } + }; + setTimeout(sendChunk, delay); + } else if (event === "error") { + errorCallback = callback; + } else if (event === "close") { + closeCallback = callback; + } + }), + destroy: vi.fn(), + } as unknown as IncomingMessage; +} diff --git a/test/unit/core/binaryLock.test.ts b/test/unit/core/binaryLock.test.ts new file mode 100644 index 00000000..bab76e1a --- /dev/null +++ b/test/unit/core/binaryLock.test.ts @@ -0,0 +1,160 @@ +import { beforeEach, describe, expect, it, vi } from "vitest"; +import * as vscode from "vscode"; + +import { BinaryLock } from "@/core/binaryLock"; +import * as downloadProgress from "@/core/downloadProgress"; + +import { + createMockLogger, + MockProgressReporter, +} from "../../mocks/testHelpers"; + +vi.mock("vscode"); + +// Mock proper-lockfile +vi.mock("proper-lockfile", () => ({ + lock: vi.fn(), +})); + +// Mock downloadProgress module +vi.mock("@/core/downloadProgress", () => ({ + STALE_TIMEOUT_MS: 15000, + readProgress: vi.fn(), + writeProgress: vi.fn(), + clearProgress: vi.fn(), +})); + +describe("BinaryLock", () => { + let binaryLock: BinaryLock; + let mockLogger: ReturnType; + let mockProgress: MockProgressReporter; + let mockRelease: () => Promise; + + const createLockError = () => { + const error = new Error("Lock is busy") as NodeJS.ErrnoException; + error.code = "ELOCKED"; + return error; + }; + + beforeEach(() => { + mockLogger = createMockLogger(); + mockProgress = new MockProgressReporter(); + mockRelease = vi.fn().mockResolvedValue(undefined); + + binaryLock = new BinaryLock(vscode, mockLogger); + }); + + describe("acquireLockOrWait", () => { + it("should acquire lock immediately when available", async () => { + const { lock } = await import("proper-lockfile"); + vi.mocked(lock).mockResolvedValue(mockRelease); + + const result = await binaryLock.acquireLockOrWait( + "/path/to/binary", + "/path/to/progress.log", + ); + + expect(result.release).toBe(mockRelease); + expect(result.waited).toBe(false); + expect(lock).toHaveBeenCalledWith("/path/to/binary", { + stale: 15000, + retries: 0, + realpath: false, + }); + }); + + it("should wait and monitor progress when lock is held", async () => { + const { lock } = await import("proper-lockfile"); + + vi.mocked(lock) + .mockRejectedValueOnce(createLockError()) + .mockResolvedValueOnce(mockRelease); + + vi.mocked(downloadProgress.readProgress).mockResolvedValue({ + bytesDownloaded: 1024, + totalBytes: 2048, + status: "downloading", + }); + + const result = await binaryLock.acquireLockOrWait( + "/path/to/binary", + "/path/to/progress.log", + ); + + expect(result.release).toBe(mockRelease); + expect(result.waited).toBe(true); + + const reports = mockProgress.getProgressReports(); + expect(reports.length).toBeGreaterThan(0); + expect(reports[0].message).toBe("1.02 kB / 2.05 kB"); + }); + + it.each([ + { + name: "downloading with known size", + progress: { + bytesDownloaded: 5000000, + totalBytes: 10000000, + status: "downloading" as const, + }, + expectedMessage: "5 MB / 10 MB", + }, + { + name: "downloading with unknown size", + progress: { + bytesDownloaded: 1024, + totalBytes: null, + status: "downloading" as const, + }, + expectedMessage: "1.02 kB / unknown", + }, + { + name: "verifying signature", + progress: { + bytesDownloaded: 0, + totalBytes: null, + status: "verifying" as const, + }, + expectedMessage: "Verifying signature...", + }, + ])( + "should report progress while waiting: $name", + async ({ progress, expectedMessage }) => { + const { lock } = await import("proper-lockfile"); + + let callCount = 0; + vi.mocked(lock).mockImplementation(() => { + callCount++; + if (callCount === 1) { + return Promise.reject(createLockError()); + } + return Promise.resolve(mockRelease); + }); + + vi.mocked(downloadProgress.readProgress).mockResolvedValue(progress); + + await binaryLock.acquireLockOrWait( + "/path/to/binary", + "/path/to/progress.log", + ); + + const reports = mockProgress.getProgressReports(); + expect(reports.length).toBeGreaterThan(0); + expect(reports[0].message).toContain(expectedMessage); + }, + ); + + it("should re-throw non-ELOCKED errors", async () => { + const { lock } = await import("proper-lockfile"); + const testError = new Error("Filesystem error"); + vi.mocked(lock).mockRejectedValue(testError); + + await expect( + binaryLock.acquireLockOrWait( + "/path/to/binary", + "/path/to/progress.log", + ), + ).rejects.toThrow("Filesystem error"); + }); + }); +}); diff --git a/test/unit/core/cliManager.concurrent.test.ts b/test/unit/core/cliManager.concurrent.test.ts new file mode 100644 index 00000000..457d8a31 --- /dev/null +++ b/test/unit/core/cliManager.concurrent.test.ts @@ -0,0 +1,191 @@ +/** + * This file tests that multiple concurrent calls to fetchBinary properly coordinate + * using proper-lockfile to prevent race conditions. Unlike the main cliManager.test.ts, + * this test uses the real filesystem and doesn't mock the locking library to verify + * actual file-level coordination. + */ +import { type AxiosInstance } from "axios"; +import { type Api } from "coder/site/src/api/api"; +import * as fs from "node:fs/promises"; +import * as os from "node:os"; +import * as path from "node:path"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; +import * as vscode from "vscode"; + +import { CliManager } from "@/core/cliManager"; +import * as cliUtils from "@/core/cliUtils"; +import { PathResolver } from "@/core/pathResolver"; +import * as pgp from "@/pgp"; + +import { + createMockLogger, + createMockStream, + MockConfigurationProvider, + MockProgressReporter, +} from "../../mocks/testHelpers"; + +vi.mock("@/pgp"); +vi.mock("@/core/cliUtils", async () => { + const actual = await vi.importActual("@/core/cliUtils"); + return { + ...actual, + goos: vi.fn(), + goarch: vi.fn(), + name: vi.fn(), + version: vi.fn(), + }; +}); + +function setupCliUtilsMocks(version: string) { + vi.mocked(cliUtils.goos).mockReturnValue("linux"); + vi.mocked(cliUtils.goarch).mockReturnValue("amd64"); + vi.mocked(cliUtils.name).mockReturnValue("coder-linux-amd64"); + vi.mocked(cliUtils.version).mockResolvedValue(version); + vi.mocked(pgp.readPublicKeys).mockResolvedValue([]); +} + +function createMockApi( + version: string, + options: { + chunkSize?: number; + delay?: number; + error?: NodeJS.ErrnoException; + } = {}, +): Api { + const mockAxios = { + get: vi.fn().mockImplementation(() => + Promise.resolve({ + status: 200, + headers: { "content-length": "17" }, + data: createMockStream(`mock-binary-v${version}`, options), + }), + ), + defaults: { baseURL: "https://test.coder.com" }, + } as unknown as AxiosInstance; + + return { + getAxiosInstance: () => mockAxios, + getBuildInfo: vi.fn().mockResolvedValue({ version }), + } as unknown as Api; +} + +function setupManager(testDir: string): CliManager { + const _mockProgress = new MockProgressReporter(); + const mockConfig = new MockConfigurationProvider(); + mockConfig.set("coder.disableSignatureVerification", true); + + return new CliManager( + vscode, + createMockLogger(), + new PathResolver(testDir, "/code/log"), + ); +} + +describe("CliManager Concurrent Downloads", () => { + let testDir: string; + + beforeEach(async () => { + testDir = await fs.mkdtemp( + path.join(os.tmpdir(), "climanager-concurrent-"), + ); + }); + + afterEach(async () => { + await fs.rm(testDir, { recursive: true, force: true }); + }); + + it("handles multiple concurrent downloads without race conditions", async () => { + const manager = setupManager(testDir); + setupCliUtilsMocks("1.2.3"); + const mockApi = createMockApi("1.2.3"); + + const label = "test.coder.com"; + const binaryPath = path.join(testDir, label, "bin", "coder-linux-amd64"); + + const downloads = await Promise.all([ + manager.fetchBinary(mockApi, label), + manager.fetchBinary(mockApi, label), + manager.fetchBinary(mockApi, label), + ]); + + expect(downloads).toHaveLength(3); + for (const result of downloads) { + expect(result).toBe(binaryPath); + } + + // Verify binary exists and lock/progress files are cleaned up + await expect(fs.access(binaryPath)).resolves.toBeUndefined(); + await expect(fs.access(binaryPath + ".lock")).rejects.toThrow(); + await expect(fs.access(binaryPath + ".progress.log")).rejects.toThrow(); + }); + + it("redownloads when version mismatch is detected concurrently", async () => { + const manager = setupManager(testDir); + setupCliUtilsMocks("1.2.3"); + vi.mocked(cliUtils.version).mockImplementation(async (binPath) => { + const fileContent = await fs.readFile(binPath, { + encoding: "utf-8", + }); + return fileContent.includes("1.2.3") ? "1.2.3" : "2.0.0"; + }); + + // First call downloads 1.2.3, next two expect 2.0.0 (server upgraded) + const mockApi1 = createMockApi("1.2.3", { delay: 100 }); + const mockApi2 = createMockApi("2.0.0"); + + const label = "test.coder.com"; + const binaryPath = path.join(testDir, label, "bin", "coder-linux-amd64"); + + // Start first call and give it time to acquire the lock + const firstDownload = manager.fetchBinary(mockApi1, label); + // Wait for the lock to be acquired before starting concurrent calls + await new Promise((resolve) => setTimeout(resolve, 50)); + + const downloads = await Promise.all([ + firstDownload, + manager.fetchBinary(mockApi2, label), + manager.fetchBinary(mockApi2, label), + ]); + + expect(downloads).toHaveLength(3); + for (const result of downloads) { + expect(result).toBe(binaryPath); + } + + // Binary should be updated to 2.0.0, lock/progress files cleaned up + await expect(fs.access(binaryPath)).resolves.toBeUndefined(); + const finalContent = await fs.readFile(binaryPath, "utf8"); + expect(finalContent).toContain("v2.0.0"); + await expect(fs.access(binaryPath + ".lock")).rejects.toThrow(); + await expect(fs.access(binaryPath + ".progress.log")).rejects.toThrow(); + }); + + it.each([ + { + name: "disk storage insufficient", + code: "ENOSPC", + message: "no space left on device", + }, + { + name: "connection timeout", + code: "ETIMEDOUT", + message: "connection timed out", + }, + ])("handles $name error during download", async ({ code, message }) => { + const manager = setupManager(testDir); + setupCliUtilsMocks("1.2.3"); + + const error = new Error(`${code}: ${message}`); + (error as NodeJS.ErrnoException).code = code; + const mockApi = createMockApi("1.2.3", { error }); + + const label = "test.coder.com"; + const binaryPath = path.join(testDir, label, "bin", "coder-linux-amd64"); + + await expect(manager.fetchBinary(mockApi, label)).rejects.toThrow( + `Unable to download binary: ${code}: ${message}`, + ); + + await expect(fs.access(binaryPath + ".lock")).rejects.toThrow(); + }); +}); diff --git a/test/unit/core/cliManager.test.ts b/test/unit/core/cliManager.test.ts index d4f16c87..95755d31 100644 --- a/test/unit/core/cliManager.test.ts +++ b/test/unit/core/cliManager.test.ts @@ -1,11 +1,11 @@ import globalAxios, { type AxiosInstance } from "axios"; import { type Api } from "coder/site/src/api/api"; -import EventEmitter from "events"; -import * as fs from "fs"; -import { type IncomingMessage } from "http"; import { fs as memfs, vol } from "memfs"; -import * as os from "os"; -import * as path from "path"; +import EventEmitter from "node:events"; +import * as fs from "node:fs"; +import { type IncomingMessage } from "node:http"; +import * as os from "node:os"; +import * as path from "node:path"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import * as vscode from "vscode"; @@ -16,6 +16,7 @@ import * as pgp from "@/pgp"; import { createMockLogger, + createMockStream, MockConfigurationProvider, MockProgressReporter, MockUserInteraction, @@ -24,7 +25,6 @@ import { expectPathsEqual } from "../../utils/platform"; vi.mock("os"); vi.mock("axios"); -vi.mock("@/pgp"); vi.mock("fs", async () => { const memfs: { fs: typeof fs } = await vi.importActual("memfs"); @@ -42,6 +42,14 @@ vi.mock("fs/promises", async () => { }; }); +// Mock lockfile to bypass file locking in tests +vi.mock("proper-lockfile", () => ({ + lock: () => Promise.resolve(() => Promise.resolve()), + check: () => Promise.resolve(false), +})); + +vi.mock("@/pgp"); + vi.mock("@/core/cliUtils", async () => { const actual = await vi.importActual("@/core/cliUtils"); @@ -676,11 +684,11 @@ describe("CliManager", () => { } function withSignatureResponses(statuses: number[]): void { - statuses.forEach((status) => { + for (const status of statuses) { const data = status === 200 ? createMockStream("mock-signature-content") : undefined; withHttpResponse(status, {}, data); - }); + } } function withHttpResponse( @@ -730,70 +738,26 @@ describe("CliManager", () => { withHttpResponse(200, { "content-length": "1024" }, errorStream); } } - - function createMockStream( - content: string, - options: { chunkSize?: number; delay?: number } = {}, - ): IncomingMessage { - const { chunkSize = 8, delay = 1 } = options; - - const buffer = Buffer.from(content); - let position = 0; - let closeCallback: ((...args: unknown[]) => void) | null = null; - - return { - on: vi.fn((event: string, callback: (...args: unknown[]) => void) => { - if (event === "data") { - // Send data in chunks - const sendChunk = () => { - if (position < buffer.length) { - const chunk = buffer.subarray( - position, - Math.min(position + chunkSize, buffer.length), - ); - position += chunkSize; - callback(chunk); - if (position < buffer.length) { - setTimeout(sendChunk, delay); - } else { - // All chunks sent - use setImmediate to ensure close happens - // after all synchronous operations and I/O callbacks complete - setImmediate(() => { - if (closeCallback) { - closeCallback(); - } - }); - } - } - }; - setTimeout(sendChunk, delay); - } else if (event === "close") { - closeCallback = callback; - } - }), - destroy: vi.fn(), - } as unknown as IncomingMessage; - } - - function createVerificationError(msg: string): pgp.VerificationError { - const error = new pgp.VerificationError( - pgp.VerificationErrorCode.Invalid, - msg, - ); - vi.mocked(error.summary).mockReturnValue("Signature does not match"); - return error; - } - - function mockBinaryContent(version: string): string { - return `mock-binary-v${version}`; - } - - function expectFileInDir(dir: string, pattern: string): string | undefined { - const files = readdir(dir); - return files.find((f) => f.includes(pattern)); - } - - function readdir(dir: string): string[] { - return memfs.readdirSync(dir) as string[]; - } }); + +function createVerificationError(msg: string): pgp.VerificationError { + const error = new pgp.VerificationError( + pgp.VerificationErrorCode.Invalid, + msg, + ); + vi.mocked(error.summary).mockReturnValue("Signature does not match"); + return error; +} + +function mockBinaryContent(version: string): string { + return `mock-binary-v${version}`; +} + +function expectFileInDir(dir: string, pattern: string): string | undefined { + const files = readdir(dir); + return files.find((f) => f.includes(pattern)); +} + +function readdir(dir: string): string[] { + return memfs.readdirSync(dir) as string[]; +} diff --git a/test/unit/core/downloadProgress.test.ts b/test/unit/core/downloadProgress.test.ts new file mode 100644 index 00000000..b39e82b6 --- /dev/null +++ b/test/unit/core/downloadProgress.test.ts @@ -0,0 +1,102 @@ +import { promises as fs } from "node:fs"; +import * as os from "node:os"; +import * as path from "node:path"; +import { afterEach, beforeEach, describe, expect, it } from "vitest"; + +import * as downloadProgress from "@/core/downloadProgress"; + +describe("downloadProgress", () => { + let testDir: string; + let testLogPath: string; + + beforeEach(async () => { + testDir = await fs.mkdtemp( + path.join(os.tmpdir(), "download-progress-test-"), + ); + testLogPath = path.join(testDir, "test.progress.log"); + }); + + afterEach(async () => { + try { + await fs.rm(testDir, { recursive: true, force: true }); + } catch { + // Ignore + } + }); + + describe("writeProgress", () => { + it("should write and overwrite progress", async () => { + await downloadProgress.writeProgress(testLogPath, { + bytesDownloaded: 1000, + totalBytes: 10000, + status: "downloading", + }); + const first = JSON.parse( + (await fs.readFile(testLogPath, "utf-8")).trim(), + ); + expect(first.bytesDownloaded).toBe(1000); + + await downloadProgress.writeProgress(testLogPath, { + bytesDownloaded: 2000, + totalBytes: null, + status: "verifying", + }); + const second = JSON.parse( + (await fs.readFile(testLogPath, "utf-8")).trim(), + ); + expect(second.bytesDownloaded).toBe(2000); + expect(second.totalBytes).toBeNull(); + }); + + it("should create nested directories", async () => { + const nestedPath = path.join(testDir, "nested", "dir", "progress.log"); + await downloadProgress.writeProgress(nestedPath, { + bytesDownloaded: 500, + totalBytes: 5000, + status: "downloading", + }); + expect(await fs.readFile(nestedPath, "utf-8")).toBeTruthy(); + }); + }); + + describe("readProgress", () => { + it("should read progress from log file", async () => { + const expectedProgress = { + bytesDownloaded: 1500, + totalBytes: 10000, + status: "downloading", + }; + + await fs.writeFile(testLogPath, JSON.stringify(expectedProgress) + "\n"); + const progress = await downloadProgress.readProgress(testLogPath); + expect(progress).toEqual(expectedProgress); + }); + + it("should return null for missing, empty, or invalid files", async () => { + expect( + await downloadProgress.readProgress(path.join(testDir, "nonexistent")), + ).toBeNull(); + + await fs.writeFile(testLogPath, ""); + expect(await downloadProgress.readProgress(testLogPath)).toBeNull(); + + await fs.writeFile(testLogPath, "invalid json"); + expect(await downloadProgress.readProgress(testLogPath)).toBeNull(); + + await fs.writeFile(testLogPath, JSON.stringify({ incomplete: true })); + expect(await downloadProgress.readProgress(testLogPath)).toBeNull(); + }); + }); + + describe("clearProgress", () => { + it("should remove existing file or ignore missing file", async () => { + await fs.writeFile(testLogPath, "test"); + await downloadProgress.clearProgress(testLogPath); + await expect(fs.readFile(testLogPath)).rejects.toThrow(); + + await expect( + downloadProgress.clearProgress(path.join(testDir, "nonexistent")), + ).resolves.toBeUndefined(); + }); + }); +}); diff --git a/yarn.lock b/yarn.lock index ea35d101..b2527a90 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1288,6 +1288,13 @@ resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz#56e2cc26c397c038fab0e3a917a12d5c5909e901" integrity sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA== +"@types/proper-lockfile@^4.1.4": + version "4.1.4" + resolved "https://registry.yarnpkg.com/@types/proper-lockfile/-/proper-lockfile-4.1.4.tgz#cd9fab92bdb04730c1ada542c356f03620f84008" + integrity sha512-uo2ABllncSqg9F1D4nugVl9v93RmjxF6LJzQLMLDdPaXCUIDPeOJ21Gbqi43xNKzBi/WQ0Q0dICqufzQbMjipQ== + dependencies: + "@types/retry" "*" + "@types/responselike@^1.0.0": version "1.0.3" resolved "https://registry.yarnpkg.com/@types/responselike/-/responselike-1.0.3.tgz#cc29706f0a397cfe6df89debfe4bf5cea159db50" @@ -1295,6 +1302,11 @@ dependencies: "@types/node" "*" +"@types/retry@*": + version "0.12.5" + resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.5.tgz#f090ff4bd8d2e5b940ff270ab39fd5ca1834a07e" + integrity sha512-3xSjTp3v03X/lSQLkczaN9UIEwJMoMCA1+Nb5HfbJEQWogdeQIyVtTvxPXDQjZ5zws8rFQfVfRdz03ARihPJgw== + "@types/sarif@^2.1.7": version "2.1.7" resolved "https://registry.yarnpkg.com/@types/sarif/-/sarif-2.1.7.tgz#dab4d16ba7568e9846c454a8764f33c5d98e5524" @@ -6825,6 +6837,15 @@ progress@^2.0.0, progress@^2.0.3: resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== +proper-lockfile@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/proper-lockfile/-/proper-lockfile-4.1.2.tgz#c8b9de2af6b2f1601067f98e01ac66baa223141f" + integrity sha512-TjNPblN4BwAWMXU8s9AEz4JmQxnD1NNL7bNOY/AKUzyamc379FWASUhc/K1pL2noVb+XmZKLL68cjzLsiOAMaA== + dependencies: + graceful-fs "^4.2.4" + retry "^0.12.0" + signal-exit "^3.0.2" + proxy-agent@^6.5.0: version "6.5.0" resolved "https://registry.yarnpkg.com/proxy-agent/-/proxy-agent-6.5.0.tgz#9e49acba8e4ee234aacb539f89ed9c23d02f232d" @@ -7686,6 +7707,11 @@ restore-cursor@^5.0.0: onetime "^7.0.0" signal-exit "^4.1.0" +retry@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/retry/-/retry-0.12.0.tgz#1b42a6266a21f07421d1b0b54b7dc167b01c013b" + integrity sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow== + reusify@^1.0.4: version "1.0.4" resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" From d5c3cc038867207806ebf5655534a37079bb7d37 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 25 Nov 2025 13:01:37 +0300 Subject: [PATCH 31/55] Add automatic reconnection for WebSocket connections (#654) Implement ReconnectingWebSocket class to automatically recover from network failures when communicating with Coder deployments. Uses exponential backoff with jitter and distinguishes between recoverable errors (network issues) and unrecoverable errors (auth failures). - Auto-reconnect on abnormal closures and network failures - Stop on unrecoverable errors (HTTP 403/410/426, WS 1002/1003) - Reconnect when session token or host changes - Event handlers persist across reconnections Closes #595 --- CHANGELOG.md | 5 + src/api/agentMetadataHelper.ts | 6 +- src/api/coderApi.ts | 173 +++++-- src/api/workspace.ts | 6 +- src/inbox.ts | 6 +- src/remote/workspaceStateMachine.ts | 7 +- src/websocket/codes.ts | 55 ++ src/websocket/eventStreamConnection.ts | 13 +- src/websocket/reconnectingWebSocket.ts | 304 ++++++++++++ src/websocket/sseConnection.ts | 27 +- test/unit/api/coderApi.test.ts | 68 ++- .../websocket/reconnectingWebSocket.test.ts | 468 ++++++++++++++++++ test/unit/websocket/sseConnection.test.ts | 18 +- 13 files changed, 1069 insertions(+), 87 deletions(-) create mode 100644 src/websocket/codes.ts create mode 100644 src/websocket/reconnectingWebSocket.ts create mode 100644 test/unit/websocket/reconnectingWebSocket.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 760d3b64..7b1745b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,11 @@ Other windows now wait and display real-time progress instead of attempting concurrent downloads, preventing corruption and failures. +### Changed + +- WebSocket connections now automatically reconnect on network failures, improving reliability when + communicating with Coder deployments. + ## [v1.11.4](https://github.com/coder/vscode-coder/releases/tag/v1.11.4) 2025-11-20 ### Fixed diff --git a/src/api/agentMetadataHelper.ts b/src/api/agentMetadataHelper.ts index 4de804ad..26ab1b6f 100644 --- a/src/api/agentMetadataHelper.ts +++ b/src/api/agentMetadataHelper.ts @@ -53,7 +53,11 @@ export async function createAgentMetadataWatcher( event.parsedMessage.data, ); - // Overwrite metadata if it changed. + if (watcher.error !== undefined) { + watcher.error = undefined; + onChange.fire(null); + } + if (JSON.stringify(watcher.metadata) !== JSON.stringify(metadata)) { watcher.metadata = metadata; onChange.fire(null); diff --git a/src/api/coderApi.ts b/src/api/coderApi.ts index ef120ce4..04c696be 100644 --- a/src/api/coderApi.ts +++ b/src/api/coderApi.ts @@ -14,7 +14,7 @@ import { type WorkspaceAgentLog, } from "coder/site/src/api/typesGenerated"; import * as vscode from "vscode"; -import { type ClientOptions, type CloseEvent, type ErrorEvent } from "ws"; +import { type ClientOptions } from "ws"; import { CertificateError } from "../error"; import { getHeaderCommand, getHeaders } from "../headers"; @@ -31,11 +31,20 @@ import { HttpClientLogLevel, } from "../logging/types"; import { sizeOf } from "../logging/utils"; -import { type UnidirectionalStream } from "../websocket/eventStreamConnection"; +import { HttpStatusCode } from "../websocket/codes"; +import { + type UnidirectionalStream, + type CloseEvent, + type ErrorEvent, +} from "../websocket/eventStreamConnection"; import { OneWayWebSocket, type OneWayWebSocketInit, } from "../websocket/oneWayWebSocket"; +import { + ReconnectingWebSocket, + type SocketFactory, +} from "../websocket/reconnectingWebSocket"; import { SseConnection } from "../websocket/sseConnection"; import { createHttpAgent } from "./utils"; @@ -47,6 +56,10 @@ const coderSessionTokenHeader = "Coder-Session-Token"; * and WebSocket methods for real-time functionality. */ export class CoderApi extends Api { + private readonly reconnectingSockets = new Set< + ReconnectingWebSocket + >(); + private constructor(private readonly output: Logger) { super(); } @@ -66,10 +79,34 @@ export class CoderApi extends Api { client.setSessionToken(token); } - setupInterceptors(client, baseUrl, output); + setupInterceptors(client, output); return client; } + setSessionToken = (token: string): void => { + const defaultHeaders = this.getAxiosInstance().defaults.headers.common; + const currentToken = defaultHeaders[coderSessionTokenHeader]; + defaultHeaders[coderSessionTokenHeader] = token; + + if (currentToken !== token) { + for (const socket of this.reconnectingSockets) { + socket.reconnect(); + } + } + }; + + setHost = (host: string | undefined): void => { + const defaults = this.getAxiosInstance().defaults; + const currentHost = defaults.baseURL; + defaults.baseURL = host; + + if (currentHost !== host) { + for (const socket of this.reconnectingSockets) { + socket.reconnect(); + } + } + }; + watchInboxNotifications = async ( watchTemplates: string[], watchTargets: string[], @@ -83,6 +120,7 @@ export class CoderApi extends Api { targets: watchTargets.join(","), }, options, + enableRetry: true, }); }; @@ -91,6 +129,7 @@ export class CoderApi extends Api { apiRoute: `/api/v2/workspaces/${workspace.id}/watch-ws`, fallbackApiRoute: `/api/v2/workspaces/${workspace.id}/watch`, options, + enableRetry: true, }); }; @@ -102,6 +141,7 @@ export class CoderApi extends Api { apiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata-ws`, fallbackApiRoute: `/api/v2/workspaceagents/${agentId}/watch-metadata`, options, + enableRetry: true, }); }; @@ -148,53 +188,78 @@ export class CoderApi extends Api { } private async createWebSocket( - configs: Omit, - ) { - const baseUrlRaw = this.getAxiosInstance().defaults.baseURL; - if (!baseUrlRaw) { - throw new Error("No base URL set on REST client"); - } + configs: Omit & { enableRetry?: boolean }, + ): Promise> { + const { enableRetry, ...socketConfigs } = configs; + + const socketFactory: SocketFactory = async () => { + const baseUrlRaw = this.getAxiosInstance().defaults.baseURL; + if (!baseUrlRaw) { + throw new Error("No base URL set on REST client"); + } + + const baseUrl = new URL(baseUrlRaw); + const token = this.getAxiosInstance().defaults.headers.common[ + coderSessionTokenHeader + ] as string | undefined; + + const headersFromCommand = await getHeaders( + baseUrlRaw, + getHeaderCommand(vscode.workspace.getConfiguration()), + this.output, + ); - const baseUrl = new URL(baseUrlRaw); - const token = this.getAxiosInstance().defaults.headers.common[ - coderSessionTokenHeader - ] as string | undefined; + const httpAgent = await createHttpAgent( + vscode.workspace.getConfiguration(), + ); - const headersFromCommand = await getHeaders( - baseUrlRaw, - getHeaderCommand(vscode.workspace.getConfiguration()), - this.output, - ); + /** + * Similar to the REST client, we want to prioritize headers in this order (highest to lowest): + * 1. Headers from the header command + * 2. Any headers passed directly to this function + * 3. Coder session token from the Api client (if set) + */ + const headers = { + ...(token ? { [coderSessionTokenHeader]: token } : {}), + ...configs.options?.headers, + ...headersFromCommand, + }; - const httpAgent = await createHttpAgent( - vscode.workspace.getConfiguration(), - ); + const webSocket = new OneWayWebSocket({ + location: baseUrl, + ...socketConfigs, + options: { + ...configs.options, + agent: httpAgent, + followRedirects: true, + headers, + }, + }); - /** - * Similar to the REST client, we want to prioritize headers in this order (highest to lowest): - * 1. Headers from the header command - * 2. Any headers passed directly to this function - * 3. Coder session token from the Api client (if set) - */ - const headers = { - ...(token ? { [coderSessionTokenHeader]: token } : {}), - ...configs.options?.headers, - ...headersFromCommand, + this.attachStreamLogger(webSocket); + return webSocket; }; - const webSocket = new OneWayWebSocket({ - location: baseUrl, - ...configs, - options: { - ...configs.options, - agent: httpAgent, - followRedirects: true, - headers, - }, - }); + if (enableRetry) { + const reconnectingSocket = await ReconnectingWebSocket.create( + socketFactory, + this.output, + configs.apiRoute, + undefined, + () => + this.reconnectingSockets.delete( + reconnectingSocket as ReconnectingWebSocket, + ), + ); + + this.reconnectingSockets.add( + reconnectingSocket as ReconnectingWebSocket, + ); - this.attachStreamLogger(webSocket); - return webSocket; + return reconnectingSocket; + } else { + return socketFactory(); + } } private attachStreamLogger( @@ -230,13 +295,15 @@ export class CoderApi extends Api { fallbackApiRoute: string; searchParams?: Record | URLSearchParams; options?: ClientOptions; + enableRetry?: boolean; }): Promise> { - let webSocket: OneWayWebSocket; + let webSocket: UnidirectionalStream; try { webSocket = await this.createWebSocket({ apiRoute: configs.apiRoute, searchParams: configs.searchParams, options: configs.options, + enableRetry: configs.enableRetry, }); } catch { // Failed to create WebSocket, use SSE fallback @@ -274,8 +341,8 @@ export class CoderApi extends Api { const handleError = (event: ErrorEvent) => { cleanup(); const is404 = - event.message?.includes("404") || - event.error?.message?.includes("404"); + event.message?.includes(String(HttpStatusCode.NOT_FOUND)) || + event.error?.message?.includes(String(HttpStatusCode.NOT_FOUND)); if (is404 && onNotFound) { connection.close(); @@ -323,14 +390,11 @@ export class CoderApi extends Api { /** * Set up logging and request interceptors for the CoderApi instance. */ -function setupInterceptors( - client: CoderApi, - baseUrl: string, - output: Logger, -): void { +function setupInterceptors(client: CoderApi, output: Logger): void { addLoggingInterceptors(client.getAxiosInstance(), output); client.getAxiosInstance().interceptors.request.use(async (config) => { + const baseUrl = client.getAxiosInstance().defaults.baseURL; const headers = await getHeaders( baseUrl, getHeaderCommand(vscode.workspace.getConfiguration()), @@ -356,7 +420,12 @@ function setupInterceptors( client.getAxiosInstance().interceptors.response.use( (r) => r, async (err) => { - throw await CertificateError.maybeWrap(err, baseUrl, output); + const baseUrl = client.getAxiosInstance().defaults.baseURL; + if (baseUrl) { + throw await CertificateError.maybeWrap(err, baseUrl, output); + } else { + throw err; + } }, ); } diff --git a/src/api/workspace.ts b/src/api/workspace.ts index a24d3a64..1d3b7a4e 100644 --- a/src/api/workspace.ts +++ b/src/api/workspace.ts @@ -11,7 +11,7 @@ import * as vscode from "vscode"; import { type FeatureSet } from "../featureSet"; import { getGlobalFlags } from "../globalFlags"; import { escapeCommandArg } from "../util"; -import { type OneWayWebSocket } from "../websocket/oneWayWebSocket"; +import { type UnidirectionalStream } from "../websocket/eventStreamConnection"; import { errToStr, createWorkspaceIdentifier } from "./api-helper"; import { type CoderApi } from "./coderApi"; @@ -93,7 +93,7 @@ export async function streamBuildLogs( client: CoderApi, writeEmitter: vscode.EventEmitter, workspace: Workspace, -): Promise> { +): Promise> { const socket = await client.watchBuildLogsByBuildId( workspace.latest_build.id, [], @@ -131,7 +131,7 @@ export async function streamAgentLogs( client: CoderApi, writeEmitter: vscode.EventEmitter, agent: WorkspaceAgent, -): Promise> { +): Promise> { const socket = await client.watchWorkspaceAgentLogs(agent.id, []); socket.addEventListener("message", (data) => { diff --git a/src/inbox.ts b/src/inbox.ts index 8dff573f..59b9ae0b 100644 --- a/src/inbox.ts +++ b/src/inbox.ts @@ -7,7 +7,7 @@ import type { import type { CoderApi } from "./api/coderApi"; import type { Logger } from "./logging/logger"; -import type { OneWayWebSocket } from "./websocket/oneWayWebSocket"; +import type { UnidirectionalStream } from "./websocket/eventStreamConnection"; // These are the template IDs of our notifications. // Maybe in the future we should avoid hardcoding @@ -16,7 +16,9 @@ const TEMPLATE_WORKSPACE_OUT_OF_MEMORY = "a9d027b4-ac49-4fb1-9f6d-45af15f64e7a"; const TEMPLATE_WORKSPACE_OUT_OF_DISK = "f047f6a3-5713-40f7-85aa-0394cce9fa3a"; export class Inbox implements vscode.Disposable { - private socket: OneWayWebSocket | undefined; + private socket: + | UnidirectionalStream + | undefined; private disposed = false; private constructor(private readonly logger: Logger) {} diff --git a/src/remote/workspaceStateMachine.ts b/src/remote/workspaceStateMachine.ts index eb7aa335..340ec960 100644 --- a/src/remote/workspaceStateMachine.ts +++ b/src/remote/workspaceStateMachine.ts @@ -21,7 +21,7 @@ import type { CoderApi } from "../api/coderApi"; import type { PathResolver } from "../core/pathResolver"; import type { FeatureSet } from "../featureSet"; import type { Logger } from "../logging/logger"; -import type { OneWayWebSocket } from "../websocket/oneWayWebSocket"; +import type { UnidirectionalStream } from "../websocket/eventStreamConnection"; /** * Manages workspace and agent state transitions until ready for SSH connection. @@ -32,9 +32,10 @@ export class WorkspaceStateMachine implements vscode.Disposable { private agent: { id: string; name: string } | undefined; - private buildLogSocket: OneWayWebSocket | null = null; + private buildLogSocket: UnidirectionalStream | null = null; - private agentLogSocket: OneWayWebSocket | null = null; + private agentLogSocket: UnidirectionalStream | null = + null; constructor( private readonly parts: AuthorityParts, diff --git a/src/websocket/codes.ts b/src/websocket/codes.ts new file mode 100644 index 00000000..ac8eccf7 --- /dev/null +++ b/src/websocket/codes.ts @@ -0,0 +1,55 @@ +/** + * WebSocket close codes (RFC 6455) and HTTP status codes for socket connections. + * @see https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1 + */ + +/** WebSocket close codes defined in RFC 6455 */ +export const WebSocketCloseCode = { + /** Normal closure - connection successfully completed */ + NORMAL: 1000, + /** Endpoint going away (server shutdown) */ + GOING_AWAY: 1001, + /** Protocol error - connection cannot be recovered */ + PROTOCOL_ERROR: 1002, + /** Unsupported data type received - connection cannot be recovered */ + UNSUPPORTED_DATA: 1003, + /** Abnormal closure - connection closed without close frame (network issues) */ + ABNORMAL: 1006, +} as const; + +/** HTTP status codes used for socket creation and connection logic */ +export const HttpStatusCode = { + /** Authentication or permission denied */ + FORBIDDEN: 403, + /** Endpoint not found */ + NOT_FOUND: 404, + /** Resource permanently gone */ + GONE: 410, + /** Protocol upgrade required */ + UPGRADE_REQUIRED: 426, +} as const; + +/** + * WebSocket close codes indicating unrecoverable errors. + * These appear in close events and should stop reconnection attempts. + */ +export const UNRECOVERABLE_WS_CLOSE_CODES = new Set([ + WebSocketCloseCode.PROTOCOL_ERROR, + WebSocketCloseCode.UNSUPPORTED_DATA, +]); + +/** + * HTTP status codes indicating unrecoverable errors during handshake. + * These appear during socket creation and should stop reconnection attempts. + */ +export const UNRECOVERABLE_HTTP_CODES = new Set([ + HttpStatusCode.FORBIDDEN, + HttpStatusCode.GONE, + HttpStatusCode.UPGRADE_REQUIRED, +]); + +/** Close codes indicating intentional closure - do not reconnect */ +export const NORMAL_CLOSURE_CODES = new Set([ + WebSocketCloseCode.NORMAL, + WebSocketCloseCode.GOING_AWAY, +]); diff --git a/src/websocket/eventStreamConnection.ts b/src/websocket/eventStreamConnection.ts index 2dc6514e..e3100ee6 100644 --- a/src/websocket/eventStreamConnection.ts +++ b/src/websocket/eventStreamConnection.ts @@ -1,11 +1,16 @@ import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; import { - type CloseEvent, + type CloseEvent as WsCloseEvent, type Event as WsEvent, - type ErrorEvent, - type MessageEvent, + type ErrorEvent as WsErrorEvent, + type MessageEvent as WsMessageEvent, } from "ws"; +export type Event = Omit; +export type CloseEvent = Omit; +export type ErrorEvent = Omit; +export type MessageEvent = Omit; + // Event payload types matching OneWayWebSocket export type ParsedMessageEvent = Readonly< | { @@ -24,7 +29,7 @@ export type EventPayloadMap = { close: CloseEvent; error: ErrorEvent; message: ParsedMessageEvent; - open: WsEvent; + open: Event; }; export type EventHandler = ( diff --git a/src/websocket/reconnectingWebSocket.ts b/src/websocket/reconnectingWebSocket.ts new file mode 100644 index 00000000..2ced9351 --- /dev/null +++ b/src/websocket/reconnectingWebSocket.ts @@ -0,0 +1,304 @@ +import { + WebSocketCloseCode, + NORMAL_CLOSURE_CODES, + UNRECOVERABLE_WS_CLOSE_CODES, + UNRECOVERABLE_HTTP_CODES, +} from "./codes"; + +import type { WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; + +import type { Logger } from "../logging/logger"; + +import type { + EventHandler, + UnidirectionalStream, +} from "./eventStreamConnection"; + +export type SocketFactory = () => Promise>; + +export type ReconnectingWebSocketOptions = { + initialBackoffMs?: number; + maxBackoffMs?: number; + jitterFactor?: number; +}; + +export class ReconnectingWebSocket + implements UnidirectionalStream +{ + readonly #socketFactory: SocketFactory; + readonly #logger: Logger; + readonly #apiRoute: string; + readonly #options: Required; + readonly #eventHandlers: { + [K in WebSocketEventType]: Set>; + } = { + open: new Set>(), + close: new Set>(), + error: new Set>(), + message: new Set>(), + }; + + #currentSocket: UnidirectionalStream | null = null; + #backoffMs: number; + #reconnectTimeoutId: NodeJS.Timeout | null = null; + #isDisposed = false; + #isConnecting = false; + #pendingReconnect = false; + readonly #onDispose?: () => void; + + private constructor( + socketFactory: SocketFactory, + logger: Logger, + apiRoute: string, + options: ReconnectingWebSocketOptions = {}, + onDispose?: () => void, + ) { + this.#socketFactory = socketFactory; + this.#logger = logger; + this.#apiRoute = apiRoute; + this.#options = { + initialBackoffMs: options.initialBackoffMs ?? 250, + maxBackoffMs: options.maxBackoffMs ?? 30000, + jitterFactor: options.jitterFactor ?? 0.1, + }; + this.#backoffMs = this.#options.initialBackoffMs; + this.#onDispose = onDispose; + } + + static async create( + socketFactory: SocketFactory, + logger: Logger, + apiRoute: string, + options: ReconnectingWebSocketOptions = {}, + onDispose?: () => void, + ): Promise> { + const instance = new ReconnectingWebSocket( + socketFactory, + logger, + apiRoute, + options, + onDispose, + ); + await instance.connect(); + return instance; + } + + get url(): string { + return this.#currentSocket?.url ?? ""; + } + + addEventListener( + event: TEvent, + callback: EventHandler, + ): void { + this.#eventHandlers[event].add(callback); + } + + removeEventListener( + event: TEvent, + callback: EventHandler, + ): void { + this.#eventHandlers[event].delete(callback); + } + + reconnect(): void { + if (this.#isDisposed) { + return; + } + + if (this.#reconnectTimeoutId !== null) { + clearTimeout(this.#reconnectTimeoutId); + this.#reconnectTimeoutId = null; + } + + // If already connecting, schedule reconnect after current attempt + if (this.#isConnecting) { + this.#pendingReconnect = true; + return; + } + + // connect() will close any existing socket + this.connect().catch((error) => this.handleConnectionError(error)); + } + + close(code?: number, reason?: string): void { + if (this.#isDisposed) { + return; + } + + // Fire close handlers synchronously before disposing + if (this.#currentSocket) { + this.executeHandlers("close", { + code: code ?? WebSocketCloseCode.NORMAL, + reason: reason ?? "Normal closure", + wasClean: true, + }); + } + + this.dispose(code, reason); + } + + private async connect(): Promise { + if (this.#isDisposed || this.#isConnecting) { + return; + } + + this.#isConnecting = true; + try { + // Close any existing socket before creating a new one + if (this.#currentSocket) { + this.#currentSocket.close( + WebSocketCloseCode.NORMAL, + "Replacing connection", + ); + this.#currentSocket = null; + } + + const socket = await this.#socketFactory(); + this.#currentSocket = socket; + + socket.addEventListener("open", (event) => { + this.#backoffMs = this.#options.initialBackoffMs; + this.executeHandlers("open", event); + }); + + socket.addEventListener("message", (event) => { + this.executeHandlers("message", event); + }); + + socket.addEventListener("error", (event) => { + this.executeHandlers("error", event); + }); + + socket.addEventListener("close", (event) => { + if (this.#isDisposed) { + return; + } + + this.executeHandlers("close", event); + + if (UNRECOVERABLE_WS_CLOSE_CODES.has(event.code)) { + this.#logger.error( + `WebSocket connection closed with unrecoverable error code ${event.code}`, + ); + this.dispose(); + return; + } + + // Don't reconnect on normal closure + if (NORMAL_CLOSURE_CODES.has(event.code)) { + return; + } + + // Reconnect on abnormal closures (e.g., 1006) or other unexpected codes + this.scheduleReconnect(); + }); + } finally { + this.#isConnecting = false; + + if (this.#pendingReconnect) { + this.#pendingReconnect = false; + this.reconnect(); + } + } + } + + private scheduleReconnect(): void { + if (this.#isDisposed || this.#reconnectTimeoutId !== null) { + return; + } + + const jitter = + this.#backoffMs * this.#options.jitterFactor * (Math.random() * 2 - 1); + const delayMs = Math.max(0, this.#backoffMs + jitter); + + this.#logger.debug( + `Reconnecting WebSocket in ${Math.round(delayMs)}ms for ${this.#apiRoute}`, + ); + + this.#reconnectTimeoutId = setTimeout(() => { + this.#reconnectTimeoutId = null; + this.connect().catch((error) => this.handleConnectionError(error)); + }, delayMs); + + this.#backoffMs = Math.min(this.#backoffMs * 2, this.#options.maxBackoffMs); + } + + private executeHandlers( + event: TEvent, + eventData: Parameters>[0], + ): void { + for (const handler of this.#eventHandlers[event]) { + try { + handler(eventData); + } catch (error) { + this.#logger.error( + `Error in ${event} handler for ${this.#apiRoute}`, + error, + ); + } + } + } + + /** + * Checks if the error is unrecoverable and disposes the connection, + * otherwise schedules a reconnect. + */ + private handleConnectionError(error: unknown): void { + if (this.#isDisposed) { + return; + } + + if (this.isUnrecoverableHttpError(error)) { + this.#logger.error( + `Unrecoverable HTTP error during connection for ${this.#apiRoute}`, + error, + ); + this.dispose(); + return; + } + + this.#logger.warn( + `WebSocket connection failed for ${this.#apiRoute}`, + error, + ); + this.scheduleReconnect(); + } + + /** + * Check if an error contains an unrecoverable HTTP status code. + */ + private isUnrecoverableHttpError(error: unknown): boolean { + const errorMessage = error instanceof Error ? error.message : String(error); + for (const code of UNRECOVERABLE_HTTP_CODES) { + if (errorMessage.includes(String(code))) { + return true; + } + } + return false; + } + + private dispose(code?: number, reason?: string): void { + if (this.#isDisposed) { + return; + } + + this.#isDisposed = true; + + if (this.#reconnectTimeoutId !== null) { + clearTimeout(this.#reconnectTimeoutId); + this.#reconnectTimeoutId = null; + } + + if (this.#currentSocket) { + this.#currentSocket.close(code, reason); + this.#currentSocket = null; + } + + for (const set of Object.values(this.#eventHandlers)) { + set.clear(); + } + + this.#onDispose?.(); + } +} diff --git a/src/websocket/sseConnection.ts b/src/websocket/sseConnection.ts index 5a71d303..dc20eeda 100644 --- a/src/websocket/sseConnection.ts +++ b/src/websocket/sseConnection.ts @@ -6,19 +6,14 @@ import { EventSource } from "eventsource"; import { createStreamingFetchAdapter } from "../api/streamingFetchAdapter"; import { type Logger } from "../logging/logger"; +import { WebSocketCloseCode } from "./codes"; import { getQueryString } from "./utils"; -import type { - CloseEvent as WsCloseEvent, - ErrorEvent as WsErrorEvent, - Event as WsEvent, - MessageEvent as WsMessageEvent, -} from "ws"; - import type { UnidirectionalStream, ParsedMessageEvent, EventHandler, + ErrorEvent as WsErrorEvent, } from "./eventStreamConnection"; export type SseConnectionInit = { @@ -66,7 +61,7 @@ export class SseConnection implements UnidirectionalStream { private setupEventHandlers(): void { this.eventSource.addEventListener("open", () => - this.invokeCallbacks(this.callbacks.open, {} as WsEvent, "open"), + this.invokeCallbacks(this.callbacks.open, {}, "open"), ); this.eventSource.addEventListener("data", (event: MessageEvent) => { @@ -84,10 +79,10 @@ export class SseConnection implements UnidirectionalStream { this.invokeCallbacks( this.callbacks.close, { - code: 1006, + code: WebSocketCloseCode.ABNORMAL, reason: "Connection lost", wasClean: false, - } as WsCloseEvent, + }, "close", ); } @@ -117,7 +112,7 @@ export class SseConnection implements UnidirectionalStream { return { error: error, message: errorMessage, - } as WsErrorEvent; + }; } public addEventListener( @@ -158,7 +153,7 @@ export class SseConnection implements UnidirectionalStream { private parseMessage( event: MessageEvent, ): ParsedMessageEvent { - const wsEvent = { data: event.data } as WsMessageEvent; + const wsEvent = { data: event.data }; try { return { sourceEvent: wsEvent, @@ -207,14 +202,16 @@ export class SseConnection implements UnidirectionalStream { this.invokeCallbacks( this.callbacks.close, { - code: code ?? 1000, + code: code ?? WebSocketCloseCode.NORMAL, reason: reason ?? "Normal closure", wasClean: true, - } as WsCloseEvent, + }, "close", ); - Object.values(this.callbacks).forEach((callbackSet) => callbackSet.clear()); + for (const callbackSet of Object.values(this.callbacks)) { + callbackSet.clear(); + } this.messageWrappers.clear(); } } diff --git a/test/unit/api/coderApi.test.ts b/test/unit/api/coderApi.test.ts index f133a72d..4f90f33e 100644 --- a/test/unit/api/coderApi.test.ts +++ b/test/unit/api/coderApi.test.ts @@ -10,7 +10,7 @@ import { createHttpAgent } from "@/api/utils"; import { CertificateError } from "@/error"; import { getHeaders } from "@/headers"; import { type RequestConfigWithMeta } from "@/logging/types"; -import { OneWayWebSocket } from "@/websocket/oneWayWebSocket"; +import { ReconnectingWebSocket } from "@/websocket/reconnectingWebSocket"; import { SseConnection } from "@/websocket/sseConnection"; import { @@ -332,7 +332,7 @@ describe("CoderApi", () => { const connection = await api.watchAgentMetadata(AGENT_ID); - expect(connection).toBeInstanceOf(OneWayWebSocket); + expect(connection).toBeInstanceOf(ReconnectingWebSocket); expect(EventSource).not.toHaveBeenCalled(); }); @@ -373,6 +373,70 @@ describe("CoderApi", () => { }); }); + describe("Reconnection on Host/Token Changes", () => { + const setupAutoOpeningWebSocket = () => { + const sockets: Array> = []; + vi.mocked(Ws).mockImplementation((url: string | URL) => { + const mockWs = createMockWebSocket(String(url), { + on: vi.fn((event, handler) => { + if (event === "open") { + setImmediate(() => handler()); + } + return mockWs as Ws; + }), + }); + sockets.push(mockWs); + return mockWs as Ws; + }); + return sockets; + }; + + it("triggers reconnection when session token changes", async () => { + const sockets = setupAutoOpeningWebSocket(); + api = createApi(CODER_URL, AXIOS_TOKEN); + await api.watchAgentMetadata(AGENT_ID); + + api.setSessionToken("new-token"); + await new Promise((resolve) => setImmediate(resolve)); + + expect(sockets[0].close).toHaveBeenCalledWith( + 1000, + "Replacing connection", + ); + expect(sockets).toHaveLength(2); + }); + + it("triggers reconnection when host changes", async () => { + const sockets = setupAutoOpeningWebSocket(); + api = createApi(CODER_URL, AXIOS_TOKEN); + const wsWrap = await api.watchAgentMetadata(AGENT_ID); + expect(wsWrap.url).toContain(CODER_URL.replace("http", "ws")); + + api.setHost("https://new-coder.example.com"); + await new Promise((resolve) => setImmediate(resolve)); + + expect(sockets[0].close).toHaveBeenCalledWith( + 1000, + "Replacing connection", + ); + expect(sockets).toHaveLength(2); + expect(wsWrap.url).toContain("wss://new-coder.example.com"); + }); + + it("does not reconnect when token or host are unchanged", async () => { + const sockets = setupAutoOpeningWebSocket(); + api = createApi(CODER_URL, AXIOS_TOKEN); + await api.watchAgentMetadata(AGENT_ID); + + // Same values as before + api.setSessionToken(AXIOS_TOKEN); + api.setHost(CODER_URL); + + expect(sockets[0].close).not.toHaveBeenCalled(); + expect(sockets).toHaveLength(1); + }); + }); + describe("Error Handling", () => { it("throws error when no base URL is set", async () => { const api = createApi(); diff --git a/test/unit/websocket/reconnectingWebSocket.test.ts b/test/unit/websocket/reconnectingWebSocket.test.ts new file mode 100644 index 00000000..cdf08949 --- /dev/null +++ b/test/unit/websocket/reconnectingWebSocket.test.ts @@ -0,0 +1,468 @@ +import { describe, it, expect, vi, beforeEach, afterEach } from "vitest"; + +import { WebSocketCloseCode, HttpStatusCode } from "@/websocket/codes"; +import { + ReconnectingWebSocket, + type SocketFactory, +} from "@/websocket/reconnectingWebSocket"; + +import { createMockLogger } from "../../mocks/testHelpers"; + +import type { CloseEvent, Event as WsEvent } from "ws"; + +import type { UnidirectionalStream } from "@/websocket/eventStreamConnection"; + +describe("ReconnectingWebSocket", () => { + beforeEach(() => { + vi.useFakeTimers(); + }); + + afterEach(() => { + vi.restoreAllMocks(); + vi.useRealTimers(); + }); + + describe("Reconnection Logic", () => { + it("automatically reconnects on abnormal closure (1006)", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + + sockets[0].fireOpen(); + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Network error", + }); + + await vi.advanceTimersByTimeAsync(300); + expect(sockets).toHaveLength(2); + + ws.close(); + }); + + it.each([ + { code: WebSocketCloseCode.NORMAL, name: "Normal Closure" }, + { code: WebSocketCloseCode.GOING_AWAY, name: "Going Away" }, + ])( + "does not reconnect on normal closure: $name ($code)", + async ({ code }) => { + const { ws, sockets } = await createReconnectingWebSocket(); + + sockets[0].fireOpen(); + sockets[0].fireClose({ code, reason: "Normal" }); + + await vi.advanceTimersByTimeAsync(10000); + expect(sockets).toHaveLength(1); + + ws.close(); + }, + ); + + it.each([ + WebSocketCloseCode.PROTOCOL_ERROR, + WebSocketCloseCode.UNSUPPORTED_DATA, + ])( + "does not reconnect on unrecoverable WebSocket close code: %i", + async (code) => { + const { ws, sockets } = await createReconnectingWebSocket(); + + sockets[0].fireOpen(); + sockets[0].fireClose({ code, reason: "Unrecoverable" }); + + await vi.advanceTimersByTimeAsync(10000); + expect(sockets).toHaveLength(1); + + ws.close(); + }, + ); + + it.each([ + HttpStatusCode.FORBIDDEN, + HttpStatusCode.GONE, + HttpStatusCode.UPGRADE_REQUIRED, + ])( + "does not reconnect on unrecoverable HTTP error during creation: %i", + async (statusCode) => { + let socketCreationAttempts = 0; + const factory = vi.fn(() => { + socketCreationAttempts++; + // Simulate HTTP error during WebSocket handshake + return Promise.reject( + new Error(`Unexpected server response: ${statusCode}`), + ); + }); + + await expect( + ReconnectingWebSocket.create( + factory, + createMockLogger(), + "/api/test", + ), + ).rejects.toThrow(`Unexpected server response: ${statusCode}`); + + // Should not retry after unrecoverable HTTP error + await vi.advanceTimersByTimeAsync(10000); + expect(socketCreationAttempts).toBe(1); + }, + ); + + it("reconnect() connects immediately and cancels pending reconnections", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + + sockets[0].fireOpen(); + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Connection lost", + }); + + // Manual reconnect() should happen immediately and cancel the scheduled reconnect + ws.reconnect(); + expect(sockets).toHaveLength(2); + + // Verify pending reconnect was cancelled - no third socket should be created + await vi.advanceTimersByTimeAsync(1000); + expect(sockets).toHaveLength(2); + + ws.close(); + }); + + it("queues reconnect() calls made during connection", async () => { + const sockets: MockSocket[] = []; + let pendingResolve: ((socket: MockSocket) => void) | null = null; + + const factory = vi.fn(() => { + const socket = createMockSocket(); + sockets.push(socket); + + // First call resolves immediately, other calls wait for manual resolve + if (sockets.length === 1) { + return Promise.resolve(socket); + } else { + return new Promise((resolve) => { + pendingResolve = resolve; + }); + } + }); + + const ws = await fromFactory(factory); + sockets[0].fireOpen(); + expect(sockets).toHaveLength(1); + + // Start first reconnect (will block on factory promise) + ws.reconnect(); + expect(sockets).toHaveLength(2); + // Call reconnect again while first reconnect is in progress + ws.reconnect(); + // Still only 2 sockets (queued reconnect hasn't started) + expect(sockets).toHaveLength(2); + + // Complete the first reconnect + pendingResolve!(sockets[1]); + sockets[1].fireOpen(); + + // Wait a tick for the queued reconnect to execute + await Promise.resolve(); + // Now queued reconnect should have executed, creating third socket + expect(sockets).toHaveLength(3); + + ws.close(); + }); + }); + + describe("Event Handlers", () => { + it("persists event handlers across reconnections", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + sockets[0].fireOpen(); + + const handler = vi.fn(); + ws.addEventListener("message", handler); + + // First message + sockets[0].fireMessage({ test: true }); + expect(handler).toHaveBeenCalledTimes(1); + + // Disconnect and reconnect + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Network", + }); + await vi.advanceTimersByTimeAsync(300); + expect(sockets).toHaveLength(2); + sockets[1].fireOpen(); + + // Handler should still work on new socket + sockets[1].fireMessage({ test: true }); + expect(handler).toHaveBeenCalledTimes(2); + + ws.close(); + }); + + it("removes event handlers when removeEventListener is called", async () => { + const socket = createMockSocket(); + const factory = vi.fn(() => Promise.resolve(socket)); + + const ws = await fromFactory(factory); + socket.fireOpen(); + + const handler1 = vi.fn(); + const handler2 = vi.fn(); + + ws.addEventListener("message", handler1); + ws.addEventListener("message", handler2); + ws.removeEventListener("message", handler1); + + socket.fireMessage({ test: true }); + + expect(handler1).not.toHaveBeenCalled(); + expect(handler2).toHaveBeenCalledTimes(1); + + ws.close(); + }); + }); + + describe("close() and Disposal", () => { + it("stops reconnection when close() is called", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + + sockets[0].fireOpen(); + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Network", + }); + ws.close(); + + await vi.advanceTimersByTimeAsync(10000); + expect(sockets).toHaveLength(1); + }); + + it("closes the underlying socket with provided code and reason", async () => { + const socket = createMockSocket(); + const factory = vi.fn(() => Promise.resolve(socket)); + const ws = await fromFactory(factory); + + socket.fireOpen(); + ws.close(WebSocketCloseCode.NORMAL, "Test close"); + + expect(socket.close).toHaveBeenCalledWith( + WebSocketCloseCode.NORMAL, + "Test close", + ); + }); + + it("calls onDispose callback once, even with multiple close() calls", async () => { + let disposeCount = 0; + const { ws } = await createReconnectingWebSocket(() => ++disposeCount); + + ws.close(); + ws.close(); + ws.close(); + + expect(disposeCount).toBe(1); + }); + + it("calls onDispose callback on unrecoverable WebSocket close code", async () => { + let disposeCount = 0; + const { sockets } = await createReconnectingWebSocket( + () => ++disposeCount, + ); + + sockets[0].fireOpen(); + sockets[0].fireClose({ + code: WebSocketCloseCode.PROTOCOL_ERROR, + reason: "Protocol error", + }); + + expect(disposeCount).toBe(1); + }); + + it("does not call onDispose callback during reconnection", async () => { + let disposeCount = 0; + const { ws, sockets } = await createReconnectingWebSocket( + () => ++disposeCount, + ); + + sockets[0].fireOpen(); + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Network error", + }); + + await vi.advanceTimersByTimeAsync(300); + expect(disposeCount).toBe(0); + + ws.close(); + expect(disposeCount).toBe(1); + }); + }); + + describe("Backoff Strategy", () => { + it("doubles backoff delay after each failed connection", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + const socket = sockets[0]; + socket.fireOpen(); + + const backoffDelays = [300, 600, 1200, 2400]; + + // Fail repeatedly + for (let i = 0; i < 4; i++) { + const currentSocket = sockets[i]; + currentSocket.fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Fail", + }); + const delay = backoffDelays[i]; + await vi.advanceTimersByTimeAsync(delay); + const nextSocket = sockets[i + 1]; + nextSocket.fireOpen(); + } + + expect(sockets).toHaveLength(5); + ws.close(); + }); + + it("resets backoff delay after successful connection", async () => { + const { ws, sockets } = await createReconnectingWebSocket(); + const socket1 = sockets[0]; + socket1.fireOpen(); + + // First disconnect + socket1.fireClose({ code: WebSocketCloseCode.ABNORMAL, reason: "Fail" }); + await vi.advanceTimersByTimeAsync(300); + const socket2 = sockets[1]; + socket2.fireOpen(); + + // Second disconnect - should use initial backoff again + socket2.fireClose({ code: WebSocketCloseCode.ABNORMAL, reason: "Fail" }); + await vi.advanceTimersByTimeAsync(300); + + expect(sockets).toHaveLength(3); + ws.close(); + }); + }); + + describe("Error Handling", () => { + it("schedules retry when socket factory throws error", async () => { + const sockets: MockSocket[] = []; + let shouldFail = false; + const factory = vi.fn(() => { + if (shouldFail) { + return Promise.reject(new Error("Factory failed")); + } + const socket = createMockSocket(); + sockets.push(socket); + return Promise.resolve(socket); + }); + const ws = await fromFactory(factory); + + sockets[0].fireOpen(); + + shouldFail = true; + sockets[0].fireClose({ + code: WebSocketCloseCode.ABNORMAL, + reason: "Network", + }); + + await vi.advanceTimersByTimeAsync(300); + expect(sockets).toHaveLength(1); + + ws.close(); + }); + }); +}); + +type MockSocket = UnidirectionalStream & { + fireOpen: () => void; + fireClose: (event: { code: number; reason: string }) => void; + fireMessage: (data: unknown) => void; + fireError: (error: Error) => void; +}; + +function createMockSocket(): MockSocket { + const listeners: { + open: Set<(event: WsEvent) => void>; + close: Set<(event: CloseEvent) => void>; + error: Set<(event: { error?: Error; message?: string }) => void>; + message: Set<(event: unknown) => void>; + } = { + open: new Set(), + close: new Set(), + error: new Set(), + message: new Set(), + }; + + return { + url: "ws://test.example.com/api/test", + addEventListener: vi.fn( + (event: keyof typeof listeners, callback: unknown) => { + (listeners[event] as Set<(data: unknown) => void>).add( + callback as (data: unknown) => void, + ); + }, + ), + removeEventListener: vi.fn( + (event: keyof typeof listeners, callback: unknown) => { + (listeners[event] as Set<(data: unknown) => void>).delete( + callback as (data: unknown) => void, + ); + }, + ), + close: vi.fn(), + fireOpen: () => { + for (const cb of listeners.open) { + cb({} as WsEvent); + } + }, + fireClose: (event: { code: number; reason: string }) => { + for (const cb of listeners.close) { + cb({ + code: event.code, + reason: event.reason, + wasClean: event.code === WebSocketCloseCode.NORMAL, + } as CloseEvent); + } + }, + fireMessage: (data: unknown) => { + for (const cb of listeners.message) { + cb({ + sourceEvent: { data }, + parsedMessage: data, + parseError: undefined, + }); + } + }, + fireError: (error: Error) => { + for (const cb of listeners.error) { + cb({ error, message: error.message }); + } + }, + }; +} + +async function createReconnectingWebSocket(onDispose?: () => void): Promise<{ + ws: ReconnectingWebSocket; + sockets: MockSocket[]; +}> { + const sockets: MockSocket[] = []; + const factory = vi.fn(() => { + const socket = createMockSocket(); + sockets.push(socket); + return Promise.resolve(socket); + }); + const ws = await fromFactory(factory, onDispose); + + // We start with one socket + expect(sockets).toHaveLength(1); + + return { ws, sockets }; +} + +async function fromFactory( + factory: SocketFactory, + onDispose?: () => void, +): Promise> { + return await ReconnectingWebSocket.create( + factory, + createMockLogger(), + "/random/api", + undefined, + onDispose, + ); +} diff --git a/test/unit/websocket/sseConnection.test.ts b/test/unit/websocket/sseConnection.test.ts index 61cfce4d..378e6f54 100644 --- a/test/unit/websocket/sseConnection.test.ts +++ b/test/unit/websocket/sseConnection.test.ts @@ -3,10 +3,14 @@ import { type ServerSentEvent } from "coder/site/src/api/typesGenerated"; import { type WebSocketEventType } from "coder/site/src/utils/OneWayWebSocket"; import { EventSource } from "eventsource"; import { describe, it, expect, vi } from "vitest"; -import { type CloseEvent, type ErrorEvent } from "ws"; import { type Logger } from "@/logging/logger"; -import { type ParsedMessageEvent } from "@/websocket/eventStreamConnection"; +import { WebSocketCloseCode } from "@/websocket/codes"; +import { + type ParsedMessageEvent, + type CloseEvent, + type ErrorEvent, +} from "@/websocket/eventStreamConnection"; import { SseConnection } from "@/websocket/sseConnection"; import { createMockLogger } from "../../mocks/testHelpers"; @@ -168,7 +172,7 @@ describe("SseConnection", () => { await waitForNextTick(); expect(events).toEqual([ { - code: 1006, + code: WebSocketCloseCode.ABNORMAL, reason: "Connection lost", wasClean: false, }, @@ -223,13 +227,17 @@ describe("SseConnection", () => { type CloseHandlingTestCase = [ code: number | undefined, reason: string | undefined, - closeEvent: Omit, + closeEvent: CloseEvent, ]; it.each([ [ undefined, undefined, - { code: 1000, reason: "Normal closure", wasClean: true }, + { + code: WebSocketCloseCode.NORMAL, + reason: "Normal closure", + wasClean: true, + }, ], [ 4000, From 5bfc4a0b799b9cf160edfddd5dbc796f278180b9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:03:37 +0300 Subject: [PATCH 32/55] chore(deps): bump actions/checkout from 5 to 6 (#662) --- .github/workflows/ci.yaml | 6 +++--- .github/workflows/pre-release.yaml | 2 +- .github/workflows/publish-extension.yaml | 2 +- .github/workflows/release.yaml | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 64e85a15..b1b0df6e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: @@ -35,7 +35,7 @@ jobs: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: @@ -51,7 +51,7 @@ jobs: runs-on: ubuntu-22.04 needs: [lint, test] steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: diff --git a/.github/workflows/pre-release.yaml b/.github/workflows/pre-release.yaml index 430aa2a1..4292c968 100644 --- a/.github/workflows/pre-release.yaml +++ b/.github/workflows/pre-release.yaml @@ -16,7 +16,7 @@ jobs: outputs: version: ${{ steps.version.outputs.version }} steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: diff --git a/.github/workflows/publish-extension.yaml b/.github/workflows/publish-extension.yaml index e7d5dca7..804ec048 100644 --- a/.github/workflows/publish-extension.yaml +++ b/.github/workflows/publish-extension.yaml @@ -27,7 +27,7 @@ jobs: hasVscePat: ${{ steps.check-secrets.outputs.hasVscePat }} hasOvsxPat: ${{ steps.check-secrets.outputs.hasOvsxPat }} steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 557586ec..5c71f8c2 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -17,7 +17,7 @@ jobs: outputs: version: ${{ steps.version.outputs.version }} steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: actions/setup-node@v6 with: From ae0a553fe7c3e502ad77b12b2b8a48ee4f60b2e6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:04:35 +0300 Subject: [PATCH 33/55] chore(deps-dev): bump @vscode/vsce from 3.6.2 to 3.7.0 (#651) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index e1946da1..7637acf7 100644 --- a/package.json +++ b/package.json @@ -372,7 +372,7 @@ "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", - "@vscode/vsce": "^3.6.2", + "@vscode/vsce": "^3.7.0", "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", "dayjs": "^1.11.13", diff --git a/yarn.lock b/yarn.lock index b2527a90..9d338260 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1772,10 +1772,10 @@ "@vscode/vsce-sign-win32-arm64" "2.0.5" "@vscode/vsce-sign-win32-x64" "2.0.5" -"@vscode/vsce@^3.6.2": - version "3.6.2" - resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.6.2.tgz#cefd2802f1dec24fca51293ae563e11912f545fd" - integrity sha512-gvBfarWF+Ii20ESqjA3dpnPJpQJ8fFJYtcWtjwbRADommCzGg1emtmb34E+DKKhECYvaVyAl+TF9lWS/3GSPvg== +"@vscode/vsce@^3.7.0": + version "3.7.0" + resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.7.0.tgz#a2a8c0bb414227867c6b246b6fcd84614e5dca7c" + integrity sha512-LY9r2T4joszRjz4d92ZPl6LTBUPS4IWH9gG/3JUv+1QyBJrveZlcVISuiaq0EOpmcgFh0GgVgKD4rD/21Tu8sA== dependencies: "@azure/identity" "^4.1.0" "@secretlint/node" "^10.1.2" From a3c17c5db12712b4e71264ed9e897f3a62be9bc1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:09:15 +0300 Subject: [PATCH 34/55] chore(deps-dev): bump @typescript-eslint/parser from 8.46.2 to 8.46.4 (#652) --- package.json | 2 +- yarn.lock | 84 ++++++++++++++++++++++++++-------------------------- 2 files changed, 43 insertions(+), 43 deletions(-) diff --git a/package.json b/package.json index 7637acf7..8a3d820c 100644 --- a/package.json +++ b/package.json @@ -368,7 +368,7 @@ "@types/vscode": "^1.73.0", "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.44.0", - "@typescript-eslint/parser": "^8.46.2", + "@typescript-eslint/parser": "^8.46.4", "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", diff --git a/yarn.lock b/yarn.lock index 9d338260..45811626 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1361,15 +1361,15 @@ natural-compare "^1.4.0" ts-api-utils "^2.1.0" -"@typescript-eslint/parser@^8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.46.2.tgz#dd938d45d581ac8ffa9d8a418a50282b306f7ebf" - integrity sha512-BnOroVl1SgrPLywqxyqdJ4l3S2MsKVLDVxZvjI1Eoe8ev2r3kGDo+PcMihNmDE+6/KjkTubSJnmqGZZjQSBq/g== - dependencies: - "@typescript-eslint/scope-manager" "8.46.2" - "@typescript-eslint/types" "8.46.2" - "@typescript-eslint/typescript-estree" "8.46.2" - "@typescript-eslint/visitor-keys" "8.46.2" +"@typescript-eslint/parser@^8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.46.4.tgz#1a5bfd48be57bc07eec64e090ac46e89f47ade31" + integrity sha512-tK3GPFWbirvNgsNKto+UmB/cRtn6TZfyw0D6IKrW55n6Vbs7KJoZtI//kpTKzE/DUmmnAFD8/Ca46s7Obs92/w== + dependencies: + "@typescript-eslint/scope-manager" "8.46.4" + "@typescript-eslint/types" "8.46.4" + "@typescript-eslint/typescript-estree" "8.46.4" + "@typescript-eslint/visitor-keys" "8.46.4" debug "^4.3.4" "@typescript-eslint/project-service@8.44.1": @@ -1381,13 +1381,13 @@ "@typescript-eslint/types" "^8.44.1" debug "^4.3.4" -"@typescript-eslint/project-service@8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.46.2.tgz#ab2f02a0de4da6a7eeb885af5e059be57819d608" - integrity sha512-PULOLZ9iqwI7hXcmL4fVfIsBi6AN9YxRc0frbvmg8f+4hQAjQ5GYNKK0DIArNo+rOKmR/iBYwkpBmnIwin4wBg== +"@typescript-eslint/project-service@8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.46.4.tgz#fa9872673b51fb57e5d5da034edbe17424ddd185" + integrity sha512-nPiRSKuvtTN+no/2N1kt2tUh/HoFzeEgOm9fQ6XQk4/ApGqjx0zFIIaLJ6wooR1HIoozvj2j6vTi/1fgAz7UYQ== dependencies: - "@typescript-eslint/tsconfig-utils" "^8.46.2" - "@typescript-eslint/types" "^8.46.2" + "@typescript-eslint/tsconfig-utils" "^8.46.4" + "@typescript-eslint/types" "^8.46.4" debug "^4.3.4" "@typescript-eslint/scope-manager@8.44.1": @@ -1398,23 +1398,23 @@ "@typescript-eslint/types" "8.44.1" "@typescript-eslint/visitor-keys" "8.44.1" -"@typescript-eslint/scope-manager@8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.46.2.tgz#7d37df2493c404450589acb3b5d0c69cc0670a88" - integrity sha512-LF4b/NmGvdWEHD2H4MsHD8ny6JpiVNDzrSZr3CsckEgCbAGZbYM4Cqxvi9L+WqDMT+51Ozy7lt2M+d0JLEuBqA== +"@typescript-eslint/scope-manager@8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.46.4.tgz#78c9b4856c0094def64ffa53ea955b46bec13304" + integrity sha512-tMDbLGXb1wC+McN1M6QeDx7P7c0UWO5z9CXqp7J8E+xGcJuUuevWKxuG8j41FoweS3+L41SkyKKkia16jpX7CA== dependencies: - "@typescript-eslint/types" "8.46.2" - "@typescript-eslint/visitor-keys" "8.46.2" + "@typescript-eslint/types" "8.46.4" + "@typescript-eslint/visitor-keys" "8.46.4" "@typescript-eslint/tsconfig-utils@8.44.1", "@typescript-eslint/tsconfig-utils@^8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.44.1.tgz#e1d9d047078fac37d3e638484ab3b56215963342" integrity sha512-B5OyACouEjuIvof3o86lRMvyDsFwZm+4fBOqFHccIctYgBjqR3qT39FBYGN87khcgf0ExpdCBeGKpKRhSFTjKQ== -"@typescript-eslint/tsconfig-utils@8.46.2", "@typescript-eslint/tsconfig-utils@^8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.46.2.tgz#d110451cb93bbd189865206ea37ef677c196828c" - integrity sha512-a7QH6fw4S57+F5y2FIxxSDyi5M4UfGF+Jl1bCGd7+L4KsaUY80GsiF/t0UoRFDHAguKlBaACWJRmdrc6Xfkkag== +"@typescript-eslint/tsconfig-utils@8.46.4", "@typescript-eslint/tsconfig-utils@^8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.46.4.tgz#989a338093b6b91b0552f1f51331d89ec6980382" + integrity sha512-+/XqaZPIAk6Cjg7NWgSGe27X4zMGqrFqZ8atJsX3CWxH/jACqWnrWI68h7nHQld0y+k9eTTjb9r+KU4twLoo9A== "@typescript-eslint/type-utils@8.44.1": version "8.44.1" @@ -1432,10 +1432,10 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.44.1.tgz#85d1cad1290a003ff60420388797e85d1c3f76ff" integrity sha512-Lk7uj7y9uQUOEguiDIDLYLJOrYHQa7oBiURYVFqIpGxclAFQ78f6VUOM8lI2XEuNOKNB7XuvM2+2cMXAoq4ALQ== -"@typescript-eslint/types@8.46.2", "@typescript-eslint/types@^8.44.1", "@typescript-eslint/types@^8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.46.2.tgz#2bad7348511b31e6e42579820e62b73145635763" - integrity sha512-lNCWCbq7rpg7qDsQrd3D6NyWYu+gkTENkG5IKYhUIcxSb59SQC/hEQ+MrG4sTgBVghTonNWq42bA/d4yYumldQ== +"@typescript-eslint/types@8.46.4", "@typescript-eslint/types@^8.44.1", "@typescript-eslint/types@^8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.46.4.tgz#38022bfda051be80e4120eeefcd2b6e3e630a69b" + integrity sha512-USjyxm3gQEePdUwJBFjjGNG18xY9A2grDVGuk7/9AkjIF1L+ZrVnwR5VAU5JXtUnBL/Nwt3H31KlRDaksnM7/w== "@typescript-eslint/typescript-estree@8.44.1": version "8.44.1" @@ -1453,15 +1453,15 @@ semver "^7.6.0" ts-api-utils "^2.1.0" -"@typescript-eslint/typescript-estree@8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.46.2.tgz#ab547a27e4222bb6a3281cb7e98705272e2c7d08" - integrity sha512-f7rW7LJ2b7Uh2EiQ+7sza6RDZnajbNbemn54Ob6fRwQbgcIn+GWfyuHDHRYgRoZu1P4AayVScrRW+YfbTvPQoQ== +"@typescript-eslint/typescript-estree@8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.46.4.tgz#6a9eeab0da45bf400f22c818e0f47102a980ceaa" + integrity sha512-7oV2qEOr1d4NWNmpXLR35LvCfOkTNymY9oyW+lUHkmCno7aOmIf/hMaydnJBUTBMRCOGZh8YjkFOc8dadEoNGA== dependencies: - "@typescript-eslint/project-service" "8.46.2" - "@typescript-eslint/tsconfig-utils" "8.46.2" - "@typescript-eslint/types" "8.46.2" - "@typescript-eslint/visitor-keys" "8.46.2" + "@typescript-eslint/project-service" "8.46.4" + "@typescript-eslint/tsconfig-utils" "8.46.4" + "@typescript-eslint/types" "8.46.4" + "@typescript-eslint/visitor-keys" "8.46.4" debug "^4.3.4" fast-glob "^3.3.2" is-glob "^4.0.3" @@ -1487,12 +1487,12 @@ "@typescript-eslint/types" "8.44.1" eslint-visitor-keys "^4.2.1" -"@typescript-eslint/visitor-keys@8.46.2": - version "8.46.2" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.46.2.tgz#803fa298948c39acf810af21bdce6f8babfa9738" - integrity sha512-tUFMXI4gxzzMXt4xpGJEsBsTox0XbNQ1y94EwlD/CuZwFcQP79xfQqMhau9HsRc/J0cAPA/HZt1dZPtGn9V/7w== +"@typescript-eslint/visitor-keys@8.46.4": + version "8.46.4" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.46.4.tgz#07031bd8d3ca6474e121221dae1055daead888f1" + integrity sha512-/++5CYLQqsO9HFGLI7APrxBJYo+5OCMpViuhV8q5/Qa3o5mMrF//eQHks+PXcsAVaLdn817fMuS7zqoXNNZGaw== dependencies: - "@typescript-eslint/types" "8.46.2" + "@typescript-eslint/types" "8.46.4" eslint-visitor-keys "^4.2.1" "@typespec/ts-http-runtime@^0.3.0": From 91d481e29836df58ccd50981bf97adeb94172352 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 13:12:58 +0300 Subject: [PATCH 35/55] chore(deps-dev): bump glob from 11.0.3 to 11.1.0 (#655) --- package.json | 2 +- yarn.lock | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/package.json b/package.json index 8a3d820c..39e53111 100644 --- a/package.json +++ b/package.json @@ -384,7 +384,7 @@ "eslint-plugin-md": "^1.0.19", "eslint-plugin-package-json": "^0.59.0", "eslint-plugin-prettier": "^5.5.4", - "glob": "^11.0.3", + "glob": "^11.1.0", "jsonc-eslint-parser": "^2.4.0", "markdown-eslint-parser": "^1.2.1", "memfs": "^4.49.0", diff --git a/yarn.lock b/yarn.lock index 45811626..29728d41 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4528,14 +4528,14 @@ glob@^10.3.10, glob@^10.4.1, glob@^10.4.5: package-json-from-dist "^1.0.0" path-scurry "^1.11.1" -glob@^11.0.0, glob@^11.0.3: - version "11.0.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-11.0.3.tgz#9d8087e6d72ddb3c4707b1d2778f80ea3eaefcd6" - integrity sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA== +glob@^11.0.0, glob@^11.1.0: + version "11.1.0" + resolved "https://registry.yarnpkg.com/glob/-/glob-11.1.0.tgz#4f826576e4eb99c7dad383793d2f9f08f67e50a6" + integrity sha512-vuNwKSaKiqm7g0THUBu2x7ckSs3XJLXE+2ssL7/MfTGPLLcrJQ/4Uq1CjPTtO5cCIiRxqvN6Twy1qOwhL0Xjcw== dependencies: foreground-child "^3.3.1" jackspeak "^4.1.1" - minimatch "^10.0.3" + minimatch "^10.1.1" minipass "^7.1.2" package-json-from-dist "^1.0.0" path-scurry "^2.0.0" @@ -6119,10 +6119,10 @@ mimic-response@^3.1.0: resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-3.1.0.tgz#2d1d59af9c1b129815accc2c46a022a5ce1fa3c9" integrity sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ== -minimatch@^10.0.3: - version "10.0.3" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.0.3.tgz#cf7a0314a16c4d9ab73a7730a0e8e3c3502d47aa" - integrity sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw== +minimatch@^10.1.1: + version "10.1.1" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.1.1.tgz#e6e61b9b0c1dcab116b5a7d1458e8b6ae9e73a55" + integrity sha512-enIvLvRAFZYXJzkCYG5RKmPfrFArdLv+R+lbQ53BmIMLIry74bjKzX6iHAm8WYamJkhSSEabrWN5D97XnKObjQ== dependencies: "@isaacs/brace-expansion" "^5.0.0" From ad7bd78bad8d1483c7047ba7e98f09a8de47645d Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 2 Dec 2025 17:16:59 +0300 Subject: [PATCH 36/55] Remove duplicate "Cancel" button for the update workspace dialog (#664) Closes #657 --- src/commands.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/commands.ts b/src/commands.ts index 682d745b..384b4d79 100644 --- a/src/commands.ts +++ b/src/commands.ts @@ -579,7 +579,6 @@ export class Commands { detail: `Update ${createWorkspaceIdentifier(this.workspace)} to the latest version?\n\nUpdating will restart your workspace which stops any running processes and may result in the loss of unsaved work.`, }, "Update", - "Cancel", ); if (action === "Update") { await this.workspaceRestClient.updateWorkspaceVersion(this.workspace); From 8f7c748531734151b33a980e9e46a9f91996f1b1 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Thu, 4 Dec 2025 17:32:04 +0300 Subject: [PATCH 37/55] Use find-process npm package (#668) --- package.json | 2 +- yarn.lock | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 39e53111..568c6d22 100644 --- a/package.json +++ b/package.json @@ -347,7 +347,7 @@ "axios": "1.12.2", "date-fns": "^3.6.0", "eventsource": "^3.0.6", - "find-process": "https://github.com/coder/find-process#fix/sequoia-compat", + "find-process": "^2.0.0", "jsonc-parser": "^3.3.1", "openpgp": "^6.2.2", "pretty-bytes": "^7.1.0", diff --git a/yarn.lock b/yarn.lock index 29728d41..36579770 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4135,9 +4135,10 @@ find-cache-dir@^3.2.0: make-dir "^3.0.2" pkg-dir "^4.1.0" -"find-process@https://github.com/coder/find-process#fix/sequoia-compat": - version "1.4.10" - resolved "https://github.com/coder/find-process#58804f57e5bdedad72c4319109d3ce2eae09a1ad" +find-process@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/find-process/-/find-process-2.0.0.tgz#0708037e538762835773fe9f3423c4cc5669f8a3" + integrity sha512-YUBQnteWGASJoEVVsOXy6XtKAY2O1FCsWnnvQ8y0YwgY1rZiKeVptnFvMu6RSELZAJOGklqseTnUGGs5D0bKmg== dependencies: chalk "~4.1.2" commander "^12.1.0" From 6d572920f4ee7653c0a73359151164bb4093351d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Dec 2025 21:17:33 +0300 Subject: [PATCH 38/55] chore(deps): bump jws from 3.2.2 to 3.2.3 (#669) --- yarn.lock | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/yarn.lock b/yarn.lock index 36579770..a12a3469 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5734,7 +5734,7 @@ jszip@^3.10.1: readable-stream "~2.3.6" setimmediate "^1.0.5" -jwa@^1.4.1: +jwa@^1.4.2: version "1.4.2" resolved "https://registry.yarnpkg.com/jwa/-/jwa-1.4.2.tgz#16011ac6db48de7b102777e57897901520eec7b9" integrity sha512-eeH5JO+21J78qMvTIDdBXidBd6nG2kZjg5Ohz/1fpa28Z4CcsWUzJ1ZZyFq/3z3N17aZy+ZuBoHljASbL1WfOw== @@ -5744,11 +5744,11 @@ jwa@^1.4.1: safe-buffer "^5.0.1" jws@^3.2.2: - version "3.2.2" - resolved "https://registry.yarnpkg.com/jws/-/jws-3.2.2.tgz#001099f3639468c9414000e99995fa52fb478304" - integrity sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA== + version "3.2.3" + resolved "https://registry.yarnpkg.com/jws/-/jws-3.2.3.tgz#5ac0690b460900a27265de24520526853c0b8ca1" + integrity sha512-byiJ0FLRdLdSVSReO/U4E7RoEyOCKnEnEPMjq3HxWtvzLsV08/i5RQKsFVNkCldrCaPr2vDNAOMsfs8T/Hze7g== dependencies: - jwa "^1.4.1" + jwa "^1.4.2" safe-buffer "^5.0.1" keytar@^7.7.0: From 3a67bc1e50fe35d05368740ca22a71c7ec028126 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 8 Dec 2025 11:03:37 +0300 Subject: [PATCH 39/55] Expand tilde in Coder settings paths (#667) Closes #417 --- CHANGELOG.md | 13 +++++--- src/util.ts | 12 ++++---- test/unit/util.test.ts | 68 +++++++++++++++++++++++++++++++++++++++++- 3 files changed, 83 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b1745b7..a7ebd676 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,16 @@ ## Unreleased +### Added + +- Support for paths that begin with a tilde (`~`). + ### Fixed - Fixed race condition when multiple VS Code windows download the Coder CLI binary simultaneously. Other windows now wait and display real-time progress instead of attempting concurrent downloads, preventing corruption and failures. +- Remove duplicate "Cancel" buttons on the workspace update dialog. ### Changed @@ -15,9 +20,9 @@ ## [v1.11.4](https://github.com/coder/vscode-coder/releases/tag/v1.11.4) 2025-11-20 -### Fixed +### Added -- Add support for `google.antigravity-remote-openssh` Remote SSH extension. +- Support for the `google.antigravity-remote-openssh` Remote SSH extension. ### Changed @@ -55,7 +60,7 @@ ### Changed -- Always enable verbose (`-v`) flag when a log directory is configured (`coder.proxyLogDir`). +- Always enable verbose (`-v`) flag when a log directory is configured (`coder.proxyLogDirectory`). - Automatically start a workspace without prompting if it is explicitly opened but not running. ### Added @@ -134,7 +139,7 @@ ### Added -- Coder extension sidebar now displays available app statuses, and let's +- Coder extension sidebar now displays available app statuses, and lets the user click them to drop into a session with a running AI Agent. ## [v1.7.1](https://github.com/coder/vscode-coder/releases/tag/v1.7.1) (2025-04-14) diff --git a/src/util.ts b/src/util.ts index e7c5c24c..21785cf6 100644 --- a/src/util.ts +++ b/src/util.ts @@ -119,13 +119,14 @@ export function toSafeHost(rawUrl: string): string { } /** - * Expand a path with ${userHome} in the input string - * @param input string - * @returns string + * Expand a path if it starts with tilde (~) or contains ${userHome}. */ export function expandPath(input: string): string { const userHome = os.homedir(); - return input.replace(/\${userHome}/g, userHome); + if (input.startsWith("~")) { + input = userHome + input.substring("~".length); + } + return input.replaceAll("${userHome}", userHome); } /** @@ -145,5 +146,6 @@ export function countSubstring(needle: string, haystack: string): number { } export function escapeCommandArg(arg: string): string { - return `"${arg.replace(/"/g, '\\"')}"`; + const escapedString = arg.replaceAll('"', String.raw`\"`); + return `"${escapedString}"`; } diff --git a/test/unit/util.test.ts b/test/unit/util.test.ts index d508f41c..a5d6eb7a 100644 --- a/test/unit/util.test.ts +++ b/test/unit/util.test.ts @@ -1,6 +1,13 @@ +import os from "node:os"; import { describe, it, expect } from "vitest"; -import { countSubstring, parseRemoteAuthority, toSafeHost } from "@/util"; +import { + countSubstring, + escapeCommandArg, + expandPath, + parseRemoteAuthority, + toSafeHost, +} from "@/util"; it("ignore unrelated authorities", () => { const tests = [ @@ -124,3 +131,62 @@ describe("countSubstring", () => { expect(countSubstring("aa", "aaaaaa")).toBe(3); }); }); + +describe("escapeCommandArg", () => { + it("wraps simple string in quotes", () => { + expect(escapeCommandArg("hello")).toBe('"hello"'); + }); + + it("handles empty string", () => { + expect(escapeCommandArg("")).toBe('""'); + }); + + it("escapes double quotes", () => { + expect(escapeCommandArg('say "hello"')).toBe(String.raw`"say \"hello\""`); + }); + + it("preserves backslashes", () => { + expect(escapeCommandArg(String.raw`path\to\file`)).toBe( + String.raw`"path\to\file"`, + ); + }); + + it("handles string with spaces", () => { + expect(escapeCommandArg("hello world")).toBe('"hello world"'); + }); +}); + +describe("expandPath", () => { + const home = os.homedir(); + + it("expands tilde at start of path", () => { + expect(expandPath("~/foo/bar")).toBe(`${home}/foo/bar`); + }); + + it("expands standalone tilde", () => { + expect(expandPath("~")).toBe(home); + }); + + it("does not expand tilde in middle of path", () => { + expect(expandPath("/foo/~/bar")).toBe("/foo/~/bar"); + }); + + it("expands ${userHome} variable", () => { + expect(expandPath("${userHome}/foo")).toBe(`${home}/foo`); + }); + + it("expands multiple ${userHome} variables", () => { + expect(expandPath("${userHome}/foo/${userHome}/bar")).toBe( + `${home}/foo/${home}/bar`, + ); + }); + + it("leaves paths without tilde or variable unchanged", () => { + expect(expandPath("/absolute/path")).toBe("/absolute/path"); + expect(expandPath("relative/path")).toBe("relative/path"); + }); + + it("expands both tilde and ${userHome}", () => { + expect(expandPath("~/${userHome}/foo")).toBe(`${home}/${home}/foo`); + }); +}); From aad1920b6a2e71f10d9a9c9ea74f07081de4b86a Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 8 Dec 2025 12:20:06 +0300 Subject: [PATCH 40/55] Refactor SSH process monitoring to support VS Code forks (#665) Extract SSH process discovery and network status display into a dedicated `SshProcessMonitor` class. Add centralized Remote SSH extension detection to support Cursor, Windsurf, and other VS Code forks. Key changes: - Extract SSH monitoring logic from `remote.ts` into `sshProcess.ts` - Add `sshExtension.ts` to detect installed Remote SSH extension - Use `createRequire` instead of private `module._load` API to load the Remote SSH extension - Fix port detection to find most recent port and handle SSH reconnects - Add Cursor's "Socks port:" log format to port regex Closes #660 --- CHANGELOG.md | 2 + src/extension.ts | 30 +- src/remote/remote.ts | 225 +++----------- src/remote/sshExtension.ts | 25 ++ src/remote/sshProcess.ts | 447 ++++++++++++++++++++++++++++ src/util.ts | 33 +- test/mocks/testHelpers.ts | 61 +++- test/mocks/vscode.runtime.ts | 32 +- test/unit/remote/sshProcess.test.ts | 442 +++++++++++++++++++++++++++ test/unit/util.test.ts | 220 ++++++++------ 10 files changed, 1197 insertions(+), 320 deletions(-) create mode 100644 src/remote/sshExtension.ts create mode 100644 src/remote/sshProcess.ts create mode 100644 test/unit/remote/sshProcess.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index a7ebd676..425ed11a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,8 @@ - WebSocket connections now automatically reconnect on network failures, improving reliability when communicating with Coder deployments. +- Improved SSH process and log file discovery with better reconnect handling and support for + VS Code forks (Cursor, Windsurf, Antigravity). ## [v1.11.4](https://github.com/coder/vscode-coder/releases/tag/v1.11.4) 2025-11-20 diff --git a/src/extension.ts b/src/extension.ts index 9751b0f7..974cbe7d 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -2,7 +2,8 @@ import axios, { isAxiosError } from "axios"; import { getErrorMessage } from "coder/site/src/api/errors"; -import * as module from "module"; +import { createRequire } from "node:module"; +import * as path from "node:path"; import * as vscode from "vscode"; import { errToStr } from "./api/api-helper"; @@ -14,6 +15,7 @@ import { AuthAction } from "./core/secretsManager"; import { CertificateError, getErrorDetail } from "./error"; import { maybeAskUrl } from "./promptUtils"; import { Remote } from "./remote/remote"; +import { getRemoteSshExtension } from "./remote/sshExtension"; import { toSafeHost } from "./util"; import { WorkspaceProvider, @@ -33,30 +35,21 @@ export async function activate(ctx: vscode.ExtensionContext): Promise { // Cursor and VSCode are covered by ms remote, and the only other is windsurf for now // Means that vscodium is not supported by this for now - const remoteSSHExtension = - vscode.extensions.getExtension("jeanp413.open-remote-ssh") || - vscode.extensions.getExtension("codeium.windsurf-remote-openssh") || - vscode.extensions.getExtension("anysphere.remote-ssh") || - vscode.extensions.getExtension("ms-vscode-remote.remote-ssh") || - vscode.extensions.getExtension("google.antigravity-remote-openssh"); + const remoteSshExtension = getRemoteSshExtension(); let vscodeProposed: typeof vscode = vscode; - if (!remoteSSHExtension) { + if (remoteSshExtension) { + const extensionRequire = createRequire( + path.join(remoteSshExtension.extensionPath, "package.json"), + ); + vscodeProposed = extensionRequire("vscode"); + } else { vscode.window.showErrorMessage( "Remote SSH extension not found, this may not work as expected.\n" + // NB should we link to documentation or marketplace? "Please install your choice of Remote SSH extension from the VS Code Marketplace.", ); - } else { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - vscodeProposed = (module as any)._load( - "vscode", - { - filename: remoteSSHExtension.extensionPath, - }, - false, - ); } const serviceContainer = new ServiceContainer(ctx, vscodeProposed); @@ -366,11 +359,12 @@ export async function activate(ctx: vscode.ExtensionContext): Promise { // after the Coder extension is installed, instead of throwing a fatal error // (this would require the user to uninstall the Coder extension and // reinstall after installing the remote SSH extension, which is annoying) - if (remoteSSHExtension && vscodeProposed.env.remoteAuthority) { + if (remoteSshExtension && vscodeProposed.env.remoteAuthority) { try { const details = await remote.setup( vscodeProposed.env.remoteAuthority, isFirstConnect, + remoteSshExtension.id, ); if (details) { ctx.subscriptions.push(details); diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 1edf351c..4193e46d 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -4,12 +4,10 @@ import { type Workspace, type WorkspaceAgent, } from "coder/site/src/api/typesGenerated"; -import find from "find-process"; import * as jsonc from "jsonc-parser"; import * as fs from "node:fs/promises"; import * as os from "node:os"; import * as path from "node:path"; -import prettyBytes from "pretty-bytes"; import * as semver from "semver"; import * as vscode from "vscode"; @@ -36,12 +34,12 @@ import { AuthorityPrefix, escapeCommandArg, expandPath, - findPort, parseRemoteAuthority, } from "../util"; import { WorkspaceMonitor } from "../workspace/workspaceMonitor"; import { SSHConfig, type SSHValues, mergeSSHConfigValues } from "./sshConfig"; +import { SshProcessMonitor } from "./sshProcess"; import { computeSSHProperties, sshSupportsSetEnv } from "./sshSupport"; import { WorkspaceStateMachine } from "./workspaceStateMachine"; @@ -109,6 +107,7 @@ export class Remote { public async setup( remoteAuthority: string, firstConnect: boolean, + remoteSshExtensionId: string, ): Promise { const parts = parseRemoteAuthority(remoteAuthority); if (!parts) { @@ -148,7 +147,7 @@ export class Remote { ]); if (result.type === "login") { - return this.setup(remoteAuthority, firstConnect); + return this.setup(remoteAuthority, firstConnect, remoteSshExtensionId); } else if (!result.userChoice) { // User declined to log in. await this.closeRemote(); @@ -156,7 +155,7 @@ export class Remote { } else { // Log in then try again. await this.commands.login({ url: baseUrlRaw, label: parts.label }); - return this.setup(remoteAuthority, firstConnect); + return this.setup(remoteAuthority, firstConnect, remoteSshExtensionId); } }; @@ -485,30 +484,26 @@ export class Remote { throw error; } - // TODO: This needs to be reworked; it fails to pick up reconnects. - this.findSSHProcessID().then(async (pid) => { - if (!pid) { - // TODO: Show an error here! - return; - } - disposables.push(this.showNetworkUpdates(pid)); - if (logDir) { - const logFiles = await fs.readdir(logDir); - const logFileName = logFiles - .reverse() - .find( - (file) => file === `${pid}.log` || file.endsWith(`-${pid}.log`), - ); - this.commands.workspaceLogPath = logFileName - ? path.join(logDir, logFileName) - : undefined; - } else { - this.commands.workspaceLogPath = undefined; - } + // Monitor SSH process and display network status + const sshMonitor = SshProcessMonitor.start({ + sshHost: parts.host, + networkInfoPath: this.pathResolver.getNetworkInfoPath(), + proxyLogDir: logDir || undefined, + logger: this.logger, + codeLogDir: this.pathResolver.getCodeLogDir(), + remoteSshExtensionId, }); + disposables.push(sshMonitor); + + this.commands.workspaceLogPath = sshMonitor.getLogFilePath(); - // Register the label formatter again because SSH overrides it! disposables.push( + sshMonitor.onLogFilePathChange((newPath) => { + this.commands.workspaceLogPath = newPath; + }), + // Watch for logDir configuration changes + this.watchLogDirSetting(logDir, featureSet), + // Register the label formatter again because SSH overrides it! vscode.extensions.onDidChange(() => { // Dispose previous label formatter labelFormatterDisposable.dispose(); @@ -741,172 +736,30 @@ export class Remote { 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 { - const networkStatus = vscode.window.createStatusBarItem( - vscode.StatusBarAlignment.Left, - 1000, - ); - const networkInfoFile = path.join( - this.pathResolver.getNetworkInfoPath(), - `${sshPid}.json`, - ); - - const updateStatus = (network: { - p2p: boolean; - latency: number; - preferred_derp: string; - derp_latency: { [key: string]: number }; - upload_bytes_sec: number; - download_bytes_sec: number; - using_coder_connect: boolean; - }) => { - let statusText = "$(globe) "; - - // Coder Connect doesn't populate any other stats - if (network.using_coder_connect) { - networkStatus.text = statusText + "Coder Connect "; - networkStatus.tooltip = "You're connected using Coder Connect."; - networkStatus.show(); + private watchLogDirSetting( + currentLogDir: string, + featureSet: FeatureSet, + ): vscode.Disposable { + return vscode.workspace.onDidChangeConfiguration((e) => { + if (!e.affectsConfiguration("coder.proxyLogDirectory")) { return; } - - if (network.p2p) { - statusText += "Direct "; - networkStatus.tooltip = "You're connected peer-to-peer ✨."; - } else { - statusText += network.preferred_derp + " "; - networkStatus.tooltip = - "You're connected through a relay 🕵.\nWe'll switch over to peer-to-peer when available."; - } - networkStatus.tooltip += - "\n\nDownload ↓ " + - prettyBytes(network.download_bytes_sec, { - bits: true, - }) + - "/s • Upload ↑ " + - prettyBytes(network.upload_bytes_sec, { - bits: true, - }) + - "/s\n"; - - if (!network.p2p) { - const derpLatency = network.derp_latency[network.preferred_derp]; - - networkStatus.tooltip += `You ↔ ${derpLatency.toFixed(2)}ms ↔ ${network.preferred_derp} ↔ ${(network.latency - derpLatency).toFixed(2)}ms ↔ Workspace`; - - let first = true; - Object.keys(network.derp_latency).forEach((region) => { - if (region === network.preferred_derp) { - return; - } - if (first) { - networkStatus.tooltip += `\n\nOther regions:`; - first = false; - } - networkStatus.tooltip += `\n${region}: ${Math.round(network.derp_latency[region] * 100) / 100}ms`; - }); - } - - statusText += "(" + network.latency.toFixed(2) + "ms)"; - networkStatus.text = statusText; - networkStatus.show(); - }; - let disposed = false; - const periodicRefresh = () => { - if (disposed) { + const newLogDir = this.getLogDir(featureSet); + if (newLogDir === currentLogDir) { return; } - fs.readFile(networkInfoFile, "utf8") - .then((content) => { - return JSON.parse(content); - }) - .then((parsed) => { - try { - updateStatus(parsed); - } catch { - // Ignore + + vscode.window + .showInformationMessage( + "Log directory configuration changed. Reload window to apply.", + "Reload", + ) + .then((action) => { + if (action === "Reload") { + vscode.commands.executeCommand("workbench.action.reloadWindow"); } - }) - .catch(() => { - // TODO: Log a failure here! - }) - .finally(() => { - // This matches the write interval of `coder vscodessh`. - setTimeout(periodicRefresh, 3000); }); - }; - periodicRefresh(); - - return { - dispose: () => { - disposed = true; - networkStatus.dispose(); - }, - }; - } - - // findSSHProcessID returns the currently active SSH process ID that is - // powering the remote SSH connection. - private async findSSHProcessID(timeout = 15000): Promise { - const search = async (logPath: string): Promise => { - // This searches for the socksPort that Remote SSH is connecting to. We do - // this to find the SSH process that is powering this connection. That SSH - // process will be logging network information periodically to a file. - const text = await fs.readFile(logPath, "utf8"); - const port = findPort(text); - if (!port) { - return; - } - const processes = await find("port", port); - if (processes.length < 1) { - return; - } - const process = processes[0]; - return process.pid; - }; - const start = Date.now(); - const loop = async (): Promise => { - if (Date.now() - start > timeout) { - return undefined; - } - // Loop until we find the remote SSH log for this window. - const filePath = await this.getRemoteSSHLogPath(); - if (!filePath) { - return new Promise((resolve) => setTimeout(() => resolve(loop()), 500)); - } - // Then we search the remote SSH log until we find the port. - const result = await search(filePath); - if (!result) { - return new Promise((resolve) => setTimeout(() => resolve(loop()), 500)); - } - return result; - }; - return loop(); - } - - /** - * Returns the log path for the "Remote - SSH" output panel. There is no VS - * Code API to get the contents of an output panel. We use this to get the - * active port so we can display network information. - */ - private async getRemoteSSHLogPath(): Promise { - const upperDir = path.dirname(this.pathResolver.getCodeLogDir()); - // Node returns these directories sorted already! - const dirs = await fs.readdir(upperDir); - const latestOutput = dirs - .reverse() - .filter((dir) => dir.startsWith("output_logging_")); - if (latestOutput.length === 0) { - return undefined; - } - const dir = await fs.readdir(path.join(upperDir, latestOutput[0])); - const remoteSSH = dir.filter((file) => file.indexOf("Remote - SSH") !== -1); - if (remoteSSH.length === 0) { - return undefined; - } - return path.join(upperDir, latestOutput[0], remoteSSH[0]); + }); } /** diff --git a/src/remote/sshExtension.ts b/src/remote/sshExtension.ts new file mode 100644 index 00000000..70ed849d --- /dev/null +++ b/src/remote/sshExtension.ts @@ -0,0 +1,25 @@ +import * as vscode from "vscode"; + +export const REMOTE_SSH_EXTENSION_IDS = [ + "jeanp413.open-remote-ssh", + "codeium.windsurf-remote-openssh", + "anysphere.remote-ssh", + "ms-vscode-remote.remote-ssh", + "google.antigravity-remote-openssh", +] as const; + +export type RemoteSshExtensionId = (typeof REMOTE_SSH_EXTENSION_IDS)[number]; + +type RemoteSshExtension = vscode.Extension & { + id: RemoteSshExtensionId; +}; + +export function getRemoteSshExtension(): RemoteSshExtension | undefined { + for (const id of REMOTE_SSH_EXTENSION_IDS) { + const extension = vscode.extensions.getExtension(id); + if (extension) { + return extension as RemoteSshExtension; + } + } + return undefined; +} diff --git a/src/remote/sshProcess.ts b/src/remote/sshProcess.ts new file mode 100644 index 00000000..e86cf154 --- /dev/null +++ b/src/remote/sshProcess.ts @@ -0,0 +1,447 @@ +import find from "find-process"; +import * as fs from "node:fs/promises"; +import * as path from "node:path"; +import prettyBytes from "pretty-bytes"; +import * as vscode from "vscode"; + +import { type Logger } from "../logging/logger"; +import { findPort } from "../util"; + +/** + * Network information from the Coder CLI. + */ +export interface NetworkInfo { + p2p: boolean; + latency: number; + preferred_derp: string; + derp_latency: { [key: string]: number }; + upload_bytes_sec: number; + download_bytes_sec: number; + using_coder_connect: boolean; +} + +/** + * Options for creating an SshProcessMonitor. + */ +export interface SshProcessMonitorOptions { + sshHost: string; + networkInfoPath: string; + proxyLogDir?: string; + logger: Logger; + // Initial poll interval for SSH process and file discovery (ms) + discoveryPollIntervalMs?: number; + // Maximum backoff interval for process and file discovery (ms) + maxDiscoveryBackoffMs?: number; + // Poll interval for network info updates + networkPollInterval?: number; + // For port-based SSH process discovery + codeLogDir: string; + remoteSshExtensionId: string; +} + +/** + * Monitors the SSH process for a Coder workspace connection and displays + * network status in the VS Code status bar. + */ +export class SshProcessMonitor implements vscode.Disposable { + private readonly statusBarItem: vscode.StatusBarItem; + private readonly options: Required< + SshProcessMonitorOptions & { proxyLogDir: string | undefined } + >; + + private readonly _onLogFilePathChange = new vscode.EventEmitter< + string | undefined + >(); + private readonly _onPidChange = new vscode.EventEmitter(); + + /** + * Event fired when the log file path changes (e.g., after reconnecting to a new process). + */ + public readonly onLogFilePathChange = this._onLogFilePathChange.event; + + /** + * Event fired when the SSH process PID changes (e.g., after reconnecting). + */ + public readonly onPidChange = this._onPidChange.event; + + private disposed = false; + private currentPid: number | undefined; + private logFilePath: string | undefined; + private pendingTimeout: NodeJS.Timeout | undefined; + private lastStaleSearchTime = 0; + + private constructor(options: SshProcessMonitorOptions) { + this.options = { + ...options, + proxyLogDir: options.proxyLogDir, + discoveryPollIntervalMs: options.discoveryPollIntervalMs ?? 1000, + maxDiscoveryBackoffMs: options.maxDiscoveryBackoffMs ?? 30_000, + // Matches the SSH update interval + networkPollInterval: options.networkPollInterval ?? 3000, + }; + this.statusBarItem = vscode.window.createStatusBarItem( + vscode.StatusBarAlignment.Left, + 1000, + ); + } + + /** + * Creates and starts an SSH process monitor. + * Begins searching for the SSH process in the background. + */ + public static start(options: SshProcessMonitorOptions): SshProcessMonitor { + const monitor = new SshProcessMonitor(options); + monitor.searchForProcess().catch((err) => { + options.logger.error("Error in SSH process monitor", err); + }); + return monitor; + } + + /** + * Returns the path to the log file for this connection, or undefined if not found. + */ + getLogFilePath(): string | undefined { + return this.logFilePath; + } + + /** + * Cleans up resources and stops monitoring. + */ + dispose(): void { + if (this.disposed) { + return; + } + this.disposed = true; + if (this.pendingTimeout) { + clearTimeout(this.pendingTimeout); + this.pendingTimeout = undefined; + } + this.statusBarItem.dispose(); + this._onLogFilePathChange.dispose(); + this._onPidChange.dispose(); + } + + /** + * Delays for the specified duration. Returns early if disposed. + */ + private async delay(ms: number): Promise { + if (this.disposed) { + return; + } + await new Promise((resolve) => { + this.pendingTimeout = setTimeout(() => { + this.pendingTimeout = undefined; + resolve(); + }, ms); + }); + } + + /** + * Searches for the SSH process indefinitely until found or disposed. + * Starts monitoring when it finds the process through the port. + */ + private async searchForProcess(): Promise { + const { discoveryPollIntervalMs, maxDiscoveryBackoffMs, logger, sshHost } = + this.options; + let attempt = 0; + let currentBackoff = discoveryPollIntervalMs; + + while (!this.disposed) { + attempt++; + + if (attempt === 1 || attempt % 10 === 0) { + logger.debug( + `SSH process search attempt ${attempt} for host: ${sshHost}`, + ); + } + + const pidByPort = await this.findSshProcessByPort(); + if (pidByPort !== undefined) { + this.setCurrentPid(pidByPort); + this.startMonitoring(); + return; + } + + await this.delay(currentBackoff); + currentBackoff = Math.min(currentBackoff * 2, maxDiscoveryBackoffMs); + } + } + + /** + * Finds SSH process by parsing the Remote SSH extension's log to get the port. + * This is more accurate as each VS Code window has a unique port. + */ + private async findSshProcessByPort(): Promise { + const { codeLogDir, remoteSshExtensionId, logger } = this.options; + + try { + const logPath = await findRemoteSshLogPath( + codeLogDir, + remoteSshExtensionId, + logger, + ); + if (!logPath) { + return undefined; + } + + const logContent = await fs.readFile(logPath, "utf8"); + this.options.logger.debug(`Read Remote SSH log file:`, logPath); + + const port = findPort(logContent); + if (!port) { + return undefined; + } + this.options.logger.debug(`Found SSH port ${port} in log file`); + + const processes = await find("port", port); + if (processes.length === 0) { + return undefined; + } + + return processes[0].pid; + } catch (error) { + logger.debug(`Port-based SSH process search failed: ${error}`); + return undefined; + } + } + + /** + * Updates the current PID and fires change events. + */ + private setCurrentPid(pid: number): void { + const previousPid = this.currentPid; + this.currentPid = pid; + + if (previousPid === undefined) { + this.options.logger.info(`SSH connection established (PID: ${pid})`); + this._onPidChange.fire(pid); + } else if (previousPid !== pid) { + this.options.logger.info( + `SSH process changed from ${previousPid} to ${pid}`, + ); + this.logFilePath = undefined; + this._onLogFilePathChange.fire(undefined); + this._onPidChange.fire(pid); + } + } + + /** + * Starts monitoring tasks after finding the SSH process. + */ + private startMonitoring(): void { + if (this.disposed || this.currentPid === undefined) { + return; + } + this.searchForLogFile(); + this.monitorNetwork(); + } + + /** + * Searches for the log file for the current PID. + * Polls until found or PID changes. + */ + private async searchForLogFile(): Promise { + const { + proxyLogDir: logDir, + logger, + discoveryPollIntervalMs, + maxDiscoveryBackoffMs, + } = this.options; + if (!logDir) { + return; + } + + let currentBackoff = discoveryPollIntervalMs; + + const targetPid = this.currentPid; + while (!this.disposed && this.currentPid === targetPid) { + try { + const logFiles = await fs.readdir(logDir); + logFiles.reverse(); + const logFileName = logFiles.find( + (file) => + file === `${targetPid}.log` || file.endsWith(`-${targetPid}.log`), + ); + + if (logFileName) { + const foundPath = path.join(logDir, logFileName); + if (foundPath !== this.logFilePath) { + this.logFilePath = foundPath; + logger.info(`Log file found: ${this.logFilePath}`); + this._onLogFilePathChange.fire(this.logFilePath); + } + return; + } + } catch { + logger.debug(`Could not read log directory: ${logDir}`); + } + + await this.delay(currentBackoff); + currentBackoff = Math.min(currentBackoff * 2, maxDiscoveryBackoffMs); + } + } + + /** + * Monitors network info and updates the status bar. + * Checks file mtime to detect stale connections and trigger reconnection search. + */ + private async monitorNetwork(): Promise { + const { networkInfoPath, networkPollInterval, logger } = this.options; + const staleThreshold = networkPollInterval * 5; + + while (!this.disposed && this.currentPid !== undefined) { + const networkInfoFile = path.join( + networkInfoPath, + `${this.currentPid}.json`, + ); + + try { + const stats = await fs.stat(networkInfoFile); + const ageMs = Date.now() - stats.mtime.getTime(); + + if (ageMs > staleThreshold) { + // Prevent tight loop: if we just searched due to stale, wait before searching again + const timeSinceLastSearch = Date.now() - this.lastStaleSearchTime; + if (timeSinceLastSearch < staleThreshold) { + await this.delay(staleThreshold - timeSinceLastSearch); + continue; + } + + logger.debug( + `Network info stale (${Math.round(ageMs / 1000)}s old), searching for new SSH process`, + ); + + // searchForProcess will update PID if a different process is found + this.lastStaleSearchTime = Date.now(); + await this.searchForProcess(); + return; + } + + const content = await fs.readFile(networkInfoFile, "utf8"); + const network = JSON.parse(content) as NetworkInfo; + const isStale = ageMs > this.options.networkPollInterval * 2; + this.updateStatusBar(network, isStale); + } catch (error) { + logger.debug( + `Failed to read network info: ${(error as Error).message}`, + ); + } + + await this.delay(networkPollInterval); + } + } + + /** + * Updates the status bar with network information. + */ + private updateStatusBar(network: NetworkInfo, isStale: boolean): void { + let statusText = "$(globe) "; + + // Coder Connect doesn't populate any other stats + if (network.using_coder_connect) { + this.statusBarItem.text = statusText + "Coder Connect "; + this.statusBarItem.tooltip = "You're connected using Coder Connect."; + this.statusBarItem.show(); + return; + } + + if (network.p2p) { + statusText += "Direct "; + this.statusBarItem.tooltip = "You're connected peer-to-peer ✨."; + } else { + statusText += network.preferred_derp + " "; + this.statusBarItem.tooltip = + "You're connected through a relay 🕵.\nWe'll switch over to peer-to-peer when available."; + } + + let tooltip = this.statusBarItem.tooltip; + tooltip += + "\n\nDownload ↓ " + + prettyBytes(network.download_bytes_sec, { bits: true }) + + "/s • Upload ↑ " + + prettyBytes(network.upload_bytes_sec, { bits: true }) + + "/s\n"; + + if (!network.p2p) { + const derpLatency = network.derp_latency[network.preferred_derp]; + tooltip += `You ↔ ${derpLatency.toFixed(2)}ms ↔ ${network.preferred_derp} ↔ ${(network.latency - derpLatency).toFixed(2)}ms ↔ Workspace`; + + let first = true; + for (const region of Object.keys(network.derp_latency)) { + if (region === network.preferred_derp) { + continue; + } + if (first) { + tooltip += `\n\nOther regions:`; + first = false; + } + tooltip += `\n${region}: ${Math.round(network.derp_latency[region] * 100) / 100}ms`; + } + } + + this.statusBarItem.tooltip = tooltip; + const latencyText = isStale + ? `(~${network.latency.toFixed(2)}ms)` + : `(${network.latency.toFixed(2)}ms)`; + statusText += latencyText; + this.statusBarItem.text = statusText; + this.statusBarItem.show(); + } +} + +/** + * Finds the Remote SSH extension's log file path. + * Tries extension-specific folder first (Cursor, Windsurf, Antigravity), + * then output_logging_ fallback (MS VS Code). + */ +async function findRemoteSshLogPath( + codeLogDir: string, + extensionId: string, + logger: Logger, +): Promise { + const logsParentDir = path.dirname(codeLogDir); + + // Try extension-specific folder (for VS Code clones like Cursor, Windsurf) + try { + const extensionLogDir = path.join(logsParentDir, extensionId); + // Node returns these directories sorted already! + const files = await fs.readdir(extensionLogDir); + files.reverse(); + + const remoteSsh = files.find((file) => file.includes("Remote - SSH")); + if (remoteSsh) { + return path.join(extensionLogDir, remoteSsh); + } + // Folder exists but no Remote SSH log yet + logger.debug( + `Extension log folder exists but no Remote SSH log found: ${extensionLogDir}`, + ); + } catch { + // Extension-specific folder doesn't exist - expected for MS VS Code, try fallback + } + + try { + // Node returns these directories sorted already! + const dirs = await fs.readdir(logsParentDir); + dirs.reverse(); + const outputDirs = dirs.filter((d) => d.startsWith("output_logging_")); + + if (outputDirs.length > 0) { + const outputPath = path.join(logsParentDir, outputDirs[0]); + const files = await fs.readdir(outputPath); + const remoteSSHLog = files.find((f) => f.includes("Remote - SSH")); + if (remoteSSHLog) { + return path.join(outputPath, remoteSSHLog); + } + logger.debug( + `Output logging folder exists but no Remote SSH log found: ${outputPath}`, + ); + } else { + logger.debug(`No output_logging_ folders found in: ${logsParentDir}`); + } + } catch { + logger.debug(`Could not read logs parent directory: ${logsParentDir}`); + } + + return undefined; +} diff --git a/src/util.ts b/src/util.ts index 21785cf6..776ba1db 100644 --- a/src/util.ts +++ b/src/util.ts @@ -1,5 +1,5 @@ -import * as os from "os"; -import url from "url"; +import * as os from "node:os"; +import url from "node:url"; export interface AuthorityParts { agent: string | undefined; @@ -13,27 +13,32 @@ export interface AuthorityParts { // they should be handled by this extension. export const AuthorityPrefix = "coder-vscode"; -// `ms-vscode-remote.remote-ssh`: `-> socksPort ->` -// `codeium.windsurf-remote-openssh`, `jeanp413.open-remote-ssh`: `=> (socks) =>` -// Windows `ms-vscode-remote.remote-ssh`: `between local port ` +// Regex patterns to find the SSH port from Remote SSH extension logs. +// `ms-vscode-remote.remote-ssh`: `-> socksPort ->` or `between local port ` +// `codeium.windsurf-remote-openssh`, `jeanp413.open-remote-ssh`, `google.antigravity-remote-openssh`: `=> (socks) =>` +// `anysphere.remote-ssh`: `Socks port: ` export const RemoteSSHLogPortRegex = - /(?:-> socksPort (\d+) ->|=> (\d+)\(socks\) =>|between local port (\d+))/; + /(?:-> socksPort (\d+) ->|between local port (\d+)|=> (\d+)\(socks\) =>|Socks port: (\d+))/g; /** - * Given the contents of a Remote - SSH log file, find a port number used by the - * SSH process. This is typically the socks port, but the local port works too. + * Given the contents of a Remote - SSH log file, find the most recent port + * number used by the SSH process. This is typically the socks port, but the + * local port works too. * * Returns null if no port is found. */ export function findPort(text: string): number | null { - const matches = text.match(RemoteSSHLogPortRegex); - if (!matches) { + const allMatches = [...text.matchAll(RemoteSSHLogPortRegex)]; + if (allMatches.length === 0) { return null; } - if (matches.length < 2) { - return null; - } - const portStr = matches[1] || matches[2] || matches[3]; + + // Get the last match, which is the most recent port. + const lastMatch = allMatches.at(-1)!; + // Each capture group corresponds to a different Remote SSH extension log format: + // [0] full match, [1] and [2] ms-vscode-remote.remote-ssh, + // [3] windsurf/open-remote-ssh/antigravity, [4] anysphere.remote-ssh + const portStr = lastMatch[1] || lastMatch[2] || lastMatch[3] || lastMatch[4]; if (!portStr) { return null; } diff --git a/test/mocks/testHelpers.ts b/test/mocks/testHelpers.ts index faf2a72d..5678cd48 100644 --- a/test/mocks/testHelpers.ts +++ b/test/mocks/testHelpers.ts @@ -29,7 +29,7 @@ export class MockConfigurationProvider { get(key: string, defaultValue: T): T; get(key: string, defaultValue?: T): T | undefined { const value = this.config.get(key); - return value !== undefined ? (value as T) : defaultValue; + return value === undefined ? defaultValue : (value as T); } /** @@ -53,7 +53,7 @@ export class MockConfigurationProvider { return { get: vi.fn((key: string, defaultValue?: unknown) => { const value = snapshot.get(getFullKey(key)); - return value !== undefined ? value : defaultValue; + return value === undefined ? defaultValue : value; }), has: vi.fn((key: string) => { return snapshot.has(getFullKey(key)); @@ -141,7 +141,7 @@ export class MockProgressReporter { * Use this to control user responses in tests. */ export class MockUserInteraction { - private responses = new Map(); + private readonly responses = new Map(); private externalUrls: string[] = []; constructor() { @@ -211,7 +211,7 @@ export class MockUserInteraction { // Simple in-memory implementation of Memento export class InMemoryMemento implements vscode.Memento { - private storage = new Map(); + private readonly storage = new Map(); get(key: string): T | undefined; get(key: string, defaultValue: T): T; @@ -235,9 +235,11 @@ export class InMemoryMemento implements vscode.Memento { // Simple in-memory implementation of SecretStorage export class InMemorySecretStorage implements vscode.SecretStorage { - private secrets = new Map(); + private readonly secrets = new Map(); private isCorrupted = false; - private listeners: Array<(e: vscode.SecretStorageChangeEvent) => void> = []; + private readonly listeners: Array< + (e: vscode.SecretStorageChangeEvent) => void + > = []; onDidChange: vscode.Event = (listener) => { this.listeners.push(listener); @@ -350,3 +352,50 @@ export function createMockStream( destroy: vi.fn(), } as unknown as IncomingMessage; } + +/** + * Mock status bar that integrates with vscode.window.createStatusBarItem. + * Use this to inspect status bar state in tests. + */ +export class MockStatusBar { + text = ""; + tooltip: string | vscode.MarkdownString = ""; + backgroundColor: vscode.ThemeColor | undefined; + color: string | vscode.ThemeColor | undefined; + command: string | vscode.Command | undefined; + accessibilityInformation: vscode.AccessibilityInformation | undefined; + name: string | undefined; + priority: number | undefined; + alignment: vscode.StatusBarAlignment = vscode.StatusBarAlignment.Left; + + readonly show = vi.fn(); + readonly hide = vi.fn(); + readonly dispose = vi.fn(); + + constructor() { + this.setupVSCodeMock(); + } + + /** + * Reset all status bar state + */ + reset(): void { + this.text = ""; + this.tooltip = ""; + this.backgroundColor = undefined; + this.color = undefined; + this.command = undefined; + this.show.mockClear(); + this.hide.mockClear(); + this.dispose.mockClear(); + } + + /** + * Setup the vscode.window.createStatusBarItem mock + */ + private setupVSCodeMock(): void { + vi.mocked(vscode.window.createStatusBarItem).mockReturnValue( + this as unknown as vscode.StatusBarItem, + ); + } +} diff --git a/test/mocks/vscode.runtime.ts b/test/mocks/vscode.runtime.ts index 2201a851..4da3796f 100644 --- a/test/mocks/vscode.runtime.ts +++ b/test/mocks/vscode.runtime.ts @@ -55,18 +55,28 @@ export class Uri { } } -// mini event -const makeEvent = () => { - const listeners = new Set<(e: T) => void>(); - const event = (listener: (e: T) => void) => { - listeners.add(listener); - return { dispose: () => listeners.delete(listener) }; +/** + * Mock EventEmitter that matches vscode.EventEmitter interface. + */ +export class EventEmitter { + private readonly listeners = new Set<(e: T) => void>(); + + event = (listener: (e: T) => void) => { + this.listeners.add(listener); + return { dispose: () => this.listeners.delete(listener) }; }; - return { event, fire: (e: T) => listeners.forEach((l) => l(e)) }; -}; -const onDidChangeConfiguration = makeEvent(); -const onDidChangeWorkspaceFolders = makeEvent(); + fire(data: T): void { + this.listeners.forEach((l) => l(data)); + } + + dispose(): void { + this.listeners.clear(); + } +} + +const onDidChangeConfiguration = new EventEmitter(); +const onDidChangeWorkspaceFolders = new EventEmitter(); export const window = { showInformationMessage: vi.fn(), @@ -83,6 +93,7 @@ export const window = { dispose: vi.fn(), clear: vi.fn(), })), + createStatusBarItem: vi.fn(), }; export const commands = { @@ -132,6 +143,7 @@ const vscode = { ExtensionMode, UIKind, Uri, + EventEmitter, window, commands, workspace, diff --git a/test/unit/remote/sshProcess.test.ts b/test/unit/remote/sshProcess.test.ts new file mode 100644 index 00000000..1ec0e048 --- /dev/null +++ b/test/unit/remote/sshProcess.test.ts @@ -0,0 +1,442 @@ +import find from "find-process"; +import { vol } from "memfs"; +import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; + +import { + SshProcessMonitor, + type SshProcessMonitorOptions, +} from "@/remote/sshProcess"; + +import { createMockLogger, MockStatusBar } from "../../mocks/testHelpers"; + +import type * as fs from "node:fs"; + +vi.mock("find-process", () => ({ default: vi.fn() })); + +vi.mock("node:fs/promises", async () => { + const memfs: { fs: typeof fs } = await vi.importActual("memfs"); + return memfs.fs.promises; +}); + +describe("SshProcessMonitor", () => { + let activeMonitors: SshProcessMonitor[] = []; + let statusBar: MockStatusBar; + + beforeEach(() => { + vi.clearAllMocks(); + vol.reset(); + activeMonitors = []; + statusBar = new MockStatusBar(); + + // Default: process found immediately + vi.mocked(find).mockResolvedValue([ + { pid: 999, ppid: 1, name: "ssh", cmd: "ssh host" }, + ]); + }); + + afterEach(() => { + for (const m of activeMonitors) { + m.dispose(); + } + activeMonitors = []; + vol.reset(); + }); + + describe("process discovery", () => { + it("finds SSH process by port from Remote SSH logs", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + }); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + const pid = await waitForEvent(monitor.onPidChange); + + expect(find).toHaveBeenCalledWith("port", 12345); + expect(pid).toBe(999); + }); + + it("retries until process is found", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + }); + + // First 2 calls return nothing, third call finds the process + vi.mocked(find) + .mockResolvedValueOnce([]) + .mockResolvedValueOnce([]) + .mockResolvedValueOnce([ + { pid: 888, ppid: 1, name: "ssh", cmd: "ssh host" }, + ]); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + const pid = await waitForEvent(monitor.onPidChange); + + expect(vi.mocked(find).mock.calls.length).toBeGreaterThanOrEqual(3); + expect(pid).toBe(888); + }); + + it("retries when Remote SSH log appears later", async () => { + // Start with no log file + vol.fromJSON({}); + + vi.mocked(find).mockResolvedValue([ + { pid: 777, ppid: 1, name: "ssh", cmd: "ssh host" }, + ]); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + + // Add the log file after a delay + setTimeout(() => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 55555 ->", + }); + }, 50); + + const pid = await waitForEvent(monitor.onPidChange); + + expect(find).toHaveBeenCalledWith("port", 55555); + expect(pid).toBe(777); + }); + + it("reconnects when network info becomes stale", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/network/999.json": JSON.stringify({ + p2p: true, + latency: 10, + preferred_derp: "", + derp_latency: {}, + upload_bytes_sec: 0, + download_bytes_sec: 0, + using_coder_connect: false, + }), + }); + + // First search finds PID 999, after reconnect finds PID 888 + vi.mocked(find) + .mockResolvedValueOnce([{ pid: 999, ppid: 1, name: "ssh", cmd: "ssh" }]) + .mockResolvedValue([{ pid: 888, ppid: 1, name: "ssh", cmd: "ssh" }]); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + networkInfoPath: "/network", + networkPollInterval: 10, + }); + + // Initial PID + const firstPid = await waitForEvent(monitor.onPidChange); + expect(firstPid).toBe(999); + + // Network info will become stale after 50ms (5 * networkPollInterval) + // Monitor keeps showing last status, only fires when PID actually changes + const pids: (number | undefined)[] = []; + monitor.onPidChange((pid) => pids.push(pid)); + + // Wait for reconnection to find new PID + await waitFor(() => pids.includes(888), 200); + + // Should NOT fire undefined - we keep showing last status while searching + expect(pids).toContain(888); + }); + + it("does not fire event when same process is found after stale check", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/network/999.json": JSON.stringify({ + p2p: true, + latency: 10, + preferred_derp: "", + derp_latency: {}, + upload_bytes_sec: 0, + download_bytes_sec: 0, + using_coder_connect: false, + }), + }); + + // Always returns the same PID + vi.mocked(find).mockResolvedValue([ + { pid: 999, ppid: 1, name: "ssh", cmd: "ssh" }, + ]); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + networkInfoPath: "/network", + networkPollInterval: 10, + }); + + // Wait for initial PID + await waitForEvent(monitor.onPidChange); + + // Track subsequent events + const pids: (number | undefined)[] = []; + monitor.onPidChange((pid) => pids.push(pid)); + + // Wait long enough for stale check to trigger and re-find same process + await new Promise((r) => setTimeout(r, 100)); + + // No events should fire - same process found, no change + expect(pids).toEqual([]); + }); + }); + + describe("log file discovery", () => { + it("finds log file matching PID pattern", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/proxy-logs/999.log": "", + "/proxy-logs/other.log": "", + }); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + proxyLogDir: "/proxy-logs", + }); + const logPath = await waitForEvent(monitor.onLogFilePathChange); + + expect(logPath).toBe("/proxy-logs/999.log"); + expect(monitor.getLogFilePath()).toBe("/proxy-logs/999.log"); + }); + + it("finds log file with prefix pattern", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/proxy-logs/coder-ssh-999.log": "", + }); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + proxyLogDir: "/proxy-logs", + }); + const logPath = await waitForEvent(monitor.onLogFilePathChange); + + expect(logPath).toBe("/proxy-logs/coder-ssh-999.log"); + }); + + it("returns undefined when no proxyLogDir set", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/proxy-logs/coder-ssh-999.log": "", // ignored + }); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + proxyLogDir: undefined, + }); + + // Wait for process to be found + await waitForEvent(monitor.onPidChange); + + expect(monitor.getLogFilePath()).toBeUndefined(); + }); + }); + + describe("network status", () => { + it("shows P2P connection in status bar", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/network/999.json": JSON.stringify({ + p2p: true, + latency: 25.5, + preferred_derp: "NYC", + derp_latency: { NYC: 10 }, + upload_bytes_sec: 1024, + download_bytes_sec: 2048, + using_coder_connect: false, + }), + }); + + createMonitor({ + codeLogDir: "/logs/window1", + networkInfoPath: "/network", + }); + await waitFor(() => statusBar.text.includes("Direct")); + + expect(statusBar.text).toContain("Direct"); + expect(statusBar.text).toContain("25.50ms"); + expect(statusBar.tooltip).toContain("peer-to-peer"); + }); + + it("shows relay connection with DERP region", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/network/999.json": JSON.stringify({ + p2p: false, + latency: 50, + preferred_derp: "SFO", + derp_latency: { SFO: 20, NYC: 40 }, + upload_bytes_sec: 512, + download_bytes_sec: 1024, + using_coder_connect: false, + }), + }); + + createMonitor({ + codeLogDir: "/logs/window1", + networkInfoPath: "/network", + }); + await waitFor(() => statusBar.text.includes("SFO")); + + expect(statusBar.text).toContain("SFO"); + expect(statusBar.tooltip).toContain("relay"); + }); + + it("shows Coder Connect status", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/network/999.json": JSON.stringify({ + p2p: false, + latency: 0, + preferred_derp: "", + derp_latency: {}, + upload_bytes_sec: 0, + download_bytes_sec: 0, + using_coder_connect: true, + }), + }); + + createMonitor({ + codeLogDir: "/logs/window1", + networkInfoPath: "/network", + }); + await waitFor(() => statusBar.text.includes("Coder Connect")); + + expect(statusBar.text).toContain("Coder Connect"); + }); + }); + + describe("dispose", () => { + it("disposes status bar", () => { + const monitor = createMonitor(); + monitor.dispose(); + + expect(statusBar.dispose).toHaveBeenCalled(); + }); + + it("stops searching for process after dispose", async () => { + // Log file exists so port can be found and find() is called + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + }); + + // find() always returns empty - monitor will keep retrying + vi.mocked(find).mockResolvedValue([]); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + + // Let a few poll cycles run + await new Promise((r) => setTimeout(r, 30)); + const callsBeforeDispose = vi.mocked(find).mock.calls.length; + expect(callsBeforeDispose).toBeGreaterThan(0); + + monitor.dispose(); + + // Wait and verify no new calls + await new Promise((r) => setTimeout(r, 50)); + expect(vi.mocked(find).mock.calls.length).toBe(callsBeforeDispose); + }); + + it("does not fire log file event after dispose", async () => { + // Start with SSH log but no proxy log file + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + }); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + proxyLogDir: "/proxy-logs", + }); + + // Wait for PID - this starts the log file search loop + await waitForEvent(monitor.onPidChange); + + const events: string[] = []; + monitor.onLogFilePathChange(() => events.push("logPath")); + + monitor.dispose(); + + // Now add the log file that WOULD have been found + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/proxy-logs/999.log": "", + }); + + await new Promise((r) => setTimeout(r, 50)); + expect(events).toEqual([]); + }); + + it("is idempotent - can be called multiple times", () => { + const monitor = createMonitor(); + + monitor.dispose(); + monitor.dispose(); + monitor.dispose(); + + // Should not throw, and dispose should only be called once on status bar + expect(statusBar.dispose).toHaveBeenCalledTimes(1); + }); + }); + + function createMonitor(overrides: Partial = {}) { + const monitor = SshProcessMonitor.start({ + sshHost: "coder-vscode--user--workspace", + networkInfoPath: "/network", + codeLogDir: "/logs/window1", + remoteSshExtensionId: "ms-vscode-remote.remote-ssh", + logger: createMockLogger(), + discoveryPollIntervalMs: 10, + maxDiscoveryBackoffMs: 100, + networkPollInterval: 10, + ...overrides, + }); + activeMonitors.push(monitor); + return monitor; + } +}); + +/** Wait for a VS Code event to fire once */ +function waitForEvent( + event: (listener: (e: T) => void) => { dispose(): void }, + timeout = 1000, +): Promise { + return new Promise((resolve, reject) => { + const timer = setTimeout(() => { + disposable.dispose(); + reject(new Error(`waitForEvent timed out after ${timeout}ms`)); + }, timeout); + + const disposable = event((value) => { + clearTimeout(timer); + disposable.dispose(); + resolve(value); + }); + }); +} + +/** Poll for a condition to become true */ +async function waitFor( + condition: () => boolean, + timeout = 1000, + interval = 5, +): Promise { + const start = Date.now(); + while (!condition()) { + if (Date.now() - start > timeout) { + throw new Error(`waitFor timed out after ${timeout}ms`); + } + await new Promise((r) => setTimeout(r, interval)); + } +} diff --git a/test/unit/util.test.ts b/test/unit/util.test.ts index a5d6eb7a..3015a47d 100644 --- a/test/unit/util.test.ts +++ b/test/unit/util.test.ts @@ -5,99 +5,104 @@ import { countSubstring, escapeCommandArg, expandPath, + findPort, parseRemoteAuthority, toSafeHost, } from "@/util"; -it("ignore unrelated authorities", () => { - const tests = [ - "vscode://ssh-remote+some-unrelated-host.com", - "vscode://ssh-remote+coder-vscode", - "vscode://ssh-remote+coder-vscode-test", - "vscode://ssh-remote+coder-vscode-test--foo--bar", - "vscode://ssh-remote+coder-vscode-foo--bar", - "vscode://ssh-remote+coder--foo--bar", - ]; - for (const test of tests) { - expect(parseRemoteAuthority(test)).toBe(null); - } -}); - -it("should error on invalid authorities", () => { - const tests = [ - "vscode://ssh-remote+coder-vscode--foo", - "vscode://ssh-remote+coder-vscode--", - "vscode://ssh-remote+coder-vscode--foo--", - "vscode://ssh-remote+coder-vscode--foo--bar--", - ]; - for (const test of tests) { - expect(() => parseRemoteAuthority(test)).toThrow("Invalid"); - } -}); - -it("should parse authority", () => { - expect( - parseRemoteAuthority("vscode://ssh-remote+coder-vscode--foo--bar"), - ).toStrictEqual({ - agent: "", - host: "coder-vscode--foo--bar", - label: "", - username: "foo", - workspace: "bar", - }); - expect( - parseRemoteAuthority("vscode://ssh-remote+coder-vscode--foo--bar--baz"), - ).toStrictEqual({ - agent: "baz", - host: "coder-vscode--foo--bar--baz", - label: "", - username: "foo", - workspace: "bar", - }); - expect( - parseRemoteAuthority( - "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar", - ), - ).toStrictEqual({ - agent: "", - host: "coder-vscode.dev.coder.com--foo--bar", - label: "dev.coder.com", - username: "foo", - workspace: "bar", - }); - expect( - parseRemoteAuthority( - "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar--baz", - ), - ).toStrictEqual({ - agent: "baz", - host: "coder-vscode.dev.coder.com--foo--bar--baz", - label: "dev.coder.com", - username: "foo", - workspace: "bar", - }); - expect( - parseRemoteAuthority( - "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar.baz", - ), - ).toStrictEqual({ - agent: "baz", - host: "coder-vscode.dev.coder.com--foo--bar.baz", - label: "dev.coder.com", - username: "foo", - workspace: "bar", +describe("parseRemoteAuthority", () => { + it("ignore unrelated authorities", () => { + const tests = [ + "vscode://ssh-remote+some-unrelated-host.com", + "vscode://ssh-remote+coder-vscode", + "vscode://ssh-remote+coder-vscode-test", + "vscode://ssh-remote+coder-vscode-test--foo--bar", + "vscode://ssh-remote+coder-vscode-foo--bar", + "vscode://ssh-remote+coder--foo--bar", + ]; + for (const test of tests) { + expect(parseRemoteAuthority(test)).toBe(null); + } + }); + + it("should error on invalid authorities", () => { + const tests = [ + "vscode://ssh-remote+coder-vscode--foo", + "vscode://ssh-remote+coder-vscode--", + "vscode://ssh-remote+coder-vscode--foo--", + "vscode://ssh-remote+coder-vscode--foo--bar--", + ]; + for (const test of tests) { + expect(() => parseRemoteAuthority(test)).toThrow("Invalid"); + } + }); + + it("should parse authority", () => { + expect( + parseRemoteAuthority("vscode://ssh-remote+coder-vscode--foo--bar"), + ).toStrictEqual({ + agent: "", + host: "coder-vscode--foo--bar", + label: "", + username: "foo", + workspace: "bar", + }); + expect( + parseRemoteAuthority("vscode://ssh-remote+coder-vscode--foo--bar--baz"), + ).toStrictEqual({ + agent: "baz", + host: "coder-vscode--foo--bar--baz", + label: "", + username: "foo", + workspace: "bar", + }); + expect( + parseRemoteAuthority( + "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar", + ), + ).toStrictEqual({ + agent: "", + host: "coder-vscode.dev.coder.com--foo--bar", + label: "dev.coder.com", + username: "foo", + workspace: "bar", + }); + expect( + parseRemoteAuthority( + "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar--baz", + ), + ).toStrictEqual({ + agent: "baz", + host: "coder-vscode.dev.coder.com--foo--bar--baz", + label: "dev.coder.com", + username: "foo", + workspace: "bar", + }); + expect( + parseRemoteAuthority( + "vscode://ssh-remote+coder-vscode.dev.coder.com--foo--bar.baz", + ), + ).toStrictEqual({ + agent: "baz", + host: "coder-vscode.dev.coder.com--foo--bar.baz", + label: "dev.coder.com", + username: "foo", + workspace: "bar", + }); }); }); -it("escapes url host", () => { - expect(toSafeHost("https://foobar:8080")).toBe("foobar"); - expect(toSafeHost("https://ほげ")).toBe("xn--18j4d"); - expect(toSafeHost("https://test.😉.invalid")).toBe("test.xn--n28h.invalid"); - expect(toSafeHost("https://dev.😉-coder.com")).toBe( - "dev.xn---coder-vx74e.com", - ); - expect(() => toSafeHost("invalid url")).toThrow("Invalid URL"); - expect(toSafeHost("http://ignore-port.com:8080")).toBe("ignore-port.com"); +describe("toSafeHost", () => { + it("escapes url host", () => { + expect(toSafeHost("https://foobar:8080")).toBe("foobar"); + expect(toSafeHost("https://ほげ")).toBe("xn--18j4d"); + expect(toSafeHost("https://test.😉.invalid")).toBe("test.xn--n28h.invalid"); + expect(toSafeHost("https://dev.😉-coder.com")).toBe( + "dev.xn---coder-vx74e.com", + ); + expect(() => toSafeHost("invalid url")).toThrow("Invalid URL"); + expect(toSafeHost("http://ignore-port.com:8080")).toBe("ignore-port.com"); + }); }); describe("countSubstring", () => { @@ -190,3 +195,46 @@ describe("expandPath", () => { expect(expandPath("~/${userHome}/foo")).toBe(`${home}/${home}/foo`); }); }); + +describe("findPort", () => { + it.each([[""], ["some random log text without ports"]])( + "returns null for <%s>", + (input) => { + expect(findPort(input)).toBe(null); + }, + ); + + it.each([ + [ + "ms-vscode-remote.remote-ssh", + "[10:30:45] SSH established -> socksPort 12345 -> ready", + 12345, + ], + [ + "ms-vscode-remote.remote-ssh[2]", + "Forwarding between local port 54321 and remote", + 54321, + ], + [ + "windsurf/open-remote-ssh/antigravity", + "[INFO] Connection => 9999(socks) => target", + 9999, + ], + [ + "anysphere.remote-ssh", + "[DEBUG] Initialized Socks port: 8888 proxy", + 8888, + ], + ])("finds port from %s log format", (_name, input, expected) => { + expect(findPort(input)).toBe(expected); + }); + + it("returns most recent port when multiple matches exist", () => { + const log = ` +[10:30:00] Starting connection -> socksPort 1111 -> initialized +[10:30:05] Reconnecting => 2222(socks) => retry +[10:30:10] Final connection Socks port: 3333 established + `; + expect(findPort(log)).toBe(3333); + }); +}); From 43d01d1f18a9d1c544fad0a7866d276a1eea3b36 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 16:11:49 +0300 Subject: [PATCH 41/55] chore(deps-dev): bump dayjs from 1.11.13 to 1.11.19 (#674) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 568c6d22..b41f85f8 100644 --- a/package.json +++ b/package.json @@ -375,7 +375,7 @@ "@vscode/vsce": "^3.7.0", "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", - "dayjs": "^1.11.13", + "dayjs": "^1.11.19", "electron": "^39.1.2", "eslint": "^8.57.1", "eslint-config-prettier": "^10.1.8", diff --git a/yarn.lock b/yarn.lock index a12a3469..edecdd22 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3001,10 +3001,10 @@ date-fns@^3.6.0: resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-3.6.0.tgz#f20ca4fe94f8b754951b24240676e8618c0206bf" integrity sha512-fRHTG8g/Gif+kSh50gaGEdToemgfj74aRX3swtiouboip5JDLAyDE9F11nHMIcvOaXeOC6D7SpNhi7uFyB7Uww== -dayjs@^1.11.13: - version "1.11.13" - resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.13.tgz#92430b0139055c3ebb60150aa13e860a4b5a366c" - integrity sha512-oaMBel6gjolK862uaPQOVTA7q3TZhuSvuMQAAglQDOWYO9A91IrAOUJEyKVlqJlHE0vq5p5UXxzdPfMH/x6xNg== +dayjs@^1.11.19: + version "1.11.19" + resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.19.tgz#15dc98e854bb43917f12021806af897c58ae2938" + integrity sha512-t5EcLVS6QPBNqM2z8fakk/NKel+Xzshgt8FFKAn+qwlD1pzZWxh0nVCrvFK7ZDb6XucZeF9z8C7CBWTRIVApAw== debug@4, debug@^4.0.1, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4, debug@^4.3.5, debug@^4.4.1: version "4.4.1" From 8c17dd43bbe44726a0dabc494c3dda1ddc735b98 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 16:21:14 +0300 Subject: [PATCH 42/55] chore(deps-dev): bump electron from 39.1.2 to 39.2.6 (#673) --- package.json | 2 +- yarn.lock | 17 +++++------------ 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/package.json b/package.json index b41f85f8..19e4d861 100644 --- a/package.json +++ b/package.json @@ -376,7 +376,7 @@ "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", "dayjs": "^1.11.19", - "electron": "^39.1.2", + "electron": "^39.2.6", "eslint": "^8.57.1", "eslint-config-prettier": "^10.1.8", "eslint-import-resolver-typescript": "^4.4.4", diff --git a/yarn.lock b/yarn.lock index edecdd22..bc824376 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1269,14 +1269,7 @@ resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-10.0.10.tgz#91f62905e8d23cbd66225312f239454a23bebfa0" integrity sha512-xPyYSz1cMPnJQhl0CLMH68j3gprKZaTjG3s5Vi+fDgx+uhG9NOXwbVt52eFS8ECyXhyKcjDLCBEqBExKuiZb7Q== -"@types/node@*", "@types/node@^22.14.1": - version "22.14.1" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.14.1.tgz#53b54585cec81c21eee3697521e31312d6ca1e6f" - integrity sha512-u0HuPQwe/dHrItgHHpmw3N2fYCR6x4ivMNbPHRkBVP4CvN+kiRrKHWk3i8tXiO/joPwXLMYvF9TTF0eqgHIuOw== - dependencies: - undici-types "~6.21.0" - -"@types/node@^22.7.7": +"@types/node@*", "@types/node@^22.14.1", "@types/node@^22.7.7": version "22.19.1" resolved "https://registry.yarnpkg.com/@types/node/-/node-22.19.1.tgz#1188f1ddc9f46b4cc3aec76749050b4e1f459b7b" integrity sha512-LCCV0HdSZZZb34qifBsyWlUmok6W7ouER+oQIGBScS8EsZsQbrtFTUrDX4hOl+CS6p7cnNC4td+qrSVGSCTUfQ== @@ -3249,10 +3242,10 @@ electron-to-chromium@^1.5.41: resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.50.tgz#d9ba818da7b2b5ef1f3dd32bce7046feb7e93234" integrity sha512-eMVObiUQ2LdgeO1F/ySTXsvqvxb6ZH2zPGaMYsWzRDdOddUa77tdmI0ltg+L16UpbWdhPmuF3wIQYyQq65WfZw== -electron@^39.1.2: - version "39.1.2" - resolved "https://registry.yarnpkg.com/electron/-/electron-39.1.2.tgz#8871c24c6795aeae8eefc08a9800a4bd0f04093c" - integrity sha512-+/TwT9NWxyQGTm5WemJEJy+bWCpnKJ4PLPswI1yn1P63bzM0/8yAeG05yS+NfFaWH4yNQtGXZmAv87Bxa5RlLg== +electron@^39.2.6: + version "39.2.6" + resolved "https://registry.yarnpkg.com/electron/-/electron-39.2.6.tgz#7e1fdc01020418ea6c5cc92a3dd05fe65ad94941" + integrity sha512-dHBgTodWBZd+tL1Dt0PSh/CFLHeDkFCTKCTXu1dgPhlE9Z3k2zzlBQ9B2oW55CFsKanBDHiUomHJNw0XaSdQpA== dependencies: "@electron/get" "^2.0.0" "@types/node" "^22.7.7" From cd59d8f633718d5ec6b0ed3f900af2afdd948e47 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 16:25:47 +0300 Subject: [PATCH 43/55] chore(deps-dev): bump @vscode/vsce from 3.7.0 to 3.7.1 (#672) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 19e4d861..bd60a54c 100644 --- a/package.json +++ b/package.json @@ -372,7 +372,7 @@ "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", - "@vscode/vsce": "^3.7.0", + "@vscode/vsce": "^3.7.1", "bufferutil": "^4.0.9", "coder": "https://github.com/coder/coder#main", "dayjs": "^1.11.19", diff --git a/yarn.lock b/yarn.lock index bc824376..56ce6194 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1765,10 +1765,10 @@ "@vscode/vsce-sign-win32-arm64" "2.0.5" "@vscode/vsce-sign-win32-x64" "2.0.5" -"@vscode/vsce@^3.7.0": - version "3.7.0" - resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.7.0.tgz#a2a8c0bb414227867c6b246b6fcd84614e5dca7c" - integrity sha512-LY9r2T4joszRjz4d92ZPl6LTBUPS4IWH9gG/3JUv+1QyBJrveZlcVISuiaq0EOpmcgFh0GgVgKD4rD/21Tu8sA== +"@vscode/vsce@^3.7.1": + version "3.7.1" + resolved "https://registry.yarnpkg.com/@vscode/vsce/-/vsce-3.7.1.tgz#55a88ae40e9618fea251e373bc6b23c128915654" + integrity sha512-OTm2XdMt2YkpSn2Nx7z2EJtSuhRHsTPYsSK59hr3v8jRArK+2UEoju4Jumn1CmpgoBLGI6ReHLJ/czYltNUW3g== dependencies: "@azure/identity" "^4.1.0" "@secretlint/node" "^10.1.2" From c3943080860c682e4a976afd9fd5990a59838d58 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Wed, 10 Dec 2025 13:09:22 +0300 Subject: [PATCH 44/55] Add configurable SSH flags via `coder.sshFlags` setting (#670) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add `coder.sshFlags` setting for passing custom flags to `coder ssh` - Watch SSH-related settings and prompt user to reload when changed - Renames `globalFlags.ts` → `cliConfig.ts` to consolidate CLI configuration logic Closes #666 --- CHANGELOG.md | 1 + package.json | 10 ++ src/api/workspace.ts | 2 +- src/{globalFlags.ts => cliConfig.ts} | 11 +- src/commands.ts | 2 +- src/remote/remote.ts | 153 +++++++++++++++++++-------- test/unit/cliConfig.test.ts | 116 ++++++++++++++++++++ test/unit/globalFlags.test.ts | 88 --------------- 8 files changed, 246 insertions(+), 137 deletions(-) rename src/{globalFlags.ts => cliConfig.ts} (60%) create mode 100644 test/unit/cliConfig.test.ts delete mode 100644 test/unit/globalFlags.test.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 425ed11a..1166d82c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ ### Added - Support for paths that begin with a tilde (`~`). +- Support for `coder ssh` flag configurations through the `coder.sshFlags` setting. ### Fixed diff --git a/package.json b/package.json index bd60a54c..b06f2a76 100644 --- a/package.json +++ b/package.json @@ -120,6 +120,16 @@ "type": "boolean", "default": false }, + "coder.sshFlags": { + "markdownDescription": "Additional flags to pass to the `coder ssh` command when establishing SSH connections. Enter each flag as a separate array item; values are passed verbatim and in order. See the [CLI ssh reference](https://coder.com/docs/reference/cli/ssh) for available flags.\n\nNote: `--network-info-dir` and `--ssh-host-prefix` are ignored (managed internally). Prefer `#coder.proxyLogDirectory#` over `--log-dir`/`-l` for full functionality.", + "type": "array", + "items": { + "type": "string" + }, + "default": [ + "--disable-autostart" + ] + }, "coder.globalFlags": { "markdownDescription": "Global flags to pass to every Coder CLI invocation. Enter each flag as a separate array item; values are passed verbatim and in order. Do **not** include the `coder` command itself. See the [CLI reference](https://coder.com/docs/reference/cli) for available global flags.\n\nNote that for `--header-command`, precedence is: `#coder.headerCommand#` setting, then `CODER_HEADER_COMMAND` environment variable, then the value specified here. The `--global-config` flag is explicitly ignored.", "type": "array", diff --git a/src/api/workspace.ts b/src/api/workspace.ts index 1d3b7a4e..93319337 100644 --- a/src/api/workspace.ts +++ b/src/api/workspace.ts @@ -8,8 +8,8 @@ import { import { spawn } from "node:child_process"; import * as vscode from "vscode"; +import { getGlobalFlags } from "../cliConfig"; import { type FeatureSet } from "../featureSet"; -import { getGlobalFlags } from "../globalFlags"; import { escapeCommandArg } from "../util"; import { type UnidirectionalStream } from "../websocket/eventStreamConnection"; diff --git a/src/globalFlags.ts b/src/cliConfig.ts similarity index 60% rename from src/globalFlags.ts rename to src/cliConfig.ts index 8e75ce8d..0ae0080f 100644 --- a/src/globalFlags.ts +++ b/src/cliConfig.ts @@ -14,7 +14,16 @@ export function getGlobalFlags( // Last takes precedence/overrides previous ones return [ ...(configs.get("coder.globalFlags") || []), - ...["--global-config", escapeCommandArg(configDir)], + "--global-config", + escapeCommandArg(configDir), ...getHeaderArgs(configs), ]; } + +/** + * Returns SSH flags for the `coder ssh` command from user configuration. + */ +export function getSshFlags(configs: WorkspaceConfiguration): string[] { + // Make sure to match this default with the one in the package.json + return configs.get("coder.sshFlags", ["--disable-autostart"]); +} diff --git a/src/commands.ts b/src/commands.ts index 384b4d79..9bb2ed54 100644 --- a/src/commands.ts +++ b/src/commands.ts @@ -10,6 +10,7 @@ import * as vscode from "vscode"; import { createWorkspaceIdentifier, extractAgents } from "./api/api-helper"; import { CoderApi } from "./api/coderApi"; import { needToken } from "./api/utils"; +import { getGlobalFlags } from "./cliConfig"; import { type CliManager } from "./core/cliManager"; import { type ServiceContainer } from "./core/container"; import { type ContextManager } from "./core/contextManager"; @@ -17,7 +18,6 @@ import { type MementoManager } from "./core/mementoManager"; import { type PathResolver } from "./core/pathResolver"; import { type SecretsManager } from "./core/secretsManager"; import { CertificateError } from "./error"; -import { getGlobalFlags } from "./globalFlags"; import { type Logger } from "./logging/logger"; import { maybeAskAgent, maybeAskUrl } from "./promptUtils"; import { escapeCommandArg, toRemoteAuthority, toSafeHost } from "./util"; diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 4193e46d..27a0477e 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -20,6 +20,7 @@ import { import { extractAgents } from "../api/api-helper"; import { CoderApi } from "../api/coderApi"; import { needToken } from "../api/utils"; +import { getGlobalFlags, getSshFlags } from "../cliConfig"; import { type Commands } from "../commands"; import { type CliManager } from "../core/cliManager"; import * as cliUtils from "../core/cliUtils"; @@ -27,7 +28,6 @@ import { type ServiceContainer } from "../core/container"; import { type ContextManager } from "../core/contextManager"; import { type PathResolver } from "../core/pathResolver"; import { featureSetForVersion, type FeatureSet } from "../featureSet"; -import { getGlobalFlags } from "../globalFlags"; import { Inbox } from "../inbox"; import { type Logger } from "../logging/logger"; import { @@ -501,8 +501,6 @@ export class Remote { sshMonitor.onLogFilePathChange((newPath) => { this.commands.workspaceLogPath = newPath; }), - // Watch for logDir configuration changes - this.watchLogDirSetting(logDir, featureSet), // Register the label formatter again because SSH overrides it! vscode.extensions.onDidChange(() => { // Dispose previous label formatter @@ -516,6 +514,18 @@ export class Remote { }), ...(await this.createAgentMetadataStatusBar(agent, workspaceClient)), ); + + const settingsToWatch = [ + { setting: "coder.globalFlags", title: "Global flags" }, + { setting: "coder.sshFlags", title: "SSH flags" }, + ]; + if (featureSet.proxyLogDirectory) { + settingsToWatch.push({ + setting: "coder.proxyLogDirectory", + title: "Proxy log directory", + }); + } + disposables.push(this.watchSettings(settingsToWatch)); } catch (ex) { // Whatever error happens, make sure we clean up the disposables in case of failure disposables.forEach((d) => d.dispose()); @@ -554,8 +564,10 @@ export class Remote { } /** - * Return the --log-dir argument value for the ProxyCommand. It may be an + * Return the --log-dir argument value for the ProxyCommand. It may be an * empty string if the setting is not set or the cli does not support it. + * + * Value defined in the "coder.sshFlags" setting is not considered. */ private getLogDir(featureSet: FeatureSet): string { if (!featureSet.proxyLogDirectory) { @@ -571,16 +583,79 @@ export class Remote { } /** - * Formats the --log-dir argument for the ProxyCommand after making sure it + * Builds the ProxyCommand for SSH connections to Coder workspaces. + * Uses `coder ssh` for modern deployments with wildcard support, + * or falls back to `coder vscodessh` for older deployments. + */ + private async buildProxyCommand( + binaryPath: string, + label: string, + hostPrefix: string, + logDir: string, + useWildcardSSH: boolean, + ): Promise { + const vscodeConfig = vscode.workspace.getConfiguration(); + + const escapedBinaryPath = escapeCommandArg(binaryPath); + const globalConfig = getGlobalFlags( + vscodeConfig, + this.pathResolver.getGlobalConfigDir(label), + ); + const logArgs = await this.getLogArgs(logDir); + + if (useWildcardSSH) { + // User SSH flags are included first; internally-managed flags + // are appended last so they take precedence. + const userSshFlags = getSshFlags(vscodeConfig); + // Make sure to update the `coder.sshFlags` description if we add more internal flags here! + const internalFlags = [ + "--stdio", + "--usage-app=vscode", + "--network-info-dir", + escapeCommandArg(this.pathResolver.getNetworkInfoPath()), + ...logArgs, + "--ssh-host-prefix", + hostPrefix, + "%h", + ]; + + const allFlags = [...userSshFlags, ...internalFlags]; + return `${escapedBinaryPath} ${globalConfig.join(" ")} ssh ${allFlags.join(" ")}`; + } else { + const networkInfoDir = escapeCommandArg( + this.pathResolver.getNetworkInfoPath(), + ); + const sessionTokenFile = escapeCommandArg( + this.pathResolver.getSessionTokenPath(label), + ); + const urlFile = escapeCommandArg(this.pathResolver.getUrlPath(label)); + + const sshFlags = [ + "--network-info-dir", + networkInfoDir, + ...logArgs, + "--session-token-file", + sessionTokenFile, + "--url-file", + urlFile, + "%h", + ]; + + return `${escapedBinaryPath} ${globalConfig.join(" ")} vscodessh ${sshFlags.join(" ")}`; + } + } + + /** + * Returns the --log-dir argument for the ProxyCommand after making sure it * has been created. */ - private async formatLogArg(logDir: string): Promise { + private async getLogArgs(logDir: string): Promise { if (!logDir) { - return ""; + return []; } await fs.mkdir(logDir, { recursive: true }); this.logger.info("SSH proxy diagnostics are being written to", logDir); - return ` --log-dir ${escapeCommandArg(logDir)} -v`; + return ["--log-dir", escapeCommandArg(logDir), "-v"]; } // updateSSHConfig updates the SSH configuration with a wildcard that handles @@ -666,15 +741,13 @@ export class Remote { ? `${AuthorityPrefix}.${label}--` : `${AuthorityPrefix}--`; - const globalConfigs = this.globalConfigs(label); - - const proxyCommand = featureSet.wildcardSSH - ? `${escapeCommandArg(binaryPath)}${globalConfigs} ssh --stdio --usage-app=vscode --disable-autostart --network-info-dir ${escapeCommandArg(this.pathResolver.getNetworkInfoPath())}${await this.formatLogArg(logDir)} --ssh-host-prefix ${hostPrefix} %h` - : `${escapeCommandArg(binaryPath)}${globalConfigs} vscodessh --network-info-dir ${escapeCommandArg( - this.pathResolver.getNetworkInfoPath(), - )}${await this.formatLogArg(logDir)} --session-token-file ${escapeCommandArg(this.pathResolver.getSessionTokenPath(label))} --url-file ${escapeCommandArg( - this.pathResolver.getUrlPath(label), - )} %h`; + const proxyCommand = await this.buildProxyCommand( + binaryPath, + label, + hostPrefix, + logDir, + featureSet.wildcardSSH, + ); const sshValues: SSHValues = { Host: hostPrefix + `*`, @@ -727,38 +800,26 @@ export class Remote { return sshConfig.getRaw(); } - private globalConfigs(label: string): string { - const vscodeConfig = vscode.workspace.getConfiguration(); - const args = getGlobalFlags( - vscodeConfig, - this.pathResolver.getGlobalConfigDir(label), - ); - return ` ${args.join(" ")}`; - } - - private watchLogDirSetting( - currentLogDir: string, - featureSet: FeatureSet, + private watchSettings( + settings: Array<{ setting: string; title: string }>, ): vscode.Disposable { return vscode.workspace.onDidChangeConfiguration((e) => { - if (!e.affectsConfiguration("coder.proxyLogDirectory")) { - return; - } - const newLogDir = this.getLogDir(featureSet); - if (newLogDir === currentLogDir) { - return; + for (const { setting, title } of settings) { + if (!e.affectsConfiguration(setting)) { + continue; + } + vscode.window + .showInformationMessage( + `${title} setting changed. Reload window to apply.`, + "Reload", + ) + .then((action) => { + if (action === "Reload") { + vscode.commands.executeCommand("workbench.action.reloadWindow"); + } + }); + break; } - - vscode.window - .showInformationMessage( - "Log directory configuration changed. Reload window to apply.", - "Reload", - ) - .then((action) => { - if (action === "Reload") { - vscode.commands.executeCommand("workbench.action.reloadWindow"); - } - }); }); } diff --git a/test/unit/cliConfig.test.ts b/test/unit/cliConfig.test.ts new file mode 100644 index 00000000..d350dcbd --- /dev/null +++ b/test/unit/cliConfig.test.ts @@ -0,0 +1,116 @@ +import { it, expect, describe } from "vitest"; +import { type WorkspaceConfiguration } from "vscode"; + +import { getGlobalFlags, getSshFlags } from "@/cliConfig"; + +import { isWindows } from "../utils/platform"; + +describe("cliConfig", () => { + describe("getGlobalFlags", () => { + 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 headerCommand = "echo test"; + const config = { + get: (key: string) => { + if (key === "coder.headerCommand") { + return headerCommand; + } + 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", + quoteCommand(headerCommand), + ]); + }); + }); + + describe("getSshFlags", () => { + it("returns default flags when no SSH flags configured", () => { + const config = { + get: (_key: string, defaultValue: unknown) => defaultValue, + } as unknown as WorkspaceConfiguration; + + expect(getSshFlags(config)).toStrictEqual(["--disable-autostart"]); + }); + + it("returns SSH flags from config", () => { + const config = { + get: (key: string) => + key === "coder.sshFlags" + ? ["--disable-autostart", "--wait=yes", "--ssh-host-prefix=custom"] + : undefined, + } as unknown as WorkspaceConfiguration; + + expect(getSshFlags(config)).toStrictEqual([ + "--disable-autostart", + "--wait=yes", + // No filtering and returned as-is (even though it'll be overridden later) + "--ssh-host-prefix=custom", + ]); + }); + }); +}); + +function quoteCommand(value: string): string { + // Used to escape environment variables in commands. See `getHeaderArgs` in src/headers.ts + const quote = isWindows() ? '"' : "'"; + return `${quote}${value}${quote}`; +} diff --git a/test/unit/globalFlags.test.ts b/test/unit/globalFlags.test.ts deleted file mode 100644 index 94c89dba..00000000 --- a/test/unit/globalFlags.test.ts +++ /dev/null @@ -1,88 +0,0 @@ -import { it, expect, describe } from "vitest"; -import { type WorkspaceConfiguration } from "vscode"; - -import { getGlobalFlags } from "@/globalFlags"; - -import { isWindows } from "../utils/platform"; - -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 headerCommand = "echo test"; - const config = { - get: (key: string) => { - if (key === "coder.headerCommand") { - return headerCommand; - } - 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", - quoteCommand(headerCommand), - ]); - }); -}); - -function quoteCommand(value: string): string { - // Used to escape environment variables in commands. See `getHeaderArgs` in src/headers.ts - const quote = isWindows() ? '"' : "'"; - return `${quote}${value}${quote}`; -} From 677eee4231baac670f2cee3af5fd8fec7ebac99b Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Wed, 10 Dec 2025 13:27:17 +0300 Subject: [PATCH 45/55] v1.11.5 (#678) --- .github/workflows/publish-extension.yaml | 2 +- CHANGELOG.md | 2 ++ package.json | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-extension.yaml b/.github/workflows/publish-extension.yaml index 804ec048..77d7f73e 100644 --- a/.github/workflows/publish-extension.yaml +++ b/.github/workflows/publish-extension.yaml @@ -121,5 +121,5 @@ jobs: repo_token: ${{ secrets.GITHUB_TOKEN }} prerelease: ${{ inputs.isPreRelease }} draft: true - title: "${{ inputs.isPreRelease && 'Pre-' || '' }}Release v${{ inputs.version }}" + title: "v${{ inputs.version }}${{ inputs.isPreRelease && '-pre' || '' }}" files: ${{ needs.setup.outputs.packageName }} diff --git a/CHANGELOG.md b/CHANGELOG.md index 1166d82c..bfbc903a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +## [v1.11.5](https://github.com/coder/vscode-coder/releases/tag/v1.11.5) 2025-12-10 + ### Added - Support for paths that begin with a tilde (`~`). diff --git a/package.json b/package.json index b06f2a76..b827cbac 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "coder-remote", "displayName": "Coder", - "version": "1.11.4", + "version": "1.11.5", "description": "Open any workspace with a single click.", "categories": [ "Other" From 40f2ae0071e14c3a19ad72291c32083767764683 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 15 Dec 2025 13:46:31 +0300 Subject: [PATCH 46/55] Add log file picker when viewing logs without an active connection (#679) Also fixes fs.readdir sorting - the order is platform-dependent, so we cannot guarantee the sorting. Closes #284 --- CHANGELOG.md | 4 ++ src/commands.ts | 49 +++++++++++++++-- src/remote/sshProcess.ts | 35 ++++++------ test/unit/remote/sshProcess.test.ts | 85 ++++++++++++++++++++++++++++- 4 files changed, 151 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bfbc903a..bb1e5b34 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Added + +- Log file picker when viewing logs without an active workspace connection. + ## [v1.11.5](https://github.com/coder/vscode-coder/releases/tag/v1.11.5) 2025-12-10 ### Added diff --git a/src/commands.ts b/src/commands.ts index 9bb2ed54..554be055 100644 --- a/src/commands.ts +++ b/src/commands.ts @@ -5,6 +5,8 @@ import { type Workspace, type WorkspaceAgent, } from "coder/site/src/api/typesGenerated"; +import * as fs from "node:fs/promises"; +import * as path from "node:path"; import * as vscode from "vscode"; import { createWorkspaceIdentifier, extractAgents } from "./api/api-helper"; @@ -225,7 +227,43 @@ export class Commands { * View the logs for the currently connected workspace. */ public async viewLogs(): Promise { - if (!this.workspaceLogPath) { + if (this.workspaceLogPath) { + // Return the connected deployment's log file. + return this.openFile(this.workspaceLogPath); + } + + const logDir = vscode.workspace + .getConfiguration() + .get("coder.proxyLogDirectory"); + if (logDir) { + try { + const files = await fs.readdir(logDir); + // Sort explicitly since fs.readdir order is platform-dependent + const logFiles = files + .filter((f) => f.endsWith(".log")) + .sort() + .reverse(); + + if (logFiles.length === 0) { + vscode.window.showInformationMessage( + "No log files found in the configured log directory.", + ); + return; + } + + const selected = await vscode.window.showQuickPick(logFiles, { + title: "Select a log file to view", + }); + + if (selected) { + await this.openFile(path.join(logDir, selected)); + } + } catch (error) { + vscode.window.showErrorMessage( + `Failed to read log directory: ${error instanceof Error ? error.message : String(error)}`, + ); + } + } else { vscode.window .showInformationMessage( "No logs available. Make sure to set coder.proxyLogDirectory to get logs.", @@ -239,11 +277,12 @@ export class Commands { ); } }); - return; } - const uri = vscode.Uri.file(this.workspaceLogPath); - const doc = await vscode.workspace.openTextDocument(uri); - await vscode.window.showTextDocument(doc); + } + + private async openFile(filePath: string): Promise { + const uri = vscode.Uri.file(filePath); + await vscode.window.showTextDocument(uri); } /** diff --git a/src/remote/sshProcess.ts b/src/remote/sshProcess.ts index e86cf154..248e071f 100644 --- a/src/remote/sshProcess.ts +++ b/src/remote/sshProcess.ts @@ -257,7 +257,7 @@ export class SshProcessMonitor implements vscode.Disposable { while (!this.disposed && this.currentPid === targetPid) { try { const logFiles = await fs.readdir(logDir); - logFiles.reverse(); + logFiles.sort().reverse(); const logFileName = logFiles.find( (file) => file === `${targetPid}.log` || file.endsWith(`-${targetPid}.log`), @@ -404,15 +404,11 @@ async function findRemoteSshLogPath( // Try extension-specific folder (for VS Code clones like Cursor, Windsurf) try { const extensionLogDir = path.join(logsParentDir, extensionId); - // Node returns these directories sorted already! - const files = await fs.readdir(extensionLogDir); - files.reverse(); - - const remoteSsh = files.find((file) => file.includes("Remote - SSH")); - if (remoteSsh) { - return path.join(extensionLogDir, remoteSsh); + const remoteSshLog = await findSshLogInDir(extensionLogDir); + if (remoteSshLog) { + return remoteSshLog; } - // Folder exists but no Remote SSH log yet + logger.debug( `Extension log folder exists but no Remote SSH log found: ${extensionLogDir}`, ); @@ -421,18 +417,19 @@ async function findRemoteSshLogPath( } try { - // Node returns these directories sorted already! const dirs = await fs.readdir(logsParentDir); - dirs.reverse(); - const outputDirs = dirs.filter((d) => d.startsWith("output_logging_")); + const outputDirs = dirs + .filter((d) => d.startsWith("output_logging_")) + .sort() + .reverse(); if (outputDirs.length > 0) { const outputPath = path.join(logsParentDir, outputDirs[0]); - const files = await fs.readdir(outputPath); - const remoteSSHLog = files.find((f) => f.includes("Remote - SSH")); - if (remoteSSHLog) { - return path.join(outputPath, remoteSSHLog); + const remoteSshLog = await findSshLogInDir(outputPath); + if (remoteSshLog) { + return remoteSshLog; } + logger.debug( `Output logging folder exists but no Remote SSH log found: ${outputPath}`, ); @@ -445,3 +442,9 @@ async function findRemoteSshLogPath( return undefined; } + +async function findSshLogInDir(dirPath: string): Promise { + const files = await fs.readdir(dirPath); + const remoteSshLog = files.find((f) => f.includes("Remote - SSH")); + return remoteSshLog ? path.join(dirPath, remoteSshLog) : undefined; +} diff --git a/test/unit/remote/sshProcess.test.ts b/test/unit/remote/sshProcess.test.ts index 1ec0e048..5e30f533 100644 --- a/test/unit/remote/sshProcess.test.ts +++ b/test/unit/remote/sshProcess.test.ts @@ -1,5 +1,6 @@ import find from "find-process"; import { vol } from "memfs"; +import * as fsPromises from "node:fs/promises"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { @@ -23,7 +24,7 @@ describe("SshProcessMonitor", () => { let statusBar: MockStatusBar; beforeEach(() => { - vi.clearAllMocks(); + vi.restoreAllMocks(); vol.reset(); activeMonitors = []; statusBar = new MockStatusBar(); @@ -101,6 +102,45 @@ describe("SshProcessMonitor", () => { expect(pid).toBe(777); }); + it("uses newest output_logging_ directory when multiple exist", async () => { + // Reverse alphabetical order means highest number/newest first + vol.fromJSON({ + "/logs/output_logging_20240101/1-Remote - SSH.log": + "-> socksPort 11111 ->", + "/logs/output_logging_20240102/1-Remote - SSH.log": + "-> socksPort 22222 ->", + "/logs/output_logging_20240103/1-Remote - SSH.log": + "-> socksPort 33333 ->", + }); + + // Mock readdir to return directories in unsorted order (simulating Windows fs) + mockReaddirOrder("/logs", [ + "output_logging_20240103", + "output_logging_20240101", + "output_logging_20240102", + "window1", + ]); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + await waitForEvent(monitor.onPidChange); + + expect(find).toHaveBeenCalledWith("port", 33333); + }); + + it("falls back to output_logging_ when extension folder has no SSH log", async () => { + // Extension folder exists but doesn't have Remote SSH log + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/some-other-log.log": "", + "/logs/output_logging_20240101/1-Remote - SSH.log": + "-> socksPort 55555 ->", + }); + + const monitor = createMonitor({ codeLogDir: "/logs/window1" }); + await waitForEvent(monitor.onPidChange); + + expect(find).toHaveBeenCalledWith("port", 55555); + }); + it("reconnects when network info becomes stale", async () => { vol.fromJSON({ "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": @@ -236,6 +276,31 @@ describe("SshProcessMonitor", () => { expect(monitor.getLogFilePath()).toBeUndefined(); }); + + it("checks log files in reverse alphabetical order", async () => { + vol.fromJSON({ + "/logs/ms-vscode-remote.remote-ssh/1-Remote - SSH.log": + "-> socksPort 12345 ->", + "/proxy-logs/2024-01-01-999.log": "", + "/proxy-logs/2024-01-02-999.log": "", + "/proxy-logs/2024-01-03-999.log": "", + }); + + // Mock readdir to return files in unsorted order (simulating Windows fs) + mockReaddirOrder("/proxy-logs", [ + "2024-01-03-999.log", + "2024-01-01-999.log", + "2024-01-02-999.log", + ]); + + const monitor = createMonitor({ + codeLogDir: "/logs/window1", + proxyLogDir: "/proxy-logs", + }); + const logPath = await waitForEvent(monitor.onLogFilePathChange); + + expect(logPath).toBe("/proxy-logs/2024-01-03-999.log"); + }); }); describe("network status", () => { @@ -407,6 +472,24 @@ describe("SshProcessMonitor", () => { } }); +/** + * Helper to mock readdir returning files in a specific unsorted order. + * This is needed because memfs returns files in sorted order, which masks + * bugs in sorting logic. + */ +function mockReaddirOrder(dirPath: string, files: string[]): void { + const originalReaddir = fsPromises.readdir; + const mockImpl = (path: fs.PathLike): Promise => { + if (path === dirPath) { + return Promise.resolve(files); + } + return originalReaddir(path) as Promise; + }; + vi.spyOn(fsPromises, "readdir").mockImplementation( + mockImpl as typeof fsPromises.readdir, + ); +} + /** Wait for a VS Code event to fire once */ function waitForEvent( event: (listener: (e: T) => void) => { dispose(): void }, From e7fc732d5e0614e4b832e97c7fe1ec10e8ef0691 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 15 Dec 2025 14:03:23 +0300 Subject: [PATCH 47/55] Fix false "setting changed" notifications on remote connect (#682) The watchSettings function was using affectsConfiguration() which can return true even when values haven't changed (e.g., during Remote SSH connection setup). Now compares actual values using getter functions that properly resolve defaults. Also: - Add coder.headerCommand to watched settings - Show single notification listing all changed settings --- CHANGELOG.md | 4 ++ src/cliConfig.ts | 17 +++++-- src/headers.ts | 6 ++- src/remote/remote.ts | 79 ++++++++++++++++++++++++-------- test/unit/cliConfig.test.ts | 90 ++++++++++++++++++++----------------- 5 files changed, 132 insertions(+), 64 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb1e5b34..ad585f37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ - Log file picker when viewing logs without an active workspace connection. +### Fixed + +- Fixed false "setting changed" notifications appearing when connecting to a remote workspace. + ## [v1.11.5](https://github.com/coder/vscode-coder/releases/tag/v1.11.5) 2025-12-10 ### Added diff --git a/src/cliConfig.ts b/src/cliConfig.ts index 0ae0080f..1f23949d 100644 --- a/src/cliConfig.ts +++ b/src/cliConfig.ts @@ -3,17 +3,26 @@ import { type WorkspaceConfiguration } from "vscode"; import { getHeaderArgs } from "./headers"; import { escapeCommandArg } from "./util"; +/** + * Returns the raw global flags from user configuration. + */ +export function getGlobalFlagsRaw( + configs: Pick, +): string[] { + return configs.get("coder.globalFlags", []); +} + /** * Returns global configuration flags for Coder CLI commands. * Always includes the `--global-config` argument with the specified config directory. */ export function getGlobalFlags( - configs: WorkspaceConfiguration, + configs: Pick, configDir: string, ): string[] { // Last takes precedence/overrides previous ones return [ - ...(configs.get("coder.globalFlags") || []), + ...getGlobalFlagsRaw(configs), "--global-config", escapeCommandArg(configDir), ...getHeaderArgs(configs), @@ -23,7 +32,9 @@ export function getGlobalFlags( /** * Returns SSH flags for the `coder ssh` command from user configuration. */ -export function getSshFlags(configs: WorkspaceConfiguration): string[] { +export function getSshFlags( + configs: Pick, +): string[] { // Make sure to match this default with the one in the package.json return configs.get("coder.sshFlags", ["--disable-autostart"]); } diff --git a/src/headers.ts b/src/headers.ts index 6c69258c..435b2ad3 100644 --- a/src/headers.ts +++ b/src/headers.ts @@ -18,7 +18,7 @@ function isExecException(err: unknown): err is ExecException { } export function getHeaderCommand( - config: WorkspaceConfiguration, + config: Pick, ): string | undefined { const cmd = config.get("coder.headerCommand")?.trim() || @@ -27,7 +27,9 @@ export function getHeaderCommand( return cmd || undefined; } -export function getHeaderArgs(config: WorkspaceConfiguration): string[] { +export function getHeaderArgs( + config: Pick, +): string[] { // Escape a command line to be executed by the Coder binary, so ssh doesn't substitute variables. const escapeSubcommand: (str: string) => string = os.platform() === "win32" diff --git a/src/remote/remote.ts b/src/remote/remote.ts index 27a0477e..9aaea237 100644 --- a/src/remote/remote.ts +++ b/src/remote/remote.ts @@ -8,6 +8,7 @@ import * as jsonc from "jsonc-parser"; import * as fs from "node:fs/promises"; import * as os from "node:os"; import * as path from "node:path"; +import { isDeepStrictEqual } from "node:util"; import * as semver from "semver"; import * as vscode from "vscode"; @@ -20,7 +21,7 @@ import { import { extractAgents } from "../api/api-helper"; import { CoderApi } from "../api/coderApi"; import { needToken } from "../api/utils"; -import { getGlobalFlags, getSshFlags } from "../cliConfig"; +import { getGlobalFlags, getGlobalFlagsRaw, getSshFlags } from "../cliConfig"; import { type Commands } from "../commands"; import { type CliManager } from "../core/cliManager"; import * as cliUtils from "../core/cliUtils"; @@ -28,6 +29,7 @@ import { type ServiceContainer } from "../core/container"; import { type ContextManager } from "../core/contextManager"; import { type PathResolver } from "../core/pathResolver"; import { featureSetForVersion, type FeatureSet } from "../featureSet"; +import { getHeaderCommand } from "../headers"; import { Inbox } from "../inbox"; import { type Logger } from "../logging/logger"; import { @@ -515,14 +517,34 @@ export class Remote { ...(await this.createAgentMetadataStatusBar(agent, workspaceClient)), ); - const settingsToWatch = [ - { setting: "coder.globalFlags", title: "Global flags" }, - { setting: "coder.sshFlags", title: "SSH flags" }, + const settingsToWatch: Array<{ + setting: string; + title: string; + getValue: () => unknown; + }> = [ + { + setting: "coder.globalFlags", + title: "Global Flags", + getValue: () => + getGlobalFlagsRaw(vscode.workspace.getConfiguration()), + }, + { + setting: "coder.headerCommand", + title: "Header Command", + getValue: () => + getHeaderCommand(vscode.workspace.getConfiguration()) ?? "", + }, + { + setting: "coder.sshFlags", + title: "SSH Flags", + getValue: () => getSshFlags(vscode.workspace.getConfiguration()), + }, ]; if (featureSet.proxyLogDirectory) { settingsToWatch.push({ setting: "coder.proxyLogDirectory", - title: "Proxy log directory", + title: "Proxy Log Directory", + getValue: () => this.getLogDir(featureSet), }); } disposables.push(this.watchSettings(settingsToWatch)); @@ -801,25 +823,46 @@ export class Remote { } private watchSettings( - settings: Array<{ setting: string; title: string }>, + settings: Array<{ + setting: string; + title: string; + getValue: () => unknown; + }>, ): vscode.Disposable { + // Capture applied values at setup time + const appliedValues = new Map( + settings.map((s) => [s.setting, s.getValue()]), + ); + return vscode.workspace.onDidChangeConfiguration((e) => { - for (const { setting, title } of settings) { + const changedTitles: string[] = []; + + for (const { setting, title, getValue } of settings) { if (!e.affectsConfiguration(setting)) { continue; } - vscode.window - .showInformationMessage( - `${title} setting changed. Reload window to apply.`, - "Reload", - ) - .then((action) => { - if (action === "Reload") { - vscode.commands.executeCommand("workbench.action.reloadWindow"); - } - }); - break; + + const newValue = getValue(); + + if (!isDeepStrictEqual(newValue, appliedValues.get(setting))) { + changedTitles.push(title); + } + } + + if (changedTitles.length === 0) { + return; } + + const message = + changedTitles.length === 1 + ? `${changedTitles[0]} setting changed. Reload window to apply.` + : `${changedTitles.join(", ")} settings changed. Reload window to apply.`; + + vscode.window.showInformationMessage(message, "Reload").then((action) => { + if (action === "Reload") { + vscode.commands.executeCommand("workbench.action.reloadWindow"); + } + }); }); } diff --git a/test/unit/cliConfig.test.ts b/test/unit/cliConfig.test.ts index d350dcbd..e35fa687 100644 --- a/test/unit/cliConfig.test.ts +++ b/test/unit/cliConfig.test.ts @@ -1,16 +1,14 @@ import { it, expect, describe } from "vitest"; -import { type WorkspaceConfiguration } from "vscode"; -import { getGlobalFlags, getSshFlags } from "@/cliConfig"; +import { getGlobalFlags, getGlobalFlagsRaw, getSshFlags } from "@/cliConfig"; +import { MockConfigurationProvider } from "../mocks/testHelpers"; import { isWindows } from "../utils/platform"; describe("cliConfig", () => { describe("getGlobalFlags", () => { it("should return global-config and header args when no global flags configured", () => { - const config = { - get: () => undefined, - } as unknown as WorkspaceConfiguration; + const config = new MockConfigurationProvider(); expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ "--global-config", @@ -19,12 +17,11 @@ describe("cliConfig", () => { }); 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; + const config = new MockConfigurationProvider(); + config.set("coder.globalFlags", [ + "--verbose", + "--disable-direct-connections", + ]); expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ "--verbose", @@ -35,16 +32,12 @@ describe("cliConfig", () => { }); 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; + const config = new MockConfigurationProvider(); + config.set("coder.globalFlags", [ + "-v", + "--global-config /path/to/ignored", + "--disable-direct-connections", + ]); expect(getGlobalFlags(config, "/config/dir")).toStrictEqual([ "-v", @@ -57,17 +50,13 @@ describe("cliConfig", () => { it("should not filter header-command flags, header args appended at end", () => { const headerCommand = "echo test"; - const config = { - get: (key: string) => { - if (key === "coder.headerCommand") { - return headerCommand; - } - if (key === "coder.globalFlags") { - return ["-v", "--header-command custom", "--no-feature-warning"]; - } - return undefined; - }, - } as unknown as WorkspaceConfiguration; + const config = new MockConfigurationProvider(); + config.set("coder.headerCommand", headerCommand); + config.set("coder.globalFlags", [ + "-v", + "--header-command custom", + "--no-feature-warning", + ]); const result = getGlobalFlags(config, "/config/dir"); expect(result).toStrictEqual([ @@ -82,22 +71,41 @@ describe("cliConfig", () => { }); }); + describe("getGlobalFlagsRaw", () => { + it("returns empty array when no global flags configured", () => { + const config = new MockConfigurationProvider(); + + expect(getGlobalFlagsRaw(config)).toStrictEqual([]); + }); + + it("returns global flags from config", () => { + const config = new MockConfigurationProvider(); + config.set("coder.globalFlags", [ + "--verbose", + "--disable-direct-connections", + ]); + + expect(getGlobalFlagsRaw(config)).toStrictEqual([ + "--verbose", + "--disable-direct-connections", + ]); + }); + }); + describe("getSshFlags", () => { it("returns default flags when no SSH flags configured", () => { - const config = { - get: (_key: string, defaultValue: unknown) => defaultValue, - } as unknown as WorkspaceConfiguration; + const config = new MockConfigurationProvider(); expect(getSshFlags(config)).toStrictEqual(["--disable-autostart"]); }); it("returns SSH flags from config", () => { - const config = { - get: (key: string) => - key === "coder.sshFlags" - ? ["--disable-autostart", "--wait=yes", "--ssh-host-prefix=custom"] - : undefined, - } as unknown as WorkspaceConfiguration; + const config = new MockConfigurationProvider(); + config.set("coder.sshFlags", [ + "--disable-autostart", + "--wait=yes", + "--ssh-host-prefix=custom", + ]); expect(getSshFlags(config)).toStrictEqual([ "--disable-autostart", From e7c06ec047698936661a903c33e0f65421c101aa Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Mon, 15 Dec 2025 14:23:57 +0300 Subject: [PATCH 48/55] v1.11.6 (#683) --- CHANGELOG.md | 2 ++ package.json | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ad585f37..6b7fb7ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased +## [v1.11.6](https://github.com/coder/vscode-coder/releases/tag/v1.11.6) 2025-12-15 + ### Added - Log file picker when viewing logs without an active workspace connection. diff --git a/package.json b/package.json index b827cbac..3ade9ee6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "coder-remote", "displayName": "Coder", - "version": "1.11.5", + "version": "1.11.6", "description": "Open any workspace with a single click.", "categories": [ "Other" From f988ee102c5cdeac4f776852250d6574ee4a0446 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 01:31:16 +0300 Subject: [PATCH 49/55] chore(deps): bump actions/upload-artifact from 5 to 6 (#688) --- .github/workflows/ci.yaml | 4 ++-- .github/workflows/pre-release.yaml | 2 +- .github/workflows/release.yaml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index b1b0df6e..7c9617cc 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -84,7 +84,7 @@ jobs: - name: Upload artifact (PR) if: github.event_name == 'pull_request' - uses: actions/upload-artifact@v5 + uses: actions/upload-artifact@v6 with: name: extension-pr-${{ github.event.pull_request.number }} path: ${{ steps.setup.outputs.packageName }} @@ -93,7 +93,7 @@ jobs: - name: Upload artifact (main) if: github.event_name == 'push' && github.ref == 'refs/heads/main' - uses: actions/upload-artifact@v5 + uses: actions/upload-artifact@v6 with: name: extension-main-${{ github.sha }} path: ${{ steps.setup.outputs.packageName }} diff --git a/.github/workflows/pre-release.yaml b/.github/workflows/pre-release.yaml index 4292c968..df3a4c0f 100644 --- a/.github/workflows/pre-release.yaml +++ b/.github/workflows/pre-release.yaml @@ -60,7 +60,7 @@ jobs: run: vsce package --pre-release --out "${{ steps.setup.outputs.packageName }}" - name: Upload artifact - uses: actions/upload-artifact@v5 + uses: actions/upload-artifact@v6 with: name: extension-${{ steps.version.outputs.version }} path: ${{ steps.setup.outputs.packageName }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 5c71f8c2..7d33ec1c 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -60,7 +60,7 @@ jobs: run: vsce package --out "${{ steps.setup.outputs.packageName }}" - name: Upload artifact - uses: actions/upload-artifact@v5 + uses: actions/upload-artifact@v6 with: name: extension-${{ steps.version.outputs.version }} path: ${{ steps.setup.outputs.packageName }} From 5a2bb6856edaeed8492bda19fbbb1fc83e7387aa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 01:31:46 +0300 Subject: [PATCH 50/55] chore(deps-dev): bump @typescript-eslint/parser from 8.46.4 to 8.49.0 (#687) --- package.json | 2 +- yarn.lock | 87 ++++++++++++++++++++++++++-------------------------- 2 files changed, 44 insertions(+), 45 deletions(-) diff --git a/package.json b/package.json index 3ade9ee6..75c61d32 100644 --- a/package.json +++ b/package.json @@ -378,7 +378,7 @@ "@types/vscode": "^1.73.0", "@types/ws": "^8.18.1", "@typescript-eslint/eslint-plugin": "^8.44.0", - "@typescript-eslint/parser": "^8.46.4", + "@typescript-eslint/parser": "^8.49.0", "@vitest/coverage-v8": "^3.2.4", "@vscode/test-cli": "^0.0.12", "@vscode/test-electron": "^2.5.2", diff --git a/yarn.lock b/yarn.lock index 56ce6194..a0c3d747 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1354,15 +1354,15 @@ natural-compare "^1.4.0" ts-api-utils "^2.1.0" -"@typescript-eslint/parser@^8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.46.4.tgz#1a5bfd48be57bc07eec64e090ac46e89f47ade31" - integrity sha512-tK3GPFWbirvNgsNKto+UmB/cRtn6TZfyw0D6IKrW55n6Vbs7KJoZtI//kpTKzE/DUmmnAFD8/Ca46s7Obs92/w== - dependencies: - "@typescript-eslint/scope-manager" "8.46.4" - "@typescript-eslint/types" "8.46.4" - "@typescript-eslint/typescript-estree" "8.46.4" - "@typescript-eslint/visitor-keys" "8.46.4" +"@typescript-eslint/parser@^8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.49.0.tgz#0ede412d59e99239b770f0f08c76c42fba717fa2" + integrity sha512-N9lBGA9o9aqb1hVMc9hzySbhKibHmB+N3IpoShyV6HyQYRGIhlrO5rQgttypi+yEeKsKI4idxC8Jw6gXKD4THA== + dependencies: + "@typescript-eslint/scope-manager" "8.49.0" + "@typescript-eslint/types" "8.49.0" + "@typescript-eslint/typescript-estree" "8.49.0" + "@typescript-eslint/visitor-keys" "8.49.0" debug "^4.3.4" "@typescript-eslint/project-service@8.44.1": @@ -1374,13 +1374,13 @@ "@typescript-eslint/types" "^8.44.1" debug "^4.3.4" -"@typescript-eslint/project-service@8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.46.4.tgz#fa9872673b51fb57e5d5da034edbe17424ddd185" - integrity sha512-nPiRSKuvtTN+no/2N1kt2tUh/HoFzeEgOm9fQ6XQk4/ApGqjx0zFIIaLJ6wooR1HIoozvj2j6vTi/1fgAz7UYQ== +"@typescript-eslint/project-service@8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/project-service/-/project-service-8.49.0.tgz#ce220525c88cb2d23792b391c07e14cb9697651a" + integrity sha512-/wJN0/DKkmRUMXjZUXYZpD1NEQzQAAn9QWfGwo+Ai8gnzqH7tvqS7oNVdTjKqOcPyVIdZdyCMoqN66Ia789e7g== dependencies: - "@typescript-eslint/tsconfig-utils" "^8.46.4" - "@typescript-eslint/types" "^8.46.4" + "@typescript-eslint/tsconfig-utils" "^8.49.0" + "@typescript-eslint/types" "^8.49.0" debug "^4.3.4" "@typescript-eslint/scope-manager@8.44.1": @@ -1391,23 +1391,23 @@ "@typescript-eslint/types" "8.44.1" "@typescript-eslint/visitor-keys" "8.44.1" -"@typescript-eslint/scope-manager@8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.46.4.tgz#78c9b4856c0094def64ffa53ea955b46bec13304" - integrity sha512-tMDbLGXb1wC+McN1M6QeDx7P7c0UWO5z9CXqp7J8E+xGcJuUuevWKxuG8j41FoweS3+L41SkyKKkia16jpX7CA== +"@typescript-eslint/scope-manager@8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.49.0.tgz#a3496765b57fb48035d671174552e462e5bffa63" + integrity sha512-npgS3zi+/30KSOkXNs0LQXtsg9ekZ8OISAOLGWA/ZOEn0ZH74Ginfl7foziV8DT+D98WfQ5Kopwqb/PZOaIJGg== dependencies: - "@typescript-eslint/types" "8.46.4" - "@typescript-eslint/visitor-keys" "8.46.4" + "@typescript-eslint/types" "8.49.0" + "@typescript-eslint/visitor-keys" "8.49.0" "@typescript-eslint/tsconfig-utils@8.44.1", "@typescript-eslint/tsconfig-utils@^8.44.1": version "8.44.1" resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.44.1.tgz#e1d9d047078fac37d3e638484ab3b56215963342" integrity sha512-B5OyACouEjuIvof3o86lRMvyDsFwZm+4fBOqFHccIctYgBjqR3qT39FBYGN87khcgf0ExpdCBeGKpKRhSFTjKQ== -"@typescript-eslint/tsconfig-utils@8.46.4", "@typescript-eslint/tsconfig-utils@^8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.46.4.tgz#989a338093b6b91b0552f1f51331d89ec6980382" - integrity sha512-+/XqaZPIAk6Cjg7NWgSGe27X4zMGqrFqZ8atJsX3CWxH/jACqWnrWI68h7nHQld0y+k9eTTjb9r+KU4twLoo9A== +"@typescript-eslint/tsconfig-utils@8.49.0", "@typescript-eslint/tsconfig-utils@^8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.49.0.tgz#857777c8e35dd1e564505833d8043f544442fbf4" + integrity sha512-8prixNi1/6nawsRYxet4YOhnbW+W9FK/bQPxsGB1D3ZrDzbJ5FXw5XmzxZv82X3B+ZccuSxo/X8q9nQ+mFecWA== "@typescript-eslint/type-utils@8.44.1": version "8.44.1" @@ -1425,10 +1425,10 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.44.1.tgz#85d1cad1290a003ff60420388797e85d1c3f76ff" integrity sha512-Lk7uj7y9uQUOEguiDIDLYLJOrYHQa7oBiURYVFqIpGxclAFQ78f6VUOM8lI2XEuNOKNB7XuvM2+2cMXAoq4ALQ== -"@typescript-eslint/types@8.46.4", "@typescript-eslint/types@^8.44.1", "@typescript-eslint/types@^8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.46.4.tgz#38022bfda051be80e4120eeefcd2b6e3e630a69b" - integrity sha512-USjyxm3gQEePdUwJBFjjGNG18xY9A2grDVGuk7/9AkjIF1L+ZrVnwR5VAU5JXtUnBL/Nwt3H31KlRDaksnM7/w== +"@typescript-eslint/types@8.49.0", "@typescript-eslint/types@^8.44.1", "@typescript-eslint/types@^8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.49.0.tgz#c1bd3ebf956d9e5216396349ca23c58d74f06aee" + integrity sha512-e9k/fneezorUo6WShlQpMxXh8/8wfyc+biu6tnAqA81oWrEic0k21RHzP9uqqpyBBeBKu4T+Bsjy9/b8u7obXQ== "@typescript-eslint/typescript-estree@8.44.1": version "8.44.1" @@ -1446,20 +1446,19 @@ semver "^7.6.0" ts-api-utils "^2.1.0" -"@typescript-eslint/typescript-estree@8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.46.4.tgz#6a9eeab0da45bf400f22c818e0f47102a980ceaa" - integrity sha512-7oV2qEOr1d4NWNmpXLR35LvCfOkTNymY9oyW+lUHkmCno7aOmIf/hMaydnJBUTBMRCOGZh8YjkFOc8dadEoNGA== +"@typescript-eslint/typescript-estree@8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.49.0.tgz#99c5a53275197ccb4e849786dad68344e9924135" + integrity sha512-jrLdRuAbPfPIdYNppHJ/D0wN+wwNfJ32YTAm10eJVsFmrVpXQnDWBn8niCSMlWjvml8jsce5E/O+86IQtTbJWA== dependencies: - "@typescript-eslint/project-service" "8.46.4" - "@typescript-eslint/tsconfig-utils" "8.46.4" - "@typescript-eslint/types" "8.46.4" - "@typescript-eslint/visitor-keys" "8.46.4" + "@typescript-eslint/project-service" "8.49.0" + "@typescript-eslint/tsconfig-utils" "8.49.0" + "@typescript-eslint/types" "8.49.0" + "@typescript-eslint/visitor-keys" "8.49.0" debug "^4.3.4" - fast-glob "^3.3.2" - is-glob "^4.0.3" minimatch "^9.0.4" semver "^7.6.0" + tinyglobby "^0.2.15" ts-api-utils "^2.1.0" "@typescript-eslint/utils@8.44.1": @@ -1480,12 +1479,12 @@ "@typescript-eslint/types" "8.44.1" eslint-visitor-keys "^4.2.1" -"@typescript-eslint/visitor-keys@8.46.4": - version "8.46.4" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.46.4.tgz#07031bd8d3ca6474e121221dae1055daead888f1" - integrity sha512-/++5CYLQqsO9HFGLI7APrxBJYo+5OCMpViuhV8q5/Qa3o5mMrF//eQHks+PXcsAVaLdn817fMuS7zqoXNNZGaw== +"@typescript-eslint/visitor-keys@8.49.0": + version "8.49.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.49.0.tgz#8e450cc502c0d285cad9e84d400cf349a85ced6c" + integrity sha512-LlKaciDe3GmZFphXIc79THF/YYBugZ7FS1pO581E/edlVVNbZKDy93evqmrfQ9/Y4uN0vVhX4iuchq26mK/iiA== dependencies: - "@typescript-eslint/types" "8.46.4" + "@typescript-eslint/types" "8.49.0" eslint-visitor-keys "^4.2.1" "@typespec/ts-http-runtime@^0.3.0": From 969905903521d8ad9f8b2f3efbc5f7bfc71b5e9c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 01:33:07 +0300 Subject: [PATCH 51/55] chore(deps): bump actions/download-artifact from 6 to 7 (#689) --- .github/workflows/publish-extension.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/publish-extension.yaml b/.github/workflows/publish-extension.yaml index 77d7f73e..51885dc0 100644 --- a/.github/workflows/publish-extension.yaml +++ b/.github/workflows/publish-extension.yaml @@ -67,7 +67,7 @@ jobs: - name: Install vsce run: npm install -g @vscode/vsce - - uses: actions/download-artifact@v6 + - uses: actions/download-artifact@v7 with: name: extension-${{ inputs.version }} @@ -93,7 +93,7 @@ jobs: - name: Install ovsx run: npm install -g ovsx - - uses: actions/download-artifact@v6 + - uses: actions/download-artifact@v7 with: name: extension-${{ inputs.version }} @@ -111,7 +111,7 @@ jobs: needs: setup runs-on: ubuntu-22.04 steps: - - uses: actions/download-artifact@v6 + - uses: actions/download-artifact@v7 with: name: extension-${{ inputs.version }} From 5dc83feb61488f2c729c5d704cc56ac5d4f8deaf Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 01:33:45 +0300 Subject: [PATCH 52/55] chore(deps): bump @peculiar/x509 from 1.14.0 to 1.14.2 (#686) --- package.json | 2 +- yarn.lock | 156 +++++++++++++++++++++++++-------------------------- 2 files changed, 79 insertions(+), 79 deletions(-) diff --git a/package.json b/package.json index 75c61d32..7415af6d 100644 --- a/package.json +++ b/package.json @@ -353,7 +353,7 @@ "word-wrap": "1.2.5" }, "dependencies": { - "@peculiar/x509": "^1.14.0", + "@peculiar/x509": "^1.14.2", "axios": "1.12.2", "date-fns": "^3.6.0", "eventsource": "^3.0.6", diff --git a/yarn.lock b/yarn.lock index a0c3d747..c0a46cd6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -753,124 +753,124 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" -"@peculiar/asn1-cms@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-cms/-/asn1-cms-2.5.0.tgz#3a7e857d86686898ce78efdbf481922bb805c68a" - integrity sha512-p0SjJ3TuuleIvjPM4aYfvYw8Fk1Hn/zAVyPJZTtZ2eE9/MIer6/18ROxX6N/e6edVSfvuZBqhxAj3YgsmSjQ/A== - dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" - "@peculiar/asn1-x509-attr" "^2.5.0" +"@peculiar/asn1-cms@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-cms/-/asn1-cms-2.6.0.tgz#88267055c460ca806651f916315a934c1b1ac994" + integrity sha512-2uZqP+ggSncESeUF/9Su8rWqGclEfEiz1SyU02WX5fUONFfkjzS2Z/F1Li0ofSmf4JqYXIOdCAZqIXAIBAT1OA== + dependencies: + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" + "@peculiar/asn1-x509-attr" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-csr@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-csr/-/asn1-csr-2.5.0.tgz#4dd7534bd7d7db5bbbbde4d00d4836bf7e818d1c" - integrity sha512-ioigvA6WSYN9h/YssMmmoIwgl3RvZlAYx4A/9jD2qaqXZwGcNlAxaw54eSx2QG1Yu7YyBC5Rku3nNoHrQ16YsQ== +"@peculiar/asn1-csr@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-csr/-/asn1-csr-2.6.0.tgz#a7eff845b0020720070a12f38f26effb9fdab158" + integrity sha512-BeWIu5VpTIhfRysfEp73SGbwjjoLL/JWXhJ/9mo4vXnz3tRGm+NGm3KNcRzQ9VMVqwYS2RHlolz21svzRXIHPQ== dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-ecc@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-ecc/-/asn1-ecc-2.5.0.tgz#3bbeaa3443567055be112b4c7e9d5562951242cf" - integrity sha512-t4eYGNhXtLRxaP50h3sfO6aJebUCDGQACoeexcelL4roMFRRVgB20yBIu2LxsPh/tdW9I282gNgMOyg3ywg/mg== +"@peculiar/asn1-ecc@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-ecc/-/asn1-ecc-2.6.0.tgz#4846d39712a1a2b4786c2d6ea27b19a6dcc05ef5" + integrity sha512-FF3LMGq6SfAOwUG2sKpPXblibn6XnEIKa+SryvUl5Pik+WR9rmRA3OCiwz8R3lVXnYnyRkSZsSLdml8H3UiOcw== dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-pfx@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-pfx/-/asn1-pfx-2.5.0.tgz#22d12e676c063dfc6244278fe18eb75c2c121880" - integrity sha512-Vj0d0wxJZA+Ztqfb7W+/iu8Uasw6hhKtCdLKXLG/P3kEPIQpqGI4P4YXlROfl7gOCqFIbgsj1HzFIFwQ5s20ug== +"@peculiar/asn1-pfx@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pfx/-/asn1-pfx-2.6.0.tgz#4c8ed3050cdd5b3e63ec4192bf8f646d9e06e3f5" + integrity sha512-rtUvtf+tyKGgokHHmZzeUojRZJYPxoD/jaN1+VAB4kKR7tXrnDCA/RAWXAIhMJJC+7W27IIRGe9djvxKgsldCQ== dependencies: - "@peculiar/asn1-cms" "^2.5.0" - "@peculiar/asn1-pkcs8" "^2.5.0" - "@peculiar/asn1-rsa" "^2.5.0" - "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-cms" "^2.6.0" + "@peculiar/asn1-pkcs8" "^2.6.0" + "@peculiar/asn1-rsa" "^2.6.0" + "@peculiar/asn1-schema" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-pkcs8@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.5.0.tgz#1939643773e928a4802813b595e324a05b453709" - integrity sha512-L7599HTI2SLlitlpEP8oAPaJgYssByI4eCwQq2C9eC90otFpm8MRn66PpbKviweAlhinWQ3ZjDD2KIVtx7PaVw== +"@peculiar/asn1-pkcs8@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs8/-/asn1-pkcs8-2.6.0.tgz#c426caf81cb49935c553b591e0273b4b44d1696f" + integrity sha512-KyQ4D8G/NrS7Fw3XCJrngxmjwO/3htnA0lL9gDICvEQ+GJ+EPFqldcJQTwPIdvx98Tua+WjkdKHSC0/Km7T+lA== dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-pkcs9@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.5.0.tgz#8c5b873a721bb92b4fe758da9de1ead63165106d" - integrity sha512-UgqSMBLNLR5TzEZ5ZzxR45Nk6VJrammxd60WMSkofyNzd3DQLSNycGWSK5Xg3UTYbXcDFyG8pA/7/y/ztVCa6A== - dependencies: - "@peculiar/asn1-cms" "^2.5.0" - "@peculiar/asn1-pfx" "^2.5.0" - "@peculiar/asn1-pkcs8" "^2.5.0" - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" - "@peculiar/asn1-x509-attr" "^2.5.0" +"@peculiar/asn1-pkcs9@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-pkcs9/-/asn1-pkcs9-2.6.0.tgz#96b57122228a0e2e30e81118cd3baa570c13a51d" + integrity sha512-b78OQ6OciW0aqZxdzliXGYHASeCvvw5caqidbpQRYW2mBtXIX2WhofNXTEe7NyxTb0P6J62kAAWLwn0HuMF1Fw== + dependencies: + "@peculiar/asn1-cms" "^2.6.0" + "@peculiar/asn1-pfx" "^2.6.0" + "@peculiar/asn1-pkcs8" "^2.6.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" + "@peculiar/asn1-x509-attr" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-rsa@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-rsa/-/asn1-rsa-2.5.0.tgz#7283756ec596ccfbef23ff0e7eda0c37133ebed8" - integrity sha512-qMZ/vweiTHy9syrkkqWFvbT3eLoedvamcUdnnvwyyUNv5FgFXA3KP8td+ATibnlZ0EANW5PYRm8E6MJzEB/72Q== +"@peculiar/asn1-rsa@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-rsa/-/asn1-rsa-2.6.0.tgz#49d905ab67ae8aa54e996734f37a391bb7958747" + integrity sha512-Nu4C19tsrTsCp9fDrH+sdcOKoVfdfoQQ7S3VqjJU6vedR7tY3RLkQ5oguOIB3zFW33USDUuYZnPEQYySlgha4w== dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-schema@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.5.0.tgz#4e58d7c3087c4259cebf5363e092f85b9cbf0ca1" - integrity sha512-YM/nFfskFJSlHqv59ed6dZlLZqtZQwjRVJ4bBAiWV08Oc+1rSd5lDZcBEx0lGDHfSoH3UziI2pXt2UM33KerPQ== +"@peculiar/asn1-schema@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.6.0.tgz#0dca1601d5b0fed2a72fed7a5f1d0d7dbe3a6f82" + integrity sha512-xNLYLBFTBKkCzEZIw842BxytQQATQv+lDTCEMZ8C196iJcJJMBUZxrhSTxLaohMyKK8QlzRNTRkUmanucnDSqg== dependencies: asn1js "^3.0.6" pvtsutils "^1.3.6" tslib "^2.8.1" -"@peculiar/asn1-x509-attr@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.5.0.tgz#d413597dfe097620a00780e9e2ae851b06f32aed" - integrity sha512-9f0hPOxiJDoG/bfNLAFven+Bd4gwz/VzrCIIWc1025LEI4BXO0U5fOCTNDPbbp2ll+UzqKsZ3g61mpBp74gk9A== +"@peculiar/asn1-x509-attr@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509-attr/-/asn1-x509-attr-2.6.0.tgz#057cb0c3c600a259c9f40582ee5fd7f0114c5be6" + integrity sha512-MuIAXFX3/dc8gmoZBkwJWxUWOSvG4MMDntXhrOZpJVMkYX+MYc/rUAU2uJOved9iJEoiUx7//3D8oG83a78UJA== dependencies: - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" asn1js "^3.0.6" tslib "^2.8.1" -"@peculiar/asn1-x509@^2.5.0": - version "2.5.0" - resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509/-/asn1-x509-2.5.0.tgz#305f9cd534f4b6a723d27fc59363f382debf5500" - integrity sha512-CpwtMCTJvfvYTFMuiME5IH+8qmDe3yEWzKHe7OOADbGfq7ohxeLaXwQo0q4du3qs0AII3UbLCvb9NF/6q0oTKQ== +"@peculiar/asn1-x509@^2.6.0": + version "2.6.0" + resolved "https://registry.yarnpkg.com/@peculiar/asn1-x509/-/asn1-x509-2.6.0.tgz#9aa0784b455ca34095fdc91a5cc52869e21528dd" + integrity sha512-uzYbPEpoQiBoTq0/+jZtpM6Gq6zADBx+JNFP3yqRgziWBxQ/Dt/HcuvRfm9zJTPdRcBqPNdaRHTVwpyiq6iNMA== dependencies: - "@peculiar/asn1-schema" "^2.5.0" + "@peculiar/asn1-schema" "^2.6.0" asn1js "^3.0.6" pvtsutils "^1.3.6" tslib "^2.8.1" -"@peculiar/x509@^1.14.0": - version "1.14.0" - resolved "https://registry.yarnpkg.com/@peculiar/x509/-/x509-1.14.0.tgz#4b1abdf7ca5e46f2cb303fba608ef0507762e84a" - integrity sha512-Yc4PDxN3OrxUPiXgU63c+ZRXKGE8YKF2McTciYhUHFtHVB0KMnjeFSU0qpztGhsp4P0uKix4+J2xEpIEDu8oXg== - dependencies: - "@peculiar/asn1-cms" "^2.5.0" - "@peculiar/asn1-csr" "^2.5.0" - "@peculiar/asn1-ecc" "^2.5.0" - "@peculiar/asn1-pkcs9" "^2.5.0" - "@peculiar/asn1-rsa" "^2.5.0" - "@peculiar/asn1-schema" "^2.5.0" - "@peculiar/asn1-x509" "^2.5.0" +"@peculiar/x509@^1.14.2": + version "1.14.2" + resolved "https://registry.yarnpkg.com/@peculiar/x509/-/x509-1.14.2.tgz#635078480a0e4796eab2fb765361dec142af0f3b" + integrity sha512-r2w1Hg6pODDs0zfAKHkSS5HLkOLSeburtcgwvlLLWWCixw+MmW3U6kD5ddyvc2Y2YdbGuVwCF2S2ASoU1cFAag== + dependencies: + "@peculiar/asn1-cms" "^2.6.0" + "@peculiar/asn1-csr" "^2.6.0" + "@peculiar/asn1-ecc" "^2.6.0" + "@peculiar/asn1-pkcs9" "^2.6.0" + "@peculiar/asn1-rsa" "^2.6.0" + "@peculiar/asn1-schema" "^2.6.0" + "@peculiar/asn1-x509" "^2.6.0" pvtsutils "^1.3.6" reflect-metadata "^0.2.2" tslib "^2.8.1" From e2fee1432d85de3c96f900228236f7f4d6a794b6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 01:44:09 +0300 Subject: [PATCH 53/55] chore(deps-dev): bump jsonc-eslint-parser from 2.4.1 to 2.4.2 (#685) --- package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 7415af6d..2caac7bc 100644 --- a/package.json +++ b/package.json @@ -395,7 +395,7 @@ "eslint-plugin-package-json": "^0.59.0", "eslint-plugin-prettier": "^5.5.4", "glob": "^11.1.0", - "jsonc-eslint-parser": "^2.4.0", + "jsonc-eslint-parser": "^2.4.2", "markdown-eslint-parser": "^1.2.1", "memfs": "^4.49.0", "nyc": "^17.1.0", diff --git a/yarn.lock b/yarn.lock index c0a46cd6..7dd63d50 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5669,10 +5669,10 @@ json5@^2.2.2, json5@^2.2.3: resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== -jsonc-eslint-parser@^2.4.0: - version "2.4.1" - resolved "https://registry.yarnpkg.com/jsonc-eslint-parser/-/jsonc-eslint-parser-2.4.1.tgz#64a8ed77311d33ac450725c1a438132dd87b2b3b" - integrity sha512-uuPNLJkKN8NXAlZlQ6kmUF9qO+T6Kyd7oV4+/7yy8Jz6+MZNyhPq8EdLpdfnPVzUC8qSf1b4j1azKaGnFsjmsw== +jsonc-eslint-parser@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/jsonc-eslint-parser/-/jsonc-eslint-parser-2.4.2.tgz#f135454fd35784ecc1b848908f0d3e98a5be9433" + integrity sha512-1e4qoRgnn448pRuMvKGsFFymUCquZV0mpGgOyIKNgD3JVDTsVJyRBGH/Fm0tBb8WsWGgmB1mDe6/yJMQM37DUA== dependencies: acorn "^8.5.0" eslint-visitor-keys "^3.0.0" From 5ef523fd04c3fdd311afd17897d3c98dc8c76741 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 11:21:57 +0300 Subject: [PATCH 54/55] chore(deps-dev): bump eslint-plugin-package-json from 0.59.0 to 0.85.0 (#675) --- package.json | 10 +++++----- yarn.lock | 29 +++++++++++++++-------------- 2 files changed, 20 insertions(+), 19 deletions(-) diff --git a/package.json b/package.json index 2caac7bc..b612e903 100644 --- a/package.json +++ b/package.json @@ -392,7 +392,7 @@ "eslint-import-resolver-typescript": "^4.4.4", "eslint-plugin-import": "^2.32.0", "eslint-plugin-md": "^1.0.19", - "eslint-plugin-package-json": "^0.59.0", + "eslint-plugin-package-json": "^0.85.0", "eslint-plugin-prettier": "^5.5.4", "glob": "^11.1.0", "jsonc-eslint-parser": "^2.4.2", @@ -416,12 +416,12 @@ "vscode": "^1.73.0" }, "icon": "media/logo.png", - "extensionKind": [ - "ui" - ], "capabilities": { "untrustedWorkspaces": { "supported": true } - } + }, + "extensionKind": [ + "ui" + ] } diff --git a/yarn.lock b/yarn.lock index 7dd63d50..03de16e6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3751,21 +3751,21 @@ eslint-plugin-md@^1.0.19: remark-preset-lint-markdown-style-guide "^2.1.3" requireindex "~1.1.0" -eslint-plugin-package-json@^0.59.0: - version "0.59.0" - resolved "https://registry.yarnpkg.com/eslint-plugin-package-json/-/eslint-plugin-package-json-0.59.0.tgz#fb847e54742a3465de2e6c813608f95c88075c24" - integrity sha512-4xdVhL3b7LqQQh8cvN3hX8HkAVM6cxZoXqyN4ZE4kN9NuJ21sgnj1IGS19/bmIgCdGBhmsWGXbbyD1H9mjZfMA== +eslint-plugin-package-json@^0.85.0: + version "0.85.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-package-json/-/eslint-plugin-package-json-0.85.0.tgz#acbd53be1eafe9d667a8bf80c4459ab2d9a80a9f" + integrity sha512-MrOxFvhbqLuk4FIPG9v3u9Amn0n137J8LKILHvgfxK3rRyAHEVzuZM0CtpXFTx7cx4LzmAzONtlpjbM0UFNuTA== dependencies: "@altano/repository-tools" "^2.0.1" change-case "^5.4.4" detect-indent "^7.0.2" detect-newline "^4.0.1" eslint-fix-utils "~0.4.0" - package-json-validator "~0.31.0" + package-json-validator "~0.59.0" semver "^7.7.3" sort-object-keys "^2.0.0" sort-package-json "^3.4.0" - validate-npm-package-name "^6.0.2" + validate-npm-package-name "^7.0.0" eslint-plugin-prettier@^5.5.4: version "5.5.4" @@ -6580,13 +6580,14 @@ package-json-from-dist@^1.0.0: resolved "https://registry.yarnpkg.com/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz#e501cd3094b278495eb4258d4c9f6d5ac3019f00" integrity sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw== -package-json-validator@~0.31.0: - version "0.31.0" - resolved "https://registry.yarnpkg.com/package-json-validator/-/package-json-validator-0.31.0.tgz#c5a693e6db3ee9ca6dddfd5d07a79807f340dc77" - integrity sha512-kAVO0fNFWI2xpmthogYHnHjCtg0nJvwm9yjd9nnrR5OKIts5fmNMK2OhhjnLD1/ohJNodhCa5tZm8AolOgkfMg== +package-json-validator@~0.59.0: + version "0.59.0" + resolved "https://registry.yarnpkg.com/package-json-validator/-/package-json-validator-0.59.0.tgz#28612014fd76b97836fd56de35828e86d4828a85" + integrity sha512-WBTDKtO9pBa9GmA1sPbQHqlWxRdnHNfLFIIA49PPgV7px/rG27gHX57DWy77qyu374fla4veaIHy+gA+qRRuug== dependencies: semver "^7.7.2" validate-npm-package-license "^3.0.4" + validate-npm-package-name "^7.0.0" yargs "~18.0.0" pako@~1.0.2: @@ -9215,10 +9216,10 @@ validate-npm-package-license@^3.0.4: spdx-correct "^3.0.0" spdx-expression-parse "^3.0.0" -validate-npm-package-name@^6.0.2: - version "6.0.2" - resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-6.0.2.tgz#4e8d2c4d939975a73dd1b7a65e8f08d44c85df96" - integrity sha512-IUoow1YUtvoBBC06dXs8bR8B9vuA3aJfmQNKMoaPG/OFsPmoQvw8xh+6Ye25Gx9DQhoEom3Pcu9MKHerm/NpUQ== +validate-npm-package-name@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-7.0.0.tgz#3b4fe12b4abfb8b0be010d0e75b1fe2b52295bc6" + integrity sha512-bwVk/OK+Qu108aJcMAEiU4yavHUI7aN20TgZNBj9MR2iU1zPUl1Z1Otr7771ExfYTPTvfN8ZJ1pbr5Iklgt4xg== version-range@^4.13.0: version "4.14.0" From 99d1fab626f7b90bc60947e338a3c3ab0001b6a3 Mon Sep 17 00:00:00 2001 From: Ehab Younes Date: Tue, 16 Dec 2025 12:35:26 +0300 Subject: [PATCH 55/55] Unify deployment tracking and support multiple deployments (#677) This change centralizes deployment state management and enables seamless multi-deployment support. The extension now properly tracks per-deployment credentials, syncs state across VS Code windows, and handles login/logout flows in a unified way. Key changes: Architecture: - Add `DeploymentManager` to centralize deployment state (`url`, `label`, `token`, `user`) and coordinate extension client updates, auth contexts, and workspace refreshes - Add `LoginCoordinator` to handle login prompts with cross-window detection, preventing duplicate login dialogs when multiple windows need auth Storage & Auth: - `SecretsManager` now stores per-deployment credentials using label-based keys (`coder.session.