Stratara.Outbox.RabbitMQ
4.3.1
Prefix Reserved
dotnet add package Stratara.Outbox.RabbitMQ --version 4.3.1
NuGet\Install-Package Stratara.Outbox.RabbitMQ -Version 4.3.1
<PackageReference Include="Stratara.Outbox.RabbitMQ" Version="4.3.1" />
<PackageVersion Include="Stratara.Outbox.RabbitMQ" Version="4.3.1" />
<PackageReference Include="Stratara.Outbox.RabbitMQ" />
paket add Stratara.Outbox.RabbitMQ --version 4.3.1
#r "nuget: Stratara.Outbox.RabbitMQ, 4.3.1"
#:package Stratara.Outbox.RabbitMQ@4.3.1
#addin nuget:?package=Stratara.Outbox.RabbitMQ&version=4.3.1
#tool nuget:?package=Stratara.Outbox.RabbitMQ&version=4.3.1
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. 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.11)
- Microsoft.Extensions.DependencyInjection (>= 10.0.11)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.11)
- RabbitMQ.Client (>= 7.2.2)
- StackExchange.Redis (>= 3.1.31)
- Stratara.Abstractions (>= 4.3.1)
- Stratara.Contracts (>= 4.3.1)
- Stratara.Mediator (>= 4.3.1)
- Stratara.Sessions (>= 4.3.1)
- Stratara.Shared (>= 4.3.1)
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.3.1 | 36 | 9/25/2026 |
| 4.3.0 | 256 | 9/23/2026 |
| 4.2.0 | 180 | 9/18/2026 |
| 4.1.1 | 108 | 9/16/2026 |
| 4.1.0 | 110 | 9/16/2026 |
| 4.0.4 | 927 | 9/14/2026 |
| 4.0.3 | 189 | 9/3/2026 |
| 4.0.2 | 612 | 9/3/2026 |
| 4.0.1 | 263 | 9/2/2026 |
| 4.0.0 | 172 | 8/31/2026 |
| 4.0.0-preview.1 | 81 | 8/31/2026 |
| 3.4.0 | 163 | 8/28/2026 |
| 3.3.0 | 132 | 8/25/2026 |
| 3.2.3 | 142 | 8/22/2026 |
| 3.2.2 | 148 | 8/14/2026 |
| 3.2.1 | 155 | 8/2/2026 |
| 3.2.0 | 148 | 7/18/2026 |
| 3.1.7 | 155 | 7/1/2026 |
| 3.1.6 | 570 | 6/22/2026 |
| 3.1.5 | 153 | 6/22/2026 |
A correctness release. A projection replay could apply a stream's later fact before its first and
then fail on every attempt, leaving the read models it had emptied empty; the two backfills that
prepare existing history for the Orleans execution model's commit-order readers took the same wrong
order. Beyond that, the setting store no longer needs declared settings, and a setting or permission
vocabulary can be declared in parts.
**Upgrading:**
- **If you replay projections, upgrade.** A store in which one save appended several versions of a
stream can hold sequence numbers that run against those versions, and a replay over it could not
complete. No entry is rewritten and no migration is needed.
- **If you implement `IEventStreamRepository` yourself,** override
`GetManyAfterSequenceInStreamOrderAsync` to give your replay the same guarantee; the default keeps
sequence order.
- **If you backfilled a store for a commit-order reader before this release,** the Orleans migration
guide gives the query that tells whether that history holds a stream out of version order, and how
to repair it.
- **A host that declared an empty `SettingCatalog` as a workaround can drop it.** A host that
registers a catalog through a factory and then calls `AddSettingCatalog` or `AddPermissionCatalog`
now fails at registration instead of replacing that catalog.
- No schema change.
### Added
- **`IEventStreamRepository.GetManyAfterSequenceInStreamOrderAsync`**: a range of the store in the order a
replay applies it — each stream's entries in version order, the streams interleaved as their sequence numbers
interleave them, and the range extended until it no longer ends between two versions of one stream. The default
implementation returns `GetManyAfterSequenceAsync`, sequence order, so a repository of your own compiles and
behaves as before; override the member to give your replay the guarantee.
### Fixed
- **A projection replay applies each stream in version order.** A save does not number its entries in version
order — EF Core chooses the statement order and the identity column numbers the rows as they arrive — and the
replay walked the store by sequence number, so it met a stream's later fact before its first. A projection that
reports a missing preceding fact then failed the batch on every attempt, and because a replay empties the read
models first, each attempt left the read side empty. On a store where many saves wrote several versions of one
stream, no replay could complete. The replay now reads through the new repository member; a batch can hold more
entries than `Projections:BatchSize`. No entry is rewritten and no migration is needed.
- **Both commit-order backfills keep each stream in version order.** `CommitTransactionIdBackfill` could end a
batch between two versions of one stream, stamping the later one with the earlier transaction.
`PartitionCounterBackfill` handed out positions in sequence order, so every save it positioned that the store
had numbered against its versions was read inverted by the portable reader. Both now extend a batch until it no
longer ends inside a stream, and the portable backfill positions each stream's entries in version order.
History backfilled with an earlier version is not revisited, because checkpoints stand on its commit records and
positions; the Orleans migration guide gives the query that tells whether a store holds such a stream.
- **The setting store works without declared settings.** `AddSettingStore<TContext>()` and
`AddSettingStoreFromContextFactory<TContext>()` resolved the `SettingCatalog` inside a factory, so a
host that registered the store and `AddStrataraErasure()` but declared no settings built, passed
`ValidateOnBuild` and every start-up check, and failed on its first erasure with *No service for type
`SettingCatalog` has been registered*. The store now registers an empty catalog when none is declared:
the store works, erasure included, and reading any setting through `ISettingProvider` fails as
undeclared. The example on `AddStrataraErasure` was exactly that composition. A host that declared an
empty catalog as a workaround can drop it.
- **A second `AddSettingCatalog` or `AddPermissionCatalog` call no longer replaces the first.** Each
call registered a new catalog and the last one won, so a host declaring its vocabulary per module kept
only the last module's — the others' settings failed as undeclared and their permissions were denied
without a word. Every call now adds to the one registered catalog, in whichever order it runs relative
to the setting store. A setting name declared in two parts throws as a duplicate; a redeclared
permission has no effect and grants to one role accumulate. A catalog registered as a factory cannot be
added to, and the next call now throws `InvalidOperationException` saying so instead of replacing it.