Deployment management refactoring

Author: EhabY

src/commands.ts

@@ -13,7 +13,7 @@ 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 { type DeploymentManager } from "./deployment";
+import { type DeploymentManager } from "./deployment/deploymentManager";
 import { CertificateError } from "./error";
 import { type Logger } from "./logging/logger";
 import { type LoginCoordinator } from "./login/loginCoordinator";

src/core/secretsManager.ts

@@ -3,7 +3,7 @@ import { toSafeHost } from "../util";
 
 import type { Memento, SecretStorage, Disposable } from "vscode";
 
-import type { Deployment } from "../deployment";
+import type { Deployment } from "../deployment/types";
 
 // Each deployment has its own key to ensure atomic operations (multiple windows
 // writing to a shared key could drop data) and to receive proper VS Code events.

src/deployment/deploymentManager.ts

@@ -1,20 +1,16 @@
-import { type CoderApi } from "../api/coderApi";
-import { type ServiceContainer } from "../core/container";
-import { type ContextManager } from "../core/contextManager";
-import { type MementoManager } from "../core/mementoManager";
-import { type SecretsManager } from "../core/secretsManager";
-import { type Logger } from "../logging/logger";
-import { type WorkspaceProvider } from "../workspace/workspacesProvider";
-
-import {
-	type Deployment,
-	type DeploymentWithAuth,
-	isAuthenticated,
-} from "./types";
-
 import type { User } from "coder/site/src/api/typesGenerated";
 import type * as vscode from "vscode";
 
+import type { CoderApi } from "../api/coderApi";
+import type { ServiceContainer } from "../core/container";
+import type { ContextManager } from "../core/contextManager";
+import type { MementoManager } from "../core/mementoManager";
+import type { SecretsManager } from "../core/secretsManager";
+import type { Logger } from "../logging/logger";
+import type { WorkspaceProvider } from "../workspace/workspacesProvider";
+
+import type { Deployment, DeploymentWithAuth } from "./types";
+
 /**
  * Manages deployment state for the extension.
  *
@@ -72,7 +68,7 @@ export class DeploymentManager implements vscode.Disposable {
 	 * Check if we have an authenticated deployment (with a valid user).
 	 */
 	public isAuthenticated(): boolean {
-		return isAuthenticated(this.currentDeployment);
+		return this.currentDeployment?.user !== undefined;
 	}
 
 	/**
@@ -101,6 +97,17 @@ export class DeploymentManager implements vscode.Disposable {
 		await this.tryFetchAndUpgradeUser();
 	}
 
+	private setDeploymentCore(deployment: DeploymentWithAuth): void {
+		if (deployment.token === undefined) {
+			this.client.setHost(deployment.url);
+		} else {
+			this.client.setCredentials(deployment.url, deployment.token);
+		}
+		this.registerAuthListener(deployment.safeHostname);
+		this.currentDeployment = { ...deployment };
+		this.updateAuthContexts(deployment.user);
+	}
+
 	/**
 	 * Log out from the current deployment.
 	 */
@@ -116,17 +123,6 @@ export class DeploymentManager implements vscode.Disposable {
 		await this.secretsManager.setCurrentDeployment(undefined);
 	}
 
-	private setDeploymentCore(deployment: DeploymentWithAuth): void {
-		if (deployment.token === undefined) {
-			this.client.setHost(deployment.url);
-		} else {
-			this.client.setCredentials(deployment.url, deployment.token);
-		}
-		this.registerAuthListener(deployment.safeHostname);
-		this.currentDeployment = { ...deployment };
-		this.updateAuthContexts(deployment.user);
-	}
-
 	public dispose(): void {
 		this.authListenerDisposable?.dispose();
 		this.crossWindowSyncDisposable?.dispose();
@@ -137,6 +133,7 @@ export class DeploymentManager implements vscode.Disposable {
 			this.secretsManager.onDidChangeCurrentDeployment(
 				async ({ deployment }) => {
 					if (this.isAuthenticated()) {
+						// Ignore if we are already authenticated
 						return;
 					}
 
@@ -158,15 +155,15 @@ export class DeploymentManager implements vscode.Disposable {
 	 * Register auth listener for the given deployment hostname.
 	 * Updates credentials when they change (token refresh, cross-window sync).
 	 */
-	private registerAuthListener(safeHost: string): void {
+	private registerAuthListener(safeHostname: string): void {
 		this.authListenerDisposable?.dispose();
 
-		this.logger.debug("Registering auth listener for hostname", safeHost);
+		this.logger.debug("Registering auth listener for hostname", safeHostname);
 		this.authListenerDisposable = this.secretsManager.onDidChangeSessionAuth(
-			safeHost,
+			safeHostname,
 			async (auth) => {
 				if (auth) {
-					if (this.currentDeployment?.safeHostname !== safeHost) {
+					if (this.currentDeployment?.safeHostname !== safeHostname) {
 						return;
 					}
 
@@ -212,7 +209,7 @@ export class DeploymentManager implements vscode.Disposable {
 	}
 
 	/**
-	 * Refresh all workspace providers.
+	 * Refresh all workspace providers asynchronously.
 	 */
 	private refreshWorkspaces(): void {
 		for (const provider of this.workspaceProviders) {

src/deployment/index.ts

@@ -17,13 +17,7 @@ export interface Deployment {
  * - Undefined token means that we should not override the existing token (if any).
  * - Undefined user means the deployment is set but not authenticated yet.
  */
-export type DeploymentWithAuth = Deployment & { token?: string; user?: User };
-
-/**
- * Type guard to check if a deployment has a valid authenticated user.
- */
-export function isAuthenticated(
-	deployment: DeploymentWithAuth | null,
-): deployment is Deployment & { user: User } {
-	return deployment?.user !== undefined;
-}
+export type DeploymentWithAuth = Deployment & {
+	readonly token?: string;
+	readonly user?: User;
+};

src/deployment/types.ts

@@ -12,7 +12,7 @@ import { needToken } from "./api/utils";
 import { Commands } from "./commands";
 import { ServiceContainer } from "./core/container";
 import { type SecretsManager } from "./core/secretsManager";
-import { DeploymentManager } from "./deployment";
+import { DeploymentManager } from "./deployment/deploymentManager";
 import { CertificateError, getErrorDetail } from "./error";
 import { maybeAskUrl } from "./promptUtils";
 import { Remote } from "./remote/remote";

src/extension.ts

@@ -3,15 +3,16 @@ import * as vscode from "vscode";
 
 import { CoderApi } from "../api/coderApi";
 import { needToken } from "../api/utils";
-import { type MementoManager } from "../core/mementoManager";
-import { type SecretsManager } from "../core/secretsManager";
-import { type Deployment } from "../deployment";
 import { CertificateError } from "../error";
-import { type Logger } from "../logging/logger";
 import { maybeAskUrl } from "../promptUtils";
 
 import type { User } from "coder/site/src/api/typesGenerated";
 
+import type { MementoManager } from "../core/mementoManager";
+import type { SecretsManager } from "../core/secretsManager";
+import type { Deployment } from "../deployment/types";
+import type { Logger } from "../logging/logger";
+
 interface LoginResult {
 	success: boolean;
 	user?: User;