liminal-rs 0.2.1

A conversation-based messaging bus built on beamr
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
525
526
527
528
use std::collections::HashMap;
use std::error::Error;
use std::future::Future;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::{Context, Poll, Wake, Waker};
use std::time::Duration;

use super::*;

#[test]
fn entry_serialization_round_trips_required_fields() -> Result<(), Box<dyn Error>> {
    let entry = DedupEntry::new("key-a", Some(vec![7, 8, 9]), 42);

    let decoded = DedupEntry::deserialize(&entry.serialize()?)?;

    assert_eq!(decoded.idempotency_key(), "key-a");
    assert_eq!(decoded.receipt(), Some(&[7, 8, 9][..]));
    assert_eq!(decoded.timestamp_millis(), 42);
    Ok(())
}

#[test]
fn key_hash_and_stream_key_are_deterministic() {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store, "dedup");

    assert_eq!(key_hash("same-key"), key_hash("same-key"));
    assert_eq!(
        cache.stream_key_for("same-key"),
        cache.stream_key_for("same-key")
    );
    assert!(cache.stream_key_for("same-key").starts_with("dedup:"));
}

#[test]
fn duplicate_completed_returns_receipt_without_append() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.complete_receipt("key", ProcessingReceipt::new(vec![1, 2, 3])))?;
    let append_count = store.append_count()?;

    let decision = block_on(cache.claim_or_get("key", 2_000))?;

    assert_eq!(
        decision,
        DedupDecision::Completed(ProcessingReceipt::new(vec![1, 2, 3]))
    );
    assert_eq!(store.append_count()?, append_count);
    Ok(())
}

#[test]
fn duplicate_inflight_returns_status_without_timestamp_refresh() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    let append_count = store.append_count()?;

    assert_eq!(
        block_on(cache.claim_or_get("key", 2_000))?,
        DedupDecision::InFlight
    );

    let stream = store.stream(&cache.stream_key_for("key"))?;
    let first = stream.first().ok_or("missing first entry")?;
    let entry = DedupEntry::deserialize(&first.payload)?;
    assert_eq!(store.append_count()?, append_count);
    assert_eq!(entry.timestamp_millis(), 1_000);
    Ok(())
}

#[test]
fn complete_receipt_appends_completed_entry_with_receipt_timestamp() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![4, 5, 6]), 10_000))?;

    let stream = store.stream(&cache.stream_key_for("key"))?;
    assert_eq!(stream.len(), 2);
    let completed = stream.get(1).ok_or("missing completed entry")?;
    let entry = DedupEntry::deserialize(&completed.payload)?;
    assert_eq!(entry.receipt(), Some(&[4, 5, 6][..]));
    assert_eq!(entry.timestamp_millis(), 10_000);
    Ok(())
}

#[test]
fn completing_completed_key_is_idempotent_only_for_matching_receipt() -> Result<(), Box<dyn Error>>
{
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![1]), 2_000))?;
    let append_count = store.append_count()?;

    block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![1]), 3_000))?;
    let mismatched =
        block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![2]), 4_000));

    assert_eq!(store.append_count()?, append_count);
    assert!(matches!(
        mismatched,
        Err(DurabilityError::DedupCollision { .. })
    ));
    assert_eq!(store.append_count()?, append_count);
    assert_eq!(
        block_on(cache.claim_or_get("key", 5_000))?,
        DedupDecision::Completed(ProcessingReceipt::new(vec![1]))
    );
    Ok(())
}

#[test]
fn completing_missing_key_returns_collision() {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store, "dedup");

    let result = block_on(cache.complete_receipt("missing", ProcessingReceipt::new(vec![1])));

    assert!(matches!(
        result,
        Err(DurabilityError::DedupCollision { .. })
    ));
}

#[test]
fn sweep_uses_scan_and_respects_ttl_grace() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");
    let sweeper = DedupSweeper::new(
        cache.clone(),
        Duration::from_millis(60_000),
        Duration::from_millis(5_000),
    );
    assert_eq!(sweeper.sweep_interval(), Duration::from_millis(5_000));
    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );

    let first_report = block_on(sweeper.sweep_once(60_999))?;
    assert_eq!(first_report.expired_entries(), 0);
    assert_eq!(
        block_on(cache.lookup("key"))?,
        Some(DedupDecision::InFlight)
    );

    let second_report = block_on(sweeper.sweep_once(62_001))?;
    assert_eq!(second_report.expired_entries(), 1);
    assert_eq!(block_on(cache.lookup("key"))?, None);
    assert_eq!(
        store.scans()?,
        vec![String::from("dedup:"), String::from("dedup:")]
    );
    Ok(())
}

#[test]
fn sweep_keeps_receipt_younger_than_ttl_even_when_claim_is_old() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store, "dedup");
    let sweeper = DedupSweeper::new(
        cache.clone(),
        Duration::from_millis(60_000),
        Duration::from_millis(5_000),
    );

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![9]), 62_000))?;

    let young_report = block_on(sweeper.sweep_once(122_999))?;
    assert_eq!(young_report.expired_entries(), 0);
    assert_eq!(
        block_on(cache.lookup("key"))?,
        Some(DedupDecision::Completed(ProcessingReceipt::new(vec![9])))
    );

    let expired_report = block_on(sweeper.sweep_once(123_001))?;
    assert_eq!(expired_report.expired_entries(), 1);
    assert_eq!(block_on(cache.lookup("key"))?, None);
    Ok(())
}

