oxcache 0.1.4

A high-performance multi-level cache library for Rust with L1 (memory) and L2 (Redis) caching.
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
//! Copyright (c) 2025-2026, Kirky.X
//!
//! MIT License
//!
//! Tiered cache backend with L1 (memory) and L2 (Redis) layers

use super::new_backend::CacheBackend;
use crate::error::{CacheError, Result};
use async_trait::async_trait;
use std::collections::HashMap;
use std::sync::Arc;
use std::time::Duration;

/// Tiered cache backend with L1 (memory) and L2 (Redis)
///
/// This backend implements a two-tier caching strategy:
/// - L1: Fast in-memory cache (Moka)
/// - L2: Distributed Redis cache
///
/// Read operations check L1 first, then L2 on miss.
/// Write operations update both L1 and L2.
/// L1 is automatically populated from L2 on cache misses.
///
/// # Example
///
/// ```rust,ignore
/// use oxcache::backend::{TieredBackend, MemoryBackend};
/// use std::sync::Arc;
///
/// // Create with default settings
/// let l1 = MemoryBackend::new();
/// let l2 = MemoryBackend::new(); // or RedisBackend::new("redis://...").await?
/// let backend = TieredBackend::new(l1, l2);
///
/// // Create with custom settings
/// let backend = TieredBackend::builder()
///     .l1(MemoryBackend::builder().capacity(10000).build())
///     .auto_promote(true)
///     .build();
/// ```
#[derive(Clone)]
pub struct TieredBackend {
    l1: Arc<dyn CacheBackend>,
    l2: Arc<dyn CacheBackend>,
    auto_promote: bool,
    degraded: Arc<tokio::sync::RwLock<bool>>,
}

impl TieredBackend {
    /// Create a new tiered backend
    ///
    /// # Arguments
    ///
    /// * `l1` - L1 (memory) backend
    /// * `l2` - L2 (backend)
    ///
    /// # Returns
    ///
    /// Configured TieredBackend instance
    pub fn new(l1: impl CacheBackend + 'static, l2: impl CacheBackend + 'static) -> Self {
        Self {
            l1: Arc::new(l1),
            l2: Arc::new(l2),
            auto_promote: true,
            degraded: Arc::new(tokio::sync::RwLock::new(false)),
        }
    }

    /// Create a tiered backend from Arc<dyn CacheBackend>
    ///
    /// This is useful when the backends are created dynamically.
    pub fn from_arc(l1: Arc<dyn CacheBackend>, l2: Arc<dyn CacheBackend>) -> Self {
        Self {
            l1,
            l2,
            auto_promote: true,
            degraded: Arc::new(tokio::sync::RwLock::new(false)),
        }
    }

    /// Create a new builder for configuring the tiered backend
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use oxcache::backend::{TieredBackend, MemoryBackend, RedisBackend};
    ///
    /// let backend = TieredBackend::builder()
    ///     .l1(MemoryBackend::builder().capacity(10000).build())
    ///     .l2(RedisBackend::new("redis://localhost:6379").await?)
    ///     .auto_promote(true)
    ///     .build();
    /// ```
    pub fn builder() -> TieredBackendBuilder {
        TieredBackendBuilder::default()
    }

    /// Check if the backend is in degraded mode
    ///
    /// Returns true if L2 is unavailable and the backend is operating
    /// in L1-only mode.
    pub async fn is_degraded(&self) -> bool {
        *self.degraded.read().await
    }

    /// Set degraded mode
    async fn set_degraded(&self, degraded: bool) {
        *self.degraded.write().await = degraded;
    }
}

/// Builder for TieredBackend
#[derive(Default)]
pub struct TieredBackendBuilder {
    l1: Option<Arc<dyn CacheBackend>>,
    l2: Option<Arc<dyn CacheBackend>>,
    auto_promote: bool,
}

impl TieredBackendBuilder {
    /// Set the L1 (memory) backend
    ///
    /// # Arguments
    ///
    /// * `l1` - L1 backend instance
    ///
    /// # Returns
    ///
    /// Self for method chaining
    pub fn l1(mut self, l1: impl CacheBackend + 'static) -> Self {
        self.l1 = Some(Arc::new(l1));
        self
    }

