prolly-map 0.3.0

Content-addressed versioned map storage primitives.
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
//! In-memory storage backend implementation

use std::collections::{BTreeMap, HashMap};
use std::sync::RwLock;

use super::super::error::Error;
use super::super::manifest::{
    sort_named_root_manifests, ManifestStore, ManifestStoreScan, ManifestUpdate, NamedRootManifest,
    RootManifest,
};
use super::super::transaction::{
    RootCondition, RootWrite, TransactionConflict, TransactionNodeWrite, TransactionUpdate,
    TransactionalStore,
};
use super::{cid_from_store_key, sort_cids, BatchOp, NodeStoreScan, OrderedBatchReadPlan, Store};

/// In-memory store for testing and simple use cases
#[derive(Debug, Default)]
pub struct MemStore {
    data: RwLock<BTreeMap<Vec<u8>, Vec<u8>>>,
    roots: RwLock<BTreeMap<Vec<u8>, RootManifest>>,
}

/// Error type for MemStore operations
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MemStoreError(String);

impl std::fmt::Display for MemStoreError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "MemStore error: {}", self.0)
    }
}

impl std::error::Error for MemStoreError {}

impl MemStore {
    /// Create a new empty in-memory store
    pub fn new() -> Self {
        Self {
            data: RwLock::new(BTreeMap::new()),
            roots: RwLock::new(BTreeMap::new()),
        }
    }
}

impl Store for MemStore {
    type Error = MemStoreError;

    fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error> {
        let data = self
            .data
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        Ok(data.get(key).cloned())
    }

    fn put(&self, key: &[u8], value: &[u8]) -> Result<(), Self::Error> {
        let mut data = self
            .data
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        data.insert(key.to_vec(), value.to_vec());
        Ok(())
    }

    fn delete(&self, key: &[u8]) -> Result<(), Self::Error> {
        let mut data = self
            .data
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        data.remove(key);
        Ok(())
    }

    fn batch(&self, ops: &[BatchOp]) -> Result<(), Self::Error> {
        let mut data = self
            .data
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;

        for op in ops {
            match op {
                BatchOp::Upsert { key, value } => {
                    data.insert(key.to_vec(), value.to_vec());
                }
                BatchOp::Delete { key } => {
                    data.remove(*key);
                }
            }
        }

        Ok(())
    }

    /// Optimized batch_get for MemStore - acquires lock once for all reads
    fn batch_get(&self, keys: &[&[u8]]) -> Result<HashMap<Vec<u8>, Vec<u8>>, Self::Error> {
        let data = self
            .data
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;

        let plan = OrderedBatchReadPlan::new(keys);
        let mut results = HashMap::with_capacity(plan.unique_keys().len());
        for key in plan.unique_keys() {
            if let Some(value) = data.get(*key) {
                results.insert(key.to_vec(), value.clone());
            }
        }
        Ok(results)
    }

    /// Optimized batch_get_ordered for MemStore - acquires lock once for all reads
    fn batch_get_ordered(&self, keys: &[&[u8]]) -> Result<Vec<Option<Vec<u8>>>, Self::Error> {
        let data = self
            .data
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;

        let plan = OrderedBatchReadPlan::new(keys);
        let unique_values = plan
            .unique_keys()
            .iter()
            .map(|key| data.get(*key).cloned())
            .collect::<Vec<_>>();
        Ok(plan.expand_owned(unique_values))
    }

    fn batch_get_ordered_unique(
        &self,
        keys: &[&[u8]],
    ) -> Result<Vec<Option<Vec<u8>>>, Self::Error> {
        let data = self
            .data
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;

        Ok(keys.iter().map(|key| data.get(*key).cloned()).collect())
    }

    fn prefers_batch_reads(&self) -> bool {
        true
    }

    /// Optimized batch_put for MemStore - acquires lock once for all writes
    fn batch_put(&self, entries: &[(&[u8], &[u8])]) -> Result<(), Self::Error> {
        let mut data = self
            .data
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;

        for (key, value) in entries {
            data.insert(key.to_vec(), value.to_vec());
        }
        Ok(())
    }
}

impl NodeStoreScan for MemStore {
    type Error = MemStoreError;

