dbos 0.23.0a5__tar.gz → 0.23.0a8__tar.gz

{dbos-0.23.0a5 → dbos-0.23.0a8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dbos
-Version: 0.23.0a5
+Version: 0.23.0a8
 Summary: Ultra-lightweight durable execution in Python
 Author-Email: "DBOS, Inc." <contact@dbos.dev>
 License: MIT
@@ -78,6 +78,9 @@ You can use DBOS to add reliable background jobs or cron scheduling or queues to
 Install and configure with:
 
 ```shell
+python3 -m venv dbos-example/.venv
+cd dbos-example
+source .venv/bin/activate
 pip install dbos
 dbos init --config
 ```
@@ -103,7 +106,7 @@ def step_two():
 def dbos_workflow():
     step_one()
     for _ in range(5):
-        print("Press Control + \ to stop the app...")
+        print("Press Control + C twice to stop the app...")
         DBOS.sleep(1)
     step_two()
 
@@ -114,7 +117,7 @@ def fastapi_endpoint():
 
 Save the program into `main.py` and start it with `fastapi run`.
 Visit `localhost:8000` in your browser to start the workflow.
-When prompted, press `Control + \` to force quit your application.
+When prompted, press `Control + C` (You may need to press `Control + C` twice quickly, or press `Control + \`, if `Control + C` is not effective in your environment) to force quit your application.
 It should crash midway through the workflow, having completed step one but not step two.
 Then, restart your app with `fastapi run`.
 It should resume the workflow from where it left off, completing step two without re-executing step one.

{dbos-0.23.0a5 → dbos-0.23.0a8}/README.md

@@ -51,6 +51,9 @@ You can use DBOS to add reliable background jobs or cron scheduling or queues to
 Install and configure with:
 
 ```shell
+python3 -m venv dbos-example/.venv
+cd dbos-example
+source .venv/bin/activate
 pip install dbos
 dbos init --config
 ```
@@ -76,7 +79,7 @@ def step_two():
 def dbos_workflow():
     step_one()
     for _ in range(5):
-        print("Press Control + \ to stop the app...")
+        print("Press Control + C twice to stop the app...")
         DBOS.sleep(1)
     step_two()
 
@@ -87,7 +90,7 @@ def fastapi_endpoint():
 
 Save the program into `main.py` and start it with `fastapi run`.
 Visit `localhost:8000` in your browser to start the workflow.
-When prompted, press `Control + \` to force quit your application.
+When prompted, press `Control + C` (You may need to press `Control + C` twice quickly, or press `Control + \`, if `Control + C` is not effective in your environment) to force quit your application.
 It should crash midway through the workflow, having completed step one but not step two.
 Then, restart your app with `fastapi run`.
 It should resume the workflow from where it left off, completing step two without re-executing step one.

{dbos-0.23.0a5 → dbos-0.23.0a8}/dbos/_croniter.py

@@ -5,14 +5,14 @@ Copyright (C) 2010-2012 Matsumoto Taichi.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, 
+without restriction, including without limitation the rights to use, copy, modify,
 merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

{dbos-0.23.0a5 → dbos-0.23.0a8}/dbos/_migrations/versions/5c361fc04708_added_system_tables.py

@@ -2,7 +2,7 @@
 Add system tables.
 
 Revision ID: 5c361fc04708
-Revises: 
+Revises:
 Create Date: 2024-07-21 13:06:13.724602
 # mypy: allow-untyped-defs, allow-untyped-calls
 """

{dbos-0.23.0a5 → dbos-0.23.0a8}/dbos/_sys_db.py

@@ -14,9 +14,7 @@ from typing import (
     Optional,
     Sequence,
     Set,
-    Tuple,
     TypedDict,
-    cast,
 )
 
 import psycopg
@@ -126,6 +124,7 @@ class GetWorkflowsInput:
         self.offset: Optional[int] = (
             None  # Offset into the matching records for pagination
         )
+        self.sort_desc: bool = False  # If true, sort by created_at in DESC order. Default false (in ASC order).
 
 
 class GetQueuedWorkflowsInput(TypedDict):
@@ -136,6 +135,7 @@ class GetQueuedWorkflowsInput(TypedDict):
     limit: Optional[int]  # Return up to this many workflows IDs.
     offset: Optional[int]  # Offset into the matching records for pagination
     name: Optional[str]  # The name of the workflow function
+    sort_desc: Optional[bool]  # Sort by created_at in DESC or ASC order
 
 
 class GetWorkflowsOutput:
@@ -149,25 +149,6 @@ class GetPendingWorkflowsOutput:
         self.queue_name: Optional[str] = queue_name
 
 
-class WorkflowInformation(TypedDict, total=False):
-    workflow_uuid: str
-    status: WorkflowStatuses  # The status of the workflow.
-    name: str  # The name of the workflow function.
-    workflow_class_name: str  # The class name holding the workflow function.
-    workflow_config_name: (
-        str  # The name of the configuration, if the class needs configuration
-    )
-    authenticated_user: str  # The user who ran the workflow. Empty string if not set.
-    assumed_role: str
-    # The role used to run this workflow.  Empty string if authorization is not required.
-    authenticated_roles: List[str]
-    # All roles the authenticated user has, if any.
-    input: Optional[_serialization.WorkflowInputs]
-    output: Optional[str]
-    error: Optional[str]
-    request: Optional[str]
-
-
 _dbos_null_topic = "__null__topic__"
 _buffer_flush_batch_size = 100
 _buffer_flush_interval_secs = 1.0
@@ -637,9 +618,11 @@ class SystemDatabase:
             return inputs
 
     def get_workflows(self, input: GetWorkflowsInput) -> GetWorkflowsOutput:
-        query = sa.select(SystemSchema.workflow_status.c.workflow_uuid).order_by(
-            SystemSchema.workflow_status.c.created_at.asc()
-        )
+        query = sa.select(SystemSchema.workflow_status.c.workflow_uuid)
+        if input.sort_desc:
+            query = query.order_by(SystemSchema.workflow_status.c.created_at.desc())
+        else:
+            query = query.order_by(SystemSchema.workflow_status.c.created_at.asc())
         if input.name:
             query = query.where(SystemSchema.workflow_status.c.name == input.name)
         if input.authenticated_user:
@@ -683,15 +666,15 @@ class SystemDatabase:
         self, input: GetQueuedWorkflowsInput
     ) -> GetWorkflowsOutput:
 
-        query = (
-            sa.select(SystemSchema.workflow_queue.c.workflow_uuid)
-            .join(
-                SystemSchema.workflow_status,
-                SystemSchema.workflow_queue.c.workflow_uuid
-                == SystemSchema.workflow_status.c.workflow_uuid,
-            )
-            .order_by(SystemSchema.workflow_status.c.created_at.asc())
+        query = sa.select(SystemSchema.workflow_queue.c.workflow_uuid).join(
+            SystemSchema.workflow_status,
+            SystemSchema.workflow_queue.c.workflow_uuid
+            == SystemSchema.workflow_status.c.workflow_uuid,
         )
+        if input["sort_desc"]:
+            query = query.order_by(SystemSchema.workflow_status.c.created_at.desc())
+        else:
+            query = query.order_by(SystemSchema.workflow_status.c.created_at.asc())
 
         if input.get("name"):
             query = query.where(SystemSchema.workflow_status.c.name == input["name"])

{dbos-0.23.0a5 → dbos-0.23.0a8}/dbos/_templates/dbos-db-starter/migrations/versions/2024_07_31_180642_init.py

@@ -2,7 +2,7 @@
 Initialize application database.
 
 Revision ID: c6b516e182b2
-Revises: 
+Revises:
 Create Date: 2024-07-31 18:06:42.500040
 """
 

{dbos-0.23.0a5 → dbos-0.23.0a8}/dbos/_workflow_commands.py

@@ -49,6 +49,7 @@ def list_workflows(
     name: Optional[str] = None,
     limit: Optional[int] = None,
     offset: Optional[int] = None,
+    sort_desc: bool = False,
 ) -> List[WorkflowInformation]:
     input = GetWorkflowsInput()
     input.workflow_ids = workflow_ids
@@ -61,6 +62,7 @@ def list_workflows(
     input.limit = limit
     input.name = name
     input.offset = offset
+    input.sort_desc = sort_desc
 
     output: GetWorkflowsOutput = sys_db.get_workflows(input)
     infos: List[WorkflowInformation] = []
@@ -82,6 +84,7 @@ def list_queued_workflows(
     name: Optional[str] = None,
     request: bool = False,
     offset: Optional[int] = None,
+    sort_desc: bool = False,
 ) -> List[WorkflowInformation]:
     input: GetQueuedWorkflowsInput = {
         "queue_name": queue_name,
@@ -91,6 +94,7 @@ def list_queued_workflows(
         "limit": limit,
         "name": name,
         "offset": offset,
+        "sort_desc": sort_desc,
     }
     output: GetWorkflowsOutput = sys_db.get_queued_workflows(input)
     infos: List[WorkflowInformation] = []

{dbos-0.23.0a5 → dbos-0.23.0a8}/pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 readme = "README.md"
-version = "0.23.0a5"
+version = "0.23.0a8"
 
 [project.license]
 text = "MIT"

{dbos-0.23.0a5 → dbos-0.23.0a8}/tests/test_croniter.py

@@ -5,14 +5,14 @@ Copyright (C) 2010-2012 Matsumoto Taichi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, 
+without restriction, including without limitation the rights to use, copy, modify,
 merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
 persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

{dbos-0.23.0a5 → dbos-0.23.0a8}/tests/test_workflow_cmds.py

@@ -89,6 +89,13 @@ def test_list_workflow_limit(dbos: DBOS, sys_db: SystemDatabase) -> None:
     # Test all workflows appear
     outputs = _workflow_commands.list_workflows(sys_db)
     assert len(outputs) == num_workflows
+    for i, output in enumerate(outputs):
+        assert output.workflow_id == str(i)
+
+    # Test sort_desc inverts the order:
+    outputs = _workflow_commands.list_workflows(sys_db, sort_desc=True)
+    for i, output in enumerate(outputs):
+        assert output.workflow_id == str(num_workflows - i - 1)
 
     # Test LIMIT 2 returns the first two
     outputs = _workflow_commands.list_workflows(sys_db, limit=2)
@@ -235,6 +242,14 @@ def test_queued_workflows(dbos: DBOS, sys_db: SystemDatabase) -> None:
         assert workflow.updated_at is not None and workflow.updated_at > 0
         assert workflow.recovery_attempts == 1
 
+    # Test sort_desc inverts the order
+    workflows = _workflow_commands.list_queued_workflows(sys_db, sort_desc=True)
+    assert len(workflows) == queued_steps
+    for i, workflow in enumerate(workflows):
+        # Verify newest queue entries appear first
+        assert workflow.input is not None
+        assert workflow.input["args"][0] == queued_steps - i - 1
+
     # Verify list_workflows also properly lists the blocking steps
     workflows = _workflow_commands.list_workflows(sys_db)
     assert len(workflows) == queued_steps + 1