Proper invalid contextUrl workaround

Author: jeanp413

src/commands/workspaces.ts

@@ -324,8 +324,19 @@ export class OpenWorkspaceContextCommand implements Command {
 			return;
 		}
 
+		const rawWsData = await this.sessionService.getAPI().getWorkspace(treeItem.id)
 		const wsData = rawWorkspaceToWorkspaceData(await this.sessionService.getAPI().getWorkspace(treeItem.id));
 
+		// Report if we couldn't parse contextUrl
+		if (!wsData.contextUrl) {
+			this.telemetryService.sendTelemetryException(new Error('Unable to parse workspace contextUrl'), {
+				gitpodHost: this.hostService.gitpodHost,
+				workspaceId: wsData.id,
+				contextUrl: rawWsData.context?.contextUrl,
+			});
+			return;
+		}
+
 		this.telemetryService.sendTelemetryEvent('vscode_desktop_view_command', {
 			name: this.id,
 			gitpodHost: this.hostService.gitpodHost,

src/local-ssh/ipc/extensionServiceServer.ts

@@ -22,8 +22,7 @@ import { ParsedKey } from 'ssh2-streams';
 import { isPortUsed } from '../../common/ports';
 import { WrapError } from '../../common/utils';
 import { ConnectError, Code } from '@bufbuild/connect';
-import { WorkspaceInstanceStatus_Phase } from '@gitpod/public-api/lib/gitpod/experimental/v1';
-import { WorkspacePhase } from '../../publicApi';
+import { rawWorkspaceToWorkspaceData } from '../../publicApi';
 
 function isServiceError(obj: any): obj is ServiceError {
     // eslint-disable-next-line eqeqeq
@@ -109,26 +108,34 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
             // TODO(lssh): Get auth info according to `request.gitpodHost`
             const gitpodHost = this.hostService.gitpodHost;
 
-            const ws = await this.sessionService.getAPI().getWorkspace(actualWorkspaceId, _context.signal);
-
-            instanceId = ws.status!.instance!.instanceId;
-
-            let ownerToken = '';
-            let sshkey = '';
-            let workspaceHost = '';
-            const phase = WorkspaceInstanceStatus_Phase[ws.status!.instance!.status!.phase ?? WorkspaceInstanceStatus_Phase.UNSPECIFIED].toLowerCase() as WorkspacePhase;
-            // if workspace is not running, we may not compute its url yet
-            if (phase === 'running') {
-                ownerToken = await this.sessionService.getAPI().getOwnerToken(actualWorkspaceId, _context.signal);
-                let workspaceUrl = ws.status!.instance!.status!.url;
-                const url = new URL(workspaceUrl);
-                workspaceHost = url.host.substring(url.host.indexOf('.') + 1);
-                if (workspaceId !== actualWorkspaceId) {
-                    // Public api doesn't take into account "debug" workspaces, readd 'debug-' prefix
-                    workspaceUrl = workspaceUrl.replace(actualWorkspaceId, workspaceId);
-                }
-                sshkey = await this.getWorkspaceSSHKey(ownerToken, workspaceUrl, _context.signal);
+            const rawWorkspace = await this.sessionService.getAPI().getWorkspace(actualWorkspaceId, _context.signal);
+            const wsData = rawWorkspaceToWorkspaceData(rawWorkspace);
+
+            // Report if we couldn't parse contextUrl
+            if (!wsData.contextUrl) {
+                this.telemetryService.sendTelemetryException(new Error('Unable to parse workspace contextUrl'), {
+                    gitpodHost: request.gitpodHost,
+                    workspaceId: request.workspaceId,
+                    instanceId,
+                    userId,
+                    contextUrl: rawWorkspace.context?.contextUrl,
+                });
+            }
+
+            const ownerToken = await this.sessionService.getAPI().getOwnerToken(actualWorkspaceId, _context.signal);
+
+            instanceId = rawWorkspace.status!.instance!.instanceId;
+
+            const workspaceUrl = new URL(wsData.workspaceUrl);
+            const workspaceHost = workspaceUrl.host.substring(workspaceUrl.host.indexOf('.') + 1);
+            let actualWorkspaceUrl = wsData.workspaceUrl;
+            if (workspaceId !== actualWorkspaceId) {
+                // Public api doesn't take into account "debug" workspaces, readd 'debug-' prefix
+                actualWorkspaceUrl = actualWorkspaceUrl.replace(actualWorkspaceId, workspaceId);
             }
+
+            const sshkey = wsData.phase === 'running' ? (await this.getWorkspaceSSHKey(ownerToken, actualWorkspaceUrl, _context.signal)) : '';
+
             return {
                 gitpodHost,
                 userId,
@@ -137,7 +144,7 @@ class ExtensionServiceImpl implements ExtensionServiceImplementation {
                 workspaceHost,
                 ownerToken,
                 sshkey,
-                phase,
+                phase: wsData.phase,
             };
         } catch (e) {
             let code = Status.INTERNAL;

src/publicApi.ts

@@ -295,29 +295,34 @@ export interface WorkspaceData {
     owner: string;
     repo: string;
     id: string;
-    contextUrl: string;
+    contextUrl: string | undefined;
     workspaceUrl: string;
     phase: WorkspacePhase;
     description: string;
     lastUsed: Date;
-    recentFolders : string[];
+    recentFolders: string[];
 }
 
 export function rawWorkspaceToWorkspaceData(rawWorkspaces: Workspace): WorkspaceData;
 export function rawWorkspaceToWorkspaceData(rawWorkspaces: Workspace[]): WorkspaceData[];
 export function rawWorkspaceToWorkspaceData(rawWorkspaces: Workspace | Workspace[]) {
     const toWorkspaceData = (ws: Workspace) => {
-        const url = new URL(ws.context!.contextUrl);
-        const provider = url.host.replace(/\..+?$/, ''); // remove '.com', etc
-        const matches = url.pathname.match(/[^/]+/g)!; // match /owner/repo
+        const normalizedUrl = getNormalizedURL(ws.context!.contextUrl);
+        let provider = 'undefined';
+        let matches = ['undefined', 'undefined'];
+        if (normalizedUrl) {
+            const url = new URL(normalizedUrl);
+            provider = url.host.replace(/\..+?$/, ''); // remove '.com', etc
+            matches = url.pathname.match(/[^/]+/g)!; // match /owner/repo
+        }
         const owner = matches[0];
         const repo = matches[1];
         return {
             provider,
             owner,
             repo,
             id: ws.workspaceId,
-            contextUrl: ws.context!.contextUrl,
+            contextUrl: normalizedUrl,
             workspaceUrl: ws.status!.instance!.status!.url,
             phase: WorkspaceInstanceStatus_Phase[ws.status!.instance!.status!.phase ?? WorkspaceInstanceStatus_Phase.UNSPECIFIED].toLowerCase() as WorkspacePhase,
             description: ws.description,
@@ -333,3 +338,24 @@ export function rawWorkspaceToWorkspaceData(rawWorkspaces: Workspace | Workspace
 
     return toWorkspaceData(rawWorkspaces);
 }
+
+// TODO: remove this once public api is fixed, ref https://github.com/gitpod-io/gitpod/pull/18292
+function getNormalizedURL(contextUrl: string | undefined): string | undefined {
+    if (!contextUrl) {
+        return
+    }
+
+    const idx = contextUrl.search(/http[s]?:\/\//);
+    let normalized = contextUrl;
+    if (idx > 0) {
+        normalized = contextUrl.substring(idx);
+    }
+
+    try {
+        new URL(normalized);
+        return normalized;
+    } catch {
+    }
+
+    return undefined
+}

src/workspacesExplorerView.ts

@@ -121,7 +121,7 @@ export class WorkspacesExplorerView extends Disposable implements vscode.TreeDat
                     ws.owner,
                     ws.repo,
                     ws.id,
-                    ws.contextUrl,
+                    ws.contextUrl ?? 'undefined',
                     ws.phase === 'running',
                     ws.description,
                     ws.lastUsed