[gpctl] Switch "gpctl api ws ls/get" to use v1/v1connect

Author: geropl

dev/gpctl/cmd/public-api-workspace.go

@@ -9,8 +9,9 @@ import (
 )
 
 var publicApiWorkspacesCmd = &cobra.Command{
-	Use:   "workspaces",
-	Short: "Interact with workspaces through the public-API",
+	Use:     "workspaces",
+	Aliases: []string{"ws"},
+	Short:   "Interact with workspaces through the public-API",
 }
 
 func init() {

dev/gpctl/cmd/public-api-workspaces-get.go

@@ -6,7 +6,8 @@ package cmd
 
 import (
 	"github.com/gitpod-io/gitpod/common-go/log"
-	v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
+	v1 "github.com/gitpod-io/gitpod/components/public-api/go/v1"
+	v1connect "github.com/gitpod-io/gitpod/components/public-api/go/v1/v1connect"
 	"github.com/spf13/cobra"
 )
 
@@ -17,25 +18,26 @@ var publicApiWorkspacesGetCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		workspaceID := args[0]
 
-		conn, err := newPublicAPIConn()
+		httpClient, address, opts, err := newConnectHttpClient()
 		if err != nil {
 			log.Log.WithError(err).Fatal()
 		}
 
-		service := v1.NewWorkspacesServiceClient(conn)
+		service := v1connect.NewWorkspaceServiceClient(httpClient, address, opts...)
 
 		log.Log.Debugf("Retrieving workspace ID: %s", workspaceID)
-		resp, err := service.GetWorkspace(cmd.Context(), &v1.GetWorkspaceRequest{WorkspaceId: workspaceID})
+		cResp, err := service.GetWorkspace(cmd.Context(), wrapReq(&v1.GetWorkspaceRequest{WorkspaceId: workspaceID}))
 		if err != nil {
 			log.WithError(err).Fatalf("failed to retrieve workspace (ID: %s)", workspaceID)
 			return
 		}
+		resp := cResp.Msg
 
-		tpl := `ID:	{{ .Result.WorkspaceId }}
-Owner:	{{ .Result.OwnerId }}
-ContextURL:	{{ .Result.Context.ContextUrl }}
-InstanceID:	{{ .Result.Status.Instance.InstanceId }}
-InstanceStatus:	{{ .Result.Status.Instance.Status.Phase }}
+		tpl := `ID:	{{ .Workspace.Id }}
+OrganizationID:	{{ .Workspace.OrganizationId }}
+ContextURL:	{{ .Workspace.ContextUrl }}
+InstanceID:	{{ .Workspace.Status.InstanceId }}
+InstanceStatus:	{{ .Workspace.Status.Phase.Name }}
 `
 		err = getOutputFormat(tpl, "{..result.workspace_id}").Print(resp)
 		if err != nil {

dev/gpctl/cmd/public-api-workspaces-list.go

@@ -6,30 +6,36 @@ package cmd
 
 import (
 	"github.com/gitpod-io/gitpod/common-go/log"
-	v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
+	v1 "github.com/gitpod-io/gitpod/components/public-api/go/v1"
+	v1connect "github.com/gitpod-io/gitpod/components/public-api/go/v1/v1connect"
 	"github.com/spf13/cobra"
 )
 
 var publicApiWorkspacesListCmd = &cobra.Command{
-	Use:   "list",
-	Short: "List your workspaces",
+	Use:     "list",
+	Aliases: []string{"ls"},
+	Short:   "List your workspaces",
+	Args:    cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		conn, err := newPublicAPIConn()
+		organizationID := args[0]
+
+		httpClient, address, opts, err := newConnectHttpClient()
 		if err != nil {
 			log.Log.WithError(err).Fatal()
 		}
 
-		service := v1.NewWorkspacesServiceClient(conn)
+		service := v1connect.NewWorkspaceServiceClient(httpClient, address, opts...)
 
-		resp, err := service.ListWorkspaces(cmd.Context(), &v1.ListWorkspacesRequest{})
+		cResp, err := service.ListWorkspaces(cmd.Context(), wrapReq(&v1.ListWorkspacesRequest{OrganizationId: organizationID}))
 		if err != nil {
 			log.WithError(err).Fatal("failed to retrieve workspace list")
 			return
 		}
+		resp := cResp.Msg
 
-		tpl := `ID	Owner	ContextURL	InstanceID	InstanceStatus
-{{- range .Result }}
-{{ .WorkspaceId }}	{{ .OwnerId }}	{{ .Context.ContextUrl }}	{{ .Status.Instance.InstanceId}}	{{ .Status.Instance.Status.Phase}}
+		tpl := `ID	OrganizationID	ContextURL	InstanceID	InstanceStatus
+{{- range .Workspaces }}
+{{ .Id }}	{{ .OrganizationId }}	{{ .ContextUrl }}	{{ .Status.InstanceId }}	{{ .Status.Phase.Name }}
 {{ end }}
 `
 		err = getOutputFormat(tpl, "{..id}").Print(resp)

dev/gpctl/cmd/public-api.go

@@ -8,8 +8,11 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
+	"net/http"
 	"os"
+	"strings"
 
+	connect "github.com/bufbuild/connect-go"
 	"github.com/gitpod-io/gitpod/common-go/log"
 	"github.com/spf13/cobra"
 	"google.golang.org/grpc"
@@ -69,3 +72,36 @@ func newPublicAPIConn() (*grpc.ClientConn, error) {
 
 	return conn, nil
 }
+
+type connectHttpTransport struct {
+	token string
+}
+
+func (t *connectHttpTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	req.URL.Path = "/public-api" + req.URL.Path
+	req.Header.Add("authorization", fmt.Sprintf("Bearer %s", t.token))
+	return http.DefaultTransport.RoundTrip(req)
+}
+
+func newConnectHttpClient() (client connect.HTTPClient, address string, opts []connect.ClientOption, err error) {
+	if publicApiCmdOpts.address == "" {
+		return nil, "", nil, fmt.Errorf("empty connection address")
+	}
+	address = publicApiCmdOpts.address
+	if !strings.Contains(publicApiCmdOpts.address, "://") {
+		address = "https://" + address
+	}
+
+	if publicApiCmdOpts.token == "" {
+		return nil, "", nil, fmt.Errorf("empty connection token. Use --token or GPCTL_PUBLICAPI_TOKEN to provide one.")
+	}
+	opts = []connect.ClientOption{
+		connect.WithProtoJSON(),
+	}
+	client = &http.Client{Transport: &connectHttpTransport{token: publicApiCmdOpts.token}}
+	return client, address, opts, nil
+}
+
+func wrapReq[T any](req *T) *connect.Request[T] {
+	return &connect.Request[T]{Msg: req}
+}

dev/gpctl/go.mod

@@ -27,6 +27,8 @@ require (
 	k8s.io/client-go v0.27.3
 )
 
+require github.com/bufbuild/connect-go v1.10.0
+
 require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.1.3 // indirect