cli: add default context for command line usage (#3479)

wk989898 · web-flow · commit f414adea4b47 · 2025-12-12T03:18:26.000Z
close #2949
diff --git a/cmd/cdc/cli/cli.go b/cmd/cdc/cli/cli.go
@@ -37,15 +37,15 @@ func NewCmdCli() *cobra.Command {
 
 	// Binding the `cli` command flags.
 	cf.AddFlags(cmds)
+	ctx, cancel := context.WithCancel(context.Background())
 	cmds.PersistentPreRun = func(cmd *cobra.Command, args []string) {
 		// Here we will initialize the logging configuration and set the current default context.
 		err := logger.InitLogger(&logger.Config{Level: cf.GetLogLevel()})
 		if err != nil {
 			cmd.Printf("init logger error %v\n", errors.Trace(err))
 			os.Exit(1)
 		}
-		_, cancel := context.WithCancel(context.Background())
-		defer cancel()
+		cmd.SetContext(ctx)
 		util.LogHTTPProxies()
 		// A notify that complete immediately, it skips the second signal essentially.
 		doneNotify := func() <-chan struct{} {
@@ -59,7 +59,7 @@ func NewCmdCli() *cobra.Command {
 	}
 
 	// Construct the client construction factory.
-	f := factory.NewFactory(cf)
+	f := factory.NewFactory(ctx, cf)
 
 	// Add subcommands.
 	cmds.AddCommand(newCmdChangefeed(f))
diff --git a/cmd/cdc/cli/cli_capture_list.go b/cmd/cdc/cli/cli_capture_list.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -52,7 +50,7 @@ type capture struct {
 
 // run runs the `cli capture list` command.
 func (o *listCaptureOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 	raw, err := o.apiv2Client.Captures().List(ctx)
 	if err != nil {
 		return err
diff --git a/cmd/cdc/cli/cli_changefeed_create.go b/cmd/cdc/cli/cli_changefeed_create.go
@@ -352,7 +352,7 @@ func newCmdCreateChangefeed(f factory.Factory) *cobra.Command {
 		Short: "Create a new replication task (changefeed)",
 		Args:  cobra.NoArgs,
 		Run: func(cmd *cobra.Command, args []string) {
-			ctx := context.Background()
+			ctx := cmd.Context()
 			util.CheckErr(o.complete(f))
 			util.CheckErr(o.validate(cmd))
 			util.CheckErr(o.run(ctx, cmd))
diff --git a/cmd/cdc/cli/cli_changefeed_list.go b/cmd/cdc/cli/cli_changefeed_list.go
@@ -14,7 +14,6 @@
 package cli
 
 import (
-	"context"
 	"time"
 
 	"github.com/pingcap/ticdc/api/owner"
@@ -66,7 +65,7 @@ func (o *listChangefeedOptions) complete(f factory.Factory) error {
 
 // run the `cli changefeed list` command.
 func (o *listChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	raw, err := o.apiClient.Changefeeds().List(ctx, o.keyspace, "all")
 	if err != nil {
diff --git a/cmd/cdc/cli/cli_changefeed_merge_table.go b/cmd/cdc/cli/cli_changefeed_merge_table.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -61,7 +59,7 @@ func (o *mergeTableChangefeedOptions) complete(f factory.Factory) error {
 // run the `cli changefeed move table` command.
 // return success or error message.
 func (o *mergeTableChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	err := o.apiClientV2.Changefeeds().MergeTable(ctx, o.keyspace, o.changefeedID, o.tableId, o.mode)
 	var errStr string
diff --git a/cmd/cdc/cli/cli_changefeed_move_split_table.go b/cmd/cdc/cli/cli_changefeed_move_split_table.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -64,7 +62,7 @@ func (o *moveSplitTableChangefeedOptions) complete(f factory.Factory) error {
 // run the `cli changefeed move table` command.
 // return success or error message.
 func (o *moveSplitTableChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	err := o.apiClientV2.Changefeeds().MoveSplitTable(ctx, o.keyspace, o.changefeedID, o.tableId, o.targetNodeID, o.mode)
 	var errStr string
diff --git a/cmd/cdc/cli/cli_changefeed_move_table.go b/cmd/cdc/cli/cli_changefeed_move_table.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -69,7 +67,7 @@ type response struct {
 // run the `cli changefeed move table` command.
 // return success or error message.
 func (o *moveTableChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	err := o.apiClientV2.Changefeeds().MoveTable(ctx, o.keyspace, o.changefeedID, o.tableId, o.targetNodeID, o.mode)
 	var errStr string
diff --git a/cmd/cdc/cli/cli_changefeed_pause.go b/cmd/cdc/cli/cli_changefeed_pause.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -55,8 +53,8 @@ func (o *pauseChangefeedOptions) complete(f factory.Factory) error {
 }
 
 // run the `cli changefeed pause` command.
-func (o *pauseChangefeedOptions) run() error {
-	ctx := context.Background()
+func (o *pauseChangefeedOptions) run(cmd *cobra.Command) error {
+	ctx := cmd.Context()
 	return o.apiClient.Changefeeds().Pause(ctx, o.keyspace, o.changefeedID)
 }
 
@@ -70,7 +68,7 @@ func newCmdPauseChangefeed(f factory.Factory) *cobra.Command {
 		Args:  cobra.NoArgs,
 		Run: func(cmd *cobra.Command, args []string) {
 			util.CheckErr(o.complete(f))
-			util.CheckErr(o.run())
+			util.CheckErr(o.run(cmd))
 		},
 	}
 
diff --git a/cmd/cdc/cli/cli_changefeed_pause_test.go b/cmd/cdc/cli/cli_changefeed_pause_test.go
@@ -38,5 +38,5 @@ func TestChangefeedPauseCli(t *testing.T) {
 	o.changefeedID = "abc"
 	o.keyspace = "test"
 	require.Nil(t, o.complete(f))
-	require.NotNil(t, o.run())
+	require.NotNil(t, o.run(cmd))
 }
diff --git a/cmd/cdc/cli/cli_changefeed_query.go b/cmd/cdc/cli/cli_changefeed_query.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/errors"
 	v2 "github.com/pingcap/ticdc/api/v2"
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
@@ -82,7 +80,7 @@ func (o *queryChangefeedOptions) complete(f factory.Factory) error {
 
 // run the `cli changefeed query` command.
 func (o *queryChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 	if o.simplified {
 		infos, err := o.apiClientV2.Changefeeds().List(ctx, o.keyspace, "all")
 		if err != nil {
diff --git a/cmd/cdc/cli/cli_changefeed_remove.go b/cmd/cdc/cli/cli_changefeed_remove.go
@@ -14,7 +14,6 @@
 package cli
 
 import (
-	"context"
 	"strings"
 
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
@@ -56,7 +55,7 @@ func (o *removeChangefeedOptions) complete(f factory.Factory) error {
 
 // run the `cli changefeed remove` command.
 func (o *removeChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	changefeedDetail, err := o.apiClient.Changefeeds().Get(ctx, o.keyspace, o.changefeedID)
 	if err != nil {
diff --git a/cmd/cdc/cli/cli_changefeed_resume.go b/cmd/cdc/cli/cli_changefeed_resume.go
@@ -194,7 +194,7 @@ func (o *resumeChangefeedOptions) validateParams(ctx context.Context) error {
 
 // run the `cli changefeed resume` command.
 func (o *resumeChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	if err := o.validateParams(ctx); err != nil {
 		return err
diff --git a/cmd/cdc/cli/cli_changefeed_split_table_by_region_count.go b/cmd/cdc/cli/cli_changefeed_split_table_by_region_count.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	apiv2client "github.com/pingcap/ticdc/pkg/api/v2"
@@ -61,7 +59,7 @@ func (o *splitTableByRegionCountChangefeedOptions) complete(f factory.Factory) e
 // run the `cli changefeed move table` command.
 // return success or error message.
 func (o *splitTableByRegionCountChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	err := o.apiClientV2.Changefeeds().SplitTableByRegionCount(ctx, o.keyspace, o.changefeedID, o.tableId, o.mode)
 	var errStr string
diff --git a/cmd/cdc/cli/cli_changefeed_statistics.go b/cmd/cdc/cli/cli_changefeed_statistics.go
@@ -95,7 +95,7 @@ func (o *statisticsChangefeedOptions) runCliWithAPIClient(ctx context.Context, c
 
 // run the `cli changefeed statistics` command.
 func (o *statisticsChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	tick := time.NewTicker(time.Duration(o.interval) * time.Second)
 	var lastTime time.Time
diff --git a/cmd/cdc/cli/cli_changefeed_update.go b/cmd/cdc/cli/cli_changefeed_update.go
@@ -14,7 +14,6 @@
 package cli
 
 import (
-	"context"
 	"encoding/json"
 	"strings"
 
@@ -91,7 +90,7 @@ func (o *updateChangefeedOptions) complete(f factory.Factory) error {
 
 // run the `cli changefeed update` command.
 func (o *updateChangefeedOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	old, err := o.apiV2Client.Changefeeds().Get(ctx, o.keyspace, o.changefeedID)
 	if err != nil {
diff --git a/cmd/cdc/cli/cli_tso_query.go b/cmd/cdc/cli/cli_tso_query.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
 	"github.com/spf13/cobra"
@@ -46,7 +44,7 @@ func (o *queryTsoOptions) complete(f factory.Factory) error {
 
 // run runs the `cli tso query` command.
 func (o *queryTsoOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	ts, logic, err := o.pdClient.GetTS(ctx)
 	if err != nil {
diff --git a/cmd/cdc/cli/cli_unsafe_delete_service_gc_safepoint.go b/cmd/cdc/cli/cli_unsafe_delete_service_gc_safepoint.go
@@ -14,7 +14,6 @@
 package cli
 
 import (
-	"context"
 	"strings"
 
 	"github.com/pingcap/errors"
@@ -76,7 +75,7 @@ func (o *unsafeDeleteServiceGcSafepointOptions) complete(f factory.Factory) erro
 
 // run runs the `cli unsafe delete-service-gc-safepoint` command.
 func (o *unsafeDeleteServiceGcSafepointOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	err := o.apiClient.Unsafe().DeleteServiceGcSafePoint(ctx, o.getUpstreamConfig(), o.keyspace)
 	if err == nil {
diff --git a/cmd/cdc/cli/cli_unsafe_reset.go b/cmd/cdc/cli/cli_unsafe_reset.go
@@ -70,7 +70,7 @@ func (o *unsafeResetOptions) addFlags(cmd *cobra.Command) {
 
 // run runs the `cli unsafe reset` command.
 func (o *unsafeResetOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 	defer o.pdClient.Close()
 	defer o.etcdClient.Close()
 
diff --git a/cmd/cdc/cli/cli_unsafe_resolve_lock.go b/cmd/cdc/cli/cli_unsafe_resolve_lock.go
@@ -47,8 +47,7 @@ func newUnsafeResolveLockOptions() *unsafeResolveLockOptions {
 }
 
 // complete adapts from the command line args to the data and client required.
-func (o *unsafeResolveLockOptions) complete(f factory.Factory) error {
-	ctx := context.Background()
+func (o *unsafeResolveLockOptions) complete(ctx context.Context, f factory.Factory) error {
 	apiClient, err := f.APIV2Client()
 	if err != nil {
 		return err
@@ -78,8 +77,7 @@ func (o *unsafeResolveLockOptions) complete(f factory.Factory) error {
 }
 
 // run runs the `cli unsafe show-metadata` command.
-func (o *unsafeResolveLockOptions) run() error {
-	ctx := context.Background()
+func (o *unsafeResolveLockOptions) run(ctx context.Context) error {
 	var pdAddrs []string
 	if o.upstreamPDAddrs != "" {
 		pdAddrs = strings.Split(o.upstreamPDAddrs, ",")
@@ -131,9 +129,10 @@ func newCmdResolveLock(f factory.Factory) *cobra.Command {
 		Use:   "resolve-lock",
 		Short: "resolve locks in regions",
 		Args:  cobra.NoArgs,
-		Run: func(_ *cobra.Command, args []string) {
-			util.CheckErr(o.complete(f))
-			util.CheckErr(o.run())
+		Run: func(cmd *cobra.Command, args []string) {
+			ctx := cmd.Context()
+			util.CheckErr(o.complete(ctx, f))
+			util.CheckErr(o.run(ctx))
 		},
 	}
 
diff --git a/cmd/cdc/cli/cli_unsafe_show_metadata.go b/cmd/cdc/cli/cli_unsafe_show_metadata.go
@@ -14,8 +14,6 @@
 package cli
 
 import (
-	"context"
-
 	"github.com/pingcap/errors"
 	"github.com/pingcap/ticdc/cmd/cdc/factory"
 	"github.com/pingcap/ticdc/cmd/util"
@@ -46,7 +44,7 @@ func (o *unsafeShowMetadataOptions) complete(f factory.Factory) error {
 
 // run runs the `cli unsafe show-metadata` command.
 func (o *unsafeShowMetadataOptions) run(cmd *cobra.Command) error {
-	ctx := context.Background()
+	ctx := cmd.Context()
 
 	kvs, err := o.apiClient.Unsafe().Metadata(ctx)
 	if err != nil {
diff --git a/cmd/cdc/factory/factory_impl.go b/cmd/cdc/factory/factory_impl.go
diff --git a/cmd/cdc/redo/apply.go b/cmd/cdc/redo/apply.go
diff --git a/cmd/cdc/redo/meta.go b/cmd/cdc/redo/meta.go
diff --git a/cmd/cdc/redo/redo.go b/cmd/cdc/redo/redo.go
diff --git a/cmd/cdc/server/server.go b/cmd/cdc/server/server.go

Original file line number	Diff line number	Diff line change
`@@ -38,5 +38,5 @@ func TestChangefeedPauseCli(t *testing.T) {`
`38`	`38`	`o.changefeedID = "abc"`
`39`	`39`	`o.keyspace = "test"`
`40`	`40`	`require.Nil(t, o.complete(f))`
`41`		`- require.NotNil(t, o.run())`
	`41`	`+ require.NotNil(t, o.run(cmd))`
`42`	`42`	`}`