DX-2192: add workflow endpoint detection feature and bump version to 0.1.4 (#36)

* feat: add workflow endpoint detection feature and bump version to 0.1.4

* fix: fmt

* feat: add failure callback feature set headers to workflow requests

Author: CahidArda

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "upstash-workflow"
-version = "0.1.3"
+version = "0.1.4"
 description = "Python SDK for Upstash Workflow"
 license = "MIT"
 authors = ["Upstash <[email protected]>"]

tests/asyncio/test_context.py

@@ -66,6 +66,8 @@ async def execute() -> None:
                         "Upstash-Workflow-RunId": "wfr-id",
                         "Upstash-Workflow-Url": "https://www.my-website.com/api",
                         "Upstash-Feature-Set": "WF_NoDelete,InitialBody",
+                        "Upstash-Failure-Callback-Feature-Set": "LazyFetch,InitialBody",
+                        "Upstash-Callback-Failure-Callback-Feature-Set": "LazyFetch,InitialBody",
                         "Upstash-Failure-Callback-Forward-Upstash-Workflow-Is-Failure": "true",
                         "Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback": "true",
                         "Upstash-Failure-Callback-Workflow-Runid": "wfr-id",

tests/test_context.py

@@ -65,6 +65,8 @@ def execute() -> None:
                         "Upstash-Workflow-RunId": "wfr-id",
                         "Upstash-Workflow-Url": "https://www.my-website.com/api",
                         "Upstash-Feature-Set": "WF_NoDelete,InitialBody",
+                        "Upstash-Failure-Callback-Feature-Set": "LazyFetch,InitialBody",
+                        "Upstash-Callback-Failure-Callback-Feature-Set": "LazyFetch,InitialBody",
                         "Upstash-Failure-Callback-Forward-Upstash-Workflow-Is-Failure": "true",
                         "Upstash-Failure-Callback-Forward-Upstash-Workflow-Failure-Callback": "true",
                         "Upstash-Failure-Callback-Workflow-Runid": "wfr-id",

upstash_workflow/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 
 from upstash_workflow.context.context import WorkflowContext
 from upstash_workflow.serve.serve import serve

upstash_workflow/asyncio/serve/options.py

@@ -4,7 +4,11 @@
 from typing import Callable, Dict, Optional, cast, TypeVar, Any, Generic, Awaitable
 from qstash import AsyncQStash, Receiver
 from upstash_workflow.workflow_types import _Response
-from upstash_workflow.constants import DEFAULT_RETRIES
+from upstash_workflow.constants import (
+    DEFAULT_RETRIES,
+    WORKFLOW_PROTOCOL_VERSION_HEADER,
+    WORKFLOW_PROTOCOL_VERSION,
+)
 from upstash_workflow.types import (
     _FinishCondition,
 )
@@ -74,11 +78,19 @@ def _on_step_finish(
                         "workflowRunId": workflow_run_id,
                     },
                     status=400,
+                    headers={
+                        WORKFLOW_PROTOCOL_VERSION_HEADER: WORKFLOW_PROTOCOL_VERSION
+                    },
                 ),
             )
 
         return cast(
-            TResponse, _Response(body={"workflowRunId": workflow_run_id}, status=200)
+            TResponse,
+            _Response(
+                body={"workflowRunId": workflow_run_id},
+                status=200,
+                headers={WORKFLOW_PROTOCOL_VERSION_HEADER: WORKFLOW_PROTOCOL_VERSION},
+            ),
         )
 
     def _initial_payload_parser(initial_request: str) -> TInitialPayload:

upstash_workflow/serve/options.py

@@ -16,7 +16,11 @@
 )
 from qstash import QStash, Receiver
 from upstash_workflow.workflow_types import _Response, _SyncRequest, _AsyncRequest
-from upstash_workflow.constants import DEFAULT_RETRIES
+from upstash_workflow.constants import (
+    DEFAULT_RETRIES,
+    WORKFLOW_PROTOCOL_VERSION_HEADER,
+    WORKFLOW_PROTOCOL_VERSION,
+)
 from upstash_workflow.types import (
     _FinishCondition,
 )
@@ -99,11 +103,19 @@ def _on_step_finish(
                         "workflowRunId": workflow_run_id,
                     },
                     status=400,
+                    headers={
+                        WORKFLOW_PROTOCOL_VERSION_HEADER: WORKFLOW_PROTOCOL_VERSION
+                    },
                 ),
             )
 
         return cast(
-            TResponse, _Response(body={"workflowRunId": workflow_run_id}, status=200)
+            TResponse,
+            _Response(
+                body={"workflowRunId": workflow_run_id},
+                status=200,
+                headers={WORKFLOW_PROTOCOL_VERSION_HEADER: WORKFLOW_PROTOCOL_VERSION},
+            ),
         )
 
     def _initial_payload_parser(initial_request: str) -> TInitialPayload:

upstash_workflow/workflow_requests.py

@@ -278,7 +278,7 @@ def _get_headers(
         WORKFLOW_INIT_HEADER: init_header_value,
         WORKFLOW_ID_HEADER: workflow_run_id,
         WORKFLOW_URL_HEADER: workflow_url,
-        WORKFLOW_FEATURE_HEADER: "LazyFetch,InitialBody",
+        WORKFLOW_FEATURE_HEADER: "LazyFetch,InitialBody,WF_DetectTrigger",
     }
 
     if not (step and step.call_url):
@@ -300,6 +300,7 @@ def _get_headers(
         base_headers["Upstash-Failure-Callback-Workflow-Init"] = "false"
         base_headers["Upstash-Failure-Callback-Workflow-Url"] = workflow_url
         base_headers["Upstash-Failure-Callback-Workflow-Calltype"] = "failureCall"
+        base_headers["Upstash-Failure-Callback-Feature-Set"] = "LazyFetch,InitialBody"
         if step and step.call_url:
             base_headers[
                 f"Upstash-Callback-Failure-Callback-Forward-{WORKFLOW_FAILURE_HEADER}"
@@ -317,6 +318,9 @@ def _get_headers(
             base_headers["Upstash-Callback-Failure-Callback-Workflow-Calltype"] = (
                 "failureCall"
             )
+            base_headers["Upstash-Callback-Failure-Callback-Feature-Set"] = (
+                "LazyFetch,InitialBody"
+            )
 
         if _should_set_retries(retries):
             base_headers["Upstash-Failure-Callback-Retries"] = str(retries)