#[test]
fn release_claim_tombstones_inflight_and_allows_reclaim() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    // While in flight, a re-claim is suppressed.
    assert_eq!(
        block_on(cache.claim_or_get("key", 1_500))?,
        DedupDecision::InFlight
    );

    block_on(cache.release_claim_at("key", 2_000))?;

    // A tombstone was appended (claim + tombstone == 2 records).
    let stream = store.stream(&cache.stream_key_for("key"))?;
    assert_eq!(stream.len(), 2);
    let last = stream.get(1).ok_or("missing tombstone")?;
    let record = DedupRecord::deserialize(&last.payload)?;
    assert!(
        matches!(record, DedupRecord::Tombstone { .. }),
        "release must append a tombstone"
    );

    // The key is now re-claimable.
    assert_eq!(
        block_on(cache.claim_or_get("key", 3_000))?,
        DedupDecision::Claimed
    );
    Ok(())
}

#[test]
fn release_claim_never_clobbers_a_stored_receipt() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.complete_receipt_at("key", ProcessingReceipt::new(vec![7, 7]), 2_000))?;
    let append_count = store.append_count()?;

    // Releasing a completed key is a no-op: no append, receipt preserved.
    block_on(cache.release_claim_at("key", 3_000))?;
    assert_eq!(store.append_count()?, append_count);

    assert_eq!(
        block_on(cache.claim_or_get("key", 4_000))?,
        DedupDecision::Completed(ProcessingReceipt::new(vec![7, 7]))
    );
    Ok(())
}

#[test]
fn release_claim_on_absent_key_is_noop() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    block_on(cache.release_claim_at("never-claimed", 1_000))?;

    assert_eq!(store.append_count()?, 0);
    assert!(
        store
            .stream(&cache.stream_key_for("never-claimed"))?
            .is_empty()
    );
    Ok(())
}

#[test]
fn release_claim_is_idempotent_across_double_release() -> Result<(), Box<dyn Error>> {
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");

    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );
    block_on(cache.release_claim_at("key", 2_000))?;
    let append_count = store.append_count()?;

    // Second release sees a tombstone (not in flight) and is a no-op.
    block_on(cache.release_claim_at("key", 3_000))?;
    assert_eq!(store.append_count()?, append_count);
    Ok(())
}

#[test]
fn release_claim_conflict_resolves_against_a_legitimate_reclaim() -> Result<(), Box<dyn Error>> {
    // Models the CONCURRENT race: a release tombstone and a legitimate re-claim
    // both target the same `next_seq`. The slow release loses the append CAS
    // because a real re-claim already wrote a fresh active entry at that slot.
    // The conflict re-check must NOT clobber that re-claim (would be a lost
    // delivery), so the release propagates the conflict.
    let store = Arc::new(FakeStore::default());
    let cache = DedupCache::new(store.clone(), "dedup");
    let stream_key = cache.stream_key_for("key");

    // First claim leaves the key in flight (seq 0). next_seq is now 1.
    assert_eq!(
        block_on(cache.claim_or_get("key", 1_000))?,
        DedupDecision::Claimed
    );

    // Simulate: the in-flight claim was released by a sweep (tombstone at seq 1),
    // and then a legitimate re-claim wrote a fresh active entry at seq 2 -- so the
    // stream head is an active, no-receipt entry. A stale release that snapshotted
    // BEFORE these writes would try to append at seq 1 and lose the CAS.
    block_on(store.append(
        &stream_key,
        DedupRecord::tombstone("key".to_owned(), 1_500).serialize()?,
        1,
    ))?;
    block_on(store.append(
        &stream_key,
        DedupEntry::new("key", None, 2_000).serialize()?,
        2,
    ))?;

    // Drive the release append against the STALE `next_seq` (1): the append loses
    // the CAS (real head is at seq 3), so the conflict re-check runs. This mirrors
    // exactly what `release_claim_at` does internally on a lost append race.
    let stale = block_on(stale_release_then_recheck(
        &cache,
        &stream_key,
        "key",
        5_000,
    ));
    assert!(
        matches!(stale, Err(DurabilityError::SequenceConflict { .. })),
        "a release racing a legitimate re-claim must not clobber it"
    );

    // The legitimate re-claim is intact: still in flight, receipt safe.
    assert_eq!(
        block_on(cache.lookup("key"))?,
        Some(DedupDecision::InFlight)
    );

    // Conversely, when the conflict is because a COMPLETION raced ahead, the
    // release goal (no dangling in-flight) is already met -> treated as Ok.
    block_on(store.append(
        &stream_key,
        DedupEntry::new("key", Some(vec![9]), 6_000).serialize()?,
        3,
    ))?;
    let after_completion = block_on(stale_release_then_recheck(
        &cache,
        &stream_key,
        "key",
        7_000,
    ));
    assert!(
        after_completion.is_ok(),
        "a release racing a completion is satisfied (receipt preserved)"
    );
    assert_eq!(
        block_on(cache.lookup("key"))?,
        Some(DedupDecision::Completed(ProcessingReceipt::new(vec![9])))
    );
    Ok(())
}

