Populate timer origin field by acroca · Pull Request #976 · dapr/python-sdk

acroca · 2026-04-10T13:13:26Z

Rebuilt latest protos
Populate the new origin field in timers.
Introduce automatic timer for wait_for_external_event to create a timer associated with such event. Other SDKs follow this same approach.

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Copilot

Pull request overview

This PR updates the durable workflow SDK to populate the newly added protobuf origin oneof on timer actions/events, and extends wait_for_external_event to support optional timeouts by internally scheduling a timer (or a far-future timer when no timeout is provided), aligning behavior with other SDKs.

Changes:

Add a timeout parameter to wait_for_external_event across the public context APIs and implement it via a composite task that races the external event against a timer.
Populate timer origin metadata for user timers (create_timer), external-event wait timers, and retry delay timers (activity + child workflow).
Rebuild protobuf Python outputs/stubs and add/adjust unit tests for the new timer-origin behavior.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
ext/dapr-ext-workflow/tests/durabletask/test_orchestration_executor.py	Updates existing external-event tests for the new “auto timer” behavior and adds new assertions/tests around timer origin fields.
ext/dapr-ext-workflow/dapr/ext/workflow/workflow_context.py	Extends the public workflow context interface to support `wait_for_external_event(..., timeout=...)`.
ext/dapr-ext-workflow/dapr/ext/workflow/dapr_workflow_context.py	Threads the new `timeout` keyword through the public wrapper context to the underlying durable task context.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py	Sets timer origins for create-timer and retry timers, and implements external-event timeout/far-future timer scheduling.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py	Adds `ExternalEventWithTimeoutTask` composite task and updates the orchestration context contract for the new timeout parameter.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py	Extends timer action helper to populate the correct origin oneof field.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/orchestrator_actions_pb2.pyi	Regenerated protobuf typing stubs for new timer origin fields.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/orchestrator_actions_pb2.py	Regenerated protobuf runtime code for new timer origin fields.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/history_events_pb2.pyi	Regenerated protobuf typing stubs for new timer origin fields on history events.
ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/history_events_pb2.py	Regenerated protobuf runtime code for new timer origin fields on history events.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

ext/dapr-ext-workflow/tests/durabletask/test_orchestration_executor.py

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

ext/dapr-ext-workflow/dapr/ext/workflow/workflow_context.py

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

codecov · 2026-04-13T15:26:39Z

Codecov Report

❌ Patch coverage is 87.87879% with 68 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.93%. Comparing base (bffb749) to head (7805f97).
⚠️ Report is 99 commits behind head on main.

Files with missing lines	Patch %	Lines
...rkflow/_durabletask/internal/history_events_pb2.py	3.70%	26 Missing ⚠️
...w/tests/durabletask/test_orchestration_executor.py	94.35%	22 Missing ⚠️
.../_durabletask/internal/orchestrator_actions_pb2.py	8.33%	11 Missing ⚠️
...xt-workflow/dapr/ext/workflow/_durabletask/task.py	83.33%	6 Missing ⚠️
...dapr/ext/workflow/_durabletask/internal/helpers.py	96.87%	1 Missing ⚠️
...-workflow/dapr/ext/workflow/_durabletask/worker.py	98.27%	1 Missing ⚠️
...orkflow/dapr/ext/workflow/dapr_workflow_context.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #976      +/-   ##
==========================================
- Coverage   86.63%   80.93%   -5.70%     
==========================================
  Files          84      136      +52     
  Lines        4473    13090    +8617     
==========================================
+ Hits         3875    10594    +6719     
- Misses        598     2496    +1898

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py

Signed-off-by: Albert Callarisa <albert@diagrid.io>

sicoyle

nice job 👏 👏 👏 🙌 few comments so far and I've reviewed mostttt files

sicoyle · 2026-04-14T13:44:01Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

 import dapr.ext.workflow._durabletask.internal.protos as pb
 from google.protobuf import timestamp_pb2, wrappers_pb2

