cqrs-rust-lib 0.6.0

An opinionated implementation of CQRS/Event Sourcing with pluggable storage backends (InMemory, PostgreSQL, MongoDB)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
use crate::errors::CqrsError;
use crate::es::storage::{EventStoreStorage, EventStream};
use crate::snapshot::Snapshot;
use crate::{Aggregate, EventEnvelope};
use futures::stream;
use serde_json::Value as JsonValue;
use std::fmt::Debug;
use std::sync::Arc;
use tokio_postgres::Client;

fn map_pg_error<E: std::error::Error + Send + Sync + 'static>(e: E) -> CqrsError {
    CqrsError::database_error(e)
}

/// Access to a `tokio_postgres::Client`.
pub trait PgConn: Send + Sync {
    fn client(&self) -> &Client;
}

cqrs_async_trait! {
/// Factory / pool of connections.
pub trait PgPool: Send + Sync + Debug + Clone + 'static {
    type Connection: PgConn + Send + Sync + 'static;
    async fn acquire(&self) -> Result<Self::Connection, CqrsError>;
}
}

/// Wraps a single `Arc<Client>`. NOT safe for concurrent transactions.
#[derive(Debug, Clone)]
pub struct SharedClient(pub Arc<Client>);

impl PgConn for SharedClient {
    fn client(&self) -> &Client {
        &self.0
    }
}

cqrs_async_trait! {
impl PgPool for SharedClient {
    type Connection = SharedClient;
    async fn acquire(&self) -> Result<Self::Connection, CqrsError> {
        Ok(self.clone())
    }
}
}

/// Wraps a connection obtained from a `PgPool`, tracking transaction state.
pub struct PgSession<C: PgConn + 'static> {
    connection: C,
    committed: bool,
}

impl<C: PgConn + 'static> PgSession<C> {
    fn client(&self) -> &Client {
        self.connection.client()
    }
}

impl<C: PgConn + 'static> Drop for PgSession<C> {
    fn drop(&mut self) {
        if !self.committed {
            tracing::warn!("PgSession dropped without commit/rollback");
        }
    }
}

// PgSession is Send+Sync when C is
unsafe impl<C: PgConn + Send + 'static> Send for PgSession<C> {}
unsafe impl<C: PgConn + Sync + 'static> Sync for PgSession<C> {}

#[derive(Clone, Debug)]
pub struct PostgresPersist<A, P = SharedClient>
where
    A: Aggregate,
    P: PgPool,
{
    _phantom: std::marker::PhantomData<A>,
    pool: P,
    snapshot_table_name: String,
    journal_table_name: String,
}

impl<A> PostgresPersist<A, SharedClient>
where
    A: Aggregate,
{
    /// Backward-compatible constructor wrapping a single `Arc<Client>`.
    #[must_use]
    pub fn new(client: Arc<Client>) -> Self {
        Self::from_client(client)
    }

    /// Backward-compatible constructor wrapping a single `Arc<Client>`.
    #[must_use]
    pub fn from_client(client: Arc<Client>) -> Self {
        Self::with_pool(SharedClient(client))
    }
}

impl<A, P> PostgresPersist<A, P>
where
    A: Aggregate,
    P: PgPool,
{
    #[must_use]
    pub fn with_pool(pool: P) -> Self {
        Self {
            _phantom: std::marker::PhantomData,
            pool,
            snapshot_table_name: format!("{}_snapshots", A::TYPE),
            journal_table_name: format!("{}_journal", A::TYPE),
        }
    }

    pub fn snapshot_table_name(&self) -> &str {
        self.snapshot_table_name.as_str()
    }
    pub fn journal_table_name(&self) -> &str {
        self.journal_table_name.as_str()
    }

    /// Returns the DDL statements to create the journal and snapshot tables,
    /// including a `UNIQUE(aggregate_id, version)` constraint on the journal.
    pub fn schema() -> String {
        let snapshot_table = format!("{}_snapshots", A::TYPE);
        let journal_table = format!("{}_journal", A::TYPE);
        format!(
            r#"CREATE TABLE IF NOT EXISTS {snapshot_table} (
    aggregate_id TEXT PRIMARY KEY,
    data JSONB NOT NULL,
    version BIGINT NOT NULL
);
CREATE TABLE IF NOT EXISTS {journal_table} (
    event_id TEXT PRIMARY KEY,
    aggregate_id TEXT NOT NULL,
    version BIGINT NOT NULL,
    payload JSONB NOT NULL,
    metadata JSONB NOT NULL,
    at TIMESTAMPTZ NOT NULL,
    UNIQUE(aggregate_id, version)
);
CREATE INDEX IF NOT EXISTS idx_{journal_table}_agg_ver ON {journal_table}(aggregate_id, version);"#
        )
    }
}

