Stratara.EventSourcing.Pipeline.CommandAudit
3.2.1
dotnet add package Stratara.EventSourcing.Pipeline.CommandAudit --version 3.2.1
NuGet\Install-Package Stratara.EventSourcing.Pipeline.CommandAudit -Version 3.2.1
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="3.2.1" />
<PackageVersion Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="3.2.1" />
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" />
paket add Stratara.EventSourcing.Pipeline.CommandAudit --version 3.2.1
#r "nuget: Stratara.EventSourcing.Pipeline.CommandAudit, 3.2.1"
#:package Stratara.EventSourcing.Pipeline.CommandAudit@3.2.1
#addin nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=3.2.1
#tool nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=3.2.1
Stratara.EventSourcing.Pipeline.CommandAudit
License: MIT.
Mediator pipeline behavior that records an audit row for every dispatched command in the Stratara event-sourced stack. Both arities are provided so consumers can register a single behavior pair and have it apply to all command shapes.
What's in the box
| Type | Purpose |
|---|---|
AddCommandAuditing() |
The package's public surface — registers both behavior arities in one call. |
CommandAuditBehavior<TRequest> (internal) |
Runs the audit-write step before delegating to next() for IRequest (commands without result). |
CommandAuditBehavior<TRequest, TResult> (internal) |
Same, for IRequest<TResult> (commands with result + queries). Only records when the request also implements ICommandBase — queries flow through untouched. |
CommandAuditWriter (internal) |
Opens a transaction on IWriteUnitOfWork, writes via ICommandAuditRepository.AddAsync, commits. |
The behavior only audits commands — query requests reach the same generic interface but are filtered by the is ICommandBase check, so registering both behaviors application-wide is safe.
Quick start
// At composition time, alongside the other framework pipeline behaviors:
builder.Services.AddCommandAuditing();
That one call registers both behavior arities. The behavior types themselves are internal — they
are an implementation detail, not something to name from your composition root.
The behaviors resolve IWriteUnitOfWork from DI (ships with Stratara.EventSourcing.EntityFrameworkCore in the default deployment). No additional registration is needed.
Dependencies
Stratara.Abstractions— forIPipelineBehavior<,>,IRequest/IRequest<T>,ICommandBase,IWriteUnitOfWork,ICommandAuditRepository.JetBrains.Annotations—[UsedImplicitly]on the public behavior classes (DI-instantiated, no static call site).
At runtime an IWriteUnitOfWork implementation must be registered — typically by referencing Stratara.EventSourcing.EntityFrameworkCore and calling AddWriteStore(IConfiguration).
Security note — command payload contents
The audit row stores CommandTypeName and the serialized CommandJson of the dispatched command. Whatever fields your commands carry land in the audit table. Sensitive data (passwords, tokens, API keys, encryption material) MUST NOT live on a command record — or must be marked with [EncryptData] so the registered ISecureJsonSerializer encrypts them before persistence.
The default Stratara registration uses ISecureJsonSerializer (AES-GCM + tenant-scoped AAD) for the audit serialization, so [EncryptData]-annotated properties are protected. Plain-text properties go to disk unencrypted — treat the audit table accordingly when designing command shapes.
| 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)
- Stratara.Abstractions (>= 3.2.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
### Fixed
- **Snapshot loads are now scoped to the aggregate type.** The snapshot read previously filtered
only by stream id, so when two aggregate types shared a stream id, rehydrating one type could
pick up the other type's (higher-versioned) snapshot and deserialize it into the requested type —
silently returning an aggregate with default/empty fields. Snapshot reads now match the aggregate
type (version-independently, so an assembly rev-bump does not invalidate existing snapshots), and
snapshot writes are grouped per `(stream, aggregate type)` so a stream carrying more than one type
snapshots each type independently. A snapshot of type X may now only ever rehydrate type X.
### Changed
- **`ISnapshotRepository` gained type-scoped read overloads.** `GetAsync(streamId,
aggregateTypeName, toVersion, ct)` and `GetLatestVersionOrDefaultAsync(streamId,
aggregateTypeName, ct)` are the correct lookups; the previous type-less overloads are now
`[Obsolete]` because they can return a foreign aggregate type's snapshot on a shared stream.
Custom `ISnapshotRepository` implementers should add the new overloads.