Improve ssh analytics (#2)

Author: jeanp413

src/extension.ts

@@ -69,11 +69,6 @@ export async function activate(context: vscode.ExtensionContext) {
 		}
 	}));
 
-	// For analitycs, will be called by gitpod-remote extension
-	context.subscriptions.push(vscode.commands.registerCommand('__gitpod.getLocalMachineId', () => {
-		return vscode.env.machineId;
-	}));
-
 	const authProvider = new GitpodAuthenticationProvider(context, logger, telemetry);
 	const remoteConnector = new RemoteConnector(context, logger, telemetry);
 	context.subscriptions.push(authProvider);
@@ -89,6 +84,10 @@ export async function activate(context: vscode.ExtensionContext) {
 		}
 	}));
 
+	if (await remoteConnector.checkRemoteConnectionSuccessful()) {
+		context.subscriptions.push(vscode.commands.registerCommand('gitpod.api.autoTunnel', remoteConnector.autoTunnelCommand, remoteConnector));
+	}
+
 	if (!context.globalState.get<boolean>(FIRST_INSTALL_KEY, false)) {
 		await context.globalState.update(FIRST_INSTALL_KEY, true);
 		telemetry.sendTelemetryEvent('gitpod_desktop_installation', { kind: 'install' });

src/remoteConnector.ts

@@ -107,10 +107,6 @@ export default class RemoteConnector extends Disposable {
 		super();
 
 		this.releaseStaleLocks();
-
-		if (vscode.env.remoteName && context.extension.extensionKind === vscode.ExtensionKind.UI) {
-			this._register(vscode.commands.registerCommand('gitpod.api.autoTunnel', this.autoTunnelCommand.bind(this)));
-		}
 	}
 
 	private releaseStaleLocks(): void {
@@ -666,8 +662,6 @@ export default class RemoteConnector extends Disposable {
 				if (password) {
 					await this.showSSHPasswordModal(password);
 				}
-
-				this.telemetry.sendTelemetryEvent('vscode_desktop_ssh', { kind: 'gateway', status: 'connected', ...params });
 			} catch (e) {
 				this.telemetry.sendTelemetryEvent('vscode_desktop_ssh', { kind: 'gateway', status: 'failed', reason: e.toString(), ...params });
 				if (e instanceof NoSSHGatewayError) {
@@ -706,8 +700,6 @@ export default class RemoteConnector extends Disposable {
 				const localAppDestData = await this.getWorkspaceLocalAppSSHDestination(params);
 				sshDestination = localAppDestData.localAppSSHDest;
 				localAppSSHConfigPath = localAppDestData.localAppSSHConfigPath;
-
-				this.telemetry.sendTelemetryEvent('vscode_desktop_ssh', { kind: 'local-app', status: 'connected', ...params });
 			} catch (e) {
 				this.logger.error(`Failed to connect ${params.workspaceId} Gitpod workspace:`, e);
 				if (e instanceof LocalAppError) {
@@ -734,6 +726,8 @@ export default class RemoteConnector extends Disposable {
 
 		await this.updateRemoteSSHConfig(usingSSHGateway, localAppSSHConfigPath);
 
+		await this.context.globalState.update(sshDestination!, { ...params, usingSSHGateway });
+
 		vscode.commands.executeCommand(
 			'vscode.openFolder',
 			vscode.Uri.parse(`vscode-remote://ssh-remote+${sshDestination}${uri.path || '/'}`),
@@ -748,7 +742,7 @@ export default class RemoteConnector extends Disposable {
 			const configKey = `config/${authority}`;
 			const localAppconfig = this.context.globalState.get<LocalAppConfig>(configKey);
 			if (!localAppconfig || checkRunning(localAppconfig.pid) !== true) {
-				// Do nothing if we are using SSH gateway
+				// Do nothing if we are using SSH gateway and local app is not running
 				return;
 			}
 		}
@@ -766,4 +760,53 @@ export default class RemoteConnector extends Disposable {
 			this.logger.error('Failed to disable auto tunneling:', e);
 		}
 	}
+
+	public async checkRemoteConnectionSuccessful() {
+		const isRemoteExtensionHostRunning = async () => {
+			try {
+				// Invoke command from gitpot-remote extension to test if connection is successful
+				await vscode.commands.executeCommand('__gitpod.getGitpodRemoteLogsUri');
+				return true;
+			} catch {
+				return false;
+			}
+		};
+
+		const remoteUri = vscode.workspace.workspaceFile || vscode.workspace.workspaceFolders?.[0].uri;
+		if (vscode.env.remoteName === 'ssh-remote' && this.context.extension.extensionKind === vscode.ExtensionKind.UI && remoteUri) {
+			const [, sshDestStr] = remoteUri.authority.split('+');
+			const sshDest: { user: string; hostName: string } = JSON.parse(Buffer.from(sshDestStr, 'hex').toString('utf8'));
+			const gitpodHost = vscode.workspace.getConfiguration('gitpod').get<string>('host')!;
+			const host = new URL(gitpodHost).host;
+			const connectionSuccessful = sshDest.hostName.endsWith(host) && await isRemoteExtensionHostRunning();
+
+			const connectionInfo = this.context.globalState.get<SSHConnectionParams & { usingSSHGateway: boolean }>(sshDestStr);
+			if (connectionInfo) {
+				const kind = connectionInfo.usingSSHGateway ? 'gateway' : 'local-app';
+				if (connectionSuccessful) {
+					this.telemetry.sendTelemetryEvent('vscode_desktop_ssh', {
+						kind,
+						status: 'connected',
+						instanceId: connectionInfo.instanceId,
+						workspaceId: connectionInfo.workspaceId,
+						gitpodHost: connectionInfo.gitpodHost
+					});
+				} else {
+					this.telemetry.sendTelemetryEvent('vscode_desktop_ssh', {
+						kind,
+						status: 'failed',
+						reason: 'remote-ssh extension: connection failed',
+						instanceId: connectionInfo.instanceId,
+						workspaceId: connectionInfo.workspaceId,
+						gitpodHost: connectionInfo.gitpodHost
+					});
+				}
+				await this.context.globalState.update(remoteUri.authority, undefined);
+			}
+
+			return connectionSuccessful;
+		}
+
+		return false;
+	}
 }