hitbox-backend 0.2.1

Backend trait for asynchronous caching framework in Rust.
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
529
530
531
532
533
534
535
536
537
//! Tests for composition read policies (Sequential, Race, Parallel).

use bytes::Bytes;
use hitbox_backend::Backend;
use hitbox_backend::composition::policy::{
    CompositionReadPolicy, ParallelReadPolicy, RaceReadPolicy, SequentialReadPolicy,
};
use hitbox_core::{BoxContext, CacheContext, CacheKey, CacheValue};

use crate::common::{ErrorBackend, TestBackend, TestOffloadManager};

/// Helper to create a default context for tests
fn default_ctx() -> BoxContext {
    CacheContext::default().boxed()
}

// =============================================================================
// SequentialReadPolicy Tests
// =============================================================================

#[tokio::test]
async fn test_sequential_l1_hit() {
    let policy = SequentialReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l1"), None, None);

    l1.write(&key, value.clone()).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}

#[tokio::test]
async fn test_sequential_l2_hit() {
    let policy = SequentialReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

#[tokio::test]
async fn test_sequential_both_miss() {
    let policy = SequentialReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_none());
}

#[tokio::test]
async fn test_sequential_l1_error_l2_hit() {
    let policy = SequentialReadPolicy::new();
    let l1 = ErrorBackend;
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

// =============================================================================
// RaceReadPolicy Tests
// =============================================================================

#[tokio::test]
async fn test_race_l1_hit() {
    let policy = RaceReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l1"), None, None);

    l1.write(&key, value.clone()).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}

#[tokio::test]
async fn test_race_l2_hit() {
    let policy = RaceReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

#[tokio::test]
async fn test_race_both_miss() {
    let policy = RaceReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_none());
}

#[tokio::test]
async fn test_race_l1_error_l2_hit() {
    let policy = RaceReadPolicy::new();
    let l1 = ErrorBackend;
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

// =============================================================================
// ParallelReadPolicy Tests
// =============================================================================

#[tokio::test]
async fn test_parallel_both_hit_prefer_l1() {
    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");

    l1.write(&key, CacheValue::new(Bytes::from("from_l1"), None, None))
        .await
        .unwrap();
    l2.write(&key, CacheValue::new(Bytes::from("from_l2"), None, None))
        .await
        .unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // Both have no expiry - should prefer L1 (tie-breaker)
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}

#[tokio::test]
async fn test_parallel_l1_miss_l2_hit() {
    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

#[tokio::test]
async fn test_parallel_both_miss() {
    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_none());
}

#[tokio::test]
async fn test_parallel_l1_error_l2_hit() {
    let policy = ParallelReadPolicy::new();
    let l1 = ErrorBackend;
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l2.write(&key, value.clone()).await.unwrap();

    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

// =============================================================================
// ParallelReadPolicy TTL-based Selection Tests
// =============================================================================

#[tokio::test]
async fn test_parallel_both_hit_l2_fresher_ttl() {
    use chrono::Utc;

    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let now = Utc::now();

    // L1 has shorter TTL (expires in 10 seconds)
    let l1_value = CacheValue::new(
        Bytes::from("from_l1"),
        Some(now + chrono::Duration::seconds(10)),
        None,
    );

    // L2 has longer TTL (expires in 60 seconds)
    let l2_value = CacheValue::new(
        Bytes::from("from_l2"),
        Some(now + chrono::Duration::seconds(60)),
        None,
    );

    l1.write(&key, l1_value).await.unwrap();
    l2.write(&key, l2_value).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // Should prefer L2 (fresher/longer TTL)
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

#[tokio::test]
async fn test_parallel_both_hit_l1_fresher_ttl() {
    use chrono::Utc;

    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let now = Utc::now();

    // L1 has longer TTL (expires in 60 seconds)
    let l1_value = CacheValue::new(
        Bytes::from("from_l1"),
        Some(now + chrono::Duration::seconds(60)),
        None,
    );

    // L2 has shorter TTL (expires in 10 seconds)
    let l2_value = CacheValue::new(
        Bytes::from("from_l2"),
        Some(now + chrono::Duration::seconds(10)),
        None,
    );

    l1.write(&key, l1_value).await.unwrap();
    l2.write(&key, l2_value).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // Should prefer L1 (fresher/longer TTL)
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}

#[tokio::test]
async fn test_parallel_both_hit_equal_ttl() {
    use chrono::Utc;

    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let now = Utc::now();
    let expiry = now + chrono::Duration::seconds(30);

    // Both have same TTL
    let l1_value = CacheValue::new(Bytes::from("from_l1"), Some(expiry), None);

    let l2_value = CacheValue::new(Bytes::from("from_l2"), Some(expiry), None);

    l1.write(&key, l1_value).await.unwrap();
    l2.write(&key, l2_value).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // Equal TTLs - should prefer L1 (tie-breaker)
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}

#[tokio::test]
async fn test_parallel_both_hit_l2_no_expiry() {
    use chrono::Utc;

    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let now = Utc::now();

    // L1 has expiry
    let l1_value = CacheValue::new(
        Bytes::from("from_l1"),
        Some(now + chrono::Duration::seconds(60)),
        None,
    );

    // L2 has no expiry (infinite TTL)
    let l2_value = CacheValue::new(Bytes::from("from_l2"), None, None);

    l1.write(&key, l1_value).await.unwrap();
    l2.write(&key, l2_value).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // L2 has no expiry (infinite) - should prefer L2
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l2"));
}

#[tokio::test]
async fn test_parallel_both_hit_l1_no_expiry() {
    use chrono::Utc;

    let policy = ParallelReadPolicy::new();
    let l1 = TestBackend::new();
    let l2 = TestBackend::new();
    let offload = TestOffloadManager;

    let key = CacheKey::from_str("test", "key1");
    let now = Utc::now();

    // L1 has no expiry (infinite TTL)
    let l1_value = CacheValue::new(Bytes::from("from_l1"), None, None);

    // L2 has expiry
    let l2_value = CacheValue::new(
        Bytes::from("from_l2"),
        Some(now + chrono::Duration::seconds(60)),
        None,
    );

    l1.write(&key, l1_value).await.unwrap();
    l2.write(&key, l2_value).await.unwrap();

    let l1_clone = l1.clone();
    let l2_clone = l2.clone();
    let read_l1 = |k: CacheKey| async move { (l1_clone.read(&k).await, default_ctx()) };
    let read_l2 = |k: CacheKey| async move { (l2_clone.read(&k).await, default_ctx()) };

    let read_result = policy
        .execute_with(key, read_l1, read_l2, &offload)
        .await
        .unwrap();

    assert!(read_result.value.is_some());
    // L1 has no expiry (infinite) - should prefer L1
    assert_eq!(read_result.value.unwrap().data(), &Bytes::from("from_l1"));
}