Add configurable autostart behavior for SSH connections

Author: EhabY

package.json

@@ -120,6 +120,21 @@
 					"type": "boolean",
 					"default": false
 				},
+				"coder.disableAutostart": {
+					"markdownDescription": "Disable starting the workspace automatically when connecting via SSH.",
+					"type": "string",
+					"enum": [
+						"auto",
+						"always",
+						"never"
+					],
+					"markdownEnumDescriptions": [
+						"Disables autostart on macOS only (recommended to avoid sleep/wake issues)",
+						"Disables on all platforms",
+						"Keeps autostart enabled on all platforms"
+					],
+					"default": "auto"
+				},
 				"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",

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";
 

src/cliConfig.ts

@@ -0,0 +1,40 @@
+import { type WorkspaceConfiguration } from "vscode";
+
+import { getHeaderArgs } from "./headers";
+import { escapeCommandArg } from "./util";
+
+/**
+ * Returns global configuration flags for Coder CLI commands.
+ * Always includes the `--global-config` argument with the specified config directory.
+ */
+export function getGlobalFlags(
+	configs: WorkspaceConfiguration,
+	configDir: string,
+): string[] {
+	// Last takes precedence/overrides previous ones
+	return [
+		...(configs.get<string[]>("coder.globalFlags") || []),
+		"--global-config",
+		escapeCommandArg(configDir),
+		...getHeaderArgs(configs),
+	];
+}
+
+type DisableAutostartSetting = "auto" | "always" | "never";
+
+/**
+ * Determines whether autostart should be disabled based on the setting and platform.
+ * - "always": disable on all platforms
+ * - "never": never disable
+ * - "auto": disable only on macOS (due to sleep/wake issues)
+ */
+export function shouldDisableAutostart(
+	configs: WorkspaceConfiguration,
+	platform: NodeJS.Platform,
+): boolean {
+	const setting = configs.get<DisableAutostartSetting>(
+		"coder.disableAutostart",
+		"auto",
+	);
+	return setting === "always" || (setting === "auto" && platform === "darwin");
+}

src/commands.ts

@@ -10,14 +10,14 @@ 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";
 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";

src/globalFlags.ts

@@ -22,14 +22,14 @@ import {
 import { extractAgents } from "../api/api-helper";
 import { CoderApi } from "../api/coderApi";
 import { needToken } from "../api/utils";
+import { getGlobalFlags, shouldDisableAutostart } from "../cliConfig";
 import { type Commands } from "../commands";
 import { type CliManager } from "../core/cliManager";
 import * as cliUtils from "../core/cliUtils";
 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 {
@@ -674,7 +674,7 @@ export class Remote {
 		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} ssh --stdio --usage-app=vscode${this.disableAutostartConfig()} --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(
@@ -741,6 +741,13 @@ export class Remote {
 		return ` ${args.join(" ")}`;
 	}
 
+	private disableAutostartConfig(): string {
+		const configs = vscode.workspace.getConfiguration();
+		return shouldDisableAutostart(configs, process.platform)
+			? " --disable-autostart"
+			: "";
+	}
+
 	// 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 {

src/remote/remote.ts

@@ -1,7 +1,7 @@
 import { it, expect, describe } from "vitest";
 import { type WorkspaceConfiguration } from "vscode";
 
-import { getGlobalFlags } from "@/globalFlags";
+import { getGlobalFlags, shouldDisableAutostart } from "@/cliConfig";
 
 import { isWindows } from "../utils/platform";
 
@@ -86,3 +86,45 @@ function quoteCommand(value: string): string {
 	const quote = isWindows() ? '"' : "'";
 	return `${quote}${value}${quote}`;
 }
+
+describe("shouldDisableAutostart", () => {
+	const mockConfig = (setting: string) =>
+		({
+			get: (key: string) =>
+				key === "coder.disableAutostart" ? setting : undefined,
+		}) as unknown as WorkspaceConfiguration;
+
+	it("returns true when setting is 'always' regardless of platform", () => {
+		const config = mockConfig("always");
+		expect(shouldDisableAutostart(config, "darwin")).toBe(true);
+		expect(shouldDisableAutostart(config, "linux")).toBe(true);
+		expect(shouldDisableAutostart(config, "win32")).toBe(true);
+	});
+
+	it("returns false when setting is 'never' regardless of platform", () => {
+		const config = mockConfig("never");
+		expect(shouldDisableAutostart(config, "darwin")).toBe(false);
+		expect(shouldDisableAutostart(config, "linux")).toBe(false);
+		expect(shouldDisableAutostart(config, "win32")).toBe(false);
+	});
+
+	it("returns true when setting is 'auto' and platform is darwin", () => {
+		const config = mockConfig("auto");
+		expect(shouldDisableAutostart(config, "darwin")).toBe(true);
+	});
+
+	it("returns false when setting is 'auto' and platform is not darwin", () => {
+		const config = mockConfig("auto");
+		expect(shouldDisableAutostart(config, "linux")).toBe(false);
+		expect(shouldDisableAutostart(config, "win32")).toBe(false);
+		expect(shouldDisableAutostart(config, "freebsd")).toBe(false);
+	});
+
+	it("defaults to 'auto' when setting is not configured", () => {
+		const config = {
+			get: (_key: string, defaultValue: unknown) => defaultValue,
+		} as unknown as WorkspaceConfiguration;
+		expect(shouldDisableAutostart(config, "darwin")).toBe(true);
+		expect(shouldDisableAutostart(config, "linux")).toBe(false);
+	});
+});