Stratara.Outbox.RabbitMQ 4.4.5

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.4.5
                    
NuGet\Install-Package Stratara.Outbox.RabbitMQ -Version 4.4.5
                    
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.4.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Stratara.Outbox.RabbitMQ" Version="4.4.5" />
                    
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.4.5
                    
#r "nuget: Stratara.Outbox.RabbitMQ, 4.4.5"
                    
#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.4.5
                    
#: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.4.5
                    
Install as a Cake Addin
#tool nuget:?package=Stratara.Outbox.RabbitMQ&version=4.4.5
                    
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.4.10 0 10/26/2026
4.4.9 0 10/26/2026
4.4.8 181 10/24/2026
4.4.7 70 10/23/2026
4.4.6 202 10/22/2026
4.4.5 327 10/14/2026
4.4.4 320 10/10/2026
4.4.3 144 10/10/2026
4.4.2 418 10/2/2026
4.4.1 392 9/29/2026
4.4.0 164 9/27/2026
4.3.1 158 9/25/2026
4.3.0 324 9/23/2026
4.2.0 193 9/18/2026
4.1.1 122 9/16/2026
4.1.0 123 9/16/2026
4.0.4 965 9/14/2026
4.0.3 206 9/3/2026
4.0.2 628 9/3/2026
4.0.1 430 9/2/2026
Loading failed

A command can now say whose data its protected fields are. Until now a command's `[EncryptData]` fields were
encrypted for the session that dispatched it, so a session with no tenant could not protect anything and a session
with another tenant protected under the wrong one. Additive and opt-in; no schema change and no migration. One
ordering rule applies once a host starts using it (see *Changed*).

### Added

- **A command can name the owner of its protected fields.** A command that implements the new `INamesDataOwner`
 (`Stratara.Abstractions.Security`: `Guid DataOwnerTenantId`, optional `Guid? DataOwnerUserId`) has its
 `[EncryptData]` fields encrypted for that owner wherever the framework serializes it — the copy the outbox, the
 bus and the Orleans record carry to its handler, and the copy the command audit records — whatever session
 dispatched it. It is to a command what `IAggregateCreationEvent` is to a stream's first event. Three cases it
 answers: a session with no tenant (an anonymous endpoint, or a saga reacting to a fact one recorded) could not
 encrypt a `TenantScoped` field at all outside development; a session with another tenant than the data's owner
 encrypted it under that tenant's key, silently, so the real owner's erasure left the audit record readable; and
 the two copies of one command were written for different users. For a command that names its owner, both copies
 are written for the same tenant and the same user.
- **The audit record of such a command is attributed to the named owner.** Its data-owner tenant and user are the
 owner the command names; its actor is the session's, as before. A tenant's view of the command log then holds the
 commands that carried its data, whoever issued them, and each record can be read back from its own columns.
- **`CommandEnvelope.DataOwnerTenantId` and `.DataOwnerUserId`** carry the owner beside the session context. They
 are set only for a command that names an owner and are omitted from the JSON otherwise; the constructor and
 `Deconstruct` are unchanged. The handling host reads the command's protected fields for the owner the envelope
 carries and runs the handler under the session it carries.
- **`CommandDataOwner`** (`Stratara.Shared.Security`) is the one resolution every writer and reader of a command
 uses, for a host that serializes commands itself.

### Changed

- **The bus-envelope signature covers a named owner.** A signed command does not verify when it is presented with
 another data owner, or with its owner removed. A command that names no owner has the canonical form it had before,
 so publishers and consumers on either side of this release verify each other's signatures for it and a fleet in
 `Strict` mode upgrades without a pass through `Permissive`.
- **Upgrade the hosts that handle commands before a host dispatches a command that names an owner.** A command
 worker or silo on an earlier release cannot read the owner. It does not run the handler with the fields emptied:
 in `Strict` mode the signature does not verify, otherwise the read fails authentication, and the message is
 retried and then kept. Two deployments are the simple order — this release first, the declarations after.
- **Nothing changes for a command that names no owner.** It is serialized, stored, published and signed as before.
 That includes a divergence this release states rather than removes: its travelling copy is written for the
 session's tenant and the *acting* user, its audit record for the session's tenant and the session's *data-owner*
 user — for an ordinary signed-in request, a user and nobody. Aligning that default would re-key every protected
 command field in transit and is left to a major version; a command that names its owner is not affected.

### Security

- **An erasure now reaches a command's protected fields where the command names its owner.** `ISubjectEraser`'s
 documentation said the command audit log and the outbox are left alone. Their rows still are; what it now also
 says is what happens to protected fields in them. A command that names its owner has them under that owner's key
 in both places, so the owner's erasure leaves the record of the command with those fields unreadable, and a
 command still waiting reaches its handler with them absent.
- **A command that names an empty tenant, or an empty user, as its owner is refused.** It fails with
 `ArgumentException` naming the command type where it is recorded and where it is dispatched, and nothing is
 recorded or sent. It does not fall back to the session, which would hide a caller's mistake in valid ciphertext
 under the wrong tenant's key.
- **Naming an owner authorizes nothing, and the owner is taken as stated.** Nothing compares the named owner
 against the session; the handler runs under the dispatching session, and authorization and tenant isolation decide
 as they do for any other command. Nothing checks that the named tenant exists either, and key material is created
 for it on first use — name an owner the code resolved from something it trusts, never one copied from a request.
- **A command encrypted as a whole does not outlive its owner.** With `[EncryptData]` on individual fields, a
 command still waiting when its owner is erased reaches its handler with those fields absent. With `[EncryptData]`
 on the class there is nothing left to rebuild: the command is retried and then kept, and its handler does not run.
 That is how a command whose session tenant was erased already behaved; it is now stated.