canic-host 0.111.0

Host-side App build and desired-state Fleet reconciliation library for Canic workspaces
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Pure authority and monotonic-progress checks for operator Component requests.

use crate::component_operation::{
    ComponentOperationError,
    model::{ComponentAuthorityRecord, ComponentPhase, ComponentProgressRecord},
};
use candid::Principal;
use canic_contracts::ids::{
    CanisterRole, ComponentSpecId, FleetSubnetRootBinding, FleetSubnetRootReleaseSet,
};

///
/// AuthorityBinding
///
/// Live authority excludes the historical review document's identity.
///

#[derive(Eq, PartialEq)]
struct AuthorityBinding<'a> {
    environment: &'a str,
    fleet: &'a str,
    root_name: &'a str,
    binding: &'a FleetSubnetRootBinding,
    release_set: &'a FleetSubnetRootReleaseSet,
    root_module_sha256: &'a str,
    root_candid_sha256: &'a [u8; 32],
    root_controllers: &'a [String],
    registry_sha256: &'a [u8; 32],
    operator: Principal,
    component_spec: &'a ComponentSpecId,
    spec_hash: &'a [u8; 32],
    role: &'a CanisterRole,
}

fn authority_binding(record: &ComponentAuthorityRecord) -> AuthorityBinding<'_> {
    let ComponentAuthorityRecord {
        source_plan_sha256: _,
        environment,
        fleet,
        root_name,
        binding,
        release_set,
        root_module_sha256,
        root_candid_sha256,
        root_controllers,
        registry_sha256,
        operator,
        component_spec,
        spec_hash,
        role,
    } = record;
    AuthorityBinding {
        environment,
        fleet,
        root_name,
        binding,
        release_set,
        root_module_sha256,
        root_candid_sha256,
        root_controllers,
        registry_sha256,
        operator: *operator,
        component_spec,
        spec_hash,
        role,
    }
}

/// Confine local operation names and target labels to individual path components.
pub fn validate_label(value: &str) -> Result<(), ComponentOperationError> {
    if value.is_empty()
        || value.len() > 128
        || !value
            .bytes()
            .all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'-' | b'_'))
    {
        return Err(ComponentOperationError::InvalidLabel(value.to_string()));
    }
    Ok(())
}

/// A review never follows changed release, controller, placement or spec authority.
pub fn validate_authority(
    expected: &ComponentAuthorityRecord,
    observed: &ComponentAuthorityRecord,
) -> Result<(), ComponentOperationError> {
    if authority_binding(expected) != authority_binding(observed) {
        return Err(ComponentOperationError::Authority {
            field: "reviewed binding",
        });
    }
    Ok(())
}

/// Preserve the first allocation identity and reject backward or unrelated status.
pub fn validate_progress(
    authority: &ComponentAuthorityRecord,
    previous: Option<&ComponentProgressRecord>,
    observed: &ComponentProgressRecord,
) -> Result<(), ComponentOperationError> {
    let allocation_id = canic_contracts::ids::ComponentInstanceId::from_root_allocation(
        authority.binding.authority.binding.fleet.fleet,
        authority.binding.authority.epoch,
        authority.binding.fleet_subnet_root,
        observed.allocation_sequence,
    );
    if observed.component != allocation_id {
        return Err(ComponentOperationError::Progress);
    }
    if observed.phase == ComponentPhase::Removed || observed.allocation_sequence == 0 {
        return Err(ComponentOperationError::Progress);
    }
    if let Some(previous) = previous {
        let same_allocation = previous.component == observed.component
            && previous.allocation_sequence == observed.allocation_sequence;
        let monotonic =
            observed.phase >= previous.phase && (!previous.complete || observed.complete);
        let same_binding = previous
            .binding
            .as_ref()
            .is_none_or(|binding| observed.binding.as_ref() == Some(binding));
        if !(same_allocation && monotonic && same_binding) {
            return Err(ComponentOperationError::Progress);
        }
    }
    if let Some(binding) = &observed.binding {
        if binding.canister_id == candid::Principal::anonymous()
            || binding.canister_id == candid::Principal::management_canister()
        {
            return Err(ComponentOperationError::Progress);
        }
        let same_identity = binding.authority == authority.binding.authority
            && binding.fleet_subnet_root == authority.binding.fleet_subnet_root
            && binding.placement_subnet == authority.binding.placement_subnet
            && binding.component == observed.component;
        let same_spec = binding.component_spec == authority.component_spec
            && binding.spec_hash == authority.spec_hash
            && binding.role == authority.role;
        if !(same_identity && same_spec) {
            return Err(ComponentOperationError::Progress);
        }
    }
    if observed.phase >= ComponentPhase::Installed && observed.binding.is_none() {
        return Err(ComponentOperationError::Progress);
    }
    if observed.complete
        && (observed.phase != ComponentPhase::Committed || observed.binding.is_none())
    {
        return Err(ComponentOperationError::Progress);
    }
    Ok(())
}