umi-memory 0.1.0

Memory library for AI agents with deterministic simulation testing
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
//! SimStorage - Simulated Storage with Fault Injection
//!
//! TigerStyle: In-memory storage that can fail deterministically.

use std::collections::HashMap;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use thiserror::Error;

use super::clock::SimClock;
use super::fault::{FaultInjector, FaultType};
use super::rng::DeterministicRng;

/// Storage errors.
#[derive(Error, Debug, Clone)]
pub enum StorageError {
    /// Write operation failed.
    #[error("storage write failed: {0}")]
    Write(String),

    /// Read operation failed.
    #[error("storage read failed: {0}")]
    Read(String),

    /// Delete operation failed.
    #[error("storage delete failed: {0}")]
    Delete(String),

    /// Storage corruption detected.
    #[error("storage corruption detected: {0}")]
    Corruption(String),

    /// Disk is full.
    #[error("disk full: {0}")]
    DiskFull(String),
}

/// Write-specific error alias.
pub type StorageWriteError = StorageError;

/// Read-specific error alias.
pub type StorageReadError = StorageError;

/// Storage statistics.
#[derive(Debug, Default)]
pub struct StorageStats {
    pub writes_count: u64,
    pub reads_count: u64,
    pub deletes_count: u64,
    pub entries_count: u64,
    pub bytes_total: u64,
    pub faults_injected_count: u64,
}

/// Entry metadata.
#[derive(Debug, Clone)]
struct StorageEntry {
    data: Vec<u8>,
    #[allow(dead_code)] // For future temporal queries
    created_at_ms: u64,
    #[allow(dead_code)] // For future temporal queries
    updated_at_ms: u64,
}

/// Simulated storage for DST testing.
///
/// TigerStyle:
/// - In-memory HashMap storage
/// - Fault injection at every operation
/// - Full statistics tracking
/// - Shared FaultInjector via Arc (Kelpie pattern)
#[derive(Debug)]
pub struct SimStorage {
    data: HashMap<String, StorageEntry>,
    clock: SimClock,
    #[allow(dead_code)] // For future random delays/corruption
    rng: DeterministicRng,
    /// Shared fault injector (via Arc for sharing with simulation harness)
    faults: Arc<FaultInjector>,
    // Statistics
    writes_count: AtomicU64,
    reads_count: AtomicU64,
    deletes_count: AtomicU64,
    faults_injected_count: AtomicU64,
}

impl SimStorage {
    /// Create a new simulated storage.
    ///
    /// TigerStyle: Takes Arc<FaultInjector> to share with simulation harness.
    #[must_use]
    pub fn new(clock: SimClock, rng: DeterministicRng, faults: Arc<FaultInjector>) -> Self {
        Self {
            data: HashMap::new(),
            clock,
            rng,
            faults,
            writes_count: AtomicU64::new(0),
            reads_count: AtomicU64::new(0),
            deletes_count: AtomicU64::new(0),
            faults_injected_count: AtomicU64::new(0),
        }
    }

    /// Write a value to storage.
    ///
    /// # Errors
    /// Returns error if fault injection triggers a failure.
    pub async fn write(&mut self, key: &str, value: &[u8]) -> Result<(), StorageError> {
        // Preconditions
        assert!(!key.is_empty(), "key must not be empty");
        assert!(value.len() <= 10_000_000, "value too large");

        // Check for fault injection
        if let Some(fault) = self.faults.should_inject("storage_write") {
            self.faults_injected_count.fetch_add(1, Ordering::Relaxed);
            return Err(self.fault_to_error(fault, "write"));
        }

        let now = self.clock.now_ms();
        let entry = StorageEntry {
            data: value.to_vec(),
            created_at_ms: now,
            updated_at_ms: now,
        };

        self.data.insert(key.to_string(), entry);
        self.writes_count.fetch_add(1, Ordering::Relaxed);

        // Postcondition
        assert!(self.data.contains_key(key), "key must exist after write");

        Ok(())
    }

