zakura-state 11.0.0

State contextual verification and storage code for the Zakura node. Internal crate, published to support cargo install zakura
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

#![allow(clippy::unwrap_in_result)]

mod prop;
mod shared_outputs;
mod vectors;

use std::sync::Mutex;

use metrics::{Counter, Gauge, Histogram, Key, KeyName, Metadata, Recorder, SharedString, Unit};

use super::ContextualMetrics;

#[derive(Default)]
struct MetricNameRecorder {
    histogram_names: Mutex<Vec<String>>,
}

impl Recorder for MetricNameRecorder {
    fn describe_counter(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}

    fn describe_gauge(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}

    fn describe_histogram(&self, _key: KeyName, _unit: Option<Unit>, _description: SharedString) {}

    fn register_counter(&self, _key: &Key, _metadata: &Metadata<'_>) -> Counter {
        Counter::noop()
    }

    fn register_gauge(&self, _key: &Key, _metadata: &Metadata<'_>) -> Gauge {
        Gauge::noop()
    }

    fn register_histogram(&self, key: &Key, _metadata: &Metadata<'_>) -> Histogram {
        self.histogram_names
            .lock()
            .expect("the metric test does not poison its recorder")
            .push(key.name().to_owned());
        Histogram::noop()
    }
}

#[test]
fn contextual_metrics_record_only_selected_series() {
    let recorder = MetricNameRecorder::default();

    assert_eq!(
        ContextualMetrics::for_commit(false),
        ContextualMetrics::AllBlocks
    );
    assert_eq!(
        ContextualMetrics::for_commit(true),
        ContextualMetrics::Mined
    );

    metrics::with_local_recorder(&recorder, || {
        ContextualMetrics::Disabled.record_duration(
            "test.contextual.disabled.all",
            "test.contextual.disabled.mined",
            std::time::Duration::ZERO,
        );
        ContextualMetrics::AllBlocks.record_duration(
            "test.contextual.all.all",
            "test.contextual.all.mined",
            std::time::Duration::ZERO,
        );
        ContextualMetrics::Mined.record_duration(
            "test.contextual.mined.all",
            "test.contextual.mined.mined",
            std::time::Duration::ZERO,
        );
    });

    assert_eq!(
        *recorder
            .histogram_names
            .lock()
            .expect("the metric test does not poison its recorder"),
        [
            "test.contextual.all.all",
            "test.contextual.mined.all",
            "test.contextual.mined.mined",
        ]
    );
}