Event Sourcing in .NET Core – part 4: query models
Event Sourcing in .NET Core – part 4: query models

Event Sourcing in .NET Core – part 4: query models

2020, May 24    

Hi All! Welcome to the fourth part of the series about Event Sourcing. This time we’ll see how we can leverage the events to refresh our Query Models.

The last time we saw how we can make use of a message queue to publish domain events to other interested parties.

As I mentioned last time, one of the prerequisites of Event Sourcing is CQRS. The Query part needs a way to be up to date with the Command side. We can (somewhat) easily accomplish this by subscribing to the events generated and reconstruct our models.

One nice thing is that our Query Models can be in whatever form our services need them. We can also have multiple representations of the same entity, based on the context.

For example, we could have a Query Model representing the archive of Customers, exposing only name and email, and another collection holding instead the full details ( number of orders, quotes, comments, whatever).

In the sample code I wrote for this series, I’m using MongoDB as persistence storage to hold the Query Models. A NoSQL DB is often a good choice for this kind of operation: data is denormalized and stored in the exact form we need and there’s no need for expensive joins of any sort. All the necessary logic to handle the relationship is executed once during the (re-)generation of the document.

As I mentioned last time, a Background Worker is listening for events on a Kafka topic. Once an event is received, will be deserialized and passed to an instance of MediatR, which will take care of finding the right handler.

The EventConsumer class exposes an EventReceived event handler we can register to perform this logic. Something like this:

async Task onEventReceived(object s, IDomainEvent<TK> e) {
  var @event = EventReceivedFactory.Create((dynamic)e);
   using var scope = scopeFactory.CreateScope();
   var mediator = scope.ServiceProvider.GetRequiredService<IMediator>();
  await mediator.Publish(@event, CancellationToken.None);
consumer.EventReceived += onEventReceived;

In our case we have a bunch of registered handlers, to refresh the state of the Customers archive, their details, and their Accounts.

For example, this is the code for rebuilding the Customer Details:

public async Task Handle(EventReceived<CustomerCreated> @event, CancellationToken cancellationToken)
            var filter = Builders<CustomerDetails>.Filter
                .Eq(a => a.Id, @event.Event.AggregateId);

            var update = Builders<CustomerDetails>.Update
                .Set(a => a.Id, @event.Event.AggregateId)
                .Set(a => a.Version, @event.Event.AggregateVersion)
                .Set(a => a.Firstname, @event.Event.Firstname)
                .Set(a => a.Lastname, @event.Event.Lastname)
                .Set(a => a.TotalBalance, new Money(Currency.CanadianDollar, 0));

            await _db.CustomersDetails.UpdateOneAsync(filter,
                cancellationToken: cancellationToken,
                update: update,
                options: new UpdateOptions() { IsUpsert = true });

As you can see I’m using UpdateOneAsync() on the _CustomersDetails **_collection. It’s an upsert operation: this way the DB will atomically create the document or replace its values.

Event Sourcing is an extremely interesting architectural pattern, and can lead to excellent results when implemented properly.

It comes with a huge cost in terms of code complexity and it also requires a lot of discipline from the dev team.

Just to give an example, since the system becomes “eventually consistent“, we might incur in situations where the event for creating an Account is picked up before the Customer’s creation.

Let’s take a look at the AccountCreated event handler:

public async Task Handle(EventReceived<AccountCreated> @event, CancellationToken cancellationToken)
            var customerFilter = Builders<CustomerArchiveItem>.Filter
                .Eq(a => a.Id, @event.Event.OwnerId);

            var customer = await (await _db.Customers.FindAsync(customerFilter, null, cancellationToken))
            if (null == customer) 
                var msg = $"unable to find customer by id {@event.Event.OwnerId}";
                throw new ArgumentOutOfRangeException(nameof(@event.Event.OwnerId), msg);

            var filter = Builders<AccountDetails>.Filter
                .Eq(a => a.Id, @event.Event.AggregateId);

            var update = Builders<AccountDetails>.Update
                .Set(a => a.Id, @event.Event.AggregateId)
                .Set(a => a.Version, @event.Event.AggregateVersion)
                .Set(a => a.OwnerFirstName, customer.Firstname)
                .Set(a => a.OwnerLastName, customer.Lastname)
                .Set(a => a.OwnerId, @event.Event.OwnerId)
                .Set(a => a.Balance, new Money(@event.Event.Currency, 0));

            await _db.AccountsDetails.UpdateOneAsync(filter,
                cancellationToken: cancellationToken,
                update: update, 
                options: new UpdateOptions() { IsUpsert = true});

As you can see, the first thing it does is looking up for the account owner details. If that document is not (yet) in the system then we get an exception.

We might also decide to silently log and just exit the handler. It highly depends on the general context.

An approach to handle this kind of situation is instead to use a retry mechanism, something we can implement quite easily with a Polly Policy inside a Decorator:

public class RetryDecorator<TNotification> : MediatR.INotificationHandler<TNotification>
        where TNotification : MediatR.INotification
        private readonly INotificationHandler<TNotification> _inner;
        private readonly Polly.IAsyncPolicy _retryPolicy;

        public RetryDecorator(MediatR.INotificationHandler<TNotification> inner)
            _inner = inner;
            _retryPolicy = Polly.Policy.Handle<ArgumentOutOfRangeException>()
                    i => TimeSpan.FromSeconds(i));

        public Task Handle(TNotification notification, CancellationToken cancellationToken)
            return _retryPolicy.ExecuteAsync(() => _inner.Handle(notification, cancellationToken));

This was the last article of the series. Next time we’ll see what is an offline consumer and why we all need one. Make sure you’re not missing part 1, part 2, and part 3 !.

Did you like this post? Then