ic-query 0.81.0

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: nns::topology::report::check
//!
//! Responsibility: build derived NNS topology check reports.
//! Does not own: component collection, text rendering, or cache IO.
//! Boundary: projects component evidence directly into status fields and consistency checks.

use super::{
    NNS_TOPOLOGY_CHECK_REPORT_SCHEMA_VERSION, NnsTopologyAssessmentStatus, NnsTopologyCheckReport,
    NnsTopologyCheckRow, TopologyInventoryReports, coverage::topology_join_coverage_counts,
    percent::coverage_percent_text, registry_versions::topology_registry_versions,
};

pub(super) fn topology_check_report_from_reports(
    network: String,
    source_endpoint: String,
    subnet_report: crate::subnet_catalog::SubnetCatalogListReport,
    reports: &TopologyInventoryReports,
) -> NnsTopologyCheckReport {
    let registry_versions = topology_registry_versions(&subnet_report, reports);
    let registry_source_count = registry_versions.len();
    let registry_version_min = registry_versions
        .iter()
        .map(|row| row.registry_version)
        .min();
    let registry_version_max = registry_versions
        .iter()
        .map(|row| row.registry_version)
        .max();
    let registry_versions_aligned = registry_version_min == registry_version_max;
    let stale_source_count = registry_versions
        .iter()
        .filter(|row| row.stale == Some(true))
        .count();
    let unknown_freshness_source_count = registry_versions
        .iter()
        .filter(|row| row.stale.is_none())
        .count();
    let (known_join_count, unknown_join_count) = topology_join_coverage_counts(reports)
        .relationships()
        .into_iter()
        .fold(
            (0_usize, 0_usize),
            |(known, unknown), (_, next_known, next_unknown)| {
                (
                    known.saturating_add(next_known),
                    unknown.saturating_add(next_unknown),
                )
            },
        );
    let join_coverage = coverage_percent_text(known_join_count, unknown_join_count);
    let checks = vec![
        check_row(
            "registry_versions",
            registry_versions_aligned,
            registry_version_detail(
                registry_source_count,
                registry_version_min,
                registry_version_max,
                registry_versions_aligned,
            ),
        ),
        check_row(
            "cache_freshness",
            stale_source_count == 0 && unknown_freshness_source_count == 0,
            cache_freshness_detail(
                stale_source_count,
                unknown_freshness_source_count,
                &subnet_report,
            ),
        ),
        check_row(
            "join_coverage",
            unknown_join_count == 0,
            format!("{known_join_count} known, {unknown_join_count} unknown ({join_coverage})"),
        ),
    ];
    let status = NnsTopologyAssessmentStatus::from_ok(
        checks
            .iter()
            .all(|row| row.status == NnsTopologyAssessmentStatus::Ok),
    );

    NnsTopologyCheckReport {
        schema_version: NNS_TOPOLOGY_CHECK_REPORT_SCHEMA_VERSION,
        network,
        source_endpoint,
        status,
        registry_source_count,
        registry_version_min,
        registry_version_max,
        registry_versions_aligned,
        stale_source_count,
        unknown_freshness_source_count,
        subnet_catalog_stale: subnet_report.catalog_stale,
        subnet_catalog_stale_reason: subnet_report.stale_reason,
        known_join_count,
        unknown_join_count,
        join_coverage,
        checks,
    }
}

fn check_row(check: &str, is_ok: bool, detail: String) -> NnsTopologyCheckRow {
    NnsTopologyCheckRow {
        check: check.to_string(),
        status: NnsTopologyAssessmentStatus::from_ok(is_ok),
        detail,
    }
}

fn registry_version_detail(
    source_count: usize,
    min: Option<u64>,
    max: Option<u64>,
    aligned: bool,
) -> String {
    match (min, max, aligned) {
        (Some(version), Some(_), true) => {
            format!("{source_count} sources at registry version {version}")
        }
        (Some(min), Some(max), false) => {
            format!("{source_count} sources span registry versions {min}..{max}")
        }
        _ => "no registry versions recorded".to_string(),
    }
}

fn cache_freshness_detail(
    stale_source_count: usize,
    unknown_source_count: usize,
    subnet_report: &crate::subnet_catalog::SubnetCatalogListReport,
) -> String {
    if stale_source_count == 0 && unknown_source_count == 0 {
        return "no stale topology sources".to_string();
    }
    if stale_source_count == 0 {
        return format!("{unknown_source_count} topology sources have no age policy");
    }
    if subnet_report.catalog_stale {
        return format!(
            "{stale_source_count} stale source, {unknown_source_count} without an age policy; subnet catalog {}",
            subnet_report.stale_reason,
        );
    }
    format!("{stale_source_count} stale source, {unknown_source_count} without an age policy")
}