python-cqrs 4.6.4__tar.gz → 4.7.0__tar.gz

{python_cqrs-4.6.4/src/python_cqrs.egg-info → python_cqrs-4.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-cqrs
-Version: 4.6.4
+Version: 4.7.0
 Summary: Python CQRS pattern implementation
 Author-email: Vadim Kozyrevskiy <vadikko2@mail.ru>, Dmitry Kutlubaev <kutlubaev00@mail.ru>
 Maintainer-email: Vadim Kozyrevskiy <vadikko2@mail.ru>
@@ -97,7 +97,10 @@ Dynamic: license-file
   </p>
 </div>
 
-
+> [!WARNING]
+> **Breaking Changes in v5.0.0**
+>
+> Starting with version 5.0.0, Pydantic support will become optional. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
 
 ## Overview
 

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/README.md

@@ -36,7 +36,10 @@
   </p>
 </div>
 
-
+> [!WARNING]
+> **Breaking Changes in v5.0.0**
+>
+> Starting with version 5.0.0, Pydantic support will become optional. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
 
 ## Overview
 

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/pyproject.toml

@@ -31,7 +31,7 @@ maintainers = [{name = "Vadim Kozyrevskiy", email = "vadikko2@mail.ru"}]
 name = "python-cqrs"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "4.6.4"
+version = "4.7.0"
 
 [project.optional-dependencies]
 aiobreaker = ["aiobreaker>=0.3.0"]

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/models.py

@@ -1,5 +1,6 @@
 import dataclasses
 import typing
+from dataclass_wizard import asdict, fromdict
 
 # Type variable for from_dict classmethod return type
 _T = typing.TypeVar("_T", bound="SagaContext")
@@ -29,7 +30,7 @@ class SagaContext:
         Returns:
             Dictionary representation of the context.
         """
-        return dataclasses.asdict(self)
+        return asdict(self)
 
     @classmethod
     def from_dict(cls: type[_T], data: dict[str, typing.Any]) -> _T:
@@ -42,11 +43,11 @@ class SagaContext:
         Returns:
             Instance of the context class.
         """
-        # Get field names from dataclass
-        field_names = {f.name for f in dataclasses.fields(cls)}
-        # Filter data to only include known fields
-        filtered_data = {k: v for k, v in data.items() if k in field_names}
-        return cls(**filtered_data)
+        # # Get field names from dataclass
+        # field_names = {f.name for f in dataclasses.fields(cls)}
+        # # Filter data to only include known fields
+        # filtered_data = {k: v for k, v in data.items() if k in field_names}
+        return fromdict(cls, data)
 
     def model_dump(self) -> dict[str, typing.Any]:
         """

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/recovery.py

@@ -29,6 +29,11 @@ async def recover_saga(
     Already completed steps will be skipped.
     If the saga was in a compensating state, compensation will resume.
 
+    On recovery failure (exception during resume), the storage's
+    increment_recovery_attempts is called automatically so the saga can be
+    retried or excluded by get_sagas_for_recovery(max_recovery_attempts=...).
+    Callers do not need to call increment_recovery_attempts themselves.
+
     Args:
         saga: The saga orchestrator instance.
         saga_id: The ID of the saga to recover.
@@ -109,11 +114,12 @@ async def recover_saga(
             )
             # Re-raise to allow callers to handle this case
             raise
-        # For other RuntimeErrors, log and re-raise
+        # For other RuntimeErrors, recovery failed: increment attempts and re-raise
         logger.error(f"Saga {saga_id} recovery ended with error: {e}")
+        await storage.increment_recovery_attempts(saga_id, new_status=SagaStatus.FAILED)
         raise
     except Exception as e:
         logger.error(f"Saga {saga_id} recovery ended with error: {e}")
-        # The transaction handles exception and runs compensation, so the saga state
-        # should be updated to FAILED (or COMPENSATED) in storage.
+        # Recovery failed: increment attempts so saga can be retried or excluded later
+        await storage.increment_recovery_attempts(saga_id, new_status=SagaStatus.FAILED)
         raise

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/saga.py

@@ -142,9 +142,14 @@ class SagaTransaction(typing.Generic[ContextT]):
         exc_val: BaseException | None,
         exc_tb: types.TracebackType | None,
     ) -> bool:
-        # If an exception occurred, compensate all completed steps
-        # Only compensate if not already compensated in __aiter__
-        if exc_val is not None and not self._compensated:
+        # If an exception occurred, compensate all completed steps.
+        # Do not compensate on GeneratorExit: consumer stopped iteration intentionally
+        # (e.g. to resume later), which is not a failure.
+        if (
+            exc_val is not None
+            and exc_type is not GeneratorExit
+            and not self._compensated
+        ):
             self._error = exc_val
             await self._compensate()
         return False  # Don't suppress the exception
@@ -302,6 +307,8 @@ class SagaTransaction(typing.Generic[ContextT]):
 
                 yield step_result
 
+            # Update context one final time before marking as completed
+            await self._state_manager.update_context(self._context)
             await self._state_manager.update_status(SagaStatus.COMPLETED)
 
         except Exception as e:

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/storage/memory.py

@@ -37,6 +37,7 @@ class MemorySagaStorage(ISagaStorage):
             "created_at": now,
             "updated_at": now,
             "version": 1,
+            "recovery_attempts": 0,
         }
         self._logs[saga_id] = []
 
@@ -115,3 +116,40 @@ class MemorySagaStorage(ISagaStorage):
             return []
         # Sort by timestamp
         return sorted(self._logs[saga_id], key=lambda x: x.timestamp)
+
+    async def get_sagas_for_recovery(
+        self,
+        limit: int,
+        max_recovery_attempts: int = 5,
+        stale_after_seconds: int | None = None,
+    ) -> list[uuid.UUID]:
+        recoverable = (SagaStatus.RUNNING, SagaStatus.COMPENSATING, SagaStatus.FAILED)
+        now = datetime.datetime.now(datetime.timezone.utc)
+        threshold = (
+            (now - datetime.timedelta(seconds=stale_after_seconds))
+            if stale_after_seconds is not None
+            else None
+        )
+        candidates = [
+            sid
+            for sid, data in self._sagas.items()
+            if data["status"] in recoverable
+            and data.get("recovery_attempts", 0) < max_recovery_attempts
+            and (threshold is None or data["updated_at"] < threshold)
+        ]
+        candidates.sort(key=lambda sid: self._sagas[sid]["updated_at"])
+        return candidates[:limit]
+
+    async def increment_recovery_attempts(
+        self,
+        saga_id: uuid.UUID,
+        new_status: SagaStatus | None = None,
+    ) -> None:
+        if saga_id not in self._sagas:
+            raise ValueError(f"Saga {saga_id} not found")
+        data = self._sagas[saga_id]
+        data["recovery_attempts"] = data.get("recovery_attempts", 0) + 1
+        data["updated_at"] = datetime.datetime.now(datetime.timezone.utc)
+        data["version"] += 1
+        if new_status is not None:
+            data["status"] = new_status

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/storage/protocol.py

@@ -70,3 +70,43 @@ class ISagaStorage(abc.ABC):
         saga_id: uuid.UUID,
     ) -> list[SagaLogEntry]:
         """Get step execution history."""
+
+    @abc.abstractmethod
+    async def get_sagas_for_recovery(
+        self,
+        limit: int,
+        max_recovery_attempts: int = 5,
+        stale_after_seconds: int | None = None,
+    ) -> list[uuid.UUID]:
+        """Return saga IDs that need recovery.
+
+        Args:
+            limit: Maximum number of saga IDs to return.
+            max_recovery_attempts: Only include sagas with recovery_attempts
+                strictly less than this value. Default 5.
+            stale_after_seconds: If set, only include sagas whose updated_at
+                is older than (now_utc - stale_after_seconds). Use this to
+                avoid picking sagas that are currently being executed (recently
+                updated). None means no staleness filter (backward compatible).
+
+        Returns:
+            List of saga IDs (RUNNING, COMPENSATING, or FAILED), ordered by
+            updated_at ascending, with recovery_attempts < max_recovery_attempts,
+            and optionally updated_at older than the staleness threshold.
+        """
+
+    @abc.abstractmethod
+    async def increment_recovery_attempts(
+        self,
+        saga_id: uuid.UUID,
+        new_status: SagaStatus | None = None,
+    ) -> None:
+        """Atomically increment recovery attempts after a failed recovery.
+
+        Updates recovery_attempts += 1, updated_at = now(), and optionally
+        status. Also increments version for optimistic locking.
+
+        Args:
+            saga_id: The saga to update.
+            new_status: If provided, set saga status to this value (e.g. FAILED).
+        """

{python_cqrs-4.6.4 → python_cqrs-4.7.0}/src/cqrs/saga/storage/sqlalchemy.py

@@ -78,6 +78,13 @@ class SagaExecutionModel(Base):
         onupdate=func.now(),
         comment="Last update timestamp",
     )
+    recovery_attempts = sqlalchemy.Column(
+        sqlalchemy.Integer,
+        nullable=False,
+        default=0,
+        server_default=sqlalchemy.text("0"),
+        comment="Number of recovery attempts",
+    )
 
 
 class SagaLogModel(Base):
@@ -143,6 +150,7 @@ class SqlAlchemySagaStorage(ISagaStorage):
                     status=SagaStatus.PENDING,
                     context=context,
                     version=1,
+                    recovery_attempts=0,
                 )
                 session.add(execution)
                 await session.commit()
@@ -303,3 +311,57 @@ class SqlAlchemySagaStorage(ISagaStorage):
                 )
                 for row in rows
             ]
+
+    async def get_sagas_for_recovery(
+        self,
+        limit: int,
+        max_recovery_attempts: int = 5,
+        stale_after_seconds: int | None = None,
+    ) -> list[uuid.UUID]:
+        recoverable = (
+            SagaStatus.RUNNING,
+            SagaStatus.COMPENSATING,
+            SagaStatus.FAILED,
+        )
+        async with self.session_factory() as session:
+            stmt = (
+                sqlalchemy.select(SagaExecutionModel.id)
+                .where(SagaExecutionModel.status.in_(recoverable))
+                .where(SagaExecutionModel.recovery_attempts < max_recovery_attempts)
+            )
+            if stale_after_seconds is not None:
+                threshold = datetime.datetime.now(
+                    datetime.timezone.utc,
+                ) - datetime.timedelta(
+                    seconds=stale_after_seconds,
+                )
+                stmt = stmt.where(SagaExecutionModel.updated_at < threshold)
+            stmt = stmt.order_by(SagaExecutionModel.updated_at.asc()).limit(limit)
+            result = await session.execute(stmt)
+            rows = result.scalars().all()
+            return [typing.cast(uuid.UUID, row) for row in rows]
+
+    async def increment_recovery_attempts(
+        self,
+        saga_id: uuid.UUID,
+        new_status: SagaStatus | None = None,
+    ) -> None:
+        async with self.session_factory() as session:
+            try:
+                values: dict[str, typing.Any] = {
+                    "recovery_attempts": SagaExecutionModel.recovery_attempts + 1,
+                    "version": SagaExecutionModel.version + 1,
+                }
+                if new_status is not None:
+                    values["status"] = new_status
+                result = await session.execute(
+                    sqlalchemy.update(SagaExecutionModel)
+                    .where(SagaExecutionModel.id == saga_id)
+                    .values(**values),
+                )
+                if result.rowcount == 0:  # type: ignore[attr-defined]
+                    raise ValueError(f"Saga {saga_id} not found")
+                await session.commit()
+            except SQLAlchemyError:
+                await session.rollback()
+                raise

{python_cqrs-4.6.4 → python_cqrs-4.7.0/src/python_cqrs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-cqrs
-Version: 4.6.4
+Version: 4.7.0
 Summary: Python CQRS pattern implementation
 Author-email: Vadim Kozyrevskiy <vadikko2@mail.ru>, Dmitry Kutlubaev <kutlubaev00@mail.ru>
 Maintainer-email: Vadim Kozyrevskiy <vadikko2@mail.ru>
@@ -97,7 +97,10 @@ Dynamic: license-file
   </p>
 </div>
 
-
+> [!WARNING]
+> **Breaking Changes in v5.0.0**
+>
+> Starting with version 5.0.0, Pydantic support will become optional. The default implementations of `Request`, `Response`, `DomainEvent`, and `NotificationEvent` will be migrated to dataclasses-based implementations.
 
 ## Overview