VDiff: Migrate client command to vtctldclient (#13976)

Signed-off-by: Matt Lord <[email protected]>

changelog/18.0/18.0.0/summary.md

@@ -19,6 +19,7 @@
     - [Deleted `vtgr`](#deleted-vtgr)
     - [Deleted `query_analyzer`](#deleted-query_analyzer)
     - [Deprecated VTBackup stat `DurationByPhase`](#deprecated-vtbackup-stat-duration-by-phase)
+    - [Deprecated VDiff v1](#deprecated-vdiff-v1)
   - **[New stats](#new-stats)**
     - [VTGate Vindex unknown parameters](#vtgate-vindex-unknown-parameters)
     - [VTBackup stat `Phase`](#vtbackup-stat-phase)
@@ -132,6 +133,10 @@ The `vtgr` has been deprecated in Vitess 17, also see https://github.com/vitessi
 
 The undocumented `query_analyzer` binary has been removed in Vitess 18, see https://github.com/vitessio/vitess/issues/14054.
 
+#### <a id="deprecated-vdiff-v1"/>Deprecated VDiff v1
+
+[VDiff v2 was added in Vitess 15.0](https://vitess.io/blog/2022-11-22-vdiff-v2/) and marked as GA in 16.0. The [legacy v1 client command](https://vitess.io/docs/18.0/reference/vreplication/vdiffv1/) is now deprecated in Vitess 18.0 and will be **removed** in 19.0. Please switch all of your usage to the [new VDiff client](https://vitess.io/docs/18.0/reference/vreplication/vdiff/) command ASAP.
+
 #### <a id="deprecated-vtbackup-stat-duration-by-phase"/>Deprecated VTbackup stat `DurationByPhase`
 
 VTBackup stat `DurationByPhase` is deprecated. Use the binary-valued `Phase` stat instead.

go/cmd/vtctldclient/cli/json.go

@@ -25,6 +25,11 @@ import (
 	"google.golang.org/protobuf/proto"
 )
 
+const (
+	jsonIndent = "  "
+	jsonPrefix = ""
+)
+
 // MarshalJSON marshals obj to a JSON string. It uses the jsonpb marshaler for
 // proto.Message types, with some sensible defaults, and falls back to the
 // standard Go marshaler otherwise. In both cases, the marshaled JSON is
@@ -39,14 +44,14 @@ func MarshalJSON(obj any) ([]byte, error) {
 	case proto.Message:
 		m := protojson.MarshalOptions{
 			Multiline:       true,
-			Indent:          "  ",
+			Indent:          jsonIndent,
 			UseEnumNumbers:  true,
 			UseProtoNames:   true,
 			EmitUnpopulated: true,
 		}
 		return m.Marshal(obj)
 	default:
-		data, err := json.MarshalIndent(obj, "", "  ")
+		data, err := json.MarshalIndent(obj, jsonPrefix, jsonIndent)
 		if err != nil {
 			return nil, fmt.Errorf("json.Marshal = %v", err)
 		}
@@ -55,20 +60,21 @@ func MarshalJSON(obj any) ([]byte, error) {
 	}
 }
 
-// MarshalJSONCompact works the same as MarshalJSON but elides zero value elements.
-func MarshalJSONCompact(obj any) ([]byte, error) {
+// MarshalJSONPretty works the same as MarshalJSON but elides zero value
+// elements and uses ENUM names instead of numbers.
+func MarshalJSONPretty(obj any) ([]byte, error) {
 	switch obj := obj.(type) {
 	case proto.Message:
 		m := protojson.MarshalOptions{
 			Multiline:       true,
-			Indent:          "  ",
-			UseEnumNumbers:  true,
+			Indent:          jsonIndent,
+			UseEnumNumbers:  false,
 			UseProtoNames:   true,
 			EmitUnpopulated: false, // elide zero value elements
 		}
 		return m.Marshal(obj)
 	default:
-		data, err := json.MarshalIndent(obj, "", "  ")
+		data, err := json.MarshalIndent(obj, jsonPrefix, jsonIndent)
 		if err != nil {
 			return nil, fmt.Errorf("json.Marshal = %v", err)
 		}

go/cmd/vtctldclient/command/root.go

@@ -30,6 +30,7 @@ import (
 	vreplcommon "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common"
 	_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/movetables"
 	_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/reshard"
+	_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/vdiff"
 	_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/workflow"
 	"vitess.io/vitess/go/trace"
 	"vitess.io/vitess/go/vt/logutil"

go/cmd/vtctldclient/command/vreplication/common/cancel.go

@@ -70,7 +70,7 @@ func commandCancel(cmd *cobra.Command, args []string) error {
 		sort.Slice(resp.Details, func(i, j int) bool {
 			return resp.Details[i].Tablet.String() < resp.Details[j].Tablet.String()
 		})
-		output, err = cli.MarshalJSONCompact(resp)
+		output, err = cli.MarshalJSONPretty(resp)
 		if err != nil {
 			return err
 		}

go/cmd/vtctldclient/command/vreplication/common/complete.go

@@ -53,7 +53,7 @@ func commandComplete(cmd *cobra.Command, args []string) error {
 
 	var output []byte
 	if format == "json" {
-		output, err = cli.MarshalJSONCompact(resp)
+		output, err = cli.MarshalJSONPretty(resp)
 		if err != nil {
 			return err
 		}

go/cmd/vtctldclient/command/vreplication/common/show.go

@@ -51,7 +51,7 @@ func commandShow(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	data, err := cli.MarshalJSON(resp)
+	data, err := cli.MarshalJSONPretty(resp)
 	if err != nil {
 		return err
 	}

go/cmd/vtctldclient/command/vreplication/common/switchtraffic.go

@@ -106,7 +106,7 @@ func commandSwitchTraffic(cmd *cobra.Command, args []string) error {
 
 	var output []byte
 	if format == "json" {
-		output, err = cli.MarshalJSONCompact(resp)
+		output, err = cli.MarshalJSONPretty(resp)
 		if err != nil {
 			return err
 		}

go/cmd/vtctldclient/command/vreplication/common/update.go

@@ -159,7 +159,7 @@ func commandUpdateState(cmd *cobra.Command, args []string) error {
 		return resp.Details[i].Tablet.String() < resp.Details[j].Tablet.String()
 	})
 
-	data, err := cli.MarshalJSON(resp)
+	data, err := cli.MarshalJSONPretty(resp)
 	if err != nil {
 		return err
 	}

go/cmd/vtctldclient/command/vreplication/common/utils.go

@@ -79,7 +79,7 @@ func RegisterCommands(root *cobra.Command) {
 
 type SubCommandsOpts struct {
 	SubCommand string
-	Workflow   string // used to specify an example workflow name for the Examples section of the help output.
+	Workflow   string // Used to specify an example workflow name for the Examples section of the help output.
 }
 
 func SetClient(c vtctldclient.VtctldClient) {
@@ -150,7 +150,7 @@ func OutputStatusResponse(resp *vtctldatapb.WorkflowStatusResponse, format strin
 	var output []byte
 	var err error
 	if format == "json" {
-		output, err = cli.MarshalJSON(resp)
+		output, err = cli.MarshalJSONPretty(resp)
 		if err != nil {
 			return err
 		}
@@ -172,11 +172,11 @@ func OutputStatusResponse(resp *vtctldatapb.WorkflowStatusResponse, format strin
 }
 
 func AddCommonFlags(cmd *cobra.Command) {
-	cmd.Flags().StringVar(&BaseOptions.TargetKeyspace, "target-keyspace", "", "Target keyspace for this workflow exists (required).")
-	cmd.MarkFlagRequired("target-keyspace")
-	cmd.Flags().StringVarP(&BaseOptions.Workflow, "workflow", "w", "", "The workflow you want to perform the command on (required).")
-	cmd.MarkFlagRequired("workflow")
-	cmd.Flags().StringVar(&BaseOptions.Format, "format", "text", "The format of the output; supported formats are: text,json.")
+	cmd.PersistentFlags().StringVar(&BaseOptions.TargetKeyspace, "target-keyspace", "", "Target keyspace for this workflow.")
+	cmd.MarkPersistentFlagRequired("target-keyspace")
+	cmd.PersistentFlags().StringVarP(&BaseOptions.Workflow, "workflow", "w", "", "The workflow you want to perform the command on.")
+	cmd.MarkPersistentFlagRequired("workflow")
+	cmd.PersistentFlags().StringVar(&BaseOptions.Format, "format", "text", "The format of the output; supported formats are: text,json.")
 }
 
 func AddCommonCreateFlags(cmd *cobra.Command) {

go/cmd/vtctldclient/command/vreplication/movetables/create.go

@@ -44,7 +44,7 @@ var (
 	// moveTablesCreate makes a moveTablesCreate gRPC call to a vtctld.
 	moveTablesCreate = &cobra.Command{
 		Use:                   "create",
-		Short:                 "Create and optionally run a moveTables VReplication workflow.",
+		Short:                 "Create and optionally run a MoveTables VReplication workflow.",
 		Example:               `vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer create --source-keyspace commerce --cells zone1 --cells zone2 --tablet-types replica`,
 		SilenceUsage:          true,
 		DisableFlagsInUseLine: true,
@@ -123,7 +123,7 @@ func commandMoveTablesCreate(cmd *cobra.Command, args []string) error {
 
 func registerCreateCommand(root *cobra.Command) {
 	common.AddCommonCreateFlags(moveTablesCreate)
-	moveTablesCreate.PersistentFlags().StringVar(&moveTablesCreateOptions.SourceKeyspace, "source-keyspace", "", "Keyspace where the tables are being moved from (required).")
+	moveTablesCreate.PersistentFlags().StringVar(&moveTablesCreateOptions.SourceKeyspace, "source-keyspace", "", "Keyspace where the tables are being moved from.")
 	moveTablesCreate.MarkPersistentFlagRequired("source-keyspace")
 	moveTablesCreate.Flags().StringSliceVar(&moveTablesCreateOptions.SourceShards, "source-shards", nil, "Source shards to copy data from when performing a partial moveTables (experimental).")
 	moveTablesCreate.Flags().StringVar(&moveTablesCreateOptions.SourceTimeZone, "source-time-zone", "", "Specifying this causes any DATETIME fields to be converted from the given time zone into UTC.")

go/cmd/vtctldclient/command/vreplication/movetables/movetables.go

@@ -27,7 +27,7 @@ var (
 	moveTables = &cobra.Command{
 		Use:   "MoveTables --workflow <workflow> --keyspace <keyspace> [command] [command-flags]",
 		Short: "Perform commands related to moving tables from a source keyspace to a target keyspace.",
-		Long: `moveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
+		Long: `MoveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
 See the --help output for each command for more details.`,
 		DisableFlagsInUseLine: true,
 		Aliases:               []string{"movetables"},