[supervisor] active client notifications

Author: akosyakov

components/gitpod-cli/cmd/docs.go

@@ -15,7 +15,7 @@ var docsCmd = &cobra.Command{
 	Use:   "docs",
 	Short: "Open Gitpod Documentation in default browser",
 	RunE: func(cmd *cobra.Command, args []string) error {
-		return openPreview("GP_EXTERNAL_BROWSER", DocsUrl)
+		return openPreview(cmd.Context(), DocsUrl, true)
 	},
 }
 

components/gitpod-cli/cmd/open.go

@@ -7,11 +7,10 @@ package cmd
 import (
 	"os"
 	"os/exec"
-	"time"
+	"path/filepath"
 
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
-
-	"context"
+	"github.com/gitpod-io/gitpod/supervisor/api"
 
 	"github.com/google/shlex"
 	"github.com/spf13/cobra"
@@ -24,25 +23,42 @@ var openCmd = &cobra.Command{
 	Short: "Opens a file in Gitpod",
 	Args:  cobra.MinimumNArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		// TODO(ak) use NotificationService.NotifyActive supervisor API instead
-
-		ctx, cancel := context.WithTimeout(cmd.Context(), 5*time.Second)
-		defer cancel()
+		ctx := cmd.Context()
 
 		client, err := supervisor.New(ctx)
 		if err != nil {
 			return err
 		}
 		defer client.Close()
-
 		client.WaitForIDEReady(ctx)
 
 		wait, _ := cmd.Flags().GetBool("wait")
 
 		pcmd := os.Getenv("GP_OPEN_EDITOR")
 		if pcmd == "" {
-			return xerrors.Errorf("GP_OPEN_EDITOR is not set")
+			var paths []string
+			for _, path := range args {
+				absPath, err := filepath.Abs(path)
+				if err == nil {
+					path = absPath
+				}
+				paths = append(paths, path)
+			}
+
+			_, err := client.Notification.NotifyActive(ctx, &api.NotifyActiveRequest{
+				ActionData: &api.NotifyActiveRequest_Open{
+					Open: &api.NotifyActiveRequest_OpenData{
+						Paths: paths,
+						Await: wait,
+					},
+				},
+			})
+			if err != nil && ctx.Err() == nil {
+				return xerrors.Errorf("failed to open: %w", err)
+			}
+			return nil
 		}
+		// TODO: backward compatibilty, remove when all IDEs are updated
 		pargs, err := shlex.Split(pcmd)
 		if err != nil {
 			return xerrors.Errorf("cannot parse GP_OPEN_EDITOR: %w", err)

components/gitpod-cli/cmd/preview.go

@@ -11,9 +11,9 @@ import (
 	"regexp"
 	"strconv"
 	"strings"
-	"time"
 
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
+	"github.com/gitpod-io/gitpod/supervisor/api"
 	"github.com/google/shlex"
 	"github.com/spf13/cobra"
 	"golang.org/x/xerrors"
@@ -31,34 +31,39 @@ var previewCmd = &cobra.Command{
 	Short: "Opens a URL in the IDE's preview",
 	Args:  cobra.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		// TODO(ak) use NotificationService.NotifyActive supervisor API instead
-
-		ctx, cancel := context.WithTimeout(cmd.Context(), 5*time.Second)
-		defer cancel()
-		client, err := supervisor.New(ctx)
-		if err != nil {
-			return err
-		}
-		defer client.Close()
-
-		client.WaitForIDEReady(ctx)
-
-		gpBrowserEnvVar := "GP_PREVIEW_BROWSER"
-
-		url := replaceLocalhostInURL(args[0])
-		if previewCmdOpts.External {
-			if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
-				url = "https://" + url
-			}
-			gpBrowserEnvVar = "GP_EXTERNAL_BROWSER"
-		}
-
-		return openPreview(gpBrowserEnvVar, url)
+		return openPreview(cmd.Context(), args[0], previewCmdOpts.External)
 	},
 }
 
-func openPreview(gpBrowserEnvVar string, url string) error {
+func openPreview(ctx context.Context, url string, external bool) error {
+	client, err := supervisor.New(ctx)
+	if err != nil {
+		return err
+	}
+	defer client.Close()
+	client.WaitForIDEReady(ctx)
+
+	url = replaceLocalhostInURL(url)
+	gpBrowserEnvVar := "GP_PREVIEW_BROWSER"
+	if external {
+		gpBrowserEnvVar = "GP_EXTERNAL_BROWSER"
+		if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
+			url = "https://" + url
+		}
+	}
 	pcmd := os.Getenv(gpBrowserEnvVar)
+	if pcmd == "" {
+		_, err := client.Notification.NotifyActive(ctx, &api.NotifyActiveRequest{
+			ActionData: &api.NotifyActiveRequest_Preview{
+				Preview: &api.NotifyActiveRequest_PreviewData{
+					Url:      url,
+					External: external,
+				},
+			},
+		})
+		return err
+	}
+	// TODO: backward compatibilty, remove when all IDEs are updated
 	if pcmd == "" {
 		return xerrors.Errorf("%s is not set", gpBrowserEnvVar)
 	}

components/gitpod-cli/hot-swap.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+# Copyright (c) 2023 Gitpod GmbH. All rights reserved.
 # Licensed under the GNU Affero General Public License (AGPL).
 # See License.AGPL.txt in the project root for license information.
 

components/ide/code/leeway.Dockerfile

@@ -99,16 +99,9 @@ FROM scratch
 COPY --from=code_builder --chown=33333:33333 /vscode-web/ /ide/
 COPY --from=code_builder --chown=33333:33333 /vscode-reh-linux-x64/ /ide/
 
+# TODO(ak) get rid of it as well
 ENV GITPOD_ENV_APPEND_PATH=/ide/bin/remote-cli:
 
-# editor config
-ENV GITPOD_ENV_SET_EDITOR=/ide/bin/remote-cli/gitpod-code
-ENV GITPOD_ENV_SET_VISUAL="$GITPOD_ENV_SET_EDITOR"
-ENV GITPOD_ENV_SET_GP_OPEN_EDITOR="$GITPOD_ENV_SET_EDITOR"
-ENV GITPOD_ENV_SET_GIT_EDITOR="$GITPOD_ENV_SET_EDITOR --wait"
-ENV GITPOD_ENV_SET_GP_PREVIEW_BROWSER="/ide/bin/remote-cli/gitpod-code --preview"
-ENV GITPOD_ENV_SET_GP_EXTERNAL_BROWSER="/ide/bin/remote-cli/gitpod-code --openExternal"
-
 ARG CODE_VERSION
 ARG CODE_COMMIT
 LABEL "io.gitpod.ide.version"=$CODE_VERSION