vellum-workflow-server 1.8.2__py3-none-any.whl → 1.10.7__py3-none-any.whl

workflow_server/api/workflow_view.py

@@ -8,6 +8,7 @@ import os
 import pkgutil
 from queue import Empty
 import sys
+import threading
 import time
 import traceback
 from uuid import uuid4
@@ -71,7 +72,6 @@ WORKFLOW_INITIATION_TIMEOUT_SECONDS = 60
 @bp.route("/stream", methods=["POST"])
 def stream_workflow_route() -> Response:
     data = request.get_json()
-
     try:
         context = WorkflowExecutorContext.model_validate(data)
     except ValidationError as e:
@@ -84,28 +84,7 @@ def stream_workflow_route() -> Response:
             content_type="application/json",
         )
 
-    logger.info(
-        f"Starting Workflow Server Request, trace ID: {context.trace_id}, "
-        f"process count: {get_active_process_count()}, process wrapper: {ENABLE_PROCESS_WRAPPER}"
-    )
-
-    # Create this event up here so timestamps are fully from the start to account for any unknown overhead
-    vembda_initiated_event = VembdaExecutionInitiatedEvent(
-        id=uuid4(),
-        timestamp=datetime.now(),
-        trace_id=context.trace_id,
-        span_id=context.execution_id,
-        body=VembdaExecutionInitiatedBody.model_validate(get_version()),
-        parent=None,
-    )
-
-    process_output_queue: Queue[Union[str, dict]] = Queue()
-
-    headers = {
-        "X-Vellum-SDK-Version": vembda_initiated_event.body.sdk_version,
-        "X-Vellum-Server-Version": vembda_initiated_event.body.server_version,
-        "X-Vellum-Events-Emitted": str(is_events_emitting_enabled(context)),
-    }
+    headers = _get_headers(context)
 
     # We can exceed the concurrency count currently with long running workflows due to a knative issue. So here
     # if we detect a memory problem just exit us early
@@ -122,6 +101,183 @@ def stream_workflow_route() -> Response:
             headers=headers,
         )
 
