durable-workflow 2.8.0__tar.gz → 2.9.0__tar.gz

{durable_workflow-2.8.0/src/durable_workflow.egg-info → durable_workflow-2.9.0}/PKG-INFO

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

{durable_workflow-2.8.0 → durable_workflow-2.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "durable-workflow"
-version = "2.8.0"
+version = "2.9.0"
 description = "Python client and worker SDK for Durable Workflow Cloud and self-hosted Server"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -75,8 +75,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.8.0"
-registry-version = "2.8.0"
+product-train = "2.9.0"
+registry-version = "2.9.0"
 supported-server-versions = "2.8.0"
 worker-protocol-version = "1.20"
 control-plane-version = "2"

{durable_workflow-2.8.0 → durable_workflow-2.9.0}/src/durable_workflow/workflow.py

@@ -2056,6 +2056,16 @@ class WorkflowContext:
         self._workflow_stream_command_counter = 0
         self.logger = _ReplayLogger(_REPLAY_LOGGER)
 
+    @property
+    def workflow_id(self) -> str:
+        """Original workflow identity, retained across continue-as-new runs."""
+        return self._workflow_id
+
+    @property
+    def run_id(self) -> str:
+        """Current run identity, stable on replay and new after continue-as-new."""
+        return self._run_id
+
     def cancellation_scope(
         self, body: Callable[[], Any], *, shield_parent: bool = False,
     ) -> Generator[Any, Any, Any]:

{durable_workflow-2.8.0 → durable_workflow-2.9.0/src/durable_workflow.egg-info}/PKG-INFO

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

{durable_workflow-2.8.0 → durable_workflow-2.9.0}/src/durable_workflow.egg-info/SOURCES.txt

@@ -142,6 +142,7 @@ tests/test_worker_telemetry_wire.py
 tests/test_workflow_entry_arguments.py
 tests/test_workflow_entrypoint_validation.py
 tests/test_workflow_handler_validation.py
+tests/test_workflow_identity.py
 tests/test_workflow_result_timeout.py
 tests/test_workflow_streams.py
 tests/test_workflow_updates_conformance.py

{durable_workflow-2.8.0 → durable_workflow-2.9.0}/tests/test_replay_regression_corpus.py

@@ -46,6 +46,7 @@ from tests.test_update_signal_condition_replay import (
     UpdateSignalConditionTimerWorkflow,
 )
 from tests.test_worker import compatible_cluster_info
+from tests.test_workflow_identity import IdentityAcrossReplay, IdentityContinueAsNew
 
 FIXTURE_SCHEMA = "durable-workflow.replay-regression/v1"
 FIXTURE_DIR = Path(__file__).parent / "fixtures" / "replay_regressions"
@@ -340,6 +341,8 @@ class NexusCooperativeDeliveryWorkflow:
 
 
 WORKFLOWS = [
+    IdentityAcrossReplay,
+    IdentityContinueAsNew,
     PersistedClockWorkflow,
     NexusCooperativeDeliveryWorkflow,
     NexusTerminalDeliveryWorkflow,
@@ -514,6 +517,8 @@ def _execute_fixture(fixture: dict[str, Any]) -> list[dict[str, Any]]:
             history,
             start_input,
             workflow_type=workflow_type,
+            workflow_id=workflow.get("workflow_id"),
+            run_id=workflow.get("run_id", ""),
             payload_codec=("json" if payload_codec is None else payload_codec),
         )
         commands = _command_documents(outcome.commands)

durable_workflow-2.9.0/tests/test_workflow_identity.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+import pytest
+
+from durable_workflow import serializer, workflow
+from durable_workflow.workflow import (
+    CompleteWorkflow,
+    ContinueAsNew,
+    ScheduleActivity,
+    WorkflowContext,
+    replay,
+)
+
+
+@workflow.defn(name="identity-across-replay")
+class IdentityAcrossReplay:
+    def run(self, ctx: WorkflowContext):  # type: ignore[no-untyped-def]
+        before = [ctx.workflow_id, ctx.run_id]
+        value = yield ctx.schedule_activity("identity", before)
+        return {"before": before, "after": [ctx.workflow_id, ctx.run_id], "value": value}
+
+
+@pytest.mark.parametrize("workflow_id", ["workflow-identity", "0", "17", "017"])
+def test_identity_survives_activity_suspension_and_cold_replay(workflow_id: str) -> None:
+    run_id = "original-run"
+    first = replay(IdentityAcrossReplay, [], [], workflow_id=workflow_id, run_id=run_id)
+    assert len(first.commands) == 1
+    assert isinstance(first.commands[0], ScheduleActivity)
+    assert first.commands[0].arguments == [workflow_id, run_id]
+
+    history = [{"event_type": "ActivityCompleted", "payload": {
+        "result": serializer.envelope("done", codec=serializer.AVRO_CODEC),
+    }}]
+    resumed = replay(IdentityAcrossReplay, history, [], workflow_id=workflow_id, run_id=run_id)
+    assert len(resumed.commands) == 1
+    assert isinstance(resumed.commands[0], CompleteWorkflow)
+    assert resumed.commands[0].result == {
+        "before": [workflow_id, run_id], "after": [workflow_id, run_id], "value": "done",
+    }
+
+
+@workflow.defn(name="identity-continue-as-new")
+class IdentityContinueAsNew:
+    def run(  # type: ignore[no-untyped-def]
+        self, ctx: WorkflowContext, again: bool,
+        prior_workflow_id: str | None = None, prior_run_id: str | None = None,
+    ):
+        if again:
+            return ctx.continue_as_new(False, ctx.workflow_id, ctx.run_id)
+        return {"current": [ctx.workflow_id, ctx.run_id], "prior": [prior_workflow_id, prior_run_id]}
+
+
+def test_successor_context_has_same_workflow_and_new_run_identity() -> None:
+    original = replay(IdentityContinueAsNew, [], [True], workflow_id="chain", run_id="run-one")
+    assert len(original.commands) == 1
+    command = original.commands[0]
+    assert isinstance(command, ContinueAsNew)
+    assert command.arguments == [False, "chain", "run-one"]
+
+    successor = replay(
+        IdentityContinueAsNew, [], command.arguments, workflow_id="chain", run_id="run-two",
+    )
+    assert len(successor.commands) == 1
+    assert isinstance(successor.commands[0], CompleteWorkflow)
+    assert successor.commands[0].result == {"current": ["chain", "run-two"], "prior": ["chain", "run-one"]}
+
+
+@pytest.mark.parametrize("attribute", ["workflow_id", "run_id"])
+def test_workflow_identity_is_read_only(attribute: str) -> None:
+    ctx = WorkflowContext(workflow_id="workflow", run_id="run")
+    with pytest.raises(AttributeError):
+        setattr(ctx, attribute, "replacement")