[dashboard] increase IDE awareness for onboarding user when starting workspace

Author: mustard-mh

components/dashboard/src/settings/SelectIDEModal.tsx

@@ -11,7 +11,7 @@ import SelectIDE, { updateUserIDEInfo } from "./SelectIDE";
 import Modal from "../components/Modal";
 import { UserContext } from "../user-context";
 
-export default function () {
+export default function (props: { onClose?: () => void }) {
     const { user, setUser } = useContext(UserContext);
     const [visible, setVisible] = useState(true);
 
@@ -23,11 +23,13 @@ export default function () {
     const handleContinue = async () => {
         setVisible(false);
         if (!user || User.hasPreferredIde(user)) {
+            props.onClose && props.onClose();
             return;
         }
         // TODO: We need to get defaultIde in ideOptions..
         const defaultIde = "code";
         await actualUpdateUserIDEInfo(user, defaultIde, false);
+        props.onClose && props.onClose();
     };
 
     return (

components/dashboard/src/start/CreateWorkspace.tsx

@@ -15,14 +15,15 @@ import {
 import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import Modal from "../components/Modal";
 import { getGitpodService, gitpodHostUrl } from "../service/service";
-import { UserContext } from "../user-context";
 import { StartPage, StartPhase, StartWorkspaceError } from "./StartPage";
 import StartWorkspace, { parseProps } from "./StartWorkspace";
 import { openAuthorizeWindow } from "../provider-utils";
 import { SelectAccountPayload } from "@gitpod/gitpod-protocol/lib/auth";
 import { SelectAccountModal } from "../settings/SelectAccountModal";
 import { watchHeadlessLogs } from "../components/PrebuildLogs";
 import CodeText from "../components/CodeText";
+import SelectIDEModal from "../settings/SelectIDEModal";
+import { UserContext } from "../user-context";
 
 const WorkspaceLogs = React.lazy(() => import("../components/WorkspaceLogs"));
 
@@ -250,6 +251,10 @@ export default class CreateWorkspace extends React.Component<CreateWorkspaceProp
                     onPrebuildSucceeded={() => this.createWorkspace(CreateWorkspaceMode.UsePrebuild)}
                 />
             );
+        } else if (result?.needOnboardingIde) {
+            statusMessage = (
+                <SelectIDEModal onClose={() => this.createWorkspace(CreateWorkspaceMode.Default)}></SelectIDEModal>
+            );
         }
 
         return (

components/gitpod-protocol/go/gitpod-service.go

@@ -1516,6 +1516,7 @@ type Repository struct {
 type WorkspaceCreationResult struct {
 	CreatedWorkspaceID         string                    `json:"createdWorkspaceId,omitempty"`
 	ExistingWorkspaces         []*WorkspaceInfo          `json:"existingWorkspaces,omitempty"`
+	NeedOnboardingIDE          bool                      `json:"needOnboardingIde,omitempty"`
 	RunningPrebuildWorkspaceID string                    `json:"runningPrebuildWorkspaceID,omitempty"`
 	RunningWorkspacePrebuild   *RunningWorkspacePrebuild `json:"runningWorkspacePrebuild,omitempty"`
 	WorkspaceURL               string                    `json:"workspaceURL,omitempty"`

components/gitpod-protocol/src/protocol.ts

@@ -1180,6 +1180,7 @@ export interface WorkspaceCreationResult {
     createdWorkspaceId?: string;
     workspaceURL?: string;
     existingWorkspaces?: WorkspaceInfo[];
+    needOnboardingIde?: boolean;
     runningWorkspacePrebuild?: {
         prebuildID: string;
         workspaceID: string;
@@ -1208,6 +1209,7 @@ export namespace WorkspaceCreationResult {
             data &&
             ("createdWorkspaceId" in data ||
                 "existingWorkspaces" in data ||
+                "needOnboardingIde" in data ||
                 "runningWorkspacePrebuild" in data ||
                 "runningPrebuildWorkspaceID" in data)
         );

components/server/ee/src/prebuilds/start-prebuild-context-parser.ts

@@ -10,6 +10,7 @@ import { IPrefixContextParser } from "../../../src/workspace/context-parser";
 
 @injectable()
 export class StartPrebuildContextParser implements IPrefixContextParser {
+    readonly specifiedIDE: boolean = false;
     static PREFIX = ContextURL.PREBUILD_PREFIX + "/";
 
     findPrefix(user: User, context: string): string | undefined {

components/server/src/workspace/additional-content-prefix-context-parser.ts

@@ -16,6 +16,7 @@ import { IPrefixContextParser } from "./context-parser";
  */
 @injectable()
 export class AdditionalContentPrefixContextParser implements IPrefixContextParser {
+    readonly specifiedIDE: boolean = false;
     @inject(Config) protected readonly config: Config;
     static PREFIX = /^\/?additionalcontent\/([^\/]*)\//;
 

components/server/src/workspace/context-parser-service.ts

@@ -7,7 +7,7 @@
 import { WorkspaceContext, User, CommitContext, GitCheckoutInfo, PullRequestContext } from "@gitpod/gitpod-protocol";
 import { injectable, multiInject, inject } from "inversify";
 import { HostContextProvider } from "../auth/host-context-provider";
-import { IPrefixContextParser, IContextParser } from "./context-parser";
+import { IPrefixContextParser, IContextParser, IPrefixContextParserContext } from "./context-parser";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
 import { ConfigProvider, InvalidGitpodYMLError } from "./config-provider";
 
@@ -55,6 +55,7 @@ export class ContextParser {
 
             if (prefixResult) {
                 result = await prefixResult.parser.handle(user, prefixResult.prefix, result);
+                (result as IPrefixContextParserContext).specifiedIDE = prefixResult.parser.specifiedIDE;
             }
         } catch (e) {
             span.logEvent("error", e);

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

@@ -96,12 +96,24 @@ export interface URLParts {
  * and expects "othercontext" to be parsed and passed back.
  */
 export interface IPrefixContextParser {
+    // readonly property to see if prefix context will specify an IDE
+    specifiedIDE: boolean;
     normalize?(contextURL: string): string | undefined;
     findPrefix(user: User, context: string): string | undefined;
     handle(user: User, prefix: string, context: WorkspaceContext): Promise<WorkspaceContext>;
 }
 export const IPrefixContextParser = Symbol("IPrefixContextParser");
 
+export interface IPrefixContextParserContext extends WorkspaceContext {
+    specifiedIDE?: boolean;
+}
+
+export namespace IPrefixContextParserContext {
+    export function is(context: any): context is IPrefixContextParserContext {
+        return context && "specifiedIDE" in context;
+    }
+}
+
 export namespace IssueContexts {
     export function toBranchName(user: User, issueTitle: string, issueNr: number): string {
         const titleWords = issueTitle

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

@@ -11,6 +11,7 @@ import { EnvVarWithValue } from "@gitpod/gitpod-protocol/src/protocol";
 
 @injectable()
 export class EnvvarPrefixParser implements IPrefixContextParser {
+    readonly specifiedIDE: boolean = false;
     public findPrefix(user: User, context: string): string | undefined {
         const result = this.parse(context);
         return result && result.prefix;

components/server/src/workspace/gitpod-server-impl.ts

@@ -157,6 +157,7 @@ import { ProjectEnvVar } from "@gitpod/gitpod-protocol/src/protocol";
 import { InstallationAdminSettings, TelemetryData } from "@gitpod/gitpod-protocol";
 import { Deferred } from "@gitpod/gitpod-protocol/lib/util/deferred";
 import { InstallationAdminTelemetryDataProvider } from "../installation-admin/telemetry-data-provider";
+import { IPrefixContextParserContext } from "./context-parser";
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi); // userId is already taken care of in WebsocketConnectionManager
@@ -1059,6 +1060,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
                 }).catch();
             }
 
+            if (User.isOnboardingUser(user) && (!IPrefixContextParserContext.is(context) || !context.specifiedIDE)) {
+                return { needOnboardingIde: true };
+            }
+
             // if we're forced to use the default config, mark the context as such
             if (!!options.forceDefaultConfig) {
                 context = WithDefaultConfig.mark(context);

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

@@ -10,6 +10,7 @@ import { IPrefixContextParser } from "./context-parser";
 
 @injectable()
 export class ImageBuildPrefixContextParser implements IPrefixContextParser {
+    readonly specifiedIDE: boolean = false;
     static PREFIX = ContextURL.IMAGEBUILD_PREFIX + "/";
 
     findPrefix(user: User, context: string): string | undefined {

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

@@ -10,6 +10,7 @@ import { injectable } from "inversify";
 
 @injectable()
 export class ReferrerPrefixParser implements IPrefixContextParser {
+    readonly specifiedIDE: boolean = true;
     private readonly prefix = /^\/?referrer:([^\/:]*)(?::([^\/]*))?\//;
 
     findPrefix(_: User, context: string): string | undefined {