Centralize vscodeProposed access via global module (#745)

Replace constructor injection of vscodeProposed with a global module
that provides a lazy proxy to the proposed VS Code API. The proxy falls
back to regular vscode before initialization, making it safe to use
during tests and early startup.

Author: EhabY

src/commands.ts

@@ -21,14 +21,14 @@ import { type Logger } from "./logging/logger";
 import { type LoginCoordinator } from "./login/loginCoordinator";
 import { maybeAskAgent, maybeAskUrl } from "./promptUtils";
 import { escapeCommandArg, toRemoteAuthority, toSafeHost } from "./util";
+import { vscodeProposed } from "./vscodeProposed";
 import {
 	AgentTreeItem,
 	type OpenableTreeItem,
 	WorkspaceTreeItem,
 } from "./workspace/workspacesProvider";
 
 export class Commands {
-	private readonly vscodeProposed: typeof vscode;
 	private readonly logger: Logger;
 	private readonly pathResolver: PathResolver;
 	private readonly mementoManager: MementoManager;
@@ -53,7 +53,6 @@ export class Commands {
 		private readonly extensionClient: CoderApi,
 		private readonly deploymentManager: DeploymentManager,
 	) {
-		this.vscodeProposed = serviceContainer.getVsCodeProposed();
 		this.logger = serviceContainer.getLogger();
 		this.pathResolver = serviceContainer.getPathResolver();
 		this.mementoManager = serviceContainer.getMementoManager();
@@ -492,7 +491,7 @@ export class Commands {
 		if (!this.workspace || !this.remoteWorkspaceClient) {
 			return;
 		}
-		const action = await this.vscodeProposed.window.showWarningMessage(
+		const action = await vscodeProposed.window.showWarningMessage(
 			"Update Workspace",
 			{
 				useCustom: true,

src/core/binaryLock.ts

@@ -3,6 +3,7 @@ import * as lockfile from "proper-lockfile";
 import * as vscode from "vscode";
 
 import { type Logger } from "../logging/logger";
+import { vscodeProposed } from "../vscodeProposed";
 
 import * as downloadProgress from "./downloadProgress";
 
@@ -21,10 +22,7 @@ type LockRelease = () => Promise<void>;
  * VS Code windows downloading the same binary.
  */
 export class BinaryLock {
-	constructor(
-		private readonly vscodeProposed: typeof vscode,
-		private readonly output: Logger,
-	) {}
+	constructor(private readonly output: Logger) {}
 
 	/**
 	 * Acquire the lock, or wait for another process if the lock is held.
@@ -78,7 +76,7 @@ export class BinaryLock {
 		binPath: string,
 		progressLogPath: string,
 	): Promise<LockRelease> {
-		return await this.vscodeProposed.window.withProgress(
+		return await vscodeProposed.window.withProgress(
 			{
 				location: vscode.ProgressLocation.Notification,
 				title: "Another window is downloading the Coder CLI binary",

src/core/cliManager.ts

@@ -14,6 +14,7 @@ import * as vscode from "vscode";
 import { errToStr } from "../api/api-helper";
 import { type Logger } from "../logging/logger";
 import * as pgp from "../pgp";
+import { vscodeProposed } from "../vscodeProposed";
 
 import { BinaryLock } from "./binaryLock";
 import * as cliUtils from "./cliUtils";
@@ -24,11 +25,10 @@ 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);
+		this.binaryLock = new BinaryLock(output);
 	}
 
 	/**
@@ -200,7 +200,7 @@ export class CliManager {
 		version: string,
 		reason: string,
 	): Promise<boolean> {
-		const choice = await this.vscodeProposed.window.showErrorMessage(
+		const choice = await vscodeProposed.window.showErrorMessage(
 			`${reason}. Run version ${version} anyway?`,
 			"Run",
 		);
@@ -621,7 +621,7 @@ export class CliManager {
 				options.push("Download signature");
 			}
 			options.push("Run without verification");
-			const action = await this.vscodeProposed.window.showWarningMessage(
+			const action = await vscodeProposed.window.showWarningMessage(
 				status === 404 ? "Signature not found" : "Failed to download signature",
 				{
 					useCustom: true,
@@ -675,7 +675,7 @@ export class CliManager {
 					this.output,
 				);
 			} catch (error) {
-				const action = await this.vscodeProposed.window.showWarningMessage(
+				const action = await vscodeProposed.window.showWarningMessage(
 					// VerificationError should be the only thing that throws, but
 					// unfortunately caught errors are always type unknown.
 					error instanceof pgp.VerificationError

src/core/container.ts

@@ -22,10 +22,7 @@ export class ServiceContainer implements vscode.Disposable {
 	private readonly contextManager: ContextManager;
 	private readonly loginCoordinator: LoginCoordinator;
 
-	constructor(
-		context: vscode.ExtensionContext,
-		private readonly vscodeProposed: typeof vscode = vscode,
-	) {
+	constructor(context: vscode.ExtensionContext) {
 		this.logger = vscode.window.createOutputChannel("Coder", { log: true });
 		this.pathResolver = new PathResolver(
 			context.globalStorageUri.fsPath,
@@ -37,25 +34,16 @@ export class ServiceContainer implements vscode.Disposable {
 			context.globalState,
 			this.logger,
 		);
-		this.cliManager = new CliManager(
-			this.vscodeProposed,
-			this.logger,
-			this.pathResolver,
-		);
+		this.cliManager = new CliManager(this.logger, this.pathResolver);
 		this.contextManager = new ContextManager(context);
 		this.loginCoordinator = new LoginCoordinator(
 			this.secretsManager,
 			this.mementoManager,
-			this.vscodeProposed,
 			this.logger,
 			context.extension.id,
 		);
 	}
 
-	getVsCodeProposed(): typeof vscode {
-		return this.vscodeProposed;
-	}
-
 	getPathResolver(): PathResolver {
 		return this.pathResolver;
 	}

src/error/certificateError.ts

@@ -1,4 +1,4 @@
-import * as vscode from "vscode";
+import { vscodeProposed } from "../vscodeProposed";
 
 /**
  * Base class for certificate-related errors that can display notifications to users.
@@ -23,7 +23,7 @@ export abstract class CertificateError extends Error {
 		const message =
 			!modal && title ? `${title}: ${this.detail}` : title || this.detail;
 
-		return await vscode.window.showErrorMessage(
+		return await vscodeProposed.window.showErrorMessage(
 			message,
 			{ modal, useCustom: modal, detail: this.detail },
 			...(items ?? []),

src/extension.ts

@@ -18,6 +18,7 @@ import { OAuthSessionManager } from "./oauth/sessionManager";
 import { Remote } from "./remote/remote";
 import { getRemoteSshExtension } from "./remote/sshExtension";
 import { registerUriHandler } from "./uri/uriHandler";
+import { initVscodeProposed } from "./vscodeProposed";
 import {
 	WorkspaceProvider,
 	WorkspaceQuery,
@@ -53,7 +54,10 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 		);
 	}
 
-	const serviceContainer = new ServiceContainer(ctx, vscodeProposed);
+	// Initialize the global vscodeProposed module for use throughout the extension
+	initVscodeProposed(vscodeProposed);
+
+	const serviceContainer = new ServiceContainer(ctx);
 	ctx.subscriptions.push(serviceContainer);
 
 	const output = serviceContainer.getLogger();
@@ -184,12 +188,7 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 	const commands = new Commands(serviceContainer, client, deploymentManager);
 
 	ctx.subscriptions.push(
-		registerUriHandler(
-			serviceContainer,
-			deploymentManager,
-			commands,
-			vscodeProposed,
-		),
+		registerUriHandler(serviceContainer, deploymentManager, commands),
 		vscode.commands.registerCommand(
 			"coder.login",
 			commands.login.bind(commands),

src/login/loginCoordinator.ts

@@ -8,6 +8,7 @@ import { CertificateError } from "../error/certificateError";
 import { OAuthAuthorizer } from "../oauth/authorizer";
 import { buildOAuthTokenData } from "../oauth/utils";
 import { maybeAskAuthMethod, maybeAskUrl } from "../promptUtils";
+import { vscodeProposed } from "../vscodeProposed";
 
 import type { User } from "coder/site/src/api/typesGenerated";
 
@@ -37,7 +38,6 @@ export class LoginCoordinator implements vscode.Disposable {
 	constructor(
 		private readonly secretsManager: SecretsManager,
 		private readonly mementoManager: MementoManager,
-		private readonly vscodeProposed: typeof vscode,
 		private readonly logger: Logger,
 		extensionId: string,
 	) {
@@ -78,7 +78,7 @@ export class LoginCoordinator implements vscode.Disposable {
 		const { safeHostname, url, detailPrefix, message } = options;
 		return this.executeWithGuard(async () => {
 			// Show dialog promise
-			const dialogPromise = this.vscodeProposed.window
+			const dialogPromise = vscodeProposed.window
 				.showErrorMessage(
 					message || "Authentication Required",
 					{
@@ -291,9 +291,11 @@ export class LoginCoordinator implements vscode.Disposable {
 		if (isAutoLogin) {
 			this.logger.warn("Failed to log in to Coder server:", message);
 		} else if (err instanceof CertificateError) {
-			void err.showNotification("Failed to log in to Coder server");
+			void err.showNotification("Failed to log in to Coder server", {
+				modal: true,
+			});
 		} else {
-			void this.vscodeProposed.window.showErrorMessage(
+			void vscodeProposed.window.showErrorMessage(
 				"Failed to log in to Coder server",
 				{
 					detail: message,

src/remote/remote.ts

@@ -43,6 +43,7 @@ import {
 	expandPath,
 	parseRemoteAuthority,
 } from "../util";
+import { vscodeProposed } from "../vscodeProposed";
 import { WorkspaceMonitor } from "../workspace/workspaceMonitor";
 
 import {
@@ -62,8 +63,6 @@ export interface RemoteDetails extends vscode.Disposable {
 }
 
 export class Remote {
-	// We use the proposed API to get access to useCustom in dialogs.
-	private readonly vscodeProposed: typeof vscode;
 	private readonly logger: Logger;
 	private readonly pathResolver: PathResolver;
 	private readonly cliManager: CliManager;
@@ -76,7 +75,6 @@ export class Remote {
 		private readonly commands: Commands,
 		private readonly extensionContext: vscode.ExtensionContext,
 	) {
-		this.vscodeProposed = serviceContainer.getVsCodeProposed();
 		this.logger = serviceContainer.getLogger();
 		this.pathResolver = serviceContainer.getPathResolver();
 		this.cliManager = serviceContainer.getCliManager();
@@ -268,7 +266,7 @@ export class Remote {
 
 			// Server versions before v0.14.1 don't support the vscodessh command!
 			if (!featureSet.vscodessh) {
-				await this.vscodeProposed.window.showErrorMessage(
+				await vscodeProposed.window.showErrorMessage(
 					"Incompatible Server",
 					{
 						detail:
@@ -304,16 +302,15 @@ export class Remote {
 				}
 				switch (error.response?.status) {
 					case 404: {
-						const result =
-							await this.vscodeProposed.window.showInformationMessage(
-								`That workspace doesn't exist!`,
-								{
-									modal: true,
-									detail: `${workspaceName} cannot be found on ${baseUrlRaw}. Maybe it was deleted...`,
-									useCustom: true,
-								},
-								"Open Workspace",
-							);
+						const result = await vscodeProposed.window.showInformationMessage(
+							`That workspace doesn't exist!`,
+							{
+								modal: true,
+								detail: `${workspaceName} cannot be found on ${baseUrlRaw}. Maybe it was deleted...`,
+								useCustom: true,
+							},
+							"Open Workspace",
+						);
 						disposables.forEach((d) => {
 							d.dispose();
 						});
@@ -345,7 +342,6 @@ export class Remote {
 				workspace,
 				workspaceClient,
 				this.logger,
-				this.vscodeProposed,
 				this.contextManager,
 			);
 			disposables.push(
@@ -366,12 +362,11 @@ export class Remote {
 				featureSet,
 				this.logger,
 				this.pathResolver,
-				this.vscodeProposed,
 			);
 			disposables.push(stateMachine);
 
 			try {
-				workspace = await this.vscodeProposed.window.withProgress(
+				workspace = await vscodeProposed.window.withProgress(
 					{
 						location: vscode.ProgressLocation.Notification,
 						cancellable: false,
@@ -452,10 +447,10 @@ export class Remote {
 
 			// Do some janky setting manipulation.
 			this.logger.info("Modifying settings...");
-			const remotePlatforms = this.vscodeProposed.workspace
+			const remotePlatforms = vscodeProposed.workspace
 				.getConfiguration()
 				.get<Record<string, string>>("remote.SSH.remotePlatform", {});
-			const connTimeout = this.vscodeProposed.workspace
+			const connTimeout = vscodeProposed.workspace
 				.getConfiguration()
 				.get<number | undefined>("remote.SSH.connectTimeout");
 
@@ -885,7 +880,7 @@ export class Remote {
 				continue;
 			}
 
-			const result = await this.vscodeProposed.window.showErrorMessage(
+			const result = await vscodeProposed.window.showErrorMessage(
 				"Unexpected SSH Config Option",
 				{
 					useCustom: true,
@@ -1007,7 +1002,7 @@ export class Remote {
 		}
 		// VS Code caches resource label formatters in it's global storage SQLite database
 		// under the key "memento/cachedResourceLabelFormatters2".
-		return this.vscodeProposed.workspace.registerResourceLabelFormatter({
+		return vscodeProposed.workspace.registerResourceLabelFormatter({
 			scheme: "vscode-remote",
 			// authority is optional but VS Code prefers formatters that most
 			// accurately match the requested authority, so we include it.

src/remote/workspaceStateMachine.ts

@@ -6,6 +6,7 @@ import {
 } from "../api/workspace";
 import { maybeAskAgent } from "../promptUtils";
 import { type AuthorityParts } from "../util";
+import { vscodeProposed } from "../vscodeProposed";
 
 import { TerminalSession } from "./terminalSession";
 
@@ -44,7 +45,6 @@ export class WorkspaceStateMachine implements vscode.Disposable {
 		private readonly featureSet: FeatureSet,
 		private readonly logger: Logger,
 		private readonly pathResolver: PathResolver,
-		private readonly vscodeProposed: typeof vscode,
 	) {
 		this.terminal = new TerminalSession("Workspace Build");
 	}
@@ -231,7 +231,7 @@ export class WorkspaceStateMachine implements vscode.Disposable {
 	}
 
 	private async confirmStart(workspaceName: string): Promise<boolean> {
-		const action = await this.vscodeProposed.window.showInformationMessage(
+		const action = await vscodeProposed.window.showInformationMessage(
 			`Unable to connect to the workspace ${workspaceName} because it is not running. Start the workspace?`,
 			{
 				useCustom: true,

src/uri/uriHandler.ts

@@ -7,6 +7,7 @@ import { type DeploymentManager } from "../deployment/deploymentManager";
 import { CALLBACK_PATH } from "../oauth/utils";
 import { maybeAskUrl } from "../promptUtils";
 import { toSafeHost } from "../util";
+import { vscodeProposed } from "../vscodeProposed";
 
 interface UriRouteContext {
 	params: URLSearchParams;
@@ -30,7 +31,6 @@ export function registerUriHandler(
 	serviceContainer: ServiceContainer,
 	deploymentManager: DeploymentManager,
 	commands: Commands,
-	vscodeProposed: typeof vscode,
 ): vscode.Disposable {
 	const output = serviceContainer.getLogger();