log getWorkspaceAuthInfo error to GRPC (#82)

Author: akosyakov

src/common/utils.ts

@@ -116,7 +116,12 @@ export function getServiceURL(gitpodHost: string): string {
 
 export class WrapError extends Error {
 	code: string | undefined;
-	constructor(msg: string, err: any, code?: string) {
+	constructor(
+		msg: string,
+		err: any,
+		code?: string,
+		readonly grpcCode?: number
+	) {
 		const isErr = err instanceof Error;
 		super(isErr ? `${msg}: ${err.message}` : msg);
 		if (isErr) {

src/local-ssh/ipc/extensionServiceServer.ts

@@ -25,6 +25,7 @@ import { CreateSSHKeyPairRequest } from '@gitpod/supervisor-api-grpcweb/lib/cont
 import * as ssh2 from 'ssh2';
 import { ParsedKey } from 'ssh2-streams';
 import { isPortUsed } from '../../common/ports';
+import { WrapError } from '../../common/utils';
 
 const phaseMap: Record<WorkspaceInstanceStatus_Phase, WorkspaceInstancePhase | undefined> = {
     [WorkspaceInstanceStatus_Phase.CREATING]: 'pending',
@@ -74,6 +75,8 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
     }
 
     async getWorkspaceAuthInfo(request: GetWorkspaceAuthInfoRequest, _context: CallContext): Promise<GetWorkspaceAuthInfoResponse> {
+        let userId: string | undefined;
+        let instanceId: string | undefined;
         try {
             if (new URL(this.hostService.gitpodHost).host !== new URL(request.gitpodHost).host) {
                 this.logService.error(`gitpod host mismatch, actual: ${this.hostService.gitpodHost} target: ${request.gitpodHost}`);
@@ -83,7 +86,7 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
             if (!accessToken) {
                 throw new ServerError(Status.INTERNAL, 'no access token found');
             }
-            const userId = this.sessionService.getUserId();
+            userId = this.sessionService.getUserId();
             const workspaceId = request.workspaceId;
             // TODO(lssh): Get auth info according to `request.gitpodHost`
             const gitpodHost = this.hostService.gitpodHost;
@@ -101,7 +104,7 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
             }
             const url = new URL(ideUrl);
             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;
+            instanceId = (usePublicApi ? (workspace as Workspace).status?.instance?.instanceId : (workspace as WorkspaceInfo).latestInstance?.id) as string;
 
             const sshkey = phase === 'running' ? (await this.getWorkspaceSSHKey(ownerToken, workspaceId, workspaceHost)) : '';
 
@@ -116,11 +119,20 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
                 phase: phase ?? 'unknown',
             };
         } catch (e) {
-            this.logService.error(e, 'failed to get workspace auth info');
-            if (e instanceof ServerError) {
-                throw e;
+            let code = Status.INTERNAL;
+            if (e instanceof WrapError && typeof e.grpcCode === 'number') {
+                code = e.grpcCode
             }
-            throw new ServerError(Status.UNAVAILABLE, e.toString());
+            const wrapErr = new WrapError('failed to get workspace auth info', e);
+            this.logService.error(wrapErr);
+            this.telemetryService.sendTelemetryException(wrapErr, {
+                gitpodHost: request.gitpodHost,
+                workspaceId: request.workspaceId,
+                instanceId,
+                userId,
+            });
+
+            throw new ServerError(code, wrapErr.toString());
         }
     }
 

src/local-ssh/proxy.ts

@@ -45,10 +45,10 @@ function getClientOptions(): ClientOptions {
 type FailedToProxyCode = 'SSH.AuthenticationFailed' | 'TUNNEL.AuthenticateSSHKeyFailed' | 'NoRunningInstance' | 'FailedToGetAuthInfo' | 'GitpodHostMismatch' | 'NoAccessTokenFound';
 
 // IgnoredFailedCodes contains the failreCode that don't need to send error report
-const IgnoredFailedCodes: FailedToProxyCode[] = ['NoRunningInstance'];
+const IgnoredFailedCodes: (FailedToProxyCode | string)[] = ['NoRunningInstance'];
 
 class FailedToProxyError extends Error {
-    constructor(public readonly failureCode: FailedToProxyCode, originError?: Error) {
+    constructor(public readonly failureCode: FailedToProxyCode | string, originError?: Error) {
         const msg = 'Failed to proxy connection: ' + failureCode;
         super(originError ? (msg + ': ' + originError.toString()) : msg);
         this.name = 'FailedToProxyError';
@@ -68,7 +68,7 @@ interface SSHUserFlowTelemetry extends UserFlowTelemetryProperties {
     workspaceId: string;
     instanceId?: string;
     userId?: string;
-    failureCode?: FailedToProxyCode;
+    failureCode?: FailedToProxyCode | string;
 }
 
 class WebSocketSSHProxy {
@@ -243,14 +243,16 @@ class WebSocketSSHProxy {
     async retryGetWorkspaceInfo(username: string) {
         return retry(async () => {
             return this.extensionIpc.getWorkspaceAuthInfo({ workspaceId: username, gitpodHost: this.options.host }).catch(e => {
+                let failureCode = 'FailedToGetAuthInfo';
                 if (e instanceof ClientError) {
                     if (e.code === Status.FAILED_PRECONDITION && e.message.includes('gitpod host mismatch')) {
                         throw new FailedToProxyError('GitpodHostMismatch', e);
                     } else if (e.code === Status.INTERNAL && e.message.includes('no access token found')) {
                         throw new FailedToProxyError('NoAccessTokenFound', e);
                     }
+                    failureCode += ':' + Status[e.code];
                 }
-                throw new FailedToProxyError('FailedToGetAuthInfo', e);
+                throw new FailedToProxyError(failureCode, e);
             });
         }, 200, 50);
     }

src/publicApi.ts

@@ -215,7 +215,7 @@ export class GitpodPublicApi extends Disposable implements IGitpodAPI {
             // https://github.com/gitpod-io/gitpod/blob/d41a38ba83939856e5292e30912f52e749787db1/components/public-api-server/pkg/auth/middleware.go#L73
             // https://github.com/gitpod-io/gitpod/blob/d41a38ba83939856e5292e30912f52e749787db1/components/public-api-server/pkg/proxy/errors.go#L30
             // NOTE: WrapError will omit error's other properties
-            throw new WrapError('Failed to call public API', err, 'PublicAPI:' + Code[err.code]);
+            throw new WrapError('Failed to call public API', err, 'PublicAPI:' + Code[err.code], err.code);
         }
     }