arc-es-postgres 0.7.1

Postgres EventStore and ReadModelStore implementation for arc event sourcing
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
//! # Postgres Read Model Store
//!
//! Implementation of [`ReadModelStore`] backed by an [`sqlx::PgPool`]. Mirrors
//! the SQLite store's contract: every projection table has the standard
//! projection shape `(id TEXT PK, version BIGINT, data JSONB)`, and writes are
//! version-gated so replay and at-least-once delivery converge.
//!
//! ## Idempotency
//!
//! [`upsert`](ReadModelStore::upsert) translates to
//!
//! ```sql
//! INSERT INTO {table} (id, version, data) VALUES ($1, $2, $3)
//! ON CONFLICT (id) DO UPDATE
//!    SET version = EXCLUDED.version, data = EXCLUDED.data
//!  WHERE {table}.version < EXCLUDED.version
//! ```
//!
//! Applying an older or equal version never regresses state.
//!
//! ## Queries
//!
//! [`find_by`](ReadModelStore::find_by) uses Postgres' `data ->> $field`
//! text-extraction operator. `IS NOT DISTINCT FROM` gives null-safe equality.
//!
//! ## Identifiers
//!
//! sqlx binds values, not identifiers. Table names are spliced into SQL, so
//! they are validated against `[A-Za-z0-9_]` first ([`check_ident`]). Field
//! names are bound as the `->>` operand and so are parameterized, but are still
//! validated for parity with the SQLite store.

use arc_core::read_model_store::{ReadModelError, ReadModelResult, ReadModelStore, Row, Upsert};
use async_trait::async_trait;
use sqlx::postgres::{PgPool, PgPoolOptions};
use sqlx::Row as _;

/// DDL for the `users_view` projection table. Idempotent.
const USERS_VIEW_SCHEMA: &str = r#"
CREATE TABLE IF NOT EXISTS users_view (
    id      TEXT   NOT NULL PRIMARY KEY,
    version BIGINT NOT NULL,
    data    JSONB  NOT NULL
);
CREATE UNIQUE INDEX IF NOT EXISTS idx_users_view_email
    ON users_view ((data ->> 'email'));
"#;

/// Postgres implementation of [`ReadModelStore`].
#[derive(Clone)]
pub struct PostgresReadModelStore {
    pool: PgPool,
}

impl PostgresReadModelStore {
    /// Build a new store from a database URL, creating a small pool.
    pub async fn new(database_url: &str) -> ReadModelResult<Self> {
        let pool = PgPoolOptions::new()
            .max_connections(10)
            .connect(database_url)
            .await
            .map_err(|e| {
                ReadModelError::other(format!("Failed to build read-model pool: {}", e))
            })?;
        Ok(PostgresReadModelStore { pool })
    }

    /// Build a store from an existing pool. Lets tests share one pool with the
    /// event store against the same database.
    pub fn with_pool(pool: PgPool) -> Self {
        PostgresReadModelStore { pool }
    }

    /// Borrow the underlying pool.
    pub fn pool(&self) -> &PgPool {
        &self.pool
    }

    /// Create the `users_view` projection table and its email index if absent.
    /// Idempotent.
    pub async fn initialize_schema(&self) -> ReadModelResult<()> {
        sqlx::raw_sql(USERS_VIEW_SCHEMA)
            .execute(&self.pool)
            .await
            .map_err(|e| ReadModelError::schema_failed(e.to_string()))?;
        Ok(())
    }
}

/// Validate a table or column name against an allow-list of characters before
/// splicing it into a SQL string. Guards against caller-supplied identifiers
/// carrying anything other than `[A-Za-z0-9_]`.
fn check_ident(label: &str, ident: &str) -> ReadModelResult<()> {
    if ident.is_empty() {
        return Err(ReadModelError::other(format!("{label} cannot be empty")));
    }
    if !ident.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
        return Err(ReadModelError::other(format!(
            "invalid {label} '{ident}': only [A-Za-z0-9_] permitted"
        )));
    }
    Ok(())
}

fn extract_version(row: &Row) -> ReadModelResult<i64> {
    row.get("version").and_then(|v| v.as_i64()).ok_or_else(|| {
        ReadModelError::write_failed(
            "Upsert.row missing required i64 field 'version' for version-gated upsert",
        )
    })
}

