enable client side "defang deployment list --active" (#1112)

* init

* update naming

* clean up

* merge

* in progress

* update vendor hash

* re-order listing

* add region to output of deployment list

* update list active deployments output to match regular list deployements

* Update src/pkg/cli/deploymentsList.go

Co-authored-by: Copilot <[email protected]>

* update from review. allow users to set the number of returned items, make active deployments the default, allow users to see active deployments for a single project

* update for limit = 0 to mean unlimited

* update limit type to uint32

* Apply suggestions from code review

Co-authored-by: Lio李歐 <[email protected]>

* review update: use deploymentsList rather than it's own active function. historical list and active lists will contain the same columns.

* update go.mod and go.sum

* Apply suggestions from code review

Co-authored-by: Lio李歐 <[email protected]>

* review updates

* update vendor hash

* update to add a --all flag

* review updates regarding flags

* review updates

* sort on proj, prov, acc, region

* fix tests

* Update src/cmd/cli/command/commands.go short desc

* Revert "Update src/cmd/cli/command/commands.go short desc"

This reverts commit a063e75.

* Update short description per comments

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: Lio李歐 <[email protected]>
Co-authored-by: Lionello Lunesu <[email protected]>

Author: 3 people

src/cmd/cli/command/commands.go

@@ -991,15 +991,9 @@ var deploymentsCmd = &cobra.Command{
 	Aliases:     []string{"deployment", "deploys", "deps", "dep"},
 	Annotations: authNeededAnnotation,
 	Args:        cobra.NoArgs,
-	Short:       "List deployments",
+	Short:       "List active deployments across all projects",
 	RunE: func(cmd *cobra.Command, args []string) error {
-		loader := configureLoader(cmd)
-		projectName, err := loader.LoadProjectName(cmd.Context())
-		if err != nil {
-			return err
-		}
-
-		return cli.DeploymentsList(cmd.Context(), projectName, client)
+		return cli.DeploymentsList(cmd.Context(), defangv1.DeploymentType_DEPLOYMENT_TYPE_ACTIVE, "", *client, 0)
 	},
 }
 
@@ -1008,16 +1002,15 @@ var deploymentsListCmd = &cobra.Command{
 	Aliases:     []string{"ls"},
 	Annotations: authNeededAnnotation,
 	Args:        cobra.NoArgs,
-	Short:       "List deployments",
-	Deprecated:  "use 'deployments' instead",
+	Short:       "List deployment history for a project",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		loader := configureLoader(cmd)
 		projectName, err := loader.LoadProjectName(cmd.Context())
 		if err != nil {
 			return err
 		}
 
-		return cli.DeploymentsList(cmd.Context(), projectName, client)
+		return cli.DeploymentsList(cmd.Context(), defangv1.DeploymentType_DEPLOYMENT_TYPE_HISTORY, projectName, *client, 10)
 	},
 }
 

src/pkg/cli/activeDeployments_test.go

