canic-core 0.86.1

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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! Module: ops::storage::index::mapper
//!
//! Responsibility: convert app/subnet index data to boundary views and inputs.
//! Does not own: stable index mutation, workflow orchestration, or DTO definitions.
//! Boundary: storage ops conversion layer for topology index snapshots.

use crate::{
    domain::policy::pure::topology::IndexPolicyInput,
    dto::{
        page::Page,
        topology::{AppIndexArgs, IndexEntryInput, IndexEntryResponse, SubnetIndexArgs},
    },
    storage::stable::index::{IndexEntryRecord, app::AppIndexData, subnet::SubnetIndexData},
    view::topology::IndexEntryView,
};

// -----------------------------------------------------------------------------
// Helpers
// -----------------------------------------------------------------------------

// Map stored index records into the shared index input entry shape.
fn data_entries_to_input(entries: Vec<IndexEntryRecord>) -> Vec<IndexEntryInput> {
    entries
        .into_iter()
        .map(|entry| IndexEntryInput {
            role: entry.role,
            pid: entry.pid,
        })
        .collect()
}

// Map index input entries back into stored index records.
fn input_entries_to_data(entries: Vec<IndexEntryInput>) -> Vec<IndexEntryRecord> {
    entries
        .into_iter()
        .map(|entry| IndexEntryRecord {
            role: entry.role,
            pid: entry.pid,
        })
        .collect()
}

///
/// AppIndexDataMapper
///
/// Storage-ops mapper for app index data and boundary input shapes.
///

pub struct AppIndexDataMapper;

impl AppIndexDataMapper {
    #[must_use]
    pub fn data_to_input(data: AppIndexData) -> AppIndexArgs {
        AppIndexArgs(data_entries_to_input(data.entries))
    }

    #[must_use]
    pub fn input_to_data(input: AppIndexArgs) -> AppIndexData {
        AppIndexData {
            entries: input_entries_to_data(input.0),
        }
    }
}

///
/// SubnetIndexDataMapper
///
/// Storage-ops mapper for subnet index data and boundary input shapes.
///

pub struct SubnetIndexDataMapper;

impl SubnetIndexDataMapper {
    #[must_use]
    pub fn data_to_input(data: SubnetIndexData) -> SubnetIndexArgs {
        SubnetIndexArgs(data_entries_to_input(data.entries))
    }

    #[must_use]
    pub fn input_to_data(input: SubnetIndexArgs) -> SubnetIndexData {
        SubnetIndexData {
            entries: input_entries_to_data(input.0),
        }
    }
}

///
/// IndexEntryMapper
///
/// Storage-ops mapper for index records, policy inputs, and response entries.
///

pub struct IndexEntryMapper;

impl IndexEntryMapper {
    #[must_use]
    pub fn records_to_projections(entries: Vec<IndexEntryRecord>) -> Vec<IndexEntryView> {
        entries
            .into_iter()
            .map(|entry| IndexEntryView {
                role: entry.role,
                pid: entry.pid,
            })
            .collect()
    }

    #[must_use]
    pub fn projection_page_to_response(page: Page<IndexEntryView>) -> Page<IndexEntryResponse> {
        Page {
            entries: page
                .entries
                .into_iter()
                .map(|entry| IndexEntryResponse {
                    role: entry.role,
                    pid: entry.pid,
                })
                .collect(),
            total: page.total,
        }
    }

    #[must_use]
    pub fn records_to_policy_input(entries: &[IndexEntryRecord]) -> Vec<IndexPolicyInput> {
        entries
            .iter()
            .map(|entry| IndexPolicyInput {
                role: entry.role.clone(),
                pid: entry.pid,
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{cdk::types::Principal, ids::CanisterRole};

    #[test]
    fn records_project_before_response_mapping() {
        let pid = Principal::from_slice(&[1]);
        let projections = IndexEntryMapper::records_to_projections(vec![IndexEntryRecord {
            role: CanisterRole::new("app"),
            pid,
        }]);

        let response = IndexEntryMapper::projection_page_to_response(Page {
            entries: projections,
            total: 1,
        });

        assert_eq!(response.total, 1);
        assert_eq!(response.entries.len(), 1);
        assert_eq!(response.entries[0].role, CanisterRole::new("app"));
        assert_eq!(response.entries[0].pid, pid);
    }
}