Proper category errors from serverApi and publicApi IDE-162 (#80)

* Proper category errors from serverApi and publicApi

* Align to public-api

Author: mustard-mh

src/authentication/authentication.ts

@@ -176,7 +176,7 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 				this.logService.info(`Verified session with the following scopes: ${scopesStr}`);
 			} catch (e) {
 				// Remove sessions that return unauthorized response
-				if (e.message === 'Unexpected server response: 401') {
+				if (e.message.includes('Unexpected server response: 401')) {
 					return undefined;
 				}
 				this.logService.error(`Error while verifying session with the following scopes: ${scopesStr}`, e);

src/internalApi.ts

@@ -5,11 +5,13 @@
 
 import { GitpodClient, GitpodServer, GitpodServiceImpl } from '@gitpod/gitpod-protocol/lib/gitpod-service';
 import { JsonRpcProxyFactory } from '@gitpod/gitpod-protocol/lib/messaging/proxy-factory';
-import { listen as doListen } from 'vscode-ws-jsonrpc';
+import { listen as doListen, ResponseError } from 'vscode-ws-jsonrpc';
 import WebSocket, { ErrorEvent } from 'ws';
 import ReconnectingWebSocket from 'reconnecting-websocket';
 import * as vscode from 'vscode';
 import { ILogService } from './services/logService';
+import { Code } from '@bufbuild/connect';
+import { WrapError } from './common/utils';
 
 type UsedGitpodFunction = ['getLoggedInUser', 'getWorkspace', 'getOwnerToken', 'getSSHPublicKeys', 'sendHeartBeat'];
 type Union<Tuple extends any[], Union = never> = Tuple[number] | Union;
@@ -58,6 +60,11 @@ class GitpodServerApi extends vscode.Disposable {
 		});
 		webSocket.onerror = (e: ErrorEvent) => {
 			if (webSocket.retryCount >= maxRetries) {
+				// https://github.com/gitpod-io/gitpod/blob/d41a38ba83939856e5292e30912f52e749787db1/components/server/src/server.ts#L193-L195
+				if (e.error.message === 'Unexpected server response: 401') {
+					this.onErrorEmitter.fire(new WrapError('Failed to call server API', e.error, 'ServerAPI:'+Code[Code.Unauthenticated]));
+					return;
+				}
 				this.onErrorEmitter.fire(e.error);
 			}
 		};
@@ -84,9 +91,46 @@ class GitpodServerApi extends vscode.Disposable {
 export function withServerApi<T>(accessToken: string, serviceUrl: string, cb: (service: GitpodConnection) => Promise<T>, logger: ILogService): Promise<T> {
 	const api = new GitpodServerApi(accessToken, serviceUrl, logger);
 	return Promise.race([
-		cb(api.service),
+		new Promise<T>((resolve, reject) => cb(api.service).then(resolve).catch(err => {
+			if (err instanceof ResponseError) {
+				const code = categorizeRPCError(err);
+				const codeStr = code ? Code[code] : 'Unknown';
+				reject(new WrapError('Failed to call server API', err, 'ServerAPI:' + codeStr));
+				return;
+			}
+			reject(err);
+		})),
 		new Promise<T>((_, reject) => api.onError(error => {
 			reject(error);
 		}))
 	]).finally(() => api.dispose());
 }
+
+// Should align with https://github.com/gitpod-io/gitpod/blob/d41a38ba83939856e5292e30912f52e749787db1/components/public-api-server/pkg/proxy/errors.go#LL25C1-L26C1
+function categorizeRPCError(err?: ResponseError<any>): Code | undefined {
+	if (!err) {
+		return;
+	}
+	switch (err.code) {
+		case 400:
+			return Code.InvalidArgument;
+		case 401:
+			return Code.Unauthenticated;
+		case 403:
+			return Code.PermissionDenied;
+		case 404:
+			return Code.NotFound;
+		case 409:
+			return Code.AlreadyExists;
+		case 429:
+			return Code.ResourceExhausted;
+		case 470:
+			return Code.PermissionDenied;
+		case -32603:
+			return Code.Internal;
+	}
+	if (err.code >= 400 && err.code < 500) {
+		return Code.InvalidArgument;
+	}
+	return Code.Internal;
+}

src/publicApi.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { createConnectTransport } from '@bufbuild/connect-node';
-import { createPromiseClient, Interceptor, PromiseClient } from '@bufbuild/connect';
+import { createPromiseClient, Interceptor, PromiseClient, ConnectError, Code } from '@bufbuild/connect';
 import { WorkspacesService } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_connectweb';
 import { IDEClientService } from '@gitpod/public-api/lib/gitpod/experimental/v1/ide_client_connectweb';
 import { UserService } from '@gitpod/public-api/lib/gitpod/experimental/v1/user_connectweb';
@@ -18,6 +18,7 @@ import { getErrorCode } from '@grpc/grpc-js/build/src/error';
 import { timeout } from './common/async';
 import { MetricsReporter, getConnectMetricsInterceptor, getGrpcMetricsInterceptor } from './metrics';
 import { ILogService } from './services/logService';
+import { WrapError } from './common/utils';
 
 function isTelemetryEnabled(): boolean {
     const TELEMETRY_CONFIG_ID = 'telemetry';
@@ -68,11 +69,24 @@ export class GitpodPublicApi extends Disposable implements IGitpodAPI {
             return await next(req);
         };
         const metricsInterceptor = getConnectMetricsInterceptor();
+        const errorWrapInterceptor: Interceptor = (next) => async (req) => {
+            try {
+                return await next(req);
+            } catch (err) {
+                if (err instanceof ConnectError) {
+                    // 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 err;
+            }
+        };
 
         const transport = createConnectTransport({
             baseUrl: serviceUrl.toString(),
             httpVersion: '2',
-            interceptors: [authInterceptor, metricsInterceptor],
+            interceptors: [errorWrapInterceptor, authInterceptor, metricsInterceptor],
             useBinaryFormat: true,
         });