ic-query 0.27.3

Internet Computer query library for NNS, SNS, ICRC, system canisters, and public network metadata
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

//! Module: sns::report::text::canisters
//!
//! Responsibility: render SNS Root canister inventory and health reports.
//! Does not own: Root calls, report construction, JSON serialization, or lookup.
//! Boundary: presents raw report fields compactly without changing the JSON contract.

use crate::{
    human_quantity::{decimal_byte_count_text, decimal_cycle_count_text},
    sns::report::SnsCanisterReport,
    table::{ColumnAlign, render_table},
    text_value::{optional_text, sanitize_text, truncate_text, yes_no},
};

const MODULE_HASH_TEXT_CHARS: usize = 12;

/// Render one SNS Root canister report as human-facing text.
#[must_use]
pub fn sns_canister_report_text(report: &SnsCanisterReport) -> String {
    let mut lines = vec![
        format!("network: {}", sanitize_text(&report.network)),
        format!("sns_id: {}", report.id),
        format!("name: {}", sanitize_text(&report.name)),
        format!("root_canister_id: {}", report.root_canister_id),
        format!("canister_count: {}", report.canister_count),
        format!("health_status_count: {}", report.health_status_count),
        format!(
            "reported_zero_cycles_count: {}",
            report.reported_zero_cycles_count
        ),
        format!(
            "cycles_unavailable_count: {}",
            report.cycles_unavailable_count
        ),
        format!("gap_count: {}", report.gap_count),
        format!(
            "health_query_status: {}",
            if report.health_query_gap.is_some() {
                "failed"
            } else {
                "succeeded"
            }
        ),
        format!(
            "point_in_time_guaranteed: {}",
            yes_no(report.point_in_time_guaranteed)
        ),
        format!("inventory_method: {}", report.inventory_method.as_str()),
        format!("health_method: {}", report.health_method.as_str()),
        format!("health_call_type: {}", report.health_call_type.as_str()),
        format!(
            "health_update_canister_list: {}",
            yes_no(report.health_update_canister_list)
        ),
        format!("sns_wasm_canister_id: {}", report.sns_wasm_canister_id),
        format!("fetched_at: {}", sanitize_text(&report.fetched_at)),
        format!(
            "source_endpoint: {}",
            sanitize_text(&report.source_endpoint)
        ),
        String::new(),
        canisters_table(report),
    ];

    if let Some(gap) = &report.health_query_gap {
        lines.extend([
            String::new(),
            "health_query_gap:".to_string(),
            render_table(
                &["METHOD", "REASON"],
                &[[gap.method.as_str().to_string(), sanitize_text(&gap.reason)]],
                &[ColumnAlign::Left, ColumnAlign::Left],
            ),
        ]);
    }

    if !report.gaps.is_empty() {
        lines.push(String::new());
        lines.push("gaps:".to_string());
        lines.push(relation_gaps_table(report));
    }

    lines.join("\n")
}

fn canisters_table(report: &SnsCanisterReport) -> String {
    render_table(
        &[
            "ROLE",
            "CANISTER",
            "STATUS",
            "MODULE HASH",
            "CYCLES",
            "MEMORY",
            "CONTROLLERS",
        ],
        &report
            .canisters
            .iter()
            .map(|canister| {
                [
                    canister.role.as_str().to_string(),
                    canister.canister_id.clone(),
                    canister
                        .status
                        .map_or_else(|| "-".to_string(), |status| status.as_str().to_string()),
                    canister.module_hash_hex.as_ref().map_or_else(
                        || "-".to_string(),
                        |hash| truncate_text(hash, MODULE_HASH_TEXT_CHARS),
                    ),
                    canister
                        .cycles
                        .as_deref()
                        .map_or_else(|| "-".to_string(), decimal_cycle_count_text),
                    canister
                        .memory_size
                        .as_deref()
                        .map_or_else(|| "-".to_string(), decimal_byte_count_text),
                    canister.controllers.len().to_string(),
                ]
            })
            .collect::<Vec<_>>(),
        &[
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Right,
            ColumnAlign::Right,
            ColumnAlign::Right,
        ],
    )
}

fn relation_gaps_table(report: &SnsCanisterReport) -> String {
    render_table(
        &["KIND", "ROLE", "INVENTORY CANISTER", "SUMMARY CANISTER"],
        &report
            .gaps
            .iter()
            .map(|gap| {
                [
                    gap.kind.as_str().to_string(),
                    gap.role.as_str().to_string(),
                    optional_text(gap.inventory_canister_id.as_ref()),
                    optional_text(gap.summary_canister_id.as_ref()),
                ]
            })
            .collect::<Vec<_>>(),
        &[
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
        ],
    )
}