[WORKFLOW SDK FEATURE REQUEST] Retry WaitForInstanceCompletion/Start on a server-sent CANCELLED
Mantenedores costumam responder em até 2 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- backend, distributed-systems
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
SIGTERMabout 10 s in fails withStatusCode.CANCELLED"context canceled".
Why retrying is safe
- A blocking unary call only gets
CANCELLEDfrom the server. The sync client can't cancel it mid-flight, and in the aio client a caller's cancellation raisesasyncio.CancelledError, notAioRpcError. A client-side deadline shows up asDEADLINE_EXCEEDED, which already maps toTimeoutError. - The wait only reads state, so re-issuing it is idempotent. It returns straight away if the workflow already finished.
What would change
- Add
CANCELLEDto the retried codes, when the caller's timeout hasn't expired, in_durabletask/client.pyL335 and_durabletask/aio/client.pyL230._is_deadline_cancellation(L349) already turns aCANCELLEDafter the deadline intoTimeoutError. - 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
CANCELLEDreaches 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.
- Linguagem predominante
- Python
- Estrelas
- 272
- Forks
- 152
- Merge médio
- 2d 22h
- PRs com merge (30d)
- 7
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de dapr/python-sdk
-
dapr-ext-workflow good first issue kind/enhancement P2
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 72/100
dapr/python-sdk#853 · 4 comentários ·
Mantenedores costumam responder em até 2 dias
-
kind/bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 65/100
dapr/python-sdk#1233 ·
Mantenedores costumam responder em até 2 dias
-
kind/bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 68/100
dapr/python-sdk#1232 ·
Mantenedores costumam responder em até 2 dias
-
kind/bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 45/100
dapr/python-sdk#1230 ·
Mantenedores costumam responder em até 2 dias
-
dapr-ext-workflow kind/enhancement
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 78/100
dapr/python-sdk#1213 ·
Mantenedores costumam responder em até 2 dias
Todas as issues de dapr/python-sdk
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
-
bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
qgis/QGIS-Plugins-Website#459 ·
-
bug severity:medium
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 2 dias
-
bot-found bug priority: P3
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
madenvel/KalinkaPlayer#179 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
ls1intum/edutelligence#1098 ·
Mantenedores costumam responder em até 1 dia