cachet 0.7.4

A composable, customizable multi-tier caching library with rich feature support.
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! Integration tests for Cache API.

#![cfg(feature = "memory")]

use cachet::{Cache, CacheEntry, Error};
use cachet_tier::MockCache;
use tick::Clock;

#[cfg_attr(miri, ignore)]
#[test]
fn builder_creates_cache() {
    let clock = Clock::new_frozen();
    let cache: Cache<String, String> = Cache::builder(clock).memory().build();

    assert!(!cache.name().is_empty());
}

#[cfg_attr(miri, ignore)]
#[test]
fn name_returns_non_empty_string() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let name = cache.name();
    assert!(!name.is_empty());
}

#[cfg_attr(miri, ignore)]
#[test]
fn clock_returns_reference() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let clock_ref = cache.clock();
    // Verify we can use the clock
    let _ = clock_ref.instant();
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn get_insert_operations() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "test_key".to_string();

    assert!(cache.get(&key).await.unwrap().is_none());

    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();

    let entry = cache.get(&key).await.unwrap().expect("entry should exist");
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn invalidate_removes_entry() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_some());

    cache.invalidate(&key).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_none());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn contains_checks_existence() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    assert!(!cache.contains(&key).await.unwrap());

    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();

    assert!(cache.contains(&key).await.unwrap());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn clear_removes_all_entries() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    cache.insert("k1".to_string(), CacheEntry::new(1)).await.unwrap();
    cache.insert("k2".to_string(), CacheEntry::new(2)).await.unwrap();

    // Verify entries exist before clearing
    assert!(cache.get(&"k1".to_string()).await.unwrap().is_some());
    assert!(cache.get(&"k2".to_string()).await.unwrap().is_some());

    cache.clear().await.unwrap();

    assert!(cache.get(&"k1".to_string()).await.unwrap().is_none());
    assert!(cache.get(&"k2".to_string()).await.unwrap().is_none());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn len_returns_correct_count() {
    // Use MockCache (HashMap-backed) for immediate consistency of len()
    let clock = Clock::new_frozen();
    let cache = Cache::builder(clock).storage(MockCache::<String, i32>::new()).build();

    assert_eq!(cache.len().await.unwrap(), 0);

    cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();

    assert_eq!(cache.len().await.unwrap(), 1);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn is_empty_returns_true_if_empty() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder(clock).storage(MockCache::<String, i32>::new()).build();

    assert!(cache.is_empty().await.unwrap());

    cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();

    assert!(!cache.is_empty().await.unwrap());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn get_or_insert_returns_cached() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    let entry = cache.get_or_insert(&key, || async { 42 }).await.unwrap();
    assert_eq!(*entry.value(), 42);

    let entry = cache.get_or_insert(&key, || async { 100 }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_success() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    let entry = cache.try_get_or_insert(&key, || async { Ok::<_, Error>(42) }).await.unwrap();
    assert_eq!(*entry.value(), 42);

    // Verify caching: second call should return cached value, not 100
    let entry = cache.try_get_or_insert(&key, || async { Ok::<_, Error>(100) }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_error() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    let result: Result<CacheEntry<i32>, Error> = cache
        .try_get_or_insert(&key, || async { Err(Error::from_message("test error")) })
        .await;

    result.expect_err("factory error should propagate");
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_returns_cached() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let result = cache.get(&key).await.unwrap();
    assert!(result.is_none());

    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();
    let entry = cache.get(&key).await.unwrap().expect("entry should exist");
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_invalidate() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();
    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_some());

    cache.invalidate(&key).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_none());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_get_or_insert() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let entry = cache.get_or_insert(&key, || async { 42 }).await.unwrap();
    assert_eq!(*entry.value(), 42);

    // Second call returns cached value
    let entry = cache.get_or_insert(&key, || async { 100 }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_try_get_or_insert_success() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let entry = cache.try_get_or_insert(&key, || async { Ok::<_, Error>(42) }).await.unwrap();
    assert_eq!(*entry.value(), 42);

    // Cached on second call
    let entry = cache.try_get_or_insert(&key, || async { Ok::<_, Error>(100) }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_try_get_or_insert_error() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let result: Result<CacheEntry<i32>, Error> = cache
        .try_get_or_insert(&key, || async { Err(Error::from_message("test error")) })
        .await;

    result.expect_err("factory error should propagate through stampede protection");
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_optionally_get_or_insert_some() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let entry = cache.optionally_get_or_insert(&key, || async { Some(42) }).await.unwrap();
    assert_eq!(*entry.unwrap().value(), 42);

    // Cached on second call
    let entry = cache.optionally_get_or_insert(&key, || async { Some(100) }).await.unwrap();
    assert_eq!(*entry.unwrap().value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_optionally_get_or_insert_none() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    // None result is not cached
    let result = cache.optionally_get_or_insert(&key, || async { None::<i32> }).await.unwrap();
    assert!(result.is_none());

    // Not cached, so second call still invokes factory
    let result = cache.optionally_get_or_insert(&key, || async { Some(42) }).await.unwrap();
    assert_eq!(*result.unwrap().value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn optionally_get_or_insert_none_not_cached() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    // None result is not cached
    let result = cache.optionally_get_or_insert(&key, || async { None::<i32> }).await.unwrap();
    assert!(result.is_none());

    // Not cached, so second call still invokes factory
    let result = cache.optionally_get_or_insert(&key, || async { Some(42) }).await.unwrap();
    assert_eq!(*result.unwrap().value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn optionally_get_or_insert_hit_returns_cached() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();
    cache.insert(key.clone(), CacheEntry::new(99)).await.unwrap();

    // Should return cached value without calling factory
    let result = cache.optionally_get_or_insert(&key, || async { Some(42) }).await.unwrap();
    assert_eq!(*result.unwrap().value(), 99);
}

// =============================================================================
// Thread Safety Tests (per O-ABSTRACTIONS-SEND-SYNC guideline)
// =============================================================================

/// Verifies that Cache with `InMemoryCache` storage is Send.
#[cfg_attr(miri, ignore)]
#[test]
fn cache_with_memory_is_send() {
    fn assert_send<T: Send>() {}
    assert_send::<Cache<String, i32>>();
}

/// Verifies that Cache with `InMemoryCache` storage is Sync.
#[cfg_attr(miri, ignore)]
#[test]
fn cache_with_memory_is_sync() {
    fn assert_sync<T: Sync>() {}
    assert_sync::<Cache<String, i32>>();
}

// =============================================================================
// get_or_insert_with tests
// =============================================================================

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn get_or_insert_with_computes_and_caches() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    let entry = cache
        .get_or_insert_with(&key, || async { CacheEntry::expires_after(42, std::time::Duration::from_mins(5)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);
    assert_eq!(entry.ttl(), Some(std::time::Duration::from_mins(5)));

    // Second call returns cached value, not the new closure result
    let entry = cache.get_or_insert_with(&key, || async { CacheEntry::new(100) }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn get_or_insert_with_preserves_per_entry_ttl() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();
    let ttl = std::time::Duration::from_mins(1);

    let entry = cache
        .get_or_insert_with(&key, || async { CacheEntry::expires_after(7, ttl) })
        .await
        .unwrap();

    assert_eq!(*entry.value(), 7);
    assert_eq!(entry.ttl(), Some(ttl));
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn or_insert_family_populates_cached_at_on_miss() {
    let clock = Clock::new_frozen();
    let now = clock.system_time();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let entry = cache.get_or_insert(&"a".to_string(), || async { 1 }).await.unwrap();
    assert_eq!(entry.cached_at(), Some(now));

    let entry = cache
        .get_or_insert_with(&"b".to_string(), || async { CacheEntry::new(2) })
        .await
        .unwrap();
    assert_eq!(entry.cached_at(), Some(now));

    let entry = cache
        .try_get_or_insert(&"c".to_string(), || async { Ok::<_, Error>(3) })
        .await
        .unwrap();
    assert_eq!(entry.cached_at(), Some(now));

    let entry = cache
        .try_get_or_insert_with(&"d".to_string(), || async { Ok::<_, Error>(CacheEntry::new(4)) })
        .await
        .unwrap();
    assert_eq!(entry.cached_at(), Some(now));

    let entry = cache
        .optionally_get_or_insert(&"e".to_string(), || async { Some(5) })
        .await
        .unwrap()
        .unwrap();
    assert_eq!(entry.cached_at(), Some(now));
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_get_or_insert_with() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let entry = cache
        .get_or_insert_with(&key, || async { CacheEntry::expires_after(42, std::time::Duration::from_mins(2)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);

    // Second call returns cached value
    let entry = cache.get_or_insert_with(&key, || async { CacheEntry::new(100) }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

// =============================================================================
// try_get_or_insert_with tests
// =============================================================================

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_with_success() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();
    let ttl = std::time::Duration::from_mins(10);

    let entry = cache
        .try_get_or_insert_with(&key, || async { Ok::<_, Error>(CacheEntry::expires_after(42, ttl)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);
    assert_eq!(entry.ttl(), Some(ttl));

    // Cached on second call
    let entry = cache
        .try_get_or_insert_with(&key, || async { Ok::<_, Error>(CacheEntry::new(100)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_with_error_not_cached() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let key = "key".to_string();

    let result: Result<CacheEntry<i32>, Error> = cache
        .try_get_or_insert_with(&key, || async { Err(Error::from_message("computation failed")) })
        .await;
    result.expect_err("error should propagate");

    // Not cached — second call with success should work
    let entry = cache
        .try_get_or_insert_with(&key, || async { Ok::<_, Error>(CacheEntry::new(99)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 99);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_try_get_or_insert_with_success() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let entry = cache
        .try_get_or_insert_with(&key, || async {
            Ok::<_, Error>(CacheEntry::expires_after(42, std::time::Duration::from_mins(1)))
        })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);

    // Cached on second call
    let entry = cache
        .try_get_or_insert_with(&key, || async { Ok::<_, Error>(CacheEntry::new(100)) })
        .await
        .unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_try_get_or_insert_with_error() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();

    let result: Result<CacheEntry<i32>, Error> = cache
        .try_get_or_insert_with(&key, || async { Err(Error::from_message("test error")) })
        .await;
    result.expect_err("error should propagate through stampede protection");
}

/// Verifies that `CacheEntry` is Send.
#[test]
fn cache_entry_is_send() {
    fn assert_send<T: Send>() {}
    assert_send::<CacheEntry<i32>>();
    assert_send::<CacheEntry<String>>();
}

/// Verifies that `CacheEntry` is Sync.
#[test]
fn cache_entry_is_sync() {
    fn assert_sync<T: Sync>() {}
    assert_sync::<CacheEntry<i32>>();
    assert_sync::<CacheEntry<String>>();
}

/// Verifies that Error is Send.
#[test]
fn error_is_send() {
    fn assert_send<T: Send>() {}
    assert_send::<Error>();
}

/// Verifies that Error is Sync.
#[test]
fn error_is_sync() {
    fn assert_sync<T: Sync>() {}
    assert_sync::<Error>();
}

/// Verifies that with stampede protection, storage errors are propagated (not hidden).
#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_propagates_storage_errors() {
    use cachet_tier::{CacheOp, MockCache};

    let clock = Clock::new_frozen();
    let mock = MockCache::<String, i32>::new();
    mock.fail_when(|op| matches!(op, CacheOp::Get(_)));

    let cache = Cache::builder(clock).storage(mock).stampede_protection().build();

    let result: Result<Option<CacheEntry<i32>>, Error> = cache.get(&"key".to_string()).await;
    assert!(result.is_err(), "storage error should propagate through stampede protection");
}

/// Verifies that with stampede protection, panics are converted to errors (not hidden as misses).
#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_converts_panic_to_error() {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicBool, Ordering};

    use cachet::CacheTier;
    use uniflight::LeaderPanicked;

    /// A cache tier that panics on the first get.
    #[derive(Clone)]
    struct PanickingCache {
        panicked: Arc<AtomicBool>,
    }

    impl CacheTier<String, i32> for PanickingCache {
        async fn get(&self, _key: &String) -> Result<Option<CacheEntry<i32>>, Error> {
            assert!(self.panicked.swap(true, Ordering::SeqCst), "simulated panic in cache tier");
            Ok(None)
        }

        async fn insert(&self, _key: String, _entry: CacheEntry<i32>) -> Result<(), Error> {
            Ok(())
        }

        async fn invalidate(&self, _key: &String) -> Result<(), Error> {
            Ok(())
        }

        async fn clear(&self) -> Result<(), Error> {
            Ok(())
        }
    }

    let clock = Clock::new_frozen();
    let storage = PanickingCache {
        panicked: Arc::new(AtomicBool::new(false)),
    };
    let cache = Cache::builder(clock).storage(storage).stampede_protection().build();

    let result = cache.get(&"key".to_string()).await;

    // Should be an error, not Ok(None)
    let err = result.expect_err("panic should be converted to error, not hidden as cache miss");

    // The error should wrap a LeaderPanicked error
    assert!(err.is_source::<LeaderPanicked>(), "error should wrap LeaderPanicked, got: {err}");

    // The panic message should be extractable
    let panicked = err.source_as::<LeaderPanicked>().expect("should extract LeaderPanicked");
    assert!(
        panicked.message().contains("simulated panic"),
        "panic message should be preserved: {}",
        panicked.message()
    );
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn stampede_protection_invalidate_removes_entry() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    let key = "key".to_string();
    cache.insert(key.clone(), CacheEntry::new(42)).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_some());

    cache.invalidate(&key).await.unwrap();
    assert!(cache.get(&key).await.unwrap().is_none());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_with_storage_error_propagates() {
    use cachet_tier::{CacheOp, MockCache};

    let clock = Clock::new_frozen();
    let mock = MockCache::<String, i32>::new();
    // Fail on get so do_try_get_or_insert's inner get fails
    mock.fail_when(|op| matches!(op, CacheOp::Get(_)));
    let cache = Cache::builder(clock).storage(mock).build();

    let result: Result<CacheEntry<i32>, Error> = cache.try_get_or_insert("key", || async { Ok::<_, std::io::Error>(42) }).await;
    result.unwrap_err();
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn optionally_get_or_insert_with_storage_error_propagates() {
    use cachet_tier::{CacheOp, MockCache};

    let clock = Clock::new_frozen();
    let mock = MockCache::<String, i32>::new();
    mock.fail_when(|op| matches!(op, CacheOp::Get(_)));
    let cache = Cache::builder(clock).storage(mock).build();

    let result: Result<Option<CacheEntry<i32>>, Error> = cache.optionally_get_or_insert("key", || async { Some(42) }).await;
    result.unwrap_err();
}

#[cfg_attr(miri, ignore)]
#[test]
fn cache_debug_output() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();
    let debug_str = format!("{cache:?}");
    assert!(debug_str.contains("Cache"), "got: {debug_str}");
}

#[cfg_attr(miri, ignore)]
#[test]
fn cache_debug_with_stampede_protection() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();
    let debug_str = format!("{cache:?}");
    assert!(debug_str.contains("Mergers"), "got: {debug_str}");
}

// =============================================================================
// Borrow semantics tests
// =============================================================================

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_get_insert_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    // Use &str keys with Cache<String, i32>
    cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();
    let entry = cache.get("key").await.unwrap().expect("entry should exist");
    assert_eq!(*entry.value(), 42);

    assert!(cache.get("missing").await.unwrap().is_none());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_invalidate_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();
    assert!(cache.contains("key").await.unwrap());

    cache.invalidate("key").await.unwrap();
    assert!(!cache.contains("key").await.unwrap());
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_get_or_insert_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let entry = cache.get_or_insert("key", || async { 42 }).await.unwrap();
    assert_eq!(*entry.value(), 42);

    // Second call returns cached value
    let entry = cache.get_or_insert("key", || async { 100 }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_try_get_or_insert_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let entry = cache.try_get_or_insert("key", || async { Ok::<_, Error>(42) }).await.unwrap();
    assert_eq!(*entry.value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_optionally_get_or_insert_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().build();

    let result = cache.optionally_get_or_insert("missing", || async { None::<i32> }).await.unwrap();
    assert!(result.is_none());

    let result = cache.optionally_get_or_insert("key", || async { Some(42) }).await.unwrap();
    assert_eq!(*result.unwrap().value(), 42);
}

#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn borrow_stampede_protection_with_str_key() {
    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().stampede_protection().build();

    cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();
    let entry = cache.get("key").await.unwrap().expect("entry should exist");
    assert_eq!(*entry.value(), 42);

    cache.invalidate("key").await.unwrap();
    assert!(cache.get("key").await.unwrap().is_none());

    let entry = cache.get_or_insert("new", || async { 77 }).await.unwrap();
    assert_eq!(*entry.value(), 77);
}

// =============================================================================
// Service feature tests
// =============================================================================

#[cfg(feature = "service")]
mod service_tests {
    use cachet::{CacheOperation, CacheResponse, GetRequest, InsertRequest, InvalidateRequest};
    use layered::Service;

    use super::*;

    /// Simple in-memory service implementing Service<CacheOperation>
    #[derive(Clone)]
    struct InMemoryService {
        data: std::sync::Arc<parking_lot::Mutex<std::collections::HashMap<String, CacheEntry<i32>>>>,
    }

    impl InMemoryService {
        fn new() -> Self {
            Self {
                data: std::sync::Arc::new(parking_lot::Mutex::new(std::collections::HashMap::new())),
            }
        }
    }

    impl Service<CacheOperation<String, i32>> for InMemoryService {
        type Out = Result<CacheResponse<i32>, Error>;

        async fn execute(&self, input: CacheOperation<String, i32>) -> Self::Out {
            match input {
                CacheOperation::Get(req) => Ok(CacheResponse::Get(self.data.lock().get(&req.key).cloned())),
                CacheOperation::Insert(req) => {
                    self.data.lock().insert(req.key, req.entry);
                    Ok(CacheResponse::Insert)
                }
                CacheOperation::Invalidate(req) => {
                    self.data.lock().remove(&req.key);
                    Ok(CacheResponse::Invalidate)
                }
                CacheOperation::Clear => {
                    self.data.lock().clear();
                    Ok(CacheResponse::Clear)
                }
            }
        }
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_builder_service_creates_cache() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).service(InMemoryService::new()).build();
        assert!(!cache.name().is_empty());

        // Verify the cache works end-to-end through the service layer
        cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();
        let entry = cache.get(&"key".to_string()).await.unwrap().expect("entry should exist");
        assert_eq!(*entry.value(), 42);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_service_get() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).memory().build();
        cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();

        let response = cache
            .execute(CacheOperation::Get(GetRequest::new("key".to_string())))
            .await
            .unwrap();
        match response {
            CacheResponse::Get(Some(entry)) => assert_eq!(*entry.value(), 42),
            other => panic!("expected Get(Some), got {other:?}"),
        }
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_service_get_miss() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).memory().build();

        let response = cache
            .execute(CacheOperation::Get(GetRequest::new("missing".to_string())))
            .await
            .unwrap();
        match response {
            CacheResponse::Get(None) => {}
            other => panic!("expected Get(None), got {other:?}"),
        }
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_service_insert() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).memory().build();

        let response = cache
            .execute(CacheOperation::Insert(InsertRequest::new("key".to_string(), CacheEntry::new(42))))
            .await
            .unwrap();
        assert!(matches!(response, CacheResponse::Insert));

        // Verify the value was inserted
        let entry = cache.get(&"key".to_string()).await.unwrap().unwrap();
        assert_eq!(*entry.value(), 42);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_service_invalidate() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).memory().build();
        cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();

        let response = cache
            .execute(CacheOperation::Invalidate(InvalidateRequest::new("key".to_string())))
            .await
            .unwrap();
        assert!(matches!(response, CacheResponse::Invalidate));

        assert!(cache.get(&"key".to_string()).await.unwrap().is_none());
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn cache_service_clear() {
        let clock = Clock::new_frozen();
        let cache = Cache::builder::<String, i32>(clock).memory().build();
        cache.insert("key".to_string(), CacheEntry::new(42)).await.unwrap();

        let response = cache.execute(CacheOperation::Clear).await.unwrap();
        assert!(matches!(response, CacheResponse::Clear));

        assert!(cache.get(&"key".to_string()).await.unwrap().is_none());
    }
}

#[cfg(feature = "logs")]
#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn get_or_insert_with_logging_emits_operation_and_events() {
    let capture = testing_aids::LogCapture::new();
    let _guard = tracing::subscriber::set_default(capture.subscriber());

    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().enable_logs().build();

    let _ = cache.get_or_insert(&"k".to_string(), || async { 1 }).await;
    capture.assert_contains("cache.get_or_insert");
    capture.assert_contains("cache.miss");
}

#[cfg(feature = "logs")]
#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn try_get_or_insert_with_logging_emits_operation_and_events() {
    let capture = testing_aids::LogCapture::new();
    let _guard = tracing::subscriber::set_default(capture.subscriber());

    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().enable_logs().build();

    let _ = cache.try_get_or_insert(&"k".to_string(), || async { Ok::<_, Error>(1) }).await;
    capture.assert_contains("cache.try_get_or_insert");
    capture.assert_contains("cache.miss");
}

#[cfg(feature = "logs")]
#[cfg_attr(miri, ignore)]
#[tokio::test]
async fn optionally_get_or_insert_with_logging_emits_operation_and_events() {
    let capture = testing_aids::LogCapture::new();
    let _guard = tracing::subscriber::set_default(capture.subscriber());

    let clock = Clock::new_frozen();
    let cache = Cache::builder::<String, i32>(clock).memory().enable_logs().build();

    let _ = cache.optionally_get_or_insert(&"k".to_string(), || async { Some(1) }).await;
    capture.assert_contains("cache.optionally_get_or_insert");
    capture.assert_contains("cache.miss");
}