canic-core 0.110.36

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

//! Lifecycle adapters.
//!
//! This module is public solely so it can be referenced by
//! macro expansions in downstream crates. It is not intended
//! for direct use.
//!
//! It must remain synchronous and minimal.

pub mod init;
pub mod upgrade;

use std::fmt;

///
/// LifecyclePhase
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum LifecyclePhase {
    Init,
    PostUpgrade,
}

impl fmt::Display for LifecyclePhase {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Init => f.write_str("init"),
            Self::PostUpgrade => f.write_str("post_upgrade"),
        }
    }
}

pub fn lifecycle_trap(phase: LifecyclePhase, err: impl fmt::Display) -> ! {
    ic_cdk::api::trap(format!("{phase}: {err}"))
}

fn retryable_nonroot_bootstrap_error(error: &crate::InternalError) -> bool {
    let code = error.public_error().code();
    [
        crate::diagnostics::codes::LIFECYCLE_INACTIVE,
        crate::diagnostics::codes::LIFECYCLE_UNAVAILABLE,
        crate::diagnostics::codes::PLATFORM_FAILED,
        crate::diagnostics::codes::PLATFORM_UNAVAILABLE,
        crate::diagnostics::codes::PLATFORM_INSUFFICIENT_LIQUID_CYCLES,
        crate::diagnostics::codes::CAPACITY_INSUFFICIENT,
        crate::diagnostics::codes::STATE_UNAVAILABLE,
    ]
    .into_iter()
    .any(|retryable| code == retryable.raw_code())
}

#[cfg(test)]
mod tests {
    use super::retryable_nonroot_bootstrap_error;

    #[test]
    fn nonroot_bootstrap_retries_transient_pool_shortage_but_not_hard_capacity() {
        assert!(retryable_nonroot_bootstrap_error(
            &crate::InternalError::public(crate::diagnostics::codes::CAPACITY_INSUFFICIENT)
        ));
        assert!(!retryable_nonroot_bootstrap_error(
            &crate::InternalError::resource_exhausted()
        ));
    }

    #[test]
    fn nonroot_bootstrap_preserves_retry_after_typed_liquid_cycle_failure() {
        let failure = ic_cdk::call::CallFailed::InsufficientLiquidCycleBalance(
            ic_cdk::call::InsufficientLiquidCycleBalance {
                available: 50,
                required: 100,
            },
        );
        let error = crate::InternalError::from(crate::infra::ic::IcInfraError::from(failure));
        assert!(retryable_nonroot_bootstrap_error(&error));
    }
}