icydb-cli 0.296.10

Developer CLI tools for IcyDB
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

use super::{average, entity_row, render_metrics_report};
use icydb::metrics::{EntityMetrics, MetricsReport};

#[test]
fn metrics_report_displays_producer_overflow_quality() {
    let wire = icydb_schema::wire::encode_one(MetricsReport::default()).unwrap();
    let report: MetricsReport = icydb_schema::wire::decode_one(&wire).unwrap();
    let rendered = render_metrics_report(&report);
    assert_eq!(
        rendered
            .matches("sample overflow=false, total overflow=false")
            .count(),
        2
    );
    assert!(!rendered.contains("+ marks a clipped count or instruction total"));
    assert!(rendered.contains("None"));
}

fn decoded_entity(
    hits: u64,
    total: u128,
    mean: Option<u128>,
    samples_saturated: bool,
    total_saturated: bool,
) -> EntityMetrics {
    #[derive(serde::Serialize)]
    struct ReportEntity {
        path: &'static str,
        instructions: ReportInstructions,
    }
    #[derive(serde::Serialize)]
    struct ReportInstructions {
        samples: u64,
        total: u128,
        maximum: Option<u64>,
        samples_overflowed: bool,
        total_overflowed: bool,
    }
    let maximum = (hits != 0).then_some(u64::try_from(total).unwrap_or(u64::MAX));
    let instructions = ReportInstructions {
        samples: hits,
        total,
        maximum,
        samples_overflowed: samples_saturated,
        total_overflowed: total_saturated,
    };
    let encoded = icydb_schema::wire::encode_one(ReportEntity {
        path: "app.Entity",
        instructions,
    })
    .expect("encode report entity");
    let decoded: EntityMetrics =
        icydb_schema::wire::decode_one(&encoded).expect("decode report entity");
    assert_eq!(average(decoded.instructions()), mean);
    decoded
}

#[test]
fn metrics_entity_row_keeps_fields_and_rounds_average_down() {
    assert_eq!(
        entity_row(&decoded_entity(3, 10, Some(3), false, false)),
        ["app.Entity", "3", "10", "3", "10"].map(str::to_string),
    );
}

#[test]
fn metrics_average_distinguishes_empty_from_measured_zero() {
    assert_eq!(
        entity_row(&decoded_entity(0, 0, None, false, false))[3],
        "unavailable"
    );
    assert_eq!(
        entity_row(&decoded_entity(3, 0, Some(0), false, false))[3],
        "0"
    );
}

#[test]
fn metrics_average_preserves_exact_caps_and_producer_quality() {
    assert_eq!(
        entity_row(&decoded_entity(u64::MAX, 0, Some(0), false, false))[3],
        "0"
    );
    for (total, total_saturated) in [(0, false), (u128::MAX, true)] {
        let row = entity_row(&decoded_entity(
            u64::MAX,
            total,
            None,
            true,
            total_saturated,
        ));
        assert_eq!(row[1], format!("{}+", u64::MAX));
        assert_eq!(
            row[2],
            if total_saturated {
                format!("{total}+")
            } else {
                total.to_string()
            }
        );
        assert_eq!(row[3], "unavailable");
    }
    assert_eq!(
        entity_row(&decoded_entity(
            1,
            u128::from(u64::MAX),
            Some(u128::from(u64::MAX)),
            false,
            false
        ))[3],
        u64::MAX.to_string()
    );
}

#[test]
fn metrics_average_preserves_totals_above_the_individual_sample_limit() {
    let total = u128::from(u64::MAX) * 2;
    assert_eq!(
        entity_row(&decoded_entity(
            2,
            total,
            Some(u128::from(u64::MAX)),
            false,
            false
        )),
        [
            "app.Entity".to_string(),
            "2".to_string(),
            total.to_string(),
            u64::MAX.to_string(),
            u64::MAX.to_string(),
        ]
    );
}