canic-core 0.69.3

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

//! Module: workflow::pool
//!
//! Responsibility: coordinate pool canister selection, reset, import, and admin flows.
//! Does not own: endpoint authorization, stable pool records, or pool policy decisions.
//! Boundary: workflow layer coordinating pool storage, policy, IC ops, and metrics.

pub mod admin;
pub mod admissibility;
pub mod controllers;
mod create_empty;
mod import;
pub mod query;
mod recycle;
mod reset;
pub mod scheduler;

use crate::{
    InternalError,
    domain::policy::pool::authority::require_pool_admin,
    ops::{
        ic::IcOps,
        runtime::{
            env::EnvOps,
            metrics::{
                pool::{PoolMetricOperation as MetricOperation, PoolMetricReason as MetricReason},
                recording::PoolMetricEvent as MetricEvent,
            },
        },
        storage::pool::PoolOps,
    },
    workflow::prelude::*,
};

///
/// PoolWorkflow
///

pub struct PoolWorkflow;

impl PoolWorkflow {
    fn mark_pending_reset(pid: Principal) {
        let created_at = IcOps::now_secs();
        PoolOps::mark_pending_reset(pid, created_at);
    }

    fn mark_ready(pid: Principal, cycles: Cycles) {
        let created_at = IcOps::now_secs();
        PoolOps::mark_ready(pid, cycles, created_at);
    }

    fn mark_failed(pid: Principal, err: &InternalError) {
        let created_at = IcOps::now_secs();
        PoolOps::mark_failed(pid, err, created_at);
    }

    #[must_use]
    pub fn pop_oldest_ready() -> Option<Principal> {
        let pid = PoolOps::pop_oldest_ready_pid();
        if pid.is_some() {
            MetricEvent::completed(MetricOperation::SelectReady, MetricReason::Ok);
        } else {
            MetricEvent::skipped(MetricOperation::SelectReady, MetricReason::Empty);
        }
        pid
    }

    #[must_use]
    pub fn pop_oldest_pending_reset() -> Option<Principal> {
        PoolOps::pop_oldest_pending_reset_pid()
    }

    fn require_pool_admin() -> Result<(), InternalError> {
        require_pool_admin(EnvOps::is_root()).map_err(Into::into)
    }
}