|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import httpx |
| 4 | +import pytest |
| 5 | + |
| 6 | +from durable_workflow import Client |
| 7 | +from durable_workflow.errors import QueryFailed |
| 8 | +from durable_workflow.retry_policy import TransportRetryPolicy |
| 9 | + |
| 10 | + |
| 11 | +@pytest.mark.parametrize("protocol", ["1.20", "1.19"]) |
| 12 | +@pytest.mark.parametrize("reason", [ |
| 13 | + "query_worker_execution_timeout", "query_task_not_claimed", "query_worker_timeout", |
| 14 | +]) |
| 15 | +@pytest.mark.parametrize("prefix", ["", "/api/runtime/v1/namespaces/example"]) |
| 16 | +async def test_query_exposes_original_canonical_timeout_without_another_admission( |
| 17 | + monkeypatch: pytest.MonkeyPatch, protocol: str, reason: str, prefix: str, |
| 18 | +) -> None: |
| 19 | + monkeypatch.setenv("DURABLE_WORKFLOW_WORKER_PROTOCOL_VERSION", protocol) |
| 20 | + original = {"reason": reason, "message": "Original query ended.", |
| 21 | + "control_plane": {"operation": "query", "reason": reason}} |
| 22 | + admissions = 0 |
| 23 | + discovery_protocols = [] |
| 24 | + |
| 25 | + def handle(request: httpx.Request) -> httpx.Response: |
| 26 | + nonlocal admissions |
| 27 | + if request.url.path.endswith("/api/cluster/info"): |
| 28 | + discovery_protocols.append(request.headers["X-Durable-Workflow-Protocol-Version"]) |
| 29 | + return httpx.Response(200, json={ |
| 30 | + "worker_protocol": {"server_capabilities": {"query_tasks": True}}, |
| 31 | + }) |
| 32 | + assert request.url.path == prefix + "/api/workflows/original/query/total" |
| 33 | + assert request.headers["X-Durable-Workflow-Control-Plane-Version"] == "2" |
| 34 | + admissions += 1 |
| 35 | + if admissions == 1: |
| 36 | + return httpx.Response(504, json=original) |
| 37 | + # The old policy hides the original failure behind a distinct admission. |
| 38 | + return httpx.Response(200, json={"result": "replacement-query"}) |
| 39 | + |
| 40 | + async with Client("https://runtime.example" + prefix, worker_token="worker", control_token="control", |
| 41 | + retry_policy=TransportRetryPolicy(initial_backoff_seconds=0, jitter=False)) as client: |
| 42 | + await client._http.aclose() |
| 43 | + client._http = httpx.AsyncClient(base_url=client.base_url, transport=httpx.MockTransport(handle)) |
| 44 | + with pytest.raises(QueryFailed) as failure: |
| 45 | + await client.query_workflow("original", "total") |
| 46 | + assert admissions == 1 |
| 47 | + assert discovery_protocols == [protocol] |
| 48 | + assert failure.value.status == 504 and failure.value.reason == reason |
| 49 | + assert failure.value.body == original |
| 50 | + |
| 51 | + |
| 52 | +@pytest.mark.parametrize(("method", "path", "status", "body", "headers"), [ |
| 53 | + ("POST", "/api/workflows/w/query/q", 504, {"reason": "gateway_timeout"}, |
| 54 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 55 | + ("POST", "/api/workflows/w/query/q", 503, {"reason": "query_worker_timeout"}, |
| 56 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 57 | + ("GET", "/api/workflows/w/query/q", 504, {"reason": "query_worker_timeout"}, |
| 58 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 59 | + ("POST", "/api/workflows/w/signals/q", 504, {"reason": "query_worker_timeout"}, |
| 60 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 61 | + ("POST", "/api/workflows/w/query/q", 504, {"reason": "query_worker_timeout"}, {}), |
| 62 | + ("POST", "/api/workflows/w/query/q", 504, [], |
| 63 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 64 | + ("POST", "/api/workflows/w/query/q", 504, {"reason": []}, |
| 65 | + {"X-Durable-Workflow-Control-Plane-Version": "2"}), |
| 66 | +]) |
| 67 | +def test_other_transport_failures_keep_existing_retry_policy( |
| 68 | + method: str, path: str, status: int, body: object, headers: dict[str, str], |
| 69 | +) -> None: |
| 70 | + request = httpx.Request(method, "https://runtime.example" + path, headers=headers) |
| 71 | + response = httpx.Response(status, request=request, json=body) |
| 72 | + error = httpx.HTTPStatusError("transport failure", request=request, response=response) |
| 73 | + assert TransportRetryPolicy().should_retry(error, 0) is True |
0 commit comments