Add preferToolbox setting and update response of /status for toolbox launcher

Author: mustard-mh

components/dashboard/src/service/service.tsx

@@ -344,8 +344,15 @@ export class IDEFrontendService implements IDEFrontendDashboardService.IServer {
             const desktopLink = new URL(url);
             // allow to redirect only for whitelisted trusted protocols
             // IDE-69
-            const trustedProtocols = ["vscode:", "vscode-insiders:", "jetbrains-gateway:"];
+            const trustedProtocols = ["vscode:", "vscode-insiders:", "jetbrains-gateway:", "jetbrains:"];
             redirect = trustedProtocols.includes(desktopLink.protocol);
+            if (
+                redirect &&
+                desktopLink.protocol === "jetbrains:" &&
+                !desktopLink.href.startsWith("jetbrains://gateway/io.gitpod.toolbox.gateway/")
+            ) {
+                redirect = false;
+            }
         } catch (e) {
             console.error("invalid desktop link:", e);
         }

components/dashboard/src/user-settings/SelectIDE.tsx

@@ -25,18 +25,20 @@ export default function SelectIDE(props: SelectIDEProps) {
 
     const [defaultIde, setDefaultIde] = useState<string>(user?.editorSettings?.name || "code");
     const [useLatestVersion, setUseLatestVersion] = useState<boolean>(user?.editorSettings?.version === "latest");
+    const [preferToolbox, setPreferToolbox] = useState<boolean>(user?.editorSettings?.preferToolbox || false);
     const [ideWarning, setIdeWarning] = useState<ReactNode | undefined>(undefined);
 
     const isOrgOwnedUser = user && isOrganizationOwned(user);
 
     const actualUpdateUserIDEInfo = useCallback(
-        async (selectedIde: string, useLatestVersion: boolean) => {
+        async (selectedIde: string, useLatestVersion: boolean, preferToolbox: boolean) => {
             // update stored autostart options to match useLatestVersion value set here
             const workspaceAutostartOptions = user?.workspaceAutostartOptions?.map((o) => {
                 const option = converter.fromWorkspaceAutostartOption(o);
 
                 if (option.ideSettings) {
                     option.ideSettings.useLatestVersion = useLatestVersion;
+                    option.ideSettings.preferToolbox = preferToolbox;
                 }
 
                 return option;
@@ -46,9 +48,10 @@ export default function SelectIDE(props: SelectIDEProps) {
                 additionalData: {
                     workspaceAutostartOptions,
                     ideSettings: {
-                        settingVersion: "2.0",
+                        settingVersion: "2.1",
                         defaultIde: selectedIde,
                         useLatestVersion: useLatestVersion,
+                        preferToolbox: preferToolbox,
                     },
                 },
             });
@@ -59,18 +62,26 @@ export default function SelectIDE(props: SelectIDEProps) {
 
     const actuallySetDefaultIde = useCallback(
         async (value: string) => {
-            await actualUpdateUserIDEInfo(value, useLatestVersion);
+            await actualUpdateUserIDEInfo(value, useLatestVersion, preferToolbox);
             setDefaultIde(value);
         },
-        [actualUpdateUserIDEInfo, useLatestVersion],
+        [actualUpdateUserIDEInfo, useLatestVersion, preferToolbox],
     );
 
     const actuallySetUseLatestVersion = useCallback(
         async (value: boolean) => {
-            await actualUpdateUserIDEInfo(defaultIde, value);
+            await actualUpdateUserIDEInfo(defaultIde, value, preferToolbox);
             setUseLatestVersion(value);
         },
-        [actualUpdateUserIDEInfo, defaultIde],
+        [actualUpdateUserIDEInfo, defaultIde, preferToolbox],
+    );
+
+    const actuallySetPreferToolbox = useCallback(
+        async (value: boolean) => {
+            await actualUpdateUserIDEInfo(defaultIde, useLatestVersion, value);
+            setPreferToolbox(value);
+        },
+        [actualUpdateUserIDEInfo, defaultIde, useLatestVersion],
     );
 
     const shouldShowJetbrainsNotice = isJetbrains(defaultIde);
@@ -142,6 +153,13 @@ export default function SelectIDE(props: SelectIDEProps) {
                 checked={useLatestVersion}
                 onChange={(checked) => actuallySetUseLatestVersion(checked)}
             />
+
+            <CheckboxInputField
+                label="Launch in JetBrains Toolbox"
+                hint={<span>Launch JetBrains IDEs in the JetBrains Toolbox.</span>}
+                checked={preferToolbox}
+                onChange={(checked) => actuallySetPreferToolbox(checked)}
+            />
         </>
     );
 }

components/dashboard/src/workspaces/CreateWorkspacePage.tsx

@@ -81,7 +81,9 @@ export function CreateWorkspacePage() {
         props.ideSettings?.useLatestVersion !== undefined
             ? props.ideSettings.useLatestVersion
             : user?.editorSettings?.version === "latest";
+    const defaultPreferToolbox = props.ideSettings?.preferToolbox ?? user?.editorSettings?.preferToolbox ?? false;
     const [useLatestIde, setUseLatestIde] = useState(defaultLatestIde);
+    const [preferToolbox, setPreferToolbox] = useState(defaultPreferToolbox);
     // Note: it has data fetching and UI rendering race between the updating of `selectedProjectId` and `selectedIde`
     // We have to stored the using repositoryId locally so that we can know selectedIde is updated because if which repo
     // so that it doesn't show ide error messages in middle state
@@ -145,6 +147,7 @@ export function CreateWorkspacePage() {
                 editorSettings: new EditorReference({
                     name: selectedIde,
                     version: useLatestIde ? "latest" : "stable",
+                    preferToolbox: preferToolbox,
                 }),
             }),
         );
@@ -156,7 +159,17 @@ export function CreateWorkspacePage() {
             },
         });
         setUser(updatedUser);
-    }, [updateUser, currentOrg, selectedIde, selectedWsClass, setUser, useLatestIde, user, workspaceContext.data]);
+    }, [
+        updateUser,
+        currentOrg,
+        selectedIde,
+        selectedWsClass,
+        setUser,
+        useLatestIde,
+        preferToolbox,
+        user,
+        workspaceContext.data,
+    ]);
 
     // see if we have a matching project based on context url and project's repo url
     const project = useMemo(() => {
@@ -271,6 +284,7 @@ export function CreateWorkspacePage() {
                     contextUrlSource.editor = {
                         name: selectedIde,
                         version: useLatestIde ? "latest" : undefined,
+                        preferToolbox: preferToolbox,
                     };
                 }
                 opts.source = {
@@ -301,6 +315,7 @@ export function CreateWorkspacePage() {
             selectedWsClass,
             selectedIde,
             useLatestIde,
+            preferToolbox,
             createWorkspaceMutation,
             selectedProjectID,
             storeAutoStartOptions,
@@ -358,6 +373,7 @@ export function CreateWorkspacePage() {
                 }
                 setSelectedIde(rememberedOptions.editorSettings?.name, false);
                 setUseLatestIde(rememberedOptions.editorSettings?.version === "latest");
+                setPreferToolbox(rememberedOptions.editorSettings?.preferToolbox || false);
             }
 
             if (!selectedWsClassIsDirty) {
@@ -374,6 +390,7 @@ export function CreateWorkspacePage() {
             if (!selectedIdeIsDirty) {
                 setSelectedIde(defaultIde, false);
                 setUseLatestIde(defaultLatestIde);
+                setPreferToolbox(defaultPreferToolbox);
             }
             if (!selectedWsClassIsDirty) {
                 const projectWsClass = project?.settings?.workspaceClasses?.regular;

components/ide-service/example-ide-config.json

@@ -129,6 +129,18 @@
           "If you don't see an open dialog in your browser, make sure you have the \u003ca target='_blank' class='gp-link' href='https://www.gitpod.io/docs/ides-and-editors/jetbrains-gateway#getting-started-jetbrains-gateway'\u003eJetBrains Gateway with Gitpod Plugin\u003c/a\u003e installed on your machine, and then click \u003cb\u003e${OPEN_LINK_LABEL}\u003c/b\u003e below."
         ]
       },
+      "jetbrains-toolbox": {
+        "defaultDesktopIDE": "intellij",
+        "desktopIDEs": [
+          "intellij",
+          "goland",
+          "pycharm",
+          "phpstorm"
+        ],
+        "installationSteps": [
+          "If you don't see an open dialog in your browser, make sure you have the \u003ca target='_blank' class='gp-link' href='https://www.gitpod.io/docs/ides-and-editors/jetbrains-gateway#getting-started-jetbrains-gateway'\u003eJetBrains Toolbox with Gitpod Plugin\u003c/a\u003e installed on your machine, and then click \u003cb\u003e${OPEN_LINK_LABEL}\u003c/b\u003e below."
+        ]
+      },
       "vscode": {
         "defaultDesktopIDE": "code-desktop",
         "desktopIDEs": [

components/ide-service/pkg/server/server.go

@@ -303,6 +303,7 @@ func grpcProbe(cfg baseserver.ServerConfiguration) func() error {
 type IDESettings struct {
 	DefaultIde        string            `json:"defaultIde,omitempty"`
 	UseLatestVersion  bool              `json:"useLatestVersion,omitempty"`
+	PreferToolbox     bool              `json:"preferToolbox,omitempty"`
 	PinnedIDEversions map[string]string `json:"pinnedIDEversions,omitempty"`
 }
 
@@ -440,12 +441,22 @@ func (s *IDEServiceServer) ResolveWorkspaceConfig(ctx context.Context, req *api.
 
 		userIdeName := ""
 		useLatest := false
+		preferToolbox := false
 		resultingIdeName := ideConfig.IdeOptions.DefaultIde
 		chosenIDE := ideConfig.IdeOptions.Options[resultingIdeName]
 
 		if ideSettings != nil {
 			userIdeName = ideSettings.DefaultIde
 			useLatest = ideSettings.UseLatestVersion
+			preferToolbox = ideSettings.PreferToolbox
+		}
+
+		if preferToolbox {
+			preferToolboxEnv := api.EnvironmentVariable{
+				Name:  "GITPOD_PREFER_TOOLBOX",
+				Value: "true",
+			}
+			resp.Envvars = append(resp.Envvars, &preferToolboxEnv)
 		}
 
 		if userIdeName != "" {
@@ -499,6 +510,7 @@ func (s *IDEServiceServer) ResolveWorkspaceConfig(ctx context.Context, req *api.
 		resultingIdeSettings := &IDESettings{
 			DefaultIde:       resultingIdeName,
 			UseLatestVersion: useLatest,
+			PreferToolbox:    preferToolbox,
 		}
 
 		err = enc.Encode(resultingIdeSettings)

components/ide/jetbrains/launcher/main.go

@@ -57,6 +57,7 @@ type LaunchContext struct {
 	label  string
 	warmup bool
 
+	preferToolbox  bool
 	qualifier      string
 	productDir     string
 	backendDir     string
@@ -98,6 +99,7 @@ func main() {
 	// supervisor refer see https://github.com/gitpod-io/gitpod/blob/main/components/supervisor/pkg/supervisor/supervisor.go#L961
 	shouldWaitBackendPlugin := os.Getenv("GITPOD_WAIT_IDE_BACKEND") == "true"
 	debugEnabled := os.Getenv("SUPERVISOR_DEBUG_ENABLE") == "true"
+	preferToolbox := os.Getenv("GITPOD_PREFER_TOOLBOX") == "true"
 	log.Init(ServiceName, constant.Version, true, debugEnabled)
 	log.Info(ServiceName + ": " + constant.Version)
 	startTime := time.Now()
@@ -165,6 +167,7 @@ func main() {
 		alias:  alias,
 		label:  label,
 
+		preferToolbox:           preferToolbox,
 		qualifier:               qualifier,
 		productDir:              productDir,
 		backendDir:              backendDir,
@@ -179,10 +182,12 @@ func main() {
 		return
 	}
 
-	err = configureToolboxCliProperties(backendDir)
-	if err != nil {
-		log.WithError(err).Error("failed to write toolbox cli config file")
-		return
+	if preferToolbox {
+		err = configureToolboxCliProperties(backendDir)
+		if err != nil {
+			log.WithError(err).Error("failed to write toolbox cli config file")
+			return
+		}
 	}
 
 	// we should start serving immediately and postpone launch
@@ -284,6 +289,22 @@ func serve(launchCtx *LaunchContext) {
 		fmt.Fprint(w, jsonLink)
 	})
 	http.HandleFunc("/status", func(w http.ResponseWriter, r *http.Request) {
+		if launchCtx.preferToolbox {
+			response := make(map[string]string)
+			toolboxLink, err := resolveToolboxLink(launchCtx.wsInfo)
+			if err != nil {
+				log.WithError(err).Error("cannot resolve toolbox link")
+				http.Error(w, err.Error(), http.StatusServiceUnavailable)
+				return
+			}
+			response["link"] = toolboxLink
+			response["label"] = launchCtx.label
+			response["clientID"] = "jetbrains-toolbox"
+			response["kind"] = launchCtx.alias
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(response)
+			return
+		}
 		backendPort := r.URL.Query().Get("backendPort")
 		if backendPort == "" {
 			backendPort = defaultBackendPort
@@ -366,6 +387,21 @@ type JoinLinkResponse struct {
 	JoinLink string `json:"joinLink"`
 }
 
+func resolveToolboxLink(wsInfo *supervisor.WorkspaceInfoResponse) (string, error) {
+	gitpodUrl, err := url.Parse(wsInfo.GitpodHost)
+	if err != nil {
+		return "", err
+	}
+	debugWorkspace := wsInfo.DebugWorkspaceType != supervisor.DebugWorkspaceType_noDebug
+	// jetbrains://gateway/io.gitpod.toolbox.gateway/open-in-toolbox?host=${host}&workspaceId=${workspaceId}&debugWorkspace=${debugWorkspace}
+	link := url.URL{
+		Scheme:   "jetbrains",
+		Host:     "gateway",
+		Fragment: fmt.Sprintf("io.gitpod.toolbox.gateway/open-in-toolbox?host=%s&workspaceId=%s&debugWorkspace=%t", gitpodUrl.Hostname(), wsInfo.WorkspaceId, debugWorkspace),
+	}
+	return link.String(), nil
+}
+
 func resolveGatewayLink(backendPort string, wsInfo *supervisor.WorkspaceInfoResponse) (string, error) {
 	gitpodUrl, err := url.Parse(wsInfo.GitpodHost)
 	if err != nil {

components/server/src/api/workspace-service-api.ts

@@ -185,6 +185,7 @@ export class WorkspaceServiceAPI implements ServiceImpl<typeof WorkspaceServiceI
                 useLatestVersion: req.source.value.editor?.version
                     ? req.source.value.editor?.version === "latest"
                     : undefined,
+                preferToolbox: req.source.value.editor?.preferToolbox ?? false,
             },
             clientRegionCode: ctxClientRegion(),
         });

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

@@ -312,6 +312,7 @@ export class WorkspaceStarter {
                             ideSettings?.useLatestVersion ??
                             user.additionalData?.ideSettings?.useLatestVersion ??
                             !!ideConfig.useLatest,
+                        preferToolbox: ideSettings?.preferToolbox ?? user.additionalData?.ideSettings?.preferToolbox ?? ideConfig.preferToolbox ?? false,
                     };
                 }
             }

install/installer/pkg/components/ide-service/ide-configmap.json

@@ -680,6 +680,23 @@
           "If you don't see an open dialog in your browser, make sure you have the <a target='_blank' class='gp-link' href='https://www.gitpod.io/docs/ides-and-editors/jetbrains-gateway#getting-started-jetbrains-gateway'>JetBrains Gateway with Gitpod Plugin</a> installed on your machine, and then click <b>${OPEN_LINK_LABEL}</b> below."
         ]
       },
+      "jetbrains-toolbox": {
+        "defaultDesktopIDE": "intellij",
+        "desktopIDEs": [
+          "intellij",
+          "goland",
+          "pycharm",
+          "phpstorm",
+          "rubymine",
+          "webstorm",
+          "rider",
+          "clion",
+          "rustrover"
+        ],
+        "installationSteps": [
+          "If you don't see an open dialog in your browser, make sure you have the <a target='_blank' class='gp-link' href='https://www.gitpod.io/docs/ides-and-editors/jetbrains-toolbox#getting-started-jetbrains-toolbox'>JetBrains Toolbox with Gitpod Plugin</a> installed on your machine, and then click <b>${OPEN_LINK_LABEL}</b> below."
+        ]
+      },
       "vscode": {
         "defaultDesktopIDE": "code-desktop",
         "desktopIDEs": [