Yapidoo.Common.Messaging 1.0.0

Yapidoo.Common.Messaging

Shared RabbitMQ messaging abstractions, serializer wiring, publisher wiring, and consumer wiring for Yapidoo .NET 10 backend services.

This is the maintained documentation file for the package.

What is in this package

• services.AddYapidooMessagingPublisher(configurationSection)
• services.AddYapidooMessagingConsumer<THandler, TPayload>(configurationSection)
• services.AddYapidooMessagingSerializer()
• IIntegrationEventPublisher
• IIntegrationEventHandler<TPayload>
• IMessageSerializer
• RabbitMqOptions
• RabbitMqIntegrationEventPublisher
• RabbitMqConsumerHostedService<THandler, TPayload>
• IntegrationEventMessage<TPayload>

Installation

dotnet add package Yapidoo.Common.Messaging

Project path

services/common/Yapidoo.Common.Messaging

Usage

Register serializer only

using Yapidoo.Common.Messaging.Registration;

builder.Services.AddYapidooMessagingSerializer();

Register publisher

using Yapidoo.Common.Messaging.Registration;

builder.Services.AddYapidooMessagingPublisher(
    builder.Configuration.GetSection("Messaging:Publisher"));

Register consumer

using Yapidoo.Common.Messaging.Abstractions;
using Yapidoo.Common.Messaging.Models;
using Yapidoo.Common.Messaging.Registration;

builder.Services.AddYapidooMessagingConsumer<UserRegisteredHandler, UserRegisteredPayload>(
    builder.Configuration.GetSection("Messaging:Consumers:UserRegistered"));

public sealed class UserRegisteredHandler : IIntegrationEventHandler<UserRegisteredPayload>
{
    public Task HandleAsync(IntegrationEventMessage<UserRegisteredPayload> message, CancellationToken cancellationToken = default)
    {
        // map to use-case command and execute business reaction
        return Task.CompletedTask;
    }
}

public sealed record UserRegisteredPayload(Guid IdentityUserId, string Email);

Baseline configuration example

{
  "Messaging": {
    "Publisher": {
      "ConnectionString": "amqp://guest:guest@localhost:5672",
      "ExchangeName": "yapidoo.integration",
      "ExchangeType": "topic"
    },
    "Consumers": {
      "UserRegistered": {
        "ConnectionString": "amqp://guest:guest@localhost:5672",
        "ExchangeName": "yapidoo.integration",
        "ExchangeType": "topic",
        "QueueName": "users.user-registered",
        "RoutingKey": "auth.user.registered",
        "PrefetchCount": 16,
        "RetryCount": 3,
        "DeadLetterExchange": "yapidoo.integration.dlx",
        "DeadLetterQueue": "users.user-registered.dlq"
      }
    }
  }
}

Change the code

Typical flow:

1. Update abstractions/options/registration/publisher/consumer code.
2. Add or update tests in tests/Yapidoo.Common.Messaging.Tests/.
3. Run local validation:

dotnet restore services/common/Yapidoo.Common.Messaging/Yapidoo.Common.Messaging.sln
dotnet test services/common/Yapidoo.Common.Messaging/Yapidoo.Common.Messaging.sln
dotnet build services/common/Yapidoo.Common.Messaging/Yapidoo.Common.Messaging.csproj -c Release

Usage rules

• use shared registration from this package for RabbitMQ publisher/consumer wiring
• keep business reactions in use-case handlers, not in broker plumbing
• keep secrets and sensitive payload data out of logs

License

MIT