Add a little detail on when heartbeat is seen from the activity side #650
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
cretz
requested review from
alexshtin,
bergundy,
mfateev,
mmcshane,
Spikhalskiy,
Sushisource and
vitarb
as code owners
cretz
commented
Nov 23, 2021
| // *CanceledError set as cause for *ActivityError. | ||
| // *CanceledError set as cause for *ActivityError. The context in the activity only becomes aware of the cancellation | ||
| // when a heartbeat is sent to the server. Since heartbeats may be batched internally, this could take up to the | ||
| // HeartbeatTimeout to appear or several minutes by default if that value is not set. |
There was a problem hiding this comment.
Technically it's only 80% of the timeout and technically the default is 10 minutes, but we leave that implementation detail out of the docs.
bergundy
approved these changes
Nov 23, 2021
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
Make clear an why activity context doesn't see its cancellation immediately without documenting too many details.
Why?
It is otherwise unclear when an activity can see its cancellation.
Checklist