durable-workflow 2.1.0__tar.gz → 2.1.1__tar.gz

{durable_workflow-2.1.0/src/durable_workflow.egg-info → durable_workflow-2.1.1}/PKG-INFO

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

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "durable-workflow"
-version = "2.1.0"
+version = "2.1.1"
 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.1.0"
-registry-version = "2.1.0"
+product-train = "2.1.1"
+registry-version = "2.1.1"
 supported-server-versions = "2.4.0"
 worker-protocol-version = "1.19"
 control-plane-version = "2"

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/src/durable_workflow/workflow.py

@@ -762,6 +762,7 @@ class RecordSideEffect:
 
     result: Any
     workflow_stream: dict[str, Any] | None = None
+    _effect: Callable[[], Any] | None = field(default=None, repr=False, compare=False)
 
     def to_server_command(
         self,
@@ -1799,8 +1800,7 @@ class WorkflowContext:
         return SelectGroup(entries)
 
     def side_effect(self, fn: Callable[[], Any]) -> RecordSideEffect:
-        result = fn()
-        return RecordSideEffect(result=result)
+        return RecordSideEffect(result=None, _effect=fn)
 
     def append_workflow_stream(
         self,
@@ -5139,6 +5139,16 @@ def _replay_state(
                     continue
                 ctx.logger._set_replaying(False)
                 _assert_pending_step_matches(cmd)
+                if cmd._effect is not None:
+                    try:
+                        cmd.result = cmd._effect()
+                    except Exception as exc:
+                        try:
+                            advanced_cmd = gen.throw(exc)
+                            continue
+                        except StopIteration as stop:
+                            return _terminal_state(stop.value, include_pending=True)
+                    cmd._effect = None
                 pending.append(cmd)
                 next_value = cmd.result
                 continue

{durable_workflow-2.1.0 → durable_workflow-2.1.1/src/durable_workflow.egg-info}/PKG-INFO

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

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/tests/test_pypi_project_surface.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import json
 import subprocess
+from dataclasses import replace
 from pathlib import Path
 from typing import Any
 
@@ -91,6 +92,10 @@ def pip_report(version: str) -> dict[str, object]:
 def test_release_channel_distinguishes_prerelease_and_stable() -> None:
     assert release_channel(source_metadata()) == "prerelease"
     assert release_channel(source_metadata(stable=True)) == "stable"
+    stable_minor = replace(source_metadata(stable=True), version="2.1.0", registry_version="2.1.0")
+    prerelease_minor = replace(source_metadata(), version="2.1.0-rc.1", registry_version="2.1.0rc1")
+    assert release_channel(stable_minor) == "stable"
+    assert release_channel(prerelease_minor) == "prerelease"
 
 
 def test_prerelease_with_existing_final_skips_project_root_and_bare_install(

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/tests/test_release_metadata.py

@@ -41,9 +41,9 @@ def test_worker_release_identity_matches_supported_server_and_protocol() -> None
     project = manifest["project"]
     release = manifest["tool"]["durable-workflow"]
 
-    assert project["version"] == "2.1.0"
+    assert check_release_metadata.VERSION_PATTERN.fullmatch(project["version"]) is not None
     assert release["product-train"] == project["version"]
-    assert release["registry-version"] == "2.1.0"
+    assert release["registry-version"] == project["version"].replace("-rc.", "rc")
     assert release["supported-server-versions"] == "2.4.0"
     assert release["worker-protocol-version"] == PROTOCOL_VERSION == "1.19"
     assert release["durable-selection"] is True

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/tests/test_replay.py

@@ -1158,6 +1158,57 @@ class TestContinueAsNew:
 
 
 class TestSideEffect:
+    def test_user_callable_runs_only_for_an_unrecorded_side_effect(self) -> None:
+        calls: list[str] = []
+
+        @workflow.defn(name="side-effect-call-count-wf")
+        class CountedSideEffectWorkflow:
+            def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
+                value = yield ctx.side_effect(lambda: calls.append("called") or 42)
+                return value
+
+        first = replay(CountedSideEffectWorkflow, [], [])
+        assert calls == ["called"]
+        assert isinstance(first.commands[0], RecordSideEffect)
+        assert first.commands[0].result == 42
+
+        history = [{"event_type": "SideEffectRecorded", "payload": {"result": _avro(99)}}]
+        replayed = replay(CountedSideEffectWorkflow, history, [])
+        assert calls == ["called"]
+        assert isinstance(replayed.commands[0], CompleteWorkflow)
+        assert replayed.commands[0].result == 99
+
+    def test_user_callable_is_not_run_when_history_shape_mismatches(self) -> None:
+        calls: list[str] = []
+
+        @workflow.defn(name="side-effect-mismatch-wf")
+        class MismatchedSideEffectWorkflow:
+            def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
+                return (yield ctx.side_effect(lambda: calls.append("called") or 42))
+
+        history = [{"event_type": "TimerScheduled", "payload": {"sequence": 1, "timer_kind": "durable_timer"}}]
+        with pytest.raises(NonDeterministicReplayError):
+            replay(MismatchedSideEffectWorkflow, history, [])
+        assert calls == []
+
+    def test_user_callable_error_can_be_handled_by_workflow(self) -> None:
+        @workflow.defn(name="side-effect-error-wf")
+        class HandledSideEffectWorkflow:
+            def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
+                def fail() -> int:
+                    raise ValueError("expected failure")
+
+                try:
+                    yield ctx.side_effect(fail)
+                except ValueError:
+                    return "handled"
+                return "unexpected"
+
+        outcome = replay(HandledSideEffectWorkflow, [], [])
+        assert len(outcome.commands) == 1
+        assert isinstance(outcome.commands[0], CompleteWorkflow)
+        assert outcome.commands[0].result == "handled"
+
     def test_first_replay_records_and_continues(self) -> None:
         outcome = replay(SideEffectWorkflow, [], [])
         assert len(outcome.commands) == 2

{durable_workflow-2.1.0 → durable_workflow-2.1.1}/tests/test_replay_regression_corpus.py

@@ -147,6 +147,15 @@ class WorkflowStreamAuthorWorkflow:
         return "done"
 
 
+@workflow.defn(name="tests.replay.recorded-side-effect")
+class RecordedSideEffectWorkflow:
+    def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
+        def unexpected_execution() -> int:
+            raise AssertionError("recorded side effect callable ran during replay")
+
+        return (yield ctx.side_effect(unexpected_execution))
+
+
 @workflow.defn(name="tests.replay.message-stream-consumer")
 class MessageStreamConsumerWorkflow:
     def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
@@ -197,6 +206,7 @@ WORKFLOWS = [
     ParallelMetadataProducerWorkflow,
     ParallelResultBindingWorkflow,
     PostConditionReceiversWorkflow,
+    RecordedSideEffectWorkflow,
     SelectionAwaitMarkerWorkflow,
     SelectionCancellationQueryWorkflow,
     SelectionMissingNestedOpeningWorkflow,