Add instance id to telemetry data when local-ssh failed (#67)

Author: mustard-mh

src/local-ssh/ipc/extensionServiceServer.ts

@@ -29,7 +29,7 @@ const phaseMap: Record<WorkspaceInstanceStatus_Phase, WorkspaceInstancePhase | u
     [WorkspaceInstanceStatus_Phase.CREATING]: 'pending',
     [WorkspaceInstanceStatus_Phase.IMAGEBUILD]: 'building',
     [WorkspaceInstanceStatus_Phase.INITIALIZING]: 'initializing',
-    [WorkspaceInstanceStatus_Phase.INTERRUPTED]: 'running',
+    [WorkspaceInstanceStatus_Phase.INTERRUPTED]: 'interrupted',
     [WorkspaceInstanceStatus_Phase.PENDING]: 'stopping',
     [WorkspaceInstanceStatus_Phase.PREPARING]: 'stopped',
     [WorkspaceInstanceStatus_Phase.RUNNING]: 'running',
@@ -89,10 +89,6 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
             ]), this.logService);
 
             const phase = usePublicApi ? phaseMap[(workspace as Workspace).status?.instance?.status?.phase ?? WorkspaceInstanceStatus_Phase.UNSPECIFIED] : (workspace as WorkspaceInfo).latestInstance?.status.phase;
