udb 0.4.25

Universal Data Broker — a Rust gRPC broker over multiple databases (Postgres, MySQL, SQLite, MongoDB, ClickHouse, Cassandra, MSSQL, Redis, Qdrant, S3, Neo4j, …) with per-tenant RLS, 2PC, sagas, and CDC.
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
//! ClickHouse implementation of [`SagaStore`] (B.10c PHASE 2).
//!
//! Semantics mirror the Postgres impl (`postgres_saga.rs`) exactly so the
//! cross-backend conformance contract passes byte-for-byte. ClickHouse has no
//! transactions / row locks / native CAS, so mutable saga state lives in a
//! `ReplacingMergeTree(version) ORDER BY saga_id`: every mutation INSERTs a NEW
//! row carrying `version + 1`, and EVERY read uses `SELECT … FINAL` so the
//! engine collapses superseded rows by `saga_id` and only the highest-`version`
//! row is observed. A raw (non-`FINAL`) read would leak stale, superseded rows
//! and break correctness.
//!
//! The recovery-attempts counter and the claim/stale flips are the versioned
//! read-insert-reread emulation (read FINAL → INSERT version+1 → re-read FINAL)
//! under a KeeperMap-backed saga mutation lease, so monotone counters and stale
//! flips are serialized across broker processes.
//!
//! ## Schema (mirrors the logical PG `udb_sagas`; ClickHouse types)
//!
//! - `udb_sagas` — `saga_id String` (uuid as text) keyed ReplacingMergeTree;
//!   status / compensation_status as their EXACT PG canonical strings, `steps` /
//!   `compensations` as JSON `String`, timestamps as epoch-millis `Int64`.

use std::time::Duration;

use async_trait::async_trait;
use chrono::{DateTime, Utc};
use serde_json::Value as Json;

use super::clickhouse::{ClickHouseCanonicalStore, sql_lit};
use super::clickhouse_projection::{
    ch_dt, ch_err, ch_i32, ch_i64, ch_json, ch_str, ch_u64, ch_uuid,
};
use super::system_store::{
    CompensationStatus, SagaInsert, SagaListFilter, SagaRow, SagaStatus, SagaStore, SagaSummary,
    SystemStoreError, SystemStoreResult,
};
use uuid::Uuid;

const CLICKHOUSE_SAGA_MUTATION_LOCK: &str = "__udb_clickhouse_sagas";

/// Canonical saga SELECT column order. Pinned next to the mapper.
const SAGA_COLS: &str = "saga_id, tx_id, tenant_id, correlation_id, status, backend_instance, \
     operation, current_step, retry_count, recovery_attempts, compensation_status, \
     steps, compensations, last_error, created_at, updated_at";

fn row_to_saga(row: &Json) -> SystemStoreResult<SagaRow> {
    let saga_id = ch_uuid(row, "saga_id")?;
    let status_str = ch_str(row, "status");
    let status = SagaStatus::parse(&status_str).ok_or_else(|| {
        SystemStoreError::InvalidInput(format!(
            "unknown saga status '{status_str}' in clickhouse row"
        ))
    })?;
    let comp_status_str = ch_str(row, "compensation_status");
    let compensation_status = CompensationStatus::parse(&comp_status_str).ok_or_else(|| {
        SystemStoreError::InvalidInput(format!(
            "unknown compensation_status '{comp_status_str}' in clickhouse row"
        ))
    })?;
    Ok(SagaRow {
        saga_id,
        tx_id: ch_str(row, "tx_id"),
        tenant_id: ch_str(row, "tenant_id"),
        correlation_id: ch_str(row, "correlation_id"),
        status,
        backend_instance: ch_str(row, "backend_instance"),
        operation: ch_str(row, "operation"),
        current_step: ch_i32(row, "current_step"),
        retry_count: ch_i32(row, "retry_count"),
        recovery_attempts: ch_i32(row, "recovery_attempts"),
        compensation_status,
        steps: ch_json(row, "steps", Json::Array(vec![])),
        compensations: ch_json(row, "compensations", Json::Array(vec![])),
        last_error: ch_str(row, "last_error"),
        created_at: ch_dt(row, "created_at"),
        updated_at: ch_dt(row, "updated_at"),
    })
}

