[supervisor] active client notifications

Author: akosyakov

WORKSPACE.yaml

@@ -7,8 +7,8 @@ defaultArgs:
   publishToNPM: true
   publishToJBMarketplace: true
   localAppVersion: unknown
-  codeCommit: 192057dab1df3cbfc64e83719306de0727a644e0
-  codeVersion: 1.74.3
+  codeCommit: 704aa0e3f54ba6b64dc1b443b4b61a5a717a38e9
+  codeVersion: 1.75.0
   codeQuality: stable
   noVerifyJBPlugin: false
   intellijDownloadUrl: "https://download.jetbrains.com/idea/ideaIU-2022.3.1.tar.gz"

components/gitpod-cli/.gitignore

@@ -0,0 +1 @@
+gitpod-cli

components/gitpod-cli/cmd/docs.go

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

components/gitpod-cli/cmd/open.go

@@ -5,12 +5,13 @@
 package cmd
 
 import (
-	"context"
 	"log"
 	"os"
 	"os/exec"
+	"path/filepath"
 
 	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
+	"github.com/gitpod-io/gitpod/supervisor/api"
 
 	"github.com/google/shlex"
 	"github.com/spf13/cobra"
@@ -23,25 +24,41 @@ var openCmd = &cobra.Command{
 	Short: "Opens a file in Gitpod",
 	Args:  cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		// TODO(ak) use NotificationService.NotifyActive supervisor API instead
-
-		ctx := context.Background()
-
+		ctx := cmd.Context()
 		client, err := supervisor.New(ctx)
 		if err != nil {
 			log.Fatal(err)
 		}
 		defer client.Close()
-
 		client.WaitForIDEReady(ctx)
 
 		wait, _ := cmd.Flags().GetBool("wait")
 
 		pcmd := os.Getenv("GP_OPEN_EDITOR")
 		if pcmd == "" {
-			log.Fatal("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 {
+				log.Fatal(err)
+			}
 			return
 		}
+		// TODO: backward compatibilty, remove when all IDEs are updated
 		pargs, err := shlex.Split(pcmd)
 		if err != nil {
 			log.Fatalf("cannot parse GP_OPEN_EDITOR: %v", err)

components/gitpod-cli/cmd/preview.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 
 	"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/sys/unix"
@@ -31,31 +32,42 @@ var previewCmd = &cobra.Command{
 	Short: "Opens a URL in the IDE's preview",
 	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		// TODO(ak) use NotificationService.NotifyActive supervisor API instead
-
-		ctx := context.Background()
-
-		client, err := supervisor.New(ctx)
-		if err != nil {
-			log.Fatal(err)
-		}
-		defer client.Close()
-		client.WaitForIDEReady(ctx)
-
-		url := replaceLocalhostInURL(args[0])
-		if previewCmdOpts.External {
-			if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
-				url = "https://" + url
-			}
-			openPreview("GP_EXTERNAL_BROWSER", url)
-			return
-		}
-		openPreview("GP_PREVIEW_BROWSER", url)
+		openPreview(cmd.Context(), args[0], previewCmdOpts.External)
 	},
 }
 
-func openPreview(gpBrowserEnvVar string, url string) {
+func openPreview(ctx context.Context, url string, external bool) {
+	client, err := supervisor.New(ctx)
+	if err != nil {
+		log.Fatal(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,
+				},
+			},
+		})
+		if err != nil && ctx.Err() == nil {
+			log.Fatal(err)
+		}
+		return
+	}
+	// TODO: backward compatibilty, remove when all IDEs are updated
 	if pcmd == "" {
 		log.Fatalf("%s is not set", gpBrowserEnvVar)
 		return

components/gitpod-cli/hot-swap.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+# 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.
+
+set -Eeuo pipefail
+
+component=${PWD##*/}
+workspaceUrl=$(echo "${1}" |sed -e "s/\/$//")
+echo "URL: $workspaceUrl"
+
+workspaceDesc=$(gpctl workspaces describe "$workspaceUrl" -o=json)
+
+podName=$(echo "$workspaceDesc" | jq .runtime.pod_name -r)
+echo "Pod: $podName"
+
+workspaceId=$(echo "$workspaceDesc" | jq .metadata.meta_id -r)
+echo "ID: $workspaceId"
+
+clusterHost=$(kubectl exec -it "$podName" -- printenv GITPOD_WORKSPACE_CLUSTER_HOST |sed -e "s/\s//g")
+echo "Cluster Host: $clusterHost"
+
+# prepare ssh
+ownerToken=$(kubectl get pod "$podName" -o=json | jq ".metadata.annotations.\"gitpod\/ownerToken\"" -r)
+sshConfig=$(mktemp)
+echo "Host $workspaceId" > "$sshConfig"
+echo "    Hostname \"$workspaceId.ssh.$clusterHost\"" >> "$sshConfig"
+echo "    User \"$workspaceId#$ownerToken\"" >> "$sshConfig"
+
+# build
+go build .
+echo "$component built"
+
+# upload
+uploadDest="/.supervisor/$component"
+echo "Upload Dest: $uploadDest"
+ssh -F "$sshConfig" "$workspaceId" "sudo chown -R gitpod:gitpod /.supervisor && rm $uploadDest 2> /dev/null"
+echo "Permissions granted"
+scp -F "$sshConfig" -r "./$component" "$workspaceId":"$uploadDest"
+echo "Swap complete"

components/gitpod-cli/pkg/supervisor/client.go

@@ -21,9 +21,10 @@ type SupervisorClient struct {
 	conn      *grpc.ClientConn
 	closeOnce sync.Once
 
-	Status   api.StatusServiceClient
-	Terminal api.TerminalServiceClient
-	Info     api.InfoServiceClient
+	Status       api.StatusServiceClient
+	Terminal     api.TerminalServiceClient
+	Info         api.InfoServiceClient
+	Notification api.NotificationServiceClient
 }
 
 type SupervisorClientOption struct {
@@ -43,10 +44,11 @@ func New(ctx context.Context, options ...*SupervisorClientOption) (*SupervisorCl
 	}
 
 	return &SupervisorClient{
-		conn:     conn,
-		Status:   api.NewStatusServiceClient(conn),
-		Terminal: api.NewTerminalServiceClient(conn),
-		Info:     api.NewInfoServiceClient(conn),
+		conn:         conn,
+		Status:       api.NewStatusServiceClient(conn),
+		Terminal:     api.NewTerminalServiceClient(conn),
+		Info:         api.NewInfoServiceClient(conn),
+		Notification: api.NewNotificationServiceClient(conn),
 	}, nil
 }
 

components/ide/code/leeway.Dockerfile

@@ -99,16 +99,9 @@ COPY --from=code_builder --chown=33333:33333 /vscode-web/ /ide/
 COPY --from=code_builder --chown=33333:33333 /vscode-reh-linux-x64/ /ide/
 COPY --chown=33333:33333 supervisor-ide-config.json components-ide-code-codehelper--app/codehelper /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