    /// Set the L2 (Redis) backend
    ///
    /// # Arguments
    ///
    /// * `l2` - L2 backend instance
    ///
    /// # Returns
    ///
    /// Self for method chaining
    pub fn l2(mut self, l2: impl CacheBackend + 'static) -> Self {
        self.l2 = Some(Arc::new(l2));
        self
    }

    /// Enable or disable auto-promote
    ///
    /// When enabled, values from L2 are automatically promoted to L1 on cache misses.
    ///
    /// # Arguments
    ///
    /// * `auto_promote` - Whether to enable auto-promote (default: true)
    ///
    /// # Returns
    ///
    /// Self for method chaining
    pub fn auto_promote(mut self, auto_promote: bool) -> Self {
        self.auto_promote = auto_promote;
        self
    }

    /// Build the tiered backend
    ///
    /// # Returns
    ///
    /// Configured TieredBackend instance
    ///
    /// # Errors
    ///
    /// Returns `CacheError` if L1 or L2 backend is not set
    pub fn build(self) -> Result<TieredBackend> {
        let l1 = self
            .l1
            .ok_or_else(|| CacheError::ConfigError("L1 backend is required".to_string()))?;
        let l2 = self
            .l2
            .ok_or_else(|| CacheError::ConfigError("L2 backend is required".to_string()))?;

        Ok(TieredBackend {
            l1,
            l2,
            auto_promote: self.auto_promote,
            degraded: Arc::new(tokio::sync::RwLock::new(false)),
        })
    }
}

#[async_trait]
impl CacheBackend for TieredBackend {
    async fn get(&self, key: &str) -> Result<Option<Vec<u8>>> {
        // Try L1 first
        if let Some(value) = self.l1.get(key).await? {
            return Ok(Some(value));
        }

        // Try L2 on L1 miss
        if let Some(value) = self.l2.get(key).await? {
            // Auto-promote to L1 if enabled
            if self.auto_promote {
                // Clone value for L1 promotion
                let value_clone = value.clone();
                if let Err(e) = self.l1.set(key, value_clone, None).await {
                    tracing::warn!("Failed to promote value to L1: {}", e);
                }
            }
            return Ok(Some(value));
        }

        Ok(None)
    }

    async fn set(&self, key: &str, value: Vec<u8>, ttl: Option<Duration>) -> Result<()> {
        // Set in both L1 and L2
        let value_clone = value.clone();

        // Set in L1 (always succeeds if L1 is healthy)
        if let Err(e) = self.l1.set(key, value, ttl).await {
            tracing::warn!("Failed to set value in L1: {}", e);
        }

        // Set in L2 (may fail if degraded)
        match self.l2.set(key, value_clone, ttl).await {
            Ok(_) => {
                // L2 is healthy, ensure we're not in degraded mode
                self.set_degraded(false).await;
                Ok(())
            }
            Err(e) => {
                // L2 failed, enter degraded mode
                tracing::warn!("L2 backend failed, entering degraded mode: {}", e);
                self.set_degraded(true).await;
                // Return degraded error
                Err(CacheError::Degraded(
                    "L2 backend unavailable, operating in L1-only mode".to_string(),
                ))
            }
        }
    }

    async fn delete(&self, key: &str) -> Result<()> {
        // Delete from both L1 and L2
        let l1_result = self.l1.delete(key).await;
        let l2_result = self.l2.delete(key).await;

        // If L2 fails, enter degraded mode
        if l2_result.is_err() {
            self.set_degraded(true).await;
        }

        // Return error if both fail
        l1_result.or(l2_result)
    }

    async fn exists(&self, key: &str) -> Result<bool> {
        // Check L1 first
        if self.l1.exists(key).await? {
            return Ok(true);
        }

        // Check L2
        self.l2.exists(key).await
    }

    async fn clear(&self) -> Result<()> {
        // Clear both L1 and L2
        let l1_result = self.l1.clear().await;
        let l2_result = self.l2.clear().await;

        // If L2 fails, enter degraded mode
        if l2_result.is_err() {
            self.set_degraded(true).await;
        }

        l1_result.or(l2_result)
    }

