dbos 1.5.0a10__tar.gz → 1.6.0a3__tar.gz

{dbos-1.5.0a10 → dbos-1.6.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 1.5.0a10
+Version: 1.6.0a3
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_client.py

@@ -1,7 +1,7 @@
 import asyncio
 import sys
 import uuid
-from typing import Any, Generic, List, Optional, TypedDict, TypeVar
+from typing import Any, Generic, List, Optional, TypedDict, TypeVar, Union
 
 from dbos._app_db import ApplicationDatabase
 from dbos._context import MaxPriority, MinPriority
@@ -128,7 +128,6 @@ class DBOSClient:
         workflow_name = options["workflow_name"]
         queue_name = options["queue_name"]
 
-        app_version = options.get("app_version")
         max_recovery_attempts = options.get("max_recovery_attempts")
         if max_recovery_attempts is None:
             max_recovery_attempts = DEFAULT_MAX_RECOVERY_ATTEMPTS
@@ -139,6 +138,7 @@ class DBOSClient:
         enqueue_options_internal: EnqueueOptionsInternal = {
             "deduplication_id": options.get("deduplication_id"),
             "priority": options.get("priority"),
+            "app_version": options.get("app_version"),
         }
 
         inputs: WorkflowInputs = {
@@ -152,7 +152,7 @@ class DBOSClient:
             "name": workflow_name,
             "class_name": None,
             "queue_name": queue_name,
-            "app_version": app_version,
+            "app_version": enqueue_options_internal["app_version"],
             "config_name": None,
             "authenticated_user": None,
             "assumed_role": None,
@@ -284,7 +284,7 @@ class DBOSClient:
         self,
         *,
         workflow_ids: Optional[List[str]] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,
@@ -314,7 +314,7 @@ class DBOSClient:
         self,
         *,
         workflow_ids: Optional[List[str]] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,
@@ -344,7 +344,7 @@ class DBOSClient:
         self,
         *,
         queue_name: Optional[str] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,
@@ -368,7 +368,7 @@ class DBOSClient:
         self,
         *,
         queue_name: Optional[str] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_context.py

@@ -93,6 +93,8 @@ class DBOSContext:
         self.assumed_role: Optional[str] = None
         self.step_status: Optional[StepStatus] = None
 
+        self.app_version: Optional[str] = None
+
         # A user-specified workflow timeout. Takes priority over a propagated deadline.
         self.workflow_timeout_ms: Optional[int] = None
         # A propagated workflow deadline.
@@ -435,7 +437,11 @@ class SetEnqueueOptions:
     """
 
     def __init__(
-        self, *, deduplication_id: Optional[str] = None, priority: Optional[int] = None
+        self,
+        *,
+        deduplication_id: Optional[str] = None,
+        priority: Optional[int] = None,
+        app_version: Optional[str] = None,
     ) -> None:
         self.created_ctx = False
         self.deduplication_id: Optional[str] = deduplication_id
@@ -446,6 +452,8 @@ class SetEnqueueOptions:
             )
         self.priority: Optional[int] = priority
         self.saved_priority: Optional[int] = None
+        self.app_version: Optional[str] = app_version
+        self.saved_app_version: Optional[str] = None
 
     def __enter__(self) -> SetEnqueueOptions:
         # Code to create a basic context
@@ -458,6 +466,8 @@ class SetEnqueueOptions:
         ctx.deduplication_id = self.deduplication_id
         self.saved_priority = ctx.priority
         ctx.priority = self.priority
+        self.saved_app_version = ctx.app_version
+        ctx.app_version = self.app_version
         return self
 
     def __exit__(
@@ -469,6 +479,7 @@ class SetEnqueueOptions:
         curr_ctx = assert_current_dbos_context()
         curr_ctx.deduplication_id = self.saved_deduplication_id
         curr_ctx.priority = self.saved_priority
+        curr_ctx.app_version = self.saved_app_version
         # Code to clean up the basic context if we created it
         if self.created_ctx:
             _clear_local_dbos_context()

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_core.py

@@ -270,7 +270,12 @@ def _init_workflow(
         "output": None,
         "error": None,
         "app_id": ctx.app_id,
-        "app_version": GlobalParams.app_version,
+        "app_version": (
+            enqueue_options["app_version"]
+            if enqueue_options is not None
+            and enqueue_options["app_version"] is not None
+            else GlobalParams.app_version
+        ),
         "executor_id": ctx.executor_id,
         "recovery_attempts": None,
         "authenticated_user": ctx.authenticated_user,
@@ -445,7 +450,8 @@ def execute_workflow_by_id(dbos: "DBOS", workflow_id: str) -> "WorkflowHandle[An
     wf_func = dbos._registry.workflow_info_map.get(status["name"], None)
     if not wf_func:
         raise DBOSWorkflowFunctionNotFoundError(
-            workflow_id, "Workflow function not found"
+            workflow_id,
+            f"Cannot execute workflow because {status['name']} is not a registered workflow function",
         )
     with DBOSContextEnsure():
         # If this function belongs to a configured class, add that class instance as its first argument
@@ -546,6 +552,7 @@ def start_workflow(
     enqueue_options = EnqueueOptionsInternal(
         deduplication_id=local_ctx.deduplication_id if local_ctx is not None else None,
         priority=local_ctx.priority if local_ctx is not None else None,
+        app_version=local_ctx.app_version if local_ctx is not None else None,
     )
     new_wf_id, new_wf_ctx = _get_new_wf()
 
@@ -637,6 +644,7 @@ async def start_workflow_async(
     enqueue_options = EnqueueOptionsInternal(
         deduplication_id=local_ctx.deduplication_id if local_ctx is not None else None,
         priority=local_ctx.priority if local_ctx is not None else None,
+        app_version=local_ctx.app_version if local_ctx is not None else None,
     )
     new_wf_id, new_wf_ctx = _get_new_wf()
 

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_dbos.py

@@ -24,6 +24,7 @@ from typing import (
     Tuple,
     Type,
     TypeVar,
+    Union,
 )
 
 from opentelemetry.trace import Span
@@ -998,7 +999,7 @@ class DBOS:
         cls,
         *,
         workflow_ids: Optional[List[str]] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,
@@ -1034,7 +1035,7 @@ class DBOS:
         cls,
         *,
         queue_name: Optional[str] = None,
-        status: Optional[str] = None,
+        status: Optional[Union[str, List[str]]] = None,
         start_time: Optional[str] = None,
         end_time: Optional[str] = None,
         name: Optional[str] = None,

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_sys_db.py

@@ -149,6 +149,8 @@ class EnqueueOptionsInternal(TypedDict):
     deduplication_id: Optional[str]
     # Priority of the workflow on the queue, starting from 1 ~ 2,147,483,647. Default 0 (highest priority).
     priority: Optional[int]
+    # On what version the workflow is enqueued. Current version if not specified.
+    app_version: Optional[str]
 
 
 class RecordedResult(TypedDict):
@@ -185,7 +187,9 @@ class GetWorkflowsInput:
         self.authenticated_user: Optional[str] = None  # The user who ran the workflow.
         self.start_time: Optional[str] = None  # Timestamp in ISO 8601 format
         self.end_time: Optional[str] = None  # Timestamp in ISO 8601 format
-        self.status: Optional[str] = None
+        self.status: Optional[List[str]] = (
+            None  # Get workflows with one of these statuses
+        )
         self.application_version: Optional[str] = (
             None  # The application version that ran this workflow. = None
         )
@@ -205,7 +209,7 @@ class GetWorkflowsInput:
 
 class GetQueuedWorkflowsInput(TypedDict):
     queue_name: Optional[str]  # Get workflows belonging to this queue
-    status: Optional[str]  # Get workflows with this status
+    status: Optional[list[str]]  # Get workflows with one of these statuses
     start_time: Optional[str]  # Timestamp in ISO 8601 format
     end_time: Optional[str]  # Timestamp in ISO 8601 format
     limit: Optional[int]  # Return up to this many workflows IDs.
@@ -832,7 +836,7 @@ class SystemDatabase:
                 <= datetime.datetime.fromisoformat(input.end_time).timestamp() * 1000
             )
         if input.status:
-            query = query.where(SystemSchema.workflow_status.c.status == input.status)
+            query = query.where(SystemSchema.workflow_status.c.status.in_(input.status))
         if input.application_version:
             query = query.where(
                 SystemSchema.workflow_status.c.application_version
@@ -938,10 +942,9 @@ class SystemDatabase:
                 SystemSchema.workflow_status.c.queue_name == input["queue_name"]
             )
 
-        if input.get("status"):
-            query = query.where(
-                SystemSchema.workflow_status.c.status == input["status"]
-            )
+        status = input.get("status", None)
+        if status:
+            query = query.where(SystemSchema.workflow_status.c.status.in_(status))
         if "start_time" in input and input["start_time"] is not None:
             query = query.where(
                 SystemSchema.workflow_status.c.created_at

{dbos-1.5.0a10 → dbos-1.6.0a3}/dbos/_workflow_commands.py

@@ -1,7 +1,7 @@
 import time
 import uuid
 from datetime import datetime
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, List, Optional, Union
 
 from dbos._context import get_local_dbos_context
 
@@ -23,7 +23,7 @@ def list_workflows(
     sys_db: SystemDatabase,
     *,
     workflow_ids: Optional[List[str]] = None,
-    status: Optional[str] = None,
+    status: Optional[Union[str, List[str]]] = None,
     start_time: Optional[str] = None,
     end_time: Optional[str] = None,
     name: Optional[str] = None,
@@ -39,7 +39,7 @@ def list_workflows(
     input.authenticated_user = user
     input.start_time = start_time
     input.end_time = end_time
-    input.status = status
+    input.status = status if status is None or isinstance(status, list) else [status]
     input.application_version = app_version
     input.limit = limit
     input.name = name
@@ -56,7 +56,7 @@ def list_queued_workflows(
     sys_db: SystemDatabase,
     *,
     queue_name: Optional[str] = None,
-    status: Optional[str] = None,
+    status: Optional[Union[str, List[str]]] = None,
     start_time: Optional[str] = None,
     end_time: Optional[str] = None,
     name: Optional[str] = None,
@@ -68,7 +68,7 @@ def list_queued_workflows(
         "queue_name": queue_name,
         "start_time": start_time,
         "end_time": end_time,
-        "status": status,
+        "status": status if status is None or isinstance(status, list) else [status],
         "limit": limit,
         "name": name,
         "offset": offset,

{dbos-1.5.0a10 → dbos-1.6.0a3}/pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "1.5.0a10"
+version = "1.6.0a3"
 
 [project.license]
 text = "MIT"

{dbos-1.5.0a10 → dbos-1.6.0a3}/tests/test_queue.py

@@ -1515,3 +1515,44 @@ def test_complex_type(dbos: DBOS) -> None:
     event.set()
     check(handle.get_result())
     check(recovery_handle.get_result())
+
+
+def test_enqueue_version(dbos: DBOS) -> None:
+
+    @DBOS.workflow()
+    def workflow(x: int) -> int:
+        return x
+
+    queue = Queue("queue")
+    input = 5
+
+    # Enqueue the app on a different version, verify it has that version
+    future_version = str(uuid.uuid4())
+    with SetEnqueueOptions(app_version=future_version):
+        handle = queue.enqueue(workflow, input)
+    assert handle.get_status().app_version == future_version
+
+    # Change the global version, verify it works
+    GlobalParams.app_version = future_version
+    assert handle.get_result() == input
+
+
+@pytest.mark.asyncio
+async def test_enqueue_version_async(dbos: DBOS) -> None:
+
+    @DBOS.workflow()
+    async def workflow(x: int) -> int:
+        return x
+
+    queue = Queue("queue")
+    input = 5
+
+    # Enqueue the app on a different version, verify it has that version
+    future_version = str(uuid.uuid4())
+    with SetEnqueueOptions(app_version=future_version):
+        handle = await queue.enqueue_async(workflow, input)
+    assert (await handle.get_status()).app_version == future_version
+
+    # Change the global version, verify it works
+    GlobalParams.app_version = future_version
+    assert await handle.get_result() == input

{dbos-1.5.0a10 → dbos-1.6.0a3}/tests/test_workflow_introspection.py

@@ -49,6 +49,8 @@ def test_list_workflow(dbos: DBOS) -> None:
     assert len(outputs) == 0
     outputs = DBOS.list_workflows(status="SUCCESS")
     assert len(outputs) == 1
+    outputs = DBOS.list_workflows(status=["SUCCESS", "PENDING"])
+    assert len(outputs) == 1
 
     # Test searching by workflow name
     outputs = DBOS.list_workflows(name="no")
@@ -258,6 +260,8 @@ def test_queued_workflows(dbos: DBOS) -> None:
     assert len(workflows) == queued_steps
     workflows = DBOS.list_queued_workflows(status=WorkflowStatusString.ENQUEUED.value)
     assert len(workflows) == 0
+    workflows = DBOS.list_queued_workflows(status=["ENQUEUED", "PENDING"])
+    assert len(workflows) == queued_steps
     workflows = DBOS.list_queued_workflows(queue_name=queue.name)
     assert len(workflows) == queued_steps
     workflows = DBOS.list_queued_workflows(queue_name="no")