icydb 0.280.0

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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

use ic_memory::{
    MemoryAllocationPool, MemoryAuthority, MemoryRequest, RuntimeOpenError,
    SealedDeclarationSnapshot,
};
use icydb::__macro::open_memory;
use icydb::db::{ensure_default_memory_manager, memory_runtime};
use icydb::traits::{CanisterKind, Path};

const AUTHORITY: &str = "icydb.ensure_default_memory_manager_test";
const MEMORY_ID: u8 = 10;
const STABLE_KEY: &str = "icydb.ensure_default_memory_manager_test.commit.control.v1";

struct TestCanister;

impl Path for TestCanister {
    const PATH: &'static str = "test::Canister";
}

impl CanisterKind for TestCanister {
    const COMMIT_STABLE_KEY: &'static str = STABLE_KEY;
    const STARTUP_STABLE_KEY: &'static str =
        "icydb.ensure_default_memory_manager_test.startup.control.v1";
    const INTEGRITY_PROGRESS_STABLE_KEY: &'static str =
        "icydb.ensure_default_memory_manager_test.integrity.progress.v1";
}

#[test]
fn ensure_bootstraps_once_then_reuses_committed_allocations() {
    assert!(matches!(
        TestCanister::commit_memory_id(),
        Err(RuntimeOpenError::NotBootstrapped)
    ));
    assert!(memory_runtime().is_none());
    assert!(matches!(
        open_memory(STABLE_KEY),
        Err(RuntimeOpenError::NotBootstrapped)
    ));
    let requirements = SealedDeclarationSnapshot::new(
        ["commit.control", "startup.control", "integrity.progress"]
            .into_iter()
            .map(|role| MemoryRequest::new(AUTHORITY, &format!("{AUTHORITY}.{role}.v1")).unwrap())
            .collect(),
    )
    .unwrap();

    ensure_default_memory_manager(AUTHORITY, &requirements, 16, || {
        MemoryAllocationPool::new(
            vec![MemoryAuthority::new(AUTHORITY, format!("{AUTHORITY}."))?],
            vec![],
        )
    })
    .expect("cold ensure should bootstrap the runtime");
    let generation = memory_runtime()
        .unwrap()
        .committed_generation()
        .expect("cold ensure should publish committed allocations");

    ensure_default_memory_manager(AUTHORITY, &requirements, 16, || {
        MemoryAllocationPool::new(
            vec![MemoryAuthority::new(AUTHORITY, format!("{AUTHORITY}."))?],
            vec![],
        )
    })
    .expect("repeated ensure should adopt the runtime");
    assert_eq!(
        memory_runtime()
            .unwrap()
            .committed_generation()
            .expect("repeated ensure should preserve committed allocations"),
        generation,
    );
    open_memory(STABLE_KEY).expect("the ensured allocation should open");
    // Unknown keys cannot open or replace committed authority.
    assert!(matches!(
        open_memory("icydb.ensure_default_memory_manager_test.unknown.v1"),
        Err(RuntimeOpenError::StableKeyNotCommitted(_))
    ));
    open_memory(STABLE_KEY).expect("rejected opens must not change committed authority");

    // Control consumers use the same committed mapping, including host pools
    // below 100. No generated type supplies physical placement constants.
    assert_eq!(TestCanister::commit_memory_id().unwrap(), MEMORY_ID);
    assert_eq!(
        TestCanister::integrity_progress_memory_id().unwrap(),
        MEMORY_ID + 1
    );
    assert_eq!(TestCanister::startup_memory_id().unwrap(), MEMORY_ID + 2);

    let allocations = memory_runtime()
        .unwrap()
        .memory_allocations()
        .expect("the ensured runtime should report allocations");
    assert_eq!(allocations.summary.current_generation, Some(generation));
    assert_eq!(allocations.summary.bucket_size_pages, 16);
    let allocation = allocations
        .memories
        .iter()
        .find(|allocation| allocation.memory_manager_id == MEMORY_ID)
        .expect("the ensured slot should be reported");
    let runtime = memory_runtime().unwrap();
    let binding = runtime
        .committed_allocations()
        .unwrap()
        .iter()
        .find(|binding| binding.stable_key().as_str() == STABLE_KEY)
        .unwrap();
    assert_eq!(binding.slot().id(), allocation.memory_manager_id);
    assert_eq!(
        runtime
            .allocation_pool()
            .unwrap()
            .authority_for_key(binding.stable_key()),
        Some(AUTHORITY)
    );
    assert_eq!(
        memory_runtime()
            .unwrap()
            .memory_allocations()
            .expect("repeated allocation inspection should succeed"),
        allocations,
    );
}