    /// Read a value from storage.
    ///
    /// # Errors
    /// Returns error if fault injection triggers a failure.
    pub async fn read(&mut self, key: &str) -> Result<Option<Vec<u8>>, StorageError> {
        // Precondition
        assert!(!key.is_empty(), "key must not be empty");

        // Check for fault injection
        if let Some(fault) = self.faults.should_inject("storage_read") {
            self.faults_injected_count.fetch_add(1, Ordering::Relaxed);
            return Err(self.fault_to_error(fault, "read"));
        }

        self.reads_count.fetch_add(1, Ordering::Relaxed);

        Ok(self.data.get(key).map(|entry| entry.data.clone()))
    }

    /// Delete a value from storage.
    ///
    /// # Errors
    /// Returns error if fault injection triggers a failure.
    pub async fn delete(&mut self, key: &str) -> Result<bool, StorageError> {
        // Precondition
        assert!(!key.is_empty(), "key must not be empty");

        // Check for fault injection
        if let Some(fault) = self.faults.should_inject("storage_delete") {
            self.faults_injected_count.fetch_add(1, Ordering::Relaxed);
            return Err(self.fault_to_error(fault, "delete"));
        }

        self.deletes_count.fetch_add(1, Ordering::Relaxed);

        Ok(self.data.remove(key).is_some())
    }

    /// Check if a key exists.
    ///
    /// # Errors
    /// Returns error if fault injection triggers a failure.
    pub async fn exists(&mut self, key: &str) -> Result<bool, StorageError> {
        // Precondition
        assert!(!key.is_empty(), "key must not be empty");

        // Check for fault injection
        if let Some(fault) = self.faults.should_inject("storage_read") {
            self.faults_injected_count.fetch_add(1, Ordering::Relaxed);
            return Err(self.fault_to_error(fault, "exists"));
        }

        Ok(self.data.contains_key(key))
    }

    /// List keys matching a prefix.
    ///
    /// # Errors
    /// Returns error if fault injection triggers a failure.
    pub async fn keys(&mut self, prefix: Option<&str>) -> Result<Vec<String>, StorageError> {
        // Check for fault injection
        if let Some(fault) = self.faults.should_inject("storage_read") {
            self.faults_injected_count.fetch_add(1, Ordering::Relaxed);
            return Err(self.fault_to_error(fault, "keys"));
        }

        let keys: Vec<String> = match prefix {
            Some(p) => self
                .data
                .keys()
                .filter(|k| k.starts_with(p))
                .cloned()
                .collect(),
            None => self.data.keys().cloned().collect(),
        };

        Ok(keys)
    }

    /// Get storage statistics.
    #[must_use]
    pub fn stats(&self) -> StorageStats {
        let bytes_total: u64 = self.data.values().map(|e| e.data.len() as u64).sum();

        StorageStats {
            writes_count: self.writes_count.load(Ordering::Relaxed),
            reads_count: self.reads_count.load(Ordering::Relaxed),
            deletes_count: self.deletes_count.load(Ordering::Relaxed),
            entries_count: self.data.len() as u64,
            bytes_total,
            faults_injected_count: self.faults_injected_count.load(Ordering::Relaxed),
        }
    }

    /// Get the clock.
    #[must_use]
    pub fn clock(&self) -> &SimClock {
        &self.clock
    }

    /// Get mutable clock.
    pub fn clock_mut(&mut self) -> &mut SimClock {
        &mut self.clock
    }

    /// Clear all data.
    pub fn clear(&mut self) {
        self.data.clear();
    }

