Properly handle uncaught child/activity cancel during workflow cancel #71
Conversation
This file contains hidden or 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
Jul 13, 2022
Comment on lines
+1130
to
+1137
| if ( | ||
| self._cancel_requested | ||
| and ( | ||
| isinstance(err, temporalio.exceptions.ActivityError) | ||
| or isinstance(err, temporalio.exceptions.ChildWorkflowError) | ||
| ) | ||
| and isinstance(err.cause, temporalio.exceptions.CancelledError) | ||
| ): |
There was a problem hiding this comment.
Might make sense to just pull the part inside the first and clause out into a var to make it a bit easier to read
There was a problem hiding this comment.
Yeah, the auto-formatter we are forced to use makes this look ugly. It gets worse with a var:
activity_or_child = isinstance(
err, temporalio.exceptions.ActivityError
) or isinstance(err, temporalio.exceptions.ChildWorkflowError)
if (
self._cancel_requested
and activity_or_child
and isinstance(err.cause, temporalio.exceptions.CancelledError)
):
err = err.causeThe Python SDK looks much uglier because of this formatter, but it's the industry norm. It's also why few-hundred line files look like thousands.
There was a problem hiding this comment.
+1 to not loving black but it is the standard now so 🤷
bergundy
approved these changes
Jul 13, 2022
…lation # Conflicts: # temporalio/worker/workflow_instance.py
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
When a workflow cancel has ever been requested (even if it was a long time ago), we unwrap any activity or child workflow cancel error to be treated as a workflow error.
Why?
When not doing this, the workflow will be considered "failed" with an activity or child error even on uncaught cancel. The downside is that the workflow will be considered cancelled if, say, you disregarded a cancel a long time ago but then way later chose to manually cancel an activity and bubbled that error out. There is no good way to handle this rare situation.
Checklist