feat: set 'vscode_connection' as build reason on workspace start (#550)

kacpersaw · ethanndickson · web-flow · commit 0407d72f68ad · 2025-07-22T13:24:26.000+02:00
Co-authored-by: Ethan &lt;39577870+ethanndickson@users.noreply.github.com&gt;
diff --git a/src/api.ts b/src/api.ts
@@ -12,6 +12,7 @@ import * as vscode from "vscode";
 import * as ws from "ws";
 import { errToStr } from "./api-helper";
 import { CertificateError } from "./error";
+import { FeatureSet } from "./featureSet";
 import { getHeaderArgs } from "./headers";
 import { getProxyForUrl } from "./proxy";
 import { Storage } from "./storage";
@@ -174,6 +175,7 @@ export async function startWorkspaceIfStoppedOrFailed(
 	binPath: string,
 	workspace: Workspace,
 	writeEmitter: vscode.EventEmitter<string>,
+	featureSet: FeatureSet,
 ): Promise<Workspace> {
 	// Before we start a workspace, we make an initial request to check it's not already started
 	const updatedWorkspace = await restClient.getWorkspace(workspace.id);
@@ -191,6 +193,10 @@ export async function startWorkspaceIfStoppedOrFailed(
 			"--yes",
 			workspace.owner_name + "/" + workspace.name,
 		];
+		if (featureSet.buildReason) {
+			startArgs.push(...["--reason", "vscode_connection"]);
+		}
+
 		const startProcess = spawn(binPath, startArgs);
 
 		startProcess.stdout.on("data", (data: Buffer) => {
diff --git a/src/featureSet.ts b/src/featureSet.ts
@@ -4,6 +4,7 @@ export type FeatureSet = {
 	vscodessh: boolean;
 	proxyLogDirectory: boolean;
 	wildcardSSH: boolean;
+	buildReason: boolean;
 };
 
 /**
@@ -29,5 +30,10 @@ export function featureSetForVersion(
 		wildcardSSH:
 			(version ? version.compare("2.19.0") : -1) >= 0 ||
 			version?.prerelease[0] === "devel",
+
+		// The --reason flag was added to `coder start` in 2.25.0
+		buildReason:
+			(version?.compare("2.25.0") || 0) >= 0 ||
+			version?.prerelease[0] === "devel",
 	};
 }
diff --git a/src/remote.ts b/src/remote.ts
@@ -68,6 +68,7 @@ export class Remote {
 		workspace: Workspace,
 		label: string,
 		binPath: string,
+		featureSet: FeatureSet,
 	): Promise<Workspace | undefined> {
 		const workspaceName = `${workspace.owner_name}/${workspace.name}`;
 
@@ -136,6 +137,7 @@ export class Remote {
 									binPath,
 									workspace,
 									writeEmitter,
+									featureSet,
 								);
 								break;
 							case "failed":
@@ -153,6 +155,7 @@ export class Remote {
 										binPath,
 										workspace,
 										writeEmitter,
+										featureSet,
 									);
 									break;
 								}
@@ -383,6 +386,7 @@ export class Remote {
 				workspace,
 				parts.label,
 				binaryPath,
+				featureSet,
 			);
 			if (!updatedWorkspace) {
 				// User declined to start the workspace.
