canic-control-plane 0.92.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

use crate::workflow::runtime::template::publication::WasmStorePublicationWorkflow;
use canic_core::api::lifecycle::metrics::{
    WasmStoreMetricOperation, WasmStoreMetricOutcome, WasmStoreMetricReason, WasmStoreMetricSource,
    WasmStoreMetricsApi,
};
use canic_core::control_plane_support::error::InternalError;
use canic_core::dto::error::ErrorCode;

impl WasmStorePublicationWorkflow {
    // Return true when one failed store call represents store-capacity exhaustion.
    pub(super) fn is_store_capacity_exceeded(err: &InternalError) -> bool {
        err.public_error()
            .is_some_and(|public| public.code == ErrorCode::WasmStoreCapacityExceeded)
    }
}

// Record one wasm-store metric point through the core API facade.
pub(super) fn record_wasm_store_metric(
    operation: WasmStoreMetricOperation,
    source: WasmStoreMetricSource,
    outcome: WasmStoreMetricOutcome,
    reason: WasmStoreMetricReason,
) {
    WasmStoreMetricsApi::record(operation, source, outcome, reason);
}

// Record one target-store release publish failure reason.
pub(super) fn record_wasm_store_publish_failed(reason: WasmStoreMetricReason) {
    record_wasm_store_metric(
        WasmStoreMetricOperation::ReleasePublish,
        WasmStoreMetricSource::TargetStore,
        WasmStoreMetricOutcome::Failed,
        reason,
    );
}

// Map publication failures into stable wasm-store metric reasons.
pub(super) trait WasmStorePublicationError {
    fn from_publication_error(err: &InternalError) -> Self;
}

impl WasmStorePublicationError for WasmStoreMetricReason {
    fn from_publication_error(err: &InternalError) -> Self {
        match err.public_error().map(|public| public.code) {
            Some(ErrorCode::WasmStoreCapacityExceeded) => Self::Capacity,
            Some(ErrorCode::WasmStoreChunkMissing) => Self::MissingChunk,
            Some(ErrorCode::WasmStoreHashMismatch) => Self::HashMismatch,
            Some(ErrorCode::WasmStoreManifestMissing) => Self::MissingManifest,
            Some(ErrorCode::Conflict | ErrorCode::InvariantViolation | ErrorCode::NotFound) => {
                Self::InvalidState
            }
            Some(_) => Self::StoreCall,
            None => Self::InvalidState,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use canic_core::dto::error::Error;

    #[test]
    fn publication_failure_reasons_use_public_codes() {
        let cases = [
            (
                ErrorCode::WasmStoreCapacityExceeded,
                WasmStoreMetricReason::Capacity,
            ),
            (
                ErrorCode::WasmStoreChunkMissing,
                WasmStoreMetricReason::MissingChunk,
            ),
            (
                ErrorCode::WasmStoreHashMismatch,
                WasmStoreMetricReason::HashMismatch,
            ),
            (
                ErrorCode::WasmStoreManifestMissing,
                WasmStoreMetricReason::MissingManifest,
            ),
            (ErrorCode::Conflict, WasmStoreMetricReason::InvalidState),
            (
                ErrorCode::InvariantViolation,
                WasmStoreMetricReason::InvalidState,
            ),
            (ErrorCode::NotFound, WasmStoreMetricReason::InvalidState),
            (ErrorCode::Unavailable, WasmStoreMetricReason::StoreCall),
        ];

        for (code, expected) in cases {
            let err = InternalError::public(Error::new(code, "detail".to_string()));
            assert!(WasmStoreMetricReason::from_publication_error(&err) == expected);
        }
    }
}