+    start_workflow_state = _start_workflow(context)
+    if isinstance(start_workflow_state, Response):
+        return start_workflow_state
+
+    workflow_events, vembda_initiated_event, process, span_id, headers = start_workflow_state
+
+    def generator() -> Generator[str, None, None]:
+        try:
+            yield "\n"
+            yield vembda_initiated_event.model_dump_json()
+            yield "\n"
+            for row in workflow_events:
+                yield "\n"
+                if isinstance(row, dict):
+                    dump = json.dumps(row)
+                    yield dump
+                else:
+                    yield row
+                yield "\n"
+            # Sometimes the connections get hung after they finish with the vembda fulfilled event
+            # if it happens during a knative scale down event. So we emit an END string so that
+            # we don't have to do string compares on all the events for performance.
+            yield "\n"
+            yield "END"
+            yield "\n"
+
+            logger.info(
+                f"Workflow stream completed, execution ID: {span_id}, process count: {get_active_process_count()}"
+            )
+        except GeneratorExit:
+            # These can happen either from Vembda disconnects (possibily from predict disconnects) or
+            # from knative activator gateway timeouts which are caused by idleTimeout or responseStartSeconds
+            # being exceeded.
+            app.logger.error(
+                "Client disconnected in the middle of the Workflow Stream",
+                extra={
+                    "sentry_tags": {
+                        "server_version": vembda_initiated_event.body.server_version,
+                        "sdk_version": vembda_initiated_event.body.sdk_version,
+                    }
+                },
+            )
+            return
+        except Exception as e:
+            logger.exception("Error during workflow response stream generator", extra={"error": e})
+            yield "\n"
+            yield "END"
+            yield "\n"
+            return
+        finally:
+            if ENABLE_PROCESS_WRAPPER:
+                try:
+                    if process and process.is_alive():
+                        process.kill()
+                    if process:
+                        increment_process_count(-1)
+                        remove_active_span_id(span_id)
+                except Exception as e:
+                    logger.error("Failed to kill process", e)
+            else:
+                increment_process_count(-1)
+                remove_active_span_id(span_id)
+
+    resp = Response(
+        stream_with_context(generator()),
+        status=200,
+        content_type="application/x-ndjson",
+        headers=headers,
+    )
+    return resp
+
+
+@bp.route("/async-exec", methods=["POST"])
+def async_exec_workflow() -> Response:
+    data = request.get_json()
+    try:
+        context = WorkflowExecutorContext.model_validate(data)
+    except ValidationError as e:
+        error_message = e.errors()[0]["msg"]
+        error_location = e.errors()[0]["loc"]
+
+        # TODO need to convert this to a vembda event so that trigger'd execs can me notified
+        #  can either do it here in the workflow server or
+        return Response(
+            json.dumps({"detail": f"Invalid context: {error_message} at {error_location}"}),
+            status=400,
+            content_type="application/json",
+        )
+
+    # Reject back to the queue handler if were low on memory here, though maybe we should update the is_available
+    # route to look at memory too. Don't send this response as an event. Though we might want some logic to catch
+    # if they have a workflow server that can never start a workflow because the base image uses so much memory.
+    if not wait_for_available_process():
+        return Response(
+            json.dumps({"detail": f"Server resources low." f"Process count: {get_active_process_count()}"}),
+            status=429,
+            content_type="application/json",
+        )
+
+    def run_workflow_background() -> None:
+        process: Optional[Process] = None
+        span_id: Optional[str] = None
+
+        try:
+            start_workflow_result = _start_workflow(context)
+            if isinstance(start_workflow_result, Response):
+                # TODO same here, should return this response as en event or it will get yeeted to the nether
+                # return start_workflow_result
+                return
+
+            workflow_events, vembda_initiated_event, process, span_id, headers = start_workflow_result
+
+            for _ in workflow_events:
+                # This is way inefficient in process mode since were just having the main proc stream the events
+                # to nowhere wasting memory I/O and cpu.
+                continue
+            logger.info(
+                f"Workflow async exec completed, execution ID: {span_id}, process count: {get_active_process_count()}"
+            )
+        except Exception as e:
+            logger.exception("Error during workflow async background worker", e)
+        finally:
+            if ENABLE_PROCESS_WRAPPER:
+                try:
+                    if process and process.is_alive():
+                        process.kill()
+                    if process:
+                        increment_process_count(-1)
+                        if span_id:
+                            remove_active_span_id(span_id)
+                except Exception as e:
+                    logger.error("Failed to kill process", e)
+            else:
+                increment_process_count(-1)
+                if span_id:
+                    remove_active_span_id(span_id)
+
+    thread = threading.Thread(target=run_workflow_background)
+    thread.start()
+
+    return Response(
+        json.dumps({"success": True}),
+        status=200,
+        content_type="application/json",
+    )
+
+
+def _start_workflow(
+    context: WorkflowExecutorContext,
+) -> Union[
+    Response,
+    tuple[
+        Iterator[Union[str, dict]],
+        VembdaExecutionInitiatedEvent,
+        Optional[Process],
+        str,
+        dict[str, str],
+    ],
+]:
+    headers = _get_headers(context)
+    logger.info(
+        f"Starting Workflow Server Request, trace ID: {context.trace_id}, "
+        f"process count: {get_active_process_count()}, process wrapper: {ENABLE_PROCESS_WRAPPER}"
+    )
+
+    # Create this event up here so timestamps are fully from the start to account for any unknown overhead
+    version_data = get_version()
+    vembda_initiated_event = VembdaExecutionInitiatedEvent(
+        id=uuid4(),
+        timestamp=datetime.now(),
+        trace_id=context.trace_id,
+        span_id=context.execution_id,
+        body=VembdaExecutionInitiatedBody.model_validate(version_data),
+        parent=None,
+    )
+
+    output_queue: Queue[Union[str, dict]] = Queue()
     cancel_signal = MultiprocessingEvent()
     timeout_signal = MultiprocessingEvent()
 
