oxcache 0.3.0

A high-performance multi-level cache library for Rust with L1 (memory) and L2 (Redis) caching.
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

//! Copyright (c) 2025-2026, Kirky.X
//!
//! MIT License
//!
//! Cache 字节操作方法（用于宏兼容）

use super::Cache;
use crate::error::{CacheError, Result};
use crate::traits::CacheKey;
use std::sync::Arc;
use std::time::Duration;

#[cfg(any(feature = "serialization", feature = "full"))]
use crate::infra::serialization::Serializer;

impl<K, V> Cache<K, V>
where
    K: CacheKey,
    V: serde::Serialize + for<'de> serde::Deserialize<'de>,
{
    pub async fn get_bytes(&self, key: &str) -> Result<Option<Vec<u8>>> {
        self.backend.get(key).await
    }

    pub async fn set_bytes(&self, key: &str, value: Vec<u8>, ttl: Option<u64>) -> Result<()> {
        let ttl_duration = ttl.map(Duration::from_secs);
        self.backend.set(key, value, ttl_duration).await
    }

    /// Synchronously get raw bytes from the cache (macro-compatible sync path).
    ///
    /// Returns `Err(NotSupported)` if `sync_mode(true)` was not set on the
    /// builder (i.e., `backend_sync` is `None`).
    pub fn get_bytes_sync(&self, key: &str) -> Result<Option<Vec<u8>>> {
        let backend = self.backend_sync.as_ref().ok_or_else(|| {
            CacheError::NotSupported(
                "sync byte API requires CacheBuilder::sync_mode(true); backend_sync is None".to_string(),
            )
        })?;
        backend.get(key)
    }

    /// Synchronously set raw bytes in the cache (macro-compatible sync path).
    ///
    /// `ttl` is in seconds (matching the async `set_bytes` signature for
    /// macro symmetry). Returns `Err(NotSupported)` if `sync_mode(true)` was
    /// not set on the builder.
    pub fn set_bytes_sync(&self, key: &str, value: Vec<u8>, ttl: Option<u64>) -> Result<()> {
        let backend = self.backend_sync.as_ref().ok_or_else(|| {
            CacheError::NotSupported(
                "sync byte API requires CacheBuilder::sync_mode(true); backend_sync is None".to_string(),
            )
        })?;
        let ttl_duration = ttl.map(Duration::from_secs);
        backend.set(key, value, ttl_duration)
    }

    #[cfg(any(feature = "serialization", feature = "full"))]
    pub fn serializer(&self) -> Arc<dyn Serializer> {
        self.serializer.clone()
    }

    pub fn unified_serializer(&self) -> crate::infra::serialization::unified::UnifiedSerializer {
        self.unified_serializer.clone()
    }
}

#[cfg(test)]
mod tests {
    use crate::cache::api::Cache;

    // ========================================================================
    // get_bytes tests
    // ========================================================================

