Skip to content

Handle async MoveTables Create #1247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickvanw merged 1 commit into from
Apr 7, 2026
+59 −44
Merged

Handle async MoveTables Create #1247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ require (
github.com/mattn/go-shellwords v1.0.12
github.com/mitchellh/go-homedir v1.1.0
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c
github.com/planetscale/planetscale-go v0.161.0
github.com/planetscale/planetscale-go v0.162.0
github.com/planetscale/psdb v0.0.0-20250717190954-65c6661ab6e4
github.com/planetscale/psdbproxy v0.0.0-20250728082226-3f4ea3a74ec7
github.com/spf13/cobra v1.10.2
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjL
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
github.com/planetscale/noglog v0.2.1-0.20210421230640-bea75fcd2e8e h1:MZ8D+Z3m2vvqGZLvoQfpaGg/j1fNDr4j03s3PRz4rVY=
github.com/planetscale/noglog v0.2.1-0.20210421230640-bea75fcd2e8e/go.mod h1:hwAsSPQdvPa3WcfKfzTXxtEq/HlqwLjQasfO6QbGo4Q=
github.com/planetscale/planetscale-go v0.161.0 h1:YWpOJXJTJKX2AFHoKkO/IZdRxCmOQAS+O6A+jJuteL8=
github.com/planetscale/planetscale-go v0.161.0/go.mod h1:paQCI5SgquuoewvMQM7R+r1XJO868bdP6/ihGidYRM0=
github.com/planetscale/planetscale-go v0.162.0 h1:uOpqOeIikRXu+5AxwUBitvImhPtRca6Kfmt6ahmXzDs=
github.com/planetscale/planetscale-go v0.162.0/go.mod h1:paQCI5SgquuoewvMQM7R+r1XJO868bdP6/ihGidYRM0=
github.com/planetscale/psdb v0.0.0-20250717190954-65c6661ab6e4 h1:Xv5pj20Rhfty1Tv0OVcidg4ez4PvGrpKvb6rvUwQgDs=
github.com/planetscale/psdb v0.0.0-20250717190954-65c6661ab6e4/go.mod h1:M52h5IWxAcbdQ1hSZrLAGQC4ZXslxEsK/Wh9nu3wdWs=
github.com/planetscale/psdbproxy v0.0.0-20250728082226-3f4ea3a74ec7 h1:aRd6vdE1fyuSI4RVj7oCr8lFmgqXvpnPUmN85VbZCp8=
Expand Down
7 changes: 6 additions & 1 deletion internal/cmd/branch/vtctld/move_tables.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,12 @@ func MoveTablesCreateCmd(ch *cmdutil.Helper) *cobra.Command {
req.AtomicCopy = &flags.atomicCopy
}

data, err := client.MoveTables.Create(ctx, req)
operation, err := client.MoveTables.Create(ctx, req)
if err != nil {
return cmdutil.HandleError(err)
}