@@ -130,7 +286,7 @@ def stream_workflow_route() -> Response:
         try:
             process = stream_workflow_process_timeout(
                 executor_context=context,
-                queue=process_output_queue,
+                queue=output_queue,
                 cancel_signal=cancel_signal,
                 timeout_signal=timeout_signal,
             )
@@ -138,10 +294,10 @@ def stream_workflow_route() -> Response:
         except Exception as e:
             logger.exception(e)
 
-            process_output_queue.put(create_vembda_rejected_event(context, traceback.format_exc()))
+            output_queue.put(create_vembda_rejected_event(context, traceback.format_exc()))
 
         try:
-            first_item = process_output_queue.get(timeout=WORKFLOW_INITIATION_TIMEOUT_SECONDS)
+            first_item = output_queue.get(timeout=WORKFLOW_INITIATION_TIMEOUT_SECONDS)
         except Empty:
             logger.error("Request timed out trying to initiate the Workflow")
 
@@ -290,72 +446,9 @@ def stream_workflow_route() -> Response:
                 break
             yield event
 
-    workflow_events = process_events(process_output_queue)
-
-    def generator() -> Generator[str, None, None]:
-        try:
-            yield "\n"
-            yield vembda_initiated_event.model_dump_json()
-            yield "\n"
-            for row in workflow_events:
-                yield "\n"
-                if isinstance(row, dict):
-                    dump = json.dumps(row)
-                    yield dump
-                else:
-                    yield row
-                yield "\n"
-            # Sometimes the connections get hung after they finish with the vembda fulfilled event
-            # if it happens during a knative scale down event. So we emit an END string so that
-            # we don't have to do string compares on all the events for performance.
-            yield "\n"
-            yield "END"
-            yield "\n"
-
-            logger.info(
-                f"Workflow stream completed, execution ID: {span_id}, process count: {get_active_process_count()}"
-            )
-        except GeneratorExit:
-            # These can happen either from Vembda disconnects (possibily from predict disconnects) or
-            # from knative activator gateway timeouts which are caused by idleTimeout or responseStartSeconds
-            # being exceeded.
-            app.logger.error(
-                "Client disconnected in the middle of the Workflow Stream",
-                extra={
-                    "sentry_tags": {
-                        "server_version": vembda_initiated_event.body.server_version,
-                        "sdk_version": vembda_initiated_event.body.sdk_version,
-                    }
-                },
-            )
-            return
-        except Exception as e:
-            logger.exception("Error during workflow response stream generator", extra={"error": e})
-            yield "\n"
-            yield "END"
-            yield "\n"
-            return
-        finally:
-            if ENABLE_PROCESS_WRAPPER:
-                try:
-                    if process and process.is_alive():
-                        process.kill()
-                    if process:
-                        increment_process_count(-1)
-                        remove_active_span_id(span_id)
-                except Exception as e:
-                    logger.error("Failed to kill process", e)
-            else:
-                increment_process_count(-1)
-                remove_active_span_id(span_id)
+    workflow_events = process_events(output_queue)
 
-    resp = Response(
-        stream_with_context(generator()),
-        status=200,
-        content_type="application/x-ndjson",
-        headers=headers,
-    )
-    return resp
+    return workflow_events, vembda_initiated_event, process, span_id, headers
 
 
 @bp.route("/stream-node", methods=["POST"])
@@ -374,12 +467,13 @@ def stream_node_route() -> Response:
         )
 
     # Create this event up here so timestamps are fully from the start to account for any unknown overhead
