Some fixes for better error reporting

Author: jeanp413

src/commands/workspaces.ts

@@ -133,9 +133,10 @@ export class ConnectInNewWindowCommand implements Command {
 						localSSHTestSuccess = true;
 					} catch (e) {
 						this.telemetryService.sendTelemetryException(
-							new WrapError('Local SSH: failed to connect to workspace', e, 'Unknown'),
+							new WrapError('Local SSH: failed to connect to workspace', e),
 							{
 								gitpodHost: this.hostService.gitpodHost,
+								openSSHVersion: await getOpenSSHVersion(),
 								workspaceId: wsData!.id,
 							}
 						);
@@ -183,10 +184,9 @@ export class ConnectInNewWindowCommand implements Command {
 				this.remoteService.startLocalSSHServiceServer()
 			]);
 		} catch (e) {
-			const openSSHVersion = await getOpenSSHVersion();
 			this.telemetryService.sendTelemetryException(new WrapError('Local SSH: failed to initialize local SSH', e), {
 				gitpodHost: this.hostService.gitpodHost,
-				openSSHVersion,
+				openSSHVersion: await getOpenSSHVersion(),
 				workspaceId
 
 			});
@@ -297,9 +297,10 @@ export class ConnectInCurrentWindowCommand implements Command {
 						localSSHTestSuccess = true;
 					} catch (e) {
 						this.telemetryService.sendTelemetryException(
-							new WrapError('Local SSH: failed to connect to workspace', e, 'Unknown'),
+							new WrapError('Local SSH: failed to connect to workspace', e),
 							{
 								gitpodHost: this.hostService.gitpodHost,
+								openSSHVersion: await getOpenSSHVersion(),
 								workspaceId: wsData!.id,
 							}
 						);
@@ -347,10 +348,9 @@ export class ConnectInCurrentWindowCommand implements Command {
 				this.remoteService.startLocalSSHServiceServer()
 			]);
 		} catch (e) {
-			const openSSHVersion = await getOpenSSHVersion();
 			this.telemetryService.sendTelemetryException(new WrapError('Local SSH: failed to initialize local SSH', e), {
 				gitpodHost: this.hostService.gitpodHost,
-				openSSHVersion,
+				openSSHVersion: await getOpenSSHVersion(),
 				workspaceId
 
 			});

src/remote.ts

@@ -23,27 +23,31 @@ export class NoRunningInstanceError extends Error {
 	code = 'NoRunningInstanceError';
 	constructor(readonly workspaceId: string, readonly phase?: string) {
 		super(`Failed to connect to ${workspaceId} Gitpod workspace, workspace not running: ${phase}`);
+		this.name = 'NoRunningInstanceError'
 	}
 }
 
 export class NoSSHGatewayError extends Error {
 	code = 'NoSSHGatewayError';
 	constructor(readonly host: string) {
 		super(`SSH gateway not configured for this Gitpod Host ${host}`);
+		this.name = 'NoSSHGatewayError'
 	}
 }
 
 export class NoExtensionIPCServerError extends Error {
 	code = 'NoExtensionIPCServer';
 	constructor() {
-		super('NoExtensionIPCServer');
+		super('No Extension IPC Server running');
+		this.name = 'NoExtensionIPCServerError'
 	}
 }
 
 export class NoLocalSSHSupportError extends Error {
 	code = 'NoLocalSSHSupport';
 	constructor() {
-		super('NoLocalSSHSupport');
+		super('No Local SSH support');
+		this.name = 'NoLocalSSHSupportError';
 	}
 }
 

src/remoteConnector.ts

@@ -716,10 +716,8 @@ export class RemoteConnector extends Disposable {
 
 						this.telemetryService.sendUserFlowStatus('connected', localSSHFlow);
 					} catch (e) {
-						const reason = e?.code ? e.code : 'Unknown';
-						if (reason === 'Unknown') {
-							this.telemetryService.sendTelemetryException(new WrapError('Local SSH: failed to connect to workspace', e, 'Unknown'), { ...localSSHFlow });
-						}
+						const reason = e?.code ?? (e?.name && e.name !== 'Error' ? e.name : 'Unknown');
+						this.telemetryService.sendTelemetryException(new WrapError('Local SSH: failed to connect to workspace', e), { ...localSSHFlow });
 						this.telemetryService.sendUserFlowStatus('failed', { ...localSSHFlow, reason });
 						this.logService.error(`Local SSH: failed to connect to ${params.workspaceId} Gitpod workspace:`, e);
 					}

src/ssh/nativeSSH.ts

@@ -15,6 +15,22 @@ export class NativeSSHError extends Error {
     }
 }
 
+export class SSHOutputVerificationError extends Error {
+    constructor() {
+        super();
+        this.name = 'SSHOutputVerificationError';
+        this.message = `SSH output verification failed`;
+    }
+}
+
+export class SSHCommandTimeoutError extends Error {
+    constructor() {
+        super();
+        this.name = 'SSHCommandTimeoutError';
+        this.message = `SSH command timeout`;
+    }
+}
+
 function getSSHConfigPath() {
     const sshPath = vscode.workspace.getConfiguration('remote.SSH').get<string>('path');
     return sshPath || 'ssh';
@@ -35,7 +51,7 @@ function execCommand(commmad: string, args?: string[], options?: { timeout?: num
             reject(err);
         });
         process.on('close', (code) => {
-            resolve({ code: code ?? 0 });
+            resolve({ code: code ?? 256 });
         });
     })
 
@@ -95,16 +111,18 @@ export async function testSSHConnection(username: string, hostname: string) {
     const sshPath = getSSHConfigPath();
     const randomId = crypto.randomBytes(12).toString('hex');
     // TODO: support password input so we can replace the ssh2 library
-    const resp = execCommand(sshPath, ['-T', '-o', 'ConnectTimeout=5', `${username}@${hostname}`, `echo "${randomId}"`], { timeout: 5500 });
+    const resp = execCommand(sshPath, ['-T', '-o', 'ConnectTimeout=8', `${username}@${hostname}`, `echo "${randomId}"`], { timeout: 8500 });
     const { code } = await resp.completed;
     if (code === 0) {
         // When using ssh gateway sometimes the command output is missing, probably some bug on go code?
         // If not then just check for code === 0, works fine with websocket though
         if (resp.stdout.includes(randomId)) {
             return;
         } else {
-            throw new Error('SSH output verification failed');
+            throw new SSHOutputVerificationError();
         }
+    } else if (code === 256) {
+        throw new SSHCommandTimeoutError();
     } else {
         throw new NativeSSHError(code, resp.stdout, resp.stderr);
     }