rrag 0.1.0-alpha.2

High-performance Rust framework for Retrieval-Augmented Generation with pluggable components, async-first design, and comprehensive observability
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
//! # Cache Persistence
//!
//! Persistence layer for cache data across restarts.

use super::{
    CacheStats, EmbeddingCacheEntry, PersistenceConfig, PersistenceFormat, QueryCacheEntry,
    ResultCacheEntry, SemanticCacheEntry,
};
use crate::{RragError, RragResult};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fs;
use std::io::{Read, Write};
use std::path::PathBuf;

/// Cache persistence manager
pub struct PersistenceManager {
    /// Configuration
    config: PersistenceConfig,

    /// Storage path
    storage_path: PathBuf,

    /// Serializer based on format
    serializer: Box<dyn CacheSerializer>,

    /// Persistence statistics
    stats: PersistenceStats,
}

/// Persistence statistics
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PersistenceStats {
    /// Total saves
    pub save_count: u64,

    /// Total loads
    pub load_count: u64,

    /// Failed saves
    pub save_failures: u64,

    /// Failed loads
    pub load_failures: u64,

    /// Total bytes written
    pub bytes_written: u64,

    /// Total bytes read
    pub bytes_read: u64,

    /// Last save time
    pub last_save: Option<std::time::SystemTime>,

    /// Last load time
    pub last_load: Option<std::time::SystemTime>,
}

/// Cache serializer trait
pub trait CacheSerializer: Send + Sync {
    /// Serialize cache data
    fn serialize_cache_data(&self, data: &PersistedCacheData) -> RragResult<Vec<u8>>;

    /// Deserialize cache data
    fn deserialize_cache_data(&self, data: &[u8]) -> RragResult<PersistedCacheData>;

    /// Get format name
    fn format_name(&self) -> &str;
}

/// Binary serializer using bincode
pub struct BinarySerializer;

impl CacheSerializer for BinarySerializer {
    fn serialize_cache_data(&self, data: &PersistedCacheData) -> RragResult<Vec<u8>> {
        bincode::serialize(data)
            .map_err(|e| RragError::serialization_with_message("binary", e.to_string()))
    }

    fn deserialize_cache_data(&self, data: &[u8]) -> RragResult<PersistedCacheData> {
        bincode::deserialize(data)
            .map_err(|e| RragError::serialization_with_message("binary", e.to_string()))
    }

    fn format_name(&self) -> &str {
        "binary"
    }
}

/// JSON serializer
pub struct JsonSerializer;

impl CacheSerializer for JsonSerializer {
    fn serialize_cache_data(&self, data: &PersistedCacheData) -> RragResult<Vec<u8>> {
        serde_json::to_vec(data)
            .map_err(|e| RragError::serialization_with_message("json", e.to_string()))
    }

    fn deserialize_cache_data(&self, data: &[u8]) -> RragResult<PersistedCacheData> {
        serde_json::from_slice(data)
            .map_err(|e| RragError::serialization_with_message("json", e.to_string()))
    }

    fn format_name(&self) -> &str {
        "json"
    }
}

/// MessagePack serializer
pub struct MessagePackSerializer;

impl CacheSerializer for MessagePackSerializer {
    fn serialize_cache_data(&self, data: &PersistedCacheData) -> RragResult<Vec<u8>> {
        rmp_serde::to_vec(data)
            .map_err(|e| RragError::serialization_with_message("msgpack", e.to_string()))
    }

    fn deserialize_cache_data(&self, data: &[u8]) -> RragResult<PersistedCacheData> {
        rmp_serde::from_slice(data)
            .map_err(|e| RragError::serialization_with_message("msgpack", e.to_string()))
    }

    fn format_name(&self) -> &str {
        "msgpack"
    }
}

/// Persisted cache data structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PersistedCacheData {
    /// Version for compatibility
    pub version: u32,

    /// Timestamp of persistence
    pub timestamp: std::time::SystemTime,

    /// Query cache entries
    pub query_cache: HashMap<String, QueryCacheEntry>,

    /// Embedding cache entries
    pub embedding_cache: HashMap<String, EmbeddingCacheEntry>,

    /// Semantic cache entries
    pub semantic_cache: HashMap<String, SemanticCacheEntry>,

    /// Result cache entries
    pub result_cache: HashMap<String, ResultCacheEntry>,

    /// Cache statistics
    pub stats: HashMap<String, CacheStats>,

    /// Metadata
    pub metadata: PersistenceMetadata,
}

/// Persistence metadata
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PersistenceMetadata {
    /// Application version
    pub app_version: String,

    /// Cache configuration hash
    pub config_hash: String,

    /// Total entries
    pub total_entries: usize,

    /// Compression enabled
    pub compression_enabled: bool,

    /// Custom metadata
    pub custom: HashMap<String, String>,
}

