fix #13815: jetbrains: launch with interactive login shell in async manner

Author: akosyakov

components/ide/jetbrains/image/leeway.Dockerfile

@@ -14,7 +14,6 @@ ARG SUPERVISOR_IDE_CONFIG
 # ensures right permissions for /ide-desktop
 COPY --from=base_builder --chown=33333:33333 /ide-desktop/ /ide-desktop/
 COPY --chown=33333:33333 ${SUPERVISOR_IDE_CONFIG} /ide-desktop/supervisor-ide-config.json
-COPY --chown=33333:33333 startup.sh /ide-desktop/
 COPY --chown=33333:33333 components-ide-jetbrains-image--download-${JETBRAINS_DOWNLOAD_QUALIFIER}/backend /ide-desktop/backend
 COPY --chown=33333:33333 components-ide-jetbrains-image-status--app/status /ide-desktop
 

components/ide/jetbrains/image/startup.sh

@@ -49,54 +49,23 @@ const BackendPath = "/ide-desktop/backend"
 const ProductInfoPath = BackendPath + "/product-info.json"
 
 type LaunchContext struct {
-	alias             string
+	startTime time.Time
+
+	port  string
+	alias string
+	label string
+
+	info           *ProductInfo
+	backendVersion *version.Version
+	wsInfo         *supervisor.WorkspaceInfoResponse
+
+	vmOptionsFile     string
 	projectDir        string
 	configDir         string
 	systemDir         string
 	projectConfigDir  string
 	projectContextDir string
 	riderSolutionFile string
-	wsInfo            *supervisor.WorkspaceInfoResponse
-}
-
-// TODO(andreafalzetti): remove dir scanning once this is implemented https://youtrack.jetbrains.com/issue/GTW-2402/Rider-Open-Project-dialog-not-displaying-in-remote-dev
-func findRiderSolutionFile(root string) (string, error) {
-	slnRegEx := regexp.MustCompile(`^.+\.sln$`)
-	projRegEx := regexp.MustCompile(`^.+\.csproj$`)
-
-	var slnFiles []string
-	var csprojFiles []string
-
-	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
-		if err != nil {
-			return err
-		} else if slnRegEx.MatchString(info.Name()) {
-			slnFiles = append(slnFiles, path)
-		} else if projRegEx.MatchString(info.Name()) {
-			csprojFiles = append(csprojFiles, path)
-		}
-		return nil
-	})
-
-	if err != nil {
-		return "", err
-	}
-
-	if len(slnFiles) > 0 {
-		return slnFiles[0], nil
-	} else if len(csprojFiles) > 0 {
-		return csprojFiles[0], nil
-	}
-
-	return root, nil
-}
-
-func resolveProjectContextDir(launchCtx *LaunchContext) string {
-	if launchCtx.alias == "rider" {
-		return launchCtx.riderSolutionFile
-	}
-
-	return launchCtx.projectDir
 }
 
 // JB startup entrypoint
@@ -133,81 +102,28 @@ func main() {
 		return
 	}
 
-	projectDir := wsInfo.GetCheckoutLocation()
-	gitpodConfig, err := parseGitpodConfig(projectDir)
-	if err != nil {
-		log.WithError(err).Error("failed to parse .gitpod.yml")
-	}
-
-	// configure vmoptions
-	idePrefix := alias
-	if alias == "intellij" {
-		idePrefix = "idea"
-	}
-	// [idea64|goland64|pycharm64|phpstorm64].vmoptions
-	vmOptionsPath := fmt.Sprintf("/ide-desktop/backend/bin/%s64.vmoptions", idePrefix)
-	err = configureVMOptions(gitpodConfig, alias, vmOptionsPath)
-	if err != nil {
-		log.WithError(err).Error("failed to configure vmoptions")
-	}
-
-	qualifier := os.Getenv("JETBRAINS_BACKEND_QUALIFIER")
-	if qualifier == "stable" {
-		qualifier = ""
-	} else {
-		qualifier = "-" + qualifier
-	}
-
-	var riderSolutionFile string
-	if alias == "rider" {
-		riderSolutionFile, err = findRiderSolutionFile(projectDir)
-		if err != nil {
-			log.WithError(err).Error("failed to find a rider solution file")
-		}
-	}
-
-	configDir := fmt.Sprintf("/workspace/.config/JetBrains%s", qualifier)
 	launchCtx := &LaunchContext{
-		alias:             alias,
-		wsInfo:            wsInfo,
-		projectDir:        projectDir,
-		projectContextDir: projectDir,
-		configDir:         configDir,
-		systemDir:         fmt.Sprintf("/workspace/.cache/JetBrains%s", qualifier),
-		riderSolutionFile: riderSolutionFile,
-	}
+		startTime: startTime,
 
