EventSourced

Event sourced entities in Rust.

Concepts

EventSourced is inspired to a large degree by the amazing Akka Persistence library. It provides a framework for implementing Event Sourcing and CQRS.

The EventSourced trait defines types for commands, events, snapshot state and errors as well as methods for command handling, event handling and setting a snapshot state.

The EvtLog and SnapshotStore traits define a pluggable event log and a pluggable snapshot store respectively. For NATS and Postgres these are implemented in the respective crates.

The spawn extension method provides for creating entities – "running" instances of an EventSourced implementation, identifiable by a Uuid – for some event log and some snapshot store. Conversion of events and snapshot state to and from bytes happens via given binarizer functions; for prost and serde_json these are already provided.

Calling spawn results in a cloneable EntityRef which can be used to pass commands to the spawned entity by invoking handle_cmd. Commands are handled by the command handler of the spawned entity. They can be rejected by returning an error. Valid commands produce an event with an optional tag which gets persisted to the EvtLog and then applied to the event handler of the respective entity. The event handler may decide to save a snapshot which is used to speed up future spawning.

Events can be queried from the event log by ID or by tag. These queries can be used to build read side projections.

Requirements for building the project and examples

Before building the project and examples, please make sure you have installed the protobuf dependency that is not only needed for the optional byte conversion with prost, but also for eventsourced-nats. The only way to get away without protobuf is to not use prost and not build eventsourced-nats.

On macOS protobuf can be installed via Homebrew:

brew install protobuf

Counter example (no pun intended)

The counter package in the example directory contains a simple example: a counter which handles Inc and Dec commands and emits/handles Increased and Decreased events.

#[derive(Debug)]
pub struct Counter;

impl EventSourced for Counter {
    type Cmd = Cmd;
    type Evt = Evt;
    type State = State;
    type Error = Error;

    const TYPE_NAME: &'static str = "counter";

    fn handle_cmd(
        _id: Uuid,
        state: &Self::State,
        cmd: Self::Cmd,
    ) -> Result<impl IntoTaggedEvt<Self::Evt>, Self::Error> {
        let value = state.value;

        match cmd {
            Cmd::Inc(inc) if inc > u64::MAX - value => Err(Error::Overflow { value, inc }),
            Cmd::Inc(inc) => Ok(Evt::Increased(inc)),

            Cmd::Dec(dec) if dec > value => Err(Error::Underflow { value, dec }),
            Cmd::Dec(dec) => Ok(Evt::Decreased(dec)),
        }
    }

    fn handle_evt(mut state: Self::State, evt: Self::Evt) -> Self::State {
        match evt {
            Evt::Increased(inc) => state.value += inc,
            Evt::Decreased(dec) => state.value -= dec,
        };
        state
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Cmd {
    Inc(u64),
    Dec(u64),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum Evt {
    Increased(u64),
    Decreased(u64),
}

#[derive(Debug, Default, Serialize, Deserialize)]
pub struct State {
    value: u64,
}

#[derive(Debug, Clone, Copy, Error)]
pub enum Error {
    #[error("Overflow: value={value}, increment={inc}")]
    Overflow { value: u64, inc: u64 },

    #[error("Underflow: value={value}, decrement={dec}")]
    Underflow { value: u64, dec: u64 },
}

There are also the two counter-nats and counter-postgres packages, with a binary crate each, using eventsourced-nats and eventsourced-postgres respectively for the event log.

...
let evt_log = evt_log.clone();
let snapshot_store = snapshot_store.clone();
let counter = Counter::default();
let counter = counter
    .spawn(
        id,
        unsafe { NonZeroUsize::new_unchecked(42) },
        evt_log,
        snapshot_store,
        convert::serde_json::binarizer(),
    )
    .await
    .context("cannot spawn entity")?;

tasks.spawn(async move {
    for n in 0..config.evt_count / 2 {
        if n > 0 && n % 2_500 == 0 {
            println!("{id}: {} events persisted", n * 2);
        }
        counter
            .handle_cmd(Cmd::Inc(n as u64))
            .await
            .context("cannot handle Inc command")
            .unwrap();
        ...
    }
});
...

Take a look at the examples directory for more details.

Running the counter-nats example

For the counter-nats example, nats-server needs to be installed. On macOS just use Homebrew:

brew install nats-server

Before running the example, start the nats-server with the jetstream feature enabled:

nats-server --jetstream

Then use the following command to run the example:

RUST_LOG=info \
    CONFIG_DIR=examples/counter-nats/config \
    cargo run \
    --release \
    --package counter-nats

Notice that you can change the configuration either by changing the defaul.toml file at examples/counter-nats/config or by overriding the configuration settings with environment variables, e.g. APP__COUNTER__EVT_COUNT=42:

RUST_LOG=info \
    APP__COUNTER__EVT_COUNT=42 \
    CONFIG_DIR=examples/counter-nats/config \
    cargo run \
    --release \
    --package counter-nats

Running the counter-postgres example

For the counter-postgres example, PostgreSQL needs to be installed. On macOS just use Homebrew:

brew install postgresql@14

Before running the example, start PostgreSQL:

brew services run postgresql@14

Make sure you know the following connection parameters:

host
port
user
password
dbname

Change the configuration either by changing the default.toml file at examples/counter-postgres/config or by overriding the configuration settings with environment variables, e.g. APP__EVT_LOG__DBNAME=test or APP__COUNTER__EVT_COUNT=42: