Clarity on client thread safety and sync activity cancel #189
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
bergundy
reviewed
Nov 4, 2022
| react appropriately. An activity must heartbeat to receive cancellation and there are other ways to be notified about | ||
| cancellation (see "Activity Context" and "Heartbeating and Cancellation" later). | ||
| react appropriately. If after cancellation is obtained an unwrapped `temporalio.exceptions.CancelledError` is raised, | ||
| the activity will be marked cancelled. An activity must heartbeat to receive cancellation and there are other ways to be |
There was a problem hiding this comment.
Should we mention heartbeating only applies to non-local activities?
There was a problem hiding this comment.
Maybe. It seems most of our documents don't make this differentiation, e.g. https://docs.temporal.io/application-development/features#activity-heartbeats. Note that doesn't say a thing about "local" wrt heartbeats. Hopefully this doc is removed in favor of that one. Let's try to get it right there.
bergundy
approved these changes
Nov 4, 2022
Quinn-With-Two-Ns
approved these changes
Nov 4, 2022
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
CancelledErrorto have an activity appear as cancelled (we are still discussing internally if we can do this better)Checklist