Skip to content

Commit c379eed

Browse files
iheanyiiheanyi
authored
Add confirmation for potentially dangerous workflow actions (#1010)
* Add confirmation for switch traffic * Update tests * Simplify flags * Implement confirmation for cutover command * Fix test * Better copy * Implement confirmation for workflow cancellation * Fix up strings * Better copy * Inline string literal * Fix typo
1 parent d0543aa commit c379eed

File tree

6 files changed

+145
-17
lines changed

6 files changed

+145
-17
lines changed

‎internal/cmd/workflow/cancel.go

+37
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
package workflow
22

33
import (
4+
"errors"
45
"fmt"
6+
"os"
57
"strconv"
68

9+
"github.com/AlecAivazis/survey/v2"
10+
"github.com/AlecAivazis/survey/v2/terminal"
711
"github.com/planetscale/cli/internal/cmdutil"
812
"github.com/planetscale/cli/internal/printer"
913
ps "github.com/planetscale/planetscale-go/planetscale"
1014
"github.com/spf13/cobra"
1115
)
1216

1317
func CancelCmd(ch *cmdutil.Helper) *cobra.Command {
18+
var force bool
19+
1420
cmd := &cobra.Command{
1521
Use: "cancel <database> <number>",
1622
Short: "Cancel a workflow that is in progress",
@@ -32,6 +38,35 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
3238
return err
3339
}
3440

41+
if !force {
42+
if ch.Printer.Format() != printer.Human {
43+
return fmt.Errorf("cannot cancel workflow with the output format %q (run with -force to override)", ch.Printer.Format())
44+
}
45+
46+
if !printer.IsTTY {
47+
return fmt.Errorf("cannot confirm cancellation (run with -force to override)")
48+
}
49+
50+
prompt := &survey.Confirm{
51+
Message: "Are you sure you want to cancel this workflow?",
52+
Default: false,
53+
}
54+
55+
var confirm bool
56+
err = survey.AskOne(prompt, &confirm)
57+
if err != nil {
58+
if err == terminal.InterruptErr {
59+
os.Exit(0)
60+
} else {
61+
return err
62+
}
63+
}
64+
65+
if !confirm {
66+
return errors.New("cancellation not confirmed, skipping workflow cancellation")
67+
}
68+
}
69+
3570
end := ch.Printer.PrintProgress(fmt.Sprintf("Cancelling workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
3671
defer end()
3772

@@ -63,5 +98,7 @@ marks it as cancelled, allowing you to start a new workflow if needed.`,
6398
},
6499
}
65100

101+
cmd.Flags().BoolVar(&force, "force", false, "Force cancel the workflow without confirmation")
102+
66103
return cmd
67104
}

‎internal/cmd/workflow/cancel_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func TestWorkflow_CancelCmd(t *testing.T) {
8181
}
8282

8383
cmd := CancelCmd(ch)
84-
cmd.SetArgs([]string{db, "123"})
84+
cmd.SetArgs([]string{db, "123", "--force"})
8585
err := cmd.Execute()
8686

8787
c.Assert(err, qt.IsNil)
@@ -122,7 +122,7 @@ func TestWorkflow_CancelCmd_Error(t *testing.T) {
122122
}
123123

124124
cmd := CancelCmd(ch)
125-
cmd.SetArgs([]string{db, "123"})
125+
cmd.SetArgs([]string{db, "123", "--force"})
126126
err := cmd.Execute()
127127

128128
c.Assert(err, qt.Not(qt.IsNil))

‎internal/cmd/workflow/cutover.go

+53
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
package workflow
22

33
import (
4+
"errors"
45
"fmt"
6+
"os"
57
"strconv"
68

9+
"github.com/AlecAivazis/survey/v2"
10+
"github.com/AlecAivazis/survey/v2/terminal"
711
"github.com/planetscale/cli/internal/cmdutil"
812
"github.com/planetscale/cli/internal/printer"
913
ps "github.com/planetscale/planetscale-go/planetscale"
1014
"github.com/spf13/cobra"
1115
)
1216

1317
func CutoverCmd(ch *cmdutil.Helper) *cobra.Command {
18+
var force bool
19+
1420
cmd := &cobra.Command{
1521
Use: "cutover <database> <number>",
1622
Short: "Completes the workflow, cutting over all traffic to the target keyspace.",
@@ -31,6 +37,51 @@ func CutoverCmd(ch *cmdutil.Helper) *cobra.Command {
3137
return err
3238
}
3339

40+
if !force {
41+
if ch.Printer.Format() != printer.Human {
42+
return fmt.Errorf("cannot cutover with the output format %q (run with -force to override)", ch.Printer.Format())
43+
}
44+
45+
if !printer.IsTTY {
46+
return fmt.Errorf("cannot confirm cutover (run with -force to override)")
47+
}
48+
49+
workflow, err := client.Workflows.Get(ctx, &ps.GetWorkflowRequest{
50+
Organization: ch.Config.Organization,
51+
Database: db,
52+
WorkflowNumber: number,
53+
})
54+
if err != nil {
55+
switch cmdutil.ErrCode(err) {
56+
case ps.ErrNotFound:
57+
return fmt.Errorf("database %s or workflow %s does not exist in organization %s",
58+
printer.BoldBlue(db), printer.BoldBlue(number), printer.BoldBlue(ch.Config.Organization))
59+
default:
60+
return cmdutil.HandleError(err)
61+
}
62+
}
63+
64+
confirmationMessage := fmt.Sprintf("Are you sure you want to cutover? This will delete the moved tables from %s and replication between %s and %s will end.", workflow.SourceKeyspace.Name, workflow.SourceKeyspace.Name, workflow.TargetKeyspace.Name)
65+
prompt := &survey.Confirm{
66+
Message: confirmationMessage,
67+
Default: false,
68+
}
69+
70+
var confirm bool
71+
err = survey.AskOne(prompt, &confirm)
72+
if err != nil {
73+
if err == terminal.InterruptErr {
74+
os.Exit(0)
75+
} else {
76+
return err
77+
}
78+
}
79+
80+
if !confirm {
81+
return errors.New("cutover not confirmed, skipping cutover")
82+
}
83+
}
84+
3485
end := ch.Printer.PrintProgress(fmt.Sprintf("Completing workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
3586
defer end()
3687

@@ -61,5 +112,7 @@ func CutoverCmd(ch *cmdutil.Helper) *cobra.Command {
61112
},
62113
}
63114

115+
cmd.Flags().BoolVar(&force, "force", false, "Force the cutover without prompting for confirmation.")
116+
64117
return cmd
65118
}

‎internal/cmd/workflow/cutover_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ func TestWorkflow_CutoverCmd(t *testing.T) {
8383
}
8484

8585
cmd := CutoverCmd(ch)
86-
cmd.SetArgs([]string{db, "123"})
86+
cmd.SetArgs([]string{db, "123", "--force"})
8787
err := cmd.Execute()
8888

8989
c.Assert(err, qt.IsNil)
@@ -124,7 +124,7 @@ func TestWorkflow_CutoverCmd_Error(t *testing.T) {
124124
}
125125

126126
cmd := CutoverCmd(ch)
127-
cmd.SetArgs([]string{db, "123"})
127+
cmd.SetArgs([]string{db, "123", "--force"})
128128
err := cmd.Execute()
129129

130130
c.Assert(err, qt.Not(qt.IsNil))

‎internal/cmd/workflow/switch_traffic.go

+48-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
package workflow
22

33
import (
4+
"errors"
45
"fmt"
6+
"os"
57
"strconv"
68

9+
"github.com/AlecAivazis/survey/v2"
10+
"github.com/AlecAivazis/survey/v2/terminal"
711
"github.com/planetscale/cli/internal/cmdutil"
812
"github.com/planetscale/cli/internal/printer"
913
ps "github.com/planetscale/planetscale-go/planetscale"
1014
"github.com/spf13/cobra"
1115
)
1216

13-
type switchTrafficFlags struct {
14-
replicasOnly bool
15-
}
16-
1717
func SwitchTrafficCmd(ch *cmdutil.Helper) *cobra.Command {
18-
var flags switchTrafficFlags
18+
var replicasOnly bool
19+
var force bool
1920

2021
cmd := &cobra.Command{
2122
Use: "switch-traffic <database> <number>",
@@ -41,22 +42,58 @@ By default, this command will route all queries for primary, replica, and read-o
4142
var workflow *ps.Workflow
4243
var end func()
4344

44-
if flags.replicasOnly {
45-
end = ch.Printer.PrintProgress(fmt.Sprintf("Switching query traffic from replica and read-only tablets to the target keyspace for workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
45+
if !force {
46+
if ch.Printer.Format() != printer.Human {
47+
return fmt.Errorf("cannot switch query traffic with the output format %q (run with -force to override)", ch.Printer.Format())
48+
}
49+
50+
if !printer.IsTTY {
51+
return fmt.Errorf("cannot confirm switching query traffic (run with -force to override)")
52+
}
53+
54+
confirmationMessage := "Are you sure you want to enable primary mode for this database?"
55+
if replicasOnly {
56+
confirmationMessage = "Are you sure you want to enable replica mode for this database?"
57+
}
58+
59+
prompt := &survey.Confirm{
60+
Message: confirmationMessage,
61+
Default: false,
62+
}
63+
64+
var confirm bool
65+
err := survey.AskOne(prompt, &confirm)
66+
if err != nil {
67+
if err == terminal.InterruptErr {
68+
os.Exit(0)
69+
} else {
70+
return err
71+
}
72+
}
73+
74+
if !confirm {
75+
return errors.New("switch traffic not confirmed, skipping switch traffic")
76+
}
77+
}
78+
79+
if replicasOnly {
80+
end = ch.Printer.PrintProgress(fmt.Sprintf("Switching query traffic from replica and read-only tablets to the target keyspace for workflow %s in database %s...", printer.BoldBlue(number), printer.BoldBlue(db)))
4681
workflow, err = client.Workflows.SwitchReplicas(ctx, &ps.SwitchReplicasWorkflowRequest{
4782
Organization: ch.Config.Organization,
4883
Database: db,
4984
WorkflowNumber: number,
5085
})
5186
} else {
52-
end = ch.Printer.PrintProgress(fmt.Sprintf("Switching query traffic from primary, replica, and read-only tablets to the target keyspace for workflow %s in database %s…", printer.BoldBlue(number), printer.BoldBlue(db)))
87+
end = ch.Printer.PrintProgress(fmt.Sprintf("Switching query traffic from primary, replica, and read-only tablets to the target keyspace for workflow %s in database %s...", printer.BoldBlue(number), printer.BoldBlue(db)))
5388
workflow, err = client.Workflows.SwitchPrimaries(ctx, &ps.SwitchPrimariesWorkflowRequest{
5489
Organization: ch.Config.Organization,
5590
Database: db,
5691
WorkflowNumber: number,
5792
})
5893
}
94+
5995
defer end()
96+
6097
if err != nil {
6198
switch cmdutil.ErrCode(err) {
6299
case ps.ErrNotFound:
@@ -69,7 +106,7 @@ By default, this command will route all queries for primary, replica, and read-o
69106
end()
70107

71108
if ch.Printer.Format() == printer.Human {
72-
if flags.replicasOnly {
109+
if replicasOnly {
73110
ch.Printer.Printf("Successfully switched query traffic from replica and read-only tablets to target keyspace for workflow %s in database %s.\n",
74111
printer.BoldBlue(workflow.Name),
75112
printer.BoldBlue(db),
@@ -87,7 +124,8 @@ By default, this command will route all queries for primary, replica, and read-o
87124
},
88125
}
89126

90-
cmd.Flags().BoolVar(&flags.replicasOnly, "replicas-only", false, "Route read queries from the replica and read-only tablets to the target keyspace.")
127+
cmd.Flags().BoolVar(&replicasOnly, "replicas-only", false, "Route read queries from the replica and read-only tablets to the target keyspace.")
128+
cmd.Flags().BoolVar(&force, "force", false, "Force the switch traffic operation without prompting for confirmation.")
91129

92130
return cmd
93131
}

‎internal/cmd/workflow/switch_traffic_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func TestWorkflow_SwitchTrafficCmd_Primaries(t *testing.T) {
8181
}
8282

8383
cmd := SwitchTrafficCmd(ch)
84-
cmd.SetArgs([]string{db, "123"})
84+
cmd.SetArgs([]string{db, "123", "--force"})
8585
err := cmd.Execute()
8686

8787
c.Assert(err, qt.IsNil)
@@ -155,7 +155,7 @@ func TestWorkflow_SwitchTrafficCmd_Replicas(t *testing.T) {
155155
}
156156

157157
cmd := SwitchTrafficCmd(ch)
158-
cmd.SetArgs([]string{db, "123", "--replicas-only"})
158+
cmd.SetArgs([]string{db, "123", "--replicas-only", "--force"})
159159
err := cmd.Execute()
160160

161161
c.Assert(err, qt.IsNil)
@@ -196,7 +196,7 @@ func TestWorkflow_SwitchTrafficCmd_Error(t *testing.T) {
196196
}
197197

198198
cmd := SwitchTrafficCmd(ch)
199-
cmd.SetArgs([]string{db, "123"})
199+
cmd.SetArgs([]string{db, "123", "--force"})
200200
err := cmd.Execute()
201201

202202
c.Assert(err, qt.Not(qt.IsNil))

0 commit comments

Comments
 (0)