Stratara.Outbox.RabbitMQ
4.6.0
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.Outbox.RabbitMQ --version 4.6.0
NuGet\Install-Package Stratara.Outbox.RabbitMQ -Version 4.6.0
<PackageReference Include="Stratara.Outbox.RabbitMQ" Version="4.6.0" />
<PackageVersion Include="Stratara.Outbox.RabbitMQ" Version="4.6.0" />
<PackageReference Include="Stratara.Outbox.RabbitMQ" />
paket add Stratara.Outbox.RabbitMQ --version 4.6.0
#r "nuget: Stratara.Outbox.RabbitMQ, 4.6.0"
#:package Stratara.Outbox.RabbitMQ@4.6.0
#addin nuget:?package=Stratara.Outbox.RabbitMQ&version=4.6.0
#tool nuget:?package=Stratara.Outbox.RabbitMQ&version=4.6.0
Stratara.Outbox.RabbitMQ
Derived. The behaviour described here is specified under
openspec/specs/. Those specifications are the source; this page explains and illustrates them.
License: MIT.
Outbox-pattern command + event dispatch for the Stratara event-sourced stack with a RabbitMQ message-bus implementation. Contains the write-side dispatchers, the outbox-retry worker, the read-side mediator command worker, the RabbitMQ bus, and the ProjectionReplayState that coordinates dispatch skip during projection replay — shared over Redis where a connection is registered, held in process otherwise. Azure Service Bus ships separately as Stratara.Outbox.AzureServiceBus.
What's in the box
| Folder | Contents |
|---|---|
Outbox/ |
OutboxOptions, CommandOutboxDispatcher (write-side ICommand fan-out via IMessageBus, falls back to outbox table on bus failure), EventBundleOutboxDispatcher (same for EventBundle), OutboxWorker (hosted service that retries unpublished outbox rows on a polling interval), NullOutboxLock + RedisOutboxLock (IOutboxLock implementations — default no-op for single-instance deployments, Redis-leased distributed lock for multi-replica setups) |
Messaging/ |
RabbitMqBus — IMessageBus over RabbitMQ. A worker subscription is a quorum queue <subscription>.v2 with <subscription>.dead-letter beside it; a message a handler cannot take is redelivered under MessageRetryOptions and then dead-lettered. A subscription holds at most Messaging:PrefetchCount messages (default 16), and the host waits for a stopping subscription's running handler to settle before it counts as stopped — within the host's shutdown timeout; twenty seconds for a subscription stopped on its own. Azure Service Bus ships as the sibling Stratara.Outbox.AzureServiceBus package. |
Mediator/ |
MediatorCommandWorker (hosted service that subscribes to the command topic and dispatches into the in-process IMediator) |
Projections/ |
ProjectionReplayState (concrete IProjectionReplayState, Redis-backed where a connection is registered, in process otherwise; dispatchers skip publishing while replay is active), ProjectionReplayOptions (how long the replay marking survives without renewal) |
DependencyInjection/ |
AddOutboxDispatcher(), AddOutboxWorker(IConfiguration), AddRedisOutboxLock() (opt-in distributed lock), AddProjectionReplayState(), AddMediatorWorker(), AddMessaging() |
Diagnostics/Extensions/ |
LoggerOutboxExtensions, LoggerMessagingExtensions (source-generated logger surfaces) |
Quick start
// In your API host:
builder.AddMessaging(); // IMessageBus + MessagingOptions binding
builder.Services
.AddOutboxDispatcher() // CommandOutboxDispatcher + EventBundleOutboxDispatcher + ProjectionReplayState
.AddOutboxWorker(builder.Configuration); // OutboxWorker hosted service (only if this host owns retries)
// In your command worker:
builder.Services
.AddMediatorWorker(); // MediatorCommandWorker hosted service
The dispatchers consult IProjectionReplayState.IsReplayActive before each publish and skip dispatch (writing to the outbox table only) while a replay is in progress. They also record the outbox.published counter for what the broker accepted — the worker counts nothing, because only the dispatcher knows what went out.
The replay marking and its progress counters are held on the lease configured by ProjectionReplayOptions.LeaseSeconds (default 300), which the replay renews every time it reports progress. A replay whose host is killed stops renewing it and the marking lapses on its own, instead of suppressing publication indefinitely. AddProjectionReplayState() reads the options from the ProjectionReplay section of the host's configuration; services.Configure<ProjectionReplayOptions>(...) after that call takes precedence. A lease of zero or less fails the host at start. Set it longer than the slowest stretch between two progress reports — too short lets the marking lapse while the replay is still running.
A drain cycle takes one batch of each kind and ends. Rows the broker would not accept stay in the table for the next interval; a cycle never re-reads what it just failed to publish, so an unreachable broker or a suppressed drain cannot turn a cycle into a loop over the same rows.
Multi-instance outbox workers
AddOutboxWorker registers NullOutboxLock as the default IOutboxLock — a no-op that preserves the single-instance assumption. For multi-replica deployments call AddRedisOutboxLock() afterwards; it replaces the no-op with a Redis-leased lock (SET stratara:outbox:lock NX EX) so only one replica drains at a time:
builder.AddCaching(); // registers IConnectionMultiplexer
builder.Services
.AddOutboxDispatcher()
.AddOutboxWorker(builder.Configuration)
.AddRedisOutboxLock(); // multi-replica safe
The lease defaults to 60 s (OutboxOptions.LockLeaseSeconds). Tune it so it exceeds the worst-case drain duration; otherwise the lock can expire mid-cycle and a peer may start a concurrent drain. Outbox semantics are still at-least-once, so a duplicate publish is recoverable provided handlers stay idempotent.
Dependencies
Stratara.Abstractions— forICommand,IEvent,IMessageBus,ICommandOutboxDispatcher,IEventBundleOutboxDispatcher,IProjectionReplayState,IMessagingIdentifier,IWriteUnitOfWork(used at runtime via the outbox repository).Stratara.Contracts— forEventBundle+CommandEnvelopemessages.Stratara.Mediator—MediatorCommandWorkerdispatches into the in-processIMediator.Stratara.Sessions— dispatcher hydratesCommandEnvelopefrom the current session context.Stratara.Shared— for messaging primitives, resilience pipeline names, mapping helpers, and the diagnostics base.RabbitMQ.Client,StackExchange.Redis(only used when a connection is registered: shared replay state, optional outbox lock).Microsoft.Extensions.Hosting.Abstractions+Microsoft.Extensions.Options.ConfigurationExtensions— for hosted services + options binding.
The outbox dispatcher persists rows through
IWriteUnitOfWork.CreateOutboxRepository— that interface lives inStratara.Abstractions, but the concrete implementation comes fromStratara.EventSourcing.EntityFrameworkCore. Reference that package alongside this one to get a working stack.
| 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
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.13)
- Microsoft.Extensions.DependencyInjection (>= 10.0.13)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.13)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.13)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.13)
- RabbitMQ.Client (>= 7.2.2)
- StackExchange.Redis (>= 3.4.5)
- Stratara.Abstractions (>= 4.6.0)
- Stratara.Contracts (>= 4.6.0)
- Stratara.Mediator (>= 4.6.0)
- Stratara.Sessions (>= 4.6.0)
- Stratara.Shared (>= 4.6.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Stratara.Outbox.RabbitMQ:
| Package | Downloads |
|---|---|
|
Stratara.Infrastructure
Infrastructure glue for the Stratara framework — authorization decorators, configuration providers, and DI composition helpers that wire Mediator, Outbox, Identity, and EF Core into a hosted app. |
|
|
Stratara.EventSourcing.WorkerDefaults
Worker-host wiring composites for the Stratara event-sourced stack. IHostApplicationBuilder extensions (AddBackendServices, AddCommandWorkerServices, AddHeavyCommandWorkerServices, AddEventProjectionWorkerServices, AddEventStreamHashWorkerServices, AddSagaWorkerServices, AddOutboxWorkerServices, and AddCommandServices, AddEventProjectionServices and AddSagaServices without the bus-fed workers) 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.
| Version | Downloads | Last Updated |
|---|---|---|
| 4.8.0 | 187 | 11/6/2026 |
| 4.7.1 | 168 | 11/5/2026 |
| 4.7.0 | 468 | 10/30/2026 |
| 4.6.1 | 142 | 10/29/2026 |
| 4.6.0 | 199 | 10/28/2026 |
| 4.5.0 | 303 | 10/28/2026 |
| 4.4.10 | 246 | 10/26/2026 |
| 4.4.9 | 144 | 10/26/2026 |
| 4.4.8 | 293 | 10/24/2026 |
| 4.4.7 | 152 | 10/23/2026 |
| 4.4.6 | 252 | 10/22/2026 |
| 4.4.5 | 341 | 10/14/2026 |
| 4.4.4 | 332 | 10/10/2026 |
| 4.4.3 | 156 | 10/10/2026 |
| 4.4.2 | 429 | 10/2/2026 |
| 4.4.1 | 402 | 9/29/2026 |
| 4.4.0 | 172 | 9/27/2026 |
| 4.3.1 | 165 | 9/25/2026 |
| 4.3.0 | 330 | 9/23/2026 |
| 4.2.0 | 200 | 9/18/2026 |
An erasure shreds every key that names the subject, and nothing stopped the next encryption for that subject
from creating a new one: a key store asked for a scope it does not hold creates a first version. A job, a request
in flight or a second process that encrypted for an erased subject afterwards got a fresh key, and what it wrote
stayed readable for good. The key store now records an erased subject and refuses to create a key for it again.
### Added
- **`IKeyStore.MarkSubjectErasedAsync(KeySubject)`** records that a tenant or user has been erased. It has a
default implementation that throws `NotSupportedException`, so an existing key store still compiles.
- **`KeySubject`** names the tenant or user, and `KeySubject.Covers(KeyScope)` states which keys belong to its
erasure: for a tenant, a key of any level that names it; for a user, a user-level key that names it.
- **`KeyScopeErasedException`** (an `InvalidOperationException`) is what a key store throws for such a scope. It
carries the refused `Scope`.
### Changed
- **An encryption for an erased subject fails.** After a subject's erasure, `GetOrCreateCurrentKeyAsync` and
`RotateAsync` throw `KeyScopeErasedException` for every scope the subject covers, whether or not it ever held a
key, and create nothing. The blob encryptor, the encrypting settings store and the field-encrypting serializer
pass it through. Code that erased a subject and then wrote encrypted data for it again now sees the exception;
the mark is permanent and cannot be lifted. Revoking every version of a scope is not an erasure and marks nothing.
- **`ISubjectEraser` marks the subject before it sweeps any plane**, so an encryption racing the erasure
either creates its key first, and that key is shredded with the rest, or is refused. A key store that cannot mark
a subject leaves the erasure as before and logs `SubjectNotMarkable` (112009).
- **The file-backed key store writes format version 2**, which holds the marks, and refuses to open a file in a
newer format than it knows. `InMemoryKeyStore` refuses an erased subject as the file store does; `DummyKeyStore`
refuses to mark one, as it refuses every erasure operation.
**Upgrading:**
- **Upgrade every process that shares a key store file in one step.** A process on an earlier release reads a
version-2 file, ignores the marks, creates keys for an erased subject and drops the marks the next time it writes
the file. A version-1 file needs no migration. Rolling back is possible but loses the marks on the first write.
- **Map `KeyScopeErasedException` to your answer for data that is gone**, if a request can reach an encryption for
a subject after its erasure.
- **A key store of your own implements `MarkSubjectErasedAsync`**, refusing in `GetOrCreateCurrentKeyAsync` and
`RotateAsync` every scope a marked subject `Covers`. Without it the erasure warns and the gap stays open.