[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,8 @@ export default class CreateWorkspace extends React.Component<CreateWorkspaceProp
                     onPrebuildSucceeded={() => this.createWorkspace(CreateWorkspaceMode.UsePrebuild)}
                 />
             );
+        } else if (result?.showUserIdePreference) {
+            statusMessage = <SelectIDEModal onClose={() => this.createWorkspace(CreateWorkspaceMode.Default)} />;
         }
 
         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"`
+	ShowUserIdePreference      bool                      `json:"showUserIdePreference,omitempty"`
 	RunningPrebuildWorkspaceID string                    `json:"runningPrebuildWorkspaceID,omitempty"`
 	RunningWorkspacePrebuild   *RunningWorkspacePrebuild `json:"runningWorkspacePrebuild,omitempty"`
 	WorkspaceURL               string                    `json:"workspaceURL,omitempty"`

components/gitpod-protocol/src/protocol.ts

@@ -968,6 +968,16 @@ export namespace WithReferrerContext {
     }
 }
 
+export type IDESpecifiedContext = WithReferrerContext;
+
+// For those prefixes that have `IDE` specified.
+// Currently used for not showing onboarding IDE awareness modal
+export namespace IDESpecifiedContext {
+    export function is(context: any): context is IDESpecifiedContext {
+        return context && WithReferrerContext.is(context);
+    }
+}
+
 export interface WithEnvvarsContext extends WorkspaceContext {
     envvars: EnvVarWithValue[];
 }
@@ -1180,6 +1190,7 @@ export interface WorkspaceCreationResult {
     createdWorkspaceId?: string;
     workspaceURL?: string;
     existingWorkspaces?: WorkspaceInfo[];
+    showUserIdePreference?: boolean;
     runningWorkspacePrebuild?: {
         prebuildID: string;
         workspaceID: string;
@@ -1208,6 +1219,7 @@ export namespace WorkspaceCreationResult {
             data &&
             ("createdWorkspaceId" in data ||
                 "existingWorkspaces" in data ||
+                "showUserIdePreference" in data ||
                 "runningWorkspacePrebuild" in data ||
                 "runningPrebuildWorkspaceID" in data)
         );

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

@@ -154,7 +154,7 @@ import { IDEConfigService } from "../ide-config";
 import { PartialProject } from "@gitpod/gitpod-protocol/src/teams-projects-protocol";
 import { ClientMetadata, traceClientMetadata } from "../websocket/websocket-connection-manager";
 import { ConfigurationService } from "../config/configuration-service";
-import { ProjectEnvVar } from "@gitpod/gitpod-protocol/src/protocol";
+import { IDESpecifiedContext, 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";
@@ -1063,6 +1063,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
                 }).catch();
             }
 
+            if (User.isOnboardingUser(user) && !IDESpecifiedContext.is(context)) {
+                return { showUserIdePreference: true };
+            }
+
             // if we're forced to use the default config, mark the context as such
             if (!!options.forceDefaultConfig) {
                 context = WithDefaultConfig.mark(context);