ports-protocol.go

// 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.

package cmd

import (
	"context"
	"fmt"
	"strconv"
	"strings"
	"time"

	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/gitpod"
	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/supervisor"
	"github.com/gitpod-io/gitpod/gitpod-cli/pkg/utils"
	serverapi "github.com/gitpod-io/gitpod/gitpod-protocol"
	"github.com/gitpod-io/gitpod/supervisor/api"
	"github.com/spf13/cobra"
	"golang.org/x/xerrors"
)

// portsProtocolCmd change protocol of port
var portsProtocolCmd = &cobra.Command{
	Use:   "protocol <port:{http|https}>",
	Short: "Set port protocol",
	Args:  cobra.ExactArgs(1),
	RunE: func(cmd *cobra.Command, args []string) error {
		// TODO: we can add protocol for analysis later.
		portProtocol := args[0]
		s := strings.Split(portProtocol, ":")
		if len(s) != 2 {
			return GpError{Err: xerrors.Errorf("cannot parse args, should be something like `3000:http` or `3000:https`"), OutCome: utils.Outcome_UserErr, ErrorCode: utils.UserErrorCode_InvalidArguments}
		}
		port, err := strconv.Atoi(s[0])
		if err != nil {
			return GpError{Err: xerrors.Errorf("port should be integer"), OutCome: utils.Outcome_UserErr, ErrorCode: utils.UserErrorCode_InvalidArguments}
		}
		protocol := s[1]
		if protocol != serverapi.PortProtocolHTTP && protocol != serverapi.PortProtocolHTTPS {
			return GpError{Err: xerrors.Errorf("protocol should be `%s` or `%s`", serverapi.PortProtocolHTTP, serverapi.PortProtocolHTTPS), OutCome: utils.Outcome_UserErr, ErrorCode: utils.UserErrorCode_InvalidArguments}
		}
		ctx, cancel := context.WithTimeout(cmd.Context(), 5*time.Second)
		defer cancel()

		supervisorClient, err := supervisor.New(ctx)
		if err != nil {
			return err
		}
		defer supervisorClient.Close()

		ports, err := supervisorClient.GetPortsList(ctx)
		if err != nil {
			return err
		}
		var prePortStatus *api.PortsStatus
		for _, p := range ports {
			if p.LocalPort == uint32(port) {
				prePortStatus = p
				break
			}
		}
		wsInfo, err := gitpod.GetWSInfo(ctx)
		if err != nil {
			return xerrors.Errorf("cannot get workspace info, %w", err)
		}
		client, err := gitpod.ConnectToServer(ctx, wsInfo, []string{
			"function:openPort",
			"resource:workspace::" + wsInfo.WorkspaceId + "::get/update",
		})
		if err != nil {
			return xerrors.Errorf("cannot connect to server, %w", err)
		}
		defer client.Close()
		params := &serverapi.WorkspaceInstancePort{
			Port:     float64(port),
			Protocol: protocol,
		}
		if prePortStatus != nil && prePortStatus.Exposed != nil {
			params.Visibility = prePortStatus.Exposed.Visibility.String()
		}

		if _, err := client.OpenPort(ctx, wsInfo.WorkspaceId, params); err != nil {
			return xerrors.Errorf("failed to change port protocol: %w", err)
		}
		fmt.Printf("port %v is now %s\n", port, protocol)
		return nil
	},
}

func init() {
	portsCmd.AddCommand(portsProtocolCmd)
}