Stratara.Sagas
3.1.1
dotnet add package Stratara.Sagas --version 3.1.1
NuGet\Install-Package Stratara.Sagas -Version 3.1.1
<PackageReference Include="Stratara.Sagas" Version="3.1.1" />
<PackageVersion Include="Stratara.Sagas" Version="3.1.1" />
<PackageReference Include="Stratara.Sagas" />
paket add Stratara.Sagas --version 3.1.1
#r "nuget: Stratara.Sagas, 3.1.1"
#:package Stratara.Sagas@3.1.1
#addin nuget:?package=Stratara.Sagas&version=3.1.1
#tool nuget:?package=Stratara.Sagas&version=3.1.1
Stratara.Sagas
License: FSL-1.1-MIT (Functional Source License — source-available; converts to MIT after 2 years). Not OSI-approved OSS.
Saga runtime for the Stratara event-sourced stack. Discovers ISaga implementations in the consumer's application assemblies, dispatches event bundles to them, and runs them under the SagaWorker hosted service.
What's in the box
| Folder | Contents |
|---|---|
Abstractions/ |
ISaga (marker for handler discovery), ISagaManager, ISagaHandler, ISagaMethodInvoker |
Services/ |
SagaManager (event-bundle → matching saga fan-out), SagaHandler (per-saga scoped execution + retries), SagaMethodInvoker (reflection-cached method-pointer dispatch into consumer sagas), SagaWorker (hosted service consuming the event-bundle subscription), SagaOptions (subscription + concurrency knobs) |
DependencyInjection/ |
AddSagaWorker(IConfiguration) + AddSagasFromAssemblyContaining<T>() |
Quick start
// In your Saga worker:
builder.Services.AddSagaWorker(builder.Configuration);
builder.Services.AddSagasFromAssemblyContaining<MyAppSagaMarker>();
Then implement ISaga in your application assembly. The saga manager picks them up automatically and dispatches matching events to their handler methods.
public sealed class OrderShippingSaga(ICommandOutboxDispatcher dispatcher) : ISaga
{
// Discovered via reflection — handler methods can be public or private.
[JetBrains.Annotations.UsedImplicitly]
private async Task HandleAsync(OrderPaidEvent @event, CancellationToken ct) =>
await dispatcher.EnqueueCommandAsync(new ScheduleShipmentCommand(@event.OrderId), ct);
}
How sagas work
Lifecycle
- Scoped per event bundle. Saga instances are resolved via
IServiceScopeFactory.CreateScope()for every event bundle theSagaWorkerconsumes from the message bus. A fresh DI scope means transient dependencies (DbContext, repositories, the unit of work) are isolated per dispatch. - No durable instance state. Sagas are not persisted between bundles — Stratara does not keep a per-saga state row. Anything you need to remember across bundles must be persisted externally (event store, read store, the aggregate the saga decides about, or a dedicated saga-state aggregate).
- At-least-once dispatch. The underlying event bundle subscription is at-least-once (see the
Outboxpackage). Handler methods MUST be idempotent — typically by checkpointing the latest processed event version per stream, or by deduplicating against the event id.
Correlation
- Routing key = event type. The
SagaManagerfilters incoming bundles by the relevant event types each saga declares (via itsHandleAsyncmethod signatures). A saga only ever sees events it asked for. - Correlation across events is your responsibility: typically you use the aggregate id carried on the event (or a domain key like
OrderId) to look up state, decide what to do, and emit a follow-up command viaICommandOutboxDispatcher. - The session context (correlation id, causation id, actor, subject) is restored from the wire envelope before handlers run, so source-generated
LoggerSagaExtensionscalls inside a handler are automatically scoped to the originating session.
State management
Sagas should drive state changes by emitting commands, not by mutating shared state directly. The recommended pattern:
[UsedImplicitly]
private async Task HandleAsync(ShipmentScheduledEvent @event, CancellationToken ct)
{
var view = await readStore.GetOrderShippingViewAsync(@event.OrderId, ct);
if (view is { State: ShippingState.AwaitingDispatch })
{
await dispatcher.EnqueueCommandAsync(new MarkOrderInTransitCommand(@event.OrderId), ct);
}
}
The read view holds the current state, the command (via the outbox) advances it, and the next event triggers the next saga step. This keeps sagas stateless, testable, and replay-safe.
Annotations on consumer handlers
Handler methods are discovered via reflection, so static analyzers (R#, IDE, Roslyn) flag them as unused. Mark every handler with [JetBrains.Annotations.UsedImplicitly]:
[UsedImplicitly]
private async Task HandleAsync(InvoiceIssuedEvent @event, CancellationToken ct) { … }
The class itself (ISaga implementation) is registered through AddSagasFromAssemblyContaining<T>() and is also "used implicitly" — typically mark it [UsedImplicitly] as well, especially if you do not reference it directly elsewhere.
Dependencies
Stratara.Contracts— forEventBundle+IEvent<T>.Stratara.Domain— for the framework's aggregate interfaces (sagas typically dispatch commands referencing tenant-scoped aggregates).Stratara.Shared— for messaging primitives, the source-generatedLoggerSagaExtensionsdiagnostics surface, and DI conventions.Microsoft.Extensions.Hosting.Abstractions+Microsoft.Extensions.Options.ConfigurationExtensions— forSagaWorkerhosting +SagaOptionsbinding.JetBrains.Annotations— for static-analysis attributes on saga-handler conventions.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- JetBrains.Annotations (>= 2025.2.4)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.8)
- Stratara.Contracts (>= 3.1.1)
- Stratara.Domain (>= 3.1.1)
- Stratara.Shared (>= 3.1.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Stratara.Sagas:
| Package | Downloads |
|---|---|
|
Stratara.EventSourcing.WorkerDefaults
Worker-host wiring composites for the Stratara event-sourced stack. IHostApplicationBuilder extensions (AddBackendServices, AddCommandWorkerServices, AddEventProjectionWorkerServices, AddSagaWorkerServices, AddOutboxWorkerServices) bundle the per-concern DI calls so each worker host opts in with one line. |
GitHub repositories
This package is not used by any popular GitHub repositories.
### Fixed
- **`FileMasterKeyProvider` now rejects a master KEK that is not exactly 32 bytes at startup.**
The KEK is used directly as an AES-256-GCM key, which accepts only 16/24/32-byte keys. The
provider previously required merely *at least* 32 bytes, so a longer KEK (for example the
48-byte output of `openssl rand -base64 48`, a common HKDF master-key recipe) passed both
construction and the eager `FileKeyStoreStartupProbe`, then threw
`CryptographicException: Specified key is not a valid size for this algorithm` on the **first**
key creation at runtime — defeating the purpose of the boot-time probe. The provider now
validates the decoded length is exactly 32 bytes and fails fast at boot with an actionable
message (`Generate one with: openssl rand -base64 32`). A 32-byte KEK is unaffected.
- **`EnvelopeFileKeyStore` is now safe for multiple processes sharing one store file** (for
example several containers bind-mounting the same host directory). Previously a process only
read the store once at construction, so a data-encryption key created by another process after
startup was invisible (`GetDataEncryptionKeyAsync` returned `null`, breaking decryption), and
two processes creating keys concurrently could overwrite each other's keys or mint colliding
versions for the same scope. Reads now reload from disk on a cache miss (guarded by the file's
last-write time to avoid reload storms), and every mutation serializes through an exclusive
cross-process lock file and re-reads the latest on-disk state before writing. A networked file
system (NFS/SMB) remains unsupported — it guarantees neither atomic rename nor reliable advisory
locks.
### Added
- **`LogEvents.KeyManagement.KeyStoreReloaded` (112_006)** — debug-level event emitted when the
file key store reloads its state from disk to pick up keys written by another process.