More feedback

Author: jeanp413

extensions/gitpod/src/remoteConnector.ts

@@ -64,6 +64,14 @@ function checkRunning(pid: number): true | Error {
 	}
 }
 
+class LocalAppError extends Error {
+	override name = 'LocalAppError';
+
+	constructor(message?: string, readonly logPath?: string) {
+		super(message);
+	}
+}
+
 export default class RemoteConnector extends Disposable {
 
 	public static AUTH_COMPLETE_PATH = '/auth-complete';
@@ -391,7 +399,6 @@ export default class RemoteConnector extends Disposable {
 
 		const workspaceInfo = await withServerApi(session.accessToken, serviceUrl.toString(), service => service.server.getWorkspace(workspaceId), this.logger);
 		if (!workspaceInfo.latestInstance) {
-			this.logger.error('No running instance for this workspaceId', workspaceId);
 			throw new Error('no_running_instance');
 		}
 
@@ -401,31 +408,29 @@ export default class RemoteConnector extends Disposable {
 		const sshHostKeyResponse = await fetch(sshHostKeyEndPoint);
 		if (!sshHostKeyResponse.ok) {
 			// Gitpod SSH gateway not configured
-			this.logger.error('SSH gateway not configured for this Gitpod Host', gitpodHost);
 			throw new Error('no_ssh_gateway');
 		}
 
 		const ownerToken = await withServerApi(session.accessToken, serviceUrl.toString(), service => service.server.getOwnerToken(workspaceId), this.logger);
 
 		const sshDestInfo = {
 			user: `${workspaceId}#${ownerToken}`,
-			hostName: workspaceUrl.host
+			// See https://github.com/gitpod-io/gitpod/pull/9786 for reasoning about `.ssh` suffix
+			hostName: workspaceUrl.host.replace(workspaceId, `${workspaceId}.ssh`)
 		};
 
 		return Buffer.from(JSON.stringify(sshDestInfo), 'utf8').toString('hex');
 	}
 
-	private async getWorkspaceLocalAppSSHDestination(params: SSHConnectionParams): Promise<{ localAppSSHDest?: string; localAppSSHConfigPath?: string; }> {
+	private async getWorkspaceLocalAppSSHDestination(params: SSHConnectionParams): Promise<{ localAppSSHDest: string; localAppSSHConfigPath: string; }> {
 		return vscode.window.withProgress({
 			location: vscode.ProgressLocation.Notification,
 			cancellable: true,
 			title: `Connecting to Gitpod workspace: ${params.workspaceId}`
 		}, async (_, token) => {
 			let localAppLogPath: string | undefined;
-
-			let connection: ResolveSSHConnectionResponse | undefined;
 			try {
-				connection = await this.withLocalApp(params.gitpodHost, (client, config) => {
+				const connection = await this.withLocalApp(params.gitpodHost, (client, config) => {
 					localAppLogPath = config.logPath;
 
 					const request = new ResolveSSHConnectionRequest();
@@ -435,26 +440,18 @@ export default class RemoteConnector extends Disposable {
 						client.resolveSSHConnection(request, (e, r) => r ? resolve(r) : reject(e))
 					);
 				}, token);
-			} catch (e) {
-				if (e instanceof Error && e.message !== 'cancelled') {
-					this.logger.error(`Failed to connect to remote workspace ${params.workspaceId} using local app`, e);
 
-					const seeLogs = 'See Logs';
-					const action = await vscode.window.showErrorMessage(`Failed to connect to remote workspace ${params.workspaceId} using local app`, seeLogs);
-					if (action === seeLogs) {
-						this.logger.show();
-						if (localAppLogPath) {
-							const document = await vscode.workspace.openTextDocument(vscode.Uri.file(localAppLogPath));
-							vscode.window.showTextDocument(document);
-						}
-					}
+				return {
+					localAppSSHDest: connection.getHost(),
+					localAppSSHConfigPath: connection.getConfigFile()
+				};
+			} catch (e) {
+				if (e instanceof Error && e.message === 'cancelled') {
+					throw e;
 				}
-			}
 
-			return {
-				localAppSSHDest: connection?.getHost(),
-				localAppSSHConfigPath: connection?.getConfigFile()
-			};
+				throw new LocalAppError(e.message, localAppLogPath);
+			}
 		});
 	}
 
@@ -534,21 +531,47 @@ export default class RemoteConnector extends Disposable {
 		try {
 			sshDestination = await this.getWorkspaceSSHDestination(params.workspaceId, params.gitpodHost);
 		} catch (e) {
-			if (e instanceof Error && e.message === 'no_running_instance') {
+			if (e instanceof Error && e.message === 'no_ssh_gateway') {
+				this.logger.error('SSH gateway not configured for this Gitpod Host', params.gitpodHost);
+				// Do nothing and continue execution
+			} else if (e instanceof Error && e.message === 'no_running_instance') {
+				this.logger.error('No running instance for this workspaceId', params.workspaceId);
 				vscode.window.showErrorMessage(`Failed to connect to remote workspace: No running instance for '${params.workspaceId}'`);
 				return;
+			} else {
+				this.logger.error(`Failed to connect to remote workspace ${params.workspaceId}`, e);
+				const seeLogs = 'See Logs';
+				const action = await vscode.window.showErrorMessage(`Failed to connect to remote workspace ${params.workspaceId}`, seeLogs);
+				if (action === seeLogs) {
+					this.logger.show();
+				}
+				return;
 			}
 		}
 
 		const usingSSHGateway = !!sshDestination;
 		let localAppSSHConfigPath: string | undefined;
 		if (!usingSSHGateway) {
-			vscode.window.showInformationMessage(`Falling back connecting to remote workspace using local app. You should update your Gitpod installation [enabling direct SSH access](https://github.com/gitpod-io/gitpod/blob/main/install/installer/docs/workspace-ssh-access.md)`);
+			vscode.window.showWarningMessage(`${params.gitpodHost} does not support [direct SSH access](https://github.com/gitpod-io/gitpod/blob/main/install/installer/docs/workspace-ssh-access.md), connecting via the deprecated SSH tunnel over WebSocket.`);
 			try {
 				const localAppDestData = await this.getWorkspaceLocalAppSSHDestination(params);
 				sshDestination = localAppDestData.localAppSSHDest;
 				localAppSSHConfigPath = localAppDestData.localAppSSHConfigPath;
 			} catch (e) {
+				this.logger.error(`Failed to connect to remote workspace ${params.workspaceId}`, e);
+				if (e instanceof LocalAppError) {
+					const seeLogs = 'See Logs';
+					const action = await vscode.window.showErrorMessage(`Failed to connect to remote workspace ${params.workspaceId}`, seeLogs);
+					if (action === seeLogs) {
+						this.logger.show();
+						if (e.logPath) {
+							const document = await vscode.workspace.openTextDocument(vscode.Uri.file(e.logPath));
+							vscode.window.showTextDocument(document);
+						}
+					}
+				} else {
+					// Do nothing, user cancelled the operation
+				}
 				return;
 			}
 		}