impl ClickHouseCanonicalStore {
    fn saga_table(&self) -> SystemStoreResult<String> {
        self.qualified("udb_sagas")
            .map_err(|e| ch_err("saga_table", e))
    }

    /// Read one saga's FINAL row + its version. `FINAL` collapses superseded
    /// ReplacingMergeTree parts so only the highest version is observed.
    async fn read_saga_versioned(
        &self,
        saga_id: Uuid,
    ) -> SystemStoreResult<Option<(SagaRow, u64)>> {
        let tbl = self.saga_table()?;
        let sql = format!(
            "SELECT {SAGA_COLS}, version FROM {tbl} FINAL WHERE saga_id = {id}",
            id = sql_lit(&saga_id.to_string()),
        );
        let rows = self
            .executor()
            .select_rows(&sql)
            .await
            .map_err(|e| ch_err("read_saga", e))?;
        match rows.first() {
            Some(r) => Ok(Some((row_to_saga(r)?, ch_u64(r, "version")))),
            None => Ok(None),
        }
    }

    /// INSERT a full saga row at `version`. Every mutation supersedes the prior
    /// version once FINAL/merge runs.
    async fn insert_saga_version(&self, saga: &SagaRow, version: u64) -> SystemStoreResult<()> {
        let tbl = self.saga_table()?;
        let sql = format!(
            "INSERT INTO {tbl} ({SAGA_COLS}, version) VALUES (\
             {saga_id}, {tx}, {tenant}, {corr}, {status}, {backend}, {operation}, \
             {step}, {retry}, {recovery}, {comp}, {steps}, {comps}, {error}, \
             {created}, {updated}, {version})",
            saga_id = sql_lit(&saga.saga_id.to_string()),
            tx = sql_lit(&saga.tx_id),
            tenant = sql_lit(&saga.tenant_id),
            corr = sql_lit(&saga.correlation_id),
            status = sql_lit(saga.status.as_str()),
            backend = sql_lit(&saga.backend_instance),
            operation = sql_lit(&saga.operation),
            step = saga.current_step,
            retry = saga.retry_count,
            recovery = saga.recovery_attempts,
            comp = sql_lit(saga.compensation_status.as_str()),
            steps = sql_lit(&saga.steps.to_string()),
            comps = sql_lit(&saga.compensations.to_string()),
            error = sql_lit(&saga.last_error),
            created = saga.created_at.timestamp_millis(),
            updated = saga.updated_at.timestamp_millis(),
        );
        self.executor()
            .execute_ddl(&sql)
            .await
            .map_err(|e| ch_err("insert_saga_version", e))
    }

    async fn acquire_saga_mutation_lock(&self, op: &str) -> SystemStoreResult<String> {
        let owner = format!("{op}:{}", Uuid::new_v4());
        self.acquire_system_mutation_lease(CLICKHOUSE_SAGA_MUTATION_LOCK, &owner, op)
            .await
            .map_err(|err| ch_err(op, err))?;
        Ok(owner)
    }

    async fn release_saga_mutation_lock(&self, owner: &str, op: &str) -> SystemStoreResult<()> {
        self.release_system_mutation_lease(CLICKHOUSE_SAGA_MUTATION_LOCK, owner, op)
            .await
            .map_err(|err| ch_err(op, err))
    }
}

