Stratara.Outbox.RabbitMQ 4.5.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Stratara.Outbox.RabbitMQ --version 4.5.0
                    
NuGet\Install-Package Stratara.Outbox.RabbitMQ -Version 4.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Stratara.Outbox.RabbitMQ" Version="4.5.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Stratara.Outbox.RabbitMQ" Version="4.5.0" />
                    
Directory.Packages.props
<PackageReference Include="Stratara.Outbox.RabbitMQ" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Stratara.Outbox.RabbitMQ --version 4.5.0
                    
#r "nuget: Stratara.Outbox.RabbitMQ, 4.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Stratara.Outbox.RabbitMQ@4.5.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Stratara.Outbox.RabbitMQ&version=4.5.0
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.Outbox.RabbitMQ&version=4.5.0
                    
Install as a Cake Tool

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 — for ICommand, IEvent, IMessageBus, ICommandOutboxDispatcher, IEventBundleOutboxDispatcher, IProjectionReplayState, IMessagingIdentifier, IWriteUnitOfWork (used at runtime via the outbox repository).
  • Stratara.Contracts — for EventBundle + CommandEnvelope messages.
  • Stratara.Mediator — MediatorCommandWorker dispatches into the in-process IMediator.
  • Stratara.Sessions — dispatcher hydrates CommandEnvelope from 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 in Stratara.Abstractions, but the concrete implementation comes from Stratara.EventSourcing.EntityFrameworkCore. Reference that package alongside this one to get a working stack.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
Loading failed

A release about reads that cost more the more the store holds. Loading an aggregate read its stream and its
snapshot through every partition of the store, so every command grew slower as the store grew. A write context
that applies `ApplyGlobalEntityConfiguration()` also lost the index on the event stream's sequence number, which
left the hashing worker, reading in sequence order and the store's head without an index. Every read of one stream
is now confined to its partition, and the write model declares the indexes it was missing, whichever key the
context gives the event stream. No public type or member changes, but the write context needs a migration, and a
write context that overrides `ConfigureConventions` without calling `base` is now refused at start-up.

**Upgrading:**
- **If your store holds events written before 3.0.0, check it first.** Releases before 3.0.0 worked out a
 stream's partition with another formula, and the store now reads a stream only in the partition its id gives.
 The composition guide (*A store written before 3.0.0*) gives a check that needs nothing but the database, and a
 repair that moves the rows to their partition without touching the hash chain. A store that 3.0.0 or later wrote
 from its start has nothing to check.
- **Generate an EF Core migration for your write context.** It adds up to three indexes and changes no table or
 column: `ix_event_stream_entry_sequence_number` (unique, only where the event stream is not keyed by its sequence
 number, which `ApplyGlobalEntityConfiguration()` makes it), `ix_event_stream_entry_unhashed_sequence_number`
 (the entries whose hash is still null) and `ix_event_chain_anchor_sequence_number`. A host that does not migrate
 fails at `Migrate()` on pending model changes, as with any schema addition.
- **If you declared these indexes yourself, remove your declarations first.** Under the same names and
 definitions, the migration then leaves them as they are. A `(stream_id, version)` index you added to bridge the
 stream reads is no longer needed and can be dropped.
- **On a large store, create the indexes without blocking writes.** The schema section of the composition guide
 shows a migration that creates them with `CREATE INDEX CONCURRENTLY`.
- **A context that overrides `ConfigureConventions` calls `base.ConfigureConventions`.** `WriteDbContext<TContext>`
 declares the sequence-number indexes there. A write context whose override does not call it is now refused when
 its model is built, at start-up and in `dotnet ef` alike, with an `InvalidOperationException` that names the
 context, so it never runs or migrates without the indexes. An override that was fine on 4.4 because the
 method was empty there needs `base.ConfigureConventions(configurationBuilder);` now.
- **An entry or snapshot written outside the framework has to carry its stream's partition.** The store writes
 each one with the partition its stream id gives it, through `BucketCalculator.GetBucketId`, and now reads one
 stream only there. A row a host inserted itself under another partition, in a test fixture or an import, is no
 longer found by the reads of its stream.

### Fixed

- **Loading an aggregate costs what its stream holds.** The reads of one stream (whether it exists, its first entry,
 a range of versions, its current version) and of its snapshot conditioned on the stream id alone. The indexes that
 serve them begin with the partition, so PostgreSQL before 18 walked the whole index for each of them, and a
 command loads several. They now condition on the partition as well. On 300,000 events, reading a stream of three
 went from 2,404 pages to 6.
- **The sequence number stays indexed under `ApplyGlobalEntityConfiguration()`.** That convention keys every entity
 by `Id`, the event stream included, which dropped the key the framework had put on the sequence number. The
 hashing worker's reads, reading the store in sequence order and the store's head then scanned the whole table on
 every pass. The write model now declares a unique index on the sequence number wherever it is not the key.
- **The hashing worker reads only what is still unchained.** An index over the entries whose hash is null lets
 each pass read the backlog and not the chained history before it. Its filter names the column your model maps the
 hash to.
- **The latest anchor is found by index.** The hash chain's anchors are indexed by sequence number, so finding the
 last one no longer sorts every anchor on every pass.