durable-workflow 2.12.3__tar.gz → 2.12.4__tar.gz

{durable_workflow-2.12.3/src/durable_workflow.egg-info → durable_workflow-2.12.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: durable-workflow
-Version: 2.12.3
+Version: 2.12.4
 Summary: Python client and worker SDK for Durable Workflow Cloud and self-hosted Server
 Author: Durable Workflow Contributors
 License-Expression: MIT
@@ -160,8 +160,14 @@ portable between both runtime choices.
 ## Compatibility
 
 Stable `2.x` SDK releases follow semantic versioning and negotiate runtime
-capabilities with Server at startup. Use stable `2.x` SDK and Server channels
-for new applications. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
+capabilities with Server at startup. The installed package includes
+`durable_workflow/server_compatibility.json`, matching the release declarations in
+`pyproject.toml`. Its `supported-server-release-baselines` maps each supported
+Server major to its minimum stable release. Readers validate every entry before
+selection and refuse missing majors, malformed entries, or a contradiction with
+the unchanged legacy `supported-server-versions` 2.x baseline. An absent map
+retains legacy reader behavior. This declaration does not replace protocol or
+capability negotiation. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
 documents protocol and upgrade guarantees.
 
 ## Worker protocol and cooperative cancellation

{durable_workflow-2.12.3 → durable_workflow-2.12.4}/README.md

@@ -113,8 +113,14 @@ portable between both runtime choices.
 ## Compatibility
 
 Stable `2.x` SDK releases follow semantic versioning and negotiate runtime
-capabilities with Server at startup. Use stable `2.x` SDK and Server channels
-for new applications. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
+capabilities with Server at startup. The installed package includes
+`durable_workflow/server_compatibility.json`, matching the release declarations in
+`pyproject.toml`. Its `supported-server-release-baselines` maps each supported
+Server major to its minimum stable release. Readers validate every entry before
+selection and refuse missing majors, malformed entries, or a contradiction with
+the unchanged legacy `supported-server-versions` 2.x baseline. An absent map
+retains legacy reader behavior. This declaration does not replace protocol or
+capability negotiation. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
 documents protocol and upgrade guarantees.
 
 ## Worker protocol and cooperative cancellation

{durable_workflow-2.12.3 → durable_workflow-2.12.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "durable-workflow"
-version = "2.12.3"
+version = "2.12.4"
 description = "Python client and worker SDK for Durable Workflow Cloud and self-hosted Server"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -79,9 +79,10 @@ 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.12.3"
-registry-version = "2.12.3"
+product-train = "2.12.4"
+registry-version = "2.12.4"
 supported-server-versions = "2.8.0"
+supported-server-release-baselines = { "2" = "2.8.0", "3" = "3.0.0" }
 worker-protocol-version = "1.20"
 control-plane-version = "2"
 durable-selection = true
@@ -106,6 +107,9 @@ saga-cancellation = "cooperative"
 [tool.setuptools.packages.find]
 where = ["src"]
 
+[tool.setuptools.package-data]
+durable_workflow = ["server_compatibility.json"]
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 asyncio_mode = "auto"

durable_workflow-2.12.4/src/durable_workflow/server_compatibility.json

@@ -0,0 +1,7 @@
+{
+  "supported-server-versions": "2.8.0",
+  "supported-server-release-baselines": {
+    "2": "2.8.0",
+    "3": "3.0.0"
+  }
+}

{durable_workflow-2.12.3 → durable_workflow-2.12.4/src/durable_workflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: durable-workflow
-Version: 2.12.3
+Version: 2.12.4
 Summary: Python client and worker SDK for Durable Workflow Cloud and self-hosted Server
 Author: Durable Workflow Contributors
 License-Expression: MIT
@@ -160,8 +160,14 @@ portable between both runtime choices.
 ## Compatibility
 
 Stable `2.x` SDK releases follow semantic versioning and negotiate runtime
-capabilities with Server at startup. Use stable `2.x` SDK and Server channels
-for new applications. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
+capabilities with Server at startup. The installed package includes
+`durable_workflow/server_compatibility.json`, matching the release declarations in
+`pyproject.toml`. Its `supported-server-release-baselines` maps each supported
+Server major to its minimum stable release. Readers validate every entry before
+selection and refuse missing majors, malformed entries, or a contradiction with
+the unchanged legacy `supported-server-versions` 2.x baseline. An absent map
+retains legacy reader behavior. This declaration does not replace protocol or
+capability negotiation. The [compatibility guide](https://durable-workflow.com/docs/2.0/compatibility/)
 documents protocol and upgrade guarantees.
 
 ## Worker protocol and cooperative cancellation

{durable_workflow-2.12.3 → durable_workflow-2.12.4}/src/durable_workflow.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ src/durable_workflow/replay_conformance.py
 src/durable_workflow/replay_verify.py
 src/durable_workflow/retry_policy.py
 src/durable_workflow/serializer.py
+src/durable_workflow/server_compatibility.json
 src/durable_workflow/sync.py
 src/durable_workflow/telemetry.py
 src/durable_workflow/telemetry_carrier.py

{durable_workflow-2.12.3 → durable_workflow-2.12.4}/tests/test_release_metadata.py

@@ -1,7 +1,11 @@
 from __future__ import annotations
 
+import io
 import json
 import sys
+import tarfile
+import zipfile
+from dataclasses import replace
 from pathlib import Path
 from types import ModuleType
 
@@ -9,7 +13,9 @@ import pytest
 from scripts import check_release_metadata
 from scripts.check_release_metadata import ReleaseMetadataError, SourceMetadata
 from scripts.release_compatibility import (
+    CompatibilityContractError,
     declared_runtime_protocol_version,
+    validate_server_release_baselines,
 )
 
 from durable_workflow.client import PROTOCOL_VERSION
@@ -48,12 +54,187 @@ def test_worker_release_identity_matches_supported_server_and_protocol() -> None
     assert release["worker-protocol-version"] == PROTOCOL_VERSION == "1.20"
     assert release["durable-selection"] is True
     assert release["durable-selection-minimum-worker-protocol-version"] == "1.19"
+    baselines = validate_server_release_baselines(
+        release["supported-server-versions"], release["supported-server-release-baselines"]
+    )
+    assert baselines == {"2": release["supported-server-versions"], "3": "3.0.0"}
+    record = (REPO_ROOT / "src/durable_workflow/server_compatibility.json").read_bytes()
+    assert record == (json.dumps({
+        "supported-server-versions": release["supported-server-versions"],
+        "supported-server-release-baselines": baselines,
+    }, indent=2) + "\n").encode()
 
     assert declared_runtime_protocol_version(
         (REPO_ROOT / "src" / "durable_workflow" / "client.py").read_text(encoding="utf-8")
     ) == "1.20"
 
 
+@pytest.mark.parametrize("baselines", [
+    None, {}, [], "3.0.0", {2: "2.8.0"}, {"02": "2.8.0"},
+    {"0": "0.1.0"}, {"2": "2.8.0", "3": 3},
+    {"2": "2.8.0", "3": "3.0.0-rc.1"},
+    {"2": "2.8.0", "3": "3.00.0"},
+    {"2": "2.8.0", "4": "3.0.0"},
+    {"2": "2.9.0", "3": "3.0.0"}, {"3": "3.0.0"},
+])
+def test_server_baselines_refuse_malformed_or_contradictory_maps(baselines: object) -> None:
+    with pytest.raises(CompatibilityContractError):
+        validate_server_release_baselines("2.8.0", baselines)
+
+
+def test_server_baselines_do_not_imply_unlisted_major_support() -> None:
+    baselines = validate_server_release_baselines("2.8.0", {"2": "2.8.0", "3": "3.0.0"})
+    assert "4" not in baselines
+
+
+COMPATIBILITY_RECORD = b'{"supported-server-versions":"2.0.0"}\n'
+
+
+def write_distributions(
+    dist: Path,
+    source: SourceMetadata,
+    *,
+    wheel_record: bytes | None,
+    sdist_record: bytes | None,
+) -> None:
+    headers = (
+        f"Name: {source.name}\nVersion: {source.registry_version}\nSummary: {source.summary}\n"
+        "Description-Content-Type: text/markdown\n"
+        + "".join(f"Classifier: {value}\n" for value in source.classifiers)
+        + "\n" + source.readme
+    ).encode()
+    with zipfile.ZipFile(dist / "sdk.whl", "w") as archive:
+        archive.writestr("sdk.dist-info/METADATA", headers)
+        if wheel_record is not None:
+            archive.writestr("durable_workflow/server_compatibility.json", wheel_record)
+    members = {"sdk/PKG-INFO": headers, "sdk/README.md": source.readme.encode()}
+    if sdist_record is not None:
+        members["sdk/src/durable_workflow/server_compatibility.json"] = sdist_record
+    with tarfile.open(dist / "sdk.tar.gz", "w:gz") as archive:
+        for path, content in members.items():
+            member = tarfile.TarInfo(path)
+            member.size = len(content)
+            archive.addfile(member, io.BytesIO(content))
+
+
+@pytest.mark.parametrize(("wheel_record", "sdist_record", "refusal"), [
+    (COMPATIBILITY_RECORD, COMPATIBILITY_RECORD, None),
+    (b"{}\n", COMPATIBILITY_RECORD, "wheel Server compatibility record differs"),
+    (COMPATIBILITY_RECORD, b"{}\n", "sdist Server compatibility record differs"),
+    (None, COMPATIBILITY_RECORD, "wheel Server compatibility record differs"),
+    (COMPATIBILITY_RECORD, None, "sdist must contain one Server compatibility record"),
+])
+def test_built_packages_must_retain_exact_server_compatibility(
+    tmp_path: Path,
+    wheel_record: bytes | None,
+    sdist_record: bytes | None,
+    refusal: str | None,
+) -> None:
+    source = replace(source_metadata(), server_compatibility=COMPATIBILITY_RECORD)
+    write_distributions(tmp_path, source, wheel_record=wheel_record, sdist_record=sdist_record)
+    if refusal is None:
+        check_release_metadata.verify_built_distributions(tmp_path, source)
+    else:
+        with pytest.raises(ReleaseMetadataError, match=refusal):
+            check_release_metadata.verify_built_distributions(tmp_path, source)
+
+
+@pytest.mark.parametrize(("wheel_record", "sdist_record", "refusal"), [
+    (None, None, None),
+    (COMPATIBILITY_RECORD, None, "wheel Server compatibility record is absent from exact source"),
+    (None, COMPATIBILITY_RECORD, "sdist Server compatibility record is absent from exact source"),
+])
+def test_legacy_source_packages_must_not_carry_unverified_server_compatibility(
+    tmp_path: Path,
+    wheel_record: bytes | None,
+    sdist_record: bytes | None,
+    refusal: str | None,
+) -> None:
+    source = source_metadata()
+    assert source.server_compatibility is None
+    write_distributions(tmp_path, source, wheel_record=wheel_record, sdist_record=sdist_record)
+    if refusal is None:
+        check_release_metadata.verify_built_distributions(tmp_path, source)
+    else:
+        with pytest.raises(ReleaseMetadataError, match=refusal):
+            check_release_metadata.verify_built_distributions(tmp_path, source)
+
+
+EXACT_SOURCE_RECORD = (
+    json.dumps({
+        "supported-server-versions": "2.8.0",
+        "supported-server-release-baselines": {"2": "2.8.0", "3": "3.0.0"},
+    }, indent=2) + "\n"
+).encode()
+
+
+@pytest.mark.parametrize(("baselines", "record", "refusal"), [
+    (None, None, None),
+    ('{ "2" = "2.8.0", "3" = "3.0.0" }', EXACT_SOURCE_RECORD, None),
+    (None, EXACT_SOURCE_RECORD, "record is present without supported-server-release-baselines"),
+    ('{ "2" = "2.8.0", "3" = "3.0.0" }', None, "requires the packaged Server compatibility record"),
+    ('{ "2" = "2.8.0", "3" = "3.0.0" }', EXACT_SOURCE_RECORD.replace(b"3.0.0", b"3.1.0"),
+     "packaged Server compatibility record differs from pyproject.toml"),
+    ('{ "2" = "2.8.0", "3" = "3.0.0" }', EXACT_SOURCE_RECORD.rstrip(b"\n"),
+     "packaged Server compatibility record differs from pyproject.toml"),
+    ('{ "2" = "2.8.0" }', EXACT_SOURCE_RECORD, "packaged Server compatibility record differs from pyproject.toml"),
+    ('{ "2" = "2.8.0", "3" = "3.0.0-rc.1" }', EXACT_SOURCE_RECORD, "stable release of its keyed major"),
+    ('{ "3" = "3.0.0" }', EXACT_SOURCE_RECORD, "contradict or omit the legacy baseline"),
+    ('{ "2" = "2.9.0", "3" = "3.0.0" }', EXACT_SOURCE_RECORD, "contradict or omit the legacy baseline"),
+    ("{}", EXACT_SOURCE_RECORD, "non-empty major-to-release map"),
+    ('"3.0.0"', EXACT_SOURCE_RECORD, "non-empty major-to-release map"),
+])
+def test_release_metadata_loader_binds_server_compatibility_to_exact_source(
+    monkeypatch: pytest.MonkeyPatch,
+    baselines: str | None,
+    record: bytes | None,
+    refusal: str | None,
+) -> None:
+    commit = "c" * 40
+    baseline_line = "" if baselines is None else f"supported-server-release-baselines = {baselines}\n"
+    pyproject = f"""
+[project]
+name = "durable-workflow"
+version = "2.12.4"
+description = "Python SDK for Durable Workflow 2.0"
+readme = "README.md"
+classifiers = ["Programming Language :: Python :: 3"]
+
+[tool.durable-workflow]
+product-train = "2.12.4"
+registry-version = "2.12.4"
+supported-server-versions = "2.8.0"
+{baseline_line}worker-protocol-version = "1.20"
+""".encode()
+    record_path = "src/durable_workflow/server_compatibility.json"
+
+    def git(*arguments: str) -> bytes:
+        if arguments[0] == "rev-parse":
+            return f"{commit}\n".encode()
+        if arguments[0] == "ls-tree":
+            assert arguments[1:] == ("--name-only", commit, "--", record_path)
+            return b"" if record is None else f"{record_path}\n".encode()
+        assert arguments[0] == "show"
+        if arguments[1] == f"{commit}:pyproject.toml":
+            return pyproject
+        if arguments[1] == f"{commit}:README.md":
+            return b"# Durable Workflow\n\nBuild durable Python workflows.\n"
+        if arguments[1] == f"{commit}:src/durable_workflow/client.py":
+            return b'PROTOCOL_VERSION = "1.20"\n'
+        assert arguments[1] == f"{commit}:{record_path}"
+        assert record is not None
+        return record
+
+    monkeypatch.setattr(check_release_metadata, "_git", git)
+
+    if refusal is not None:
+        with pytest.raises(ReleaseMetadataError, match=refusal):
+            check_release_metadata.load_source_metadata("HEAD")
+        return
+    source = check_release_metadata.load_source_metadata("HEAD")
+    assert source.server_compatibility == record
+
+
 def pypi_json(source: SourceMetadata, **overrides: object) -> bytes:
     info: dict[str, object] = {
         "name": source.name,
@@ -116,6 +297,8 @@ worker-protocol-version = "1.19"
     def git(*arguments: str) -> bytes:
         if arguments[0] == "rev-parse":
             return f"{commit}\n".encode()
+        if arguments[0] == "ls-tree":
+            return b""
         assert arguments[0] == "show"
         if arguments[1].endswith(":pyproject.toml"):
             return pyproject