Skip to content

Commit b1ed87d

Browse files
committed
Add deterministic selection and durable structured concurrency
1 parent 6cdd087 commit b1ed87d

10 files changed

Lines changed: 552 additions & 24 deletions

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9-
The Python SDK advances to prerelease `2.0.0-rc.42`. PyPI displays the normalized
10-
PEP 440 identity `2.0.0rc42`. This Avro-only SDK release is qualified with Server
9+
The Python SDK advances to prerelease `2.0.0-rc.43`. PyPI displays the normalized
10+
PEP 440 identity `2.0.0rc43`. This Avro-only SDK release is qualified with Server
1111
`2.0.0-rc.57`; JSON remains HTTP transport and is no longer a workflow payload
1212
codec.
1313
Earlier SDK versions remain historical releases and are not alternate supported

‎pyproject.toml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "durable-workflow"
7-
version = "2.0.0-rc.42"
7+
version = "2.0.0-rc.43"
88
description = "Release candidate Python SDK for the Durable Workflow 2.0 train"
99
readme = "README.md"
1010
requires-python = ">=3.10"
@@ -68,8 +68,8 @@ durable-workflow-replay-conformance = "durable_workflow.replay_conformance:main"
6868
durable-workflow-workflow-updates-conformance = "durable_workflow.workflow_updates_conformance:main"
6969

7070
[tool.durable-workflow]
71-
product-train = "2.0.0-rc.42"
72-
registry-version = "2.0.0rc42"
71+
product-train = "2.0.0-rc.43"
72+
registry-version = "2.0.0rc43"
7373
supported-server-versions = "2.0.0-rc.57"
7474
worker-protocol-version = "1.19"
7575
control-plane-version = "2"

