Skip to content

fix: correct misleading xdc-redirection note in workflow delete warning #1082

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

Closed
jiechenz wants to merge 1 commit into from
+11 −13
Closed

fix: correct misleading xdc-redirection note in workflow delete warning #1082

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
4 changes: 2 additions & 2 deletions internal/temporalcli/commands.gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3820,9 +3820,9 @@ func NewTemporalWorkflowDeleteCommand(cctx *CommandContext, parent *TemporalWork
s.Command.Use = "delete [flags]"
s.Command.Short = "Remove Workflow Execution"
if hasHighlighting {
s.Command.Long = "Delete a Workflow Execution and its Event History:\n\n\x1b[1mtemporal workflow delete \\\n --workflow-id YourWorkflowId\x1b[0m\n\nThe removal executes asynchronously. If the Execution is Running, the Service\nterminates it before deletion.\n\nWARNING: Deleting Workflow Executions in a global Namespace removes them from\nall replicas. Requests sent to a passive cluster are forwarded to the active\ncluster by default; to target the passive cluster directly, specify\n\x1b[1m--grpc-meta xdc-redirection=false\x1b[0m.\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See \x1b[1mtemporal batch --help\x1b[0m for a quick reference."
s.Command.Long = "Delete a Workflow Execution and its Event History:\n\n\x1b[1mtemporal workflow delete \\\n --workflow-id YourWorkflowId\x1b[0m\n\nThe removal executes asynchronously. If the Execution is Running, the Service\nterminates it before deletion.\n\nWARNING: In a global Namespace, deleting a Workflow Execution removes it from\nall clusters and cannot be undone.\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See \x1b[1mtemporal batch --help\x1b[0m for a quick reference."
} else {
s.Command.Long = "Delete a Workflow Execution and its Event History:\n\n```\ntemporal workflow delete \\\n --workflow-id YourWorkflowId\n```\n\nThe removal executes asynchronously. If the Execution is Running, the Service\nterminates it before deletion.\n\nWARNING: Deleting Workflow Executions in a global Namespace removes them from\nall replicas. Requests sent to a passive cluster are forwarded to the active\ncluster by default; to target the passive cluster directly, specify\n`--grpc-meta xdc-redirection=false`.\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See `temporal batch --help` for a quick reference."
s.Command.Long = "Delete a Workflow Execution and its Event History:\n\n```\ntemporal workflow delete \\\n --workflow-id YourWorkflowId\n```\n\nThe removal executes asynchronously. If the Execution is Running, the Service\nterminates it before deletion.\n\nWARNING: In a global Namespace, deleting a Workflow Execution removes it from\nall clusters and cannot be undone.\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation. See `temporal batch --help` for a quick reference."
}
s.Command.Args = cobra.NoArgs
s.SingleWorkflowOrBatchOptions.BuildFlags(s.Command.Flags())
Expand Down
2 changes: 1 addition & 1 deletion internal/temporalcli/commands.workflow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import (

const metadataQueryName = "__temporal_workflow_metadata"

const workflowDeleteWarning = "WARNING: Deleting Workflow Executions in a global Namespace removes them from all replicas. Requests sent to a passive cluster are forwarded to the active cluster by default; to target the passive cluster directly, specify `--grpc-meta xdc-redirection=false`."
const workflowDeleteWarning = "WARNING: In a global Namespace, deleting a Workflow Execution removes it from all clusters and cannot be undone."

func (c *TemporalWorkflowCancelCommand) run(cctx *CommandContext, args []string) error {
cl, err := dialClient(cctx, &c.Parent.ClientOptions)
Expand Down
12 changes: 6 additions & 6 deletions internal/temporalcli/commands.workflow_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,8 @@ func (s *SharedServerSuite) TestWorkflow_Delete_SingleWorkflowRequiresConfirmati
)
s.EqualError(res.Err, "user denied confirmation")
// Dev-server's default namespace is non-global, so the warning is suppressed.
s.NotContains(res.Stdout.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stderr.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stdout.String(), "removes it from all clusters and cannot be undone")
s.NotContains(res.Stderr.String(), "removes it from all clusters and cannot be undone")
}

func (s *SharedServerSuite) TestWorkflow_Delete_SingleWorkflowSuccess() {
Expand All @@ -203,8 +203,8 @@ func (s *SharedServerSuite) TestWorkflow_Delete_SingleWorkflowSuccess() {
"--yes",
)
s.NoError(res.Err)
s.NotContains(res.Stdout.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stderr.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stdout.String(), "removes it from all clusters and cannot be undone")
s.NotContains(res.Stderr.String(), "removes it from all clusters and cannot be undone")
s.Contains(res.Stdout.String(), "Delete workflow succeeded")
}

Expand Down Expand Up @@ -252,8 +252,8 @@ func (s *SharedServerSuite) TestWorkflow_Delete_BatchWorkflowSuccess() {
)
s.NoError(res.Err)
s.Contains(res.Stdout.String(), "Start batch against workflows matching query")
s.NotContains(res.Stdout.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stderr.String(), "Deleting Workflow Executions in a global Namespace")
s.NotContains(res.Stdout.String(), "removes it from all clusters and cannot be undone")
s.NotContains(res.Stderr.String(), "removes it from all clusters and cannot be undone")

// Confirm workflows were deleted
s.Eventually(func() bool {
Expand Down
6 changes: 2 additions & 4 deletions internal/temporalcli/commands.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3641,10 +3641,8 @@ commands:
The removal executes asynchronously. If the Execution is Running, the Service
terminates it before deletion.

WARNING: Deleting Workflow Executions in a global Namespace removes them from
all replicas. Requests sent to a passive cluster are forwarded to the active
cluster by default; to target the passive cluster directly, specify
`--grpc-meta xdc-redirection=false`.
WARNING: In a global Namespace, deleting a Workflow Execution removes it from
all clusters and cannot be undone.

Visit https://docs.temporal.io/visibility to read more about Search Attributes
and Query creation. See `temporal batch --help` for a quick reference.
Expand Down
Loading