mumucc 0.4.4 → 0.4.10

package/defaults/plugin-seed/marketplaces/claude-code-workflows/plugins/backend-development/skills/saga-orchestration/SKILL.md

@@ -0,0 +1,361 @@
+---
+name: saga-orchestration
+description: Implement saga patterns for distributed transactions and cross-aggregate workflows. Use this skill when implementing distributed transactions across microservices where 2PC is unavailable, designing compensating actions for failed order workflows that span inventory, payment, and shipping services, building event-driven saga coordinators for travel booking systems that must roll back hotel, flight, and car rental reservations atomically, or debugging stuck saga states in production where compensation steps never complete.
+---
+
+# Saga Orchestration
+
+Patterns for managing distributed transactions and long-running business processes without two-phase commit.
+
+## Inputs and Outputs
+
+**What you provide:**
+- Service boundaries and ownership (which service owns which step)
+- Transaction requirements (which steps must be atomic, which can be eventual)
+- Failure modes for each step (transient vs. permanent, retry policy)
+- SLA requirements per step (informs timeout configuration)
+- Existing event/messaging infrastructure (Kafka, RabbitMQ, SQS, etc.)
+
+**What this skill produces:**
+- Saga definition with ordered steps, action commands, and compensation commands
+- Orchestrator or choreography implementation for your chosen pattern
+- Compensation logic for each participant service (idempotent, always-succeeds)
+- Step timeout configuration with per-step deadlines
+- Monitoring setup: state machine metrics, stuck saga detection, DLQ recovery
+
+---
+
+## When to Use This Skill
+
+- Coordinating multi-service transactions without distributed locks
+- Implementing compensating transactions for partial failures
+- Managing long-running business workflows (minutes to hours)
+- Handling failures in distributed systems where atomicity is required
+- Building order fulfillment, approval, or booking processes
+- Replacing fragile two-phase commit with async compensation
+
+---
+
+## Core Concepts
+
+### Saga Pattern Types
+
+```text
+Choreography                        Orchestration
+┌─────┐  ┌─────┐  ┌─────┐         ┌─────────────┐
+│Svc A│─►│Svc B│─►│Svc C│         │ Orchestrator│
+└─────┘  └─────┘  └─────┘         └──────┬──────┘
+   │        │        │                   │
+   ▼        ▼        ▼             ┌─────┼─────┐
+ Event    Event    Event           ▼     ▼     ▼
+                                ┌────┐┌────┐┌────┐
+Each service reacts to the      │Svc1││Svc2││Svc3│
+previous service's event.       └────┘└────┘└────┘
+No central coordinator.    Central coordinator sends
+                           commands and tracks state.
+```
+
+**Choose orchestration when:** You need explicit step tracking, retries, and centralized visibility. Easier to debug.
+
+**Choose choreography when:** You want loose coupling and services that can evolve independently. Harder to trace.
+
+### Saga Execution States
+
+| State            | Description                                       |
+| ---------------- | ------------------------------------------------- |
+| **Started**      | Saga initiated, first step dispatched             |
+| **Pending**      | Waiting for a step reply from a participant       |
+| **Compensating** | A step failed; rolling back completed steps       |
+| **Completed**    | All forward steps succeeded                       |
+| **Failed**       | Saga failed and all compensations have finished   |
+
+### Compensation Rules
+
+| Situation                            | Handling                                              |
+| ------------------------------------ | ----------------------------------------------------- |
+| Step never started                   | No compensation needed (skip)                         |
+| Step completed successfully          | Run compensation command                              |
+| Step failed before completion        | No compensation needed; mark failed                   |
+| Compensation itself fails            | Retry with backoff → DLQ → manual intervention alert  |
+| Step result no longer exists         | Treat compensation as success (idempotency)           |
+
+---
+
+## Templates
+
+### Template 1: Order Fulfillment Saga (Orchestration)
+
+Concrete subclass of the base orchestrator. Defines four steps spanning inventory, payment, shipping, and notification. See `references/advanced-patterns.md` for the full abstract `SagaOrchestrator` base class.
+
+```python
+from saga_orchestrator import SagaOrchestrator, SagaStep
+from typing import Dict, List
+
+
+class OrderFulfillmentSaga(SagaOrchestrator):
+    """Orchestrates order fulfillment across four participant services."""
+
+    @property
+    def saga_type(self) -> str:
+        return "OrderFulfillment"
+
+    def define_steps(self, data: Dict) -> List[SagaStep]:
+        return [
+            SagaStep(
+                name="reserve_inventory",
+                action="InventoryService.ReserveItems",
+                compensation="InventoryService.ReleaseReservation"
+            ),
+            SagaStep(
+                name="process_payment",
+                action="PaymentService.ProcessPayment",
+                compensation="PaymentService.RefundPayment"
+            ),
+            SagaStep(
+                name="create_shipment",
+                action="ShippingService.CreateShipment",
+                compensation="ShippingService.CancelShipment"
+            ),
+            SagaStep(
+                name="send_confirmation",
+                action="NotificationService.SendOrderConfirmation",
+                compensation="NotificationService.SendCancellationNotice"
+            ),
+        ]
+
+
+# Start a saga
+async def create_order(order_data: Dict, saga_store, event_publisher):
+    saga = OrderFulfillmentSaga(saga_store, event_publisher)
+    return await saga.start({
+        "order_id": order_data["order_id"],
+        "customer_id": order_data["customer_id"],
+        "items": order_data["items"],
+        "payment_method": order_data["payment_method"],
+        "shipping_address": order_data["shipping_address"],
+    })
+
+
+# Participant service — handles command and publishes reply
+class InventoryService:
+    async def handle_reserve_items(self, command: Dict):
+        try:
+            reservation = await self.reserve(command["items"], command["order_id"])
+            await self.event_publisher.publish("SagaStepCompleted", {
+                "saga_id": command["saga_id"],
+                "step_name": "reserve_inventory",
+                "result": {"reservation_id": reservation.id}
+            })
+        except InsufficientInventoryError as e:
+            await self.event_publisher.publish("SagaStepFailed", {
+                "saga_id": command["saga_id"],
+                "step_name": "reserve_inventory",
+                "error": str(e)
+            })
+
+    async def handle_release_reservation(self, command: Dict):
+        """Compensation — idempotent, always publishes completion."""
+        try:
+            await self.release_reservation(
+                command["original_result"]["reservation_id"]
+            )
+        except ReservationNotFoundError:
+            pass  # Already released — treat as success
+        await self.event_publisher.publish("SagaCompensationCompleted", {
+            "saga_id": command["saga_id"],
+            "step_name": "reserve_inventory"
+        })
+```
+
+### Template 2: Choreography-Based Saga
+
+Each service listens for the previous service's event and reacts. No central coordinator. Compensation is triggered by failure events propagating backward.
+
+```python
+from dataclasses import dataclass
+from typing import Dict, Any
+
+
+@dataclass
+class SagaContext:
+    """Carried through all events in a choreographed saga."""
+    saga_id: str
+    step: int
+    data: Dict[str, Any]
+    completed_steps: list
+
+
+class OrderChoreographySaga:
+    """Choreography-based saga — services react to each other's events."""
+
+    def __init__(self, event_bus):
+        self.event_bus = event_bus
+        self._register_handlers()
+
+    def _register_handlers(self):
+        # Forward path
+        self.event_bus.subscribe("OrderCreated",       self._on_order_created)
+        self.event_bus.subscribe("InventoryReserved",  self._on_inventory_reserved)
+        self.event_bus.subscribe("PaymentProcessed",   self._on_payment_processed)
+        self.event_bus.subscribe("ShipmentCreated",    self._on_shipment_created)
+        # Compensation path
+        self.event_bus.subscribe("PaymentFailed",      self._on_payment_failed)
+        self.event_bus.subscribe("ShipmentFailed",     self._on_shipment_failed)
+
+    async def _on_order_created(self, event: Dict):
+        await self.event_bus.publish("ReserveInventory", {
+            "saga_id": event["order_id"],
+            "order_id": event["order_id"],
+            "items": event["items"],
+        })
+
+    async def _on_inventory_reserved(self, event: Dict):
+        await self.event_bus.publish("ProcessPayment", {
+            "saga_id": event["saga_id"],
+            "order_id": event["order_id"],
+            "amount": event["total_amount"],
+            "reservation_id": event["reservation_id"],
+        })
+
+    async def _on_payment_processed(self, event: Dict):
+        await self.event_bus.publish("CreateShipment", {
+            "saga_id": event["saga_id"],
+            "order_id": event["order_id"],
+            "payment_id": event["payment_id"],
+        })
+
+    async def _on_shipment_created(self, event: Dict):
+        await self.event_bus.publish("OrderFulfilled", {
+            "saga_id": event["saga_id"],
+            "order_id": event["order_id"],
+            "tracking_number": event["tracking_number"],
+        })
+
+    # Compensation handlers
+    async def _on_payment_failed(self, event: Dict):
+        """Payment failed — release inventory and mark order failed."""
+        await self.event_bus.publish("ReleaseInventory", {
+            "saga_id": event["saga_id"],
+            "reservation_id": event["reservation_id"],
+        })
+        await self.event_bus.publish("OrderFailed", {
+            "order_id": event["order_id"],
+            "reason": "Payment failed",
+        })
+
+    async def _on_shipment_failed(self, event: Dict):
+        """Shipment failed — refund payment and release inventory."""
+        await self.event_bus.publish("RefundPayment", {
+            "saga_id": event["saga_id"],
+            "payment_id": event["payment_id"],
+        })
+        await self.event_bus.publish("ReleaseInventory", {
+            "saga_id": event["saga_id"],
+            "reservation_id": event["reservation_id"],
+        })
+```
+
+### Template 3: Idempotent Step Guards
+
+Every participant must guard against duplicate command delivery. Store an idempotency key before executing and return the cached result on replay.
+
+```python
+async def handle_reserve_items(self, command: Dict):
+    """Idempotency-guarded reservation step."""
+    idempotency_key = f"reserve-{command['order_id']}"
+    existing = await self.reservation_store.find_by_key(idempotency_key)
+    if existing:
+        # Already executed — return the previous result without side effects
+        await self.event_publisher.publish("SagaStepCompleted", {
+            "saga_id": command["saga_id"],
+            "step_name": "reserve_inventory",
+            "result": {"reservation_id": existing.id}
+        })
+        return
+
+    # First execution
+    reservation = await self.reserve(
+        items=command["items"],
+        order_id=command["order_id"],
+        idempotency_key=idempotency_key
+    )
+    await self.event_publisher.publish("SagaStepCompleted", {
+        "saga_id": command["saga_id"],
+        "step_name": "reserve_inventory",
+        "result": {"reservation_id": reservation.id}
+    })
+```
+
+---
+
+## Best Practices
+
+### Do's
+
+- **Make every step idempotent** — Commands may be replayed on broker reconnect
+- **Design compensations carefully** — They are the most critical code path
+- **Use correlation IDs** — The `saga_id` must flow through every event and log
+- **Implement per-step timeouts** — Never wait indefinitely for a participant reply
+- **Log state transitions** — `saga_id`, `step_name`, `old_state → new_state` on every change
+- **Test compensation paths explicitly** — Inject failures at each step index in integration tests
+
+### Don'ts
+
+- **Don't assume instant completion** — Sagas are async and may take minutes
+- **Don't skip compensation testing** — The rollback path is the hardest to get right
+- **Don't couple services directly** — Use async messaging, never synchronous calls inside a saga step
+- **Don't ignore partial failures** — A step that partially executed still needs compensation
+- **Don't use a global timeout** — Each step has different latency characteristics
+
+---
+
+## Troubleshooting
+
+### Saga stuck in COMPENSATING state
+
+A saga enters compensation but never reaches FAILED. This means a compensation handler is throwing an unhandled exception and never publishing `SagaCompensationCompleted`. Add dead-letter queue (DLQ) handling to compensation consumers and ensure every compensation action publishes a result event even when the underlying operation was already rolled back.
+
+```python
+async def handle_release_reservation(self, command: Dict):
+    try:
+        await self.release_reservation(command["original_result"]["reservation_id"])
+    except ReservationNotFoundError:
+        pass  # Already released — treat as success
+    # Always publish completion, regardless of outcome
+    await self.event_publisher.publish("SagaCompensationCompleted", {
+        "saga_id": command["saga_id"],
+        "step_name": "reserve_inventory"
+    })
+```
+
+### Duplicate saga executions on restart
+
+If your orchestrator service restarts mid-saga, it may replay events and re-execute already-completed steps. Guard every step action with an idempotency key — see **Template 3** above.
+
+### Choreography saga losing events
+
+In a choreography-based saga, a downstream service may miss an event if it was offline when published. Use a durable message broker (Kafka with replication, RabbitMQ with persistence) and store the current saga state in a dedicated `saga_log` table so you can replay from the last known good step.
+
+### Timeout firing before a slow-but-valid step completes
+
+A step like `create_shipment` might take up to 15 minutes during peak load but your global timeout is 5 minutes, causing spurious compensation. Make step timeouts configurable per step type — see `references/advanced-patterns.md` for the `TimeoutSagaOrchestrator` implementation and the `STEP_TIMEOUTS` dict pattern.
+
+### Compensation order not matching execution order
+
+When two steps both complete before a failure is detected, compensation must run in strict reverse order or you leave data in an inconsistent state. Verify that `_compensate()` iterates from `current_step - 1` down to `0`, and add an integration test that deliberately fails at each step index to confirm correct rollback order.
+
+---
+
+## Advanced Patterns
+
+The `references/` directory contains production-grade implementations not needed for most sagas:
+
+- **`references/advanced-patterns.md`** — Full `SagaOrchestrator` abstract base class, `TimeoutSagaOrchestrator` with per-step deadlines, detailed bank transfer compensating transaction chain, Prometheus instrumentation, stuck saga PromQL alerts, and DLQ recovery worker.
+
+---
+
+## Related Skills
+
+- `cqrs-implementation` — Pair sagas with CQRS for read-model updates after each step completes
+- `event-store-design` — Store saga events in an event store for full audit trail and replay capability
+- `workflow-orchestration-patterns` — Higher-level workflow engines (Temporal, Conductor) that build on saga concepts