vellum-workflow-server 1.8.6.post2__tar.gz → 1.9.2__tar.gz

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-workflow-server
-Version: 1.8.6.post2
+Version: 1.9.2
 Summary: 
 License: AGPL
 Requires-Python: >=3.9.0,<4
@@ -29,7 +29,7 @@ Requires-Dist: pyjwt (==2.10.0)
 Requires-Dist: python-dotenv (==1.0.1)
 Requires-Dist: retrying (==1.3.4)
 Requires-Dist: sentry-sdk[flask] (==2.20.0)
-Requires-Dist: vellum-ai (==1.8.6)
+Requires-Dist: vellum-ai (==1.9.2)
 Description-Content-Type: text/markdown
 
 # Vellum Workflow Runner Server

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "vellum-workflow-server"
 
 [tool.poetry]
 name = "vellum-workflow-server"
-version = "1.8.6.post2"
+version = "1.9.2"
 description = ""
 readme = "README.md"
 authors = []
@@ -45,7 +45,7 @@ flask = "2.3.3"
 orderly-set = "5.2.2"
 pebble = "5.0.7"
 gunicorn = "23.0.0"
-vellum-ai = "1.8.6"
+vellum-ai = "1.9.2"
 python-dotenv = "1.0.1"
 retrying = "1.3.4"
 sentry-sdk = {extras = ["flask"], version = "2.20.0"}

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/workflow_server/api/auth_middleware.py

@@ -5,7 +5,7 @@ from flask import Flask, Request, Response
 import jwt
 from jwt import ExpiredSignatureError
 
-from workflow_server.config import IS_VPC, NAMESPACE, VEMBDA_PUBLIC_KEY, is_development
+from workflow_server.config import IS_ASYNC_MODE, IS_VPC, NAMESPACE, VEMBDA_PUBLIC_KEY, is_development
 
 
 class AuthMiddleware:
@@ -15,7 +15,7 @@ class AuthMiddleware:
     def __call__(self, environ: Dict[str, Any], start_response: Any) -> Any:
         try:
             request = Request(environ)
-            if not request.path.startswith("/healthz") and not is_development() and not IS_VPC:
+            if not request.path.startswith("/healthz") and not is_development() and not IS_VPC and not IS_ASYNC_MODE:
                 token = request.headers.get("X-Vembda-Signature")
                 if token:
                     decoded = jwt.decode(token, VEMBDA_PUBLIC_KEY, algorithms=["RS256"])

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/workflow_server/api/tests/test_workflow_view.py

@@ -537,6 +537,57 @@ def test_serialize_route__with_invalid_workspace_api_key():
     assert "exec_config" in response.json
 
 
