canic-core 0.110.33

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

//! Module: domain::provisioning_failure
//!
//! Responsibility: name bounded provisioning failures and decide active retry delays.
//! Does not own: timers, storage, observations, or effect reconciliation.
//! Boundary: only proved authority failures suspend immediately; unknown failures back off.

use candid::CandidType;
use serde::{Deserialize, Serialize};

/// Exact owner stage of the latest provisioning failure.
#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ProvisioningFailureStage {
    Provisioning,
    CoordinatorStatus,
    ComponentOrigin,
    ComponentAllocation,
    ComponentChildAllocation,
    ComponentRuntime,
    ComponentMembership,
    ComponentCommit,
    RootPreparation,
    RootActivation,
    StoreCatalog,
    StoreStatus,
    StoreIdentity,
    StoreCredential,
    StoreActivation,
}

/// Whether another active attempt is justified by the originating failure.
#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum ProvisioningRetryCategory {
    Backoff,
    ReviewRequired,
}

/// Maximum delay for transient attempts that retain uncertain-effect reconciliation.
pub const MAX_PROVISIONING_BACKOFF_SECONDS: u64 = 60;

/// Return a bounded exponential delay, or suspend active attempts for review.
#[must_use]
pub fn retry_delay_seconds(category: ProvisioningRetryCategory, failures: u32) -> Option<u64> {
    if matches!(category, ProvisioningRetryCategory::ReviewRequired) {
        None
    } else {
        Some((1_u64 << failures.saturating_sub(1).min(6)).min(MAX_PROVISIONING_BACKOFF_SECONDS))
    }
}