canic-core 0.100.93

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

use crate::{InternalError, InternalErrorClass, InternalErrorOrigin, dto::error::Error};

fn internal_error_to_public(err: &InternalError) -> Error {
    if let Some(public) = err.public_error() {
        return public.clone();
    }

    let message = err.to_string();

    match err.class() {
        InternalErrorClass::Access => Error::unauthorized(message),

        InternalErrorClass::Domain => match err.origin() {
            InternalErrorOrigin::Config => Error::invalid(message),
            _ => Error::conflict(message),
        },

        InternalErrorClass::Invariant => Error::invariant(message),

        InternalErrorClass::Infra | InternalErrorClass::Ops | InternalErrorClass::Workflow => {
            Error::internal(message)
        }
    }
}

impl From<&InternalError> for Error {
    fn from(err: &InternalError) -> Self {
        internal_error_to_public(err)
    }
}

impl From<InternalError> for Error {
    fn from(err: InternalError) -> Self {
        internal_error_to_public(&err)
    }
}

// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        access::AccessError,
        domain::policy::pure::{
            component_allocation::ComponentAllocationPolicyError,
            component_child_allocation::ComponentChildAllocationPolicyError,
        },
        dto::error::ErrorCode,
        ids::CanisterRole,
    };

    #[test]
    fn internal_error_mapping_matches_class_contract() {
        let access: Error = InternalError::from(AccessError::Denied("denied".to_string())).into();
        assert_eq!(access.code, ErrorCode::Unauthorized);

        let domain_config: Error =
            InternalError::domain(InternalErrorOrigin::Config, "bad config").into();
        assert_eq!(domain_config.code, ErrorCode::InvalidInput);

        let domain_other: Error =
            InternalError::domain(InternalErrorOrigin::Domain, "conflict").into();
        assert_eq!(domain_other.code, ErrorCode::Conflict);

        let invariant: Error =
            InternalError::invariant(InternalErrorOrigin::Ops, "broken invariant").into();
        assert_eq!(invariant.code, ErrorCode::InvariantViolation);

        let infra: Error = InternalError::infra(InternalErrorOrigin::Infra, "infra fail").into();
        assert_eq!(infra.code, ErrorCode::Internal);

        let ops: Error = InternalError::ops(InternalErrorOrigin::Ops, "ops fail").into();
        assert_eq!(ops.code, ErrorCode::Internal);

        let workflow: Error =
            InternalError::workflow(InternalErrorOrigin::Workflow, "workflow fail").into();
        assert_eq!(workflow.code, ErrorCode::Internal);

        let invalid_allocation: Error =
            InternalError::from(ComponentAllocationPolicyError::EmptyOperationId).into();
        assert_eq!(invalid_allocation.code, ErrorCode::InvalidInput);

        let exhausted_allocation: Error =
            InternalError::from(ComponentAllocationPolicyError::ComponentCapacityExhausted).into();
        assert_eq!(exhausted_allocation.code, ErrorCode::ResourceExhausted);

        let invalid_authority: Error =
            InternalError::from(ComponentAllocationPolicyError::RootTopologyDigestMismatch).into();
        assert_eq!(invalid_authority.code, ErrorCode::InvariantViolation);

        let forbidden_child: Error =
            InternalError::from(ComponentChildAllocationPolicyError::SpawnGrantMissing {
                parent_role: CanisterRole::new("project_hub"),
                child_role: CanisterRole::new("project_ledger"),
            })
            .into();
        assert_eq!(forbidden_child.code, ErrorCode::Forbidden);

        let stale_child: Error = InternalError::from(
            ComponentChildAllocationPolicyError::ComponentRegistryAuthorityMismatch,
        )
        .into();
        assert_eq!(stale_child.code, ErrorCode::Conflict);

        let exhausted_child: Error = InternalError::from(
            ComponentChildAllocationPolicyError::ComponentDescendantCapacityExhausted,
        )
        .into();
        assert_eq!(exhausted_child.code, ErrorCode::ResourceExhausted);

        let token_expired: Error = AccessError::DelegatedAuthTokenExpired.into();
        assert_eq!(token_expired.code, ErrorCode::AuthTokenExpired);

        let cert_expired: Error = AccessError::DelegatedAuthCertExpired.into();
        assert_eq!(cert_expired.code, ErrorCode::AuthProofExpired);
    }

    #[test]
    fn public_error_is_preserved_without_remap() {
        let public = Error::not_found("missing");
        let remapped: Error = InternalError::public(public.clone()).into();
        assert_eq!(remapped, public);
    }
}