impl PersistenceManager {
    /// Create new persistence manager
    pub fn new(config: PersistenceConfig) -> RragResult<Self> {
        let storage_path = PathBuf::from(&config.storage_path);

        // Create storage directory if it doesn't exist
        if !storage_path.exists() {
            fs::create_dir_all(&storage_path)
                .map_err(|e| RragError::storage("create_cache_directory", e))?;
        }

        let serializer: Box<dyn CacheSerializer> = match config.format {
            PersistenceFormat::Binary => Box::new(BinarySerializer),
            PersistenceFormat::Json => Box::new(JsonSerializer),
            PersistenceFormat::MessagePack => Box::new(MessagePackSerializer),
        };

        Ok(Self {
            config,
            storage_path,
            serializer,
            stats: PersistenceStats::default(),
        })
    }

    /// Save cache data to disk
    pub fn save(&mut self, data: &PersistedCacheData) -> RragResult<()> {
        let start = std::time::Instant::now();

        // Serialize data
        let serialized = self.serializer.serialize_cache_data(data)?;

        // Write to temporary file first
        let temp_path = self.get_temp_path();
        let mut file =
            fs::File::create(&temp_path).map_err(|e| RragError::storage("create_temp_file", e))?;

        file.write_all(&serialized)
            .map_err(|e| RragError::storage("write_cache_data", e))?;

        file.sync_all()
            .map_err(|e| RragError::storage("sync_cache_file", e))?;

        // Rename to final path (atomic on most systems)
        let final_path = self.get_cache_path();
        fs::rename(&temp_path, &final_path)
            .map_err(|e| RragError::storage("rename_cache_file", e))?;

        // Update stats
        self.stats.save_count += 1;
        self.stats.bytes_written += serialized.len() as u64;
        self.stats.last_save = Some(std::time::SystemTime::now());

        let duration = start.elapsed();
        tracing::info!(
            "Cache saved: {} entries, {} bytes, {:?}",
            data.metadata.total_entries,
            serialized.len(),
            duration
        );

        Ok(())
    }

    /// Load cache data from disk
    pub fn load(&mut self) -> RragResult<PersistedCacheData> {
        let start = std::time::Instant::now();
        let cache_path = self.get_cache_path();

        if !cache_path.exists() {
            return Err(RragError::memory("load_cache", "Cache file not found"));
        }

        // Read file
        let mut file =
            fs::File::open(&cache_path).map_err(|e| RragError::storage("open_cache_file", e))?;

        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer)
            .map_err(|e| RragError::storage("read_cache_file", e))?;

        // Deserialize data
        let data = self.serializer.deserialize_cache_data(&buffer)?;

        // Validate version
        if data.version != CACHE_VERSION {
            return Err(RragError::validation(
                "cache_version",
                format!("version {}", CACHE_VERSION),
                format!("version {}", data.version),
            ));
        }

        // Update stats
        self.stats.load_count += 1;
        self.stats.bytes_read += buffer.len() as u64;
        self.stats.last_load = Some(std::time::SystemTime::now());

        let duration = start.elapsed();
        tracing::info!(
            "Cache loaded: {} entries, {} bytes, {:?}",
            data.metadata.total_entries,
            buffer.len(),
            duration
        );