+TimerOrigin = Union[


can you mv these changes into a timer.py file instead of adding to the helpers.py pls

sicoyle · 2026-04-14T13:45:59Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

+def is_optional_timer_action(action: pb.WorkflowAction) -> bool:
+    """Returns True if the action is an optional TimerOriginExternalEvent timer
+    with the sentinel fireAt — i.e. created by an indefinite wait_for_external_event.
+
+    Pre-patch histories (from prior SDK versions that didn't schedule a timer for
+    indefinite waits) won't carry a matching TimerCreatedEvent; the replay logic
+    uses this check to drop the optional action and shift sequence ids.
+    """
+    if not action.HasField('createTimer'):
+        return False
+    timer = action.createTimer
+    if timer.WhichOneof('origin') != 'externalEvent':
+        return False
+    return (
+        timer.fireAt.seconds == OPTIONAL_TIMER_FIRE_AT.seconds
+        and timer.fireAt.nanos == OPTIONAL_TIMER_FIRE_AT.nanos
+    )
+
+
+def is_optional_timer_event(event: pb.HistoryEvent) -> bool:
+    """Returns True if a TimerCreatedEvent is the optional sentinel timer.
+
+    For replay compatibility, treat a timerCreated event with the sentinel
+    fireAt as optional even if the proto3 ``origin`` oneof is unset (e.g. when
+    reading histories emitted by older sidecars that didn't populate it). When
+    ``origin`` *is* populated, it must match TimerOriginExternalEvent.
+    """
+    if not event.HasField('timerCreated'):
+        return False
+    timer = event.timerCreated
+    if (
+        timer.fireAt.seconds != OPTIONAL_TIMER_FIRE_AT.seconds
+        or timer.fireAt.nanos != OPTIONAL_TIMER_FIRE_AT.nanos
+    ):
+        return False
+    origin = timer.WhichOneof('origin')
+    return origin in (None, 'externalEvent')
+


these look almost like the same func... can we create a helper for the same logic between the two?

sicoyle · 2026-04-14T13:47:05Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

+        timer.fireAt.seconds == OPTIONAL_TIMER_FIRE_AT.seconds
+        and timer.fireAt.nanos == OPTIONAL_TIMER_FIRE_AT.nanos


will both always be set?

sicoyle · 2026-04-14T13:47:20Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

+        timer.fireAt.seconds != OPTIONAL_TIMER_FIRE_AT.seconds
+        or timer.fireAt.nanos != OPTIONAL_TIMER_FIRE_AT.nanos


why is this one or if the func above uses and for this check?

sicoyle · 2026-04-14T13:48:10Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py

@@ -202,10 +272,20 @@ def new_workflow_version_not_available_action(
    )


-def new_create_timer_action(id: int, fire_at: datetime) -> pb.WorkflowAction:
-    timestamp = timestamp_pb2.Timestamp()
-    timestamp.FromDatetime(fire_at)
-    return pb.WorkflowAction(id=id, createTimer=pb.CreateTimerAction(fireAt=timestamp))
+def new_create_timer_action(
+    id: int,
+    fire_at: Union[datetime, timestamp_pb2.Timestamp],
+    origin: Optional[TimerOrigin] = None,
+) -> pb.WorkflowAction:
+    if isinstance(fire_at, timestamp_pb2.Timestamp):
+        timestamp = fire_at


consistency between timer_id and id params between the two funcs and also vars within on the ts vs timestamp for the same thing pls

sicoyle · 2026-04-14T13:49:22Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/history_events_pb2.pyi

+
+    DESCRIPTOR: _descriptor.Descriptor
+
+    TASKEXECUTIONID_FIELD_NUMBER: _builtins.int


Suggested change

TASKEXECUTIONID_FIELD_NUMBER: _builtins.int

TASK_EXECUTION_ID_FIELD_NUMBER: _builtins.int

why do we need to track the field number for this? can it just be TASK_EXECUTION_ID instead?

sicoyle · 2026-04-14T13:52:22Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

+            * ``None`` (default) or a *negative* ``timedelta`` — wait indefinitely.
+              An optional sentinel timer is scheduled internally for runtime
+              tracking, but ``TimeoutError`` is never raised on its own.
+            * ``timedelta(0)`` — do not wait at all. The returned task fails
+              immediately with ``TimeoutError``.
+            * A future ``datetime`` or a positive ``timedelta`` — wait until
+              that deadline / for that duration; ``TimeoutError`` is raised if
+              the event has not been received in time.


which of these does plain 0 fall under? How do these compare to the other SDK timeout field defaults? How does this compare to other workflow providers for default behaviors?

sicoyle · 2026-04-14T13:52:40Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

+        wait_for_external_event being canceled before any history event arrives.
+        """
+        if self._is_complete:
+            raise ValueError('The task has already completed.')


should this instead be a noop?

sicoyle · 2026-04-14T13:54:08Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

+        if self.is_complete:
+            return
+        if completed_task is self._event_task:
+            if completed_task.is_failed:


this is missing a few other terminal states i believe in the if conditional check

sicoyle · 2026-04-14T13:55:50Z

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py

+            if self._timeout is not None:
+                msg = (
+                    f'Timed out after {self._timeout!r} waiting for '
+                    f'external event {self._event_name!r}'
+                )
+            else:
+                msg = f'Timed out waiting for external event {self._event_name!r}'


can these just be combined instead of split in an if else?

Populate timer origin field

fae65e9

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested review from a team as code owners April 10, 2026 13:13

ruff

b6d99bd

Signed-off-by: Albert Callarisa <albert@diagrid.io>

sicoyle requested a review from Copilot April 10, 2026 13:26

Copilot started reviewing on behalf of sicoyle April 10, 2026 13:26 View session

Copilot AI reviewed Apr 10, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py Show resolved Hide resolved

ext/dapr-ext-workflow/tests/durabletask/test_orchestration_executor.py Outdated Show resolved Hide resolved

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py Outdated Show resolved Hide resolved

Backwards compatible external event timer

b2c7d87

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested a review from Copilot April 13, 2026 15:03

Copilot started reviewing on behalf of acroca April 13, 2026 15:04 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py Outdated Show resolved Hide resolved

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py Show resolved Hide resolved

acroca added 2 commits April 13, 2026 17:10

ruff

9485df6

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Addressed review comments

03558b8

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested a review from Copilot April 13, 2026 15:13

Copilot started reviewing on behalf of acroca April 13, 2026 15:13 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/internal/helpers.py Outdated Show resolved Hide resolved

ext/dapr-ext-workflow/dapr/ext/workflow/workflow_context.py Show resolved Hide resolved

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/task.py Outdated Show resolved Hide resolved

acroca added 2 commits April 13, 2026 17:19

Fix ci

6c4e337

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Addressed review comments

ad30808

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested a review from Copilot April 13, 2026 15:21

Copilot started reviewing on behalf of acroca April 13, 2026 15:22 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py Outdated Show resolved Hide resolved

acroca added 2 commits April 13, 2026 17:33

Addressed review comments

51222cf

Signed-off-by: Albert Callarisa <albert@diagrid.io>

Fix CI

461620e

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested a review from Copilot April 13, 2026 15:49

Copilot started reviewing on behalf of acroca April 13, 2026 15:49 View session

Copilot AI reviewed Apr 13, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py Show resolved Hide resolved

Remove pending external_event_task when timeout fires

5a79404

Signed-off-by: Albert Callarisa <albert@diagrid.io>

acroca requested a review from Copilot April 14, 2026 08:10

Copilot started reviewing on behalf of acroca April 14, 2026 08:11 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

ext/dapr-ext-workflow/dapr/ext/workflow/_durabletask/worker.py Outdated Show resolved Hide resolved

Addressed review comments

7805f97

Signed-off-by: Albert Callarisa <albert@diagrid.io>

sicoyle requested changes Apr 14, 2026

View reviewed changes

		timer.fireAt.seconds == OPTIONAL_TIMER_FIRE_AT.seconds
		and timer.fireAt.nanos == OPTIONAL_TIMER_FIRE_AT.nanos

		timer.fireAt.seconds != OPTIONAL_TIMER_FIRE_AT.seconds
		or timer.fireAt.nanos != OPTIONAL_TIMER_FIRE_AT.nanos


		DESCRIPTOR: _descriptor.Descriptor

		TASKEXECUTIONID_FIELD_NUMBER: _builtins.int

	TASKEXECUTIONID_FIELD_NUMBER: _builtins.int
	TASK_EXECUTION_ID_FIELD_NUMBER: _builtins.int

Conversation

acroca commented Apr 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

sicoyle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Apr 13, 2026 •

edited

Loading