ic-storage 0.64.0

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
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

use ic_storage::*;
fn source(keys: &[&str]) -> SealedDeclarationSnapshot {
    SealedDeclarationSnapshot::new(
        keys.iter()
            .map(|key| MemoryRequest::new("app", key).unwrap())
            .collect(),
    )
    .unwrap()
}
fn grants() -> AllocationGrants {
    AllocationGrants::new(vec![MemoryAuthority::new("app", "app.").unwrap()]).unwrap()
}

#[test]
fn public_runtime_retains_omitted_names_and_requires_current_admission() {
    let memory = VectorMemory::default();
    let mut host = MemoryRuntime::new(memory.clone()).unwrap();
    let names: Vec<_> = (0..1024).map(|n| format!("app.rows{n}.v1")).collect();
    let names: Vec<_> = names.iter().map(String::as_str).collect();
    host.bootstrap(&source(&names), &grants(), &GenericAllocationPolicy)
        .unwrap();
    let key = StableKey::parse("app.rows999.v1").unwrap();
    let id = host.allocation_id(&key).unwrap();
    assert!(id.get() > 255);
    let rows = host.open_memory(&key).unwrap();
    rows.grow(1).unwrap();
    rows.write(17, b"retained");
    drop(host);
    assert!(matches!(
        MemoryRuntime::new(memory.clone()),
        Err(RuntimeConstructionError::BackingAlreadyClaimed)
    ));
    drop(rows);
    let mut host = MemoryRuntime::new(memory.clone()).unwrap();
    host.bootstrap(
        &source(&["app.other.v1"]),
        &grants(),
        &GenericAllocationPolicy,
    )
    .unwrap();
    assert_eq!(host.allocation_id(&key), Some(id));
    assert!(matches!(
        host.open_memory(&key),
        Err(RuntimeOpenError::NotAdmitted(_))
    ));
    drop(host);
    let mut host = MemoryRuntime::new(memory).unwrap();
    host.bootstrap(
        &source(&[key.as_str()]),
        &grants(),
        &GenericAllocationPolicy,
    )
    .unwrap();
    let rows = host.open_memory(&key).unwrap();
    let mut bytes = [0; 8];
    rows.read(17, &mut bytes);
    assert_eq!(&bytes, b"retained");
}

struct Select;
impl RuntimeBootstrapPolicy for Select {
    type Error = &'static str;
    fn validate_allocation(&self, _: &StableKey) -> Result<(), Self::Error> {
        Ok(())
    }
    fn runtime_bootstrap_identity(&self) -> PolicyIdentity {
        PolicyIdentity::new([7; 32])
    }
    fn prepare_bootstrap(&self, admission: &mut BootstrapAdmission<'_>) -> Result<(), Self::Error> {
        admission
            .include_historical("app", "app.old.v1")
            .map_err(|_| "selection")
    }
}
#[test]
fn historical_selection_warm_binding_and_namespace_refusal() {
    let memory = VectorMemory::default();
    let mut host = MemoryRuntime::new(memory.clone()).unwrap();
    let invalid =
        SealedDeclarationSnapshot::new(vec![MemoryRequest::new("other", "app.old.v1").unwrap()])
            .unwrap();
    let before = memory.borrow().clone();
    assert!(
        host.bootstrap(&invalid, &grants(), &GenericAllocationPolicy)
            .is_err()
    );
    assert_eq!(*memory.borrow(), before);
    host.bootstrap(
        &source(&["app.old.v1"]),
        &grants(),
        &GenericAllocationPolicy,
    )
    .unwrap();
    drop(host);
    let mut host = MemoryRuntime::new(memory.clone()).unwrap();
    let empty = source(&[]);
    host.bootstrap(&empty, &grants(), &Select).unwrap();
    let before = memory.borrow().clone();
    host.verify_bootstrap(&empty, &grants(), &Select).unwrap();
    assert!(matches!(
        host.bootstrap(&empty, &grants(), &GenericAllocationPolicy),
        Err(RuntimeBootstrapError::BindingMismatch)
    ));
    assert_eq!(*memory.borrow(), before);
    assert!(
        host.open_memory(&StableKey::parse("app.old.v1").unwrap())
            .is_ok()
    );
}

#[test]
fn fallible_growth_reports_overflow_and_poisoning_without_panicking() {
    let memory = VectorMemory::default();
    let mut host = MemoryRuntime::new(memory.clone()).unwrap();
    host.bootstrap(
        &source(&["app.one.v1", "app.two.v1"]),
        &grants(),
        &GenericAllocationPolicy,
    )
    .unwrap();
    let rows = host
        .open_memory(&StableKey::parse("app.one.v1").unwrap())
        .unwrap();
    rows.grow(1).unwrap();
    let before = memory.borrow().clone();
    assert_eq!(
        rows.grow(u64::MAX),
        Err(RuntimeGrowError::ArithmeticOverflow)
    );
    assert_eq!(*memory.borrow(), before);
    // Deliberately violate raw custody to qualify the checked opening boundary.
    memory.borrow_mut()[0] ^= 1;
    assert!(
        host.open_memory(&StableKey::parse("app.two.v1").unwrap())
            .is_err()
    );
    assert_eq!(rows.grow(0), Err(RuntimeGrowError::Poisoned));
    assert_eq!(rows.grow(1), Err(RuntimeGrowError::Poisoned));
}