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
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
//! Cache Manager - Unified Cache Operations
//!
//! Manages operations across L1 (Moka) and L2 (Redis) caches with intelligent fallback.
use crate::error::CacheResult;
use dashmap::DashMap;
use rand::Rng;
use std::future::Future;
use std::sync::Arc;
use std::sync::atomic::{AtomicU64, AtomicUsize, Ordering};
use std::time::Duration;
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
use tokio::sync::Mutex;
use tokio::sync::broadcast;
use tracing::{debug, error, info, warn};
#[cfg(feature = "moka")]
#[cfg_attr(docsrs, doc(cfg(feature = "moka")))]
use crate::L1Cache;
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
use crate::L2Cache;
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
use crate::invalidation::{
AtomicInvalidationStats, InvalidationConfig, InvalidationMessage, InvalidationPublisher,
InvalidationSubscriber,
};
use crate::serialization::{CacheSerializer, JsonSerializer};
use crate::traits::{CacheBackend, L2CacheBackend, StreamingBackend};
use bytes::Bytes;
use futures_util::future::BoxFuture;
///// Type alias for the in-flight requests map
/// Stores a broadcast sender for each active key computation
type InFlightMap = DashMap<String, broadcast::Sender<CacheResult<Bytes>>>;
/// Cache strategies for different data types
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub enum CacheStrategy {
/// Real-time data - 10 seconds TTL
RealTime,
/// Short-term data - 5 minutes TTL
ShortTerm,
/// Medium-term data - 1 hour TTL
MediumTerm,
/// Long-term data - 3 hours TTL
LongTerm,
/// Custom TTL
Custom(Duration),
/// Default strategy (5 minutes)
Default,
}
impl CacheStrategy {
/// Convert strategy to duration
#[must_use]
pub fn to_duration(&self) -> Duration {
match self {
Self::RealTime => Duration::from_secs(10),
Self::ShortTerm | Self::Default => Duration::from_secs(300), // 5 minutes
Self::MediumTerm => Duration::from_secs(3600), // 1 hour
Self::LongTerm => Duration::from_secs(10800), // 3 hours
Self::Custom(duration) => *duration,
}
}
}
/// Statistics for a single cache tier
#[derive(Debug)]
pub struct TierStats {
/// Tier level (1 = L1, 2 = L2, 3 = L3, etc.)
pub tier_level: usize,
/// Number of cache hits at this tier
pub hits: AtomicU64,
/// Backend name for identification
pub backend_name: String,
}
impl Clone for TierStats {
fn clone(&self) -> Self {
Self {
tier_level: self.tier_level,
hits: AtomicU64::new(self.hits.load(Ordering::Relaxed)),
backend_name: self.backend_name.clone(),
}
}
}
impl TierStats {
fn new(tier_level: usize, backend_name: String) -> Self {
Self {
tier_level,
hits: AtomicU64::new(0),
backend_name,
}
}
/// Get current hit count
pub fn hit_count(&self) -> u64 {
self.hits.load(Ordering::Relaxed)
}
}
/// A single cache tier in the multi-tier architecture
#[derive(Clone)]
pub struct CacheTier {
/// The backend for this tier
pub backend: Arc<dyn L2CacheBackend>,
/// Tier level (1 for fastest, increases for slower/cheaper tiers)
pub tier_level: usize,
/// Whether to promote keys FROM lower tiers TO this tier
pub promotion_enabled: bool,
/// Promotion frequency (N) - promote with 1/N probability
pub promotion_frequency: usize,
/// TTL multiplier for this tier (e.g., L2 might store for 2x L1 TTL)
pub ttl_scale: f64,
/// Statistics for this tier
pub stats: TierStats,
}
impl CacheTier {
/// Create a new cache tier
pub fn new(
backend: Arc<dyn L2CacheBackend>,
tier_level: usize,
promotion_enabled: bool,
promotion_frequency: usize,
ttl_scale: f64,
) -> Self {
let backend_name = backend.name().to_string();
Self {
backend,
tier_level,
promotion_enabled,
promotion_frequency,
ttl_scale,
stats: TierStats::new(tier_level, backend_name),
}
}
/// Get value with TTL from this tier
async fn get_with_ttl(&self, key: &str) -> Option<(Bytes, Option<Duration>)> {
self.backend.get_with_ttl(key).await
}
/// Set value with TTL in this tier
async fn set_with_ttl(&self, key: &str, value: Bytes, ttl: Duration) -> CacheResult<()> {
let scaled_ttl = Duration::from_secs_f64(ttl.as_secs_f64() * self.ttl_scale);
self.backend.set_with_ttl(key, value, scaled_ttl).await
}
/// Remove value from this tier
async fn remove(&self, key: &str) -> CacheResult<()> {
self.backend.remove(key).await
}
/// Record a cache hit for this tier
fn record_hit(&self) {
self.stats.hits.fetch_add(1, Ordering::Relaxed);
}
}
/// Configuration for a cache tier (used in builder pattern)
#[derive(Debug, Clone)]
pub struct TierConfig {
/// Tier level (1, 2, 3, 4...)
pub tier_level: usize,
/// Enable promotion to upper tiers on hit
pub promotion_enabled: bool,
/// Promotion frequency (N) - promote with 1/N probability (default 10)
pub promotion_frequency: usize,
/// TTL scale factor (1.0 = same as base TTL)
pub ttl_scale: f64,
}
impl TierConfig {
/// Create new tier configuration
#[must_use]
pub fn new(tier_level: usize) -> Self {
Self {
tier_level,
promotion_enabled: true,
promotion_frequency: 10,
ttl_scale: 1.0,
}
}
/// Configure as L1 (hot tier)
#[must_use]
pub fn as_l1() -> Self {
Self {
tier_level: 1,
promotion_enabled: false, // L1 is already top tier
promotion_frequency: 1, // Doesn't matter but use 1
ttl_scale: 1.0,
}
}
/// Configure as L2 (warm tier)
#[must_use]
pub fn as_l2() -> Self {
Self {
tier_level: 2,
promotion_enabled: true,
promotion_frequency: 10,
ttl_scale: 1.0,
}
}
/// Configure as L3 (cold tier) with longer TTL
#[must_use]
pub fn as_l3() -> Self {
Self {
tier_level: 3,
promotion_enabled: true,
promotion_frequency: 10,
ttl_scale: 2.0, // Keep data 2x longer
}
}
/// Configure as L4 (archive tier) with much longer TTL
#[must_use]
pub fn as_l4() -> Self {
Self {
tier_level: 4,
promotion_enabled: true,
promotion_frequency: 10,
ttl_scale: 8.0, // Keep data 8x longer
}
}
/// Set promotion enabled
#[must_use]
pub fn with_promotion(mut self, enabled: bool) -> Self {
self.promotion_enabled = enabled;
self
}
/// Set promotion frequency (N)
#[must_use]
pub fn with_promotion_frequency(mut self, n: usize) -> Self {
self.promotion_frequency = n;
self
}
/// Set TTL scale factor
#[must_use]
pub fn with_ttl_scale(mut self, scale: f64) -> Self {
self.ttl_scale = scale;
self
}
/// Set tier level
#[must_use]
pub fn with_level(mut self, level: usize) -> Self {
self.tier_level = level;
self
}
}
pub struct CacheManager {
/// Ordered list of cache tiers (L1, L2, L3, ...)
tiers: Vec<CacheTier>,
/// Optional streaming backend
streaming_backend: Option<Arc<dyn StreamingBackend>>,
/// Statistics
total_requests: AtomicU64,
l1_hits: AtomicU64,
l2_hits: AtomicU64,
misses: AtomicU64,
/// In-flight requests map (Broadcaster integration will replace this in Step 4)
in_flight_requests: Arc<InFlightMap>,
/// Pluggable serializer
serializer: Arc<CacheSerializer>,
/// Invalidation publisher
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
invalidation_publisher: Option<Arc<Mutex<InvalidationPublisher>>>,
/// Invalidation subscriber
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
invalidation_subscriber: Option<Arc<InvalidationSubscriber>>,
/// Invalidation statistics
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
invalidation_stats: Arc<AtomicInvalidationStats>,
/// Number of promotions performed
promotions: AtomicUsize,
}
impl CacheManager {
/// Create new cache manager with trait objects (pluggable backends)
///
/// This is the primary constructor for v0.3.0+, supporting custom cache backends.
///
/// # Arguments
///
/// * `l1_cache` - Any L1 cache backend implementing `CacheBackend` trait
/// * `l2_cache` - Any L2 cache backend implementing `L2CacheBackend` trait
/// * `streaming_backend` - Optional streaming backend (None to disable streaming)
///
/// # Example
///
/// ```rust,ignore
/// use multi_tier_cache::{CacheManager, L1Cache, L2Cache};
/// use std::sync::Arc;
///
/// let l1: Arc<dyn CacheBackend> = Arc::new(L1Cache::new().await?);
/// let l2: Arc<dyn L2CacheBackend> = Arc::new(L2Cache::new().await?);
///
/// let manager = CacheManager::new_with_backends(l1, l2, None).await?;
/// ```
/// # Errors
///
/// Returns `Ok` if successful. Currently no error conditions, but kept for future compatibility.
pub fn new_with_backends(
l1_cache: Arc<dyn CacheBackend>,
l2_cache: Arc<dyn L2CacheBackend>,
streaming_backend: Option<Arc<dyn StreamingBackend>>,
) -> CacheResult<Self> {
debug!("Initializing Cache Manager with L1+L2 backends...");
let tiers = vec![
CacheTier::new(Arc::new(ProxyL1ToL2(l1_cache)), 1, false, 1, 1.0),
CacheTier::new(l2_cache, 2, true, 10, 1.0),
];
Ok(Self {
tiers,
streaming_backend,
total_requests: AtomicU64::new(0),
l1_hits: AtomicU64::new(0),
l2_hits: AtomicU64::new(0),
misses: AtomicU64::new(0),
promotions: AtomicUsize::new(0),
in_flight_requests: Arc::new(DashMap::new()),
serializer: Arc::new(CacheSerializer::Json(JsonSerializer)),
#[cfg(feature = "redis")]
invalidation_publisher: None,
#[cfg(feature = "redis")]
invalidation_subscriber: None,
#[cfg(feature = "redis")]
#[cfg(feature = "redis")]
invalidation_stats: Arc::new(AtomicInvalidationStats::default()),
})
}
/// Create new cache manager with default backends (backward compatible)
///
/// This is the legacy constructor maintained for backward compatibility.
/// New code should prefer `new_with_backends()` or `CacheSystemBuilder`.
///
/// # Arguments
///
/// * `l1_cache` - Moka L1 cache instance
/// * `l2_cache` - Redis L2 cache instance
/// # Errors
///
/// Returns an error if Redis connection fails.
#[cfg(all(feature = "moka", feature = "redis"))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "moka", feature = "redis"))))]
pub async fn new(l1_cache: Arc<L1Cache>, l2_cache: Arc<L2Cache>) -> CacheResult<Self> {
debug!("Initializing Cache Manager...");
// Convert concrete types to trait objects
let l1_backend: Arc<dyn CacheBackend> = l1_cache.clone();
let l2_backend: Arc<dyn L2CacheBackend> = l2_cache.clone();
// Create RedisStreams backend for streaming functionality
let streaming_backend: Option<Arc<dyn StreamingBackend>> = {
let redis_url =
std::env::var("REDIS_URL").unwrap_or_else(|_| "redis://127.0.0.1:6379".to_string());
let redis_streams = crate::redis_streams::RedisStreams::new(&redis_url).await?;
Some(Arc::new(redis_streams))
};
Self::new_with_backends(l1_backend, l2_backend, streaming_backend)
}
/// Create new cache manager with invalidation support
///
/// This constructor enables cross-instance cache invalidation via Redis Pub/Sub.
///
/// # Arguments
///
/// * `l1_cache` - Moka L1 cache instance
/// * `l2_cache` - Redis L2 cache instance
/// * `redis_url` - Redis connection URL for Pub/Sub
/// * `config` - Invalidation configuration
///
/// # Example
///
/// ```rust,ignore
/// use multi_tier_cache::{CacheManager, L1Cache, L2Cache, InvalidationConfig};
///
/// let config = InvalidationConfig {
/// channel: "my_app:cache:invalidate".to_string(),
/// ..Default::default()
/// };
///
/// let manager = CacheManager::new_with_invalidation(
/// l1, l2, "redis://localhost", config
/// ).await?;
/// ```
/// # Errors
///
/// Returns an error if Redis connection fails or invalidation setup fails.
#[cfg(all(feature = "moka", feature = "redis"))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "moka", feature = "redis"))))]
pub async fn new_with_invalidation(
l1_cache: Arc<L1Cache>,
l2_cache: Arc<L2Cache>,
redis_url: &str,
config: InvalidationConfig,
) -> CacheResult<Self> {
debug!("Initializing Cache Manager with Invalidation...");
debug!(" Pub/Sub channel: {}", config.channel);
// Convert concrete types to trait objects
let l1_backend: Arc<dyn CacheBackend> = l1_cache.clone();
let l2_backend: Arc<dyn L2CacheBackend> = l2_cache.clone();
// Create RedisStreams backend for streaming functionality
let streaming_backend: Option<Arc<dyn StreamingBackend>> = {
let redis_streams = crate::redis_streams::RedisStreams::new(redis_url).await?;
Some(Arc::new(redis_streams))
};
// Create publisher
let (invalidation_publisher, invalidation_subscriber) = {
let client = redis::Client::open(redis_url)?;
let conn_manager = redis::aio::ConnectionManager::new(client).await?;
let publisher = InvalidationPublisher::new(conn_manager, config.clone());
// Create subscriber
let subscriber = InvalidationSubscriber::new(redis_url, config.clone())?;
(
Some(Arc::new(Mutex::new(publisher))),
Some(Arc::new(subscriber)),
)
};
let invalidation_stats = Arc::new(AtomicInvalidationStats::default());
let tiers = vec![
CacheTier::new(Arc::new(ProxyL1ToL2(l1_backend)), 1, false, 1, 1.0),
CacheTier::new(l2_backend, 2, true, 10, 1.0),
];
let manager = Self {
tiers,
streaming_backend,
total_requests: AtomicU64::new(0),
l1_hits: AtomicU64::new(0),
l2_hits: AtomicU64::new(0),
misses: AtomicU64::new(0),
promotions: AtomicUsize::new(0),
in_flight_requests: Arc::new(DashMap::new()),
serializer: Arc::new(CacheSerializer::Json(JsonSerializer)),
invalidation_publisher,
invalidation_subscriber,
invalidation_stats,
};
// Start subscriber with handler
manager.start_invalidation_subscriber();
info!("Cache Manager initialized with invalidation support");
Ok(manager)
}
/// Create new cache manager with multi-tier architecture (v0.5.0+)
///
/// This constructor enables dynamic multi-tier caching with 3, 4, or more tiers.
/// Tiers are checked in order (lower `tier_level` = faster/hotter).
///
/// # Arguments
///
/// * `tiers` - Vector of configured cache tiers (must be sorted by `tier_level` ascending)
/// * `streaming_backend` - Optional streaming backend
///
/// # Example
///
/// ```rust,ignore
/// use multi_tier_cache::{CacheManager, CacheTier, TierConfig, L1Cache, L2Cache};
/// use std::sync::Arc;
///
/// // L1 + L2 + L3 setup
/// let l1 = Arc::new(L1Cache::new()?);
/// let l2 = Arc::new(L2Cache::new().await?);
/// let l3 = Arc::new(RocksDBCache::new("/tmp/cache").await?);
///
/// let tiers = vec![
/// CacheTier::new(l1, 1, false, 1.0), // L1 - no promotion
/// CacheTier::new(l2, 2, true, 1.0), // L2 - promote to L1
/// CacheTier::new(l3, 3, true, 2.0), // L3 - promote to L2&L1, 2x TTL
/// ];
///
/// let manager = CacheManager::new_with_tiers(tiers, None).await?;
/// ```
/// # Errors
///
/// Returns an error if tiers are not sorted by level or if no tiers are provided.
pub fn new_with_tiers(
tiers: Vec<CacheTier>,
streaming_backend: Option<Arc<dyn StreamingBackend>>,
) -> CacheResult<Self> {
debug!("Initializing Multi-Tier Cache Manager...");
debug!(" Tier count: {}", tiers.len());
for tier in &tiers {
debug!(
" L{}: {} (promotion={}, ttl_scale={})",
tier.tier_level, tier.stats.backend_name, tier.promotion_enabled, tier.ttl_scale
);
}
// Validate tiers are sorted by level
for i in 1..tiers.len() {
if let (Some(current), Some(prev)) = (tiers.get(i), tiers.get(i - 1))
&& current.tier_level <= prev.tier_level
{
return Err(crate::error::CacheError::ConfigError(format!(
"Tiers must be sorted by tier_level ascending (found L{} after L{})",
current.tier_level, prev.tier_level
)));
}
}
Ok(Self {
tiers,
streaming_backend,
total_requests: AtomicU64::new(0),
l1_hits: AtomicU64::new(0),
l2_hits: AtomicU64::new(0),
misses: AtomicU64::new(0),
promotions: AtomicUsize::new(0),
in_flight_requests: Arc::new(DashMap::new()),
serializer: Arc::new(CacheSerializer::Json(JsonSerializer)),
#[cfg(feature = "redis")]
invalidation_publisher: None,
#[cfg(feature = "redis")]
invalidation_subscriber: None,
#[cfg(feature = "redis")]
#[cfg(feature = "redis")]
invalidation_stats: Arc::new(AtomicInvalidationStats::default()),
})
}
/// Set a custom serializer for the cache manager
pub fn set_serializer(&mut self, serializer: CacheSerializer) {
debug!(name = %serializer.name(), "Switching cache serializer");
self.serializer = Arc::new(serializer);
}
/// Start the invalidation subscriber background task
#[cfg(feature = "redis")]
#[cfg_attr(docsrs, doc(cfg(feature = "redis")))]
fn start_invalidation_subscriber(&self) {
#[cfg(feature = "redis")]
if let Some(subscriber) = &self.invalidation_subscriber {
let tiers = self.tiers.clone();
subscriber.start(move |msg: crate::invalidation::InvalidationMessage| {
let tiers = tiers.clone();
async move {
for tier in &tiers {
match &msg {
InvalidationMessage::Remove { key } => {
tier.backend.remove(key).await.ok();
}
InvalidationMessage::Update {
key,
value,
ttl_secs,
} => {
if let Some(secs) = ttl_secs {
tier.backend
.set_with_ttl(
key,
value.clone(),
Duration::from_secs(*secs),
)
.await
.ok();
} else {
tier.backend.set(key, value.clone()).await.ok();
}
}
InvalidationMessage::RemovePattern { pattern } => {
if let Err(e) = tier.backend.remove_pattern(pattern).await {
warn!(
"Failed to remove pattern '{}' from L{}: {}",
pattern, tier.tier_level, e
);
}
}
InvalidationMessage::RemoveBulk { keys } => {
for key in keys {
if let Err(e) = tier.backend.remove(key).await {
warn!(
"Failed to remove '{}' from L{}: {}",
key, tier.tier_level, e
);
}
}
}
}
}
Ok(())
}
});
info!("Invalidation subscriber started across all tiers");
}
}
/// Get value from cache using multi-tier architecture (v0.5.0+)
///
/// This method iterates through all configured tiers and automatically promotes
/// to upper tiers on cache hit.
async fn get_multi_tier(&self, key: &str) -> CacheResult<Option<Bytes>> {
// Try each tier sequentially (sorted by tier_level)
for (tier_index, tier) in self.tiers.iter().enumerate() {
if let Some((value, ttl)) = tier.get_with_ttl(key).await {
// Cache hit!
tier.record_hit();
// Promote to all upper tiers (if promotion enabled)
if tier.promotion_enabled && tier_index > 0 {
// Probabilistic Promotion Check
let should_promote = if tier.promotion_frequency <= 1 {
true
} else {
rand::thread_rng().gen_ratio(
1,
u32::try_from(tier.promotion_frequency).unwrap_or(u32::MAX),
)
};
if should_promote {
let promotion_ttl =
ttl.unwrap_or_else(|| CacheStrategy::Default.to_duration());
// Promote to all tiers above this one
for upper_tier in self.tiers.iter().take(tier_index).rev() {
if let Err(e) = upper_tier
.set_with_ttl(key, value.clone(), promotion_ttl)
.await
{
warn!(
"Failed to promote '{}' from L{} to L{}: {}",
key, tier.tier_level, upper_tier.tier_level, e
);
} else {
self.promotions.fetch_add(1, Ordering::Relaxed);
debug!(
"Promoted '{}' from L{} to L{} (TTL: {:?})",
key, tier.tier_level, upper_tier.tier_level, promotion_ttl
);
}
}
} else {
debug!(
"Probabilistic skip promotion for '{}' from L{} (N={})",
key, tier.tier_level, tier.promotion_frequency
);
}
}
return Ok(Some(value));
}
}
// Cache miss across all tiers
Ok(None)
}
/// Get value from cache (L1 first, then L2 fallback with promotion)
///
/// This method now includes built-in Cache Stampede protection when cache misses occur.
/// Multiple concurrent requests for the same missing key will be coalesced to prevent
/// unnecessary duplicate work on external data sources.
///
/// Supports both legacy 2-tier mode and new multi-tier mode (v0.5.0+).
///
/// # Arguments
/// * `key` - Cache key to retrieve
///
/// # Returns
/// * `Ok(Some(value))` - Cache hit, value found in any tier
/// * `Ok(None)` - Cache miss, value not found in any cache
/// * `Err(error)` - Cache operation failed
/// # Errors
///
/// Returns an error if cache operation fails.
///
/// # Panics
///
/// Panics if tiers are not initialized in multi-tier mode (should not happen if constructed correctly).
pub async fn get(&self, key: &str) -> CacheResult<Option<Bytes>> {
self.total_requests.fetch_add(1, Ordering::Relaxed);
// Fast path for L1 (first tier) - no locking needed
if let Some(tier1) = self.tiers.first()
&& let Some((value, _ttl)) = tier1.get_with_ttl(key).await
{
tier1.record_hit();
// Update legacy stats for backward compatibility
self.l1_hits.fetch_add(1, Ordering::Relaxed);
return Ok(Some(value));
}
// L1 miss - use stampede protection for lower tiers
let key_owned = key.to_string();
let lock_guard = self
.in_flight_requests
.entry(key_owned.clone())
.or_insert_with(|| broadcast::Sender::new(1))
.clone();
let mut rx = lock_guard.subscribe();
// If there are other receivers, someone else is computing, wait for it
if lock_guard.receiver_count() > 1 {
match rx.recv().await {
Ok(Ok(value)) => return Ok(Some(value)),
Ok(Err(e)) => {
return Err(crate::error::CacheError::BackendError(format!(
"Computation failed in another thread: {e}"
)));
}
Err(_) => {} // Fall through to re-compute if sender dropped or channel empty
}
}
// Double-check L1 after acquiring lock (or if we are the first to compute)
if let Some(tier1) = self.tiers.first()
&& let Some((value, _ttl)) = tier1.get_with_ttl(key).await
{
tier1.record_hit();
self.l1_hits.fetch_add(1, Ordering::Relaxed);
let _ = lock_guard.send(Ok(value.clone())); // Notify any waiting subscribers
return Ok(Some(value));
}
// Check remaining tiers with promotion
let result = self.get_multi_tier(key).await?;
if let Some(val) = result.clone() {
// Hit in L2+ tier - update legacy stats
if self.tiers.len() >= 2 {
self.l2_hits.fetch_add(1, Ordering::Relaxed);
}
// Notify any waiting subscribers
let _ = lock_guard.send(Ok(val.clone()));
// Remove the in-flight entry after computation/retrieval
self.in_flight_requests.remove(key);
Ok(Some(val))
} else {
self.misses.fetch_add(1, Ordering::Relaxed);
// Remove the in-flight entry after computation/retrieval
self.in_flight_requests.remove(key);
Ok(None)
}
}
/// Get a value from cache and deserialize it (Type-Safe Version)
///
/// # Errors
///
/// Returns a `SerializationError` if deserialization fails, or a `BackendError` if the cache retrieval fails.
pub async fn get_typed<T>(&self, key: &str) -> CacheResult<Option<T>>
where
T: serde::de::DeserializeOwned,
{
if let Some(bytes) = self.get(key).await? {
return Ok(Some(self.serializer.deserialize::<T>(&bytes)?));
}
Ok(None)
}
/// Set value with specific cache strategy (all tiers)
///
/// Supports both legacy 2-tier mode and new multi-tier mode (v0.5.0+).
/// In multi-tier mode, stores to ALL tiers with their respective TTL scaling.
/// # Errors
///
/// Returns an error if cache set operation fails.
pub async fn set_with_strategy(
&self,
key: &str,
value: Bytes,
strategy: CacheStrategy,
) -> CacheResult<()> {
let ttl = strategy.to_duration();
let mut success_count = 0;
let mut last_error = None;
for tier in &self.tiers {
match tier.set_with_ttl(key, value.clone(), ttl).await {
Ok(()) => {
success_count += 1;
}
Err(e) => {
error!(
"L{} cache set failed for key '{}': {}",
tier.tier_level, key, e
);
last_error = Some(e);
}
}
}
if success_count > 0 {
debug!(
"[Cache] Stored '{}' in {}/{} tiers (base TTL: {:?})",
key,
success_count,
self.tiers.len(),
ttl
);
return Ok(());
}
Err(last_error.unwrap_or_else(|| {
crate::error::CacheError::InternalError("All tiers failed".to_string())
}))
}
/// Get or compute value with Cache Stampede protection across L1+L2+Compute
///
/// This method provides comprehensive Cache Stampede protection:
/// 1. Check L1 cache first (uses Moka's built-in coalescing)
/// 2. Check L2 cache with mutex-based coalescing
/// 3. Compute fresh data with protection against concurrent computations
///
/// # Arguments
/// * `key` - Cache key
/// * `strategy` - Cache strategy for TTL and storage behavior
/// * `compute_fn` - Async function to compute the value if not in any cache
///
/// # Example
/// ```ignore
/// let api_data = cache_manager.get_or_compute_with(
/// "api_response",
/// CacheStrategy::RealTime,
/// || async {
/// fetch_data_from_api().await
/// }
/// ).await?;
/// ```
#[allow(dead_code)]
/// # Errors
///
/// Returns an error if compute function fails or cache operations fail.
pub async fn get_or_compute_with<F, Fut>(
&self,
key: &str,
strategy: CacheStrategy,
compute_fn: F,
) -> CacheResult<Bytes>
where
F: FnOnce() -> Fut + Send,
Fut: Future<Output = CacheResult<Bytes>> + Send,
{
self.total_requests.fetch_add(1, Ordering::Relaxed);
// 1. Try tiers sequentially first
for (idx, tier) in self.tiers.iter().enumerate() {
if let Some((value, _ttl)) = tier.get_with_ttl(key).await {
tier.record_hit();
if tier.tier_level == 1 {
self.l1_hits.fetch_add(1, Ordering::Relaxed);
} else if tier.tier_level == 2 {
self.l2_hits.fetch_add(1, Ordering::Relaxed);
}
// Promotion to L1 if hit was in a lower tier
if idx > 0 && tier.promotion_enabled {
// Probabilistic Promotion Check
let should_promote = if tier.promotion_frequency <= 1 {
true
} else {
rand::thread_rng().gen_ratio(
1,
u32::try_from(tier.promotion_frequency).unwrap_or(u32::MAX),
)
};
if should_promote && let Some(l1_tier) = self.tiers.first() {
let _ = l1_tier
.set_with_ttl(key, value.clone(), strategy.to_duration())
.await;
self.promotions.fetch_add(1, Ordering::Relaxed);
}
}
return Ok(value);
}
}
// 2. Cache miss across all tiers - use stampede protection
let (tx, mut rx): (
tokio::sync::broadcast::Sender<CacheResult<Bytes>>,
tokio::sync::broadcast::Receiver<CacheResult<Bytes>>,
) = match self.in_flight_requests.entry(key.to_string()) {
dashmap::mapref::entry::Entry::Occupied(entry) => {
let tx = entry.get().clone();
(tx.clone(), tx.subscribe())
}
dashmap::mapref::entry::Entry::Vacant(entry) => {
let (tx, _) = tokio::sync::broadcast::channel(1);
entry.insert(tx.clone());
(tx.clone(), tx.subscribe())
}
};
if tx.receiver_count() > 1 {
// Someone else is computing, wait for it
match rx.recv().await {
Ok(Ok(value)) => return Ok(value),
Ok(Err(e)) => {
return Err(crate::error::CacheError::BackendError(format!(
"Computation failed in another thread: {e}"
)));
}
Err(_) => {} // Fall through to re-compute
}
}
// 3. Re-check cache after receiving/creating broadcaster (double-check pattern)
for tier in &self.tiers {
if let Some((value, _)) = tier.get_with_ttl(key).await {
let _ = tx.send(Ok(value.clone()));
return Ok(value);
}
}
// 4. Miss - compute fresh data
debug!(
"Computing fresh data for key: '{}' (Stampede protected)",
key
);
let result = compute_fn().await;
// Remove from in_flight BEFORE broadcasting
self.in_flight_requests.remove(key);
match &result {
Ok(value) => {
let _ = self.set_with_strategy(key, value.clone(), strategy).await;
let _ = tx.send(Ok(value.clone()));
}
Err(e) => {
let _ = tx.send(Err(e.clone()));
}
}
result
}
/// Get or compute typed value with Cache Stampede protection (Type-Safe Version)
///
/// This method provides the same functionality as `get_or_compute_with()` but with
/// **type-safe** automatic serialization/deserialization. Perfect for database queries,
/// API calls, or any computation that returns structured data.
///
/// # Type Safety
///
/// - Returns your actual type `T` instead of `serde_json::Value`
/// - Compiler enforces Serialize + `DeserializeOwned` bounds
/// - No manual JSON conversion needed
///
/// # Cache Flow
///
/// 1. Check L1 cache → deserialize if found
/// 2. Check L2 cache → deserialize + promote to L1 if found
/// 3. Execute `compute_fn` → serialize → store in L1+L2
/// 4. Full stampede protection (only ONE request computes)
///
/// # Arguments
///
/// * `key` - Cache key
/// * `strategy` - Cache strategy for TTL
/// * `compute_fn` - Async function returning `Result<T>`
///
/// # Example - Database Query
///
/// ```no_run
/// # use multi_tier_cache::{CacheManager, CacheStrategy, L1Cache, L2Cache, MokaCacheConfig};
/// # use std::sync::Arc;
/// # use serde::{Serialize, Deserialize};
/// # async fn example() -> anyhow::Result<()> {
/// # let l1 = Arc::new(L1Cache::new(MokaCacheConfig::default())?);
/// # let l2 = Arc::new(L2Cache::new().await?);
/// # let cache_manager = CacheManager::new(l1, l2);
///
/// #[derive(Serialize, Deserialize)]
/// struct User {
/// id: i64,
/// name: String,
/// }
///
/// // Type-safe database caching (example - requires sqlx)
/// // let user: User = cache_manager.get_or_compute_typed(
/// // "user:123",
/// // CacheStrategy::MediumTerm,
/// // || async {
/// // sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
/// // .bind(123)
/// // .fetch_one(&pool)
/// // .await
/// // }
/// // ).await?;
/// # Ok(())
/// # }
/// ```
///
/// # Example - API Call
///
/// ```no_run
/// # use multi_tier_cache::{CacheManager, CacheStrategy, L1Cache, L2Cache, MokaCacheConfig};
/// # use std::sync::Arc;
/// # use serde::{Serialize, Deserialize};
/// # async fn example() -> anyhow::Result<()> {
/// # let l1 = Arc::new(L1Cache::new(MokaCacheConfig::default())?);
/// # let l2 = Arc::new(L2Cache::new().await?);
/// # let cache_manager = CacheManager::new(l1, l2);
/// #[derive(Serialize, Deserialize)]
/// struct ApiResponse {
/// data: String,
/// timestamp: i64,
/// }
///
/// // API call caching (example - requires reqwest)
/// // let response: ApiResponse = cache_manager.get_or_compute_typed(
/// // "api:endpoint",
/// // CacheStrategy::RealTime,
/// // || async {
/// // reqwest::get("https://api.example.com/data")
/// // .await?
/// // .json::<ApiResponse>()
/// // .await
/// // }
/// // ).await?;
/// # Ok(())
/// # }
/// ```
///
/// # Performance
///
/// - L1 hit: <1ms + deserialization (~10-50μs for small structs)
/// - L2 hit: 2-5ms + deserialization + L1 promotion
/// - Compute: Your function time + serialization + L1+L2 storage
/// - Stampede protection: 99.6% latency reduction under high concurrency
///
/// # Errors
///
/// Returns error if:
/// - Compute function fails
/// - Serialization fails (invalid type for JSON)
/// - Deserialization fails (cache data doesn't match type T)
/// - Cache operations fail (Redis connection issues)
#[allow(clippy::too_many_lines)]
pub async fn get_or_compute_typed<T, F, Fut>(
&self,
key: &str,
strategy: CacheStrategy,
compute_fn: F,
) -> CacheResult<T>
where
T: serde::Serialize + serde::de::DeserializeOwned + Send + Sync + 'static,
F: FnOnce() -> Fut + Send,
Fut: Future<Output = CacheResult<T>> + Send,
{
// 1. Try to get typed from cache first
if let Some(value) = self.get_typed::<T>(key).await? {
return Ok(value);
}
// 2. Use get_or_compute_with to handle stampede protection
let serializer = self.serializer.clone();
let bytes_result = self
.get_or_compute_with(key, strategy, || async move {
let val = compute_fn().await?;
serializer.serialize(&val)
})
.await?;
// 3. Deserialize result
self.serializer.deserialize::<T>(&bytes_result)
}
/// Get comprehensive cache statistics
///
/// In multi-tier mode, aggregates statistics from all tiers.
/// In legacy mode, returns L1 and L2 stats.
#[allow(dead_code)]
pub fn get_stats(&self) -> CacheManagerStats {
let total_reqs = self.total_requests.load(Ordering::Relaxed);
let l1_hits = self.l1_hits.load(Ordering::Relaxed);
let l2_hits = self.l2_hits.load(Ordering::Relaxed);
let misses = self.misses.load(Ordering::Relaxed);
CacheManagerStats {
total_requests: total_reqs,
l1_hits,
l2_hits,
total_hits: l1_hits + l2_hits,
misses,
hit_rate: if total_reqs > 0 {
#[allow(clippy::cast_precision_loss)]
{
((l1_hits + l2_hits) as f64 / total_reqs as f64) * 100.0
}
} else {
0.0
},
l1_hit_rate: if total_reqs > 0 {
#[allow(clippy::cast_precision_loss)]
{
(l1_hits as f64 / total_reqs as f64) * 100.0
}
} else {
0.0
},
promotions: self.promotions.load(Ordering::Relaxed),
in_flight_requests: self.in_flight_requests.len(),
}
}
/// Get per-tier statistics (v0.5.0+)
///
/// Returns statistics for each tier if multi-tier mode is enabled.
/// Returns None if using legacy 2-tier mode.
///
/// # Example
/// ```rust,ignore
/// if let Some(tier_stats) = cache_manager.get_tier_stats() {
/// for stats in tier_stats {
/// println!("L{}: {} hits ({})",
/// stats.tier_level,
/// stats.hit_count(),
/// stats.backend_name);
/// }
/// }
/// ```
pub fn get_tier_stats(&self) -> Vec<TierStats> {
self.tiers.iter().map(|tier| tier.stats.clone()).collect()
}
}
/// Proxy wrapper to allow using `CacheBackend` where `DynL2CacheBackend` is expected
/// (Internal helper for `new_with_backends` to wrap L1 `CacheBackend` into `DynL2CacheBackend`)
struct ProxyL1ToL2(Arc<dyn CacheBackend>);
impl CacheBackend for ProxyL1ToL2 {
fn get<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Option<Bytes>> {
self.0.get(key)
}
fn set_with_ttl<'a>(
&'a self,
key: &'a str,
value: Bytes,
ttl: Duration,
) -> BoxFuture<'a, CacheResult<()>> {
self.0.set_with_ttl(key, value, ttl)
}
fn remove<'a>(&'a self, key: &'a str) -> BoxFuture<'a, CacheResult<()>> {
self.0.remove(key)
}
fn remove_pattern<'a>(&'a self, pattern: &'a str) -> BoxFuture<'a, CacheResult<()>> {
self.0.remove_pattern(pattern)
}
fn health_check(&self) -> BoxFuture<'_, bool> {
self.0.health_check()
}
fn name(&self) -> &'static str {
self.0.name()
}
}
impl L2CacheBackend for ProxyL1ToL2 {
fn get_with_ttl<'a>(
&'a self,
key: &'a str,
) -> BoxFuture<'a, Option<(Bytes, Option<Duration>)>> {
Box::pin(async move { self.0.get(key).await.map(|v| (v, None)) })
}
}
impl CacheManager {
// ===== Redis Streams Methods =====
/// Publish data to Redis Stream
///
/// # Arguments
/// * `stream_key` - Name of the stream (e.g., "`events_stream`")
/// * `fields` - Field-value pairs to publish
/// * `maxlen` - Optional max length for stream trimming
///
/// # Returns
/// The entry ID generated by Redis
///
/// # Errors
/// Returns error if streaming backend is not configured
pub async fn publish_to_stream(
&self,
stream_key: &str,
fields: Vec<(String, String)>,
maxlen: Option<usize>,
) -> CacheResult<String> {
match &self.streaming_backend {
Some(backend) => backend.stream_add(stream_key, fields, maxlen).await,
None => Err(crate::error::CacheError::ConfigError(
"Streaming backend not configured".to_string(),
)),
}
}
/// Read latest entries from Redis Stream
///
/// # Arguments
/// * `stream_key` - Name of the stream
/// * `count` - Number of latest entries to retrieve
///
/// # Returns
/// Vector of (`entry_id`, fields) tuples (newest first)
///
/// # Errors
/// Returns error if streaming backend is not configured
pub async fn read_stream_latest(
&self,
stream_key: &str,
count: usize,
) -> CacheResult<Vec<(String, Vec<(String, String)>)>> {
match &self.streaming_backend {
Some(backend) => backend
.stream_read_latest(stream_key, count)
.await,
None => Err(crate::error::CacheError::ConfigError(
"Streaming backend not configured".to_string(),
)),
}
}
/// Read from Redis Stream with optional blocking
///
/// # Arguments
/// * `stream_key` - Name of the stream
/// * `last_id` - Last ID seen ("0" for start, "$" for new only)
/// * `count` - Max entries to retrieve
/// * `block_ms` - Optional blocking timeout in ms
///
/// # Returns
/// Vector of (`entry_id`, fields) tuples
///
/// # Errors
/// Returns error if streaming backend is not configured
pub async fn read_stream(
&self,
stream_key: &str,
last_id: &str,
count: usize,
block_ms: Option<usize>,
) -> CacheResult<Vec<(String, Vec<(String, String)>)>> {
match &self.streaming_backend {
Some(backend) => {
backend
.stream_read(stream_key, last_id, count, block_ms)
.await
}
None => Err(crate::error::CacheError::ConfigError(
"Streaming backend not configured".to_string(),
)),
}
}
// ===== Cache Invalidation Methods =====
/// Invalidate a cache key across all instances
///
/// This removes the key from all cache tiers and broadcasts
/// the invalidation to all other cache instances via Redis Pub/Sub.
///
/// Supports both legacy 2-tier mode and new multi-tier mode (v0.5.0+).
///
/// # Arguments
/// * `key` - Cache key to invalidate
///
/// # Example
/// ```rust,no_run
/// # use multi_tier_cache::CacheManager;
/// # async fn example(cache_manager: &CacheManager) -> anyhow::Result<()> {
/// // Invalidate user cache after profile update
/// cache_manager.invalidate("user:123").await?;
/// # Ok(())
/// # }
/// ```
/// # Errors
///
/// Returns an error if invalidation fails.
pub async fn invalidate(&self, key: &str) -> CacheResult<()> {
// Remove from ALL tiers
for tier in &self.tiers {
if let Err(e) = tier.remove(key).await {
warn!(
"Failed to remove '{}' from L{}: {}",
key, tier.tier_level, e
);
}
}
// Broadcast to other instances
#[cfg(feature = "redis")]
{
if let Some(publisher) = &self.invalidation_publisher {
let mut pub_lock: tokio::sync::MutexGuard<
'_,
crate::invalidation::InvalidationPublisher,
> = publisher.lock().await;
let msg = InvalidationMessage::remove(key);
pub_lock.publish(&msg).await?;
self.invalidation_stats
.messages_sent
.fetch_add(1, Ordering::Relaxed);
}
}
debug!("Invalidated '{}' across all instances", key);
Ok(())
}
/// Update cache value across all instances
///
/// This updates the key in all cache tiers and broadcasts
/// the update to all other cache instances, avoiding cache misses.
///
/// Supports both legacy 2-tier mode and new multi-tier mode (v0.5.0+).
///
/// # Arguments
/// * `key` - Cache key to update
/// * `value` - New value
/// * `ttl` - Optional TTL (uses default if None)
///
/// # Example
/// ```rust,no_run
/// # use multi_tier_cache::CacheManager;
/// # use std::time::Duration;
/// # use bytes::Bytes;
/// # async fn example(cache_manager: &CacheManager) -> anyhow::Result<()> {
/// // Update user cache with new data
/// let user_data = Bytes::from("alice");
/// cache_manager.update_cache("user:123", user_data, Some(Duration::from_secs(3600))).await?;
/// # Ok(())
/// # }
/// ```
/// # Errors
///
/// Returns an error if cache update fails.
pub async fn update_cache(
&self,
key: &str,
value: Bytes,
ttl: Option<Duration>,
) -> CacheResult<()> {
let ttl = ttl.unwrap_or_else(|| CacheStrategy::Default.to_duration());
// Update ALL tiers
for tier in &self.tiers {
if let Err(e) = tier.set_with_ttl(key, value.clone(), ttl).await {
warn!("Failed to update '{}' in L{}: {}", key, tier.tier_level, e);
}
}
// Broadcast update to other instances
#[cfg(feature = "redis")]
if let Some(publisher) = &self.invalidation_publisher {
let mut pub_lock = publisher.lock().await;
let msg = InvalidationMessage::update(key, value, Some(ttl));
pub_lock.publish(&msg).await?;
self.invalidation_stats
.messages_sent
.fetch_add(1, Ordering::Relaxed);
}
debug!("Updated '{}' across all instances", key);
Ok(())
}
/// Invalidate all keys matching a pattern
///
/// This scans L2 cache for keys matching the pattern, removes them from all tiers,
/// and broadcasts the invalidation. L1 caches will be cleared via broadcast.
///
/// Supports both legacy 2-tier mode and new multi-tier mode (v0.5.0+).
///
/// **Note**: Pattern scanning requires a concrete `L2Cache` instance with `scan_keys()`.
/// In multi-tier mode, this scans from L2 but removes from all tiers.
///
/// # Arguments
/// * `pattern` - Glob-style pattern (e.g., "user:*", "product:123:*")
///
/// # Example
/// ```rust,no_run
/// # use multi_tier_cache::CacheManager;
/// # async fn example(cache_manager: &CacheManager) -> anyhow::Result<()> {
/// // Invalidate all user caches
/// cache_manager.invalidate_pattern("user:*").await?;
///
/// // Invalidate specific user's related caches
/// cache_manager.invalidate_pattern("user:123:*").await?;
/// # Ok(())
/// # }
/// ```
/// # Errors
///
/// Returns an error if invalidation fails.
pub async fn invalidate_pattern(&self, pattern: &str) -> CacheResult<()> {
debug!(pattern = %pattern, "Invalidating pattern across all tiers");
// 1. Invalidate in all configured tiers
for tier in &self.tiers {
debug!(tier = %tier.tier_level, "Invalidating pattern in tier");
tier.backend.remove_pattern(pattern).await?;
}
// 2. Broadcast invalidation if publisher is configured
#[cfg(feature = "redis")]
{
if let Some(publisher) = &self.invalidation_publisher {
let msg = InvalidationMessage::remove_pattern(pattern);
publisher.lock().await.publish(&msg).await?;
debug!(pattern = %pattern, "Broadcasted pattern invalidation");
}
}
Ok(())
}
/// Set value with automatic broadcast to all instances
///
/// This is a write-through operation that updates the cache and
/// broadcasts the update to all other instances automatically.
///
/// # Arguments
/// * `key` - Cache key
/// * `value` - Value to cache
/// * `strategy` - Cache strategy (determines TTL)
///
/// # Example
/// ```rust,no_run
/// # use multi_tier_cache::{CacheManager, CacheStrategy};
/// # use bytes::Bytes;
/// # async fn example(cache_manager: &CacheManager) -> anyhow::Result<()> {
/// // Update and broadcast in one call
/// let data = Bytes::from("active");
/// cache_manager.set_with_broadcast("user:123", data, CacheStrategy::MediumTerm).await?;
/// # Ok(())
/// # }
/// ```
/// # Errors
///
/// Returns an error if cache set or broadcast fails.
pub async fn set_with_broadcast(
&self,
key: &str,
value: Bytes,
strategy: CacheStrategy,
) -> CacheResult<()> {
#[cfg(feature = "redis")] let ttl = strategy.to_duration();
// Set in local caches
self.set_with_strategy(key, value.clone(), strategy).await?;
// Broadcast update if invalidation is enabled
#[cfg(feature = "redis")]
if let Some(publisher) = &self.invalidation_publisher {
let mut pub_lock = publisher.lock().await;
let msg = InvalidationMessage::update(key, value, Some(ttl));
pub_lock.publish(&msg).await?;
self.invalidation_stats
.messages_sent
.fetch_add(1, Ordering::Relaxed);
}
Ok(())
}
/// Get invalidation statistics
///
/// Returns statistics about invalidation operations if invalidation is enabled.
#[cfg(feature = "redis")]
pub fn invalidation_stats(&self) -> Option<crate::invalidation::InvalidationStats> {
#[cfg(feature = "redis")]
{
Some(self.invalidation_stats.snapshot())
}
#[cfg(not(feature = "redis"))]
{
None
}
}
}
/// Cache Manager statistics
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct CacheManagerStats {
pub total_requests: u64,
pub l1_hits: u64,
pub l2_hits: u64,
pub total_hits: u64,
pub misses: u64,
pub hit_rate: f64,
pub l1_hit_rate: f64,
pub promotions: usize,
pub in_flight_requests: usize,
}