+    version_data = get_version()
     vembda_initiated_event = VembdaExecutionInitiatedEvent(
         id=uuid4(),
         timestamp=datetime.now(),
         trace_id=context.trace_id,
         span_id=context.execution_id,
-        body=VembdaExecutionInitiatedBody.model_validate(get_version()),
+        body=VembdaExecutionInitiatedBody.model_validate(version_data),
         parent=None,
     )
 
@@ -433,6 +527,8 @@ def serialize_route() -> Response:
 
     files = data.get("files", {})
     workspace_api_key = data.get("workspace_api_key")
+    is_new_server = data.get("is_new_server", False)
+    module = data.get("module")
 
     if not files:
         return Response(
@@ -445,7 +541,12 @@ def serialize_route() -> Response:
 
     # Generate a unique namespace for this serialization request
     namespace = get_random_namespace()
-    virtual_finder = VirtualFileFinder(files, namespace)
+    virtual_finder = VirtualFileFinder(files, namespace, source_module=module)
+
+    headers = {
+        "X-Vellum-Is-New-Server": str(is_new_server).lower(),
+    }
+
     try:
         sys.meta_path.append(virtual_finder)
         result = BaseWorkflowDisplay.serialize_module(namespace, client=client, dry_run=True)
@@ -454,6 +555,7 @@ def serialize_route() -> Response:
             json.dumps(result.model_dump()),
             status=200,
             content_type="application/json",
+            headers=headers,
         )
 
     except WorkflowInitializationException as e:
@@ -463,6 +565,7 @@ def serialize_route() -> Response:
             json.dumps({"detail": error_message}),
             status=400,
             content_type="application/json",
+            headers=headers,
         )
 
     except Exception as e:
@@ -471,6 +574,7 @@ def serialize_route() -> Response:
             json.dumps({"detail": f"Serialization failed: {str(e)}"}),
             status=500,
             content_type="application/json",
+            headers=headers,
         )
 
     finally:
@@ -553,3 +657,12 @@ def startup_error_generator(
             },
         )
         return
+
+
+def _get_headers(context: WorkflowExecutorContext) -> dict[str, Union[str, Any]]:
+    headers = {
+        "X-Vellum-SDK-Version": get_version()["sdk_version"],
+        "X-Vellum-Server-Version": get_version()["server_version"],
+        "X-Vellum-Events-Emitted": str(is_events_emitting_enabled(context)),
+    }
+    return headers

workflow_server/config.py

@@ -42,6 +42,8 @@ LOCAL_WORKFLOW_MODULE = os.getenv("LOCAL_WORKFLOW_MODULE")
 # The deployment name to match against when using local mode so you can still run your normal workflow
 LOCAL_DEPLOYMENT = os.getenv("LOCAL_DEPLOYMENT")
 
+IS_ASYNC_MODE = os.getenv("IS_ASYNC_MODE", "false").lower() == "true"
+
 
 def is_development() -> bool:
     return os.getenv("FLASK_ENV", "local") == "local"

workflow_server/core/executor.py

@@ -1,5 +1,4 @@
-from datetime import datetime
-import importlib
+from datetime import datetime, timezone
 from io import StringIO
 import json
 import logging
@@ -12,12 +11,13 @@ from threading import Event as ThreadingEvent
 import time
 from traceback import format_exc
 from uuid import UUID, uuid4
-from typing import Any, Callable, Generator, Iterator, Optional, Tuple, Type
+from typing import Any, Callable, Generator, Iterator, Optional, Tuple
 
 from vellum_ee.workflows.display.utils.events import event_enricher
 from vellum_ee.workflows.server.virtual_file_loader import VirtualFileFinder
 
 from vellum.workflows import BaseWorkflow
+from vellum.workflows.context import execution_context
 from vellum.workflows.emitters.base import BaseWorkflowEmitter
 from vellum.workflows.emitters.vellum_emitter import VellumEmitter
 from vellum.workflows.events.exception_handling import stream_initialization_exception
