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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
use inherent::inherent;
use std::{collections::HashMap, marker::PhantomData, sync::Arc};
use glean_core::metrics::MetricType;
use glean_core::traits;
use crate::{ErrorType, RecordedEvent};
pub use glean_core::traits::NoExtraKeys;
#[derive(Clone)]
pub struct EventMetric<K> {
pub(crate) inner: Arc<glean_core::metrics::EventMetric>,
extra_keys: PhantomData<K>,
}
impl<K: traits::ExtraKeys> EventMetric<K> {
pub fn new(meta: glean_core::CommonMetricData) -> Self {
let allowed_extra_keys = K::ALLOWED_KEYS.iter().map(|s| s.to_string()).collect();
let inner = Arc::new(glean_core::metrics::EventMetric::new(
meta,
allowed_extra_keys,
));
Self {
inner,
extra_keys: PhantomData,
}
}
}
#[inherent(pub)]
impl<K: traits::ExtraKeys> traits::Event for EventMetric<K> {
type Extra = K;
fn record<M: Into<Option<HashMap<<Self as traits::Event>::Extra, String>>>>(&self, extra: M) {
const NANOS_PER_MILLI: u64 = 1_000_000;
let now = time::precise_time_ns() / NANOS_PER_MILLI;
let extra = extra
.into()
.map(|h| h.into_iter().map(|(k, v)| (k.index(), v)).collect());
let metric = Arc::clone(&self.inner);
crate::launch_with_glean(move |glean| metric.record(glean, now, extra));
}
fn test_get_value<'a, S: Into<Option<&'a str>>>(
&self,
ping_name: S,
) -> Option<Vec<RecordedEvent>> {
crate::block_on_dispatcher();
let queried_ping_name = ping_name
.into()
.unwrap_or_else(|| &self.inner.meta().send_in_pings[0]);
crate::with_glean(|glean| self.inner.test_get_value(glean, queried_ping_name))
}
fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
&self,
error: ErrorType,
ping_name: S,
) -> i32 {
crate::block_on_dispatcher();
crate::with_glean_mut(|glean| {
glean_core::test_get_num_recorded_errors(
&glean,
self.inner.meta(),
error,
ping_name.into(),
)
.unwrap_or(0)
})
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::common_test::{lock_test, new_glean};
use crate::CommonMetricData;
#[test]
fn no_extra_keys() {
let _lock = lock_test();
let _t = new_glean(None, true);
let metric: EventMetric<NoExtraKeys> = EventMetric::new(CommonMetricData {
name: "event".into(),
category: "test".into(),
send_in_pings: vec!["test1".into()],
..Default::default()
});
metric.record(None);
metric.record(None);
let data = metric.test_get_value(None).expect("no event recorded");
assert_eq!(2, data.len());
assert!(data[0].timestamp <= data[1].timestamp);
}
#[test]
fn with_extra_keys() {
let _lock = lock_test();
let _t = new_glean(None, true);
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq)]
enum SomeExtra {
Key1,
Key2,
}
impl glean_core::traits::ExtraKeys for SomeExtra {
const ALLOWED_KEYS: &'static [&'static str] = &["key1", "key2"];
fn index(self) -> i32 {
self as i32
}
}
let metric: EventMetric<SomeExtra> = EventMetric::new(CommonMetricData {
name: "event".into(),
category: "test".into(),
send_in_pings: vec!["test1".into()],
..Default::default()
});
let mut map1 = HashMap::new();
map1.insert(SomeExtra::Key1, "1".into());
metric.record(map1);
let mut map2 = HashMap::new();
map2.insert(SomeExtra::Key1, "1".into());
map2.insert(SomeExtra::Key2, "2".into());
metric.record(map2);
metric.record(None);
let data = metric.test_get_value(None).expect("no event recorded");
assert_eq!(3, data.len());
assert!(data[0].timestamp <= data[1].timestamp);
assert!(data[1].timestamp <= data[2].timestamp);
let mut map = HashMap::new();
map.insert("key1".into(), "1".into());
assert_eq!(Some(map), data[0].extra);
let mut map = HashMap::new();
map.insert("key1".into(), "1".into());
map.insert("key2".into(), "2".into());
assert_eq!(Some(map), data[1].extra);
assert_eq!(None, data[2].extra);
}
}