-	launchCtx.projectContextDir = resolveProjectContextDir(launchCtx)
-	launchCtx.projectConfigDir = fmt.Sprintf("%s/RemoteDev-%s/%s", configDir, info.ProductCode, strings.ReplaceAll(launchCtx.projectContextDir, "/", "_"))
+		port:  port,
+		alias: alias,
+		label: label,
 
-	// sync initial options
-	err = syncOptions(launchCtx)
-	if err != nil {
-		log.WithError(err).Error("failed to sync initial options")
+		info:           info,
+		backendVersion: backendVersion,
+		wsInfo:         wsInfo,
 	}
+	// we should start serving immediately and postpone launch
+	// in order to enable a JB Gateway to connect as soon as possible
+	go launch(launchCtx)
+	// IMPORTANT: don't put startup logic in serve!!!
+	serve(launchCtx)
+}
 
-	// install project plugins
-	version_2022_1, _ := version.NewVersion("2022.1")
-	if version_2022_1.LessThanOrEqual(backendVersion) {
-		err = installPlugins(gitpodConfig, launchCtx)
-		installPluginsCost := time.Now().Local().Sub(startTime).Milliseconds()
-		if err != nil {
-			log.WithError(err).WithField("cost", installPluginsCost).Error("installing repo plugins: done")
-		} else {
-			log.WithField("cost", installPluginsCost).Info("installing repo plugins: done")
-		}
-	}
-
-	// install gitpod plugin
-	err = linkRemotePlugin()
-	if err != nil {
-		log.WithError(err).Error("failed to install gitpod-remote plugin")
-	}
-	go run(launchCtx)
-
+func serve(launchCtx *LaunchContext) {
 	debugAgentPrefix := "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:"
 	http.HandleFunc("/debug", func(w http.ResponseWriter, r *http.Request) {
-		options, err := readVMOptions(vmOptionsPath)
+		options, err := readVMOptions(launchCtx.vmOptionsFile)
 		if err != nil {
 			log.WithError(err).Error("failed to configure debug agent")
 			http.Error(w, err.Error(), http.StatusInternalServerError)
@@ -243,7 +159,7 @@ func main() {
 		options = deduplicateVMOption(options, debugOptions, func(l, r string) bool {
 			return strings.HasPrefix(l, debugAgentPrefix) && strings.HasPrefix(r, debugAgentPrefix)
 		})
-		err = writeVMOptions(vmOptionsPath, options)
+		err = writeVMOptions(launchCtx.vmOptionsFile, options)
 		if err != nil {
 			log.WithError(err).Error("failed to configure debug agent")
 			http.Error(w, err.Error(), http.StatusInternalServerError)
@@ -274,7 +190,7 @@ func main() {
 		if backendPort == "" {
 			backendPort = defaultBackendPort
 		}
-		jsonLink, err := resolveGatewayLink(backendPort, wsInfo)
+		jsonLink, err := resolveGatewayLink(backendPort, launchCtx.wsInfo)
 		if err != nil {
 			log.WithError(err).Error("cannot resolve gateway link")
 			http.Error(w, err.Error(), http.StatusServiceUnavailable)
@@ -287,23 +203,23 @@ func main() {
 		if backendPort == "" {
 			backendPort = defaultBackendPort
 		}
-		gatewayLink, err := resolveGatewayLink(backendPort, wsInfo)
+		gatewayLink, err := resolveGatewayLink(backendPort, launchCtx.wsInfo)
 		if err != nil {
 			log.WithError(err).Error("cannot resolve gateway link")
 			http.Error(w, err.Error(), http.StatusServiceUnavailable)
 			return
 		}
 		response := make(map[string]string)
 		response["link"] = gatewayLink
-		response["label"] = label
+		response["label"] = launchCtx.label
 		response["clientID"] = "jetbrains-gateway"
-		response["kind"] = alias
+		response["kind"] = launchCtx.alias
 		w.Header().Set("Content-Type", "application/json")
 		_ = json.NewEncoder(w).Encode(response)
 	})
 
-	fmt.Printf("Starting status proxy for desktop IDE at port %s\n", port)
-	if err := http.ListenAndServe(fmt.Sprintf(":%s", port), nil); err != nil {
+	fmt.Printf("Starting status proxy for desktop IDE at port %s\n", launchCtx.port)
+	if err := http.ListenAndServe(fmt.Sprintf(":%s", launchCtx.port), nil); err != nil {
 		log.Fatal(err)
 	}
 }
@@ -415,6 +331,76 @@ func resolveWorkspaceInfo(ctx context.Context) (*supervisor.WorkspaceInfoRespons
 	return nil, errors.New("failed with attempt 10 times")
 }
 
+func launch(launchCtx *LaunchContext) {
+	projectDir := launchCtx.wsInfo.GetCheckoutLocation()
+	gitpodConfig, err := parseGitpodConfig(projectDir)
+	if err != nil {
+		log.WithError(err).Error("failed to parse .gitpod.yml")
+	}
+
+	// configure vmoptions
+	idePrefix := launchCtx.alias
+	if launchCtx.alias == "intellij" {
+		idePrefix = "idea"
+	}
+	// [idea64|goland64|pycharm64|phpstorm64].vmoptions
+	launchCtx.vmOptionsFile = fmt.Sprintf("/ide-desktop/backend/bin/%s64.vmoptions", idePrefix)
+	err = configureVMOptions(gitpodConfig, launchCtx.alias, launchCtx.vmOptionsFile)
+	if err != nil {
+		log.WithError(err).Error("failed to configure vmoptions")
+	}
+
+	qualifier := os.Getenv("JETBRAINS_BACKEND_QUALIFIER")
+	if qualifier == "stable" {
+		qualifier = ""
+	} else {
+		qualifier = "-" + qualifier
+	}
+
+	var riderSolutionFile string
+	if launchCtx.alias == "rider" {
+		riderSolutionFile, err = findRiderSolutionFile(projectDir)
+		if err != nil {
+			log.WithError(err).Error("failed to find a rider solution file")
+		}
+	}
+
+	configDir := fmt.Sprintf("/workspace/.config/JetBrains%s", qualifier)
+	launchCtx.projectDir = projectDir
+	launchCtx.configDir = configDir
+	launchCtx.systemDir = fmt.Sprintf("/workspace/.cache/JetBrains%s", qualifier)
+	launchCtx.riderSolutionFile = riderSolutionFile
+	launchCtx.projectContextDir = resolveProjectContextDir(launchCtx)
+	launchCtx.projectConfigDir = fmt.Sprintf("%s/RemoteDev-%s/%s", configDir, launchCtx.info.ProductCode, strings.ReplaceAll(launchCtx.projectContextDir, "/", "_"))
+
+	// sync initial options
+	err = syncOptions(launchCtx)
+	if err != nil {
+		log.WithError(err).Error("failed to sync initial options")
+	}
+
+	// install project plugins
+	version_2022_1, _ := version.NewVersion("2022.1")
+	if version_2022_1.LessThanOrEqual(launchCtx.backendVersion) {
+		err = installPlugins(gitpodConfig, launchCtx)
+		installPluginsCost := time.Now().Local().Sub(launchCtx.startTime).Milliseconds()
+		if err != nil {
+			log.WithError(err).WithField("cost", installPluginsCost).Error("installing repo plugins: done")
+		} else {
+			log.WithField("cost", installPluginsCost).Info("installing repo plugins: done")
+		}
+	}
+
+	// install gitpod plugin
+	err = linkRemotePlugin()
+	if err != nil {
+		log.WithError(err).Error("failed to install gitpod-remote plugin")
+	}
+
+	// run backend
+	run(launchCtx)
+}
+
 func run(launchCtx *LaunchContext) {
 	var args []string
 	args = append(args, "run")
@@ -443,14 +429,24 @@ func run(launchCtx *LaunchContext) {
 	os.Exit(cmd.ProcessState.ExitCode())
 }
 
-func remoteDevServerCmd(args []string, productContext *LaunchContext) *exec.Cmd {
-	cmd := exec.Command(BackendPath+"/bin/remote-dev-server.sh", args...)
-	cmd.Env = os.Environ()
-
-	// Set default config and system directories under /workspace to preserve between restarts
-	cmd.Env = append(cmd.Env,
-		fmt.Sprintf("IJ_HOST_CONFIG_BASE_DIR=%s", productContext.configDir),
-		fmt.Sprintf("IJ_HOST_SYSTEM_BASE_DIR=%s", productContext.systemDir),
+func remoteDevServerCmd(args []string, launchCtx *LaunchContext) *exec.Cmd {
+	shell := os.Getenv("SHELL")
+	if shell == "" {
+		shell = "/bin/bash"
+	}
+	// Emulate the interactive login shell to ensure that all users defined shell scripts are loaded
+	shellArgs := []string{"-ilc", BackendPath + "/bin/remote-dev-server.sh"}
+	shellArgs = append(shellArgs, args...)
+	cmd := exec.Command(shell, shellArgs...)
+
+	cmd.Env = append(os.Environ(),
+		// Set default config and system directories under /workspace to preserve between restarts
+		fmt.Sprintf("IJ_HOST_CONFIG_BASE_DIR=%s", launchCtx.configDir),
+		fmt.Sprintf("IJ_HOST_SYSTEM_BASE_DIR=%s", launchCtx.systemDir),
+		// instead put them into /ide-desktop/backend/bin/idea64.vmoptions
+		// otherwise JB will complain to a user on each startup
+		// by default remote dev already set -Xmx2048m, see /ide-desktop/backend/plugins/remote-dev-server/bin/launcher.sh
+		"JAVA_TOOL_OPTIONS=",
 	)
 
 	cmd.Stderr = os.Stderr
@@ -731,3 +727,43 @@ func linkRemotePlugin() error {
 	}
 	return os.Symlink("/ide-desktop-plugins/gitpod-remote", remotePluginDir)
 }
+
+// TODO(andreafalzetti): remove dir scanning once this is implemented https://youtrack.jetbrains.com/issue/GTW-2402/Rider-Open-Project-dialog-not-displaying-in-remote-dev
+func findRiderSolutionFile(root string) (string, error) {
+	slnRegEx := regexp.MustCompile(`^.+\.sln$`)
+	projRegEx := regexp.MustCompile(`^.+\.csproj$`)
+
+	var slnFiles []string
+	var csprojFiles []string
+
+	err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		} else if slnRegEx.MatchString(info.Name()) {
+			slnFiles = append(slnFiles, path)
+		} else if projRegEx.MatchString(info.Name()) {
+			csprojFiles = append(csprojFiles, path)
+		}
+		return nil
+	})
+
+	if err != nil {
+		return "", err
+	}
+
+	if len(slnFiles) > 0 {
+		return slnFiles[0], nil
+	} else if len(csprojFiles) > 0 {
+		return csprojFiles[0], nil
+	}
+
+	return root, nil
+}
+
+func resolveProjectContextDir(launchCtx *LaunchContext) string {
+	if launchCtx.alias == "rider" {
+		return launchCtx.riderSolutionFile
+	}
+
+	return launchCtx.projectDir
+}