/// Map a JSON primitive to the text Postgres' `->>` operator returns for that
/// value, so `find_by` can compare against an extracted field.
fn find_by_text(value: &serde_json::Value) -> ReadModelResult<Option<String>> {
    match value {
        serde_json::Value::Null => Ok(None),
        serde_json::Value::String(s) => Ok(Some(s.clone())),
        serde_json::Value::Number(n) => Ok(Some(n.to_string())),
        serde_json::Value::Bool(b) => Ok(Some(if *b { "true".into() } else { "false".into() })),
        other => Err(ReadModelError::query_failed(format!(
            "find_by only accepts primitive values, got: {other}"
        ))),
    }
}

#[async_trait]
impl ReadModelStore for PostgresReadModelStore {
    async fn upsert(&self, op: Upsert) -> ReadModelResult<()> {
        check_ident("table name", &op.table)?;
        let version = extract_version(&op.row)?;

        let sql = format!(
            "INSERT INTO {table} (id, version, data) VALUES ($1, $2, $3) \
             ON CONFLICT (id) DO UPDATE SET version = EXCLUDED.version, data = EXCLUDED.data \
             WHERE {table}.version < EXCLUDED.version",
            table = op.table
        );

        sqlx::query(&sql)
            .bind(&op.key)
            .bind(version)
            .bind(&op.row)
            .execute(&self.pool)
            .await
            .map_err(|e| ReadModelError::write_failed(e.to_string()))?;
        Ok(())
    }

    async fn delete(&self, table: &str, key: &str) -> ReadModelResult<()> {
        check_ident("table name", table)?;
        sqlx::query(&format!("DELETE FROM {table} WHERE id = $1"))
            .bind(key)
            .execute(&self.pool)
            .await
            .map_err(|e| ReadModelError::write_failed(e.to_string()))?;
        Ok(())
    }

    async fn get(&self, table: &str, key: &str) -> ReadModelResult<Option<Row>> {
        check_ident("table name", table)?;
        let row = sqlx::query(&format!("SELECT data FROM {table} WHERE id = $1 LIMIT 1"))
            .bind(key)
            .fetch_optional(&self.pool)
            .await
            .map_err(|e| ReadModelError::query_failed(e.to_string()))?;

        match row {
            Some(r) => {
                Ok(Some(r.try_get("data").map_err(|e| {
                    ReadModelError::query_failed(e.to_string())
                })?))
            }
            None => Ok(None),
        }
    }

    async fn find_by(
        &self,
        table: &str,
        field: &str,
        value: &serde_json::Value,
    ) -> ReadModelResult<Vec<Row>> {
        check_ident("table name", table)?;
        check_ident("field name", field)?;
        let needle = find_by_text(value)?;

        let rows = sqlx::query(&format!(
            "SELECT data FROM {table} WHERE data ->> $1 IS NOT DISTINCT FROM $2"
        ))
        .bind(field)
        .bind(needle)
        .fetch_all(&self.pool)
        .await
        .map_err(|e| ReadModelError::query_failed(e.to_string()))?;

        rows.iter()
            .map(|r| {
                r.try_get("data")
                    .map_err(|e| ReadModelError::query_failed(e.to_string()))
            })
            .collect()
    }

    async fn list(&self, table: &str) -> ReadModelResult<Vec<Row>> {
        check_ident("table name", table)?;
        let rows = sqlx::query(&format!("SELECT data FROM {table}"))
            .fetch_all(&self.pool)
            .await
            .map_err(|e| ReadModelError::query_failed(e.to_string()))?;

        rows.iter()
            .map(|r| {
                r.try_get("data")
                    .map_err(|e| ReadModelError::query_failed(e.to_string()))
            })
            .collect()
    }

