Remove the coder.disableAutostart setting and enhance documentation

Author: EhabY

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
 

package.json

@@ -120,27 +120,15 @@
 					"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 autostart on all platforms",
-						"Keeps autostart enabled on all platforms"
-					],
-					"default": "auto"
-				},
 				"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). `--disable-autostart` and `--log-dir`/`-l` can be specified here, but prefer using `#coder.disableAutostart#` and `#coder.proxyLogDirectory#` settings respectively.",
+					"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.",

src/cliConfig.ts

@@ -20,25 +20,6 @@ export function getGlobalFlags(
 	];
 }
 
-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");
-}
-
 /**
  * Returns SSH flags for the `coder ssh` command from user configuration.
  */

src/remote/remote.ts

@@ -20,11 +20,7 @@ import {
 import { extractAgents } from "../api/api-helper";
 import { CoderApi } from "../api/coderApi";
 import { needToken } from "../api/utils";
-import {
-	getGlobalFlags,
-	getSshFlags,
-	shouldDisableAutostart,
-} from "../cliConfig";
+import { getGlobalFlags, getSshFlags } from "../cliConfig";
 import { type Commands } from "../commands";
 import { type CliManager } from "../core/cliManager";
 import * as cliUtils from "../core/cliUtils";
@@ -560,28 +556,20 @@ export class Remote {
 	/**
 	 * 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) {
 			return "";
 		}
-
-		const vscodeConfig = vscode.workspace.getConfiguration();
-		const proxyLogDir = vscodeConfig
-			.get<string>("coder.proxyLogDirectory")
-			?.trim();
-		if (proxyLogDir) {
-			return expandPath(proxyLogDir);
-		}
-
-		const sshFlags = getSshFlags(vscodeConfig);
-		const logDirFlagIndex = sshFlags.findIndex(
-			(option) => option === "-l" || option === "--log-dir",
+		// If the proxyLogDirectory is not set in the extension settings we don't send one.
+		return expandPath(
+			String(
+				vscode.workspace.getConfiguration().get("coder.proxyLogDirectory") ??
+					"",
+			).trim(),
 		);
-		if (logDirFlagIndex !== -1 && logDirFlagIndex + 1 < sshFlags.length) {
-			return expandPath(sshFlags[logDirFlagIndex + 1].trim());
-		}
-		return "";
 	}
 
 	/**
@@ -609,20 +597,13 @@ export class Remote {
 			// User SSH flags are included first; internally-managed flags
 			// are appended last so they take precedence.
 			const userSSHFlags = getSshFlags(vscodeConfig);
-			const disableAutostart = shouldDisableAutostart(
-				vscodeConfig,
-				process.platform,
-			)
-				? ["--disable-autostart"]
-				: [];
 			// 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,
-				...disableAutostart,
 				"--ssh-host-prefix",
 				hostPrefix,
 				"%h",

test/unit/cliConfig.test.ts

@@ -1,11 +1,7 @@
 import { it, expect, describe } from "vitest";
 import { type WorkspaceConfiguration } from "vscode";
 
-import {
-	getGlobalFlags,
-	getSshFlags,
-	shouldDisableAutostart,
-} from "@/cliConfig";
+import { getGlobalFlags, getSshFlags } from "@/cliConfig";
 
 import { isWindows } from "../utils/platform";
 
@@ -86,48 +82,6 @@ describe("cliConfig", () => {
 		});
 	});
 
-	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);
-		});
-	});
-
 	describe("getSshFlags", () => {
 		it("returns empty array when no SSH flags configured", () => {
 			const config = {