        Ok(data)
    }

    /// Save cache asynchronously
    pub async fn save_async(&mut self, data: PersistedCacheData) -> RragResult<()> {
        let serializer = self.create_serializer();
        let path = self.get_cache_path();
        let temp_path = self.get_temp_path();

        // Spawn blocking task for IO
        tokio::task::spawn_blocking(move || {
            let serialized = serializer.serialize_cache_data(&data)?;

            let mut file = fs::File::create(&temp_path)
                .map_err(|e| RragError::storage("create_temp_file", e))?;

            file.write_all(&serialized)
                .map_err(|e| RragError::storage("write_cache_data", e))?;

            file.sync_all()
                .map_err(|e| RragError::storage("sync_cache_file", e))?;

            fs::rename(&temp_path, &path)
                .map_err(|e| RragError::storage("rename_cache_file", e))?;

            Ok(())
        })
        .await
        .map_err(|e| RragError::memory("async_save", e.to_string()))?
    }

    /// Create backup of current cache
    pub fn backup(&self) -> RragResult<()> {
        let cache_path = self.get_cache_path();
        if !cache_path.exists() {
            return Ok(());
        }

        let backup_path = self.get_backup_path();
        fs::copy(&cache_path, &backup_path).map_err(|e| RragError::storage("create_backup", e))?;

        tracing::info!("Cache backed up to {:?}", backup_path);
        Ok(())
    }

    /// Restore from backup
    pub fn restore(&self) -> RragResult<()> {
        let backup_path = self.get_backup_path();
        if !backup_path.exists() {
            return Err(RragError::memory("restore_backup", "Backup file not found"));
        }

        let cache_path = self.get_cache_path();
        fs::copy(&backup_path, &cache_path)
            .map_err(|e| RragError::storage("restore_from_backup", e))?;

        tracing::info!("Cache restored from backup");
        Ok(())
    }

    /// Clean old cache files
    pub fn cleanup(&self, keep_days: u32) -> RragResult<()> {
        let cutoff =
            std::time::SystemTime::now() - std::time::Duration::from_secs(keep_days as u64 * 86400);

        let entries = fs::read_dir(&self.storage_path)
            .map_err(|e| RragError::storage("read_cache_directory", e))?;

        let mut removed = 0;
        for entry in entries {
            let entry = entry.map_err(|e| RragError::storage("read_directory_entry", e))?;
            let metadata = entry
                .metadata()
                .map_err(|e| RragError::storage("read_file_metadata", e))?;

            if let Ok(modified) = metadata.modified() {
                if modified < cutoff {
                    fs::remove_file(entry.path())
                        .map_err(|e| RragError::storage("remove_old_cache", e))?;
                    removed += 1;
                }
            }
        }

        tracing::info!("Cleaned up {} old cache files", removed);
        Ok(())
    }

    /// Get cache file path
    fn get_cache_path(&self) -> PathBuf {
        self.storage_path.join("cache.dat")
    }

    /// Get temporary file path
    fn get_temp_path(&self) -> PathBuf {
        self.storage_path.join("cache.tmp")
    }

    /// Get backup file path
    fn get_backup_path(&self) -> PathBuf {
        self.storage_path.join("cache.bak")
    }

    /// Create serializer instance
    fn create_serializer(&self) -> Box<dyn CacheSerializer> {
        match self.config.format {
            PersistenceFormat::Binary => Box::new(BinarySerializer),
            PersistenceFormat::Json => Box::new(JsonSerializer),
            PersistenceFormat::MessagePack => Box::new(MessagePackSerializer),
        }
    }
}

/// Cache version for compatibility checking
const CACHE_VERSION: u32 = 1;

impl Default for PersistenceStats {
    fn default() -> Self {
        Self {
            save_count: 0,
            load_count: 0,
            save_failures: 0,
            load_failures: 0,
            bytes_written: 0,
            bytes_read: 0,
            last_save: None,
            last_load: None,
        }
    }
}

impl Default for PersistedCacheData {
    fn default() -> Self {
        Self {
            version: CACHE_VERSION,
            timestamp: std::time::SystemTime::now(),
            query_cache: HashMap::new(),
            embedding_cache: HashMap::new(),
            semantic_cache: HashMap::new(),
            result_cache: HashMap::new(),
            stats: HashMap::new(),
            metadata: PersistenceMetadata::default(),
        }
    }
}

impl Default for PersistenceMetadata {
    fn default() -> Self {
        Self {
            app_version: env!("CARGO_PKG_VERSION").to_string(),
            config_hash: String::new(),
            total_entries: 0,
            compression_enabled: false,
            custom: HashMap::new(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::TempDir;

    fn create_test_config(dir: &Path) -> PersistenceConfig {
        PersistenceConfig {
            enabled: true,
            storage_path: dir.to_str().unwrap().to_string(),
            auto_save_interval: std::time::Duration::from_secs(60),
            format: PersistenceFormat::Binary,
        }
    }

    #[test]
    fn test_binary_serializer() {
        let serializer = BinarySerializer;
        let data = PersistedCacheData::default();

        let serialized = serializer.serialize_cache_data(&data).unwrap();
        let deserialized = serializer.deserialize_cache_data(&serialized).unwrap();

        assert_eq!(data.version, deserialized.version);
    }

    #[test]
    fn test_json_serializer() {
        let serializer = JsonSerializer;
        let data = PersistedCacheData::default();

        let serialized = serializer.serialize_cache_data(&data).unwrap();
        let deserialized = serializer.deserialize_cache_data(&serialized).unwrap();

        assert_eq!(data.version, deserialized.version);
    }

    #[test]
    fn test_save_and_load() {
        let temp_dir = TempDir::new().unwrap();
        let config = create_test_config(temp_dir.path());
        let mut manager = PersistenceManager::new(config).unwrap();

        let data = PersistedCacheData::default();
        manager.save(&data).unwrap();

        let loaded = manager.load().unwrap();
        assert_eq!(loaded.version, data.version);
    }

    #[test]
    fn test_backup_and_restore() {
        let temp_dir = TempDir::new().unwrap();
        let config = create_test_config(temp_dir.path());
        let mut manager = PersistenceManager::new(config).unwrap();

        let data = PersistedCacheData::default();
        manager.save(&data).unwrap();

        manager.backup().unwrap();

        // Delete original
        fs::remove_file(manager.get_cache_path()).unwrap();

        // Restore from backup
        manager.restore().unwrap();

        let loaded = manager.load().unwrap();
        assert_eq!(loaded.version, data.version);
    }
}