Use number instead of name for the workflow messages (#1014)

iheanyi · web-flow · commit 6a89e3cbab02 · 2025-03-28T17:20:58.000Z
* Use number instead of name for the workflow messages

* Remove word duplication
diff --git a/internal/cmd/workflow/cancel.go b/internal/cmd/workflow/cancel.go
@@ -67,7 +67,7 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
 				}
 			}
 
-			end := ch.Printer.PrintProgress(fmt.Sprintf("Cancelling workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Cancelling workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))
 			defer end()
 
 			workflow, err := client.Workflows.Cancel(ctx, &ps.CancelWorkflowRequest{
@@ -88,7 +88,7 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Workflow %s in database %s has been cancelled.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/complete.go b/internal/cmd/workflow/complete.go
@@ -31,7 +31,7 @@ func CompleteCmd(ch *cmdutil.Helper) *cobra.Command {
 				return err
 			}
 
-			end := ch.Printer.PrintProgress(fmt.Sprintf("Marking workflow %s in database %s as complete…", printer.BoldBlue(number), printer.BoldBlue(db)))
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Marking workflow %s in database %s as complete…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))
 			defer end()
 
 			workflow, err := client.Workflows.Complete(ctx, &ps.CompleteWorkflowRequest{
@@ -52,7 +52,7 @@ func CompleteCmd(ch *cmdutil.Helper) *cobra.Command {
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Workflow %s in database %s has been marked as complete.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/create.go b/internal/cmd/workflow/create.go
@@ -57,7 +57,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 			}
 
 			if ch.Printer.Format() == printer.Human {
-				ch.Printer.Printf("Successfully created workflow %s to copy %d tables from %s to %s.\n", printer.BoldBlue(workflow.Name), len(flags.tables), printer.Bold(flags.sourceKeyspace), printer.Bold(flags.targetKeyspace))
+				ch.Printer.Printf("Successfully created workflow %s to copy %d tables from %s to %s.\n", printer.BoldBlue(printer.Number(workflow.Number)), len(flags.tables), printer.Bold(flags.sourceKeyspace), printer.Bold(flags.targetKeyspace))
 				return nil
 			}
 
@@ -291,7 +291,12 @@ func createInteractive(ctx context.Context, ch *cmdutil.Helper, org, db, branch
 		return err
 	}
 
-	ch.Printer.Printf("Successfully created workflow %s. It will copy %s tables from %s to %s.", printer.BoldBlue(workflow.Name), printer.Bold(len(workflow.Tables)), printer.BoldBlue(workflow.SourceKeyspace.Name), printer.BoldBlue(workflow.TargetKeyspace.Name))
+	numTables := "1 table"
+	if len(workflow.Tables) > 1 {
+		numTables = fmt.Sprintf("%d tables", len(workflow.Tables))
+	}
+
+	ch.Printer.Printf("Successfully created workflow %s. It will copy %s from %s to %s.", printer.BoldBlue(printer.Number(workflow.Number)), printer.Bold(numTables), printer.BoldBlue(workflow.SourceKeyspace.Name), printer.BoldBlue(workflow.TargetKeyspace.Name))
 
 	return nil
 }
diff --git a/internal/cmd/workflow/cutover.go b/internal/cmd/workflow/cutover.go
@@ -82,7 +82,7 @@ func CutoverCmd(ch *cmdutil.Helper) *cobra.Command {
 				}
 			}
 
-			end := ch.Printer.PrintProgress(fmt.Sprintf("Completing workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Completing workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))
 			defer end()
 
 			workflow, err := client.Workflows.Cutover(ctx, &ps.CutoverWorkflowRequest{
@@ -103,7 +103,7 @@ func CutoverCmd(ch *cmdutil.Helper) *cobra.Command {
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Workflow %s successfully completed.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 				)
 				return nil
 			}
diff --git a/internal/cmd/workflow/retry.go b/internal/cmd/workflow/retry.go
@@ -31,7 +31,7 @@ func RetryCmd(ch *cmdutil.Helper) *cobra.Command {
 				return err
 			}
 
-			end := ch.Printer.PrintProgress(fmt.Sprintf("Retrying workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Retrying workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))
 			defer end()
 
 			workflow, err := client.Workflows.Retry(ctx, &ps.RetryWorkflowRequest{
@@ -52,7 +52,7 @@ func RetryCmd(ch *cmdutil.Helper) *cobra.Command {
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Workflow %s in database %s has been retried.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/reverse_cutover.go b/internal/cmd/workflow/reverse_cutover.go
@@ -32,7 +32,7 @@ This is useful if your application has errors and you need to rollback after a c
 				return err
 			}
 
-			end := ch.Printer.PrintProgress(fmt.Sprintf("Reversing cutover for workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
+			end := ch.Printer.PrintProgress(fmt.Sprintf("Reversing cutover for workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))
 			defer end()
 
 			workflow, err := client.Workflows.ReverseCutover(ctx, &ps.ReverseCutoverWorkflowRequest{
@@ -54,7 +54,7 @@ This is useful if your application has errors and you need to rollback after a c
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Cutover reversed for workflow %s in database %s.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/reverse_traffic.go b/internal/cmd/workflow/reverse_traffic.go
@@ -53,7 +53,7 @@ This is useful when you need to rollback a traffic switch operation.`,
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Successfully reversed traffic for workflow %s in database %s.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/switch_traffic.go b/internal/cmd/workflow/switch_traffic.go
@@ -108,13 +108,13 @@ By default, this command will route all queries for primary, replica, and read-o
 			if ch.Printer.Format() == printer.Human {
 				if replicasOnly {
 					ch.Printer.Printf("Successfully switched query traffic from replica and read-only tablets to target keyspace for workflow %s in database %s.\n",
-						printer.BoldBlue(workflow.Name),
+						printer.BoldBlue(printer.Number(workflow.Number)),
 						printer.BoldBlue(db),
 					)
 					return nil
 				}
 				ch.Printer.Printf("Successfully switched queries from primary, replica, and read-only tablets to target keyspace for workflow %s in database %s.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db),
 				)
 				return nil
diff --git a/internal/cmd/workflow/verify_data.go b/internal/cmd/workflow/verify_data.go
@@ -51,7 +51,7 @@ func VerifyDataCmd(ch *cmdutil.Helper) *cobra.Command {
 
 			if ch.Printer.Format() == printer.Human {
 				ch.Printer.Printf("Successfully started data verification for workflow %s in database %s.\n",
-					printer.BoldBlue(workflow.Name),
+					printer.BoldBlue(printer.Number(workflow.Number)),
 					printer.BoldBlue(db))
 				return nil
 			}
diff --git a/internal/printer/printer.go b/internal/printer/printer.go
@@ -325,3 +325,8 @@ func Bold(msg interface{}) string {
 	// the 'color' package already handles IsTTY gracefully
 	return color.New(color.Bold).Sprint(msg)
 }
+
+// Number returns a formatted number with the # prefix
+func Number(number uint64) string {
+	return fmt.Sprintf("#%d", number)
+}

Original file line number	Diff line number	Diff line change
@@ -67,7 +67,7 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`		`- end := ch.Printer.PrintProgress(fmt.Sprintf("Cancelling workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))`
	`70`	`+ end := ch.Printer.PrintProgress(fmt.Sprintf("Cancelling workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))`
`71`	`71`	`defer end()`
`72`	`72`
`73`	`73`	`workflow, err := client.Workflows.Cancel(ctx, &ps.CancelWorkflowRequest{`
@@ -88,7 +88,7 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
`88`	`88`
`89`	`89`	`if ch.Printer.Format() == printer.Human {`
`90`	`90`	`ch.Printer.Printf("Workflow %s in database %s has been cancelled.\n",`
`91`		`- printer.BoldBlue(workflow.Name),`
	`91`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`92`	`92`	`printer.BoldBlue(db),`
`93`	`93`	`)`
`94`	`94`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func CompleteCmd(ch cmdutil.Helper) cobra.Command {`
`31`	`31`	`return err`
`32`	`32`	`}`
`33`	`33`
`34`		`- end := ch.Printer.PrintProgress(fmt.Sprintf("Marking workflow %s in database %s as complete…", printer.BoldBlue(number), printer.BoldBlue(db)))`
	`34`	`+ end := ch.Printer.PrintProgress(fmt.Sprintf("Marking workflow %s in database %s as complete…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))`
`35`	`35`	`defer end()`
`36`	`36`
`37`	`37`	`workflow, err := client.Workflows.Complete(ctx, &ps.CompleteWorkflowRequest{`
`@@ -52,7 +52,7 @@ func CompleteCmd(ch cmdutil.Helper) cobra.Command {`
`52`	`52`
`53`	`53`	`if ch.Printer.Format() == printer.Human {`
`54`	`54`	`ch.Printer.Printf("Workflow %s in database %s has been marked as complete.\n",`
`55`		`- printer.BoldBlue(workflow.Name),`
	`55`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`56`	`56`	`printer.BoldBlue(db),`
`57`	`57`	`)`
`58`	`58`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func CreateCmd(ch cmdutil.Helper) cobra.Command {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`if ch.Printer.Format() == printer.Human {`
`60`		`- ch.Printer.Printf("Successfully created workflow %s to copy %d tables from %s to %s.\n", printer.BoldBlue(workflow.Name), len(flags.tables), printer.Bold(flags.sourceKeyspace), printer.Bold(flags.targetKeyspace))`
	`60`	`+ ch.Printer.Printf("Successfully created workflow %s to copy %d tables from %s to %s.\n", printer.BoldBlue(printer.Number(workflow.Number)), len(flags.tables), printer.Bold(flags.sourceKeyspace), printer.Bold(flags.targetKeyspace))`
`61`	`61`	`return nil`
`62`	`62`	`}`
`63`	`63`
`@@ -291,7 +291,12 @@ func createInteractive(ctx context.Context, ch *cmdutil.Helper, org, db, branch`
`291`	`291`	`return err`
`292`	`292`	`}`
`293`	`293`
`294`		`- ch.Printer.Printf("Successfully created workflow %s. It will copy %s tables from %s to %s.", printer.BoldBlue(workflow.Name), printer.Bold(len(workflow.Tables)), printer.BoldBlue(workflow.SourceKeyspace.Name), printer.BoldBlue(workflow.TargetKeyspace.Name))`
	`294`	`+ numTables := "1 table"`
	`295`	`+ if len(workflow.Tables) > 1 {`
	`296`	`+ numTables = fmt.Sprintf("%d tables", len(workflow.Tables))`
	`297`	`+ }`
	`298`	`+`
	`299`	`+ ch.Printer.Printf("Successfully created workflow %s. It will copy %s from %s to %s.", printer.BoldBlue(printer.Number(workflow.Number)), printer.Bold(numTables), printer.BoldBlue(workflow.SourceKeyspace.Name), printer.BoldBlue(workflow.TargetKeyspace.Name))`
`295`	`300`
`296`	`301`	`return nil`
`297`	`302`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func CutoverCmd(ch cmdutil.Helper) cobra.Command {`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`85`		`- end := ch.Printer.PrintProgress(fmt.Sprintf("Completing workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))`
	`85`	`+ end := ch.Printer.PrintProgress(fmt.Sprintf("Completing workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))`
`86`	`86`	`defer end()`
`87`	`87`
`88`	`88`	`workflow, err := client.Workflows.Cutover(ctx, &ps.CutoverWorkflowRequest{`
`@@ -103,7 +103,7 @@ func CutoverCmd(ch cmdutil.Helper) cobra.Command {`
`103`	`103`
`104`	`104`	`if ch.Printer.Format() == printer.Human {`
`105`	`105`	`ch.Printer.Printf("Workflow %s successfully completed.\n",`
`106`		`- printer.BoldBlue(workflow.Name),`
	`106`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`107`	`107`	`)`
`108`	`108`	`return nil`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ func RetryCmd(ch cmdutil.Helper) cobra.Command {`
`31`	`31`	`return err`
`32`	`32`	`}`
`33`	`33`
`34`		`- end := ch.Printer.PrintProgress(fmt.Sprintf("Retrying workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))`
	`34`	`+ end := ch.Printer.PrintProgress(fmt.Sprintf("Retrying workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))`
`35`	`35`	`defer end()`
`36`	`36`
`37`	`37`	`workflow, err := client.Workflows.Retry(ctx, &ps.RetryWorkflowRequest{`
`@@ -52,7 +52,7 @@ func RetryCmd(ch cmdutil.Helper) cobra.Command {`
`52`	`52`
`53`	`53`	`if ch.Printer.Format() == printer.Human {`
`54`	`54`	`ch.Printer.Printf("Workflow %s in database %s has been retried.\n",`
`55`		`- printer.BoldBlue(workflow.Name),`
	`55`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`56`	`56`	`printer.BoldBlue(db),`
`57`	`57`	`)`
`58`	`58`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ This is useful if your application has errors and you need to rollback after a c`
`32`	`32`	`return err`
`33`	`33`	`}`
`34`	`34`
`35`		`- end := ch.Printer.PrintProgress(fmt.Sprintf("Reversing cutover for workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))`
	`35`	`+ end := ch.Printer.PrintProgress(fmt.Sprintf("Reversing cutover for workflow %s in database %s…", printer.BoldBlue(printer.Number(number)), printer.BoldBlue(db)))`
`36`	`36`	`defer end()`
`37`	`37`
`38`	`38`	`workflow, err := client.Workflows.ReverseCutover(ctx, &ps.ReverseCutoverWorkflowRequest{`
`@@ -54,7 +54,7 @@ This is useful if your application has errors and you need to rollback after a c`
`54`	`54`
`55`	`55`	`if ch.Printer.Format() == printer.Human {`
`56`	`56`	`ch.Printer.Printf("Cutover reversed for workflow %s in database %s.\n",`
`57`		`- printer.BoldBlue(workflow.Name),`
	`57`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`58`	`58`	`printer.BoldBlue(db),`
`59`	`59`	`)`
`60`	`60`	`return nil`
Original file line number	Diff line number	Diff line change
@@ -53,7 +53,7 @@ This is useful when you need to rollback a traffic switch operation.`,
`53`	`53`
`54`	`54`	`if ch.Printer.Format() == printer.Human {`
`55`	`55`	`ch.Printer.Printf("Successfully reversed traffic for workflow %s in database %s.\n",`
`56`		`- printer.BoldBlue(workflow.Name),`
	`56`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`57`	`57`	`printer.BoldBlue(db),`
`58`	`58`	`)`
`59`	`59`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -108,13 +108,13 @@ By default, this command will route all queries for primary, replica, and read-o`
`108`	`108`	`if ch.Printer.Format() == printer.Human {`
`109`	`109`	`if replicasOnly {`
`110`	`110`	`ch.Printer.Printf("Successfully switched query traffic from replica and read-only tablets to target keyspace for workflow %s in database %s.\n",`
`111`		`- printer.BoldBlue(workflow.Name),`
	`111`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`112`	`112`	`printer.BoldBlue(db),`
`113`	`113`	`)`
`114`	`114`	`return nil`
`115`	`115`	`}`
`116`	`116`	`ch.Printer.Printf("Successfully switched queries from primary, replica, and read-only tablets to target keyspace for workflow %s in database %s.\n",`
`117`		`- printer.BoldBlue(workflow.Name),`
	`117`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`118`	`118`	`printer.BoldBlue(db),`
`119`	`119`	`)`
`120`	`120`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ func VerifyDataCmd(ch cmdutil.Helper) cobra.Command {`
`51`	`51`
`52`	`52`	`if ch.Printer.Format() == printer.Human {`
`53`	`53`	`ch.Printer.Printf("Successfully started data verification for workflow %s in database %s.\n",`
`54`		`- printer.BoldBlue(workflow.Name),`
	`54`	`+ printer.BoldBlue(printer.Number(workflow.Number)),`
`55`	`55`	`printer.BoldBlue(db))`
`56`	`56`	`return nil`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -325,3 +325,8 @@ func Bold(msg interface{}) string {`
`325`	`325`	`// the 'color' package already handles IsTTY gracefully`
`326`	`326`	`return color.New(color.Bold).Sprint(msg)`
`327`	`327`	`}`
	`328`	`+`
	`329`	`+// Number returns a formatted number with the # prefix`
	`330`	`+func Number(number uint64) string {`
	`331`	`+ return fmt.Sprintf("#%d", number)`
	`332`	`+}`