canic-core 0.27.6

Canic — a canister orchestration and management toolkit for the Internet Computer
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

pub mod mapper;

use crate::{
    InternalError,
    ops::prelude::*,
    storage::stable::pool::{PoolRecord, PoolStatus, PoolStore, PoolStoreRecord},
};

///
/// PoolOps
/// Operational façade over pool storage.
///

pub struct PoolOps;

impl PoolOps {
    // ---------------------------------------------------------------
    // Registration
    // ---------------------------------------------------------------

    pub fn register_ready(
        pid: Principal,
        cycles: Cycles,
        role: Option<CanisterRole>,
        parent: Option<Principal>,
        module_hash: Option<Vec<u8>>,
        created_at: u64,
    ) {
        PoolStore::register(
            pid,
            cycles,
            PoolStatus::Ready,
            role,
            parent,
            module_hash,
            created_at,
        );
    }

    // ---------------------------------------------------------------
    // State transitions
    // ---------------------------------------------------------------

    pub fn mark_pending_reset(pid: Principal, created_at: u64) {
        Self::register_or_update_state(
            pid,
            Cycles::default(),
            PoolStatus::PendingReset,
            None,
            created_at,
        );
    }

    pub fn mark_ready(pid: Principal, cycles: Cycles, created_at: u64) {
        Self::register_or_update_state(pid, cycles, PoolStatus::Ready, None, created_at);
    }

    pub fn mark_failed(pid: Principal, err: &InternalError, created_at: u64) {
        Self::register_or_update_state(
            pid,
            Cycles::default(),
            PoolStatus::Failed {
                reason: err.to_string(),
            },
            None,
            created_at,
        );
    }

    // ---------------------------------------------------------------
    // Data (read-only)
    // ---------------------------------------------------------------

    #[must_use]
    pub fn data() -> PoolStoreRecord {
        PoolStore::export()
    }

    #[must_use]
    pub fn contains(pid: &Principal) -> bool {
        PoolStore::contains(pid)
    }

    #[must_use]
    pub fn has_pending_reset() -> bool {
        PoolStore::has_status(PoolStatus::PendingReset)
    }

    #[must_use]
    pub fn pop_oldest_ready_pid() -> Option<Principal> {
        Self::pop_oldest_by_status(PoolStatus::Ready)
    }

    #[must_use]
    pub fn pop_oldest_pending_reset_pid() -> Option<Principal> {
        Self::pop_oldest_by_status(PoolStatus::PendingReset)
    }

    // ---------------------------------------------------------------
    // Removal
    // ---------------------------------------------------------------

    pub fn remove(pid: &Principal) {
        PoolStore::remove(pid);
    }

    // ---------------------------------------------------------------
    // Internal helper
    // ---------------------------------------------------------------

    fn pop_oldest_by_status(status: PoolStatus) -> Option<Principal> {
        let data = PoolStore::export();
        let (pid, _) = Self::select_oldest(data, &status)?;
        Self::remove(&pid);
        Some(pid)
    }

    fn select_oldest(
        data: PoolStoreRecord,
        status: &PoolStatus,
    ) -> Option<(Principal, PoolRecord)> {
        let mut selected: Option<(Principal, PoolRecord)> = None;

        for (pid, record) in data.entries {
            let matches = match status {
                PoolStatus::Ready => matches!(record.state.status, PoolStatus::Ready),
                PoolStatus::PendingReset => matches!(record.state.status, PoolStatus::PendingReset),
                PoolStatus::Failed { .. } => false,
            };

            if !matches {
                continue;
            }

            let replace = match &selected {
                None => true,
                Some((best_pid, best_record)) => {
                    record.header.created_at < best_record.header.created_at
                        || (record.header.created_at == best_record.header.created_at
                            && pid.as_slice() < best_pid.as_slice())
                }
            };

            if replace {
                selected = Some((pid, record));
            }
        }

        selected
    }

    fn register_or_update_state(
        pid: Principal,
        cycles: Cycles,
        status: PoolStatus,
        role: Option<CanisterRole>,
        created_at: u64,
    ) {
        let updated = PoolStore::update_state_with(pid, |mut state| {
            state.cycles = cycles.clone();
            state.status = status.clone();

            if role.is_some() {
                state.role.clone_from(&role);
            }

            state
        });

        if !updated {
            PoolStore::register(pid, cycles, status, role, None, None, created_at);
        }
    }
}