Title: Preserve dispatch outcomes on teardown cancellation and document generator cleanup semantics · Issue #301 · microsoft/durabletask-python · GitHub
Open Graph Title: Preserve dispatch outcomes on teardown cancellation and document generator cleanup semantics · Issue #301 · microsoft/durabletask-python
X Title: Preserve dispatch outcomes on teardown cancellation and document generator cleanup semantics · Issue #301 · microsoft/durabletask-python
Description: Context Follow-up to merged PR #300. These items were raised in the review and remain follow-ups after merge. Closing the generator at the dispatch boundary is compatible with replay: the next dispatch reconstructs a fresh context and ge...
Open Graph Description: Context Follow-up to merged PR #300. These items were raised in the review and remain follow-ups after merge. Closing the generator at the dispatch boundary is compatible with replay: the next disp...
X Description: Context Follow-up to merged PR #300. These items were raised in the review and remain follow-ups after merge. Closing the generator at the dispatch boundary is compatible with replay: the next disp...
Opengraph URL: https://github.com/microsoft/durabletask-python/issues/301
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Preserve dispatch outcomes on teardown cancellation and document generator cleanup semantics","articleBody":"## Context\n\nFollow-up to merged PR [#300](https://github.com/microsoft/durabletask-python/pull/300). These items were raised in [the review](https://github.com/microsoft/durabletask-python/pull/300#pullrequestreview-5588884189) and remain follow-ups after merge.\n\nClosing the generator at the dispatch boundary is compatible with replay: the next dispatch reconstructs a fresh context and generator from history. The remaining work is to preserve dispatch outcomes when teardown raises cancellation and make the customer-visible finalizer contract explicit.\n\n## 1. Handle cancellation raised by generator teardown\n\nOriginal [inline comment](https://github.com/microsoft/durabletask-python/pull/300#discussion_r4328008675); [code at the reviewed commit](https://github.com/microsoft/durabletask-python/blob/2f85f4c535a7c723519c91a7c0431b446e99a672/durabletask/worker.py#L2354-L2368).\n\nThe handler around `ctx._generator.close()` catches `Exception`, but `asyncio.CancelledError` inherits from `BaseException`. An async bridge's finalizer can call `root.cancel()` followed by `loop.run_until_complete(root)`, causing cancellation to escape from `close()`.\n\nThat exception overrides the already-constructed `ExecutionResults`. The worker's outer `except Exception` also misses it, so it sends neither `CompleteOrchestratorTask` nor an abandonment request. Teardown cancellation can also mask a pending version-rejection `AbandonOrchestrationError`.\n\n- [ ] Handle `asyncio.CancelledError` raised by teardown explicitly, without indiscriminately swallowing `SystemExit` or `KeyboardInterrupt`.\n- [ ] Add regression coverage showing that teardown cancellation preserves a normal dispatch response and its delivery to the scheduler.\n- [ ] Add regression coverage showing that teardown cancellation does not replace version-rejection abandonment.\n\n## 2. Document the customer-visible finalizer semantics\n\nOriginal [inline comment](https://github.com/microsoft/durabletask-python/pull/300#discussion_r4328008685).\n\nAdd orchestration documentation, rather than relying only on the implementation comment, covering each of these nuances:\n\n- `close()` injects `GeneratorExit`, running active `finally` blocks and context-manager exits when a dispatch suspends, before its durable task completes. This can happen again on subsequent dispatches. These are per-dispatch resource-cleanup hooks, not orchestration-completion or exactly-once compensation hooks. Releasing an external resource here can affect an activity that is still running.\n- `ctx.is_replaying` is normally false during teardown after processing new events. Guarding a finalizer with `not ctx.is_replaying`, or using a replay-safe logger, does not make it run only at orchestration completion.\n- Durable actions, timer cancellation, custom-status changes, and `continue_as_new()` invoked only by forced teardown do not alter the saved response. Durable cleanup must remain in normal orchestration control flow.\n- Yielding a task while handling `GeneratorExit` raises `RuntimeError: generator ignored GeneratorExit`. Logging that warning does not mean the generator finished closing: it can remain suspended and retain resources. Distinguish forced teardown from a finalizer reached through normal replay/completion, where yielding durable cleanup can still work.\n- Garbage collection could already trigger finalization, so completion-only finalizer timing was never reliable. This change makes dispatch-boundary teardown explicit and synchronous; it does not provide a durable cleanup guarantee across process failure.\n\n- [ ] Document all of the above in the orchestration documentation.\n- [ ] Include a short example contrasting local resource teardown with workflow-level cleanup.\n\n## 3. Clarify the wording in all three changelogs\n\nOriginal [inline comment](https://github.com/microsoft/durabletask-python/pull/300#discussion_r4328008688).\n\nMatching `Unreleased` entries were added to all three affected packages before merge, so changelog coverage is already addressed. The remaining request is to align their wording with the documented lifecycle contract:\n\n- `CHANGELOG.md`\n- `durabletask-azuremanaged/CHANGELOG.md`\n- `azure-functions-durable/CHANGELOG.md`\n\nThe current phrase \"runs deterministically\" could be read as a guarantee of orchestration-level or exactly-once cleanup. State explicitly that generators close after each dispatch, including while waiting for durable work, so finalizers and context-manager exits can run before orchestration completion and repeat across dispatches.\n\n- [ ] Clarify the per-dispatch scope consistently in all three `Unreleased` entries.\n- [ ] Link to the finalizer-semantics documentation for the caveats about discarded teardown actions/status and yielding during close.","author":{"url":"https://github.com/andystaples","@type":"Person","name":"andystaples"},"datePublished":"2026-10-20T17:22:53Z","url":"https://github.com/microsoft/durabletask-python/issues/301"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:ca8bc01d-408e-c566-b665-b7b1d86a3f7a |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E054:1FBC18:C81280:118F871:6AFE2CD6 |
| html-safe-nonce | f61718eb0d579006ee4b5dd1de9a85d467e2dbe60533a1326820af41e4c393d4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMDU0OjFGQkMxODpDODEyODA6MTE4Rjg3MTo2QUZFMkNENiIsInZpc2l0b3JfaWQiOiI3NTIxMzQxNDA0NzkwNzk1NDc4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 175343c3848e9c2aacc0c6617f87f41a1b0e29f0acc955988a027598bf08baee |
| hovercard-subject-tag | issue:5946302777 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/durabletask-python/301/issue_layout |
| twitter:image | https://opengraph.githubassets.com/4b14d021832b2110fa5bb96ea258f1a2f9a273032181844f678e82e482724f93/microsoft/durabletask-python/issues/301 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/4b14d021832b2110fa5bb96ea258f1a2f9a273032181844f678e82e482724f93/microsoft/durabletask-python/issues/301 |
| og:image:alt | Context Follow-up to merged PR #300. These items were raised in the review and remain follow-ups after merge. Closing the generator at the dispatch boundary is compatible with replay: the next disp... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | andystaples |
| hostname | github.com |
| expected-hostname | github.com |
| None | e973f9ec3625f3faad8cac5c2d11a214b7ffe45f3cc563b828459b290ecaeed3 |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/durabletask-python git https://github.com/microsoft/durabletask-python.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 627664515 |
| octolytics-dimension-repository_nwo | microsoft/durabletask-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 627664515 |
| octolytics-dimension-repository_network_root_nwo | microsoft/durabletask-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 1f92c367595b9190e0be293896078033886b1913 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width