    fn list_node_cids(&self) -> Result<Vec<super::super::cid::Cid>, Self::Error> {
        let data = self
            .data
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        let mut cids = data
            .keys()
            .map(|key| cid_from_store_key(key, "MemStore node"))
            .collect::<Result<Vec<_>, _>>()
            .map_err(MemStoreError)?;
        sort_cids(&mut cids);
        Ok(cids)
    }
}

impl ManifestStore for MemStore {
    type Error = MemStoreError;

    fn get_root(&self, name: &[u8]) -> Result<Option<RootManifest>, Self::Error> {
        let roots = self
            .roots
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        Ok(roots.get(name).cloned())
    }

    fn put_root(&self, name: &[u8], manifest: &RootManifest) -> Result<(), Self::Error> {
        let mut roots = self
            .roots
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        roots.insert(name.to_vec(), manifest.clone());
        Ok(())
    }

    fn delete_root(&self, name: &[u8]) -> Result<(), Self::Error> {
        let mut roots = self
            .roots
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        roots.remove(name);
        Ok(())
    }

    fn compare_and_swap_root(
        &self,
        name: &[u8],
        expected: Option<&RootManifest>,
        new: Option<&RootManifest>,
    ) -> Result<ManifestUpdate, Self::Error> {
        let mut roots = self
            .roots
            .write()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        let current = roots.get(name).cloned();
        if current.as_ref() != expected {
            return Ok(ManifestUpdate::Conflict { current });
        }

        match new {
            Some(manifest) => {
                roots.insert(name.to_vec(), manifest.clone());
            }
            None => {
                roots.remove(name);
            }
        }

        Ok(ManifestUpdate::Applied)
    }
}

impl ManifestStoreScan for MemStore {
    fn list_roots(&self) -> Result<Vec<NamedRootManifest>, Self::Error> {
        let roots = self
            .roots
            .read()
            .map_err(|e| MemStoreError(format!("lock poisoned: {}", e)))?;
        let mut roots = roots
            .iter()
            .map(|(name, manifest)| NamedRootManifest::new(name.clone(), manifest.clone()))
            .collect::<Vec<_>>();
        sort_named_root_manifests(&mut roots);
        Ok(roots)
    }
}

impl TransactionalStore for MemStore {
    fn supports_transactions(&self) -> bool {
        true
    }