    /// Convert a fault type to an error.
    fn fault_to_error(&self, fault: FaultType, operation: &str) -> StorageError {
        match fault {
            FaultType::StorageWriteFail => {
                StorageError::Write(format!("injected {} fault", operation))
            }
            FaultType::StorageReadFail => {
                StorageError::Read(format!("injected {} fault", operation))
            }
            FaultType::StorageDeleteFail => {
                StorageError::Delete(format!("injected {} fault", operation))
            }
            FaultType::StorageCorruption => {
                StorageError::Corruption(format!("injected {} fault", operation))
            }
            FaultType::StorageDiskFull => {
                StorageError::DiskFull(format!("injected {} fault", operation))
            }
            _ => StorageError::Write(format!("unexpected fault type for {}", operation)),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dst::fault::{FaultConfig, FaultInjectorBuilder};

    fn create_storage() -> SimStorage {
        let clock = SimClock::new();
        let mut rng = DeterministicRng::new(42);
        let faults = Arc::new(FaultInjectorBuilder::new(rng.fork()).build());
        SimStorage::new(clock, rng, faults)
    }

    fn create_faulty_storage(fault_type: FaultType) -> SimStorage {
        let clock = SimClock::new();
        let mut rng = DeterministicRng::new(42);
        let faults = Arc::new(
            FaultInjectorBuilder::new(rng.fork())
                .with_fault(FaultConfig::new(fault_type, 1.0))
                .build(),
        );
        SimStorage::new(clock, rng, faults)
    }

    #[tokio::test]
    async fn test_write_and_read() {
        let mut storage = create_storage();

        storage.write("key1", b"value1").await.unwrap();
        let result = storage.read("key1").await.unwrap();

        assert_eq!(result, Some(b"value1".to_vec()));
    }

    #[tokio::test]
    async fn test_read_nonexistent() {
        let mut storage = create_storage();

        let result = storage.read("nonexistent").await.unwrap();

        assert_eq!(result, None);
    }

    #[tokio::test]
    async fn test_delete() {
        let mut storage = create_storage();

        storage.write("key1", b"value1").await.unwrap();
        let deleted = storage.delete("key1").await.unwrap();

        assert!(deleted);
        assert_eq!(storage.read("key1").await.unwrap(), None);
    }

    #[tokio::test]
    async fn test_delete_nonexistent() {
        let mut storage = create_storage();

        let deleted = storage.delete("nonexistent").await.unwrap();

        assert!(!deleted);
    }

    #[tokio::test]
    async fn test_exists() {
        let mut storage = create_storage();

        assert!(!storage.exists("key1").await.unwrap());

        storage.write("key1", b"value1").await.unwrap();

        assert!(storage.exists("key1").await.unwrap());
    }

    #[tokio::test]
    async fn test_keys() {
        let mut storage = create_storage();

        storage.write("user:1", b"alice").await.unwrap();
        storage.write("user:2", b"bob").await.unwrap();
        storage.write("session:1", b"data").await.unwrap();

        let mut all_keys = storage.keys(None).await.unwrap();
        all_keys.sort();
        assert_eq!(all_keys, vec!["session:1", "user:1", "user:2"]);

        let mut user_keys = storage.keys(Some("user:")).await.unwrap();
        user_keys.sort();
        assert_eq!(user_keys, vec!["user:1", "user:2"]);
    }

    #[tokio::test]
    async fn test_write_fault_injection() {
        let mut storage = create_faulty_storage(FaultType::StorageWriteFail);

        let result = storage.write("key", b"value").await;

        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), StorageError::Write(_)));
    }

    #[tokio::test]
    async fn test_read_fault_injection() {
        let mut storage = create_faulty_storage(FaultType::StorageReadFail);

        let result = storage.read("key").await;

        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), StorageError::Read(_)));
    }

    #[tokio::test]
    async fn test_stats_tracking() {
        let mut storage = create_storage();

        storage.write("k1", b"v1").await.unwrap();
        storage.write("k2", b"v2").await.unwrap();
        storage.read("k1").await.unwrap();
        storage.read("k3").await.unwrap(); // nonexistent
        storage.delete("k1").await.unwrap();

        let stats = storage.stats();

        assert_eq!(stats.writes_count, 2);
        assert_eq!(stats.reads_count, 2);
        assert_eq!(stats.deletes_count, 1);
        assert_eq!(stats.entries_count, 1); // k2 remains
    }

    #[tokio::test]
    async fn test_clear() {
        let mut storage = create_storage();

        storage.write("k1", b"v1").await.unwrap();
        storage.write("k2", b"v2").await.unwrap();

        storage.clear();

        assert_eq!(storage.stats().entries_count, 0);
    }

    #[test]
    #[should_panic(expected = "key must not be empty")]
    fn test_write_empty_key() {
        let mut storage = create_storage();
        let _ = tokio_test::block_on(storage.write("", b"value"));
    }
}