KState-Saga/ca.acendas.kstate.saga/StatefulSagaStep

StatefulSagaStep

data class StatefulSagaStep<C, R, S>(val step: TypedValue, val forward: suspend StatefulStepScope<R, S>.(C) -> StepOutcome<R>, val compensation: suspend CompensationScope<R, S>.() -> Unit? = null, val idempotent: Boolean = false, val timeout: Duration? = null, val retryPolicy: RetryPolicy? = null)

Represents a single step in a stateful saga with typed state management.

Unlike SagaStep, this step provides access to shared saga state that can be updated during forward execution and read during compensation. This enables "smart compensation" where compensation logic can make decisions based on the execution progress of later steps.

Example

data class PaymentState(val escrowCaptured: Boolean = false)

StatefulSagaStep<Cart, Order, PaymentState>(
    step = TypedValue.fromEnum(OrderSteps.TAKE_PAYMENT),
    forward = { cart ->
        updateState { it.copy(amount = payment.amount) }
        completes with createOrder(cart)
    },
    compensation = {
        // `state` contains latest state including updates from later steps
        if (state.escrowCaptured) refund() else returnEscrow()
    }
)

Parameters

The type of context passed to saga steps

The type of result produced by saga steps

The type of shared saga state

Constructors

StatefulSagaStep

constructor(step: TypedValue, forward: suspend StatefulStepScope<R, S>.(C) -> StepOutcome<R>, compensation: suspend CompensationScope<R, S>.() -> Unit? = null, idempotent: Boolean = false, timeout: Duration? = null, retryPolicy: RetryPolicy? = null)