exoware-simulator 2026.7.1

Simulate the Exoware API.
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
use std::time::Duration;

use bytes::Bytes;
use exoware_sdk::keys::{Key, Prefix};
use exoware_sdk::kv_codec::Utf8;
use exoware_sdk::prune_policy::{PolicyScope, PrunePolicy, RetainPolicy};
use exoware_sdk::selector::Selector;
use exoware_sdk::stream_filter::StreamFilter;
use exoware_sdk::{PrefixedStoreClient, RetryConfig, StoreClient};

/// Spawns a local simulator and returns a client for it.
async fn spawn_client() -> PrefixedStoreClient {
    let (_task, url) = exoware_simulator::open_temp().await.expect("open_temp");
    let client = StoreClient::builder()
        .url(&url)
        .retry_config(RetryConfig::disabled())
        .build()
        .expect("build client");
    PrefixedStoreClient::empty(client)
}

fn key(family: u8, payload: &[u8]) -> Key {
    Prefix::from_byte(family).encode(payload).expect("encode")
}

fn filter(family: u8) -> StreamFilter {
    StreamFilter {
        selectors: vec![Selector {
            prefix: Bytes::from(vec![family]),
            payload_regex: Utf8::from("(?s).*"),
        }],
        value_filters: vec![],
    }
}

fn keep_latest_batches(count: usize) -> PrunePolicy {
    PrunePolicy {
        scope: PolicyScope::Sequence,
        retain: RetainPolicy::KeepLatest { count },
    }
}

fn drop_all_batches() -> PrunePolicy {
    PrunePolicy {
        scope: PolicyScope::Sequence,
        retain: RetainPolicy::DropAll,
    }
}

async fn next_with_timeout(
    sub: &mut exoware_sdk::StreamSubscription,
    ms: u64,
) -> Option<exoware_sdk::StreamSubscriptionFrame> {
    tokio::time::timeout(Duration::from_millis(ms), sub.next())
        .await
        .ok()
        .and_then(|r| r.expect("stream error"))
}

// ---------- live subscribe ----------

#[tokio::test]
async fn live_subscribe_delivers_matching_entries() {
    let client = spawn_client().await;
    let mut sub = client
        .stream()
        .subscribe(filter(1), None)
        .await
        .expect("subscribe");

    // Give the subscription time to register on the server before we publish.
    tokio::time::sleep(Duration::from_millis(50)).await;

    let k = key(1, b"hello");
    let seq = client.ingest().put(&[(&k, b"world")]).await.expect("put");

    let frame = next_with_timeout(&mut sub, 1_000)
        .await
        .expect("should receive a frame");
    assert_eq!(frame.sequence_number, seq);
    assert_eq!(frame.entries.len(), 1);
    assert_eq!(frame.entries[0].key.as_ref(), k.as_ref());
    assert_eq!(frame.entries[0].value.as_ref(), b"world");
}

#[tokio::test]
async fn non_matching_put_yields_no_frame() {
    let client = spawn_client().await;
    let mut sub = client
        .stream()
        .subscribe(filter(1), None)
        .await
        .expect("subscribe");
    tokio::time::sleep(Duration::from_millis(50)).await;

    client
        .ingest()
        .put(&[(&key(2, b"miss"), b"v")])
        .await
        .expect("put");

    assert!(
        next_with_timeout(&mut sub, 200).await.is_none(),
        "should NOT receive a frame"
    );
}

#[tokio::test]
async fn multiple_selectors_delivered_once_per_put() {
    let client = spawn_client().await;
    let f = StreamFilter {
        selectors: vec![
            Selector {
                prefix: Bytes::from(vec![1]),
                payload_regex: Utf8::from("(?s).*"),
            },
            Selector {
                prefix: Bytes::from(vec![2]),
                payload_regex: Utf8::from("(?s).*"),
            },
        ],
        value_filters: vec![],
    };
    let mut sub = client.stream().subscribe(f, None).await.expect("subscribe");
    tokio::time::sleep(Duration::from_millis(50)).await;

    let ka = key(1, b"a");
    let kb = key(2, b"b");
    client
        .ingest()
        .put(&[(&ka, b"1"), (&kb, b"2")])
        .await
        .expect("put");

    let frame = next_with_timeout(&mut sub, 1_000)
        .await
        .expect("frame received");
    assert_eq!(frame.entries.len(), 2);
    // Both families deliver in one frame (one PUT → one frame, atomic).
    let keys: Vec<&[u8]> = frame.entries.iter().map(|e| e.key.as_ref()).collect();
    assert!(keys.contains(&ka.as_ref()));
    assert!(keys.contains(&kb.as_ref()));
}

