MNW #031: Implementing The Saga Pattern With Rebus And RabbitMQ

Read time: 5 minutes

A big thank you to our sponsors who keep this newsletter free to the reader:

This week's issue is sponsored by QueueExplorer. QueueExplorer is an explorer-like management console for RabbitMQ, Azure Service Bus, MSMQ, and ActiveMQ. With QueueExplorer you can see what happens in your queues, edit and fix problematic messages, extract business data from JSON or XML payloads, or send thousands of messages for stress testing.

And by Rebus Pro. Rebus is a free .NET "service bus", and Rebus Pro is the perfect one-up for serious Rebus users. Use Fleet Manager to get Slack alerts when something fails and retry dead-lettered messages with a click of the mouse.

Designing long-lived processes in a distributed environment is an interesting engineering challenge.

And a well known pattern for solving this problem is a Saga.

A Saga is a sequence of local transactions, where each local transaction updates the Saga state and publishes a message triggering the next step in the Saga.

Sagas come in two forms:

Orchestrated
Choreographed

With an orchestrated Saga, there's a central component responsible for orchestrating the individual steps.

In a choreographed Saga, processes work independently but coordinate with each other using events.

In this week's issue, I'll show you how to create orchestrated Sagas using the Rebus library with RabbitMQ for message transport.

Rebus Configuration

Rebus is a free .NET “service bus”, and it's practical for implementing asynchronous messaging-based communication between the components of an application.

Let's install the following libraries:

Rebus.ServiceProvider for managing the Rebus instance
Rebus.RabbitMq for RabbitMQ message transport
Rebus.SqlServer for SQL Server state persistence

Inside of your ASP .NET Core application you will need the following configuration.

Unpacking the individual configuration steps:

Routing - Configures messages to be routed by their type
Transport - Configures the message transport mechanism
Sagas - Configures the Saga persistence store
Timeouts - Configures the timeouts persistence store

You also need to specify the queue name for sending and receiving messages.

AutoRegisterHandlersFromAssemblyOf will scan the specified assembly and automatically register the respective message handlers.

Creating The Saga With Rebus

We're going to create a Saga for a newsletter onboarding process.

When a user subscribes to the newsletter we want to:

Send a welcome email immediately
Send a follow-up email after 7 days

The first step in creating the Saga is defining the data model by implementing ISagaData. We'll keep it simple and store the Email for correlation, and add two flags for the distinct steps in our Saga.

Now we can define the NewsletterOnboardingSaga class by inheriting from the Saga class and implementing the CorrelateMessages method.

It's a best practice to use a unique value for correlation. In our case this will be the Email.

You also configure how the Saga starts with IAmInitiatedBy, and the individual messages the Saga handles with IHandleMessages.

Message Types And Naming Conventions

There are two types of messages you send in a Saga:

Commands
Events

Commands instruct the receiving component what to do.
Think: verb, imperative.

Events notify the Saga which process was just completed.

Think: what happened, past tense.

Saga Orchestration With Messages

The NewsletterOnboardingSaga starts by handling the SubscribeToNewsletter command, and publishes a SendWelcomeEmail command.

The SendWelcomeEmail command is handled by a different component, which publishes a WelcomeEmailSent event when it completes.

In the WelcomeEmailSent handler we update the Saga state and publish a deferred message by calling Defer. Rebus will persist the SendFollowUpEmail command, and publish it when the timeout expires.

Finally, the SendFollowUpEmail command is handled and we publish the FollowUpEmailSent event.

We update the Saga state again, and also call MarkAsComplete to complete the Saga.

Completing the Saga will delete it from the database.

Handling Commands With Rebus

Here's how the SendWelcomeEmail command handler looks like:

The important thing to highlight here is that we're using the Reply method to send a message back. This will reply back to the endpoint specified as the return address on the current message.

In Summary

Sagas are practical for implementing a long-lived process in a distributed system. Each business process is represented by a local transaction, and publishes a message to trigger the next step in the Saga.

Although Sagas are very powerful, they are also complicated to develop, maintain and debug.

We didn't cover a few important topics in this newsletter:

Error handling
Message retries
Compensating transactions

I think you'll have some fun researching these on your own.

Take a look at the source code for the example used in this newsletter if you want to learn more about implementing Sagas.

If you have Docker installed, you should be able to run it without a problem and try it out.