    async fn truncate(&self, table: &str) -> ReadModelResult<()> {
        check_ident("table name", table)?;
        sqlx::query(&format!("DELETE FROM {table}"))
            .execute(&self.pool)
            .await
            .map_err(|e| ReadModelError::schema_failed(e.to_string()))?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn test_check_ident_accepts_plain_name() {
        check_ident("table name", "users_view").unwrap();
    }

    #[test]
    fn test_check_ident_rejects_injection() {
        let err = check_ident("table name", "users; DROP TABLE users").unwrap_err();
        assert!(
            matches!(err, ReadModelError::Other { ref message } if message.contains("table name")),
            "got {err:?}"
        );
    }

    #[test]
    fn test_check_ident_rejects_empty() {
        assert!(check_ident("field name", "").is_err());
    }

    #[test]
    fn test_extract_version_reads_field() {
        let row = json!({ "id": "u1", "version": 7 });
        assert_eq!(extract_version(&row).unwrap(), 7);
    }

    #[test]
    fn test_extract_version_missing_is_error() {
        let row = json!({ "id": "u1" });
        let err = extract_version(&row).unwrap_err();
        assert!(matches!(err, ReadModelError::WriteFailed { .. }));
    }

    #[test]
    fn test_find_by_text_maps_primitives() {
        assert_eq!(find_by_text(&json!("a@b.c")).unwrap(), Some("a@b.c".into()));
        assert_eq!(find_by_text(&json!(42)).unwrap(), Some("42".into()));
        assert_eq!(find_by_text(&json!(true)).unwrap(), Some("true".into()));
        assert_eq!(find_by_text(&json!(null)).unwrap(), None);
    }

    #[test]
    fn test_find_by_text_rejects_composite() {
        assert!(find_by_text(&json!({ "x": 1 })).is_err());
        assert!(find_by_text(&json!([1, 2])).is_err());
    }

    // ── Live-database tests ──────────────────────────────────────────────────
    // Gated behind ARC_POSTGRES_TEST_DATABASE_URL; see lib.rs for usage.

    async fn live_store() -> Option<PostgresReadModelStore> {
        let url = std::env::var("ARC_POSTGRES_TEST_DATABASE_URL").ok()?;
        let store = PostgresReadModelStore::new(&url).await.expect("connect");
        store.initialize_schema().await.expect("schema");
        sqlx::query("DELETE FROM users_view")
            .execute(store.pool())
            .await
            .expect("clear");
        Some(store)
    }

    fn user_row(id: &str, name: &str, email: &str, version: i64) -> Row {
        json!({ "id": id, "name": name, "email": email, "version": version })
    }

    #[tokio::test]
    #[serial_test::serial]
    async fn test_live_upsert_and_get() {
        let Some(store) = live_store().await else {
            return;
        };
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice", "a@b.c", 1),
            ))
            .await
            .unwrap();
        let got = store.get("users_view", "u1").await.unwrap().unwrap();
        assert_eq!(got["name"], "Alice");
        assert_eq!(got["version"], 1);
    }

    #[tokio::test]
    #[serial_test::serial]
    async fn test_live_upsert_version_gate() {
        let Some(store) = live_store().await else {
            return;
        };
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice2", "a@b.c", 2),
            ))
            .await
            .unwrap();
        // Stale write must not regress.
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Stale", "a@b.c", 1),
            ))
            .await
            .unwrap();
        let got = store.get("users_view", "u1").await.unwrap().unwrap();
        assert_eq!(got["name"], "Alice2");
        assert_eq!(got["version"], 2);
    }

    #[tokio::test]
    #[serial_test::serial]
    async fn test_live_find_by_email() {
        let Some(store) = live_store().await else {
            return;
        };
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice", "a@b.c", 1),
            ))
            .await
            .unwrap();
        store
            .upsert(Upsert::new(
                "users_view",
                "u2",
                user_row("u2", "Bob", "b@b.c", 1),
            ))
            .await
            .unwrap();
        let hits = store
            .find_by("users_view", "email", &json!("b@b.c"))
            .await
            .unwrap();
        assert_eq!(hits.len(), 1);
        assert_eq!(hits[0]["id"], "u2");
    }

    #[tokio::test]
    #[serial_test::serial]
    async fn test_live_delete_and_truncate() {
        let Some(store) = live_store().await else {
            return;
        };
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice", "a@b.c", 1),
            ))
            .await
            .unwrap();
        store
            .upsert(Upsert::new(
                "users_view",
                "u2",
                user_row("u2", "Bob", "b@b.c", 1),
            ))
            .await
            .unwrap();
        store.delete("users_view", "u1").await.unwrap();
        assert!(store.get("users_view", "u1").await.unwrap().is_none());
        assert_eq!(store.list("users_view").await.unwrap().len(), 1);
        store.truncate("users_view").await.unwrap();
        assert!(store.list("users_view").await.unwrap().is_empty());
    }
}