Revo Framework

Revo is an application framework for modern server C#/.NET applications built with event sourcing, CQRS and DDD.

Development of this framework is supported by <a href="https://olify.io">OLIFY - smarter solution for facility management & maintenance.</a>

🏠 Home
⚡️ Features
👓 Super-short example
🚀 Getting started
📘 Full documentation
📦 Packages
📑 License

⚡️ Features

The project combines the concepts of event sourcing, CQRS and DDD to provide framework for building applications that are scalable, maintainable, can work in distributed environments and are easy to integrate with outside world. As such, it takes some rather opinionated approaches on the design of certain parts of its architecture. Revo also offers other common features and infrastructure that is often necessary for building complete applications – for example, authorizations, validations, messaging, integrations, multi-tenancy or testing. Furthermore, its extensions implement other useful features like entity history change-tracking, auditing or user notifications.

Domain-Driven Design
Building blocks for rich DDD-style domain models (aggregates, entities, value objects, domain events, repositories...).

Event Sourcing
Implementing event-sourced entity persistence with support for multiple event store backends (PostgreSQL, MSSQL, SQLite...).

CQRS
Segregating command and query responsibilities with:

Commands and queries
Command/query handlers
Processing pipeline with filters for cross-cutting concerns (authorization, validation)
Different read/write models

A/synchronous event processing
Support for both synchronous and asynchronous event processing, guaranteed at-least-once delivery, event queues with strict sequence ordering (optionally), event source catch-ups, optional pseudo-synchronous event dispatch for listeners (projectors, for example).

Data access
Thin abstraction layer for easy data persistence (e.g. querying read models) using Entity Framework Core, Entity Framework 6, RavenDB, testable in-memory database or other data providers. Includes support for simple database migrations.

Projections
Support for read-model projections with various backends (e.g. Entity Framework Core (PostgreSQL, MSSQL, SQLite,...), Entity Framework 6, RavenDB...), automatic idempotency- and concurrency-handling, etc.

SOA, messaging and integration
Scale and integrate by publishing and receiving events, commands and queries using common messaging patterns,<br> e.g. with RabbitMQ message queue (using EasyNetQ connector or Rebus service bus).

Sagas
Coordinating long-running processes or inter-aggregate cooperation with sagas that react to events<br>(a.k.a. process managers).

Authorization
Basic permission/role-based ACL for commands and queries, fine-grained row filtering.

Other minor features:

Validation for commands, queries and other structures.
Jobs
Multi-tenancy
Event message metadata
Event versioning
Event upgrades
Database migrations
History and change-tracking
User notifications: event-based, with different output channels (mail, etc.), aggregation, buffering, etc.
.NET 6.0+ support (with integration for ASP.NET Core)

👓 Show me how it looks!

Super-short example of a simple application that can save tasks using event-sourced aggregates and then query them back from a RDBMS.

Event

The event that happens when changing a task's name.

public class TodoRenamedEvent : DomainAggregateEvent
{
    public TodoRenamedEvent(string name)
    {
        Name = name;
    }

    public string Name { get; }
}

Aggregate

The task aggregate root.

public class Todo : EventSourcedAggregateRoot
{
    public Todo(Guid id, string name) : base(id)
    {
        Rename(name);
    }
    
    protected Todo(Guid id) : base(id)
    {
    }
    
    public string Name { get; private set; }
    
    public void Rename(string name)
    {
        if (!Name != name)
        {
            Publish(new TodoRenamedEvent(name));
        }
    }
    
    private void Apply(TodoRenamedEvent ev)
    {
        Name = ev.Name;
    }
}

Command and command handler

Command to save a new task.

public class CreateTodoCommand : ICommand
{
    public CreateTodoCommand(string name)
    {
        Name = name;
    }

    [Required]
    public string Name { get; }
}

public class TodoCommandHandler : ICommandHandler<CreateTodoCommand>
{
    private readonly IRepository repository;
    
    public TodoCommandHandler(IRepository repository)
    {
        this.repository = repository;
    }
    
    public Task HandleAsync(CreateTodoCommand command, CancellationToken cancellationToken)
    {
        var todo = new Todo(command.Id);
        todo.Rename(command.Name);
        repository.Add(todoList);
        return Task.CompletedTask;
    }   
}

Read model and projection

Read model and a projection for the event-sourced aggregate.

public class TodoReadModel : EntityReadModel
{
    public string Name { get; set; }
}