    async fn close(&self) -> Result<()> {
        // Close both L1 and L2
        let l1_result = self.l1.close().await;
        let l2_result = self.l2.close().await;

        l1_result.or(l2_result)
    }

    async fn ttl(&self, key: &str) -> Result<Option<Duration>> {
        // Check L1 first
        if let Ok(Some(ttl)) = self.l1.ttl(key).await {
            return Ok(Some(ttl));
        }

        // Check L2
        self.l2.ttl(key).await
    }

    async fn expire(&self, key: &str, ttl: Duration) -> Result<bool> {
        // Set TTL in both L1 and L2
        let l1_result = self.l1.expire(key, ttl).await;
        let l2_result = self.l2.expire(key, ttl).await;

        // If L2 fails, enter degraded mode
        if l2_result.is_err() {
            self.set_degraded(true).await;
        }

        // Return true if either succeeds
        Ok(l1_result.unwrap_or(false) || l2_result.unwrap_or(false))
    }

    async fn health_check(&self) -> Result<bool> {
        // Check if both L1 and L2 are healthy
        let l1_healthy = self.l1.health_check().await.unwrap_or(false);
        let l2_healthy = self.l2.health_check().await.unwrap_or(false);

        // Update degraded state based on L2 health
        if !l2_healthy && l1_healthy {
            self.set_degraded(true).await;
        } else {
            self.set_degraded(false).await;
        }

        // Consider healthy if at least L1 is working
        Ok(l1_healthy)
    }

    async fn stats(&self) -> Result<HashMap<String, String>> {
        let mut stats = HashMap::new();
        stats.insert("type".to_string(), "tiered".to_string());
        stats.insert("degraded".to_string(), self.is_degraded().await.to_string());
        stats.insert("auto_promote".to_string(), self.auto_promote.to_string());

        // Get L1 stats
        if let Ok(l1_stats) = self.l1.stats().await {
            for (key, value) in l1_stats {
                stats.insert(format!("l1_{}", key), value);
            }
        }

        // Get L2 stats
        if let Ok(l2_stats) = self.l2.stats().await {
            for (key, value) in l2_stats {
                stats.insert(format!("l2_{}", key), value);
            }
        }

        Ok(stats)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::backend::memory::MemoryBackend;

    #[tokio::test]
    async fn test_tiered_backend_basic() {
        let l1 = MemoryBackend::new();
        let l2 = MemoryBackend::new(); // Use MemoryBackend as mock L2 for testing
        let backend = TieredBackend::new(l1, l2);

        // Test set and get
        backend.set("key1", b"value1".to_vec(), None).await.unwrap();
        let value = backend.get("key1").await.unwrap();
        assert_eq!(value, Some(b"value1".to_vec()));

        // Test exists
        assert!(backend.exists("key1").await.unwrap());
        assert!(!backend.exists("key2").await.unwrap());

        // Test delete
        backend.delete("key1").await.unwrap();
        assert!(!backend.exists("key1").await.unwrap());
    }

    #[tokio::test]
    async fn test_tiered_backend_l1_miss_l2_hit() {
        let l1 = MemoryBackend::new();
        let l2 = MemoryBackend::new();
        let backend = TieredBackend::new(l1.clone(), l2.clone());

        // Set value only in L2
        l2.set("key1", b"value1".to_vec(), None).await.unwrap();

        // Get should return value from L2 and promote to L1
        let value: Option<Vec<u8>> = backend.get("key1").await.unwrap();
        assert_eq!(value, Some(b"value1".to_vec()));

        // Now value should be in L1
        let exists: bool = l1.exists("key1").await.unwrap();
        assert!(exists);
    }

    #[tokio::test]
    async fn test_tiered_backend_stats() {
        let l1 = MemoryBackend::new();
        let l2 = MemoryBackend::new();
        let backend = TieredBackend::new(l1.clone(), l2.clone());

        let stats = backend.stats().await.unwrap();
        assert_eq!(stats.get("type"), Some(&"tiered".to_string()));
        assert_eq!(stats.get("degraded"), Some(&"false".to_string()));
        assert!(stats.contains_key("l1_type"));
        assert!(stats.contains_key("l2_type"));
    }
}