Philiprehberger.Outbox 0.2.1

Philiprehberger.Outbox

Transactional outbox pattern implementation for reliable event/message publishing.

Installation

dotnet add package Philiprehberger.Outbox

Usage

using Philiprehberger.Outbox;

builder.Services.AddOutbox(options =>
{
    options = options with
    {
        PollingInterval = TimeSpan.FromSeconds(10),
        BatchSize = 50,
        MaxRetries = 5
    };
});

builder.Services.AddSingleton<IOutboxStore, MyEfCoreOutboxStore>();
builder.Services.AddSingleton<IOutboxDispatcher, MyRabbitMqDispatcher>();

Saving Messages

using Philiprehberger.Outbox;

var message = new OutboxMessage(
    Id: Guid.NewGuid(),
    Type: "OrderPlaced",
    Payload: JsonSerializer.Serialize(order),
    CreatedAt: DateTimeOffset.UtcNow);

await outboxStore.SaveAsync(message);

Message Priority

using Philiprehberger.Outbox;

var urgent = new OutboxMessage(
    Id: Guid.NewGuid(),
    Type: "PaymentFailed",
    Payload: JsonSerializer.Serialize(payment),
    CreatedAt: DateTimeOffset.UtcNow,
    Priority: MessagePriority.Critical);

await outboxStore.SaveAsync(urgent);

Deduplication with Idempotency Keys

using Philiprehberger.Outbox;

var message = new OutboxMessage(
    Id: Guid.NewGuid(),
    Type: "OrderPlaced",
    Payload: JsonSerializer.Serialize(order),
    CreatedAt: DateTimeOffset.UtcNow,
    IdempotencyKey: $"order-placed-{order.Id}");

await outboxStore.SaveAsync(message);

Dead Letter Queue

using Philiprehberger.Outbox;

// Default in-memory DLQ is registered automatically.
// Replace with your own implementation for production:
builder.Services.AddSingleton<IDeadLetterStore, MyDatabaseDeadLetterStore>();

// Inspect dead-lettered messages:
var dlq = serviceProvider.GetRequiredService<IDeadLetterStore>();
var failed = await dlq.GetAllAsync();

Diagnostic Events

using Philiprehberger.Outbox;

OutboxDiagnostics.MessageDispatched += msg =>
    Console.WriteLine($"Dispatched: {msg.Id} ({msg.Type})");

OutboxDiagnostics.MessageDeadLettered += msg =>
    Console.WriteLine($"Dead-lettered: {msg.Id} after {msg.RetryCount} retries");

API

OutboxMessage

MessagePriority

IOutboxStore

IOutboxDispatcher

IDeadLetterStore

OutboxOptions

OutboxDiagnostics

OutboxServiceCollectionExtensions

Development

dotnet build src/Philiprehberger.Outbox.csproj --configuration Release

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT