arc-es-sqlite 0.7.1

SQLite EventStore 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
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
//! # SQLite Read Model Store
//!
//! Production-grade implementation of [`ReadModelStore`] backed by an
//! `r2d2`-pooled SQLite connection. Each projection table follows the
//! framework's standard projection shape: `(id TEXT PK, version BIGINT,
//! data TEXT)`. The `data` column holds the full row as JSON, so this store
//! can serve any projector without compile-time knowledge of the
//! domain-specific columns.
//!
//! ## Idempotency
//!
//! [`upsert`](ReadModelStore::upsert) translates to
//!
//! ```sql
//! INSERT INTO {table} (id, version, data) VALUES (?, ?, ?)
//! ON CONFLICT(id) DO UPDATE
//!    SET version = excluded.version, data = excluded.data
//!  WHERE {table}.version < excluded.version
//! ```
//!
//! That gate makes replay-from-zero deterministic and tolerates at-least-once
//! delivery: applying an older event twice, or out-of-order, never regresses
//! state.
//!
//! ## Queries
//!
//! [`find_by`](ReadModelStore::find_by) uses `json_extract(data, '$.{field}')`
//! to reach into the blob. Columns commonly queried (e.g. `email`) get
//! expression indexes in the migration that creates the table.
//!
//! ## Boundaries
//!
//! The store does **not** create tables — DDL lives in `migrations/`. That
//! keeps the production write path away from connection-time mutations and
//! lets `diesel migration run` control schema evolution.

use arc_core::read_model_store::{ReadModelError, ReadModelResult, ReadModelStore, Row, Upsert};
use async_trait::async_trait;
use diesel::prelude::*;
use diesel::r2d2::{self, ConnectionManager};
use diesel::sql_types::{BigInt, Nullable, Text};
use diesel::sqlite::SqliteConnection;
use std::sync::Arc;

type Pool = r2d2::Pool<ConnectionManager<SqliteConnection>>;

/// SQLite implementation of [`ReadModelStore`].
#[derive(Clone)]
pub struct SqliteReadModelStore {
    pool: Arc<Pool>,
}

impl SqliteReadModelStore {
    /// Build a new store from a database URL. Creates a small r2d2 pool.
    pub async fn new(database_url: &str) -> ReadModelResult<Self> {
        let manager = ConnectionManager::<SqliteConnection>::new(database_url);
        let pool = Pool::builder().max_size(10).build(manager).map_err(|e| {
            ReadModelError::other(format!("Failed to build read-model pool: {}", e))
        })?;
        Ok(SqliteReadModelStore {
            pool: Arc::new(pool),
        })
    }

    /// Build a store from an existing pool. Used in tests so we can share a
    /// single in-memory database with the event store.
    pub fn with_pool(pool: Pool) -> Self {
        Self {
            pool: Arc::new(pool),
        }
    }
}

#[derive(QueryableByName, Debug)]
struct DataRow {
    #[diesel(sql_type = Text)]
    data: String,
}

/// Validate a table or column name against an allow-list of characters before
/// splicing it into a SQL string. Diesel's `sql_query` does not bind
/// identifiers, only values. This guards against caller-supplied identifiers
/// reaching SQL with anything other than `[A-Za-z0-9_]` — same posture as
/// every other SQL library that accepts dynamic table names.
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",
        )
    })
}

fn parse_data_row(raw: &str) -> ReadModelResult<Row> {
    serde_json::from_str(raw).map_err(|e| {
        ReadModelError::query_failed(format!("Failed to parse projection row JSON: {e}"))
    })
}

#[async_trait]
impl ReadModelStore for SqliteReadModelStore {
    async fn upsert(&self, op: Upsert) -> ReadModelResult<()> {
        check_ident("table name", &op.table)?;
        let version = extract_version(&op.row)?;
        let data = serde_json::to_string(&op.row)
            .map_err(|e| ReadModelError::write_failed(format!("Failed to serialize row: {e}")))?;
        let pool = self.pool.clone();
        let table = op.table.clone();
        let key = op.key.clone();

        tokio::task::spawn_blocking(move || -> ReadModelResult<()> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::write_failed(format!("Failed to get connection: {e}"))
            })?;

            let sql = format!(
                "INSERT INTO {table} (id, version, data) VALUES (?, ?, ?) \
                 ON CONFLICT(id) DO UPDATE SET version = excluded.version, data = excluded.data \
                 WHERE {table}.version < excluded.version"
            );

            diesel::sql_query(sql)
                .bind::<Text, _>(key)
                .bind::<BigInt, _>(version)
                .bind::<Text, _>(data)
                .execute(&mut *conn)
                .map_err(|e| ReadModelError::write_failed(e.to_string()))?;
            Ok(())
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))?
    }

    async fn delete(&self, table: &str, key: &str) -> ReadModelResult<()> {
        check_ident("table name", table)?;
        let pool = self.pool.clone();
        let table = table.to_string();
        let key = key.to_string();

        tokio::task::spawn_blocking(move || -> ReadModelResult<()> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::write_failed(format!("Failed to get connection: {e}"))
            })?;
            diesel::sql_query(format!("DELETE FROM {table} WHERE id = ?"))
                .bind::<Text, _>(key)
                .execute(&mut *conn)
                .map_err(|e| ReadModelError::write_failed(e.to_string()))?;
            Ok(())
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))?
    }

    async fn get(&self, table: &str, key: &str) -> ReadModelResult<Option<Row>> {
        check_ident("table name", table)?;
        let pool = self.pool.clone();
        let table = table.to_string();
        let key = key.to_string();

        let raw = tokio::task::spawn_blocking(move || -> ReadModelResult<Option<String>> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::query_failed(format!("Failed to get connection: {e}"))
            })?;
            let rows: Vec<DataRow> =
                diesel::sql_query(format!("SELECT data FROM {table} WHERE id = ? LIMIT 1"))
                    .bind::<Text, _>(key)
                    .load(&mut *conn)
                    .map_err(|e| ReadModelError::query_failed(e.to_string()))?;
            Ok(rows.into_iter().next().map(|r| r.data))
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))??;

        match raw {
            Some(s) => Ok(Some(parse_data_row(&s)?)),
            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 pool = self.pool.clone();
        let table = table.to_string();
        let path = format!("$.{field}");

        // We only support primitive comparisons here. Anything else is a
        // caller bug, not a runtime exception worth tolerating.
        let bind_text: Option<String> = match value {
            serde_json::Value::Null => None,
            serde_json::Value::String(s) => Some(s.clone()),
            serde_json::Value::Number(n) => Some(n.to_string()),
            serde_json::Value::Bool(b) => Some(if *b { "1".into() } else { "0".into() }),
            other => {
                return Err(ReadModelError::query_failed(format!(
                    "find_by only accepts primitive values, got: {other}"
                )))
            }
        };

        let rows = tokio::task::spawn_blocking(move || -> ReadModelResult<Vec<String>> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::query_failed(format!("Failed to get connection: {e}"))
            })?;
            let sql = format!("SELECT data FROM {table} WHERE json_extract(data, ?) IS ?");
            let rows: Vec<DataRow> = diesel::sql_query(sql)
                .bind::<Text, _>(path)
                .bind::<Nullable<Text>, _>(bind_text)
                .load(&mut *conn)
                .map_err(|e| ReadModelError::query_failed(e.to_string()))?;
            Ok(rows.into_iter().map(|r| r.data).collect())
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))??;

        rows.iter().map(|r| parse_data_row(r)).collect()
    }

    async fn list(&self, table: &str) -> ReadModelResult<Vec<Row>> {
        check_ident("table name", table)?;
        let pool = self.pool.clone();
        let table = table.to_string();

        let rows = tokio::task::spawn_blocking(move || -> ReadModelResult<Vec<String>> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::query_failed(format!("Failed to get connection: {e}"))
            })?;
            let rows: Vec<DataRow> = diesel::sql_query(format!("SELECT data FROM {table}"))
                .load(&mut *conn)
                .map_err(|e| ReadModelError::query_failed(e.to_string()))?;
            Ok(rows.into_iter().map(|r| r.data).collect())
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))??;

        rows.iter().map(|r| parse_data_row(r)).collect()
    }

    async fn truncate(&self, table: &str) -> ReadModelResult<()> {
        check_ident("table name", table)?;
        let pool = self.pool.clone();
        let table = table.to_string();

        tokio::task::spawn_blocking(move || -> ReadModelResult<()> {
            let mut conn = pool.get().map_err(|e| {
                ReadModelError::schema_failed(format!("Failed to get connection: {e}"))
            })?;
            diesel::sql_query(format!("DELETE FROM {table}"))
                .execute(&mut *conn)
                .map_err(|e| ReadModelError::schema_failed(e.to_string()))?;
            Ok(())
        })
        .await
        .map_err(|e| ReadModelError::other(format!("Task join error: {e}")))?
    }
}

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

    async fn setup() -> SqliteReadModelStore {
        let manager = ConnectionManager::<SqliteConnection>::new(":memory:");
        let pool = Pool::builder().max_size(1).build(manager).expect("pool");
        let mut conn = pool.get().expect("conn");
        crate::test_support::migrate(&mut conn);
        drop(conn);
        SqliteReadModelStore::with_pool(pool)
    }

    fn user_row(id: &str, name: &str, email: &str, version: i64) -> Row {
        json!({
            "id": id,
            "name": name,
            "email": email,
            "password_hash": "$argon2id$v=19$m=19456,t=2,p=1$x$y",
            "version": version,
        })
    }

    #[tokio::test]
    async fn test_upsert_inserts_then_reads() {
        let store = setup().await;
        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]
    async fn test_upsert_advances_on_higher_version() {
        let store = setup().await;
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice", "a@b.c", 1),
            ))
            .await
            .unwrap();
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice2", "a@b.c", 2),
            ))
            .await
            .unwrap();

        let got = store.get("users_view", "u1").await.unwrap().unwrap();
        assert_eq!(got["name"], "Alice2");
        assert_eq!(got["version"], 2);
    }

    #[tokio::test]
    async fn test_upsert_idempotent_on_lower_or_equal_version() {
        // Replay must not regress newer state.
        let store = setup().await;
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice2", "a@b.c", 2),
            ))
            .await
            .unwrap();

        // Same version: SQLite ON CONFLICT WHERE clause filters this out.
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Should not stick", "a@b.c", 2),
            ))
            .await
            .unwrap();
        // Lower version: same.
        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]
    async fn test_find_by_email_uses_index() {
        let store = setup().await;
        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]
    async fn test_delete_and_truncate() {
        let store = setup().await;
        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());
    }

    #[tokio::test]
    async fn test_email_unique_constraint_rejects_collision() {
        // Pinned: the migration's UNIQUE INDEX on json_extract(data,'$.email')
        // protects login-by-email from ambiguity. Two rows with the same email
        // must not coexist.
        let store = setup().await;
        store
            .upsert(Upsert::new(
                "users_view",
                "u1",
                user_row("u1", "Alice", "x@y.z", 1),
            ))
            .await
            .unwrap();
        let err = store
            .upsert(Upsert::new(
                "users_view",
                "u2",
                user_row("u2", "Bob", "x@y.z", 1),
            ))
            .await
            .unwrap_err();
        assert!(
            matches!(err, ReadModelError::WriteFailed { ref message } if message.contains("UNIQUE")),
            "expected UNIQUE constraint violation, got {err:?}"
        );
    }

    #[tokio::test]
    async fn test_table_name_validation_rejects_injection() {
        let store = setup().await;
        let err = store
            .get("users_view; DROP TABLE users_view", "u1")
            .await
            .unwrap_err();
        assert!(
            matches!(err, ReadModelError::Other { ref message } if message.contains("table name")),
            "expected identifier rejection, got {err:?}"
        );
    }
}