dbos 0.24.0a5__tar.gz → 0.24.0a6__tar.gz

{dbos-0.24.0a5 → dbos-0.24.0a6}/PKG-INFO

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

{dbos-0.24.0a5 → dbos-0.24.0a6}/dbos/_core.py

@@ -824,7 +824,9 @@ def decorate_step(
             stepOutcome = Outcome[R].make(functools.partial(func, *args, **kwargs))
             if retries_allowed:
                 stepOutcome = stepOutcome.retry(
-                    max_attempts, on_exception, lambda i: DBOSMaxStepRetriesExceeded()
+                    max_attempts,
+                    on_exception,
+                    lambda i: DBOSMaxStepRetriesExceeded(func.__name__, i),
                 )
 
             outcome = (

{dbos-0.24.0a5 → dbos-0.24.0a6}/dbos/_error.py

@@ -1,7 +1,7 @@
 """Errors thrown by DBOS."""
 
 from enum import Enum
-from typing import Optional
+from typing import Any, Optional
 
 
 class DBOSException(Exception):
@@ -124,12 +124,18 @@ class DBOSNotAuthorizedError(DBOSException):
 class DBOSMaxStepRetriesExceeded(DBOSException):
     """Exception raised when a step was retried the maximimum number of times without success."""
 
-    def __init__(self) -> None:
+    def __init__(self, step_name: str, max_retries: int) -> None:
+        self.step_name = step_name
+        self.max_retries = max_retries
         super().__init__(
-            "Step reached maximum retries.",
+            f"Step {step_name} has exceeded its maximum of {max_retries} retries",
             dbos_error_code=DBOSErrorCode.MaxStepRetriesExceeded.value,
         )
 
+    def __reduce__(self) -> Any:
+        # Tell jsonpickle how to reconstruct this object
+        return (self.__class__, (self.step_name, self.max_retries))
+
 
 class DBOSWorkflowCancelledError(DBOSException):
     """Exception raised when the workflow has already been cancelled."""

{dbos-0.24.0a5 → dbos-0.24.0a6}/pyproject.toml

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

{dbos-0.24.0a5 → dbos-0.24.0a6}/tests/test_failures.py

@@ -8,11 +8,16 @@ import sqlalchemy as sa
 from psycopg.errors import SerializationFailure
 from sqlalchemy.exc import InvalidRequestError, OperationalError
 
-# Public API
-from dbos import DBOS, GetWorkflowsInput, SetWorkflowID
-from dbos._error import DBOSDeadLetterQueueError, DBOSException
+from dbos import DBOS, GetWorkflowsInput, Queue, SetWorkflowID
+from dbos._error import (
+    DBOSDeadLetterQueueError,
+    DBOSException,
+    DBOSMaxStepRetriesExceeded,
+)
 from dbos._sys_db import WorkflowStatusString
 
+from .conftest import queue_entries_are_cleaned_up
+
 
 def test_transaction_errors(dbos: DBOS) -> None:
     retry_counter: int = 0
@@ -258,3 +263,64 @@ def test_wfstatus_invalid(dbos: DBOS) -> None:
         with SetWorkflowID(wfuuid):
             non_deterministic_worklow()
     assert "Hint: Check if your workflow is deterministic." in str(exc_info.value)
+
+
+def test_step_retries(dbos: DBOS) -> None:
+    step_counter = 0
+
+    queue = Queue("test-queue")
+    max_attempts = 2
+
+    @DBOS.step(retries_allowed=True, interval_seconds=0, max_attempts=max_attempts)
+    def failing_step() -> None:
+        nonlocal step_counter
+        step_counter += 1
+        raise Exception("fail")
+
+    @DBOS.workflow()
+    def failing_workflow() -> None:
+        failing_step()
+
+    @DBOS.workflow()
+    def enqueue_failing_step() -> None:
+        queue.enqueue(failing_step).get_result()
+
+    error_message = f"Step {failing_step.__name__} has exceeded its maximum of {max_attempts} retries"
+
+    # Test calling the step directly
+    with pytest.raises(DBOSMaxStepRetriesExceeded) as excinfo:
+        failing_step()
+    assert error_message in str(excinfo.value)
+    assert step_counter == max_attempts
+
+    # Test calling the workflow
+    step_counter = 0
+    with pytest.raises(DBOSMaxStepRetriesExceeded) as excinfo:
+        failing_workflow()
+    assert error_message in str(excinfo.value)
+    assert step_counter == max_attempts
+
+    # Test enqueueing the step
+    step_counter = 0
+    handle = queue.enqueue(failing_step)
+    with pytest.raises(DBOSMaxStepRetriesExceeded) as excinfo:
+        handle.get_result()
+    assert error_message in str(excinfo.value)
+    assert step_counter == max_attempts
+
+    # Test enqueuing the workflow
+    step_counter = 0
+    handle = queue.enqueue(failing_workflow)
+    with pytest.raises(DBOSMaxStepRetriesExceeded) as excinfo:
+        handle.get_result()
+    assert error_message in str(excinfo.value)
+    assert step_counter == max_attempts
+
+    # Test enqueuing the step from a workflow
+    step_counter = 0
+    with pytest.raises(DBOSMaxStepRetriesExceeded) as excinfo:
+        enqueue_failing_step()
+    assert error_message in str(excinfo.value)
+    assert step_counter == max_attempts
+
+    assert queue_entries_are_cleaned_up(dbos)