    fn commit_transaction(
        &self,
        node_writes: &[TransactionNodeWrite],
        root_conditions: &[RootCondition],
        root_writes: &[RootWrite],
    ) -> Result<TransactionUpdate, Error> {
        let mut data = self.data.write().map_err(|err| {
            Error::Store(Box::new(MemStoreError(format!("lock poisoned: {err}"))))
        })?;
        let mut roots = self.roots.write().map_err(|err| {
            Error::Store(Box::new(MemStoreError(format!("lock poisoned: {err}"))))
        })?;

        for condition in root_conditions {
            let current = roots.get(&condition.name).cloned();
            if current != condition.expected {
                return Ok(TransactionUpdate::Conflict(Box::new(
                    TransactionConflict::new(
                        condition.name.clone(),
                        condition.expected.clone(),
                        current,
                    ),
                )));
            }
        }

        for write in node_writes {
            match write {
                TransactionNodeWrite::Upsert { key, value } => {
                    data.insert(key.clone(), value.clone());
                }
                TransactionNodeWrite::Delete { key } => {
                    data.remove(key);
                }
            }
        }

        for write in root_writes {
            match write {
                RootWrite::Put { name, manifest } => {
                    roots.insert(name.clone(), manifest.clone());
                }
                RootWrite::Delete { name } => {
                    roots.remove(name);
                }
            }
        }

        Ok(TransactionUpdate::Applied {
            nodes_written: node_writes.len(),
            roots_written: root_writes.len(),
        })
    }
}

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

    #[test]
    fn test_memstore_put_get() {
        let store = MemStore::new();
        let key = b"test_key";
        let value = b"test_value";

        store.put(key, value).unwrap();
        let result = store.get(key).unwrap();

        assert_eq!(result, Some(value.to_vec()));
    }

    #[test]
    fn test_memstore_get_nonexistent() {
        let store = MemStore::new();
        let result = store.get(b"nonexistent").unwrap();
        assert_eq!(result, None);
    }

    #[test]
    fn test_memstore_delete() {
        let store = MemStore::new();
        let key = b"test_key";
        let value = b"test_value";

        store.put(key, value).unwrap();
        store.delete(key).unwrap();
        let result = store.get(key).unwrap();

        assert_eq!(result, None);
    }

    #[test]
    fn test_memstore_batch() {
        let store = MemStore::new();

        // First put some initial data
        store.put(b"key1", b"value1").unwrap();
        store.put(b"key2", b"value2").unwrap();

        // Batch: update key1, delete key2, add key3
        let ops = vec![
            BatchOp::Upsert {
                key: b"key1",
                value: b"updated",
            },
            BatchOp::Delete { key: b"key2" },
            BatchOp::Upsert {
                key: b"key3",
                value: b"value3",
            },
        ];

        store.batch(&ops).unwrap();

        assert_eq!(store.get(b"key1").unwrap(), Some(b"updated".to_vec()));
        assert_eq!(store.get(b"key2").unwrap(), None);
        assert_eq!(store.get(b"key3").unwrap(), Some(b"value3".to_vec()));
    }

    // ========================================================================
    // Unit tests for batch_get_ordered
    // ========================================================================

    #[test]
    fn test_batch_get_ordered_with_existing_keys() {
        let store = MemStore::new();

        // Store some data
        store.put(b"key1", b"value1").unwrap();
        store.put(b"key2", b"value2").unwrap();
        store.put(b"key3", b"value3").unwrap();

        // Query in a specific order
        let keys: Vec<&[u8]> = vec![b"key3", b"key1", b"key2"];
        let results = store.batch_get_ordered(&keys).unwrap();

        // Verify results are in the same order as input keys
        assert_eq!(results.len(), 3);
        assert_eq!(results[0], Some(b"value3".to_vec())); // key3
        assert_eq!(results[1], Some(b"value1".to_vec())); // key1
        assert_eq!(results[2], Some(b"value2".to_vec())); // key2
    }

    #[test]
    fn test_batch_get_ordered_with_nonexistent_keys() {
        let store = MemStore::new();

        // Query keys that don't exist
        let keys: Vec<&[u8]> = vec![b"missing1", b"missing2", b"missing3"];
        let results = store.batch_get_ordered(&keys).unwrap();

        // Verify all results are None
        assert_eq!(results.len(), 3);
        assert_eq!(results[0], None);
        assert_eq!(results[1], None);
        assert_eq!(results[2], None);
    }

    #[test]
    fn test_batch_get_ordered_with_mixed_keys() {
        let store = MemStore::new();

        // Store some data
        store.put(b"exists1", b"value1").unwrap();
        store.put(b"exists2", b"value2").unwrap();

        // Query mix of existing and non-existing keys
        let keys: Vec<&[u8]> = vec![b"exists1", b"missing1", b"exists2", b"missing2"];
        let results = store.batch_get_ordered(&keys).unwrap();

        // Verify results are in correct order with Some/None as appropriate
        assert_eq!(results.len(), 4);
        assert_eq!(results[0], Some(b"value1".to_vec())); // exists1
        assert_eq!(results[1], None); // missing1
        assert_eq!(results[2], Some(b"value2".to_vec())); // exists2
        assert_eq!(results[3], None); // missing2
    }

    #[test]
    fn test_batch_get_ordered_empty_keys() {
        let store = MemStore::new();

        // Store some data
        store.put(b"key1", b"value1").unwrap();

        // Query with empty keys list
        let keys: Vec<&[u8]> = vec![];
        let results = store.batch_get_ordered(&keys).unwrap();

        // Should return empty vector
        assert_eq!(results.len(), 0);
    }

    #[test]
    fn test_batch_get_ordered_duplicate_keys() {
        let store = MemStore::new();

        // Store some data
        store.put(b"key1", b"value1").unwrap();

        // Query with duplicate keys
        let keys: Vec<&[u8]> = vec![b"key1", b"key1", b"key1"];
        let results = store.batch_get_ordered(&keys).unwrap();

        // Should return same value for each duplicate key
        assert_eq!(results.len(), 3);
        assert_eq!(results[0], Some(b"value1".to_vec()));
        assert_eq!(results[1], Some(b"value1".to_vec()));
        assert_eq!(results[2], Some(b"value1".to_vec()));
    }
}