[WORKFLOW SDK FEATURE REQUEST] Retry WaitForInstanceCompletion/Start on a server-sent CANCELLED

未關閉

#1,246 建立於 2026年9月28日 0 則留言 0 個 reaction 已指派 0 人在 GitHub 檢視

維護者通常 3 天內回覆

還沒有人認領這個 Issue。

評估

難度: 4/5
預估耗時: 3-5 天
新手友好度: 55/100

Issue 類型: 功能
描述清晰度: 基本清楚
活躍度: 活躍
技術堆疊: python
領域: backend, distributed-systems

研究方向

Start in dapr/ext/workflow/_durabletask/client.py around lines 335-349 and the matching retry logic in aio/client.py. Read the three cancellation tests in tests/ext/workflow/durabletask/test_orchestration_wait.py and test_client_async.py, then confirm the intended retry and timeout behavior with maintainers. Done means both clients re-issue eligible waits after server CANCELLED responses while preserving caller deadlines and the updated tests pass.

由索引模型根據 Issue 內容生成。

描述

dapr-ext-workflow kind/enhancement

Proposal

wait_for_workflow_completion and wait_for_workflow_start (sync and aio) should re-issue WaitForInstanceCompletion / WaitForInstanceStart when the server ends the call with CANCELLED and the caller's own timeout hasn't expired. Today that status reaches the caller as an error, even though the workflow is still running. This asks maintainers to decide on the behaviour first, because it reverses assertions added in #1112. It's a proposal, not a PR.

Why the server sends CANCELLED

When daprd shuts down or restarts mid-wait (rollout, pod restart, hot-reload, a config change that restarts the runtime), the actors router cancels every in-flight call it tracks. The wait then returns CANCELLED "context canceled", even though the caller is still waiting. The mechanism and a repro are in dapr/dapr#10566.

Reproduced against native daprd 1.18.0:

a 60 s workflow with wait_for_workflow_completion(id) and no timeout returns normally;
the same run with daprd sent SIGTERM about 10 s in fails with StatusCode.CANCELLED "context canceled".

Why retrying is safe

A blocking unary call only gets CANCELLED from the server. The sync client can't cancel it mid-flight, and in the aio client a caller's cancellation raises asyncio.CancelledError, not AioRpcError. A client-side deadline shows up as DEADLINE_EXCEEDED, which already maps to TimeoutError.
The wait only reads state, so re-issuing it is idempotent. It returns straight away if the workflow already finished.

What would change

Add CANCELLED to the retried codes, when the caller's timeout hasn't expired, in _durabletask/client.py L335 and _durabletask/aio/client.py L230. _is_deadline_cancellation (L349) already turns a CANCELLED after the deadline into TimeoutError.
Restart the 30 s transient-retry window after each successful re-issue, rather than anchoring it on the first transient error. Otherwise a sidecar that restarts more than once during a long wait would still fail it.
These tests from #1112 currently assert that a CANCELLED reaches the caller, and would flip:

Relationship to the runtime fix

The proper fix is in daprd: return UNAVAILABLE in this case (dapr/dapr#10566). The SDK already retries UNAVAILABLE. This change would protect users on current and older runtimes until that ships, and it would still help afterwards with proxies that reset the stream.

Question for maintainers

Is it acceptable to treat a server-sent CANCELLED on these two waits as retryable, and change the #1112 tests? If yes, it's a small change in both clients plus tests.

主要語言: Python
星號: 273
分支: 155
平均合併: 3 天 13 小時
30 天內合併 PR: 11

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

沒有 Dockerfile 或 Docker Compose 檔案
有 Pull Request 範本
閱讀貢獻指南

從這裡開始

先讀完整個 Issue，再讀專案的貢獻指南。
在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
Fork 儲存庫，在一個分支上完成修改。
送出 Pull Request，並在描述裡引用這個 Issue 編號。

dapr/python-sdk 的其他 Issue

SDK Alignment of Workflow Examples
未關閉
- 哪裡不對？
dapr-ext-workflow good first issue kind/enhancement P2

難度 2/5 1-2 天新手友好度 72/100

dapr/python-sdk#853 · 4 則留言 · 2025年10月21日建立

維護者通常 3 天內回覆
[BUG] subscribe_with_handler stops silently: async task can die or be collected, sync retry path exits, handler errors reconnect the stream
未關閉
- 哪裡不對？
kind/bug

難度 4/5 3-5 天新手友好度 65/100

dapr/python-sdk#1233 · 2026年9月24日建立

維護者通常 3 天內回覆
[BUG] Configuration subscription stops permanently after the daprd sidecar restarts
未關閉
- 哪裡不對？
kind/bug

難度 4/5 3-5 天新手友好度 68/100

dapr/python-sdk#1232 · 2026年9月24日建立

維護者通常 3 天內回覆
[BUG] Streaming subscribe returns None after a reconnect, making test_streaming_subscribe_receives_published_message flaky
未關閉
- 哪裡不對？
kind/bug

難度 4/5 3-5 天新手友好度 45/100

dapr/python-sdk#1230 · 2026年9月24日建立

維護者通常 3 天內回覆
[WORKFLOW SDK BUG] Workflow constructors reject Unix-domain socket DAPR_GRPC_ENDPOINT
未關閉
- 哪裡不對？
dapr-ext-workflow kind/enhancement

難度 3/5 1-2 天新手友好度 78/100

dapr/python-sdk#1213 · 2026年9月14日建立

維護者通常 3 天內回覆

查看 dapr/python-sdk 的全部 Issue

相似的 Issue

Claiming namespace `apoint`
未關閉
- 哪裡不對？
namespace operations

難度 1/5 1 小時以內新手友好度 82/100

EclipseFdn/open-vsx.org#13573 · 2026年9月30日建立

維護者通常 1 天內回覆
[Bug] vRecur has BYWEEKDAY registered but that is not part of the standard
未關閉
- 哪裡不對？
難度 2/5 1-3 小時新手友好度 72/100

collective/icalendar#1854 · 2026年9月30日建立

維護者通常 1 天內回覆
The no-agent error message is wrong
未關閉
- 哪裡不對？
難度 2/5 1-3 小時新手友好度 72/100

rancher/rancher-ai-agent#412 · 2026年9月30日建立

維護者通常 6 天內回覆
Add a check in io.py, only check the existence for Path and string objects
未關閉
- 哪裡不對？
難度 2/5 1-3 小時新手友好度 84/100

TUDelftGeodesy/DePSI#134 · 2026年9月30日建立
`American "Acknowledgments" heading is misclassified and rendered after Introduction`
未關閉
- 哪裡不對？
難度 2/5 1-3 小時新手友好度 88/100

HenriquesLab/rxiv-maker#335 · 2026年9月30日建立

更多 Python Issue

[WORKFLOW SDK FEATURE REQUEST] Retry WaitForInstanceCompletion/Start on a server-sent CANCELLED

哪裡不對？

評估

研究方向

描述

Proposal

Why the server sends CANCELLED

Why retrying is safe

What would change

Relationship to the runtime fix

Question for maintainers

環境準備

從這裡開始

dapr/python-sdk 的其他 Issue

哪裡不對？

哪裡不對？

哪裡不對？

哪裡不對？

哪裡不對？

相似的 Issue

哪裡不對？

哪裡不對？

哪裡不對？

哪裡不對？

哪裡不對？

把新 issue 寄到你的電子郵件信箱