feat(workflows): Remove the option of updating the workflow name (#921)

Signed-off-by: Javier Rodriguez <[email protected]>

Author: javirln

app/cli/cmd/workflow_update.go

@@ -23,17 +23,14 @@ import (
 )
 
 func newWorkflowUpdateCmd() *cobra.Command {
-	var workflowID, name, description, project, team, contractID string
+	var workflowID, description, project, team, contractID string
 	var public bool
 
 	cmd := &cobra.Command{
 		Use:   "update",
 		Short: "Update an existing workflow",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			opts := &action.NewWorkflowUpdateOpts{}
-			if cmd.Flags().Changed("name") {
-				opts.Name = &name
-			}
+			opts := &action.WorkflowUpdateOpts{}
 			if cmd.Flags().Changed("team") {
 				opts.Team = &team
 			}
@@ -66,7 +63,6 @@ func newWorkflowUpdateCmd() *cobra.Command {
 	err := cmd.MarkFlagRequired("id")
 	cobra.CheckErr(err)
 
-	cmd.Flags().StringVar(&name, "name", "", "workflow name")
 	cmd.Flags().StringVar(&description, "description", "", "workflow description")
 	cmd.Flags().StringVar(&team, "team", "", "team name")
 	cmd.Flags().StringVar(&project, "project", "", "project name")

app/cli/internal/action/workflow_update.go

@@ -29,19 +29,20 @@ func NewWorkflowUpdate(cfg *ActionsOpts) *WorkflowUpdate {
 	return &WorkflowUpdate{cfg}
 }
 
-type NewWorkflowUpdateOpts struct {
-	Name, Description, Project, Team, ContractID *string
-	Public                                       *bool
+type WorkflowUpdateOpts struct {
+	Description, Project, Team, ContractID *string
+	Public                                 *bool
 }
 
-func (action *WorkflowUpdate) Run(ctx context.Context, id string, opts *NewWorkflowUpdateOpts) (*WorkflowItem, error) {
+func (action *WorkflowUpdate) Run(ctx context.Context, id string, opts *WorkflowUpdateOpts) (*WorkflowItem, error) {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
 	resp, err := client.Update(ctx, &pb.WorkflowServiceUpdateRequest{
-		Id:   id,
-		Name: opts.Name, Description: opts.Description,
-		Project: opts.Project, Team: opts.Team,
-		Public:   opts.Public,
-		SchemaId: opts.ContractID,
+		Id:          id,
+		Description: opts.Description,
+		Project:     opts.Project,
+		Team:        opts.Team,
+		Public:      opts.Public,
+		SchemaId:    opts.ContractID,
 	})
 
 	if err != nil {

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

@@ -44,7 +44,6 @@ message WorkflowServiceUpdateRequest {
   string id = 1 [(buf.validate.field).string.uuid = true];
   // "optional" allow us to detect if the value is explicitly set
   // and not just the default value
-  optional string name = 2;
   optional string project = 3;
   optional string team = 4;
   optional bool public = 5;

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

@@ -59,8 +59,8 @@ type WorkflowCreateOpts struct {
 }
 
 type WorkflowUpdateOpts struct {
-	Name, Project, Team, Description, ContractID *string
-	Public                                       *bool
+	Project, Team, Description, ContractID *string
+	Public                                 *bool
 }
 
 type WorkflowUseCase struct {
@@ -125,13 +125,6 @@ func (uc *WorkflowUseCase) Update(ctx context.Context, orgID, workflowID string,
 		return nil, NewErrInvalidUUID(err)
 	}
 
-	if opts.Name != nil {
-		// validate format of the name and the project
-		if err := ValidateIsDNS1123(*opts.Name); err != nil {
-			return nil, NewErrValidation(err)
-		}
-	}
-
 	if opts.Project != nil && *opts.Project != "" {
 		if err := ValidateIsDNS1123(*opts.Project); err != nil {
 			return nil, NewErrValidation(err)

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

@@ -200,7 +200,7 @@ func (s *workflowIntegrationTestSuite) TestUpdate() {
 	})
 
 	s.Run("can't update a workflow in another org", func() {
-		got, err := s.Workflow.Update(ctx, org2.ID, workflow.ID.String(), &biz.WorkflowUpdateOpts{Name: toPtrS("new-name")})
+		got, err := s.Workflow.Update(ctx, org2.ID, workflow.ID.String(), &biz.WorkflowUpdateOpts{Description: toPtrS("new description")})
 		s.True(biz.IsNotFound(err))
 		s.Error(err)
 		s.Nil(got)
@@ -218,37 +218,26 @@ func (s *workflowIntegrationTestSuite) TestUpdate() {
 		{
 			name:    "non existing workflow",
 			id:      uuid.Generate().String(),
-			updates: &biz.WorkflowUpdateOpts{Name: toPtrS("new-name")},
+			updates: &biz.WorkflowUpdateOpts{Description: toPtrS("new description")},
 			wantErr: true,
 		},
 		{
 			name:    "invalid uuid",
 			id:      "deadbeef",
-			updates: &biz.WorkflowUpdateOpts{Name: toPtrS("new-name")},
+			updates: &biz.WorkflowUpdateOpts{Description: toPtrS("new description")},
 			wantErr: true,
 		},
 		{
 			name:       "no updates",
 			wantErr:    true,
 			wantErrMsg: "no updates provided",
 		},
-		{
-			name:       "invalid name",
-			wantErr:    true,
-			wantErrMsg: "RFC 1123",
-			updates:    &biz.WorkflowUpdateOpts{Name: toPtrS(" no no ")},
-		},
 		{
 			name:       "invalid Project",
 			wantErr:    true,
 			wantErrMsg: "RFC 1123",
 			updates:    &biz.WorkflowUpdateOpts{Project: toPtrS(" no no ")},
 		},
-		{
-			name:    "update name",
-			updates: &biz.WorkflowUpdateOpts{Name: toPtrS("new-name")},
-			want:    &biz.Workflow{Name: "new-name", Description: description, Team: team, Project: project, Public: false},
-		},
 		{
 			name:    "update description",
 			updates: &biz.WorkflowUpdateOpts{Description: toPtrS("new description")},
@@ -261,13 +250,8 @@ func (s *workflowIntegrationTestSuite) TestUpdate() {
 		},
 		{
 			name:    "update all options",
-			updates: &biz.WorkflowUpdateOpts{Name: toPtrS("new-name-2"), Project: toPtrS("new-project"), Team: toPtrS("new team"), Public: toPtrBool(true)},
-			want:    &biz.Workflow{Name: "new-name-2", Description: description, Team: "new team", Project: "new-project", Public: true},
-		},
-		{
-			name:    "name can't be emptied",
-			updates: &biz.WorkflowUpdateOpts{Name: toPtrS("")},
-			wantErr: true,
+			updates: &biz.WorkflowUpdateOpts{Project: toPtrS("new-project"), Team: toPtrS("new team"), Public: toPtrBool(true)},
+			want:    &biz.Workflow{Description: description, Team: "new team", Project: "new-project", Public: true},
 		},
 		{
 			name:    "can update contract",

app/controlplane/internal/biz/workflow.go

@@ -34,7 +34,7 @@ type Workflow struct {
 // Fields of the Workflow.
 func (Workflow) Fields() []ent.Field {
 	return []ent.Field{
-		field.String("name"),
+		field.String("name").Immutable(),
 		field.String("project").Optional(),
 		field.String("team").Optional(),
 		field.Int("runs_count").Default(0),

app/controlplane/internal/biz/workflow_integration_test.go

@@ -86,12 +86,6 @@ func (r *WorkflowRepo) Update(ctx context.Context, id uuid.UUID, opts *biz.Workf
 		SetNillablePublic(opts.Public).
 		SetNillableDescription(opts.Description)
 
-	// Required schema properties do not have a nillable setter
-	// https://github.com/ent/ent/issues/2108#issuecomment-961898661
-	if opts.Name != nil && *opts.Name != "" {
-		req = req.SetName(*opts.Name)
-	}
-
 	// Update the contract if provided
 	if opts.ContractID != nil {
 		contractUUID, err := uuid.Parse(*opts.ContractID)