cqrs_async_trait! {
impl<A, P> EventStoreStorage<A> for PostgresPersist<A, P>
where
    A: Aggregate + 'static,
    P: PgPool,
{
    type Session = PgSession<P::Connection>;

    async fn start_session(&self) -> Result<Self::Session, CqrsError> {
        let connection = self.pool.acquire().await?;
        connection
            .client()
            .batch_execute("BEGIN")
            .await
            .map_err(map_pg_error)?;
        Ok(PgSession {
            connection,
            committed: false,
        })
    }

    async fn close_session(&self, mut session: Self::Session) -> Result<(), CqrsError> {
        session
            .client()
            .batch_execute("COMMIT")
            .await
            .map_err(map_pg_error)?;
        session.committed = true;
        Ok(())
    }

    async fn abort_session(&self, mut session: Self::Session) -> Result<(), CqrsError> {
        session
            .client()
            .batch_execute("ROLLBACK")
            .await
            .map_err(map_pg_error)?;
        session.committed = true;
        Ok(())
    }

    async fn fetch_snapshot(&self, aggregate_id: &str) -> Result<Option<Snapshot<A>>, CqrsError> {
        let conn = self.pool.acquire().await?;
        let sql = format!(
            "SELECT data, version FROM {} WHERE aggregate_id = $1",
            self.snapshot_table_name
        );
        let row_opt = conn
            .client()
            .query_opt(&sql, &[&aggregate_id])
            .await
            .map_err(map_pg_error)?;
        if let Some(row) = row_opt {
            let data: JsonValue = row.try_get("data").map_err(map_pg_error)?;
            let version: i64 = row.try_get("version").map_err(map_pg_error)?;
            let state: A = serde_json::from_value(data).map_err(CqrsError::serialization_error)?;
            Ok(Some(Snapshot::<A> {
                aggregate_id: aggregate_id.to_string(),
                state,
                version: version as usize,
            }))
        } else {
            Ok(None)
        }
    }

    async fn fetch_events_from_version(
        &self,
        aggregate_id: &str,
        version: usize,
    ) -> Result<EventStream<A>, CqrsError> {
        let conn = self.pool.acquire().await?;
        let sql = format!(
            "SELECT event_id, aggregate_id, version, payload, metadata, at FROM {} WHERE aggregate_id = $1 AND version > $2 ORDER BY version ASC",
            self.journal_table_name
        );
        let rows = conn
            .client()
            .query(&sql, &[&aggregate_id, &(version as i64)])
            .await
            .map_err(map_pg_error)?;

        let events: Result<Vec<EventEnvelope<A>>, CqrsError> = rows
            .into_iter()
            .map(|row| {
                let payload: JsonValue = row.try_get("payload").map_err(map_pg_error)?;
                let metadata: JsonValue = row.try_get("metadata").map_err(map_pg_error)?;
                Ok(EventEnvelope::<A> {
                    event_id: row.try_get::<_, String>("event_id").map_err(map_pg_error)?,
                    aggregate_id: row
                        .try_get::<_, String>("aggregate_id")
                        .map_err(map_pg_error)?,
                    version: row.try_get::<_, i64>("version").map_err(map_pg_error)? as usize,
                    payload: serde_json::from_value(payload)
                        .map_err(CqrsError::serialization_error)?,
                    metadata: serde_json::from_value(metadata)
                        .map_err(CqrsError::serialization_error)?,
                    at: row.try_get("at").map_err(map_pg_error)?,
                })
            })
            .collect();

        let events = events?;
        Ok(Box::pin(stream::iter(events.into_iter().map(Ok))))
    }

    async fn fetch_all_events(&self, aggregate_id: &str) -> Result<EventStream<A>, CqrsError> {
        let conn = self.pool.acquire().await?;
        let sql = format!(
            "SELECT event_id, aggregate_id, version, payload, metadata, at FROM {} WHERE aggregate_id = $1 ORDER BY version ASC",
            self.journal_table_name
        );
        let rows = conn
            .client()
            .query(&sql, &[&aggregate_id])
            .await
            .map_err(map_pg_error)?;

        let events: Result<Vec<EventEnvelope<A>>, CqrsError> = rows
            .into_iter()
            .map(|row| {
                let payload: JsonValue = row.try_get("payload").map_err(map_pg_error)?;
                let metadata: JsonValue = row.try_get("metadata").map_err(map_pg_error)?;
                Ok(EventEnvelope::<A> {
                    event_id: row.try_get::<_, String>("event_id").map_err(map_pg_error)?,
                    aggregate_id: row
                        .try_get::<_, String>("aggregate_id")
                        .map_err(map_pg_error)?,
                    version: row.try_get::<_, i64>("version").map_err(map_pg_error)? as usize,
                    payload: serde_json::from_value(payload)
                        .map_err(CqrsError::serialization_error)?,
                    metadata: serde_json::from_value(metadata)
                        .map_err(CqrsError::serialization_error)?,
                    at: row.try_get("at").map_err(map_pg_error)?,
                })
            })
            .collect();

        let events = events?;
        Ok(Box::pin(stream::iter(events.into_iter().map(Ok))))
    }

    async fn fetch_events_paged(
        &self,
        aggregate_id: &str,
        page: usize,
        page_size: usize,
    ) -> Result<(Vec<EventEnvelope<A>>, i64), CqrsError> {
        let conn = self.pool.acquire().await?;
        // Get total count
        let count_sql = format!(
            "SELECT COUNT(*) FROM {} WHERE aggregate_id = $1",
            self.journal_table_name
        );
        let count_row = conn
            .client()
            .query_one(&count_sql, &[&aggregate_id])
            .await
            .map_err(map_pg_error)?;
        let total: i64 = count_row.try_get(0).map_err(map_pg_error)?;

        // Get paginated events
        let offset = ((page.max(1) - 1) * page_size) as i64;
        let sql = format!(
            "SELECT event_id, aggregate_id, version, payload, metadata, at FROM {} WHERE aggregate_id = $1 ORDER BY version ASC LIMIT $2 OFFSET $3",
            self.journal_table_name
        );
        let rows = conn
            .client()
            .query(&sql, &[&aggregate_id, &(page_size as i64), &offset])
            .await
            .map_err(map_pg_error)?;

        let events: Result<Vec<EventEnvelope<A>>, CqrsError> = rows
            .into_iter()
            .map(|row| {
                let payload: JsonValue = row.try_get("payload").map_err(map_pg_error)?;
                let metadata: JsonValue = row.try_get("metadata").map_err(map_pg_error)?;
                Ok(EventEnvelope::<A> {
                    event_id: row.try_get::<_, String>("event_id").map_err(map_pg_error)?,
                    aggregate_id: row
                        .try_get::<_, String>("aggregate_id")
                        .map_err(map_pg_error)?,
                    version: row.try_get::<_, i64>("version").map_err(map_pg_error)? as usize,
                    payload: serde_json::from_value(payload)
                        .map_err(CqrsError::serialization_error)?,
                    metadata: serde_json::from_value(metadata)
                        .map_err(CqrsError::serialization_error)?,
                    at: row.try_get("at").map_err(map_pg_error)?,
                })
            })
            .collect();

        let events = events?;
        Ok((events, total))
    }

    async fn fetch_latest_event(
        &self,
        aggregate: &A,
        session: &Self::Session,
    ) -> Result<Option<EventEnvelope<A>>, CqrsError> {
        let sql = format!(
            "SELECT event_id, aggregate_id, version, payload, metadata, at FROM {} WHERE aggregate_id = $1 ORDER BY version DESC LIMIT 1 FOR UPDATE",
            self.journal_table_name
        );
        let row_opt = session
            .client()
            .query_opt(&sql, &[&aggregate.aggregate_id()])
            .await
            .map_err(map_pg_error)?;
        if let Some(row) = row_opt {
            let payload: JsonValue = row.try_get("payload").map_err(map_pg_error)?;
            let metadata: JsonValue = row.try_get("metadata").map_err(map_pg_error)?;
            Ok(Some(EventEnvelope::<A> {
                event_id: row.try_get::<_, String>("event_id").map_err(map_pg_error)?,
                aggregate_id: row
                    .try_get::<_, String>("aggregate_id")
                    .map_err(map_pg_error)?,
                version: row.try_get::<_, i64>("version").map_err(map_pg_error)? as usize,
                payload: serde_json::from_value(payload).map_err(CqrsError::serialization_error)?,
                metadata: serde_json::from_value(metadata)
                    .map_err(CqrsError::serialization_error)?,
                at: row.try_get("at").map_err(map_pg_error)?,
            }))
        } else {
            Ok(None)
        }
    }

    async fn save_events(
        &self,
        events: Vec<EventEnvelope<A>>,
        session: &mut Self::Session,
    ) -> Result<(), CqrsError> {
        if events.is_empty() {
            return Ok(());
        }
        let sql = format!(
            "INSERT INTO {} (event_id, aggregate_id, version, payload, metadata, at) VALUES ($1,$2,$3,$4,$5,$6)",
            self.journal_table_name
        );
        for e in events.iter() {
            let payload =
                serde_json::to_value(&e.payload).map_err(CqrsError::serialization_error)?;
            let metadata =
                serde_json::to_value(&e.metadata).map_err(CqrsError::serialization_error)?;
            session
                .client()
                .execute(
                    &sql,
                    &[
                        &e.event_id,
                        &e.aggregate_id,
                        &(e.version as i64),
                        &payload,
                        &metadata,
                        &e.at,
                    ],
                )
                .await
                .map_err(map_pg_error)?;
        }
        Ok(())
    }

    async fn save_snapshot(
        &self,
        aggregate: &A,
        version: usize,
        session: &mut Self::Session,
    ) -> Result<(), CqrsError> {
        let data = serde_json::to_value(aggregate).map_err(CqrsError::serialization_error)?;
        let sql = format!(
            "INSERT INTO {} (aggregate_id, data, version) VALUES ($1, $2, $3) \
             ON CONFLICT (aggregate_id) DO UPDATE SET data = EXCLUDED.data, version = EXCLUDED.version",
            self.snapshot_table_name
        );
        session
            .client()
            .execute(&sql, &[&aggregate.aggregate_id(), &data, &(version as i64)])
            .await
            .map_err(map_pg_error)?;
        Ok(())
    }
}
}