canic-core 0.100.0

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
128
129

//! Module: ops::storage::directory::fleet
//!
//! Responsibility: provide deterministic access to the Fleet Directory stable record.
//! Does not own: stable schema, topology workflow, or endpoint DTOs.
//! Boundary: storage ops facade used by topology workflows and queries.

use crate::{
    InternalError,
    dto::topology::{DirectoryProvenance, FleetDirectoryInput},
    model::topology::TopologyDirectoryEntry,
    ops::{
        config::ConfigOps,
        prelude::*,
        storage::directory::{
            ensure_allowed_roles, ensure_required_roles, ensure_unique_roles,
            mapper::{DirectoryEntryMapper, FleetDirectoryDataMapper},
        },
    },
    storage::stable::directory::fleet::{FleetDirectory, FleetDirectoryData},
    view::topology::DirectoryEntryView,
};

///
/// FleetDirectoryOps
///
/// Storage-ops facade for the Fleet Directory stable record.
///

pub struct FleetDirectoryOps;

/// Fully validated Fleet Directory replacement ready for an infallible commit.
pub struct PreparedFleetDirectoryImport(FleetDirectoryData);

impl FleetDirectoryOps {
    // -------------------------------------------------------------------------
    // Getters
    // -------------------------------------------------------------------------

    #[must_use]
    pub fn get(role: &CanisterRole) -> Option<Principal> {
        FleetDirectory::export()
            .entries
            .iter()
            .find_map(|entry| (&entry.role == role).then_some(entry.pid))
    }

    // -------------------------------------------------------------------------
    // Canonical data access
    // -------------------------------------------------------------------------

    #[must_use]
    pub(crate) fn data() -> FleetDirectoryData {
        FleetDirectory::export()
    }

    #[must_use]
    pub fn entry_projections() -> Vec<DirectoryEntryView> {
        DirectoryEntryMapper::records_to_projections(FleetDirectory::export().entries)
    }

    #[must_use]
    pub(crate) fn topology_entries() -> Vec<TopologyDirectoryEntry> {
        DirectoryEntryMapper::records_to_topology_entries(&FleetDirectory::export().entries)
    }

    #[must_use]
    pub fn snapshot_args(provenance: DirectoryProvenance) -> FleetDirectoryInput {
        FleetDirectoryDataMapper::data_to_input(FleetDirectory::export(), provenance)
    }

    pub(crate) fn filter_args_for_local_config(
        args: FleetDirectoryInput,
    ) -> Result<FleetDirectoryInput, InternalError> {
        let allowed = ConfigOps::get()?.services.fleet.roles.clone();
        Ok(FleetDirectoryInput {
            provenance: args.provenance,
            entries: args
                .entries
                .into_iter()
                .filter(|entry| allowed.contains(&entry.role))
                .collect(),
        })
    }

    pub(crate) fn import_args_allow_incomplete(
        args: FleetDirectoryInput,
    ) -> Result<(), InternalError> {
        let prepared = Self::prepare_args_allow_incomplete(args)?;
        Self::commit_prepared(prepared);

        Ok(())
    }

    pub(crate) fn prepare_args_allow_incomplete(
        args: FleetDirectoryInput,
    ) -> Result<PreparedFleetDirectoryImport, InternalError> {
        let data = FleetDirectoryDataMapper::input_to_data(args);
        ensure_unique_roles(&data.entries, "Fleet")?;
        let allowed = ConfigOps::get()?.services.fleet.roles.clone();
        ensure_allowed_roles(&data.entries, "Fleet", &allowed)?;

        Ok(PreparedFleetDirectoryImport(data))
    }

    pub(crate) fn commit_prepared(prepared: PreparedFleetDirectoryImport) {
        FleetDirectory::import(prepared.0);
    }

    pub(crate) fn import(data: FleetDirectoryData) -> Result<(), InternalError> {
        ensure_unique_roles(&data.entries, "Fleet")?;
        let required = ConfigOps::get()?.services.fleet.roles.clone();
        ensure_allowed_roles(&data.entries, "Fleet", &required)?;
        ensure_required_roles(&data.entries, "Fleet", &required)?;
        FleetDirectory::import(data);

        Ok(())
    }

    /// Import a root-built partial Directory snapshot.
    ///
    /// External/propagated DTO snapshots must use `import_args_allow_incomplete`
    /// so they are checked against the configured FleetDirectory role set.
    pub(crate) fn import_trusted_partial(data: FleetDirectoryData) -> Result<(), InternalError> {
        ensure_unique_roles(&data.entries, "Fleet")?;
        FleetDirectory::import(data);

        Ok(())
    }
}