Oragon.RabbitMQ.Serializer.SystemTextJson 0.0.11

Oragon.RabbitMQ

Official Release

Others

Tech / Skill

Opinionated and Simplified Minimal APIs for Consuming Messages from RabbitMQ, Ensuring No Crucial Configurations Are Hidden.

What is Oragon.RabbitMQ?

Oragon.RabbitMQ provides everything you need to create resilient RabbitMQ consumers without the need to study numerous books and articles or introduce unknown risks to your environment.

If you have a service like this

public class BusinessService
{
    public async Task DoSomethingAsync(BusinessCommandOrEvent commandOrEvent)
    {
        ... business core ...
    }
}

You will create a RabbitMQ Consumers with this

Singleton

builder.Services.AddSingleton<BusinessService>();

builder.Services.AddSingleton<IAMQPSerializer>(sp => new SystemTextJsonAMQPSerializer(new System.Text.Json.JsonSerializerOptions(System.Text.Json.JsonSerializerDefaults.General){ ... }));

builder.Services.MapQueue<BusinessService, BusinessCommandOrEvent>(config => config
    .WithDispatchInRootScope()    
    .WithAdapter((svc, msg) => svc.DoSomethingAsync(msg))
    .WithQueueName("events")
    .WithPrefetchCount(1)
);

Scoped

builder.Services.AddScoped<BusinessService>();

builder.Services.AddSingleton<IAMQPSerializer>(sp => new SystemTextJsonAMQPSerializer(new System.Text.Json.JsonSerializerOptions(System.Text.Json.JsonSerializerDefaults.General){ ... }));

builder.Services.MapQueue<BusinessService, BusinessCommandOrEvent>(config => config
    .WithDispatchInChildScope()    
    .WithAdapter((svc, msg) => svc.DoSomethingAsync(msg))
    .WithQueueName("events")
    .WithPrefetchCount(1)
);

Scoped and Keyed Services, Same Type, Multiple Consumers, Using NewtonsoftAMQPSerializer

builder.Services.AddKeyedScoped<BusinessService>("key-of-service-1");
builder.Services.AddKeyedScoped("key-of-service-2", (sp, key) => new BusinessService(... custom dependencies ...));

builder.Services.AddSingleton<IAMQPSerializer>(sp => new NewtonsoftAMQPSerializer(new Newtonsoft.Json.JsonSerializerSettings(){ ... }));

builder.Services.MapQueue<BusinessService, BusinessCommandOrEvent>(config => config
    .WithDispatchInChildScope()
    .WithKeyedService("key-of-service-1") 
    .WithAdapter((svc, msg) => svc.DoSomethingAsync(msg))
    .WithQueueName("events1")
    .WithPrefetchCount(1)
);

builder.Services.MapQueue<BusinessService, BusinessCommandOrEvent>(config => config
    .WithDispatchInChildScope()
    .WithKeyedService("key-of-service-2") 
    .WithAdapter((svc, msg) => svc.DoSomethingAsync(msg))
    .WithQueueName("events2")
    .WithPrefetchCount(1)
);

Concepts

Decoupling Business Logic from Infrastructure

This approach is designed to decouple RabbitMQ consumers from business logic, ensuring that business code remains unaware of the queue consumption context.

The result is incredibly simple, decoupled, agnostic, more reusable, and highly testable code.

Opinionated Design: Why?

This consumer is focused on creating a resilient consumer using manual acknowledgments.

• The flow produces a BasicReject without requeue for serialization failures (e.g., incorrectly formatted messages), you will use dead-lettering to ensure these messages are not lost.
• The flow produces a BasicNack with requeue for processing failures, allowing for message reprocessing.
• Minimal API design style made without reflection
• Extensible with support for custom serializers and encoders

RabbitMQ Tracing com OpenTelemetry

Full support for OpenTelemetry on publishing or consuming RabbitMQ messages.

<img src="./docs/playground.gif">

Refactored to use RabbitMQ.Client 7x (with IChannel instead IModel)

Stages and Requirements for Launch

• Migrate Demo to Library Project
• Core: Queue Consumer
• Core: Rpc Queue Consumer
• Core: Support Keyed Services
• Core: Support of new design of RabbitMQ.Client
• Create Samples
• Review All SuppressMessageAttribute
• Create Docs
• Benchmarks
• Automate Badges
• Add SonarCloud
• Code Coverage > 80%
• Add CI/CD
• Add Unit Tests
• Add Integrated Tests with TestContainers
• Test CI/CD Flow: MyGet Alpha Packages with Symbols
• Test CI/CD Flow: MyGet Packages without Symbols
• Test CI/CD Flow: Nuget Packages without Symbols