Thank you for reading, and have an awesome Saturday.

Whenever you're ready, there are 3 ways I can help you 🎁

To access Production-ready source code that I use in my YouTube videos support me on Patreon
For more practical & in-depth coding examples subscribe to my YouTube channel
Promote yourself to 13.000+ subscribers by sponsoring this newsletter (booked out 2 months)

You received this email because you subscribed to our list. You can unsubscribe at any time.

Dragise Cvetkovica 2, Niš, 18000, Serbia

Key phrases

free NET service bus Azure Service Bus interesting engineering challenge serious Rebus users The Saga Pattern

Older messages

MNW #030: How To Publish MediatR Notifications In Parallel

Saturday, March 25, 2023

Find out how one simple change can give you a 10x performance boost ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ View In The Browser MNW #

MNW #029: Creating Data-Driven Tests With xUnit

Saturday, March 18, 2023

4 ways to write parameterized tests in .NET ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ View In The Browser MNW #029: Creating Data-Driven

MNW #028: Using Multiple EF Core DbContexts In a Single Application

Saturday, March 11, 2023

Find out when you should use multiple DbContexts in your application ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ View In The Browser MNW #

MNW #027: How To Apply Functional Programming In C#

Saturday, March 4, 2023

Object-oriented programming is easier if you know functional programming ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ View In The Browser MNW

MNW #026: Outbox Pattern For Reliable Microservices Messaging 📦

Saturday, February 25, 2023

Find out how can you implement reliable communication in a distributed system ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ View In The Browser

Physical vs. Digital Games: Should You Buy Physical Games?

Monday, June 5, 2023

Did You Know?: The enormous geodesic polyhedron, Spaceship Earth, at the center of Walt Disney World's Epcot park, is clad in 11324 silvered isosceles triangles. If a perfect polyhedron, it would

DeveloPassion's Newsletter #124 - Polywork

Monday, June 5, 2023

Hello everyone! I'm Sébastien Dubois, your host (I'm on Twitter). You're receiving this email because you signed up for DeveloPassion's Newsletter. Thank you for being here with me ✨

Noonification: How Atoms Fixed Flux

Monday, June 5, 2023

Top Tech Content sent at Noon! HackerNoon Web 2.5 Documentary Coming Soon to Amazon Prime! How are you, @hacker? 🪐 What's happening in tech this week: The Noonification by HackerNoon has got you

How to win the AI products arms race

Monday, June 5, 2023

Everyone is racing to integrate AI into new and pre-existing products. But AI alone is not a silver bullet. Hiten's Pick Winning the AI Products Arms Race Everyone is racing to integrate AI into

🍑 Early stage peaches & more this week at TechCrunch | June 5

Monday, June 5, 2023

What's happening at TechCrunch this week TechCrunch events roundup This Wednesday, we are focusing on the Atlanta startup ecosystem at TechCrunch Live City Spotlight. Not only will you will

WWDC today: Everything to expect

Monday, June 5, 2023

95% of devs use gen AI; Micro-social media; Best floor standing speakers -- ZDNET ZDNET Tech Today - US June 5, 2023 placeholder Every Apple product we're expecting at WWDC: AR/VR headset, Mac

Win a $100 Amazon Gift Card! Build Modern Apps in Record Time: Join Our Low-Code Deep Dive!

Monday, June 5, 2023

Build Modern Apps in Record Time: Join Our Low-Code Deep Dive! Hi Professional, Are you struggling to meet your customers' demands for easy and convenient experiences across all channels and

Software Testing Weekly - Issue 171

Monday, June 5, 2023

A Deep Dive into Quality Metrics 📊 View on the Web Archives ISSUE 171 June 5th 2023 COMMENT Welcome to the 171st issue! Since the beginning of this newsletter, I've featured well over 4000 articles

Amazon reportedly exploring free cell phone service for Prime subscribers

Monday, June 5, 2023

The Morning After Now available on your smart speaker and wherever you get your podcasts Apple Podcasts | Spotify | Google Podcasts It's Monday, June 05, 2023. According to Bloomberg, Amazon is in

Magento, WooCommerce, WordPress, and Shopify Exploited in Web Skimmer Attack

Monday, June 5, 2023

The Hacker News Daily Updates Newsletter cover Proactive Application Security: Why Shifting Left and Developing Clean Code are Fundamental to Application Security On Demand Webinar Download Now