ic-query 0.37.1

Internet Computer query library for CloudEngine, 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

//! Module: cloud_engine::node::text
//!
//! Responsibility: render CloudEngine Type4 node reports as human-facing text.
//! Does not own: JSON serialization, source validation, live calls, or process output.
//! Boundary: separates off-chain Dashboard provenance from node tables.

use super::{CloudEngineNodeInfoReport, CloudEngineNodeListReport, CloudEngineNodeRow};
use crate::{
    ic::dashboard_provenance_lines,
    table::{ColumnAlign, render_table},
    text_value::{optional_text, sanitize_text, yes_no},
};

/// Render one complete explicitly scoped Type4 node list.
#[must_use]
pub fn cloud_engine_node_list_report_text(report: &CloudEngineNodeListReport) -> String {
    let mut lines = dashboard_provenance_lines(&report.provenance);
    lines.extend([
        format!("node_reward_type: {}", report.node_reward_type),
        format!("included_statuses: {}", report.included_statuses.join(",")),
        format!(
            "requested_node_provider_id: {}",
            optional_text(report.requested_node_provider_id.as_ref())
        ),
        format!("node_count: {}", report.node_count),
        format!("status_up: {}", report.status_counts.up),
        format!("status_down: {}", report.status_counts.down),
        format!("status_disabled: {}", report.status_counts.disabled),
        format!("status_degraded: {}", report.status_counts.degraded),
        format!("status_unknown: {}", report.status_counts.unknown),
        format!("node_provider_count: {}", report.node_provider_count),
        format!(
            "cloud_engine_subnet_count: {}",
            report.cloud_engine_subnet_count
        ),
        format!(
            "unassigned_cloud_engine_node_count: {}",
            report.unassigned_cloud_engine_node_count
        ),
    ]);
    if !report.nodes.is_empty() {
        lines.push(String::new());
        lines.push("CloudEngine nodes".to_string());
        lines.push(node_table(&report.nodes));
    }
    lines.join("\n")
}

/// Render one exact Type4 node observation.
#[must_use]
pub fn cloud_engine_node_info_report_text(report: &CloudEngineNodeInfoReport) -> String {
    let node = &report.node;
    let mut lines = dashboard_provenance_lines(&report.provenance);
    lines.extend([
        format!("node_id: {}", node.node_id),
        format!("status: {}", sanitize_text(&node.status)),
        format!("node_type: {}", sanitize_text(&node.node_type)),
        format!(
            "node_reward_type: {}",
            sanitize_text(&node.node_reward_type)
        ),
        format!("node_provider_id: {}", node.node_provider_id),
        format!(
            "node_provider_name: {}",
            sanitize_text(&node.node_provider_name)
        ),
        format!("node_operator_id: {}", node.node_operator_id),
        format!(
            "cloud_engine_subnet_id: {}",
            optional_text(node.cloud_engine_subnet_id.as_ref())
        ),
        format!("subnet_id: {}", optional_text(node.subnet_id.as_ref())),
        format!("data_center_id: {}", sanitize_text(&node.data_center_id)),
        format!(
            "data_center_name: {}",
            sanitize_text(&node.data_center_name)
        ),
        format!("owner: {}", sanitize_text(node.owner.trim())),
        format!("region: {}", sanitize_text(&node.region)),
        format!(
            "guestos_version: {}",
            optional_text(node.guestos_version.as_ref())
        ),
        format!(
            "guestos_tee_active: {}",
            optional_bool(node.guestos_tee_active)
        ),
        format!("ip_address: {}", optional_text(node.ip_address.as_ref())),
        format!(
            "ipv4_connectivity_status: {}",
            optional_bool(node.ipv4_connectivity_status)
        ),
        format!(
            "node_hardware_generation: {}",
            optional_text(node.node_hardware_generation.as_ref())
        ),
        format!("alert_name: {}", optional_text(node.alert_name.as_ref())),
    ]);
    lines.join("\n")
}

fn node_table(nodes: &[CloudEngineNodeRow]) -> String {
    let rows = nodes
        .iter()
        .map(|node| {
            [
                node.node_id.clone(),
                sanitize_text(&node.status),
                node.cloud_engine_subnet_id
                    .as_ref()
                    .map_or_else(|| "-".to_string(), Clone::clone),
                node.node_provider_id.clone(),
                node.node_operator_id.clone(),
                sanitize_text(&node.data_center_id),
                node.guestos_version
                    .as_ref()
                    .map_or_else(|| "-".to_string(), Clone::clone),
            ]
        })
        .collect::<Vec<_>>();
    render_table(
        &[
            "Node",
            "Status",
            "CE Subnet",
            "Provider",
            "Operator",
            "DC",
            "GuestOS",
        ],
        &rows,
        &[
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
            ColumnAlign::Left,
        ],
    )
}

fn optional_bool(value: Option<bool>) -> &'static str {
    value.map_or("-", yes_no)
}