Add experimental support for jupyter desktop (#1345)

* Implement jlab desktop

* Install jupyter server on remote side when using jupyter desktop

Author: bkneis

cmd/agent/container/setup.go

@@ -434,6 +434,8 @@ func (cmd *SetupContainerCmd) installIDE(setupInfo *config.Result, ide *provider
 		return fleet.NewFleetServer(config.GetRemoteUser(setupInfo), ide.Options, log).Install(setupInfo.SubstitutionContext.ContainerWorkspaceFolder)
 	case string(config2.IDEJupyterNotebook):
 		return jupyter.NewJupyterNotebookServer(setupInfo.SubstitutionContext.ContainerWorkspaceFolder, config.GetRemoteUser(setupInfo), ide.Options, log).Install()
+	case string(config2.IDEJupyterDesktop):
+		return jupyter.NewJupyterNotebookServer(setupInfo.SubstitutionContext.ContainerWorkspaceFolder, config.GetRemoteUser(setupInfo), ide.Options, log).Install()
 	}
 
 	return nil

cmd/up.go

@@ -354,6 +354,18 @@ func (cmd *UpCmd) Run(
 				cmd.GitToken,
 				log,
 			)
+		case string(config.IDEJupyterDesktop):
+			return startJupyterDesktop(
+				cmd.GPGAgentForwarding,
+				ctx,
+				devPodConfig,
+				client,
+				user,
+				ideConfig.Options,
+				cmd.GitUsername,
+				cmd.GitToken,
+				log,
+			)
 		}
 	}
 
@@ -630,6 +642,61 @@ func startJupyterNotebookInBrowser(
 	)
 }
 
+func startJupyterDesktop(
+	forwardGpg bool,
+	ctx context.Context,
+	devPodConfig *config.Config,
+	client client2.BaseWorkspaceClient,
+	user string,
+	ideOptions map[string]config.OptionValue,
+	gitUsername, gitToken string,
+	logger log.Logger,
+) error {
+	if forwardGpg {
+		err := performGpgForwarding(client, logger)
+		if err != nil {
+			return err
+		}
+	}
+
+	// determine port
+	jupyterAddress, jupyterPort, err := parseAddressAndPort(
+		jupyter.Options.GetValue(ideOptions, jupyter.BindAddressOption),
+		jupyter.DefaultServerPort,
+	)
+	if err != nil {
+		return err
+	}
+
+	// wait until reachable then open browser
+	targetURL := fmt.Sprintf("http://localhost:%d/lab", jupyterPort)
+	if jupyter.Options.GetValue(ideOptions, jupyter.OpenOption) == "true" {
+		go func() {
+			err = open2.JLabDesktop(ctx, targetURL, logger)
+			if err != nil {
+				logger.Errorf("error opening jupyter desktop: %v", err)
+			}
+			logger.Infof("Successfully started jupyter desktop")
+		}()
+	}
+
+	// start in browser
+	logger.Infof("Starting jupyter desktop using server %s", targetURL)
+	extraPorts := []string{fmt.Sprintf("%s:%d", jupyterAddress, jupyter.DefaultServerPort)}
+	return startBrowserTunnel(
+		ctx,
+		devPodConfig,
+		client,
+		user,
+		targetURL,
+		false,
+		extraPorts,
+		gitUsername,
+		gitToken,
+		logger,
+	)
+}
+
 func startFleet(ctx context.Context, client client2.BaseWorkspaceClient, logger log.Logger) error {
 	// create ssh command
 	stdout := &bytes.Buffer{}

pkg/config/ide.go

@@ -18,6 +18,7 @@ const (
 	IDEWebStorm        IDE = "webstorm"
 	IDEFleet           IDE = "fleet"
 	IDEJupyterNotebook IDE = "jupyternotebook"
+	IDEJupyterDesktop  IDE = "jupyterdesktop"
 	IDECursor          IDE = "cursor"
 	IDEPositron        IDE = "positron"
 )

pkg/ide/ideparse/parse.go

@@ -122,6 +122,14 @@ var AllowedIDEs = []AllowedIDE{
 		IconDark:     "https://devpod.sh/assets/jupyter_dark.svg",
 		Experimental: true,
 	},
+	{
+		Name:         config.IDEJupyterDesktop,
+		DisplayName:  "Jupyter Desktop",
+		Options:      jupyter.Options,
+		Icon:         "https://devpod.sh/assets/jupyter.svg",
+		IconDark:     "https://devpod.sh/assets/jupyter_dark.svg",
+		Experimental: true,
+	},
 	{
 		Name:         config.IDEVSCodeInsiders,
 		DisplayName:  "VSCode Insiders",

pkg/open/open.go

@@ -4,28 +4,49 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"os/exec"
 	"time"
 
 	devpodhttp "github.com/loft-sh/devpod/pkg/http"
 	"github.com/loft-sh/log"
 	"github.com/skratchdot/open-golang/open"
 )
 
+// Open opens the given url in the default application, retrying every second until the context is done
 func Open(ctx context.Context, url string, log log.Logger) error {
 	for {
 		select {
 		case <-ctx.Done():
 			return nil
 		case <-time.After(time.Second):
-			err := tryOpen(ctx, url, log)
+			err := tryOpen(ctx, url, open.Start, log)
 			if err == nil {
 				return nil
 			}
 		}
 	}
 }
 
-func tryOpen(ctx context.Context, url string, log log.Logger) error {
+// JLabDesktop opens the given url in the JLab desktop application, retrying every second until the context is done
+func JLabDesktop(ctx context.Context, url string, log log.Logger) error {
+	for {
+		select {
+		case <-ctx.Done():
+			return nil
+		case <-time.After(time.Second):
+			err := tryOpen(ctx, url, jlabOpen, log)
+			if err == nil {
+				return nil
+			}
+		}
+	}
+}
+
+func jlabOpen(url string) error {
+	return exec.Command("jlab", url).Run()
+}
+
+func tryOpen(ctx context.Context, url string, fn func(string) error, log log.Logger) error {
 	timeoutCtx, cancel := context.WithTimeout(ctx, time.Second)
 	defer cancel()
 
@@ -48,7 +69,7 @@ func tryOpen(ctx context.Context, url string, log log.Logger) error {
 				return nil
 			case <-time.After(time.Second):
 			}
-			_ = open.Start(url)
+			_ = fn(url)
 			log.Donef("Successfully opened %s", url)
 			return nil
 		}