feat(workflows): describe workflow by name (#756)

Signed-off-by: Jose I. Paris <[email protected]>

Author: jiparis

app/cli/cmd/workflow_describe.go

@@ -21,13 +21,13 @@ import (
 )
 
 func newWorkflowDescribeCmd() *cobra.Command {
-	var workflowID string
+	var workflowID, workflowName string
 
 	cmd := &cobra.Command{
 		Use:   "describe",
 		Short: "Describe an existing workflow",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			wf, err := action.NewWorkflowDescribe(actionOpts).Run(cmd.Context(), workflowID)
+			wf, err := action.NewWorkflowDescribe(actionOpts).Run(cmd.Context(), workflowID, workflowName)
 			if err != nil {
 				return err
 			}
@@ -37,8 +37,10 @@ func newWorkflowDescribeCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&workflowID, "id", "", "workflow id")
-	err := cmd.MarkFlagRequired("id")
-	cobra.CheckErr(err)
+	cmd.Flags().StringVar(&workflowName, "name", "", "workflow name")
+
+	cmd.MarkFlagsOneRequired("id", "name")
+	cmd.MarkFlagsMutuallyExclusive("id", "name")
 
 	return cmd
 }

app/cli/internal/action/workflow_describe.go

@@ -29,10 +29,14 @@ func NewWorkflowDescribe(cfg *ActionsOpts) *WorkflowDescribe {
 	return &WorkflowDescribe{cfg}
 }
 
-func (action *WorkflowDescribe) Run(ctx context.Context, workflowID string) (*WorkflowItem, error) {
+func (action *WorkflowDescribe) Run(ctx context.Context, workflowID, workflowName string) (*WorkflowItem, error) {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
 
-	resp, err := client.View(ctx, &pb.WorkflowServiceViewRequest{Id: workflowID})
+	req := &pb.WorkflowServiceViewRequest{Id: workflowID}
+	if workflowName != "" {
+		req.Name = workflowName
+	}
+	resp, err := client.View(ctx, req)
 	if err != nil {
 		return nil, err
 	}

app/controlplane/api/controlplane/v1/workflow.pb.go

@@ -72,7 +72,30 @@ message WorkflowServiceListResponse {
 }
 
 message WorkflowServiceViewRequest {
-  string id = 1 [(buf.validate.field).string.uuid = true];
+  string id = 1 [
+    deprecated = true,
+    (buf.validate.field) = {
+      string: {uuid: true},
+      ignore_empty: true,
+    }
+  ];
+
+  string name = 2 [
+    (buf.validate.field) = {
+      ignore_empty: true,
+      cel: {
+        message: "name must be a valid DNS-1123 subdomain",
+        expression: "this.matches('^[a-z0-9]([-a-z0-9]*[a-z0-9])?$')",
+        id: "name.dns-1123",
+      },
+    }
+  ];
+
+  option (buf.validate.message).cel = {
+    id: "either-name-or-id-required",
+    message: "either name or id are required",
+    expression: "has(this.id) || has(this.name)"
+  };
 }
 
 message WorkflowServiceViewResponse {

app/controlplane/api/controlplane/v1/workflow.proto

@@ -44,6 +44,7 @@ type WorkflowRepo interface {
 	Update(ctx context.Context, id uuid.UUID, opts *WorkflowUpdateOpts) (*Workflow, error)
 	List(ctx context.Context, orgID uuid.UUID) ([]*Workflow, error)
 	GetOrgScoped(ctx context.Context, orgID, workflowID uuid.UUID) (*Workflow, error)
+	GetOrgScopedByName(ctx context.Context, orgID uuid.UUID, workflowName string) (*Workflow, error)
 	IncRunsCounter(ctx context.Context, workflowID uuid.UUID) error
 	FindByID(ctx context.Context, workflowID uuid.UUID) (*Workflow, error)
 	SoftDelete(ctx context.Context, workflowID uuid.UUID) error
@@ -231,6 +232,24 @@ func (uc *WorkflowUseCase) FindByIDInOrg(ctx context.Context, orgID, workflowID
 	return wf, nil
 }
 
+func (uc *WorkflowUseCase) FindByNameInOrg(ctx context.Context, orgID, workflowName string) (*Workflow, error) {
+	orgUUID, err := uuid.Parse(orgID)
+	if err != nil {
+		return nil, NewErrInvalidUUID(err)
+	}
+
+	if workflowName == "" {
+		return nil, NewErrValidationStr("empty workflow name")
+	}
+
+	wf, err := uc.wfRepo.GetOrgScopedByName(ctx, orgUUID, workflowName)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get workflow: %w", err)
+	}
+
+	return wf, nil
+}
+
 // Delete soft-deletes the entry
 func (uc *WorkflowUseCase) Delete(ctx context.Context, orgID, workflowID string) error {
 	orgUUID, err := uuid.Parse(orgID)

app/controlplane/api/gen/frontend/controlplane/v1/workflow.ts

@@ -59,6 +59,28 @@ func (s *workflowIntegrationTestSuite) TestContractLatestAvailable() {
 	})
 }
 
+func (s *workflowIntegrationTestSuite) TestView() {
+	s.Run("finds by id in org", func() {
+		wf, err := s.Workflow.FindByIDInOrg(context.TODO(), s.org.ID, s.wf.ID.String())
+		s.NoError(err)
+		s.Equal(s.wf.ID, wf.ID)
+	})
+
+	s.Run("finds by name in org", func() {
+		wf, err := s.Workflow.FindByNameInOrg(context.TODO(), s.org.ID, s.wf.Name)
+		s.NoError(err)
+		s.Equal(s.wf.ID, wf.ID)
+	})
+
+	s.Run("fails if workflow belongs to a different org", func() {
+		org2, err := s.Organization.CreateWithRandomName(context.Background())
+		require.NoError(s.T(), err)
+
+		_, err = s.Workflow.FindByNameInOrg(context.TODO(), org2.ID, s.wf.Name)
+		s.Error(err)
+	})
+}
+
 func (s *workflowIntegrationTestSuite) TestCreateDuplicatedName() {
 	ctx := context.Background()
 
@@ -310,6 +332,7 @@ func TestWorkflowUseCase(t *testing.T) {
 type workflowIntegrationTestSuite struct {
 	testhelpers.UseCasesEachTestSuite
 	org *biz.Organization
+	wf  *biz.Workflow
 }
 
 func (s *workflowIntegrationTestSuite) SetupTest() {
@@ -320,6 +343,13 @@ func (s *workflowIntegrationTestSuite) SetupTest() {
 	ctx := context.Background()
 	s.org, err = s.Organization.CreateWithRandomName(ctx)
 	assert.NoError(err)
+
+	s.wf, err = s.Workflow.Create(ctx, &biz.WorkflowCreateOpts{
+		Name:    "my-workflow",
+		Project: "my-project",
+		OrgID:   s.org.ID,
+	})
+	assert.NoError(err)
 }
 
 func toPtrS(s string) *string {