Test public API (#25)

jeanp413 · mustard-mh · web-flow · commit 6a1558fc4227 · 2022-10-20T12:32:51.000-05:00
Co-authored-by: mustard &lt;huiwen@gitpod.io&gt;
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -12,7 +12,10 @@
             "outFiles": [
                 "${workspaceFolder}/out/**/*.js"
             ],
-            "preLaunchTask": "npm: watch"
+            "preLaunchTask": "npm: watch",
+            "env": {
+                "TEST": "1",
+            }
         }
     ]
 }
diff --git a/package.json b/package.json
@@ -127,7 +127,6 @@
 		"@types/js-yaml": "^4.0.5",
 		"@types/mocha": "^9.1.1",
 		"@types/node": "16.x",
-		"@types/node-fetch": "^2.5.12",
 		"@types/semver": "^7.3.10",
 		"@types/ssh2": "^0.5.52",
 		"@types/tmp": "^0.2.1",
@@ -149,13 +148,15 @@
 		"webpack-cli": "^4.7.2"
 	},
 	"dependencies": {
+		"@bufbuild/connect-web": "^0.2.1",
 		"@gitpod/gitpod-protocol": "main",
 		"@gitpod/local-app-api-grpcweb": "main",
+		"@gitpod/public-api": "main",
 		"@improbable-eng/grpc-web-node-http-transport": "^0.14.0",
 		"analytics-node": "^6.2.0",
 		"configcat-node": "^8.0.0",
 		"js-yaml": "^4.1.0",
-		"node-fetch": "2.6.7",
+		"node-fetch-commonjs": "^3.2.4",
 		"pkce-challenge": "^3.0.0",
 		"semver": "^7.3.7",
 		"ssh-config": "^4.1.6",
diff --git a/src/authentication.ts b/src/authentication.ts
@@ -5,7 +5,6 @@
 
 import * as vscode from 'vscode';
 import { v4 as uuid } from 'uuid';
-import fetch from 'node-fetch';
 import Keychain from './common/keychain';
 import GitpodServer from './gitpodServer';
 import Log from './common/logger';
@@ -106,9 +105,11 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 
 		const endpoint = `${this._serviceUrl}/api/oauth/inspect?client=${vscode.env.uriScheme}-gitpod`;
 		try {
-			const resp = await fetch(endpoint, { timeout: 1500 });
+			const controller = new AbortController();
+			setTimeout(() => controller.abort(), 1500);
+			const resp = await fetch(endpoint, { signal: controller.signal });
 			if (resp.ok) {
-				this._validScopes = await resp.json();
+				this._validScopes = (await resp.json()) as string[];
 				return this._validScopes;
 			}
 		} catch (e) {
diff --git a/src/experiments.ts b/src/experiments.ts
@@ -18,8 +18,9 @@ export class ExperimentalSettings {
     private configcatClient: configcatcommon.IConfigCatClient;
     private extensionVersion: semver.SemVer;
 
-    constructor(key: string, extensionVersion: string, private logger: Log) {
+    constructor(key: string, extensionVersion: string, private logger: Log, gitpodHost: string) {
         this.configcatClient = configcat.createClientWithLazyLoad(key, {
+            baseUrl: new URL('/configcat', process.env['TEST'] ? 'https://gitpod-staging.com' : gitpodHost).href,
             logger: {
                 debug(): void { },
                 log(): void { },
@@ -33,6 +34,18 @@ export class ExperimentalSettings {
         this.extensionVersion = new semver.SemVer(extensionVersion);
     }
 
+    async getRaw<T>(
+        configcatKey: string,
+        userId: string,
+        custom: {
+            gitpodHost: string;
+            [key: string]: string;
+        }
+    ) {
+        const user = userId ? new configcatcommon.User(userId, undefined, undefined, custom) : undefined;
+        return (await this.configcatClient.getValueAsync(configcatKey, undefined, user)) as T | undefined;
+    }
+
     async get<T>(
         key: string,
         userId: string,
diff --git a/src/extension.ts b/src/extension.ts
@@ -5,6 +5,7 @@
 
 import * as os from 'os';
 import * as vscode from 'vscode';
+import fetch, { Headers, Request, Response, AbortError, FetchError } from 'node-fetch-commonjs';
 import GitpodAuthenticationProvider from './authentication';
 import Log from './common/logger';
 import { UserFlowTelemetry } from './common/telemetry';
@@ -17,6 +18,16 @@ import RemoteConnector from './remoteConnector';
 import { SettingsSync } from './settingsSync';
 import TelemetryReporter from './telemetryReporter';
 
+// connect-web uses fetch api, so we need to polyfill it
+if (!global.fetch) {
+	global.fetch = fetch as any;
+	global.Headers = Headers as any;
+	global.Request = Request as any;
+	global.Response = Response as any;
+	(global as any).AbortError = AbortError as any;
+	(global as any).FetchError = FetchError as any;
+}
+
 const FIRST_INSTALL_KEY = 'gitpod-desktop.firstInstall';
 
 let telemetry: TelemetryReporter;
@@ -31,8 +42,9 @@ export async function activate(context: vscode.ExtensionContext) {
 
 	const logger = new Log('Gitpod');
 	logger.info(`${extensionId}/${packageJSON.version} (${os.release()} ${os.platform()} ${os.arch()}) vscode/${vscode.version} (${vscode.env.appName})`);
-
-	const experiments = new ExperimentalSettings(packageJSON.configcatKey, packageJSON.version, logger);
+	
+	const gitpodHost = vscode.workspace.getConfiguration('gitpod').get<string>('host')!;
+	const experiments = new ExperimentalSettings('gitpod', packageJSON.version, logger, gitpodHost);
 	context.subscriptions.push(experiments);
 
 	telemetry = new TelemetryReporter(extensionId, packageJSON.version, packageJSON.segmentKey);
diff --git a/src/featureSupport.ts b/src/featureSupport.ts
@@ -4,7 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 import * as vscode from 'vscode';
 import * as semver from 'semver';
-import fetch from 'node-fetch';
 import Log from './common/logger';
 import { retry } from './common/async';
 
@@ -55,7 +54,9 @@ async function getOrFetchVersionInfo(serviceUrl: string, logger: Log) {
     let gitpodRawVersion: string | undefined;
     try {
         gitpodRawVersion = await retry(async () => {
-            const resp = await fetch(versionEndPoint, { timeout: 1500 });
+            const controller = new AbortController();
+            setTimeout(() => controller.abort(), 1500);
+            const resp = await fetch(versionEndPoint, { signal: controller.signal });
             if (!resp.ok) {
                 throw new Error(`Responded with ${resp.status} ${resp.statusText}`);
             }
@@ -104,7 +105,9 @@ export async function isOauthInspectSupported(gitpodHost: string,) {
     const serviceUrl = new URL(gitpodHost).toString().replace(/\/$/, '');
     const endpoint = `${serviceUrl}/api/oauth/inspect?client=${vscode.env.uriScheme}-gitpod`;
     try {
-        const resp = await fetch(endpoint, { timeout: 1500 });
+        const controller = new AbortController();
+        setTimeout(() => controller.abort(), 1500);
+        const resp = await fetch(endpoint, { signal: controller.signal });
         if (resp.ok) {
             return true;
         }
diff --git a/src/gitpodServer.ts b/src/gitpodServer.ts
@@ -5,7 +5,6 @@
 
 import * as vscode from 'vscode';
 import Log from './common/logger';
-import fetch from 'node-fetch';
 import { PromiseAdapter, promiseFromEvent } from './common/utils';
 import { withServerApi } from './internalApi';
 import pkceChallenge from 'pkce-challenge';
@@ -157,7 +156,7 @@ export default class GitpodServer extends Disposable {
 					return;
 				}
 
-				const exchangeTokenData: ExchangeTokenResponse = await exchangeTokenResponse.json();
+				const exchangeTokenData = (await exchangeTokenResponse.json()) as ExchangeTokenResponse;
 				const jwtToken = exchangeTokenData.access_token;
 				const accessToken = JSON.parse(Buffer.from(jwtToken.split('.')[1], 'base64').toString())['jti'];
 				resolve(accessToken);
diff --git a/src/heartbeat.ts b/src/heartbeat.ts
@@ -3,10 +3,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { WorkspaceInfo } from '@gitpod/gitpod-protocol';
+import { Workspace, WorkspaceInstanceStatus_Phase } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_pb';
 import * as vscode from 'vscode';
 import { Disposable } from './common/dispose';
 import Log from './common/logger';
 import { withServerApi } from './internalApi';
+import { GitpodPublicApi } from './publicApi';
 import TelemetryReporter from './telemetryReporter';
 
 export class HeartbeatManager extends Disposable {
@@ -22,6 +25,7 @@ export class HeartbeatManager extends Disposable {
         readonly workspaceId: string,
         readonly instanceId: string,
         private readonly accessToken: string,
+        private readonly publicApi: GitpodPublicApi | undefined,
         private readonly logger: Log,
         private readonly telemetry: TelemetryReporter
     ) {
@@ -98,9 +102,14 @@ export class HeartbeatManager extends Disposable {
         const suffix = wasClosed ? 'closed heartbeat' : 'heartbeat';
         try {
             await withServerApi(this.accessToken, this.gitpodHost, async service => {
-                const workspaceInfo = await service.server.getWorkspace(this.workspaceId);
-                this.isWorkspaceRunning = workspaceInfo.latestInstance?.status?.phase === 'running' && workspaceInfo.latestInstance?.id === this.instanceId;
+                const workspaceInfo = this.publicApi
+                    ? await this.publicApi.getWorkspace(this.workspaceId)
+                    : await service.server.getWorkspace(this.workspaceId);
+                this.isWorkspaceRunning = this.publicApi
+                    ? (workspaceInfo as Workspace)?.status?.instance?.status?.phase === WorkspaceInstanceStatus_Phase.RUNNING && (workspaceInfo as Workspace)?.status?.instance?.instanceId === this.instanceId
+                    : (workspaceInfo as WorkspaceInfo).latestInstance?.status?.phase === 'running' && (workspaceInfo as WorkspaceInfo).latestInstance?.id === this.instanceId;
                 if (this.isWorkspaceRunning) {
+                    // TODO: use the public API
                     await service.server.sendHeartBeat({ instanceId: this.instanceId, wasClosed });
                     if (wasClosed) {
                         this.telemetry.sendTelemetryEvent('ide_close_signal', { workspaceId: this.workspaceId, instanceId: this.instanceId, gitpodHost: this.gitpodHost, clientKind: 'vscode' });
diff --git a/src/publicApi.ts b/src/publicApi.ts
@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Gitpod. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { createConnectTransport, createPromiseClient, Interceptor, PromiseClient } from '@bufbuild/connect-web';
+import { WorkspacesService } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_connectweb';
+import { Workspace } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_pb';
+
+export class GitpodPublicApi {
+
+    private workspaceService!: PromiseClient<typeof WorkspacesService>;
+
+    constructor() {
+    }
+
+    async init(accessToken: string, gitpodHost: string) {
+        const serviceUrl = new URL(gitpodHost);
+        serviceUrl.hostname = `api.${serviceUrl.hostname}`;
+
+        const authInterceptor: Interceptor = (next) => async (req) => {
+            req.header.set('Authorization', `Bearer ${accessToken}`);
+            return await next(req);
+        };
+
+        const transport = createConnectTransport({
+            baseUrl: serviceUrl.toString(),
+            interceptors: [authInterceptor],
+        });
+
+        this.workspaceService = createPromiseClient(WorkspacesService, transport);
+    }
+
+    async getWorkspace(workspaceId: string): Promise<Workspace | undefined> {
+        const response = await this.workspaceService.getWorkspace({ workspaceId });
+        return response.result;
+    }
+
+    async getOwnerToken(workspaceId: string): Promise<string> {
+        const response = await this.workspaceService.getOwnerToken({ workspaceId });
+        return response.token;
+    }
+}
diff --git a/src/releaseNotes.ts b/src/releaseNotes.ts
@@ -3,7 +3,6 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import fetch, { Response } from 'node-fetch';
 import * as vscode from 'vscode';
 import { load } from 'js-yaml';
 import { CacheHelper } from './common/cache';
diff --git a/src/remoteConnector.ts b/src/remoteConnector.ts
@@ -7,12 +7,13 @@ import { AutoTunnelRequest, ResolveSSHConnectionRequest, ResolveSSHConnectionRes
 import { LocalAppClient } from '@gitpod/local-app-api-grpcweb/lib/localapp_pb_service';
 import { NodeHttpTransport } from '@improbable-eng/grpc-web-node-http-transport';
 import { grpc } from '@improbable-eng/grpc-web';
+import { Workspace, WorkspaceInstanceStatus_Phase } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_pb';
+import { WorkspaceInfo } from '@gitpod/gitpod-protocol';
 import * as cp from 'child_process';
 import * as fs from 'fs';
 import * as http from 'http';
 import * as net from 'net';
 import * as crypto from 'crypto';
-import fetch, { Response } from 'node-fetch';
 import { Client as sshClient, OpenSSHAgent, utils as sshUtils } from 'ssh2';
 import { ParsedKey } from 'ssh2-streams';
 import * as tmp from 'tmp';
@@ -35,6 +36,7 @@ import { retry } from './common/async';
 import { getOpenSSHVersion } from './ssh/sshVersion';
 import { NotificationService } from './notification';
 import { UserFlowTelemetry } from './common/telemetry';
+import { GitpodPublicApi } from './publicApi';
 
 interface SSHConnectionParams {
 	workspaceId: string;
@@ -124,6 +126,8 @@ export default class RemoteConnector extends Disposable {
 
 	private heartbeatManager: HeartbeatManager | undefined;
 
+	private publicApi: GitpodPublicApi | undefined;
+
 	constructor(
 		private readonly context: vscode.ExtensionContext,
 		private readonly settingsSync: SettingsSync,
@@ -243,7 +247,7 @@ export default class RemoteConnector extends Disposable {
 			const installationStream = fs.createWriteStream(installationPath);
 			const cancelInstallationListener = token.onCancellationRequested(() => installationStream.destroy(new Error('cancelled')));
 			await new Promise((resolve, reject) => {
-				download.body.pipe(installationStream)
+				(download.body as unknown as NodeJS.ReadableStream)!.pipe(installationStream)
 					.on('error', reject)
 					.on('finish', resolve);
 			}).finally(() => {
@@ -529,17 +533,23 @@ export default class RemoteConnector extends Disposable {
 	private async getWorkspaceSSHDestination(session: vscode.AuthenticationSession, { workspaceId, gitpodHost }: SSHConnectionParams): Promise<{ destination: string; password?: string }> {
 		const serviceUrl = new URL(gitpodHost);
 		const sshKeysSupported = session.scopes.includes(ScopeFeature.SSHPublicKeys);
+
 		const [workspaceInfo, ownerToken, registeredSSHKeys] = await withServerApi(session.accessToken, serviceUrl.toString(), service => Promise.all([
-			service.server.getWorkspace(workspaceId),
-			service.server.getOwnerToken(workspaceId),
+			this.publicApi ? this.publicApi.getWorkspace(workspaceId) : service.server.getWorkspace(workspaceId),
+			this.publicApi ? this.publicApi.getOwnerToken(workspaceId) : service.server.getOwnerToken(workspaceId),
 			sshKeysSupported ? service.server.getSSHPublicKeys() : undefined
 		]), this.logger);
 
-		if (workspaceInfo.latestInstance?.status?.phase !== 'running') {
+		const isRunning = this.publicApi
+			? (workspaceInfo as Workspace)?.status?.instance?.status?.phase === WorkspaceInstanceStatus_Phase.RUNNING
+			: (workspaceInfo as WorkspaceInfo).latestInstance?.status?.phase === 'running';
+		if (!isRunning) {
 			throw new NoRunningInstanceError(workspaceId);
 		}
 
-		const workspaceUrl = new URL(workspaceInfo.latestInstance.ideUrl);
+		const workspaceUrl = this.publicApi
+			? new URL((workspaceInfo as Workspace).status!.instance!.status!.url)
+			: new URL((workspaceInfo as WorkspaceInfo).latestInstance!.ideUrl);
 
 		const sshHostKeyEndPoint = `https://${workspaceUrl.host}/_ssh/host_keys`;
 		const sshHostKeyResponse = await fetch(sshHostKeyEndPoint);
@@ -548,7 +558,7 @@ export default class RemoteConnector extends Disposable {
 			throw new NoSSHGatewayError(gitpodHost);
 		}
 
-		const sshHostKeys: { type: string; host_key: string }[] = await sshHostKeyResponse.json();
+		const sshHostKeys = (await sshHostKeyResponse.json()) as { type: string; host_key: string }[];
 
 		const sshDestInfo = {
 			user: workspaceId,
@@ -736,7 +746,7 @@ export default class RemoteConnector extends Disposable {
 		throw new Error('SSH password modal dialog, Canceled');
 	}
 
-	private async ensureValidGitpodHost(gitpodHost: string, flow: UserFlowTelemetry): Promise<boolean>{
+	private async ensureValidGitpodHost(gitpodHost: string, flow: UserFlowTelemetry): Promise<boolean> {
 		const config = vscode.workspace.getConfiguration('gitpod');
 		const currentGitpodHost = config.get<string>('host')!;
 		if (new URL(gitpodHost).host !== new URL(currentGitpodHost).host) {
@@ -797,6 +807,15 @@ export default class RemoteConnector extends Disposable {
 
 		this.logger.info('Opening Gitpod workspace', uri.toString());
 
+		const usePublicApi = await this.experiments.getRaw<boolean>('gitpod_experimental_publicApi', session.account.id, { gitpodHost: params.gitpodHost });
+		this.logger.info(`Going to use ${usePublicApi ? 'public' : 'server'} API`);
+		if (usePublicApi) {
+			if (!this.publicApi) {
+				this.publicApi = new GitpodPublicApi();
+			}
+			await this.publicApi.init(session.accessToken, params.gitpodHost);
+		}
+
 		const forceUseLocalApp = getServiceURL(params.gitpodHost) === 'https://gitpod.io'
 			? (await this.experiments.get<boolean>('gitpod.remote.useLocalApp', session.account.id, { gitpodHost: params.gitpodHost }))!
 			: (await this.experiments.get<boolean>('gitpod.remote.useLocalApp', session.account.id, { gitpodHost: params.gitpodHost }, 'gitpod_remote_useLocalApp_sh'))!;
@@ -931,12 +950,12 @@ export default class RemoteConnector extends Disposable {
 		}
 	}
 
-	private async startHeartBeat(accessToken: string, connectionInfo: SSHConnectionParams, gitpodVersion: GitpodVersion) {
+	private async startHeartBeat(session: vscode.AuthenticationSession, connectionInfo: SSHConnectionParams, gitpodVersion: GitpodVersion) {
 		if (this.heartbeatManager) {
 			return;
 		}
 
-		this.heartbeatManager = new HeartbeatManager(connectionInfo.gitpodHost, connectionInfo.workspaceId, connectionInfo.instanceId, accessToken, this.logger, this.telemetry);
+		this.heartbeatManager = new HeartbeatManager(connectionInfo.gitpodHost, connectionInfo.workspaceId, connectionInfo.instanceId, session.accessToken, this.publicApi, this.logger, this.telemetry);
 
 		// gitpod remote extension installation is async so sometimes gitpod-desktop will activate before gitpod-remote
 		// let's try a few times for it to finish install
@@ -1061,12 +1080,12 @@ export default class RemoteConnector extends Disposable {
 
 		const heartbeatSupported = session.scopes.includes(ScopeFeature.LocalHeartbeat);
 		if (heartbeatSupported) {
-			this.startHeartBeat(session.accessToken, connectionInfo, gitpodVersion);
+			this.startHeartBeat(session, connectionInfo, gitpodVersion);
 		} else {
 			this.logger.warn(`Local heartbeat not supported in ${connectionInfo.gitpodHost}, using version ${gitpodVersion.raw}`);
 		}
 
-		const syncExtensions = (await this.experiments.get<boolean>('gitpod.remote.syncExtensions', session.account.id, { gitpodHost: connectionInfo.gitpodHost	}))!;
+		const syncExtensions = (await this.experiments.get<boolean>('gitpod.remote.syncExtensions', session.account.id, { gitpodHost: connectionInfo.gitpodHost }))!;
 		const userOverride = String(isUserOverrideSetting('gitpod.remote.syncExtensions'));
 		const syncExtFlow = { ...connectionInfo, gitpodVersion: gitpodVersion.raw, userId: session.account.id, flow: 'sync_local_extensions', userOverride };
 		this.telemetry.sendUserFlowStatus(syncExtensions ? 'enabled' : 'disabled', syncExtFlow);
diff --git a/src/settingsSync.ts b/src/settingsSync.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,10 @@`
`12`	`12`	`"outFiles": [`
`13`	`13`	`"${workspaceFolder}/out/*/.js"`
`14`	`14`	`],`
`15`		`- "preLaunchTask": "npm: watch"`
	`15`	`+ "preLaunchTask": "npm: watch",`
	`16`	`+ "env": {`
	`17`	`+ "TEST": "1",`
	`18`	`+ }`
`16`	`19`	`}`
`17`	`20`	`]`
`18`	`21`	`}`