#[tokio::test]
async fn two_puts_yield_two_distinct_frames() {
    let client = spawn_client().await;
    let mut sub = client
        .stream()
        .subscribe(filter(1), None)
        .await
        .expect("subscribe");
    tokio::time::sleep(Duration::from_millis(50)).await;

    let seq1 = client
        .ingest()
        .put(&[(&key(1, b"a"), b"1")])
        .await
        .expect("put1");
    let seq2 = client
        .ingest()
        .put(&[(&key(1, b"b"), b"2")])
        .await
        .expect("put2");

    let f1 = next_with_timeout(&mut sub, 1_000).await.expect("frame 1");
    let f2 = next_with_timeout(&mut sub, 1_000).await.expect("frame 2");
    assert_eq!(f1.sequence_number, seq1);
    assert_eq!(f2.sequence_number, seq2);
    assert!(f2.sequence_number > f1.sequence_number);
}

// ---------- replay via since_sequence_number ----------

#[tokio::test]
async fn replay_since_delivers_retained_batches_then_live() {
    let client = spawn_client().await;
    let mut seen_seqs = Vec::new();
    for i in 0..5u8 {
        let seq = client
            .ingest()
            .put(&[(&key(1, &[b'a' + i]), &[b'v', i])])
            .await
            .expect("put");
        seen_seqs.push(seq);
    }

    // Subscribe from seq 3 → should replay 3, 4, 5 then continue live.
    let start = seen_seqs[2];
    let mut sub = client
        .stream()
        .subscribe(filter(1), Some(start))
        .await
        .expect("subscribe");

    // Expect replay frames for seq 3, 4, 5 in order.
    let mut replayed = Vec::new();
    for _ in 0..3 {
        let frame = next_with_timeout(&mut sub, 1_000)
            .await
            .expect("replay frame");
        replayed.push(frame.sequence_number);
    }
    assert_eq!(replayed, vec![seen_seqs[2], seen_seqs[3], seen_seqs[4]]);

    // Now live: a new PUT should arrive with its actual seq.
    let live_seq = client
        .ingest()
        .put(&[(&key(1, b"live"), b"hot")])
        .await
        .expect("put live");
    let live = next_with_timeout(&mut sub, 1_000)
        .await
        .expect("live frame");
    assert_eq!(live.sequence_number, live_seq);
    assert!(live.sequence_number > seen_seqs[4]);
}

#[tokio::test]
async fn replay_past_end_delivers_only_live() {
    let client = spawn_client().await;
    let current = client
        .ingest()
        .put(&[(&key(1, b"seed"), b"v")])
        .await
        .expect("put");

    let mut sub = client
        .stream()
        .subscribe(filter(1), Some(current + 10))
        .await
        .expect("subscribe");

    // No replay — should not receive a frame for current+10 since it doesn't
    // exist and since > current triggers the unset-cursor path.
    assert!(next_with_timeout(&mut sub, 200).await.is_none());

    // Next live PUT lands with its actual seq (no synthetic gaps).
    let live_seq = client
        .ingest()
        .put(&[(&key(1, b"next"), b"n")])
        .await
        .expect("put next");
    let frame = next_with_timeout(&mut sub, 1_000)
        .await
        .expect("live frame");
    assert_eq!(frame.sequence_number, live_seq);
}

#[tokio::test]
async fn replay_miss_after_prune_returns_batch_evicted() {
    let client = spawn_client().await;
    for i in 0..20u8 {
        client
            .ingest()
            .put(&[(&key(1, &[i]), &[b'v', i])])
            .await
            .expect("put");
    }
    // Prune via compact batch-log policy: keep last 10.
    client
        .compact()
        .prune(&[keep_latest_batches(10)])
        .await
        .expect("prune keep_latest batches");

    // Subscribing from seq 1 should fail with BATCH_EVICTED. The error may
    // surface either on the subscribe call itself or on the first next()
    // depending on whether the transport has flushed headers before the
    // server-side error returns.
    let err_msg = match client.stream().subscribe(filter(1), Some(1)).await {
        Err(err) => format!("{err:?}"),
        Ok(mut sub) => format!("{:?}", sub.next().await.expect_err("stream should error")),
    };
    assert!(
        err_msg.contains("out_of_range")
            || err_msg.contains("OutOfRange")
            || err_msg.contains("BATCH_EVICTED")
            || err_msg.contains("evicted"),
        "unexpected error: {err_msg}"
    );
}

// ---------- GetBatch ----------