public class TodoListReadModelProjector : EFCoreEntityEventToPocoProjector<Todo, TodoReadModel>
{
    public TodoListReadModelProjector(IEFCoreCrudRepository repository) : base(repository)
    {
    }
    
    private void Apply(IEventMessage<TodoRenamedEvent> ev)
    {
        Target.Name = ev.Event.Name;
    }
}

Query and query handler

Query to read the tasks back from a RDBMS.

public class GetTodosQuery : IQuery<IQueryable<TodoReadModel>>
{
}

public class TaskQueryHandler : IQueryHandler<GetTodoQuery, IQueryable<TodoReadModel>>
{
    private readonly IReadRepository readRepository;
    
    public TaskListQueryHandler(IReadRepository readRepository)
    {
        this.readRepository = readRepository;
    }
    
    public Task<IQueryable<TodoReadModel>> HandleAsync(GetTodoListsQuery query, CancellationToken cancellationToken)
    {
        return Task.FromResult(readRepository
            .FindAll<TodoListReadModel>());
    }
}

🚀 Getting started

If you are new to the framework, you can

begin with reading the quick walkthrough for the Simple TO-DOs example (a task list app)
or try exploring ~~the other examples~~ (TODO!) and framework sources on Github.

You can also start by reading the 📘 reference guide.

📦 Packages

Released version are available in form of NuGet packages.
There is also a separate pre-release CI package feed at Azure.

<div style="width:100%";> <table border="0" cellpadding="0" cellspacing="0" style="float:left;"> <tr> <th colspan="2"> Core </th> </tr> <tr> <td> Revo.Core </td> <td> <a href="https://www.nuget.org/packages/Revo.Core/"><img src="https://img.shields.io/nuget/v/Revo.Core.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.DataAccess </td> <td> <a href="https://www.nuget.org/packages/Revo.DataAccess/"><img src="https://img.shields.io/nuget/v/Revo.DataAccess.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.Domain </td> <td> <a href="https://www.nuget.org/packages/Revo.Domain/"><img src="https://img.shields.io/nuget/v/Revo.Domain.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.Infrastructure </td> <td> <a href="https://www.nuget.org/packages/Revo.Infrastructure/"><img src="https://img.shields.io/nuget/v/Revo.Infrastructure.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.Testing </td> <td> <a href="https://www.nuget.org/packages/Revo.Testing/"><img src="https://img.shields.io/nuget/v/Revo.Testing.svg" alt="NuGet package version"></a> </td> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" style="float:left;"> <tr> <th colspan="2"> Data access </th> </tr> <tr> <td> Revo.EFCore </td> <td> <a href="https://www.nuget.org/packages/Revo.EFCore/"><img src="https://img.shields.io/nuget/v/Revo.EFCore.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.EF6 </td> <td> <a href="https://www.nuget.org/packages/Revo.EF6/"><img src="https://img.shields.io/nuget/v/Revo.EF6.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.RavenDB </td> <td> <a href="https://www.nuget.org/packages/Revo.RavenDB/"><img src="https://img.shields.io/nuget/v/Revo.RavenDB.svg" alt="NuGet package version"></a> </td> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" style="float:left;"> <tr> <th colspan="2"> Platforms </th> </tr> <tr> <td> Revo.AspNetCore </td> <td> <a href="https://www.nuget.org/packages/Revo.AspNetCore/"><img src="https://img.shields.io/nuget/v/Revo.AspNetCore.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.Hangfire </td> <td> <a href="https://www.nuget.org/packages/Revo.Hangfire/"><img src="https://img.shields.io/nuget/v/Revo.Hangfire.svg" alt="NuGet package version"></a> </td> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" style="float:left;"> <tr> <th colspan="2"> Integrations </th> </tr> <tr> <td> Revo.EasyNetQ (RabbitMQ connector) </td> <td> <a href="https://www.nuget.org/packages/Revo.EasyNetQ/"><img src="https://img.shields.io/nuget/v/Revo.EasyNetQ.svg" alt="NuGet package version"></a> </td> </tr> <tr> <td> Revo.Rebus (service bus, deprecated) </td> <td> <a href="https://www.nuget.org/packages/Revo.Rebus/"><img src="https://img.shields.io/nuget/v/Revo.Rebus.svg" alt="NuGet package version"></a> </td> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" style="float:left;"> <tr> <th colspan="2"> Other extensions