/// Drives a release tombstone append at the STALE `expected_seq` 1 so it loses the
/// CAS, then runs the same conflict re-check `release_claim_at` uses internally.
/// This exercises [`DedupCache::confirm_release_after_conflict`] deterministically
/// without a `#[cfg(test)]` seam in the production module.
async fn stale_release_then_recheck(
    cache: &DedupCache,
    stream_key: &str,
    idempotency_key: &str,
    timestamp_millis: u64,
) -> Result<(), DurabilityError> {
    let tombstone = DedupRecord::tombstone(idempotency_key.to_owned(), timestamp_millis);
    match cache
        .store
        .append(stream_key, tombstone.serialize()?, 1)
        .await
    {
        Ok(_) => Ok(()),
        Err(DurabilityError::SequenceConflict { expected, actual }) => {
            cache
                .confirm_release_after_conflict(stream_key, idempotency_key, expected, actual)
                .await
        }
        Err(error) => Err(error),
    }
}

#[derive(Debug, Default)]
struct FakeStore {
    streams: Mutex<HashMap<String, Vec<StoredEntry>>>,
    append_count: Mutex<usize>,
    scans: Mutex<Vec<String>>,
}

#[async_trait::async_trait]
impl DurableStore for FakeStore {
    async fn append(
        &self,
        stream_key: &str,
        payload: Vec<u8>,
        expected_seq: u64,
    ) -> Result<u64, DurabilityError> {
        let actual = {
            let mut streams = self.streams.lock().map_err(|_| lock_error())?;
            let stream = streams.entry(stream_key.to_owned()).or_default();
            let actual = len_to_u64(stream.len())?;
            if expected_seq != actual {
                return Err(DurabilityError::SequenceConflict {
                    expected: expected_seq,
                    actual,
                });
            }
            stream.push(StoredEntry {
                payload,
                sequence: actual,
                timestamp: 0,
            });
            drop(streams);
            actual
        };
        *self.append_count.lock().map_err(|_| lock_error())? += 1;
        Ok(actual)
    }

    async fn read_from(
        &self,
        stream_key: &str,
        offset: u64,
        limit: usize,
    ) -> Result<Vec<StoredEntry>, DurabilityError> {
        let start = usize::try_from(offset).map_err(|error| {
            DurabilityError::ConfigError(format!("test offset cannot fit usize: {error}"))
        })?;
        let entries = {
            let streams = self.streams.lock().map_err(|_| lock_error())?;
            let entries = streams.get(stream_key).map_or_else(Vec::new, |stream| {
                stream.iter().skip(start).take(limit).cloned().collect()
            });
            drop(streams);
            entries
        };
        Ok(entries)
    }

    async fn cas(&self, _: &str, _: u64, _: u64) -> Result<(), DurabilityError> {
        Ok(())
    }

    async fn read_value(&self, _: &str) -> Result<Option<u64>, DurabilityError> {
        Ok(None)
    }

    async fn scan(&self, prefix: &str) -> Result<Vec<StoredEntry>, DurabilityError> {
        self.scans
            .lock()
            .map_err(|_| lock_error())?
            .push(prefix.to_owned());
        let streams = self.streams.lock().map_err(|_| lock_error())?;
        Ok(streams
            .iter()
            .filter(|(key, _)| key.starts_with(prefix))
            .flat_map(|(_, entries)| entries.clone())
            .collect())
    }

    async fn flush(&self) -> Result<(), DurabilityError> {
        Ok(())
    }
}

impl FakeStore {
    fn append_count(&self) -> Result<usize, DurabilityError> {
        self.append_count
            .lock()
            .map(|guard| *guard)
            .map_err(|_| lock_error())
    }

    fn stream(&self, stream_key: &str) -> Result<Vec<StoredEntry>, DurabilityError> {
        self.streams
            .lock()
            .map_err(|_| lock_error())
            .map(|streams| streams.get(stream_key).cloned().unwrap_or_default())
    }

    fn scans(&self) -> Result<Vec<String>, DurabilityError> {
        self.scans
            .lock()
            .map(|guard| guard.clone())
            .map_err(|_| lock_error())
    }
}

fn block_on<F: Future>(future: F) -> F::Output {
    let waker = Waker::from(Arc::new(NoopWaker));
    let mut context = Context::from_waker(&waker);
    let mut future = Box::pin(future);
    loop {
        match Future::poll(Pin::as_mut(&mut future), &mut context) {
            Poll::Ready(output) => return output,
            Poll::Pending => std::thread::yield_now(),
        }
    }
}

struct NoopWaker;

impl Wake for NoopWaker {
    fn wake(self: Arc<Self>) {}
}

fn lock_error() -> DurabilityError {
    DurabilityError::StoreError(haematite::ApiError::Storage(
        haematite::DatabaseError::IoError(std::io::Error::other("fake store lock poisoned")),
    ))
}