feat: add confirmation dialog, split auto/recommended SSH defaults

Author: EhabY

src/commands.ts

@@ -24,7 +24,10 @@ import { type Logger } from "./logging/logger";
 import { type LoginCoordinator } from "./login/loginCoordinator";
 import { withProgress } from "./progress";
 import { maybeAskAgent, maybeAskUrl } from "./promptUtils";
-import { RECOMMENDED_SSH_SETTINGS } from "./remote/userSettings";
+import {
+	RECOMMENDED_SSH_SETTINGS,
+	applySettingOverrides,
+} from "./remote/userSettings";
 import { escapeCommandArg, toRemoteAuthority, toSafeHost } from "./util";
 import { vscodeProposed } from "./vscodeProposed";
 import {
@@ -315,19 +318,41 @@ export class Commands {
 	 * Apply recommended SSH settings for reliable Coder workspace connections.
 	 */
 	public async applyRecommendedSettings(): Promise<void> {
-		const config = vscode.workspace.getConfiguration();
 		const entries = Object.entries(RECOMMENDED_SSH_SETTINGS);
-		for (const [key, setting] of entries) {
-			await config.update(
-				key,
-				setting.value,
-				vscode.ConfigurationTarget.Global,
-			);
+		const summary = entries.map(([, s]) => s.label).join("\n");
+		const confirm = await vscodeProposed.window.showWarningMessage(
+			"Apply Recommended SSH Settings",
+			{
+				useCustom: true,
+				modal: true,
+				detail: summary,
+			},
+			"Apply",
+		);
+		if (confirm !== "Apply") {
+			return;
 		}
-		const summary = entries.map(([, s]) => s.label).join(", ");
-		vscode.window.showInformationMessage(
-			`Applied recommended SSH settings: ${summary}`,
+
+		const overrides = entries.map(([key, setting]) => ({
+			key,
+			value: setting.value,
+		}));
+		await applySettingOverrides(
+			this.pathResolver.getUserSettingsPath(),
+			overrides,
+			this.logger,
 		);
+		if (this.remoteWorkspaceClient) {
+			const action = await vscode.window.showInformationMessage(
+				"Applied recommended SSH settings. Reload the window for changes to take effect.",
+				"Reload Window",
+			);
+			if (action === "Reload Window") {
+				await vscode.commands.executeCommand("workbench.action.reloadWindow");
+			}
+		} else {
+			vscode.window.showInformationMessage("Applied recommended SSH settings.");
+		}
 	}
 
 	/**

src/remote/userSettings.ts

@@ -1,3 +1,4 @@
+import { formatDuration, intervalToDuration } from "date-fns";
 import * as jsonc from "jsonc-parser";
 import * as fs from "node:fs/promises";
 
@@ -15,25 +16,45 @@ interface RecommendedSetting {
 	readonly label: string;
 }
 
+function recommended(
+	shortName: string,
+	value: number | null,
+): RecommendedSetting {
+	if (value === null) {
+		return { value, label: `${shortName}: max allowed` };
+	}
+	const humanized = formatDuration(
+		intervalToDuration({ start: 0, end: value * 1000 }),
+	);
+	return { value, label: `${shortName}: ${humanized}` };
+}
+
+/** Applied by the "Apply Recommended SSH Settings" command. */
 export const RECOMMENDED_SSH_SETTINGS = {
-	"remote.SSH.connectTimeout": {
-		value: 1800,
-		label: "Connect Timeout: 1800s (30 min)",
-	},
-	"remote.SSH.reconnectionGraceTime": {
-		value: 28800,
-		label: "Reconnection Grace Time: 28800s (8 hours)",
-	},
-	"remote.SSH.serverShutdownTimeout": {
-		value: 28800,
-		label: "Server Shutdown Timeout: 28800s (8 hours)",
-	},
-	"remote.SSH.maxReconnectionAttempts": {
-		value: null,
-		label: "Max Reconnection Attempts: max allowed",
-	},
+	"remote.SSH.connectTimeout": recommended("Connect Timeout", 1800),
+	"remote.SSH.reconnectionGraceTime": recommended(
+		"Reconnection Grace Time",
+		86400,
+	),
+	"remote.SSH.serverShutdownTimeout": recommended(
+		"Server Shutdown Timeout",
+		86400,
+	),
+	"remote.SSH.maxReconnectionAttempts": recommended(
+		"Max Reconnection Attempts",
+		null,
+	),
 } as const satisfies Record<string, RecommendedSetting>;
 
+type SshSettingKey = keyof typeof RECOMMENDED_SSH_SETTINGS;
+
+/** Defaults set during connection when the user hasn't configured a value. */
+const AUTO_SETUP_DEFAULTS = {
+	"remote.SSH.reconnectionGraceTime": 28800, // 8h
+	"remote.SSH.serverShutdownTimeout": 28800, // 8h
+	"remote.SSH.maxReconnectionAttempts": null, // max allowed
+} as const satisfies Partial<Record<SshSettingKey, number | null>>;
+
 /**
  * Build the list of VS Code setting overrides needed for a remote SSH
  * connection to a Coder workspace.
@@ -58,25 +79,17 @@ export function buildSshOverrides(
 	}
 
 	// Default 15s is too short for startup scripts; enforce a minimum.
-	const minConnTimeout =
-		RECOMMENDED_SSH_SETTINGS["remote.SSH.connectTimeout"].value;
-	const connTimeout = config.get<number>("remote.SSH.connectTimeout");
-	if (!connTimeout || connTimeout < minConnTimeout) {
-		overrides.push({
-			key: "remote.SSH.connectTimeout",
-			value: minConnTimeout,
-		});
+	const connTimeoutKey: SshSettingKey = "remote.SSH.connectTimeout";
+	const { value: minConnTimeout } = RECOMMENDED_SSH_SETTINGS[connTimeoutKey];
+	const connTimeout = config.get<number>(connTimeoutKey);
+	if (minConnTimeout && (!connTimeout || connTimeout < minConnTimeout)) {
+		overrides.push({ key: connTimeoutKey, value: minConnTimeout });
 	}
 
-	// Set recommended defaults for settings the user hasn't configured.
-	const setIfUndefined = [
-		"remote.SSH.reconnectionGraceTime",
-		"remote.SSH.serverShutdownTimeout",
-		"remote.SSH.maxReconnectionAttempts",
-	] as const;
-	for (const key of setIfUndefined) {
+	// Set conservative defaults for settings the user hasn't configured.
+	for (const [key, value] of Object.entries(AUTO_SETUP_DEFAULTS)) {
 		if (config.get(key) === undefined) {
-			overrides.push({ key, value: RECOMMENDED_SSH_SETTINGS[key].value });
+			overrides.push({ key, value });
 		}
 	}
 

test/unit/remote/userSettings.test.ts

@@ -229,6 +229,18 @@ describe("applySettingOverrides", () => {
 		expect(raw).toContain('"remote.SSH.remotePlatform"');
 	});
 
+	it("writes null values literally instead of deleting the key", async () => {
+		const ok = await applySettingOverrides(
+			settingsPath,
+			[{ key: "remote.SSH.maxReconnectionAttempts", value: null }],
+			logger,
+		);
+
+		expect(ok).toBe(true);
+		const raw = await fsPromises.readFile(settingsPath, "utf8");
+		expect(raw).toContain('"remote.SSH.maxReconnectionAttempts": null');
+	});
+
 	it("returns false and logs warning when write fails", async () => {
 		vol.fromJSON({ [settingsPath]: "{}" });
 		const writeSpy = vi