[server] add editor prefix to choose custom IDE

Author: mustard-mh

components/gitpod-protocol/src/context-url.ts

@@ -20,6 +20,7 @@ export namespace ContextURL {
     export const IMAGEBUILD_PREFIX = "imagebuild";
     export const SNAPSHOT_PREFIX = "snapshot";
     export const REFERRER_PREFIX = "referrer:";
+    export const EDITOR_PREFIX = "editor:";
 
     /**
      * This function will (try to) return the HTTP(S) URL of the context the user originally created this workspace on.
@@ -94,7 +95,8 @@ export namespace ContextURL {
             firstSegment === INCREMENTAL_PREBUILD_PREFIX ||
             firstSegment === IMAGEBUILD_PREFIX ||
             firstSegment === SNAPSHOT_PREFIX ||
-            firstSegment.startsWith(REFERRER_PREFIX)
+            firstSegment.startsWith(REFERRER_PREFIX) ||
+            firstSegment.startsWith(EDITOR_PREFIX)
         ) {
             return segmentsToURL(1);
         }

components/gitpod-protocol/src/protocol.ts

@@ -863,14 +863,26 @@ export namespace PrebuiltWorkspaceContext {
     }
 }
 
+export interface WithEditorContext extends WorkspaceContext {
+    ide: string;
+    useLatest?: boolean;
+    referrer?: string;
+}
+
+export namespace WithEditorContext {
+    export function is(context: any): context is WithEditorContext {
+        return context && "ide" in context;
+    }
+}
+
 export interface WithReferrerContext extends WorkspaceContext {
     referrer: string;
     referrerIde?: string;
 }
 
 export namespace WithReferrerContext {
     export function is(context: any): context is WithReferrerContext {
-        return context && "referrer" in context;
+        return context && "referrer" in context && !("ide" in context);
     }
 }
 

components/server/src/container-module.ts

@@ -96,6 +96,7 @@ import { DebugApp } from "./debug-app";
 import { LocalMessageBroker, LocalRabbitMQBackedMessageBroker } from "./messaging/local-message-broker";
 import { contentServiceBinder } from "@gitpod/content-service/lib/sugar";
 import { ReferrerPrefixParser } from "./workspace/referrer-prefix-context-parser";
+import { EditorPrefixParser } from "./workspace/editor-prefix-context-parser";
 import { InstallationAdminTelemetryDataProvider } from "./installation-admin/telemetry-data-provider";
 
 export const productionContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
@@ -169,6 +170,7 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
     bind(SnapshotContextParser).toSelf().inSingletonScope();
     bind(IContextParser).to(SnapshotContextParser).inSingletonScope();
     bind(IPrefixContextParser).to(ReferrerPrefixParser).inSingletonScope();
+    bind(IPrefixContextParser).to(EditorPrefixParser).inSingletonScope();
     bind(IPrefixContextParser).to(EnvvarPrefixParser).inSingletonScope();
     bind(IPrefixContextParser).to(ImageBuildPrefixContextParser).inSingletonScope();
     bind(IPrefixContextParser).to(AdditionalContentPrefixContextParser).inSingletonScope();

components/server/src/workspace/editor-prefix-context-parser.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { IPrefixContextParser } from "./context-parser";
+import { User, WorkspaceContext, WithEditorContext } from "@gitpod/gitpod-protocol";
+import { injectable } from "inversify";
+
+@injectable()
+export class EditorPrefixParser implements IPrefixContextParser {
+    private readonly prefix = /^\/?editor:([^\/:]*?)(?::([^\/:]*?))?(?::([^\/:]*?))?\//;
+
+    findPrefix(_: User, context: string): string | undefined {
+        return this.prefix.exec(context)?.[0] || undefined;
+    }
+
+    async handle(_: User, prefix: string, context: WorkspaceContext): Promise<WorkspaceContext | WithEditorContext> {
+        const matches = this.prefix.exec(prefix);
+        const ide = matches?.[1];
+        const useLatest = matches?.[2] === "latest";
+        const referrer = matches?.[3];
+        return ide ? { ...context, ide, useLatest, referrer } : context;
+    }
+}

components/server/src/workspace/workspace-starter.ts

@@ -103,7 +103,7 @@ import * as path from "path";
 import * as grpc from "@grpc/grpc-js";
 import { IDEConfig, IDEConfigService } from "../ide-config";
 import { EnvVarWithValue } from "@gitpod/gitpod-protocol/src/protocol";
-import { WithReferrerContext } from "@gitpod/gitpod-protocol/lib/protocol";
+import { WithEditorContext, WithReferrerContext } from "@gitpod/gitpod-protocol/lib/protocol";
 import { IDEOption, IDEOptions } from "@gitpod/gitpod-protocol/lib/ide-protocol";
 import { Deferred } from "@gitpod/gitpod-protocol/lib/util/deferred";
 import { ExtendedUser } from "@gitpod/ws-manager/lib/constraints";
@@ -607,8 +607,12 @@ export class WorkspaceStarter {
             user.additionalData.ideSettings = migratted;
         }
 
-        const ideChoice = user.additionalData?.ideSettings?.defaultIde;
-        const useLatest = !!user.additionalData?.ideSettings?.useLatestVersion;
+        const preferenceIDE = user.additionalData?.ideSettings?.defaultIde;
+        const perferenceUseLatest = !!user.additionalData?.ideSettings?.useLatestVersion;
+        const ideChoice = WithEditorContext.is(workspace.context) ? workspace.context.ide : preferenceIDE;
+        const useLatest = WithEditorContext.is(workspace.context)
+            ? workspace.context.useLatest ?? false
+            : perferenceUseLatest;
 
         // TODO(cw): once we allow changing the IDE in the workspace config (i.e. .gitpod.yml), we must
         //           give that value precedence over the default choice.
@@ -618,7 +622,7 @@ export class WorkspaceStarter {
             ideConfig: {
                 // We only check user setting because if code(insider) but desktopIde has no latestImage
                 // it still need to notice user that this workspace is using latest IDE
-                useLatest: user.additionalData?.ideSettings?.useLatestVersion,
+                useLatest,
             },
         };
 
@@ -633,11 +637,17 @@ export class WorkspaceStarter {
             configuration.desktopIdeImage = choose.desktopIdeImage;
         }
 
+        log.info(
+            { context: workspace.context, isEditorContext: WithEditorContext.is(workspace.context) },
+            "check context",
+        );
+
         const referrerIde = this.resolveReferrerIDE(workspace, user, ideConfig);
         if (referrerIde) {
-            configuration.desktopIdeImage = useLatest
+            configuration.desktopIdeImage = perferenceUseLatest
                 ? referrerIde.option.latestImage ?? referrerIde.option.image
                 : referrerIde.option.image;
+            configuration.ideConfig!.useLatest = perferenceUseLatest;
             if (!user.additionalData?.ideSettings) {
                 // A user does not have IDE settings configured yet configure it with a referrer ide as default.
                 const additionalData = user?.additionalData || {};
@@ -691,17 +701,24 @@ export class WorkspaceStarter {
             },
             configuration,
         };
-        if (WithReferrerContext.is(workspace.context)) {
+
+        const trackIDEPreferrer = (referrer?: string, referrerIde?: string, useLatest?: boolean) => {
             this.analytics.track({
                 userId: user.id,
                 event: "ide_referrer",
                 properties: {
                     workspaceId: workspace.id,
                     instanceId: instance.id,
-                    referrer: workspace.context.referrer,
-                    referrerIde: workspace.context.referrerIde,
+                    referrer,
+                    useLatest,
+                    referrerIde,
                 },
             });
+        };
+        if (WithReferrerContext.is(workspace.context)) {
+            trackIDEPreferrer(workspace.context.referrer, workspace.context.referrerIde, perferenceUseLatest);
+        } else if (WithEditorContext.is(workspace.context)) {
+            trackIDEPreferrer(workspace.context.referrer, workspace.context.ide, workspace.context.useLatest);
         }
         return instance;
     }