Azure / Azure/azure-functions-durable-python

LongTimerTask isn't cancelling properly

未关闭
#573 2 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
bug fixed-in-v2 P2
主要语言
Python
星标
157
派生
70
平均合并
2 天 10 小时
30 天内合并 PR
2

描述

🐛 **Describe the bug**
I am trying to build an approval workflow, and the deadline for approvals is two weeks.

```
@bp.orchestration_trigger(context_name="context")
def test_long_timer(context: df.DurableOrchestrationContext):
deadline = context.current_utc_datetime + timedelta(days=14)
approval_event_task = context.wait_for_external_event("testapproval")
timeout_task = context.create_timer(deadline)

winner = yield context.task_any([approval_event_task, timeout_task])
if winner == approval_event_task:
timeout_task.cancel()
return True
elif winner == timeout_task:
return False
```
If I get an approval event, the timeout_task attempts to cancel, and the function tries to exit. Now if the days is only 1 or 2, we get TimerTask, and everything works as expected. However since the days is 14, we get a LongTimerTask, and the cancellation doesn't work on it. The result is the function exits, but the framework wont mark it completed until the LongTimer completes.

🤔 **Expected behavior**
After cancelling the long_time_task, the function should have been able to complete, instead of waiting for the LongTimerTask to complete first.

☕ **Steps to reproduce**
Using the code above, after sending a 'testapproval' event, you will see the orchestration wont complete.

⚡**If deployed to Azure**
This was failing locally while developing using Azurite, and after deploying to Azure using default Storage

**Hack, possible clues**
So I figured the issue here could be:
* the timeout task is stuck in 'running' state
* given the LongTimerTask is a CompositeTask, the cancelation were not being applied to all children.

I really am not sure why, but this solved the problem, however I am unsure if it created more problems down the line.

```
if winner == approval_event_task:
timeout_task.cancel()

# Cancel Timer Hack
if isinstance(timeout_task, azure.durable_functions.models.Task.LongTimerTask):
for child in timeout_task.pending_tasks:
child.cancel()
timeout_task.set_value(False, None)
# End Hack

return True
```
After putting in this code, it just works as expect, but I hate the hack.

**Aside note**
I find this framework incredibly useful, but it is SO HARD to understand what is really happening. Are there any good articles on how this is all hanging together. Like what tasks are, how they relate to actions, and I can't for the life of me workout how task/actions are scheduled, or where the magic runtime is that ordinates all this logic. Any leads would be great (don't say the normal documentation, I want the nitty gritty details). I am not expected anyone to write that up, just hoping it somewhere in a niche corner of the web

贡献指南

打开贡献指南

调研方向

首先使用提供的编排重现该问题,并比较取消一到两天计时器与取消 14 天计时器的情况。阅读 azure.durable_functions.models.Task 中的 LongTimerTask 和 CompositeTask,然后验证批准事件后,编排可以完成而无需等待长计时器。

由索引模型根据 Issue 内容生成。

评估

技术栈
azure, python
领域
backend, cloud, distributed-systems
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。