durable-workflow 2.5.9__tar.gz → 2.5.10__tar.gz

{durable_workflow-2.5.9/src/durable_workflow.egg-info → durable_workflow-2.5.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: durable-workflow
-Version: 2.5.9
+Version: 2.5.10
 Summary: Python client and worker SDK for Durable Workflow Cloud and self-hosted Server
 Author: Durable Workflow Contributors
 License-Expression: MIT

{durable_workflow-2.5.9 → durable_workflow-2.5.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "durable-workflow"
-version = "2.5.9"
+version = "2.5.10"
 description = "Python client and worker SDK for Durable Workflow Cloud and self-hosted Server"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -71,8 +71,8 @@ durable-workflow-replay-conformance = "durable_workflow.replay_conformance:main"
 durable-workflow-workflow-updates-conformance = "durable_workflow.workflow_updates_conformance:main"
 
 [tool.durable-workflow]
-product-train = "2.5.9"
-registry-version = "2.5.9"
+product-train = "2.5.10"
+registry-version = "2.5.10"
 supported-server-versions = "2.5.16"
 worker-protocol-version = "1.20"
 control-plane-version = "2"

{durable_workflow-2.5.9 → durable_workflow-2.5.10}/src/durable_workflow/workflow.py

@@ -5238,7 +5238,7 @@ def _replay_state(
     pending: list[Command] = []
     advanced_cmd: Any = None
     terminal_condition_reopen_cmd: WaitCondition | None = None
-    version_decisions: dict[str, tuple[int, str]] = {}
+    version_decisions: dict[str, int] = {}
 
     def _version_error(detail: str, step: _RecordedStep | None = None) -> NonDeterministicReplayError:
         return NonDeterministicReplayError(
@@ -5256,13 +5256,12 @@ def _replay_state(
         if type(version) is not int:
             raise _version_error("Version marker must contain an integer version.", step)
         change_id = payload.get("change_id")
-        if "change_id" in payload and (not isinstance(change_id, str) or not change_id.strip()):
+        if not isinstance(change_id, str) or not change_id.strip():
             raise _version_error("Version marker must retain a non-empty change ID.", step)
-        if "min_supported" in payload or "max_supported" in payload:
-            minimum, maximum = payload.get("min_supported"), payload.get("max_supported")
-            if (type(minimum) is not int or type(maximum) is not int
-                    or not minimum <= version <= maximum):
-                raise _version_error("Recorded version marker has an invalid supported range.", step)
+        minimum, maximum = payload.get("min_supported"), payload.get("max_supported")
+        if (type(minimum) is not int or type(maximum) is not int
+                or not minimum <= version <= maximum):
+            raise _version_error("Recorded version marker has an invalid supported range.", step)
         return version
 
     def _consume_duplicate_version_markers() -> None:
@@ -5277,7 +5276,7 @@ def _replay_state(
             if _next_unconsumed_recorded_step() is not step:
                 return
             version = _recorded_version(step)
-            if version != version_decisions[change_id][0]:
+            if version != version_decisions[change_id]:
                 raise _version_error(f"Conflicting recorded decisions for change ID {change_id!r}.", step)
             # Earlier SDKs emitted a marker for every invocation. Consume these
             # aliases while retaining their physical positions for cancellation
@@ -5293,13 +5292,10 @@ def _replay_state(
         if (type(command.min_supported) is not int or type(command.max_supported) is not int
                 or command.min_supported > command.max_supported):
             raise _version_error(f"Invalid supported range for change ID {change_id!r}.")
-        family = "version" if command.result_kind == "version" else "patch"
         decision = version_decisions.get(change_id)
         step = _next_unconsumed_recorded_step()
         if decision is not None:
-            version, original_family = decision
-            if original_family != family:
-                raise _version_error(f"Change ID {change_id!r} cannot switch between version and patch helpers.", step)
+            version = decision
         elif step is not None and step.shape == "version marker":
             _assert_step_matches(command, step)
             version = _recorded_version(step)
@@ -5326,7 +5322,7 @@ def _replay_state(
                 f"Recorded version {version} for change ID {change_id!r} is outside "
                 f"the supported range {command.min_supported}..{command.max_supported}.", step,
             )
-        version_decisions.setdefault(change_id, (version, family))
+        version_decisions.setdefault(change_id, version)
         return _version_marker_result(command, version)
 
     def _parallel_leaf_kind(command: Any) -> str:

{durable_workflow-2.5.9 → durable_workflow-2.5.10/src/durable_workflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: durable-workflow
-Version: 2.5.9
+Version: 2.5.10
 Summary: Python client and worker SDK for Durable Workflow Cloud and self-hosted Server
 Author: Durable Workflow Contributors
 License-Expression: MIT

{durable_workflow-2.5.9 → durable_workflow-2.5.10}/tests/test_patch_history.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from itertools import permutations
 from typing import Any
 
 import pytest
@@ -74,6 +75,43 @@ class PatchCancellationWorkflow:
             return [decisions, "cancelled"]
 
 
+@workflow.defn(name="tests.patch.helpers")
+class MixedPatchHelpersWorkflow:
+    def run(self, ctx, helpers):  # type: ignore[no-untyped-def]
+        decisions = []
+        for helper in helpers:
+            command = ctx.get_version("same", -1, 1) if helper == "get_version" else getattr(ctx, helper)("same")
+            decisions.append((yield command))
+        result = yield ctx.schedule_activity("old", [])
+        return [decisions, result]
+
+
+@pytest.mark.parametrize("helpers", list(permutations(["get_version", "patched", "deprecate_patch"])))
+@pytest.mark.parametrize("marker_count", [0, 1, 2])
+@pytest.mark.parametrize("completed", [False, True])
+def test_helpers_share_one_decision_on_old_history(
+    helpers: tuple[str, ...], marker_count: int, completed: bool,
+) -> None:
+    history = [version_marker(sequence) for sequence in range(1, marker_count + 1)]
+    history += old_activity(marker_count + 1, completed)
+    commands = replay(MixedPatchHelpersWorkflow, history, [helpers]).commands
+    if not completed:
+        assert commands == []
+    else:
+        assert len(commands) == 1
+        assert isinstance(commands[0], CompleteWorkflow)
+        version = 1 if marker_count else -1
+        values = {"get_version": version, "patched": version == 1, "deprecate_patch": None}
+        assert commands[0].result == [[values[helper] for helper in helpers], "recorded"]
+
+
+@pytest.mark.parametrize("helpers", list(permutations(["get_version", "patched", "deprecate_patch"])))
+def test_helpers_record_one_decision_on_fresh_history(helpers: tuple[str, ...]) -> None:
+    commands = replay(MixedPatchHelpersWorkflow, [], [helpers]).commands
+    assert [type(command) for command in commands] == [RecordVersionMarker, ScheduleActivity]
+    assert commands[0].version == 1
+
+
 @pytest.mark.parametrize("completed", [False, True])
 def test_inserted_patch_preserves_unmarked_activity(completed: bool) -> None:
     outcome = replay(PatchInsertionWorkflow, old_activity(1, completed), [])
@@ -122,7 +160,7 @@ def test_repeated_version_reuses_first_decision() -> None:
 
 
 @pytest.mark.parametrize("arguments", [[3], [1, True]])
-def test_repeated_version_rejects_incompatible_range_or_family(arguments: list[Any]) -> None:
+def test_repeated_version_rejects_incompatible_range(arguments: list[Any]) -> None:
     with pytest.raises(NonDeterministicReplayError):
         replay(VersionRangeWorkflow, [], arguments)
 
@@ -134,6 +172,41 @@ def test_conflicting_duplicate_marker_is_rejected(version: Any) -> None:
         replay(RepeatedPatchWorkflow, history, [])
 
 
+@pytest.mark.parametrize("sequence", [1, 2])
+@pytest.mark.parametrize("bounds", [
+    {}, {"min_supported": -1}, {"max_supported": 1},
+    {"min_supported": True, "max_supported": 1},
+    {"min_supported": -1, "max_supported": "1"},
+    {"min_supported": 2, "max_supported": 1},
+    {"min_supported": -1, "max_supported": 0},
+])
+def test_canonical_markers_require_valid_recorded_ranges(sequence: int, bounds: dict[str, Any]) -> None:
+    markers = [version_marker(1), version_marker(2)]
+    markers[sequence - 1]["payload"].pop("min_supported")
+    markers[sequence - 1]["payload"].pop("max_supported")
+    markers[sequence - 1]["payload"].update(bounds)
+    with pytest.raises(NonDeterministicReplayError, match="invalid supported range"):
+        replay(RepeatedPatchWorkflow, markers + old_activity(3), [])
+
+
+@pytest.mark.parametrize("identity", [{}, {"change_id": None}, {"change_id": ""}, {"change_id": True}])
+def test_canonical_marker_requires_a_change_id(identity: dict[str, Any]) -> None:
+    marker = version_marker(1)
+    marker["payload"].pop("change_id")
+    marker["payload"].update(identity)
+    with pytest.raises(NonDeterministicReplayError, match="non-empty change ID"):
+        replay(RepeatedPatchWorkflow, [marker] + old_activity(2), [])
+
+
+def test_duplicate_ranges_may_differ_around_the_same_version() -> None:
+    marker = version_marker(2)
+    marker["payload"].update(min_supported=0, max_supported=3)
+    commands = replay(RepeatedPatchWorkflow, [version_marker(1), marker] + old_activity(3), []).commands
+    assert len(commands) == 1
+    assert isinstance(commands[0], CompleteWorkflow)
+    assert commands[0].result == [True, True, "recorded"]
+
+
 @pytest.mark.parametrize("marker_count", [0, 1, 2])
 def test_patch_decisions_preserve_committed_cancellation_sequence(marker_count: int) -> None:
     history = [version_marker(sequence) for sequence in range(1, marker_count + 1)]

{durable_workflow-2.5.9 → durable_workflow-2.5.10}/tests/test_replay.py

@@ -1949,7 +1949,9 @@ class TestVersionMarker:
 
     def test_version_from_history(self) -> None:
         history = [
-            {"event_type": "VersionMarkerRecorded", "payload": {"version": 2}},
+            {"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "change-1", "version": 2, "min_supported": 1, "max_supported": 2,
+            }},
         ]
         outcome = replay(VersionWorkflow, history, [])
         assert len(outcome.commands) == 1
@@ -1959,7 +1961,9 @@ class TestVersionMarker:
 
     def test_old_version_from_history(self) -> None:
         history = [
-            {"event_type": "VersionMarkerRecorded", "payload": {"version": 1}},
+            {"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "change-1", "version": 1, "min_supported": 1, "max_supported": 2,
+            }},
         ]
         outcome = replay(VersionWorkflow, history, [])
         assert len(outcome.commands) == 1
@@ -1969,7 +1973,9 @@ class TestVersionMarker:
 
     def test_full_replay(self) -> None:
         history = [
-            {"event_type": "VersionMarkerRecorded", "payload": {"version": 2}},
+            {"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "change-1", "version": 2, "min_supported": 1, "max_supported": 2,
+            }},
             {"event_type": "ActivityCompleted", "payload": {"result": _avro("done")}},
         ]
         outcome = replay(VersionWorkflow, history, [])
@@ -2006,7 +2012,9 @@ class TestVersionMarker:
 
     def test_patched_uses_recorded_marker_for_existing_patched_runs(self) -> None:
         history = [
-            {"event_type": "VersionMarkerRecorded", "payload": {"version": 1}},
+            {"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "patch-1", "version": 1, "min_supported": -1, "max_supported": 1,
+            }},
         ]
 
         outcome = replay(PatchedWorkflow, history, [])
@@ -2017,7 +2025,9 @@ class TestVersionMarker:
 
     def test_patched_uses_legacy_default_for_existing_unpatched_runs(self) -> None:
         history = [
-            {"event_type": "VersionMarkerRecorded", "payload": {"version": -1}},
+            {"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "patch-1", "version": -1, "min_supported": -1, "max_supported": 1,
+            }},
         ]
 
         outcome = replay(PatchedWorkflow, history, [])
@@ -2040,7 +2050,9 @@ class TestVersionMarker:
 
         replayed = replay(
             DeprecatedPatchWorkflow,
-            [{"event_type": "VersionMarkerRecorded", "payload": {"version": 1}}],
+            [{"event_type": "VersionMarkerRecorded", "payload": {
+                "sequence": 1, "change_id": "patch-1", "version": 1, "min_supported": -1, "max_supported": 1,
+            }}],
             [],
         )
         assert len(replayed.commands) == 1

{durable_workflow-2.5.9 → durable_workflow-2.5.10}/tests/test_replay_regression_corpus.py

@@ -25,7 +25,12 @@ from tests.test_golden_history_replay import (
     GoldenTimeoutWaitWorkflow,
     GoldenVersionMarkerWorkflow,
 )
-from tests.test_patch_history import PatchCancellationWorkflow, PatchInsertionWorkflow, RepeatedPatchWorkflow
+from tests.test_patch_history import (
+    MixedPatchHelpersWorkflow,
+    PatchCancellationWorkflow,
+    PatchInsertionWorkflow,
+    RepeatedPatchWorkflow,
+)
 from tests.test_pending_operation_replay import PendingOperation
 from tests.test_update_signal_condition_replay import (
     PostConditionReceiversWorkflow,
@@ -290,6 +295,7 @@ WORKFLOWS = [
     ParallelResultBindingWorkflow,
     PatchCancellationWorkflow,
     PatchInsertionWorkflow,
+    MixedPatchHelpersWorkflow,
     RepeatedPatchWorkflow,
     PendingOperation,
     PagedRecordedSideEffectsWorkflow,