data, err := waitForMoveTablesOperationResult(ctx, client, ch.Config.Organization, database, branch, operation.ID)
if err != nil {
return cmdutil.HandleError(err)
}
Expand Down
86 changes: 48 additions & 38 deletions internal/cmd/branch/vtctld/move_tables_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,14 @@ func setMoveTablesOperationTimeouts(t *testing.T, defaultTimeout, timeoutBuffer

func TestMoveTablesCreate(t *testing.T) {
c := qt.New(t)
setMoveTablesPollInterval(t, 0)

org := "my-org"
db := "my-db"
branch := "my-branch"

svc := &mock.MoveTablesService{
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (json.RawMessage, error) {
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (*ps.VtctldOperationReference, error) {
c.Assert(req.Organization, qt.Equals, org)
c.Assert(req.Database, qt.Equals, db)
c.Assert(req.Branch, qt.Equals, branch)
Expand All @@ -82,25 +83,29 @@ func TestMoveTablesCreate(t *testing.T) {
c.Assert(req.TabletTypes, qt.IsNil)
c.Assert(req.ExcludeTables, qt.IsNil)
c.Assert(req.AtomicCopy, qt.IsNil)
return json.RawMessage(`{"summary":"created"}`), nil
return &ps.VtctldOperationReference{ID: "create-op"}, nil
},
}

var buf bytes.Buffer
format := printer.JSON
p := printer.NewPrinter(&format)
p.SetResourceOutput(&buf)
vtctldSvc := &mock.VtctldService{
GetOperationFn: func(ctx context.Context, req *ps.GetVtctldOperationRequest) (*ps.VtctldOperation, error) {
c.Assert(req.Organization, qt.Equals, org)
c.Assert(req.Database, qt.Equals, db)
c.Assert(req.Branch, qt.Equals, branch)
c.Assert(req.ID, qt.Equals, "create-op")

ch := &cmdutil.Helper{
Printer: p,
Config: &config.Config{Organization: org},
Client: func() (*ps.Client, error) {
return &ps.Client{
MoveTables: svc,
return &ps.VtctldOperation{
ID: "create-op",
State: "completed",
Completed: true,
Result: json.RawMessage(`{"summary":"created"}`),
}, nil
},
}

var buf bytes.Buffer
ch := moveTablesTestHelper(org, svc, vtctldSvc, &buf)

cmd := MoveTablesCmd(ch)
cmd.SetArgs([]string{"create", db, branch,
"--workflow", "my-workflow",
Expand All @@ -110,41 +115,43 @@ func TestMoveTablesCreate(t *testing.T) {
err := cmd.Execute()
c.Assert(err, qt.IsNil)
c.Assert(svc.CreateFnInvoked, qt.IsTrue)
c.Assert(vtctldSvc.GetOperationFnInvoked, qt.IsTrue)
c.Assert(buf.String(), qt.JSONEquals, map[string]string{"summary": "created"})
}

func TestMoveTablesCreateWithDeferSecondaryKeysFalse(t *testing.T) {
c := qt.New(t)
setMoveTablesPollInterval(t, 0)

org := "my-org"
db := "my-db"
branch := "my-branch"

svc := &mock.MoveTablesService{
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (json.RawMessage, error) {
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (*ps.VtctldOperationReference, error) {
c.Assert(req.Workflow, qt.Equals, "my-workflow")
c.Assert(req.TargetKeyspace, qt.Equals, "target-ks")
c.Assert(req.SourceKeyspace, qt.Equals, "source-ks")
c.Assert(req.DeferSecondaryKeys, qt.IsNotNil)
c.Assert(*req.DeferSecondaryKeys, qt.IsFalse)
return json.RawMessage(`{"summary":"created"}`), nil
return &ps.VtctldOperationReference{ID: "create-op"}, nil
},
}

var buf bytes.Buffer
format := printer.JSON
p := printer.NewPrinter(&format)
p.SetResourceOutput(&buf)

ch := &cmdutil.Helper{
Printer: p,
Config: &config.Config{Organization: org},
Client: func() (*ps.Client, error) {
return &ps.Client{
MoveTables: svc,
vtctldSvc := &mock.VtctldService{
GetOperationFn: func(ctx context.Context, req *ps.GetVtctldOperationRequest) (*ps.VtctldOperation, error) {
return &ps.VtctldOperation{
ID: "create-op",
State: "completed",
Completed: true,
Result: json.RawMessage(`{"summary":"created"}`),
}, nil
},
}

var buf bytes.Buffer
ch := moveTablesTestHelper(org, svc, vtctldSvc, &buf)

cmd := MoveTablesCmd(ch)
cmd.SetArgs([]string{"create", db, branch,
"--workflow", "my-workflow",
Expand All @@ -155,17 +162,19 @@ func TestMoveTablesCreateWithDeferSecondaryKeysFalse(t *testing.T) {
err := cmd.Execute()
c.Assert(err, qt.IsNil)
c.Assert(svc.CreateFnInvoked, qt.IsTrue)
c.Assert(vtctldSvc.GetOperationFnInvoked, qt.IsTrue)
}

func TestMoveTablesCreateWithAllFlags(t *testing.T) {
c := qt.New(t)
setMoveTablesPollInterval(t, 0)

org := "my-org"
db := "my-db"
branch := "my-branch"

svc := &mock.MoveTablesService{
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (json.RawMessage, error) {
CreateFn: func(ctx context.Context, req *ps.MoveTablesCreateRequest) (*ps.VtctldOperationReference, error) {
c.Assert(req.Workflow, qt.Equals, "my-workflow")
c.Assert(req.TargetKeyspace, qt.Equals, "target-ks")
c.Assert(req.SourceKeyspace, qt.Equals, "source-ks")
Expand All @@ -176,25 +185,24 @@ func TestMoveTablesCreateWithAllFlags(t *testing.T) {
c.Assert(*req.AtomicCopy, qt.IsTrue)
c.Assert(req.AllTables, qt.IsNotNil)
c.Assert(*req.AllTables, qt.IsTrue)
return json.RawMessage(`{"summary":"created"}`), nil
return &ps.VtctldOperationReference{ID: "create-op"}, nil
},
}

var buf bytes.Buffer
format := printer.JSON
p := printer.NewPrinter(&format)
p.SetResourceOutput(&buf)

ch := &cmdutil.Helper{
Printer: p,
Config: &config.Config{Organization: org},
Client: func() (*ps.Client, error) {
return &ps.Client{
MoveTables: svc,
vtctldSvc := &mock.VtctldService{
GetOperationFn: func(ctx context.Context, req *ps.GetVtctldOperationRequest) (*ps.VtctldOperation, error) {
return &ps.VtctldOperation{
ID: "create-op",
State: "completed",
Completed: true,
Result: json.RawMessage(`{"summary":"created"}`),
}, nil
},
}

var buf bytes.Buffer
ch := moveTablesTestHelper(org, svc, vtctldSvc, &buf)

cmd := MoveTablesCmd(ch)
cmd.SetArgs([]string{"create", db, branch,
"--workflow", "my-workflow",
Expand All @@ -209,6 +217,8 @@ func TestMoveTablesCreateWithAllFlags(t *testing.T) {
err := cmd.Execute()
c.Assert(err, qt.IsNil)
c.Assert(svc.CreateFnInvoked, qt.IsTrue)
c.Assert(vtctldSvc.GetOperationFnInvoked, qt.IsTrue)
c.Assert(buf.String(), qt.JSONEquals, map[string]string{"summary": "created"})
}

func TestMoveTablesSwitchTrafficWithMaxLag(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions internal/mock/vtctld_move_tables.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
)

type MoveTablesService struct {
CreateFn func(context.Context, *ps.MoveTablesCreateRequest) (json.RawMessage, error)
CreateFn func(context.Context, *ps.MoveTablesCreateRequest) (*ps.VtctldOperationReference, error)
CreateFnInvoked bool

ShowFn func(context.Context, *ps.MoveTablesShowRequest) (json.RawMessage, error)
Expand All @@ -30,7 +30,7 @@ type MoveTablesService struct {
CompleteFnInvoked bool
}

func (s *MoveTablesService) Create(ctx context.Context, req *ps.MoveTablesCreateRequest) (json.RawMessage, error) {
func (s *MoveTablesService) Create(ctx context.Context, req *ps.MoveTablesCreateRequest) (*ps.VtctldOperationReference, error) {
s.CreateFnInvoked = true
return s.CreateFn(ctx, req)
}
Expand Down