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

//! Module: workflow::topology::directory::query
//!
//! Responsibility: expose read-only Fleet and Subnet Directory pages and role lookups.
//! Does not own: Directory storage mutation, endpoint authorization, or DTO schemas.
//! Boundary: workflow query facade over Directory storage ops.

use crate::{
    InternalError,
    cdk::types::Principal,
    dto::{
        page::{Page, PageRequest},
        topology::{
            DirectoryEntryResponse, FleetDirectoryPageResponse, SubnetDirectoryPageResponse,
        },
    },
    ids::CanisterRole,
    ops::{
        storage::directory::{
            fleet::FleetDirectoryOps, mapper::DirectoryEntryMapper, subnet::SubnetDirectoryOps,
        },
        topology::directory::current_provenance,
    },
    view::topology::DirectoryEntryView,
    workflow::view::paginate::paginate_vec,
};

///
/// FleetDirectoryQuery
///

pub struct FleetDirectoryQuery;

impl FleetDirectoryQuery {
    #[must_use]
    pub fn get(role: CanisterRole) -> Option<Principal> {
        FleetDirectoryOps::get(&role)
    }

    pub fn page(page: PageRequest) -> Result<FleetDirectoryPageResponse, InternalError> {
        let page = directory_page(FleetDirectoryOps::entry_projections(), page);
        Ok(FleetDirectoryPageResponse {
            provenance: current_provenance()?,
            entries: page.entries,
            total: page.total,
        })
    }
}

///
/// SubnetDirectoryQuery
///

pub struct SubnetDirectoryQuery;

impl SubnetDirectoryQuery {
    #[must_use]
    pub fn get(role: CanisterRole) -> Option<Principal> {
        SubnetDirectoryOps::get(&role)
    }

    pub fn page(page: PageRequest) -> Result<SubnetDirectoryPageResponse, InternalError> {
        let page = directory_page(SubnetDirectoryOps::entry_projections(), page);
        Ok(SubnetDirectoryPageResponse {
            provenance: current_provenance()?,
            entries: page.entries,
            total: page.total,
        })
    }
}

// Paginate read-only Directory projections and let ops own response mapping.
fn directory_page(
    entries: Vec<DirectoryEntryView>,
    page: PageRequest,
) -> Page<DirectoryEntryResponse> {
    DirectoryEntryMapper::projection_page_to_response(paginate_vec(entries, page))
}