    #[tokio::test]
    async fn test_get_bytes_returns_none_for_missing_key() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let result = cache.get_bytes("nonexistent_key").await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn test_get_bytes_returns_stored_value() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let data = vec![1, 2, 3, 4, 5];
        cache.set_bytes("test_key", data.clone(), None).await.unwrap();
        let result = cache.get_bytes("test_key").await.unwrap();
        assert_eq!(result, Some(data));
    }

    // ========================================================================
    // set_bytes tests
    // ========================================================================

    #[tokio::test]
    async fn test_set_bytes_without_ttl() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let data = b"hello world".to_vec();
        let result = cache.set_bytes("hello", data.clone(), None).await;
        assert!(result.is_ok());
        let stored = cache.get_bytes("hello").await.unwrap();
        assert_eq!(stored, Some(data));
    }

    #[tokio::test]
    async fn test_set_bytes_with_ttl() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let data = b"expiring".to_vec();
        let result = cache.set_bytes("temp", data.clone(), Some(3600)).await;
        assert!(result.is_ok());
        let stored = cache.get_bytes("temp").await.unwrap();
        assert_eq!(stored, Some(data));
    }

    #[tokio::test]
    async fn test_set_bytes_overwrites_existing() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        cache.set_bytes("counter", vec![1], None).await.unwrap();
        cache.set_bytes("counter", vec![2], None).await.unwrap();
        let result = cache.get_bytes("counter").await.unwrap();
        assert_eq!(result, Some(vec![2]));
    }

    #[tokio::test]
    async fn test_set_bytes_empty_value() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let empty_data: Vec<u8> = vec![];
        cache.set_bytes("empty", empty_data.clone(), None).await.unwrap();
        let result = cache.get_bytes("empty").await.unwrap();
        assert_eq!(result, Some(empty_data));
    }

    #[tokio::test]
    async fn test_unified_serializer_accessible() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let serializer = cache.unified_serializer();
        // Verify it's a valid UnifiedSerializer by serializing and deserializing
        let original = "hello";
        let serialized = serializer.serialize(&original).unwrap();
        let deserialized: String = serializer.deserialize(&serialized).unwrap();
        assert_eq!(deserialized, original);
    }

    // ========================================================================
    // serializer() feature-gated test
    // ========================================================================

    #[tokio::test]
    #[cfg(any(feature = "serialization", feature = "full"))]
    async fn test_serializer_returns_json() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let serializer = cache.serializer();
        // JsonSerializer should be returned - serialize then deserialize to verify
        let original = b"hello world";
        let serialized = serializer.serialize("bytes", original).unwrap();
        let deserialized = serializer.deserialize("bytes", &serialized).unwrap();
        assert_eq!(deserialized, original);
    }

    // ========================================================================
    // Large data tests
    // ========================================================================

    #[tokio::test]
    async fn test_set_bytes_large_data() {
        let cache: Cache<String, Vec<u8>> = Cache::memory().await.unwrap();
        let large_data = vec![0xAB; 1024 * 100]; // 100KB
        cache.set_bytes("large", large_data.clone(), None).await.unwrap();
        let result = cache.get_bytes("large").await.unwrap();
        assert_eq!(result, Some(large_data));
    }

    // ========================================================================
    // get_bytes_sync / set_bytes_sync tests
    // ========================================================================

    // NOTE: multi_thread flavor required — MokaMemoryBackend's sync_block_on
    // uses block_in_place, which panics on current_thread runtimes.
    #[tokio::test(flavor = "multi_thread")]
    async fn test_get_bytes_sync_returns_none_for_missing_key() {
        let cache: Cache<String, Vec<u8>> = Cache::builder().sync_mode(true).build().await.unwrap();
        let result = cache.get_bytes_sync("nonexistent_key").unwrap();
        assert!(result.is_none(), "missing key should return None");
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn test_set_bytes_sync_then_get_bytes_sync_roundtrip() {
        let cache: Cache<String, Vec<u8>> = Cache::builder().sync_mode(true).build().await.unwrap();
        let data = vec![1, 2, 3, 4, 5];
        cache.set_bytes_sync("test_key", data.clone(), None).unwrap();
        let result = cache.get_bytes_sync("test_key").unwrap();
        assert_eq!(result, Some(data));
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn test_set_bytes_sync_with_ttl_roundtrip() {
        let cache: Cache<String, Vec<u8>> = Cache::builder().sync_mode(true).build().await.unwrap();
        let data = b"expiring".to_vec();
        cache.set_bytes_sync("temp", data.clone(), Some(3600)).unwrap();
        let result = cache.get_bytes_sync("temp").unwrap();
        assert_eq!(result, Some(data));
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn test_get_bytes_sync_without_sync_mode_returns_not_supported() {
        // Default builder (sync_mode=false) should return Err(NotSupported)
        let cache: Cache<String, Vec<u8>> = Cache::builder().build().await.unwrap();
        let result = cache.get_bytes_sync("any_key");
        assert!(
            matches!(result, Err(crate::error::CacheError::NotSupported(_))),
            "expected Err(NotSupported) when sync_mode is false, got {:?}",
            result
        );
    }

    #[tokio::test(flavor = "multi_thread")]
    async fn test_set_bytes_sync_without_sync_mode_returns_not_supported() {
        let cache: Cache<String, Vec<u8>> = Cache::builder().build().await.unwrap();
        let result = cache.set_bytes_sync("any_key", vec![1], None);
        assert!(
            matches!(result, Err(crate::error::CacheError::NotSupported(_))),
            "expected Err(NotSupported) when sync_mode is false, got {:?}",
            result
        );
    }
}