@@ -0,0 +1,96 @@
+package cli
+
+import (
+	"context"
+	"net/http/httptest"
+	"strings"
+	"testing"
+
+	"github.com/DefangLabs/defang/src/pkg/term"
+	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
+	"github.com/DefangLabs/defang/src/protos/io/defang/v1/defangv1connect"
+	connect "github.com/bufbuild/connect-go"
+)
+
+var emptyDeployments []*defangv1.Deployment
+var activeDeployments = []*defangv1.Deployment{
+	{Project: "projectAA", Provider: defangv1.Provider_AWS, Region: "us-east-1"},
+	{Project: "projectAB", Provider: defangv1.Provider_AWS, Region: "us-east-2"},
+	{Project: "projectAC", Provider: defangv1.Provider_AWS, Region: "us-east-3"},
+
+	{Project: "projectDA", Provider: defangv1.Provider_DIGITALOCEAN, Region: "us-central-1"},
+	{Project: "projectDB", Provider: defangv1.Provider_DIGITALOCEAN, Region: "us-central-1"},
+
+	{Project: "projectGA", Provider: defangv1.Provider_GCP, Region: "us-central-2"},
+	{Project: "projectGB", Provider: defangv1.Provider_GCP, Region: "us-central-3"},
+
+	{Project: "projectPlayground", Provider: defangv1.Provider_DEFANG, Region: "us-west-1"},
+}
+
+type mockActiveDeploymentsHandler struct {
+	defangv1connect.UnimplementedFabricControllerHandler
+	testDeploymentsData []*defangv1.Deployment
+}
+
+func (g *mockActiveDeploymentsHandler) ListDeployments(ctx context.Context, req *connect.Request[defangv1.ListDeploymentsRequest]) (*connect.Response[defangv1.ListDeploymentsResponse], error) {
+	return connect.NewResponse(&defangv1.ListDeploymentsResponse{
+		Deployments: g.testDeploymentsData,
+	}), nil
+}
+
+func TestActiveDeployments(t *testing.T) {
+	ctx := context.Background()
+
+	fabricServer := &mockActiveDeploymentsHandler{}
+	_, handler := defangv1connect.NewFabricControllerHandler(fabricServer)
+	server := httptest.NewServer(handler)
+	t.Cleanup(server.Close)
+
+	url := strings.TrimPrefix(server.URL, "http://")
+	grpcClient, _ := Connect(ctx, url)
+
+	t.Run("no active deployments", func(t *testing.T) {
+		fabricServer.testDeploymentsData = emptyDeployments
+		stdout, _ := term.SetupTestTerm(t)
+
+		err := DeploymentsList(ctx, defangv1.DeploymentType_DEPLOYMENT_TYPE_ACTIVE, "", *grpcClient, 10)
+		if err != nil {
+			t.Fatalf("DeploymentsList() error = %v", err)
+		}
+
+		receivedOutput := stdout.String()
+		expectedOutput := "No deployments found"
+
+		if !strings.Contains(receivedOutput, expectedOutput) {
+			t.Errorf("Expected %s to contain %s", receivedOutput, expectedOutput)
+		}
+	})
+
+	t.Run("some active deployments", func(t *testing.T) {
+		fabricServer.testDeploymentsData = activeDeployments
+
+		stdout, _ := term.SetupTestTerm(t)
+		err := DeploymentsList(ctx, defangv1.DeploymentType_DEPLOYMENT_TYPE_ACTIVE, "", *grpcClient, 10)
+		if err != nil {
+			t.Fatalf("DeploymentsList() error = %v", err)
+		}
+
+		lines := strings.Split(stdout.String(), "\n")[2:] // Skip first two lines (space and header)
+
+		// Verify each provider and project name exists in the output
+		for _, deployment := range activeDeployments {
+			match := false
+			for _, line := range lines {
+				if strings.Contains(line, strings.ToLower(deployment.Provider.String())) &&
+					strings.Contains(line, deployment.Project) &&
+					strings.Contains(line, deployment.Region) {
+					match = true
+					break
+				}
+			}
+			if !match {
+				t.Errorf("Missing expected output for provider %q and project %q", deployment.Provider.String(), deployment.Project)
+			}
+		}
+	})
+}

src/pkg/cli/deploymentsList.go