#[tokio::test]
async fn get_batch_returns_whole_batch_unfiltered() {
    let client = spawn_client().await;
    let ka = key(1, b"a");
    let kb = key(2, b"b");
    let seq = client
        .ingest()
        .put(&[(&ka, b"1"), (&kb, b"2")])
        .await
        .expect("put");

    let got = client
        .stream()
        .get(seq)
        .await
        .expect("get_batch")
        .expect("some");
    assert_eq!(got.len(), 2);
    // Order must match write order.
    assert_eq!(got[0].0.as_ref(), ka.as_ref());
    assert_eq!(got[0].1.as_ref(), b"1");
    assert_eq!(got[1].0.as_ref(), kb.as_ref());
    assert_eq!(got[1].1.as_ref(), b"2");
}

#[tokio::test]
async fn get_batch_missing_seq_returns_none() {
    let client = spawn_client().await;
    client
        .ingest()
        .put(&[(&key(1, b"a"), b"1")])
        .await
        .expect("put");
    let got = client
        .stream()
        .get(10_000)
        .await
        .expect("get_batch should not error");
    assert!(got.is_none());
}

#[tokio::test]
async fn get_batch_after_drop_all_returns_none() {
    let client = spawn_client().await;
    let seq = client
        .ingest()
        .put(&[(&key(1, b"a"), b"1")])
        .await
        .expect("put");
    client
        .compact()
        .prune(&[drop_all_batches()])
        .await
        .expect("prune");

    let got = client.stream().get(seq).await.expect("get_batch");
    assert!(got.is_none(), "pruned batch should return None");
}

#[tokio::test]
async fn get_batch_after_keep_latest_evicts_old_but_keeps_new() {
    let client = spawn_client().await;
    let mut seqs = Vec::new();
    for i in 0..20u8 {
        let s = client
            .ingest()
            .put(&[(&key(1, &[i]), &[b'v', i])])
            .await
            .expect("put");
        seqs.push(s);
    }
    client
        .compact()
        .prune(&[keep_latest_batches(10)])
        .await
        .expect("prune keep_latest batches");

    // Earliest seq should be evicted.
    assert!(client.stream().get(seqs[0]).await.expect("get").is_none());
    // Latest seq should survive.
    let last = client
        .stream()
        .get(*seqs.last().unwrap())
        .await
        .expect("get last")
        .expect("some");
    assert_eq!(last.len(), 1);
    assert_eq!(last[0].1.as_ref(), &[b'v', 19]);
}

// ---------- slow subscriber is dropped without blocking ingest ----------

#[tokio::test]
async fn slow_subscriber_drops_without_blocking_ingest() {
    let client = spawn_client().await;
    // Open subscription but never drain it. Internal cap = 256 frames.
    let _sub = client
        .stream()
        .subscribe(filter(1), None)
        .await
        .expect("subscribe");
    tokio::time::sleep(Duration::from_millis(50)).await;

    // Flood enough matching PUTs to exceed the subscriber channel.
    // Ingest latency must stay bounded: if the subscriber ever blocked
    // ingest, this loop would hang.
    let started = std::time::Instant::now();
    for i in 0..512u16 {
        let k = key(1, &i.to_be_bytes());
        client.ingest().put(&[(&k, b"x")]).await.expect("put");
    }
    let elapsed = started.elapsed();
    assert!(
        elapsed < Duration::from_secs(30),
        "ingest should not stall on slow subscriber (took {elapsed:?})"
    );
    // Small verification that the store actually still serves reads.
    let last = Bytes::copy_from_slice(
        client
            .query()
            .get(&key(1, &511u16.to_be_bytes()))
            .await
            .expect("get")
            .expect("some")
            .as_ref(),
    );
    assert_eq!(last.as_ref(), b"x");
}

#[tokio::test]
async fn value_filter_restricts_to_matching_values() {
    use exoware_sdk::stream_filter::Filter;
    let client = spawn_client().await;
    let f = StreamFilter {
        selectors: vec![Selector {
            prefix: Bytes::from(vec![1]),
            payload_regex: Utf8::from("(?s).*"),
        }],
        value_filters: vec![Filter::Regex("^keep.*$".into())],
    };
    let mut sub = client.stream().subscribe(f, None).await.expect("subscribe");
    tokio::time::sleep(Duration::from_millis(50)).await;

    let ka = key(1, b"a");
    let kb = key(1, b"b");
    client
        .ingest()
        .put(&[(&ka, b"keep-alpha"), (&kb, b"drop-beta")])
        .await
        .expect("put");

    let frame = next_with_timeout(&mut sub, 1_000)
        .await
        .expect("should receive a frame");
    assert_eq!(frame.entries.len(), 1);
    assert_eq!(frame.entries[0].key.as_ref(), ka.as_ref());
    assert_eq!(frame.entries[0].value.as_ref(), b"keep-alpha");
}