-            if (phase !== 'running') {
-                // TODO(lssh): notification?
-                throw new ServerError(Status.UNAVAILABLE, 'workspace is not running, current phase: ' + phase);
-            }
 
             const ideUrl = usePublicApi ? (workspace as Workspace).status?.instance?.status?.url : (workspace as WorkspaceInfo).latestInstance?.ideUrl;
             if (!ideUrl) {
@@ -102,7 +98,7 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
             const workspaceHost = url.host.substring(url.host.indexOf('.') + 1);
             const instanceId = (usePublicApi ? (workspace as Workspace).status?.instance?.instanceId : (workspace as WorkspaceInfo).latestInstance?.id) as string;
 
-            const sshkey = await this.getWorkspaceSSHKey(ownerToken, workspaceId, workspaceHost);
+            const sshkey = phase === 'running' ? (await this.getWorkspaceSSHKey(ownerToken, workspaceId, workspaceHost)) : '';
 
             return {
                 gitpodHost,
@@ -111,7 +107,8 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
                 instanceId,
                 workspaceHost,
                 ownerToken,
-                sshkey
+                sshkey,
+                phase: phase ?? 'unknown',
             };
         } catch (e) {
             this.logService.error(e, 'failed to get workspace auth info');

src/local-ssh/proxy.ts

@@ -7,8 +7,8 @@ import { SshClient } from '@microsoft/dev-tunnels-ssh-tcp';
 import { NodeStream, SshClientCredentials, SshClientSession, SshDisconnectReason, SshServerSession, SshSessionConfiguration, Stream, WebSocketStream } from '@microsoft/dev-tunnels-ssh';
 import { importKey, importKeyBytes } from '@microsoft/dev-tunnels-ssh-keys';
 import { ExtensionServiceDefinition, GetWorkspaceAuthInfoResponse, SendErrorReportRequest, SendLocalSSHUserFlowStatusRequest } from '../proto/typescript/ipc/v1/ipc';
-import { Client, ClientError, Status, createChannel, createClient } from 'nice-grpc';
-import { retry, retryWithStop } from '../common/async';
+import { Client, createChannel, createClient } from 'nice-grpc';
+import { retry } from '../common/async';
 import { WebSocket } from 'ws';
 import * as stream from 'stream';
 import { ILogService } from '../services/logService';
@@ -46,8 +46,9 @@ type SSHUserFlowTelemetry = Partial<SendLocalSSHUserFlowStatusRequest>;
 
 type FailedToProxyCode = 'SSH.AuthenticationFailed' | 'TUNNEL.AuthenticateSSHKeyFailed' | 'NoRunningInstance' | 'FailedToGetAuthInfo';
 class FailedToProxyError extends Error {
-    constructor(public readonly failureCode: FailedToProxyCode) {
-        super('Failed to proxy connection: ' + failureCode);
+    constructor(public readonly failureCode: FailedToProxyCode, originError?: Error) {
+        const msg = 'Failed to proxy connection: ' + failureCode
+        super(originError ? (msg + ': ' + originError.toString()) : msg );
         this.name = 'FailedToProxyError';
     }
 
@@ -154,6 +155,9 @@ class WebSocketSSHProxy {
         const workspaceInfo = await this.retryGetWorkspaceInfo(username);
         flow.instanceId = workspaceInfo.instanceId;
         flow.userId = workspaceInfo.userId;
+        if (workspaceInfo.phase !== 'running') {
+            throw new FailedToProxyError('NoRunningInstance')
+        }
 
         if (FORCE_TUNNEL) {
             return this.getTunnelSSHConfig(workspaceInfo);
@@ -213,15 +217,9 @@ class WebSocketSSHProxy {
     }
 
     async retryGetWorkspaceInfo(username: string) {
-        return retryWithStop(async (stop) => {
+        return retry(async () => {
             return this.extensionIpc.getWorkspaceAuthInfo({ workspaceId: username, gitpodHost: this.options.host }).catch(e => {
-                if (e instanceof ClientError) {
-                    if (e.code === Status.UNAVAILABLE && e.details.startsWith('workspace is not running')) {
-                        stop();
-                        throw new FailedToProxyError('NoRunningInstance');
-                    }
-                }
-                throw new FailedToProxyError('FailedToGetAuthInfo');
+                throw new FailedToProxyError('FailedToGetAuthInfo', e);
             });
         }, 200, 50);
     }

src/proto/ipc/v1/ipc.proto

@@ -83,4 +83,5 @@ message GetWorkspaceAuthInfoResponse {
     string gitpod_host = 5;
     string user_id = 6;
     string sshkey = 7;
+    string phase = 8;
 }

src/proto/typescript/ipc/v1/ipc.ts

@@ -203,6 +203,7 @@ export interface GetWorkspaceAuthInfoResponse {
   gitpodHost: string;
   userId: string;
   sshkey: string;
+  phase: string;
 }
 
 function createBaseSendErrorReportRequest(): SendErrorReportRequest {
@@ -636,7 +637,16 @@ export const GetWorkspaceAuthInfoRequest = {
 };
 
 function createBaseGetWorkspaceAuthInfoResponse(): GetWorkspaceAuthInfoResponse {
-  return { workspaceId: "", instanceId: "", workspaceHost: "", ownerToken: "", gitpodHost: "", userId: "", sshkey: "" };
+  return {
+    workspaceId: "",
+    instanceId: "",
+    workspaceHost: "",
+    ownerToken: "",
+    gitpodHost: "",
+    userId: "",
+    sshkey: "",
+    phase: "",
+  };
 }
 
 export const GetWorkspaceAuthInfoResponse = {
@@ -662,6 +672,9 @@ export const GetWorkspaceAuthInfoResponse = {
     if (message.sshkey !== "") {
       writer.uint32(58).string(message.sshkey);
     }
+    if (message.phase !== "") {
+      writer.uint32(66).string(message.phase);
+    }
     return writer;
   },
 
@@ -693,6 +706,9 @@ export const GetWorkspaceAuthInfoResponse = {
         case 7:
           message.sshkey = reader.string();
           break;
+        case 8:
+          message.phase = reader.string();
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -710,6 +726,7 @@ export const GetWorkspaceAuthInfoResponse = {
       gitpodHost: isSet(object.gitpodHost) ? String(object.gitpodHost) : "",
       userId: isSet(object.userId) ? String(object.userId) : "",
       sshkey: isSet(object.sshkey) ? String(object.sshkey) : "",
+      phase: isSet(object.phase) ? String(object.phase) : "",
     };
   },
 
@@ -722,6 +739,7 @@ export const GetWorkspaceAuthInfoResponse = {
     message.gitpodHost !== undefined && (obj.gitpodHost = message.gitpodHost);
     message.userId !== undefined && (obj.userId = message.userId);
     message.sshkey !== undefined && (obj.sshkey = message.sshkey);
+    message.phase !== undefined && (obj.phase = message.phase);
     return obj;
   },
 
@@ -738,6 +756,7 @@ export const GetWorkspaceAuthInfoResponse = {
     message.gitpodHost = object.gitpodHost ?? "";
     message.userId = object.userId ?? "";
     message.sshkey = object.sshkey ?? "";
+    message.phase = object.phase ?? "";
     return message;
   },
 };