Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pandatecham/be-lib-masstransit-postgres-outbox

Enhance your MassTransit applications with scalable, multi-DbContext support for PostgreSQL outbox and inbox patterns, ensuring robust message delivery and processing.
https://github.com/pandatecham/be-lib-masstransit-postgres-outbox

distributed-systems ef-core inbox-pattern library mass-transit messaging microservices modular-monolith nuget outbox-pattern pandatech postgres

Last synced: 3 days ago
JSON representation

Enhance your MassTransit applications with scalable, multi-DbContext support for PostgreSQL outbox and inbox patterns, ensuring robust message delivery and processing.

Awesome Lists containing this project

README 

        
- [1. Pandatech.MassTransit.PostgresOutbox](#1-pandatechmasstransitpostgresoutbox)

  - [1.1. Features](#11-features)

  - [1.2. Getting Started](#12-getting-started)

  - [1.3. Installation](#13-installation)

  - [1.4. Configuration](#14-configuration)

  - [1.5. Usage](#15-usage)

    - [1.5.1. Configuration](#151-configuration)

    - [1.5.2. Publishing Messages (Outbox Pattern)](#152-publishing-messages-outbox-pattern)

    - [1.5.3. Consuming Messages (Inbox Pattern)](#153-consuming-messages-inbox-pattern)

  - [1.6. License](#16-license)



# 1. Pandatech.MassTransit.PostgresOutbox



Welcome to the Pandatech MassTransit PostgreSQL Outbox Extension repository. This library is designed to enhance

MassTransit's capabilities by introducing robust support for the Outbox and Inbox patterns with a particular focus on

PostgreSQL, alongside seamless integration with multiple DbContexts in Entity Framework Core. This extension is ideal

for developers seeking to ensure reliable message delivery and processing in distributed, microservice-oriented

architectures.



## 1.1. Features



- **Multiple DbContext Support**: Operate within complex systems using multiple data contexts without hassle.

- **Outbox Pattern Implementation**: Reliably handle message sending operations, ensuring no messages are lost in

  transit, even in the event of system failures.

- **Inbox Pattern Support**: Process incoming messages effectively, preventing duplicate processing and ensuring message

  consistency.

- **PostgreSQL ForUpdate Concurrency Handling**: Utilize PostgreSQL's ForUpdate feature for enhanced concurrency

  control, making your message handling processes more robust.

- **Seamless Integration**: Designed to fit effortlessly into existing MassTransit and EF Core based projects.



## 1.2. Getting Started



To get started with the Pandatech MassTransit PostgreSQL Outbox Extension, ensure you have the following prerequisites:



- .NET Core 8 or later

- An existing MassTransit project

- PostgreSQL database



## 1.3. Installation



The library can be installed via NuGet Package Manager. Use the following command:



```bash

Install-Package Pandatech.MassTransit.PostgresOutbox

``` 



## 1.4. Configuration



Before diving into the usage, it's essential to configure the Pandatech MassTransit PostgreSQL Outbox Extension in your

application. This involves setting up your DbContexts, configuring MassTransit to use the extension, and initializing

the Outbox and Inbox features.



Stay tuned for the next sections where we'll cover the usage details, showcasing how you can leverage this powerful

extension to enhance your distributed systems.



## 1.5. Usage



Take into account that examples below are given for configuring both inbox and outbox patterns.

If you need only one of those , consider using appropriate methods available(eg. instead of AddOutboxInboxServices use

AddInboxServices and etc).



### 1.5.1. Configuration



**Entity Configuration:** Ensure your `DbContext` implements the `IOutboxDbContext` and `IInboxDbContext` interfaces.

Configure your entities and generate migrations.

Call `ConfigureInboxOutboxEntities` on your `ModelBuilder` to configure the necessary tables for inbox and outbox patterns.



```csharp

protected override void OnModelCreating(ModelBuilder modelBuilder)

{

    modelBuilder.ConfigureInboxOutboxEntities();

}

```

And you need to call `UseQueryLocks()` inside `AddDbContext` or `AddDbContextPool` , this needs for enabling `ForUpdate`

feature.

```csharp

builder.Services.AddDbContextPool(options =>

         options.UseNpgsql(connectionString)

                .UseQueryLocks());

```



**Service Registration:** Register essential services on startup, specifying the `DbContext` type.

You can optionally override settings(its optional parameter).



```csharp

services.AddOutboxInboxServices();

```



### 1.5.2. Publishing Messages (Outbox Pattern)



To publish a message using the outbox pattern, call the `AddToOutbox` method on your `DbContext`,

specifying your message. Remember to call `SaveChanges()` to persist the message to the database.



```csharp

dbContext.Orders.Add(new Order

{

    Amount = 555,

    CreatedAt = DateTime.UtcNow,

});



// Add message to the outbox

dbContext.AddToOutbox(new OrderCreatedEvent());



// Save changes to the database

dbContext.SaveChanges();

```



### 1.5.3. Consuming Messages (Inbox Pattern)



To consume messages using the inbox pattern, create a consumer that inherits from

`InboxConsumer` class, specifying the message type and `DbContext` type as generic arguments.



```csharp



public class YourConsumer : InboxConsumer

{

    private readonly PostgresContext _context;



    public YourConsumer(PostgresContext dbContext, IServiceScopeFactory serviceScopeFactory)

        : base(serviceScopeFactory)

    {

        _context = dbContext;

    }



    public override async Task Consume(YourMessage message)

    {

        // Implement your message processing logic here

    }

}

```



## 1.6. License



Pandatech.MassTransit.PostgresOutbox is licensed under the MIT License.