@@ -2,6 +2,8 @@ package cli
 
 import (
 	"context"
+	"sort"
+	"strings"
 	"time"
 
 	"github.com/DefangLabs/defang/src/pkg/cli/client"
@@ -10,37 +12,64 @@ import (
 )
 
 type PrintDeployment struct {
-	Deployment string
-	Provider   string
-	DeployedAt string
-	Region     string
+	AccountId   string
+	Deployment  string
+	DeployedAt  string
+	ProjectName string
+	Provider    string
+	Region      string
 }
 
-func DeploymentsList(ctx context.Context, projectName string, client client.FabricClient) error {
+func DeploymentsList(ctx context.Context, listType defangv1.DeploymentType, projectName string, client client.GrpcClient, limit uint32) error {
 	response, err := client.ListDeployments(ctx, &defangv1.ListDeploymentsRequest{
-		Type:    defangv1.DeploymentType_DEPLOYMENT_TYPE_HISTORY,
+		Type:    listType,
 		Project: projectName,
+		Limit:   limit,
 	})
 	if err != nil {
 		return err
 	}
 
 	numDeployments := len(response.Deployments)
 	if numDeployments == 0 {
-		_, err := term.Warnf("No deployments found for project %q", projectName)
+		var err error
+		if projectName == "" {
+			_, err = term.Warn("No deployments found")
+		} else {
+			_, err = term.Warnf("No deployments found for project %q", projectName)
+		}
 		return err
 	}
 
 	// map to Deployment struct
 	deployments := make([]PrintDeployment, numDeployments)
 	for i, d := range response.Deployments {
 		deployments[i] = PrintDeployment{
-			Deployment: d.Id,
-			Provider:   d.ProviderString, // TODO: use Provider
-			DeployedAt: d.Timestamp.AsTime().Format(time.RFC3339),
-			Region:     d.Region,
+			AccountId:   d.ProviderAccountId,
+			DeployedAt:  d.Timestamp.AsTime().Format(time.RFC3339),
+			Deployment:  d.Id,
+			ProjectName: d.Project,
+			Provider:    getProvider(d.Provider, d.ProviderString),
+			Region:      d.Region,
 		}
 	}
 
-	return term.Table(deployments, []string{"Deployment", "Provider", "DeployedAt"}) // TODO: add region
+	// sort by project name, provider, account id, and region
+	sortKeys := make([]string, numDeployments)
+	for i, d := range deployments {
+		// TODO: allow user to specify sort order
+		sortKeys[i] = strings.Join([]string{d.ProjectName, d.Provider, d.AccountId, d.Region}, "|")
+	}
+	sort.SliceStable(sortKeys, func(i, j int) bool {
+		return sortKeys[i] < sortKeys[j]
+	})
+
+	return term.Table(deployments, []string{"ProjectName", "Provider", "AccountId", "Region", "Deployment", "DeployedAt"})
+}
+
+func getProvider(provider defangv1.Provider, providerString string) string {
+	if provider == defangv1.Provider_PROVIDER_UNSPECIFIED {
+		return providerString
+	}
+	return strings.ToLower(provider.String())
 }

src/pkg/cli/deploymentsList_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/DefangLabs/defang/src/pkg/term"
 	defangv1 "github.com/DefangLabs/defang/src/protos/io/defang/v1"
 	"github.com/DefangLabs/defang/src/protos/io/defang/v1/defangv1connect"
-	"github.com/bufbuild/connect-go"
+	connect "github.com/bufbuild/connect-go"
 	"google.golang.org/protobuf/types/known/emptypb"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
@@ -59,7 +59,7 @@ func TestDeploymentsList(t *testing.T) {
 
 	t.Run("no deployments", func(t *testing.T) {
 		stdout, _ := term.SetupTestTerm(t)
-		err := DeploymentsList(ctx, "empty", grpcClient)
+		err := DeploymentsList(ctx, defangv1.DeploymentType_DEPLOYMENT_TYPE_HISTORY, "empty", *grpcClient, 10)
 		if err != nil {
 			t.Fatalf("DeploymentsList() error = %v", err)
 		}
@@ -74,12 +74,12 @@ func TestDeploymentsList(t *testing.T) {
 
 	t.Run("some deployments", func(t *testing.T) {
 		stdout, _ := term.SetupTestTerm(t)
-		err := DeploymentsList(ctx, "test", grpcClient)
+		err := DeploymentsList(ctx, defangv1.DeploymentType_DEPLOYMENT_TYPE_HISTORY, "test", *grpcClient, 10)
 		if err != nil {
 			t.Fatalf("DeploymentsList() error = %v", err)
 		}
-		expectedOutput := "\x1b[1m\nDeployment  Provider    DeployedAt            \x1b[0m" + `
-a1b2c3      playground  ` + timestamppb.Now().AsTime().Format("2006-01-02T15:04:05Z07:00") + `
+		expectedOutput := "\x1b[1m\nProjectName  Provider  AccountId   Region     Deployment  DeployedAt            \x1b[0m" + `
+test         defang    1234567890  us-test-2  a1b2c3      ` + timestamppb.Now().AsTime().Format("2006-01-02T15:04:05Z07:00") + `
 `
 
 		receivedLines := strings.Split(stdout.String(), "\n")