+def test_serialize_route__with_is_new_server_header():
+    """
+    Tests that the serialize route returns the is_new_server header.
+    """
+    # GIVEN a Flask application
+    flask_app = create_app()
+
+    workflow_files = {
+        "__init__.py": "",
+        "workflow.py": (
+            "from vellum.workflows import BaseWorkflow\n\n"
+            "class Workflow(BaseWorkflow):\n"
+            "    class Outputs(BaseWorkflow.Outputs):\n"
+            "        foo = 'hello'\n"
+        ),
+    }
+
+    # WHEN we make a request with is_new_server=True
+    with flask_app.test_client() as test_client:
+        response = test_client.post("/workflow/serialize", json={"files": workflow_files, "is_new_server": True})
+
+    # THEN we should get a successful response
+    assert response.status_code == 200
+
+    # AND the response should contain the is_new_server header set to true
+    assert "X-Vellum-Is-New-Server" in response.headers
+    assert response.headers["X-Vellum-Is-New-Server"] == "true"
+
+    # WHEN we make a request with is_new_server=False
+    with flask_app.test_client() as test_client:
+        response = test_client.post("/workflow/serialize", json={"files": workflow_files, "is_new_server": False})
+
+    # THEN we should get a successful response
+    assert response.status_code == 200
+
+    # AND the response should contain the is_new_server header set to false
+    assert "X-Vellum-Is-New-Server" in response.headers
+    assert response.headers["X-Vellum-Is-New-Server"] == "false"
+
+    # WHEN we make a request without is_new_server
+    with flask_app.test_client() as test_client:
+        response = test_client.post("/workflow/serialize", json={"files": workflow_files})
+
+    # THEN we should get a successful response
+    assert response.status_code == 200
+
+    # AND the response should contain the is_new_server header set to false (default)
+    assert "X-Vellum-Is-New-Server" in response.headers
+    assert response.headers["X-Vellum-Is-New-Server"] == "false"
+
+
 def test_stream_node_route__with_node_id():
     """
     Tests that the stream-node endpoint works with node_id.

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/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,19 +72,195 @@ 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:
+        error_message = e.errors()[0]["msg"]
+        error_location = e.errors()[0]["loc"]
+
+        return Response(
+            json.dumps({"detail": f"Invalid context: {error_message} at {error_location}"}),
+            status=400,
+            content_type="application/json",
+        )
+
+    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
+    if not wait_for_available_process():
+        return Response(
+            json.dumps(
+                {
+                    "detail": f"Workflow server concurrent request rate exceeded. "
+                    f"Process count: {get_active_process_count()}"
+                }
+            ),
+            status=429,
+            content_type="application/json",
+            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}"
@@ -100,29 +277,7 @@ def stream_workflow_route() -> Response:
         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)),
-    }
-
-    # 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
-    if not wait_for_available_process():
-        return Response(
-            json.dumps(
-                {
-                    "detail": f"Workflow server concurrent request rate exceeded. "
-                    f"Process count: {get_active_process_count()}"
-                }
-            ),
-            status=429,
-            content_type="application/json",
-            headers=headers,
-        )
-
+    output_queue: Queue[Union[str, dict]] = Queue()
     cancel_signal = MultiprocessingEvent()
     timeout_signal = MultiprocessingEvent()
 
@@ -131,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,
             )
@@ -139,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")
 
@@ -291,72 +446,9 @@ def stream_workflow_route() -> Response:
                 break
             yield event
 
-    workflow_events = process_events(process_output_queue)
+    workflow_events = process_events(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)
-
-    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"])
@@ -435,6 +527,7 @@ 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)
 
     if not files:
         return Response(
@@ -448,6 +541,11 @@ def serialize_route() -> Response:
     # Generate a unique namespace for this serialization request
     namespace = get_random_namespace()
     virtual_finder = VirtualFileFinder(files, namespace)
+
+    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)
@@ -456,6 +554,7 @@ def serialize_route() -> Response:
             json.dumps(result.model_dump()),
             status=200,
             content_type="application/json",
+            headers=headers,
         )
 
     except WorkflowInitializationException as e:
@@ -465,6 +564,7 @@ def serialize_route() -> Response:
             json.dumps({"detail": error_message}),
             status=400,
             content_type="application/json",
+            headers=headers,
         )
 
     except Exception as e:
@@ -473,6 +573,7 @@ def serialize_route() -> Response:
             json.dumps({"detail": f"Serialization failed: {str(e)}"}),
             status=500,
             content_type="application/json",
+            headers=headers,
         )
 
     finally:
@@ -555,3 +656,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

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/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"

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/workflow_server/core/executor.py

@@ -1,5 +1,4 @@
 from datetime import datetime
-import importlib
 from io import StringIO
 import json
 import logging
@@ -32,6 +31,7 @@ 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 workflow_sandbox_event_filter
 from workflow_server.config import LOCAL_DEPLOYMENT, LOCAL_WORKFLOW_MODULE
@@ -150,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(
@@ -176,6 +190,7 @@ def stream_workflow(
             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,
         )
     except WorkflowInitializationException as e:
         cancel_watcher_kill_switch.set()
@@ -473,38 +488,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)

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/workflow_server/core/workflow_executor_context.py

@@ -36,6 +36,10 @@ 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
 
     @field_validator("inputs", mode="before")
     @classmethod

{vellum_workflow_server-1.8.6.post2 → vellum_workflow_server-1.9.2}/src/workflow_server/start.py

@@ -33,6 +33,7 @@ class CustomGunicornLogger(glogging.Logger):
         logger = logging.getLogger("gunicorn.access")
         logger.addFilter(HealthCheckFilter())
         logger.addFilter(SignalFilter())
+        logger.addFilter(StatusIsAvailableFilter())
 
 
 class HealthCheckFilter(logging.Filter):
@@ -45,6 +46,11 @@ class SignalFilter(logging.Filter):
         return "SIGTERM" not in record.getMessage()
 
 
+class StatusIsAvailableFilter(logging.Filter):
+    def filter(self, record: Any) -> bool:
+        return "/status/is_available" not in record.getMessage()
+
+
 def start() -> None:
     if not is_development():
         start_oom_killer_worker()