ic-storage 0.68.8

Governed stable allocation and collections for Internet Computer applications
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

//! Baseline ordered projections and caller-codec behavior.
use super::*;
use std::{
    borrow::Cow,
    panic::{AssertUnwindSafe, catch_unwind},
};
#[test]
fn bounded_map_keys_and_mixed_end_ranges_preserve_order() {
    let runtime = runtime(VectorMemory::default());
    let mut map = StableBTreeMap::<u64, Vec<u8>>::create(
        runtime
            .open_memory(&crate::StableKey::parse("test.map.v1").unwrap())
            .unwrap(),
    )
    .unwrap();
    for key in 0..100 {
        map.insert(key, vec![7; 16384]).unwrap();
    }
    let mut keys = map.keys_range(10..14);
    assert_eq!(keys.next().unwrap().unwrap(), 10);
    assert_eq!(keys.next_back().unwrap().unwrap(), 13);
    assert_eq!(keys.collect::<Result<Vec<_>, _>>().unwrap(), vec![11, 12]);
}

fn fixed_key_history<const N: usize>() {
    let backing = VectorMemory::default();
    let host = runtime(backing.clone());
    let binding = crate::StableKey::parse(KEYS[0]).unwrap();
    let mut map =
        StableBTreeMap::<[u8; N], ()>::create(host.open_memory(&binding).unwrap()).unwrap();
    let mut model = std::collections::BTreeSet::new();
    // Wide fixed keys with zero-sized values exercise densely occupied nodes;
    // N=0 also verifies empty slices without chunks_exact(0) or extra key IO.
    for number in (0..240_u8).rev() {
        let key = [number; N];
        assert_eq!(map.insert(key, ()).unwrap().is_none(), model.insert(key));
    }
    drop(map);
    drop(host);
    let host = runtime(backing);
    let mut map = StableBTreeMap::<[u8; N], ()>::load(host.open_memory(&binding).unwrap()).unwrap();
    for number in 0..240_u8 {
        let key = [number; N];
        assert_eq!(map.get(&key).unwrap(), model.contains(&key).then_some(()));
        if number % 3 == 0 {
            assert_eq!(map.remove(&key).unwrap().is_some(), model.remove(&key));
        }
    }
    assert_eq!(
        map.iter()
            .map(|entry| entry.unwrap().into_pair().unwrap())
            .collect::<Vec<_>>(),
        model.into_iter().map(|key| (key, ())).collect::<Vec<_>>()
    );
}

#[test]
fn fixed_key_batch_boundaries_preserve_splits_removals_and_reopening() {
    fixed_key_history::<0>();
    fixed_key_history::<1>();
    fixed_key_history::<8>();
    fixed_key_history::<15>();
    fixed_key_history::<16>();
    fixed_key_history::<17>();
}
#[derive(Clone)]
struct RejectDecode(u64);
impl Storable for RejectDecode {
    const BOUND: Bound = u64::BOUND;
    fn to_bytes(&self) -> Result<Cow<'_, [u8]>, CodecError> {
        self.0.to_bytes()
    }
    fn from_bytes(_: Cow<'_, [u8]>) -> Result<Self, CodecError> {
        Err(CodecError::Invalid("injected stored decode refusal"))
    }
}
#[test]
fn stored_value_decode_failure_traps_and_keys_remain_readable() {
    let backing = VectorMemory::default();
    let runtime = runtime(backing.clone());
    let mut map = StableBTreeMap::<u64, RejectDecode>::create(
        runtime
            .open_memory(&crate::StableKey::parse("test.map.v1").unwrap())
            .unwrap(),
    )
    .unwrap();
    map.insert(7, RejectDecode(42)).unwrap();
    let before = backing.borrow().clone();
    assert!(catch_unwind(AssertUnwindSafe(|| map.get(&7))).is_err());
    assert_eq!(map.keys().collect::<Result<Vec<_>, _>>().unwrap(), vec![7]);
    assert_eq!(*backing.borrow(), before);
    // Upstream updates before decoding a displaced value. A native panic must
    // poison the shared owner; IC executions use rollback instead.
    assert!(catch_unwind(AssertUnwindSafe(|| map.insert(7, RejectDecode(43)))).is_err());
    assert!(
        runtime
            .open_memory(&crate::StableKey::parse("test.set.v1").unwrap())
            .is_err()
    );
}