Clarify semantic of cancel wf commands #849
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sushisource
approved these changes
Dec 3, 2024
| None => { | ||
| return Err(WFMachinesError::Fatal( | ||
| "Cancel external workflow command had empty target field" | ||
| let we: NamespacedWorkflowExecution = |
There was a problem hiding this comment.
The type hint should be unnecessary
There was a problem hiding this comment.
Removed the type hint + use ok_or_else instead of a match expression.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was changed
RequestCancelExternalWorkflowExecutioncommand indicating thatCancelChildWorkflowExecutionshould be prefered for cancellation of child workflows, and removed thechild_workflow_idtarget on the former to avoid confusion.Why
CancelUnstartedChildWorkflowExecutioncommand might fail if Workflow tries to cancel child workflow before getting notified of start event #331, we simplified child workflow cancellation command so that lang would simply request cancellation of the child workflow, and core would decide either to actually emit a cancellation command to the server. However,RequestCancelExternalWorkflowExecution.target.child_workflow_idhas not been removed, and no comment had been added, resulting in some confusion as to which API should be used in new code.