ic-query 0.27.1

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: cache::text
//!
//! Responsibility: render the generic cache-status report for people.
//! Does not own: filesystem inspection, JSON output, or cache policy.
//! Boundary: keeps raw paths and invalid-cache diagnostics visible.

use super::CacheStatusReport;
use crate::{
    duration::display_duration_seconds,
    human_quantity::byte_count_text,
    table::{ColumnAlign, render_table},
    text_value::{sanitize_text, yes_no},
};

/// Render a human-readable cache-status report.
#[must_use]
pub fn cache_status_report_text(report: &CacheStatusReport) -> String {
    let mut lines = vec![
        format!("cache_root: {}", sanitize_text(&report.cache_root)),
        format!("cache_root_found: {}", yes_no(report.cache_root_found)),
        format!("inspected_at: {}", sanitize_text(&report.inspected_at)),
        format!(
            "family_validation_performed: {}",
            yes_no(report.family_validation_performed)
        ),
        format!("cache_count: {}", report.cache_count),
        format!("readable_headers: {}", report.readable_header_count),
        format!("invalid_headers: {}", report.invalid_header_count),
        format!("fresh: {}", report.fresh_count),
        format!("stale: {}", report.stale_count),
        format!("unmanaged_age: {}", report.unmanaged_age_count),
        format!("unknown_age: {}", report.unknown_age_count),
        format!(
            "total_size_bytes: {}",
            byte_count_text(u128::from(report.total_size_bytes))
        ),
        format!("refresh_locks: {}", report.refresh_lock_count),
        format!("active_refresh_locks: {}", report.active_refresh_lock_count),
        format!("stale_refresh_locks: {}", report.stale_refresh_lock_count),
        format!(
            "invalid_refresh_locks: {}",
            report.invalid_refresh_lock_count
        ),
        format!(
            "refresh_lock_size_bytes: {}",
            byte_count_text(u128::from(report.refresh_lock_size_bytes))
        ),
        format!("truncated: {}", yes_no(report.truncated)),
    ];
    append_cache_rows(&mut lines, report);
    append_refresh_lock_rows(&mut lines, report);
    lines.join("\n")
}

fn append_cache_rows(lines: &mut Vec<String>, report: &CacheStatusReport) {
    if !report.caches.is_empty() {
        lines.push(String::new());
        lines.push(render_table(
            &[
                "HEADER",
                "AGE STATE",
                "INVALID RECOVERY",
                "COMPONENT",
                "AGE",
                "STALE AFTER",
                "BYTES",
                "PATH",
            ],
            &report
                .caches
                .iter()
                .map(|row| {
                    [
                        row.header_status.as_str().to_string(),
                        row.age_status.as_str().to_string(),
                        row.recovery_policy.as_str().to_string(),
                        row.component.clone(),
                        row.age_seconds
                            .map_or_else(|| "-".to_string(), display_duration_seconds),
                        row.stale_after_seconds
                            .map_or_else(|| "-".to_string(), display_duration_seconds),
                        byte_count_text(u128::from(row.size_bytes)),
                        row.relative_path.clone(),
                    ]
                })
                .collect::<Vec<_>>(),
            &[
                ColumnAlign::Left,
                ColumnAlign::Left,
                ColumnAlign::Left,
                ColumnAlign::Left,
                ColumnAlign::Right,
                ColumnAlign::Right,
                ColumnAlign::Right,
                ColumnAlign::Left,
            ],
        ));
        for row in report
            .caches
            .iter()
            .filter(|row| row.inspection_error.is_some())
        {
            lines.push(format!(
                "cache_inspection_error[{}]: {}",
                sanitize_text(&row.relative_path),
                sanitize_text(row.inspection_error.as_deref().unwrap_or_default())
            ));
        }
    }
}

fn append_refresh_lock_rows(lines: &mut Vec<String>, report: &CacheStatusReport) {
    if !report.refresh_locks.is_empty() {
        lines.push(String::new());
        lines.push("REFRESH LOCKS".to_string());
        lines.push(render_table(
            &["STATUS", "COMPONENT", "AGE", "STALE AFTER", "PID", "PATH"],
            &report
                .refresh_locks
                .iter()
                .map(|row| {
                    [
                        row.status.as_str().to_string(),
                        row.component.clone(),
                        row.age_seconds
                            .map_or_else(|| "-".to_string(), display_duration_seconds),
                        row.stale_after_seconds
                            .map_or_else(|| "-".to_string(), display_duration_seconds),
                        row.pid
                            .map_or_else(|| "-".to_string(), |pid| pid.to_string()),
                        row.relative_path.clone(),
                    ]
                })
                .collect::<Vec<_>>(),
            &[
                ColumnAlign::Left,
                ColumnAlign::Left,
                ColumnAlign::Right,
                ColumnAlign::Right,
                ColumnAlign::Right,
                ColumnAlign::Left,
            ],
        ));
        for row in report
            .refresh_locks
            .iter()
            .filter(|row| row.error.is_some())
        {
            lines.push(format!(
                "refresh_lock_error[{}]: {}",
                sanitize_text(&row.relative_path),
                sanitize_text(row.error.as_deref().unwrap_or_default())
            ));
        }
    }
}