#[async_trait]
impl SagaStore for ClickHouseCanonicalStore {
    fn backend_label(&self) -> &'static str {
        "clickhouse"
    }

    async fn ensure_saga_tables(&self) -> SystemStoreResult<()> {
        let tbl = self.saga_table()?;
        let ddl = format!(
            "CREATE TABLE IF NOT EXISTS {tbl} (\
             saga_id String, \
             tx_id String, \
             tenant_id String, \
             correlation_id String, \
             status String, \
             backend_instance String, \
             operation String, \
             current_step Int32, \
             retry_count Int32, \
             recovery_attempts Int32, \
             compensation_status String, \
             steps String, \
             compensations String, \
             last_error String, \
             created_at Int64, \
             updated_at Int64, \
             version UInt64\
             ) ENGINE = ReplacingMergeTree(version) ORDER BY saga_id"
        );
        self.executor()
            .execute_ddl(&ddl)
            .await
            .map_err(|e| ch_err("ensure_saga_tables", e))?;
        Ok(())
    }

    async fn record_saga(&self, saga: &SagaInsert) -> SystemStoreResult<Uuid> {
        let owner = self.acquire_saga_mutation_lock("record_saga").await?;
        let result = async {
            let saga_id = Uuid::new_v4();
            let now = Self::now_unix_ms();
            let now_dt = DateTime::<Utc>::from_timestamp_millis(now).unwrap_or_else(Utc::now);
            // Fresh saga: version 1, current_step / retry_count / recovery_attempts 0,
            // compensation_status none.
            let row = SagaRow {
                saga_id,
                tx_id: saga.tx_id.clone(),
                tenant_id: saga.tenant_id.clone(),
                correlation_id: saga.correlation_id.clone(),
                status: saga.status,
                backend_instance: saga.backend_instance.clone(),
                operation: saga.operation.clone(),
                current_step: 0,
                retry_count: 0,
                recovery_attempts: 0,
                compensation_status: CompensationStatus::None,
                steps: saga.steps.clone(),
                compensations: saga.compensations.clone(),
                last_error: String::new(),
                created_at: now_dt,
                updated_at: now_dt,
            };
            self.insert_saga_version(&row, 1).await?;
            Ok(saga_id)
        }
        .await;
        self.release_saga_mutation_lock(&owner, "record_saga")
            .await?;
        result
    }

    async fn get_saga(&self, saga_id: Uuid) -> SystemStoreResult<Option<SagaRow>> {
        Ok(self.read_saga_versioned(saga_id).await?.map(|(row, _)| row))
    }

    async fn list_sagas(&self, filter: &SagaListFilter) -> SystemStoreResult<Vec<SagaRow>> {
        let tbl = self.saga_table()?;
        // FINAL scan + Rust filter / DESC sort / page (mirrors PG's
        // `WHERE … ORDER BY updated_at DESC LIMIT/OFFSET`). FINAL collapses
        // superseded versions so each saga is listed once at its latest state.
        let scan = format!("SELECT {SAGA_COLS}, version FROM {tbl} FINAL");
        let rows = self
            .executor()
            .select_rows(&scan)
            .await
            .map_err(|e| ch_err("list_sagas scan", e))?;
        let mut sagas: Vec<SagaRow> = Vec::new();
        for row in &rows {
            let saga = row_to_saga(row)?;
            if let Some(t) = &filter.tenant_id {
                if &saga.tenant_id != t {
                    continue;
                }
            }
            if let Some(s) = filter.status {
                if saga.status != s {
                    continue;
                }
            }
            if let Some(t) = &filter.tx_id {
                if &saga.tx_id != t {
                    continue;
                }
            }
            if let Some(c) = &filter.correlation_id {
                if &saga.correlation_id != c {
                    continue;
                }
            }
            sagas.push(saga);
        }
        sagas.sort_by(|a, b| b.updated_at.cmp(&a.updated_at));
        let limit = if filter.limit <= 0 { 100 } else { filter.limit } as usize;
        let offset = filter.offset.max(0) as usize;
        Ok(sagas.into_iter().skip(offset).take(limit).collect())
    }

    async fn update_saga_status(
        &self,
        saga_id: Uuid,
        status: SagaStatus,
        compensation_status: CompensationStatus,
    ) -> SystemStoreResult<()> {
        let owner = self
            .acquire_saga_mutation_lock("update_saga_status")
            .await?;
        let result = async {
            // Read FINAL, INSERT version+1 with the new status. A missing saga is an
            // error (PG returns rows_affected == 0 → InvalidInput).
            let Some((mut saga, version)) = self.read_saga_versioned(saga_id).await? else {
                return Err(SystemStoreError::InvalidInput(format!(
                    "saga {saga_id} not found for update_saga_status"
                )));
            };
            saga.status = status;
            saga.compensation_status = compensation_status;
            saga.updated_at = DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms())
                .unwrap_or_else(Utc::now);
            self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                .await
        }
        .await;
        self.release_saga_mutation_lock(&owner, "update_saga_status")
            .await?;
        result
    }

    async fn mark_saga_manual_review(&self, saga_id: Uuid) -> SystemStoreResult<()> {
        let owner = self
            .acquire_saga_mutation_lock("mark_saga_manual_review")
            .await?;
        let result = async {
            let Some((mut saga, version)) = self.read_saga_versioned(saga_id).await? else {
                return Err(SystemStoreError::InvalidInput(format!(
                    "saga {saga_id} not found"
                )));
            };
            saga.status = SagaStatus::ManualReview;
            saga.updated_at = DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms())
                .unwrap_or_else(Utc::now);
            self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                .await
        }
        .await;
        self.release_saga_mutation_lock(&owner, "mark_saga_manual_review")
            .await?;
        result
    }

    async fn request_saga_recompensation(&self, saga_id: Uuid) -> SystemStoreResult<()> {
        let owner = self
            .acquire_saga_mutation_lock("request_saga_recompensation")
            .await?;
        let result = async {
            // PG: conditional update WHERE status IN ('failed_compensation',
            // 'manual_review'), bumping retry_count and resetting to indeterminate.
            // The KeeperMap mutation lease serializes read FINAL → validate guard →
            // INSERT version+1 across broker processes.
            let Some((mut saga, version)) = self.read_saga_versioned(saga_id).await? else {
                return Err(SystemStoreError::InvalidInput(format!(
                    "saga {saga_id} is not in a retryable state (must be failed_compensation or manual_review)"
                )));
            };
            if !matches!(
                saga.status,
                SagaStatus::FailedCompensation | SagaStatus::ManualReview
            ) {
                return Err(SystemStoreError::InvalidInput(format!(
                    "saga {saga_id} is not in a retryable state (must be failed_compensation or manual_review)"
                )));
            }
            saga.status = SagaStatus::Indeterminate;
            saga.last_error = String::new();
            saga.retry_count += 1;
            saga.compensation_status = CompensationStatus::RetryRequested;
            saga.updated_at =
                DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms()).unwrap_or_else(Utc::now);
            self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                .await
        }
        .await;
        self.release_saga_mutation_lock(&owner, "request_saga_recompensation")
            .await?;
        result
    }

    async fn increment_recovery_attempts(
        &self,
        saga_id: Uuid,
        error: &str,
    ) -> SystemStoreResult<i64> {
        let owner = self
            .acquire_saga_mutation_lock("increment_recovery_attempts")
            .await?;
        let result = async {
            // PG: `recovery_attempts = recovery_attempts + 1 … RETURNING`. The
            // KeeperMap mutation lease serializes read FINAL → INSERT version+1 with
            // count+1, preserving the monotone-counter contract across processes.
            let Some((mut saga, version)) = self.read_saga_versioned(saga_id).await? else {
                return Err(SystemStoreError::InvalidInput(format!(
                    "saga {saga_id} not found for increment_recovery_attempts"
                )));
            };
            let next = saga.recovery_attempts + 1;
            saga.recovery_attempts = next;
            saga.last_error = error.to_string();
            saga.updated_at = DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms())
                .unwrap_or_else(Utc::now);
            self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                .await?;
            Ok(next as i64)
        }
        .await;
        self.release_saga_mutation_lock(&owner, "increment_recovery_attempts")
            .await?;
        result
    }

    async fn claim_recoverable_sagas(
        &self,
        stale_after: Duration,
        limit: i64,
    ) -> SystemStoreResult<Vec<SagaRow>> {
        let owner = self
            .acquire_saga_mutation_lock("claim_recoverable_sagas")
            .await?;
        let result = async {
            let tbl = self.saga_table()?;
            // FINAL scan for recoverable candidates: indeterminate / in_doubt always,
            // plus stale in_progress (updated_at older than the cutoff). Like Neo4j,
            // the indeterminate/in_doubt rows are READ as-is (the contract asserts an
            // indeterminate saga stays indeterminate); only stale in_progress rows are
            // flipped to indeterminate under the KeeperMap mutation lease.
            let scan = format!("SELECT {SAGA_COLS}, version FROM {tbl} FINAL");
            let rows = self
                .executor()
                .select_rows(&scan)
                .await
                .map_err(|e| ch_err("claim_recoverable_sagas scan", e))?;
            let cutoff = Utc::now()
                - chrono::Duration::from_std(stale_after)
                    .unwrap_or_else(|_| chrono::Duration::zero());
            let mut candidates: Vec<(SagaRow, u64)> = Vec::new();
            for row in &rows {
                let saga = row_to_saga(row)?;
                let recoverable =
                    matches!(saga.status, SagaStatus::Indeterminate | SagaStatus::InDoubt)
                        || (saga.status == SagaStatus::InProgress && saga.updated_at < cutoff);
                if recoverable {
                    candidates.push((saga, ch_u64(row, "version")));
                }
            }
            candidates.sort_by_key(|(s, _)| s.updated_at);
            candidates.truncate(limit.max(1) as usize);

            let mut out = Vec::with_capacity(candidates.len());
            for (mut saga, version) in candidates {
                if saga.status == SagaStatus::InProgress {
                    let now_dt = DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms())
                        .unwrap_or_else(Utc::now);
                    saga.status = SagaStatus::Indeterminate;
                    saga.last_error = "stale in-progress reconciled at recovery claim".to_string();
                    saga.updated_at = now_dt;
                    self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                        .await?;
                }
                out.push(saga);
            }
            Ok(out)
        }
        .await;
        self.release_saga_mutation_lock(&owner, "claim_recoverable_sagas")
            .await?;
        result
    }

    async fn mark_stale_in_progress_indeterminate(
        &self,
        stale_after: Duration,
    ) -> SystemStoreResult<i64> {
        let owner = self
            .acquire_saga_mutation_lock("mark_stale_in_progress_indeterminate")
            .await?;
        let result = async {
            let tbl = self.saga_table()?;
            let scan = format!("SELECT {SAGA_COLS}, version FROM {tbl} FINAL");
            let rows = self
                .executor()
                .select_rows(&scan)
                .await
                .map_err(|e| ch_err("mark_stale_in_progress_indeterminate scan", e))?;
            let cutoff = Utc::now()
                - chrono::Duration::from_std(stale_after)
                    .unwrap_or_else(|_| chrono::Duration::zero());
            let mut n = 0i64;
            for row in &rows {
                let mut saga = row_to_saga(row)?;
                if saga.status != SagaStatus::InProgress || saga.updated_at >= cutoff {
                    continue;
                }
                let version = ch_u64(row, "version");
                saga.status = SagaStatus::Indeterminate;
                saga.last_error = "stale in-progress reconciled at startup".to_string();
                saga.updated_at = DateTime::<Utc>::from_timestamp_millis(Self::now_unix_ms())
                    .unwrap_or_else(Utc::now);
                self.insert_saga_version(&saga, version.saturating_add(1).max(1))
                    .await?;
                n += 1;
            }
            Ok(n)
        }
        .await;
        self.release_saga_mutation_lock(&owner, "mark_stale_in_progress_indeterminate")
            .await?;
        result
    }

    async fn saga_summary(&self) -> SystemStoreResult<SagaSummary> {
        let tbl = self.saga_table()?;
        // FINAL group-by status so each saga counts once at its latest status.
        let sql = format!("SELECT status, count() AS n FROM {tbl} FINAL GROUP BY status");
        let rows = self
            .executor()
            .select_rows(&sql)
            .await
            .map_err(|e| ch_err("saga_summary", e))?;
        let mut s = SagaSummary::default();
        for row in &rows {
            let status = ch_str(row, "status");
            let n = ch_i64(row, "n");
            match SagaStatus::parse(&status) {
                Some(SagaStatus::Indeterminate) => s.indeterminate += n,
                Some(SagaStatus::InProgress) => s.in_progress += n,
                Some(SagaStatus::Pending) => s.pending += n,
                Some(SagaStatus::Committed) => s.committed += n,
                Some(SagaStatus::Compensated) => s.compensated += n,
                Some(SagaStatus::Failed) => s.failed += n,
                Some(SagaStatus::InDoubt) => s.in_doubt += n,
                Some(SagaStatus::FailedCompensation) => s.failed_compensation += n,
                Some(SagaStatus::ManualReview) => s.manual_review += n,
                None => {
                    return Err(SystemStoreError::InvalidInput(format!(
                        "unknown saga status '{status}' in clickhouse summary"
                    )));
                }
            }
        }
        Ok(s)
    }
}