polish

Author: xuanyu66

go.mod

@@ -44,6 +44,7 @@ require (
 
 require (
 	filippo.io/edwards25519 v1.1.0 // indirect
+	github.com/AlekSi/pointer v1.2.0 // indirect
 	github.com/alecthomas/chroma v0.10.0 // indirect
 	github.com/alecthomas/chroma/v2 v2.14.0 // indirect
 	github.com/alessio/shellescape v1.4.1 // indirect

go.sum

@@ -27,6 +27,8 @@ github.com/99designs/keyring v1.2.2 h1:pZd3neh/EmUzWONb35LxQfvuY7kiSXAq3HQd97+XB
 github.com/99designs/keyring v1.2.2/go.mod h1:wes/FrByc8j7lFOAGLGSNEg8f/PaI3cgTBqhFkHUrPk=
 github.com/AlecAivazis/survey/v2 v2.3.6 h1:NvTuVHISgTHEHeBFqt6BHOe4Ny/NwGZr7w+F8S9ziyw=
 github.com/AlecAivazis/survey/v2 v2.3.6/go.mod h1:4AuI9b7RjAR+G7v9+C4YSlX/YL3K3cWNXgWXOhllqvI=
+github.com/AlekSi/pointer v1.2.0 h1:glcy/gc4h8HnG2Z3ZECSzZ1IX1x2JxRVuDzaJwQE0+w=
+github.com/AlekSi/pointer v1.2.0/go.mod h1:gZGfd3dpW4vEc/UlyfKKi1roIqcCgwOIvb0tSNSBle0=
 github.com/Azure/azure-sdk-for-go/sdk/azcore v1.11.1 h1:E+OJmp2tPvt1W+amx48v1eqbjDYsgN+RzP4q16yV5eM=
 github.com/Azure/azure-sdk-for-go/sdk/azcore v1.11.1/go.mod h1:a6xsAQUZg+VsS3TJ05SRp524Hs4pZ/AeFSr5ENf0Yjo=
 github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.5.2 h1:FDif4R1+UUR+00q6wquyX90K7A8dN+R5E8GEadoP7sU=

internal/cli/serverless/migration/create.go

@@ -19,6 +19,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"slices"
 	"strings"
 	"time"
 
@@ -42,8 +43,8 @@ func CreateCmd(h *internal.Helper) *cobra.Command {
 		Short: "Create a migration",
 		Args:  cobra.NoArgs,
 		Example: fmt.Sprintf(`  Create a migration:
-	$ %[1]s serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path> --dry-run
-	$ %[1]s serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path>
+  $ %[1]s serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path> --dry-run
+  $ %[1]s serverless migration create -c <cluster-id> --display-name <name> --config-file <file-path>
 `, config.CliName),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return markCreateMigrationRequiredFlags(cmd)
@@ -67,6 +68,9 @@ func CreateCmd(h *internal.Helper) *cobra.Command {
 			if err != nil {
 				return errors.Trace(err)
 			}
+			if strings.TrimSpace(name) == "" {
+				return errors.New("display name is required")
+			}
 			configPath, err := cmd.Flags().GetString(flag.MigrationConfigFile)
 			if err != nil {
 				return errors.Trace(err)
@@ -81,9 +85,6 @@ func CreateCmd(h *internal.Helper) *cobra.Command {
 			}
 			definitionStr := string(definitionBytes)
 
-			if strings.TrimSpace(name) == "" {
-				return errors.New("display name is required")
-			}
 			sources, target, mode, err := parseMigrationDefinition(definitionStr)
 			if err != nil {
 				return err
@@ -111,16 +112,16 @@ func CreateCmd(h *internal.Helper) *cobra.Command {
 				return errors.Trace(err)
 			}
 
-			taskID := aws.ToString(resp.MigrationId)
-			fmt.Fprintln(h.IOStreams.Out, color.GreenString("migration %s(%s) created", name, taskID))
+			migrationID := aws.ToString(resp.MigrationId)
+			fmt.Fprintln(h.IOStreams.Out, color.GreenString("migration %s(%s) created", name, migrationID))
 			return nil
 		},
 	}
 
 	cmd.Flags().StringP(flag.ClusterID, flag.ClusterIDShort, "", "The ID of the target cluster.")
 	cmd.Flags().StringP(flag.DisplayName, flag.DisplayNameShort, "", "Display name for the migration.")
 	cmd.Flags().String(flag.MigrationConfigFile, "", "Path to a migration config JSON file. Use \"ticloud serverless migration template --mode <mode>\" to print templates.")
-	cmd.Flags().Bool(flag.MigrationDryRun, false, "Run a migration precheck (dry run) with the provided inputs without creating a task.")
+	cmd.Flags().Bool(flag.MigrationDryRun, false, "Run a migration precheck (dry run) with the provided inputs without creating a migration.")
 
 	return cmd
 }
@@ -168,7 +169,7 @@ func runMigrationPrecheck(ctx context.Context, client cloud.TiDBCloudClient, clu
 			if err != nil {
 				return errors.Trace(err)
 			}
-			finished, err := printPrecheckSummary(precheckID, result.GetStatus(), result, h)
+			finished, err := printPrecheckSummary(result, h)
 			if err != nil {
 				return err
 			}
@@ -195,15 +196,15 @@ func isPrecheckUnfinished(status pkgmigration.MigrationPrecheckStatus) bool {
 	}
 }
 
-func printPrecheckSummary(id string, status pkgmigration.MigrationPrecheckStatus, result *pkgmigration.MigrationPrecheck, h *internal.Helper) (bool, error) {
-	if isPrecheckUnfinished(status) {
-		fmt.Fprintf(h.IOStreams.Out, "precheck %s summary (status %s)\n", id, status)
+func printPrecheckSummary(result *pkgmigration.MigrationPrecheck, h *internal.Helper) (bool, error) {
+	if isPrecheckUnfinished(result.GetStatus()) {
+		fmt.Fprintf(h.IOStreams.Out, "precheck %s summary (status %s)\n", result.GetPrecheckId(), result.GetStatus())
 		fmt.Fprintf(h.IOStreams.Out, "Total: %d, Success: %d, Warn: %d, Failed: %d\n",
 			aws.ToInt32(result.Total), aws.ToInt32(result.SuccessCnt), aws.ToInt32(result.WarnCnt), aws.ToInt32(result.FailedCnt))
 		return false, nil
 	}
 
-	fmt.Fprintf(h.IOStreams.Out, "precheck %s finished with status %s\n", id, status)
+	fmt.Fprintf(h.IOStreams.Out, "precheck %s finished with status %s\n", result.GetPrecheckId(), result.GetStatus())
 	fmt.Fprintf(h.IOStreams.Out, "Total: %d, Success: %d, Warn: %d, Failed: %d\n",
 		aws.ToInt32(result.Total), aws.ToInt32(result.SuccessCnt), aws.ToInt32(result.WarnCnt), aws.ToInt32(result.FailedCnt))
 	if len(result.Items) == 0 {
@@ -289,24 +290,14 @@ func parseMigrationDefinition(value string) ([]pkgmigration.Source, pkgmigration
 func parseMigrationMode(value string) (pkgmigration.TaskMode, error) {
 	trimmed := strings.TrimSpace(value)
 	if trimmed == "" {
-		return "", errors.New("mode is required in the migration definition")
+		return "", errors.New("empty config file")
 	}
 	normalized := strings.ToUpper(trimmed)
 	mode := pkgmigration.TaskMode(normalized)
-	for _, allowed := range pkgmigration.AllowedTaskModeEnumValues {
-		if mode == allowed {
-			return mode, nil
-		}
-	}
-	return "", errors.Errorf("invalid mode %q, allowed values: %s", value, strings.Join(taskModeValues(), ", "))
-}
-
-func taskModeValues() []string {
-	values := make([]string, 0, len(pkgmigration.AllowedTaskModeEnumValues))
-	for _, mode := range pkgmigration.AllowedTaskModeEnumValues {
-		values = append(values, string(mode))
+	if slices.Contains(pkgmigration.AllowedTaskModeEnumValues, mode) {
+		return mode, nil
 	}
-	return values
+	return "", errors.Errorf("invalid mode %q, allowed values: %s", value, pkgmigration.AllowedTaskModeEnumValues)
 }
 
 // standardizeJSON accepts JSON With Commas and Comments(JWCC) see

internal/cli/serverless/migration/delete.go

@@ -37,7 +37,7 @@ type DeleteOpts struct {
 func (c DeleteOpts) NonInteractiveFlags() []string {
 	return []string{
 		flag.ClusterID,
-		flag.MigrationTaskID,
+		flag.MigrationID,
 	}
 }
 
@@ -65,14 +65,14 @@ func DeleteCmd(h *internal.Helper) *cobra.Command {
 
 	var cmd = &cobra.Command{
 		Use:     "delete",
-		Short:   "Delete a migration task",
+		Short:   "Delete a migration",
 		Aliases: []string{"rm"},
 		Args:    cobra.NoArgs,
-		Example: fmt.Sprintf(`  Delete a migration task in interactive mode:
-	  $ %[1]s serverless migration delete
+		Example: fmt.Sprintf(`  Delete a migration in interactive mode:
+  $ %[1]s serverless migration delete
 
-	  Delete a migration task in non-interactive mode:
-	  $ %[1]s serverless migration delete -c <cluster-id> --migration-id <task-id>`, config.CliName),
+  Delete a migration in non-interactive mode:
+  $ %[1]s serverless migration delete -c <cluster-id> --migration-id <migration-id>`, config.CliName),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.MarkInteractive(cmd)
 		},
@@ -83,7 +83,7 @@ func DeleteCmd(h *internal.Helper) *cobra.Command {
 			}
 			ctx := cmd.Context()
 
-			var clusterID, taskID string
+			var clusterID, migrationID string
 			if opts.interactive {
 				if !h.IOStreams.CanPrompt {
 					return errors.New("The terminal doesn't support interactive mode, please use non-interactive mode")
@@ -97,26 +97,26 @@ func DeleteCmd(h *internal.Helper) *cobra.Command {
 					return err
 				}
 				clusterID = cluster.ID
-				task, err := cloud.GetSelectedMigrationTask(ctx, clusterID, h.QueryPageSize, d)
+				migration, err := cloud.GetSelectedMigration(ctx, clusterID, h.QueryPageSize, d)
 				if err != nil {
 					return err
 				}
-				taskID = task.ID
+				migrationID = migration.ID
 			} else {
 				var err error
 				clusterID, err = cmd.Flags().GetString(flag.ClusterID)
 				if err != nil {
 					return errors.Trace(err)
 				}
-				taskID, err = cmd.Flags().GetString(flag.MigrationTaskID)
+				migrationID, err = cmd.Flags().GetString(flag.MigrationID)
 				if err != nil {
 					return errors.Trace(err)
 				}
 			}
 
 			if !force {
 				if !h.IOStreams.CanPrompt {
-					return errors.New("The terminal doesn't support prompt, please run with --force to delete the migration task")
+					return errors.New("The terminal doesn't support prompt, please run with --force to delete the migration")
 				}
 				prompt := &survey.Input{
 					Message: fmt.Sprintf("%s %s %s", color.BlueString("Please type"), color.HiBlueString("yes"), color.BlueString("to confirm:")),
@@ -129,21 +129,21 @@ func DeleteCmd(h *internal.Helper) *cobra.Command {
 					return err
 				}
 				if confirmation != "yes" {
-					return errors.New("Incorrect confirm string entered, skipping migration task deletion")
+					return errors.New("Incorrect confirm string entered, skipping migration deletion")
 				}
 			}
 
-			if _, err := d.DeleteMigration(ctx, clusterID, taskID); err != nil {
+			if _, err := d.DeleteMigration(ctx, clusterID, migrationID); err != nil {
 				return errors.Trace(err)
 			}
 
-			fmt.Fprintln(h.IOStreams.Out, color.GreenString("migration task %s deleted", taskID))
+			fmt.Fprintln(h.IOStreams.Out, color.GreenString("migration %s deleted", migrationID))
 			return nil
 		},
 	}
 
 	cmd.Flags().BoolVar(&force, flag.Force, false, "Delete without confirmation.")
-	cmd.Flags().StringP(flag.ClusterID, flag.ClusterIDShort, "", "Cluster ID that owns the migration task.")
-	cmd.Flags().StringP(flag.MigrationTaskID, flag.MigrationTaskIDShort, "", "ID of the migration task to delete.")
+	cmd.Flags().StringP(flag.ClusterID, flag.ClusterIDShort, "", "Cluster ID that owns the migration.")
+	cmd.Flags().StringP(flag.MigrationID, flag.MigrationIDShort, "", "ID of the migration to delete.")
 	return cmd
 }

internal/cli/serverless/migration/describe.go

@@ -34,7 +34,7 @@ type DescribeOpts struct {
 func (c DescribeOpts) NonInteractiveFlags() []string {
 	return []string{
 		flag.ClusterID,
-		flag.MigrationTaskID,
+		flag.MigrationID,
 	}
 }
 
@@ -61,14 +61,14 @@ func DescribeCmd(h *internal.Helper) *cobra.Command {
 
 	var cmd = &cobra.Command{
 		Use:     "describe",
-		Short:   "Describe a migration task",
+		Short:   "Describe a migration",
 		Aliases: []string{"get"},
 		Args:    cobra.NoArgs,
-		Example: fmt.Sprintf(`  Describe a migration task in interactive mode:
+		Example: fmt.Sprintf(`  Describe a migration in interactive mode:
   $ %[1]s serverless migration describe
 
-  Describe a migration task in non-interactive mode:
-  $ %[1]s serverless migration describe -c <cluster-id> --migration-id <task-id>`, config.CliName),
+  Describe a migration in non-interactive mode:
+  $ %[1]s serverless migration describe -c <cluster-id> --migration-id <migration-id>`, config.CliName),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.MarkInteractive(cmd)
 		},
@@ -79,7 +79,7 @@ func DescribeCmd(h *internal.Helper) *cobra.Command {
 			}
 			ctx := cmd.Context()
 
-			var clusterID, taskID string
+			var clusterID, migrationID string
 			if opts.interactive {
 				if !h.IOStreams.CanPrompt {
 					return errors.New("The terminal doesn't support interactive mode, please use non-interactive mode")
@@ -94,24 +94,24 @@ func DescribeCmd(h *internal.Helper) *cobra.Command {
 				}
 				clusterID = cluster.ID
 
-				task, err := cloud.GetSelectedMigrationTask(ctx, clusterID, h.QueryPageSize, d)
+				migration, err := cloud.GetSelectedMigration(ctx, clusterID, h.QueryPageSize, d)
 				if err != nil {
 					return err
 				}
-				taskID = task.ID
+				migrationID = migration.ID
 			} else {
 				var err error
 				clusterID, err = cmd.Flags().GetString(flag.ClusterID)
 				if err != nil {
 					return errors.Trace(err)
 				}
-				taskID, err = cmd.Flags().GetString(flag.MigrationTaskID)
+				migrationID, err = cmd.Flags().GetString(flag.MigrationID)
 				if err != nil {
 					return errors.Trace(err)
 				}
 			}
 
-			resp, err := d.GetMigration(ctx, clusterID, taskID)
+			resp, err := d.GetMigration(ctx, clusterID, migrationID)
 			if err != nil {
 				return errors.Trace(err)
 			}
@@ -120,7 +120,7 @@ func DescribeCmd(h *internal.Helper) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringP(flag.ClusterID, flag.ClusterIDShort, "", "Cluster ID that owns the migration task.")
-	cmd.Flags().StringP(flag.MigrationTaskID, flag.MigrationTaskIDShort, "", "ID of the migration task to describe.")
+	cmd.Flags().StringP(flag.ClusterID, flag.ClusterIDShort, "", "Cluster ID that owns the migration.")
+	cmd.Flags().StringP(flag.MigrationID, flag.MigrationIDShort, "", "ID of the migration to describe.")
 	return cmd
 }

internal/cli/serverless/migration/list.go

@@ -16,8 +16,8 @@ package migration
 
 import (
 	"fmt"
-	"time"
 
+	"github.com/AlekSi/pointer"
 	"github.com/juju/errors"
 	"github.com/spf13/cobra"
 
@@ -121,21 +121,11 @@ func ListCmd(h *internal.Helper) *cobra.Command {
 			columns := []output.Column{"ID", "Name", "Mode", "State", "CreatedAt"}
 			var rows []output.Row
 			for _, task := range resp.Migrations {
-				id := safeString(task.MigrationId)
-				name := safeString(task.DisplayName)
-				if name == "" {
-					name = id
-				}
-				mode := ""
-				if task.Mode != nil {
-					mode = string(*task.Mode)
-				}
-				state := ""
-				if task.State != nil {
-					state = string(*task.State)
-				}
-				created := formatTime(task.CreateTime)
-				rows = append(rows, output.Row{id, name, mode, state, created})
+				id := pointer.Get(task.MigrationId)
+				name := pointer.Get(task.DisplayName)
+				mode := string(pointer.Get(task.Mode))
+				state := string(pointer.Get(task.State))
+				rows = append(rows, output.Row{id, name, mode, state, task.CreateTime.String()})
 			}
 			return errors.Trace(output.PrintHumanTable(h.IOStreams.Out, columns, rows))
 		},
@@ -145,17 +135,3 @@ func ListCmd(h *internal.Helper) *cobra.Command {
 	cmd.Flags().StringP(flag.Output, flag.OutputShort, output.HumanFormat, flag.OutputHelp)
 	return cmd
 }
-
-func safeString(value *string) string {
-	if value == nil {
-		return ""
-	}
-	return *value
-}
-
-func formatTime(value *time.Time) string {
-	if value == nil {
-		return ""
-	}
-	return value.Format(time.RFC3339)
-}