‎src/durable_workflow/workflow.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2516,6 +2516,7 @@ def query_state(
25162516
payload_codec=payload_codec,
25172517
external_storage=external_storage,
25182518
external_storage_cache=external_storage_cache,
2519+
stop_at_uncommitted_cancellation=True,
25192520
)
25202521
except Exception as exc:
25212522
raise QueryFailed(f"workflow replay failed before query: {exc}") from exc
@@ -3425,6 +3426,7 @@ def _replay_state(
34253426
external_storage: ExternalStorageDriver | None = None,
34263427
external_storage_cache: ExternalPayloadCache | None = None,
34273428
cancel_requested: bool = False,
3429+
stop_at_uncommitted_cancellation: bool = False,
34283430
) -> _ReplayState:
34293431
if payload_codec is not None and payload_codec != serializer.AVRO_CODEC:
34303432
try:
@@ -4886,6 +4888,13 @@ def _terminal_state(value: Any, *, include_pending: bool) -> _ReplayState:
48864888
strict=True,
48874889
):
48884890
steps = selection_steps.get(sequence, [])
4891+
if marker is not None and not steps:
4892+
raise NonDeterministicReplayError(
4893+
sequence,
4894+
f"durable {_parallel_leaf_kind(leaf)} selection member opening history",
4895+
["SelectionResolved"],
4896+
detail="selection member is missing scheduled/open history",
4897+
)
48894898
if steps:
48904899
for selection_step in steps:
48914900
_assert_step_matches(leaf, selection_step)
@@ -5052,6 +5061,25 @@ def _terminal_state(value: Any, *, include_pending: bool) -> _ReplayState:
50525061
_assert_authored_selection_handle(cmd.handle)
50535062
if _selection_cancellation_for_handle(cmd.handle) is None:
50545063
pending.append(cmd)
5064+
cancellation_shape: list[Any] | None = None
5065+
if isinstance(cmd.handle.operation, list):
5066+
_, cancellation_shape = _annotate_parallel_commands(
5067+
cmd.handle.operation,
5068+
cmd.handle.base_sequence,
5069+
)
5070+
operation_is_terminal, _, _ = _selection_member_value(
5071+
cmd.handle.base_sequence,
5072+
cmd.handle.size,
5073+
cancellation_shape,
5074+
)
5075+
# Query replay may expose only state behind durable history.
5076+
# A terminal member is already a committed no-op boundary.
5077+
if (
5078+
stop_at_uncommitted_cancellation
5079+
and not operation_is_terminal
5080+
and _next_unconsumed_recorded_step() is None
5081+
):
5082+
return _state(pending)
50555083
next_value = None
50565084
continue
50575085
if isinstance(cmd, ContinueAsNew):
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/durable-workflow/.github/main/regression-corpus/evidence-schema.json",
3+
"fixture_schema": "durable-workflow.replay-regression/v1",
4+
"id": "selection-missing-nested-opening",
5+
"protocol_version": "1.19",
6+
"bindings": [
7+
"python"
8+
],
9+
"workflow": {
10+
"type": "tests.replay.selection-missing-nested-opening",
11+
"input": [],
12+
"payload_codec": "avro"
13+
},
14+
"history": [
15+
{
16+
"event_type": "WorkflowStarted",
17+
"payload": {
18+
"workflow_type": "tests.replay.selection-missing-nested-opening",
19+
"payload_codec": "avro"
20+
}
21+
},
22+
{
23+
"id": "winner-scheduled",
24+
"event_type": "ActivityScheduled",
25+
"payload": {
26+
"sequence": 3,
27+
"activity_type": "winner",
28+
"activity_execution_id": "activity-winner",
29+
"parallel_group_id": "select-calls:1:3",
30+
"parallel_group_kind": "activity",
31+
"parallel_group_mode": "select",
32+
"parallel_group_base_sequence": 1,
33+
"parallel_group_size": 3,
34+
"parallel_group_index": 2,
35+
"selection_member_key": "winner",
36+
"selection_member_index": 1,
37+
"selection_member_base_sequence": 3,
38+
"selection_member_size": 1,
39+
"selection_member_kind": "activity",
40+
"parallel_group_path": [
41+
{
42+
"parallel_group_id": "select-calls:1:3",
43+
"parallel_group_kind": "activity",
44+
"parallel_group_mode": "select",
45+
"parallel_group_base_sequence": 1,
46+
"parallel_group_size": 3,
47+
"parallel_group_index": 2,
48+
"selection_member_key": "winner",
49+
"selection_member_index": 1,
50+
"selection_member_base_sequence": 3,
51+
"selection_member_size": 1,
52+
"selection_member_kind": "activity"
53+
}
54+
]
55+
}
56+
},
57+
{
58+
"id": "winner-completed",
59+
"event_type": "ActivityCompleted",
60+
"payload": {
61+
"sequence": 3,
62+
"activity_type": "winner",
63+
"activity_execution_id": "activity-winner",
64+
"result": {
65+
"codec": "avro",
66+
"blob": "wwHioz3/VYAiNwoUZmFzdC12YWx1ZQ=="
67+
},
68+
"payload_codec": "avro",
69+
"parallel_group_id": "select-calls:1:3",
70+
"parallel_group_kind": "activity",
71+
"parallel_group_mode": "select",
72+
"parallel_group_base_sequence": 1,
73+
"parallel_group_size": 3,
74+
"parallel_group_index": 2,
75+
"selection_member_key": "winner",
76+
"selection_member_index": 1,
77+
"selection_member_base_sequence": 3,
78+
"selection_member_size": 1,
79+
"selection_member_kind": "activity",
80+
"parallel_group_path": [
81+
{
82+
"parallel_group_id": "select-calls:1:3",
83+
"parallel_group_kind": "activity",
84+
"parallel_group_mode": "select",
85+
"parallel_group_base_sequence": 1,
86+
"parallel_group_size": 3,
87+
"parallel_group_index": 2,
88+
"selection_member_key": "winner",
89+
"selection_member_index": 1,
90+
"selection_member_base_sequence": 3,
91+
"selection_member_size": 1,
92+
"selection_member_kind": "activity"
93+
}
94+
]
95+
}
96+
},
97+
{
98+
"id": "selection-resolved",
99+
"event_type": "SelectionResolved",
100+
"payload": {
101+
"selection_group_id": "select-calls:1:3",
102+
"selection_group_base_sequence": 1,
103+
"selection_group_size": 3,
104+
"member_key": "winner",
105+
"member_index": 1,
106+
"member_base_sequence": 3,
107+
"member_size": 1,
108+
"operation_kind": "activity",
109+
"operation_identity": "activity-winner",
110+
"outcome": "completed",
111+
"resolution_event_id": "winner-completed",
112+
"resolution_event_type": "ActivityCompleted"
113+
}
114+
}
115+
],
116+
"expected": {
117+
"command_sequence": []
118+
},
119+
"expected_replay_error": {
120+
"type": "NonDeterministicReplayError",
121+
"message_contains": "selection member is missing scheduled/open history",
122+
"workflow_sequence": 1
123+
}
124+
}
Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/durable-workflow/.github/main/regression-corpus/evidence-schema.json",
3+
"fixture_schema": "durable-workflow.replay-regression/v1",
4+
"id": "selection-uncommitted-cancellation-query",
5+
"protocol_version": "1.19",
6+
"bindings": [
7+
"python"
8+
],
9+
"workflow": {
10+
"type": "tests.replay.selection-cancellation-query",
11+
"input": [],
12+
"payload_codec": "avro",
13+
"query": {
14+
"name": "state",
15+
"arguments": []
16+
}
17+
},
18+
"history": [
19+
{
20+
"event_type": "WorkflowStarted",
21+
"payload": {
22+
"workflow_type": "tests.replay.selection-cancellation-query",
23+
"payload_codec": "avro"
24+
}
25+
},
26+
{
27+
"id": "slow-scheduled",
28+
"event_type": "ActivityScheduled",
29+
"payload": {
30+
"sequence": 1,
31+
"activity_type": "slow-activity",
32+
"activity_execution_id": "activity-slow",
33+
"parallel_group_id": "select-calls:1:2",
34+
"parallel_group_kind": "activity",
35+
"parallel_group_mode": "select",
36+
"parallel_group_base_sequence": 1,
37+
"parallel_group_size": 2,
38+
"parallel_group_index": 0,
39+
"selection_member_key": "slow",
40+
"selection_member_index": 0,
41+
"selection_member_base_sequence": 1,
42+
"selection_member_size": 1,
43+
"selection_member_kind": "activity",
44+
"parallel_group_path": [
45+
{
46+
"parallel_group_id": "select-calls:1:2",
47+
"parallel_group_kind": "activity",
48+
"parallel_group_mode": "select",
49+
"parallel_group_base_sequence": 1,
50+
"parallel_group_size": 2,
51+
"parallel_group_index": 0,
52+
"selection_member_key": "slow",
53+
"selection_member_index": 0,
54+
"selection_member_base_sequence": 1,
55+
"selection_member_size": 1,
56+
"selection_member_kind": "activity"
57+
}
58+
]
59+
}
60+
},
61+
{
62+
"id": "fast-scheduled",
63+
"event_type": "ActivityScheduled",
64+
"payload": {
65+
"sequence": 2,
66+
"activity_type": "fast-activity",
67+
"activity_execution_id": "activity-fast",
68+
"parallel_group_id": "select-calls:1:2",
69+
"parallel_group_kind": "activity",
70+
"parallel_group_mode": "select",
71+
"parallel_group_base_sequence": 1,
72+
"parallel_group_size": 2,
73+
"parallel_group_index": 1,
74+
"selection_member_key": "fast",
75+
"selection_member_index": 1,
76+
"selection_member_base_sequence": 2,
77+
"selection_member_size": 1,
78+
"selection_member_kind": "activity",
79+
"parallel_group_path": [
80+
{
81+
"parallel_group_id": "select-calls:1:2",
82+
"parallel_group_kind": "activity",
83+
"parallel_group_mode": "select",
84+
"parallel_group_base_sequence": 1,
85+
"parallel_group_size": 2,
86+
"parallel_group_index": 1,
87+
"selection_member_key": "fast",
88+
"selection_member_index": 1,
89+
"selection_member_base_sequence": 2,
90+
"selection_member_size": 1,
91+
"selection_member_kind": "activity"
92+
}
93+
]
94+
}
95+
},
96+
{
97+
"id": "fast-completed",
98+
"event_type": "ActivityCompleted",
99+
"payload": {
100+
"sequence": 2,
101+
"activity_type": "fast-activity",
102+
"activity_execution_id": "activity-fast",
103+
"result": {
104+
"codec": "avro",
105+
"blob": "wwHioz3/VYAiNwoUZmFzdC12YWx1ZQ=="
106+
},
107+
"payload_codec": "avro",
108+
"parallel_group_id": "select-calls:1:2",
109+
"parallel_group_kind": "activity",
110+
"parallel_group_mode": "select",
111+
"parallel_group_base_sequence": 1,
112+
"parallel_group_size": 2,
113+
"parallel_group_index": 1,
114+
"selection_member_key": "fast",
115+
"selection_member_index": 1,
116+
"selection_member_base_sequence": 2,
117+
"selection_member_size": 1,
118+
"selection_member_kind": "activity",
119+
"parallel_group_path": [
120+
{
121+
"parallel_group_id": "select-calls:1:2",
122+
"parallel_group_kind": "activity",
123+
"parallel_group_mode": "select",
124+
"parallel_group_base_sequence": 1,
125+
"parallel_group_size": 2,
126+
"parallel_group_index": 1,
127+
"selection_member_key": "fast",
128+
"selection_member_index": 1,
129+
"selection_member_base_sequence": 2,
130+
"selection_member_size": 1,
131+
"selection_member_kind": "activity"
132+
}
133+
]
134+
}
135+
},
136+
{
137+
"id": "selection-resolved",
138+
"event_type": "SelectionResolved",
139+
"payload": {
140+
"selection_group_id": "select-calls:1:2",
141+
"selection_group_base_sequence": 1,
142+
"selection_group_size": 2,
143+
"member_key": "fast",
144+
"member_index": 1,
145+
"member_base_sequence": 2,
146+
"member_size": 1,
147+
"operation_kind": "activity",
148+
"operation_identity": "activity-fast",
149+
"outcome": "completed",
150+
"resolution_event_id": "fast-completed",
151+
"resolution_event_type": "ActivityCompleted"
152+
}
153+
}
154+
],
155+
"expected": {
156+
"query_result": "before-cancel"
157+
}
158+
}

0 commit comments

Comments
 (0)