Updated cancellation documentation with detailed behavior and examples #49
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
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?s=80&v=4){kind=small}
Comment on lines
+63
to
+65
| For cancellation to work, the invocation must reach the deployment (the service endpoint must be reachable). | ||
|
|
||
| If the deployment is not reachable, cancellation will not work. In this case, use [kill](#kill) instead. |
There was a problem hiding this comment.
Could be made shorter in a single sentence
Comment on lines
+75
to
+80
| The cancellation exception (`TerminalError` in TypeScript/Python, `TerminalException` in Java/Kotlin) is thrown at the next **await point** - operations that wait for a result: | ||
| - Run actions: `ctx.run()` | ||
| - Request-response calls | ||
| - Sleep | ||
| - Awakeable resolution | ||
| - Promise combinators (e.g., `RestatePromise.all()`) |
There was a problem hiding this comment.
No need to enumerate them all, as they might change.
Suggested change
| The cancellation exception (`TerminalError` in TypeScript/Python, `TerminalException` in Java/Kotlin) is thrown at the next **await point** - operations that wait for a result: | |
| - Run actions: `ctx.run()` | |
| - Request-response calls | |
| - Sleep | |
| - Awakeable resolution | |
| - Promise combinators (e.g., `RestatePromise.all()`) | |
| The cancellation exception (`TerminalError` in TypeScript/Python, `TerminalException` in Java/Kotlin) is thrown at the next **await point** - operations that wait for a result, such as `ctx.run()`, call responses, sleeps, awakeable results, etc. |
Comment on lines
+82
to
+87
| Operations that are **not** await points will continue to execute and ignore cancellation: | ||
| - Setting and getting state | ||
| - Sending messages / one-way calls | ||
| - Delayed messages | ||
| - Deterministic UUID generation with the context (e.g., `ctx.uuid()`) | ||
| - Other non-blocking context operations |
There was a problem hiding this comment.
This one too is too much detailed IMO, plus wrong, get state is an await point. Just remove it.
Suggested change
| Operations that are **not** await points will continue to execute and ignore cancellation: | |
| - Setting and getting state | |
| - Sending messages / one-way calls | |
| - Delayed messages | |
| - Deterministic UUID generation with the context (e.g., `ctx.uuid()`) | |
| - Other non-blocking context operations |
| 1. **Propagate to leaves**: Cancellation first reaches the leaves of the call graph | ||
| 2. **Throw at await points**: Each handler receives the cancellation exception at its next await point | ||
| 3. **Run compensation**: Handlers execute their compensation logic (if defined) | ||
| 4. **Propagate upward**: Cancellation flows back up the call graph, allowing each parent to compensate |
There was a problem hiding this comment.
This is not fully right, and I think misleading written this way. The automatic propagation is only to leaves, and not to parents. the cancellation propagates upward if the user rethrows the error manually, or doesn't catch the exception, which btw is correct terminology really only in languages with exceptions/automatic error propagation, it doesn't apply to go and rust for example.
I would be prone to remove this line completely. It's clear enough that it throws an error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Clarified cancellation requirements, flow, and behavior based on Slack discussion. Added code example showing when cancellation exceptions are thrown at await points.
Created by Mintlify agent