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

//! Exact snapshot-removal reconciliation under independent operator custody.

#[cfg(test)]
mod tests;

use crate::fleet_ensure::model::{CanisterRuntimeStatus, EnsureAction, LiveCanister};
use thiserror::Error;

/// Refuse ambiguous destructive intent or changed physical custody/inventory.
#[derive(Clone, Debug, Eq, Error, PartialEq)]
pub enum SnapshotRemovalError {
    #[error("snapshot removal requires the reviewed stopped canister under sole operator custody")]
    Custody,
    #[error("snapshot removal inventory differs from the exact reviewed before/after set")]
    Inventory,
}

/// Recognize the exact before/after inventory. The executor owns durable intent authority.
pub(in crate::fleet_ensure) fn reconcile(
    action: &EnsureAction,
    operator: &str,
    live: Option<&LiveCanister>,
    snapshots: &[String],
) -> Result<bool, SnapshotRemovalError> {
    let EnsureAction::DeleteSnapshot {
        principal,
        snapshot_id,
        expected_snapshots,
        expected_module_sha256,
        ..
    } = action
    else {
        return Err(SnapshotRemovalError::Inventory);
    };
    let valid_id = |id: &String| {
        !id.is_empty()
            && id.len().is_multiple_of(2)
            && id
                .bytes()
                .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(&byte))
    };
    if !expected_snapshots.iter().all(valid_id)
        || !expected_snapshots.windows(2).all(|pair| pair[0] < pair[1])
        || !expected_snapshots.contains(snapshot_id)
    {
        return Err(SnapshotRemovalError::Inventory);
    }
    let Some(live) = live else {
        return Err(SnapshotRemovalError::Custody);
    };
    if live.principal != *principal
        || live.status != CanisterRuntimeStatus::Stopped
        || live.controllers != [operator]
        || live.module_sha256 != *expected_module_sha256
    {
        return Err(SnapshotRemovalError::Custody);
    }
    if snapshots == expected_snapshots {
        return Ok(false);
    }
    let remaining = expected_snapshots.iter().filter(|id| *id != snapshot_id);
    if remaining.eq(snapshots.iter()) {
        return Ok(true);
    }
    Err(SnapshotRemovalError::Inventory)
}