@@ -31,8 +31,9 @@ from vellum.workflows.resolvers.base import BaseWorkflowResolver
 from vellum.workflows.resolvers.resolver import VellumResolver
 from vellum.workflows.state.context import WorkflowContext
 from vellum.workflows.state.store import EmptyStore
+from vellum.workflows.triggers import BaseTrigger
 from vellum.workflows.types import CancelSignal
-from vellum.workflows.workflows.event_filters import all_workflow_event_filter
+from vellum.workflows.workflows.event_filters import workflow_sandbox_event_filter
 from workflow_server.config import LOCAL_DEPLOYMENT, LOCAL_WORKFLOW_MODULE
 from workflow_server.core.cancel_workflow import CancelWorkflowWatcherThread
 from workflow_server.core.events import (
@@ -149,7 +150,21 @@ def stream_workflow(
     cancel_watcher_kill_switch = ThreadingEvent()
     try:
         workflow, namespace = _create_workflow(executor_context)
-        workflow_inputs = _get_workflow_inputs(executor_context, workflow.__class__)
+
+        trigger_id = executor_context.trigger_id
+
+        inputs_or_trigger = workflow.deserialize_trigger(trigger_id=trigger_id, inputs=executor_context.inputs)
+
+        # Determine whether we have inputs or a trigger
+        if isinstance(inputs_or_trigger, BaseInputs):
+            workflow_inputs = inputs_or_trigger
+            trigger = None
+        elif isinstance(inputs_or_trigger, BaseTrigger):
+            workflow_inputs = None
+            trigger = inputs_or_trigger
+        else:
+            workflow_inputs = None
+            trigger = None
 
         workflow_state = (
             workflow.deserialize_state(
@@ -170,15 +185,22 @@ def stream_workflow(
             inputs=workflow_inputs,
             state=workflow_state,
             node_output_mocks=node_output_mocks,
-            event_filter=all_workflow_event_filter,
+            event_filter=workflow_sandbox_event_filter,
             cancel_signal=cancel_signal,
             entrypoint_nodes=[executor_context.node_id] if executor_context.node_id else None,
             previous_execution_id=executor_context.previous_execution_id,
             timeout=executor_context.timeout,
+            trigger=trigger,
+            execution_id=executor_context.workflow_span_id,
         )
     except WorkflowInitializationException as e:
         cancel_watcher_kill_switch.set()
-        initialization_exception_stream = stream_initialization_exception(e)
+
+        with execution_context(
+            parent_context=executor_context.execution_context.parent_context,
+            trace_id=executor_context.execution_context.trace_id,
+        ):
+            initialization_exception_stream = stream_initialization_exception(e)
 
         def _stream_generator() -> Generator[dict[str, Any], Any, None]:
             for event in initialization_exception_stream:
@@ -251,32 +273,11 @@ def stream_node(
     disable_redirect: bool = True,
 ) -> Iterator[dict]:
     workflow, namespace = _create_workflow(executor_context)
-    Node: Optional[Type[BaseNode]] = None
-
-    for workflow_node in workflow.get_nodes():
-        if executor_context.node_id and workflow_node.__id__ == executor_context.node_id:
-            Node = workflow_node
-            break
-        elif (
-            executor_context.node_module
-            and executor_context.node_name
-            and workflow_node.__name__ == executor_context.node_name
-            and workflow_node.__module__ == f"{namespace}.{executor_context.node_module}"
-        ):
-            Node = workflow_node
-            break
-
-    if not Node:
-        identifier = executor_context.node_id or f"{executor_context.node_module}.{executor_context.node_name}"
-        raise WorkflowInitializationException(
-            message=f"Node '{identifier}' not found in workflow",
-            workflow_definition=workflow.__class__,
-        )
 
     def call_node() -> Generator[dict[str, Any], Any, None]:
         executor_context.stream_start_time = time.time_ns()
 
-        for event in workflow.run_node(Node, inputs=executor_context.inputs):  # type: ignore[arg-type]
+        for event in workflow.run_node(executor_context.node_ref, inputs=executor_context.inputs):
             yield event.model_dump(mode="json")
 
     return _call_stream(
@@ -337,7 +338,9 @@ def _call_stream(
 def _create_workflow(executor_context: BaseExecutorContext) -> Tuple[BaseWorkflow, str]:
     namespace = _get_file_namespace(executor_context)
     if namespace != LOCAL_WORKFLOW_MODULE:
-        sys.meta_path.append(VirtualFileFinder(executor_context.files, namespace))
+        sys.meta_path.append(
+            VirtualFileFinder(executor_context.files, namespace, source_module=executor_context.module)
+        )
 
     workflow_context = _create_workflow_context(executor_context)
     Workflow = BaseWorkflow.load_from_module(namespace)
@@ -405,7 +408,7 @@ def get_random_namespace() -> str:
     return "workflow_tmp_" + "".join(random.choice(string.ascii_letters + string.digits) for i in range(14))
 
 
-def _enrich_event(event: WorkflowEvent, vellum_client: Optional[Any]) -> WorkflowEvent:
+def _enrich_event(event: WorkflowEvent, executor_context: Optional[BaseExecutorContext] = None) -> WorkflowEvent:
     """
     Enrich an event with metadata based on the event type.
 
@@ -425,6 +428,17 @@ def _enrich_event(event: WorkflowEvent, vellum_client: Optional[Any]) -> Workflo
             memory_mb = get_memory_in_use_mb()
             if memory_mb is not None:
                 metadata["memory_usage_mb"] = memory_mb
+
+            if executor_context is not None:
+                metadata["is_new_server"] = executor_context.is_new_server
+
+                if executor_context.vembda_service_initiated_timestamp is not None and event.timestamp is not None:
+                    event_ts = event.timestamp
+                    if event_ts.tzinfo is None:
+                        event_ts = event_ts.replace(tzinfo=timezone.utc)
+                    event_ts_ns = int(event_ts.timestamp() * 1_000_000_000)
+                    initiated_latency = event_ts_ns - executor_context.vembda_service_initiated_timestamp
+                    metadata["initiated_latency"] = initiated_latency
         elif event.name == "workflow.execution.fulfilled" and is_deployment:
             metadata = {}
             memory_mb = get_memory_in_use_mb()
@@ -433,6 +447,7 @@ def _enrich_event(event: WorkflowEvent, vellum_client: Optional[Any]) -> Workflo
     except Exception:
         pass
 
+    vellum_client = executor_context.vellum_client if executor_context else None
     return event_enricher(event, vellum_client, metadata=metadata)
 
 
@@ -441,7 +456,7 @@ def _dump_event(event: BaseEvent, executor_context: BaseExecutorContext) -> dict
 
     dump = event.model_dump(
         mode="json",
-        context={"event_enricher": lambda event: _enrich_event(event, executor_context.vellum_client)},
+        context={"event_enricher": lambda event: _enrich_event(event, executor_context)},
     )
     if dump["name"] in {
         "workflow.execution.initiated",
@@ -463,38 +478,3 @@ def _dump_event(event: BaseEvent, executor_context: BaseExecutorContext) -> dict
         dump["body"]["node_definition"]["module"] = module_base + dump["body"]["node_definition"]["module"][1:]
 
     return dump
-
-
-def _get_workflow_inputs(
-    executor_context: BaseExecutorContext, workflow_class: Type[BaseWorkflow]
-) -> Optional[BaseInputs]:
-    if not executor_context.inputs:
-        return None
-
-    if not executor_context.files.get("inputs.py"):
-        return None
-
-    namespace = _get_file_namespace(executor_context)
-    inputs_module_path = f"{namespace}.inputs"
-    try:
-        inputs_module = importlib.import_module(inputs_module_path)
-    except Exception as e:
-        raise WorkflowInitializationException(
-            message=f"Failed to initialize workflow inputs: {e}",
-            workflow_definition=workflow_class,
-        ) from e
-
-    if not hasattr(inputs_module, "Inputs"):
-        raise WorkflowInitializationException(
-            message=f"Inputs module {inputs_module_path} does not have a required Inputs class",
-            workflow_definition=workflow_class,
-        )
-
-    if not issubclass(inputs_module.Inputs, BaseInputs):
-        raise WorkflowInitializationException(
-            message=f"""The class {inputs_module_path}.Inputs was expected to be a subclass of BaseInputs, \
-but found {inputs_module.Inputs.__class__.__name__}""",
-            workflow_definition=workflow_class,
-        )
-
-    return inputs_module.Inputs(**executor_context.inputs)

workflow_server/core/utils.py

@@ -2,6 +2,7 @@ from datetime import datetime
 from uuid import uuid4
 from typing import Optional
 
+from workflow_server.config import IS_ASYNC_MODE
 from workflow_server.core.events import VembdaExecutionFulfilledBody, VembdaExecutionFulfilledEvent
 from workflow_server.core.workflow_executor_context import BaseExecutorContext
 
@@ -46,6 +47,9 @@ def serialize_vembda_rejected_event(
 
 
 def is_events_emitting_enabled(executor_context: Optional[BaseExecutorContext]) -> bool:
+    if IS_ASYNC_MODE:
+        return True
+
     if not executor_context:
         return False
 

workflow_server/core/workflow_executor_context.py

@@ -3,7 +3,7 @@ from functools import cached_property
 import os
 import time
 from uuid import UUID
-from typing import Any, Optional
+from typing import Any, Optional, Union
 from typing_extensions import Self
 
 from flask import has_request_context, request
@@ -36,6 +36,11 @@ class BaseExecutorContext(UniversalBaseModel):
     previous_execution_id: Optional[UUID] = None
     feature_flags: Optional[dict[str, bool]] = None
     is_new_server: bool = False
+    trigger_id: Optional[UUID] = None
+    # The actual 'execution id' of the workflow that we pass into the workflow
+    # when running in async mode.
+    workflow_span_id: Optional[UUID] = None
+    vembda_service_initiated_timestamp: Optional[int] = None
 
     @field_validator("inputs", mode="before")
     @classmethod
@@ -86,6 +91,18 @@ class NodeExecutorContext(BaseExecutorContext):
     node_module: Optional[str] = None
     node_name: Optional[str] = None
 
+    @property
+    def node_ref(self) -> Union[UUID, str]:
+        """
+        Returns the node reference for use with workflow.run_node().
+
+        Returns node_id if it exists, otherwise returns the combination
+        of node_module and node_name as a fully qualified string.
+        """
+        if self.node_id:
+            return self.node_id
+        return f"{self.node_module}.{self.node_name}"
+
     @model_validator(mode="after")
     def validate_node_identification(self) -> Self:
         if not self.node_id and not (self.node_module and self.node_name):

workflow_server/server.py

@@ -5,6 +5,7 @@ from flask import Flask
 
 from workflow_server.api.auth_middleware import AuthMiddleware
 from workflow_server.api.healthz_view import bp as healthz_bp
+from workflow_server.api.status_view import bp as status_bp
 from workflow_server.api.workflow_view import bp as workflow_bp
 from workflow_server.config import is_development
 from workflow_server.logging_config import GCPJsonFormatter
@@ -48,6 +49,7 @@ def create_app() -> Flask:
 
     # Register blueprints
     app.register_blueprint(healthz_bp, url_prefix="/healthz")
+    app.register_blueprint(status_bp, url_prefix="/status")
     app.register_blueprint(workflow_bp, url_prefix="/workflow")
 
     logger.info(is_development())