Source code
Revision control
Copy as Markdown
Other Tools
// -*- mode: Rust -*-
// AUTOGENERATED BY glean_parser. DO NOT EDIT.
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
pub enum DynamicLabel { }
pub mod test {
use crate::private::*;
#[allow(unused_imports)] // CommonMetricData might be unused, let's avoid warnings
use glean::CommonMetricData;
#[allow(unused_imports)] // HistogramType might be unusued, let's avoid warnings
use glean::HistogramType;
use once_cell::sync::Lazy;
#[allow(unused_imports)]
use std::convert::TryFrom;
#[allow(non_upper_case_globals)]
/// generated from test.boolean_metric
///
/// A multi-line
/// description
pub static boolean_metric: Lazy<BooleanMetric> = Lazy::new(|| {
BooleanMetric::new(1.into(), CommonMetricData {
name: "boolean_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.counter_metric
///
/// A multi-line
/// description
pub static counter_metric: Lazy<CounterMetric> = Lazy::new(|| {
CounterMetric::new(2.into(), CommonMetricData {
name: "counter_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.custom_distribution_metric
///
/// A multi-line
/// description
pub static custom_distribution_metric: Lazy<CustomDistributionMetric> = Lazy::new(|| {
CustomDistributionMetric::new(3.into(), CommonMetricData {
name: "custom_distribution_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
}, 0, 100, 100, HistogramType::Linear)
});
#[allow(non_upper_case_globals)]
/// generated from test.labeled_boolean_metric
///
/// A multi-line
/// description
pub static labeled_boolean_metric: Lazy<LabeledMetric<LabeledBooleanMetric, super::DynamicLabel>> = Lazy::new(|| {
LabeledMetric::new(4.into(), CommonMetricData {
name: "labeled_boolean_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, None)
});
#[repr(u16)]
pub enum LabeledBooleanMetricLabelsLabel {
OneLabel = 0,
TwoLabels = 1,
ThreeLabels = 2,
FourLabels = 3,
FiveLabels = 4,
SixLabels = 5,
SevenLabels = 6,
EightLabels = 7,
NineLabels = 8,
TenLabels = 9,
__Other__,
}
impl From<u16> for LabeledBooleanMetricLabelsLabel {
fn from(v: u16) -> Self {
match v {
0 => Self::OneLabel,
1 => Self::TwoLabels,
2 => Self::ThreeLabels,
3 => Self::FourLabels,
4 => Self::FiveLabels,
5 => Self::SixLabels,
6 => Self::SevenLabels,
7 => Self::EightLabels,
8 => Self::NineLabels,
9 => Self::TenLabels,
_ => Self::__Other__,
}
}
}
impl Into<&'static str> for LabeledBooleanMetricLabelsLabel {
fn into(self) -> &'static str {
match self {
Self::OneLabel => "one_label",
Self::TwoLabels => "two_labels",
Self::ThreeLabels => "three_labels",
Self::FourLabels => "four_labels",
Self::FiveLabels => "five_labels",
Self::SixLabels => "six_labels",
Self::SevenLabels => "seven_labels",
Self::EightLabels => "eight_labels",
Self::NineLabels => "nine_labels",
Self::TenLabels => "ten_labels",
Self::__Other__ => "__other__",
}
}
}
#[allow(non_upper_case_globals)]
/// generated from test.labeled_boolean_metric_labels
///
/// A multi-line
/// description
pub static labeled_boolean_metric_labels: Lazy<LabeledMetric<LabeledBooleanMetric, LabeledBooleanMetricLabelsLabel>> = Lazy::new(|| {
LabeledMetric::new(5.into(), CommonMetricData {
name: "labeled_boolean_metric_labels".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, Some(vec![::std::borrow::Cow::from("eight_labels"), ::std::borrow::Cow::from("five_labels"), ::std::borrow::Cow::from("four_labels"), ::std::borrow::Cow::from("nine_labels"), ::std::borrow::Cow::from("one_label"), ::std::borrow::Cow::from("seven_labels"), ::std::borrow::Cow::from("six_labels"), ::std::borrow::Cow::from("ten_labels"), ::std::borrow::Cow::from("three_labels"), ::std::borrow::Cow::from("two_labels")]))
});
#[allow(non_upper_case_globals)]
/// generated from test.labeled_counter_metric
///
/// A multi-line
/// description
pub static labeled_counter_metric: Lazy<LabeledMetric<LabeledCounterMetric, super::DynamicLabel>> = Lazy::new(|| {
LabeledMetric::new(6.into(), CommonMetricData {
name: "labeled_counter_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, None)
});
#[repr(u16)]
pub enum LabeledCounterMetricLabelsLabel {
OneLabel = 0,
TwoLabels = 1,
__Other__,
}
impl From<u16> for LabeledCounterMetricLabelsLabel {
fn from(v: u16) -> Self {
match v {
0 => Self::OneLabel,
1 => Self::TwoLabels,
_ => Self::__Other__,
}
}
}
impl Into<&'static str> for LabeledCounterMetricLabelsLabel {
fn into(self) -> &'static str {
match self {
Self::OneLabel => "one_label",
Self::TwoLabels => "two_labels",
Self::__Other__ => "__other__",
}
}
}
#[allow(non_upper_case_globals)]
/// generated from test.labeled_counter_metric_labels
///
/// A multi-line
/// description
pub static labeled_counter_metric_labels: Lazy<LabeledMetric<LabeledCounterMetric, LabeledCounterMetricLabelsLabel>> = Lazy::new(|| {
LabeledMetric::new(7.into(), CommonMetricData {
name: "labeled_counter_metric_labels".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, Some(vec![::std::borrow::Cow::from("one_label"), ::std::borrow::Cow::from("two_labels")]))
});
#[allow(non_upper_case_globals)]
/// generated from test.labeled_string_metric
///
/// A multi-line
/// description
pub static labeled_string_metric: Lazy<LabeledMetric<LabeledStringMetric, super::DynamicLabel>> = Lazy::new(|| {
LabeledMetric::new(8.into(), CommonMetricData {
name: "labeled_string_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, None)
});
#[repr(u16)]
pub enum LabeledStringMetricLabelsLabel {
OneLabel = 0,
TwoLabels = 1,
__Other__,
}
impl From<u16> for LabeledStringMetricLabelsLabel {
fn from(v: u16) -> Self {
match v {
0 => Self::OneLabel,
1 => Self::TwoLabels,
_ => Self::__Other__,
}
}
}
impl Into<&'static str> for LabeledStringMetricLabelsLabel {
fn into(self) -> &'static str {
match self {
Self::OneLabel => "one_label",
Self::TwoLabels => "two_labels",
Self::__Other__ => "__other__",
}
}
}
#[allow(non_upper_case_globals)]
/// generated from test.labeled_string_metric_labels
///
/// A multi-line
/// description
pub static labeled_string_metric_labels: Lazy<LabeledMetric<LabeledStringMetric, LabeledStringMetricLabelsLabel>> = Lazy::new(|| {
LabeledMetric::new(9.into(), CommonMetricData {
name: "labeled_string_metric_labels".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, Some(vec![::std::borrow::Cow::from("one_label"), ::std::borrow::Cow::from("two_labels")]))
});
#[allow(non_upper_case_globals)]
/// generated from test.memory_distribution_metric
///
/// A multi-line
/// description
pub static memory_distribution_metric: Lazy<MemoryDistributionMetric> = Lazy::new(|| {
MemoryDistributionMetric::new(10.into(), CommonMetricData {
name: "memory_distribution_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
}, MemoryUnit::Kilobyte)
});
#[allow(non_upper_case_globals)]
/// generated from test.string_list_metric
///
/// A multi-line
/// description
pub static string_list_metric: Lazy<StringListMetric> = Lazy::new(|| {
StringListMetric::new(11.into(), CommonMetricData {
name: "string_list_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.string_metric
///
/// A multi-line
/// description
pub static string_metric: Lazy<StringMetric> = Lazy::new(|| {
StringMetric::new(12.into(), CommonMetricData {
name: "string_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.text_metric
///
/// A multi-line
/// description
pub static text_metric: Lazy<TextMetric> = Lazy::new(|| {
TextMetric::new(13.into(), CommonMetricData {
name: "text_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.timespan_metric
///
/// A multi-line
/// description
pub static timespan_metric: Lazy<TimespanMetric> = Lazy::new(|| {
TimespanMetric::new(14.into(), CommonMetricData {
name: "timespan_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, TimeUnit::Millisecond)
});
#[allow(non_upper_case_globals)]
/// generated from test.timing_distribution_metric
///
/// A multi-line
/// description
pub static timing_distribution_metric: Lazy<TimingDistributionMetric> = Lazy::new(|| {
TimingDistributionMetric::new(15.into(), CommonMetricData {
name: "timing_distribution_metric".into(),
category: "test".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
}, TimeUnit::Nanosecond)
});
}
pub mod test_nested {
use crate::private::*;
#[allow(unused_imports)] // CommonMetricData might be unused, let's avoid warnings
use glean::CommonMetricData;
#[allow(unused_imports)] // HistogramType might be unusued, let's avoid warnings
use glean::HistogramType;
use once_cell::sync::Lazy;
#[allow(unused_imports)]
use std::convert::TryFrom;
pub type AnObjectObject = Vec<AnObjectObjectItem>;
#[derive(Debug, Hash, Eq, PartialEq, ::glean::traits::__serde::Serialize, ::glean::traits::__serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub struct AnObjectObjectItem {
#[serde(skip_serializing_if = "Option::is_none")]
pub colour: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub diameter: Option<i64>,
}
#[allow(non_upper_case_globals)]
/// generated from test.nested.an_object
///
/// An example object
pub static an_object: Lazy<ObjectMetric<AnObjectObject>> = Lazy::new(|| {
ObjectMetric::new(16.into(), CommonMetricData {
name: "an_object".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.datetime_metric
///
/// A multi-line
/// description
pub static datetime_metric: Lazy<DatetimeMetric> = Lazy::new(|| {
DatetimeMetric::new(17.into(), CommonMetricData {
name: "datetime_metric".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
}, TimeUnit::Millisecond)
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.event_metric
///
/// A multi-line
/// description
pub static event_metric: Lazy<EventMetric<NoExtraKeys>> = Lazy::new(|| {
EventMetric::new(18.into(), CommonMetricData {
name: "event_metric".into(),
category: "test.nested".into(),
send_in_pings: vec!["events".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[derive(Default, Debug, Clone, Hash, Eq, PartialEq)]
pub struct EventMetricWithExtraExtra {
pub an_extra_key: Option<String>,
pub another_extra_key: Option<String>,
}
impl ExtraKeys for EventMetricWithExtraExtra {
const ALLOWED_KEYS: &'static [&'static str] = &["an_extra_key", "another_extra_key"];
fn into_ffi_extra(self) -> ::std::collections::HashMap<String, String> {
let mut map = ::std::collections::HashMap::new();
self.an_extra_key.and_then(|val| map.insert("an_extra_key".into(), val.to_string()));
self.another_extra_key.and_then(|val| map.insert("another_extra_key".into(), val.to_string()));
map
}
}
#[allow(non_upper_case_globals)]
/// generated from test.nested.event_metric_with_extra
///
/// A multi-line
/// description
pub static event_metric_with_extra: Lazy<EventMetric<EventMetricWithExtraExtra>> = Lazy::new(|| {
EventMetric::new(19.into(), CommonMetricData {
name: "event_metric_with_extra".into(),
category: "test.nested".into(),
send_in_pings: vec!["events".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.external_denominator
///
/// A multi-line
/// description
pub static external_denominator: Lazy<DenominatorMetric> = Lazy::new(|| {
DenominatorMetric::new(20.into(), CommonMetricData {
name: "external_denominator".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
}, vec![CommonMetricData {name: "rate_with_external_denominator".into(), category: "test.nested".into(), send_in_pings: vec!["metrics".into()], lifetime: Lifetime::Ping, disabled: false, ..Default::default()}])
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.optimizable_counter_metric
///
/// A multi-line
/// description
pub static optimizable_counter_metric: Lazy<CounterMetric> = Lazy::new(|| {
CounterMetric::codegen_new(
21,
"test.nested",
"optimizable_counter_metric",
"metrics"
)
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.quantity_metric
///
/// A multi-line
/// description
pub static quantity_metric: Lazy<QuantityMetric> = Lazy::new(|| {
QuantityMetric::new(22.into(), CommonMetricData {
name: "quantity_metric".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.rate_metric
///
/// A multi-line
/// description
pub static rate_metric: Lazy<RateMetric> = Lazy::new(|| {
RateMetric::new(23.into(), CommonMetricData {
name: "rate_metric".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.rate_with_external_denominator
///
/// A multi-line
/// description
pub static rate_with_external_denominator: Lazy<NumeratorMetric> = Lazy::new(|| {
NumeratorMetric::new(24.into(), CommonMetricData {
name: "rate_with_external_denominator".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Ping,
disabled: false,
..Default::default()
})
});
#[allow(non_upper_case_globals)]
/// generated from test.nested.uuid_metric
///
/// A multi-line
/// description
pub static uuid_metric: Lazy<UuidMetric> = Lazy::new(|| {
UuidMetric::new(25.into(), CommonMetricData {
name: "uuid_metric".into(),
category: "test.nested".into(),
send_in_pings: vec!["metrics".into()],
lifetime: Lifetime::Application,
disabled: false,
..Default::default()
})
});
}
#[allow(dead_code)]
pub(crate) mod __glean_metric_maps {
use std::collections::HashMap;
use crate::metrics::extra_keys_len;
use crate::private::*;
use once_cell::sync::Lazy;
pub static BOOLEAN_MAP: Lazy<HashMap<MetricId, &Lazy<BooleanMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(1.into(), &super::test::boolean_metric);
map
});
pub static COUNTER_MAP: Lazy<HashMap<MetricId, &Lazy<CounterMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(2);
map.insert(2.into(), &super::test::counter_metric);
map.insert(21.into(), &super::test_nested::optimizable_counter_metric);
map
});
pub static CUSTOM_DISTRIBUTION_MAP: Lazy<HashMap<MetricId, &Lazy<CustomDistributionMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(3.into(), &super::test::custom_distribution_metric);
map
});
pub static MEMORY_DISTRIBUTION_MAP: Lazy<HashMap<MetricId, &Lazy<MemoryDistributionMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(10.into(), &super::test::memory_distribution_metric);
map
});
pub static STRING_LIST_MAP: Lazy<HashMap<MetricId, &Lazy<StringListMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(11.into(), &super::test::string_list_metric);
map
});
pub static STRING_MAP: Lazy<HashMap<MetricId, &Lazy<StringMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(12.into(), &super::test::string_metric);
map
});
pub static TEXT_MAP: Lazy<HashMap<MetricId, &Lazy<TextMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(13.into(), &super::test::text_metric);
map
});
pub static TIMESPAN_MAP: Lazy<HashMap<MetricId, &Lazy<TimespanMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(14.into(), &super::test::timespan_metric);
map
});
pub static TIMING_DISTRIBUTION_MAP: Lazy<HashMap<MetricId, &Lazy<TimingDistributionMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(15.into(), &super::test::timing_distribution_metric);
map
});
pub static DATETIME_MAP: Lazy<HashMap<MetricId, &Lazy<DatetimeMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(17.into(), &super::test_nested::datetime_metric);
map
});
pub static DENOMINATOR_MAP: Lazy<HashMap<MetricId, &Lazy<DenominatorMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(20.into(), &super::test_nested::external_denominator);
map
});
pub static QUANTITY_MAP: Lazy<HashMap<MetricId, &Lazy<QuantityMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(22.into(), &super::test_nested::quantity_metric);
map
});
pub static RATE_MAP: Lazy<HashMap<MetricId, &Lazy<RateMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(23.into(), &super::test_nested::rate_metric);
map
});
pub static NUMERATOR_MAP: Lazy<HashMap<MetricId, &Lazy<NumeratorMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(24.into(), &super::test_nested::rate_with_external_denominator);
map
});
pub static UUID_MAP: Lazy<HashMap<MetricId, &Lazy<UuidMetric>>> = Lazy::new(|| {
let mut map = HashMap::with_capacity(1);
map.insert(25.into(), &super::test_nested::uuid_metric);
map
});
pub(crate) fn set_object_by_id(metric_id: u32, value: String) -> Result<(), ()> {
match metric_id {
16 => {
super::test_nested::an_object.set_string(value);
Ok(())
}
_ => Err(()),
}
}
/// Wrapper to get the currently stored object for object metric as a string.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `ping_name` - (Optional) The ping name to look into.
/// Defaults to the first value in `send_in_pings`.
///
/// # Returns
///
/// Returns the recorded object serialized as a JSON string or `None` if nothing stored.
///
/// # Panics
///
/// Panics if no object by the given metric ID could be found.
pub(crate) fn object_test_get_value(metric_id: u32, ping_name: Option<String>) -> Option<String> {
match metric_id {
16 => super::test_nested::an_object.test_get_value_as_str(ping_name.as_deref()),
_ => panic!("No object for metric id {}", metric_id),
}
}
/// Check the provided object for errors.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
///
/// # Returns
///
/// Returns a string for the recorded error or `None`.
///
/// # Panics
///
/// Panics if no object by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn object_test_get_error(metric_id: u32) -> Option<String> {
#[cfg(feature = "with_gecko")]
match metric_id {
16 => test_get_errors!(super::test_nested::an_object),
_ => panic!("No object for metric id {}", metric_id),
}
#[cfg(not(feature = "with_gecko"))]
{
return None;
}
}
/// Wrapper to record an event based on its metric ID.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `extra` - An map of (extra key id, string) pairs.
/// The map will be decoded into the appropriate `ExtraKeys` type.
/// # Returns
///
/// Returns `Ok(())` if the event was found and `record` was called with the given `extra`,
/// or an `EventRecordingError::InvalidId` if no event by that ID exists
/// or an `EventRecordingError::InvalidExtraKey` if the `extra` map could not be deserialized.
pub(crate) fn record_event_by_id(metric_id: u32, extra: HashMap<String, String>) -> Result<(), EventRecordingError> {
match metric_id {
18 => {
assert!(
extra_keys_len(&super::test_nested::event_metric) != 0 || extra.is_empty(),
"No extra keys allowed, but some were passed"
);
super::test_nested::event_metric.record_raw(extra);
Ok(())
}
19 => {
assert!(
extra_keys_len(&super::test_nested::event_metric_with_extra) != 0 || extra.is_empty(),
"No extra keys allowed, but some were passed"
);
super::test_nested::event_metric_with_extra.record_raw(extra);
Ok(())
}
_ => Err(EventRecordingError::InvalidId),
}
}
/// Wrapper to record an event based on its metric ID, with a provided timestamp.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `timestamp` - The time at which this event was recorded.
/// * `extra` - An map of (extra key id, string) pairs.
/// The map will be decoded into the appropriate `ExtraKeys` type.
/// # Returns
///
/// Returns `Ok(())` if the event was found and `record` was called with the given `extra`,
/// or an `EventRecordingError::InvalidId` if no event by that ID exists
/// or an `EventRecordingError::InvalidExtraKey` if the event doesn't take extra pairs,
/// but some are passed in.
pub(crate) fn record_event_by_id_with_time(metric_id: MetricId, timestamp: u64, extra: HashMap<String, String>) -> Result<(), EventRecordingError> {
match metric_id {
MetricId(18) => {
if extra_keys_len(&super::test_nested::event_metric) == 0 && !extra.is_empty() {
return Err(EventRecordingError::InvalidExtraKey);
}
super::test_nested::event_metric.record_with_time(timestamp, extra);
Ok(())
}
MetricId(19) => {
if extra_keys_len(&super::test_nested::event_metric_with_extra) == 0 && !extra.is_empty() {
return Err(EventRecordingError::InvalidExtraKey);
}
super::test_nested::event_metric_with_extra.record_with_time(timestamp, extra);
Ok(())
}
_ => Err(EventRecordingError::InvalidId),
}
}
/// Wrapper to get the currently stored events for event metric.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `ping_name` - (Optional) The ping name to look into.
/// Defaults to the first value in `send_in_pings`.
///
/// # Returns
///
/// Returns the recorded events or `None` if nothing stored.
///
/// # Panics
///
/// Panics if no event by the given metric ID could be found.
pub(crate) fn event_test_get_value_wrapper(metric_id: u32, ping_name: Option<String>) -> Option<Vec<RecordedEvent>> {
match metric_id {
18 => super::test_nested::event_metric.test_get_value(ping_name.as_deref()),
19 => super::test_nested::event_metric_with_extra.test_get_value(ping_name.as_deref()),
_ => panic!("No event for metric id {}", metric_id),
}
}
/// Check the provided event for errors.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `ping_name` - (Optional) The ping name to look into.
/// Defaults to the first value in `send_in_pings`.
///
/// # Returns
///
/// Returns a string for the recorded error or `None`.
///
/// # Panics
///
/// Panics if no event by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn event_test_get_error(metric_id: u32) -> Option<String> {
#[cfg(feature = "with_gecko")]
match metric_id {
18 => test_get_errors!(super::test_nested::event_metric),
19 => test_get_errors!(super::test_nested::event_metric_with_extra),
_ => panic!("No event for metric id {}", metric_id),
}
#[cfg(not(feature = "with_gecko"))]
{
return None;
}
}
/// Gets the submetric from the specified labeled_boolean metric.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label` - The label identifying the boolean submetric.
///
/// # Returns
///
/// Returns the boolean submetric.
///
/// # Panics
///
/// Panics if no labeled_boolean by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_boolean_get(metric_id: u32, label: &str) -> LabeledBooleanMetric {
match metric_id {
4 => super::test::labeled_boolean_metric.get(label),
5 => super::test::labeled_boolean_metric_labels.get(label),
_ => panic!("No labeled_boolean for metric id {}", metric_id),
}
}
/// Gets the submetric from the specified labeled_boolean metric, by enum.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label_enum` - The label enum identifying the boolean submetric.
///
/// # Returns
///
/// Returns the boolean submetric.
///
/// # Panics
///
/// Panics if no labeled_boolean by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_boolean_enum_get(metric_id: u32, label_enum: u16) -> LabeledBooleanMetric {
match metric_id {
5 => super::test::labeled_boolean_metric_labels.get(labeled_enum_to_str(metric_id, label_enum)),
_ => panic!("No labeled_boolean for metric id {}", metric_id),
}
}
/// Gets the submetric from the specified labeled_counter metric.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label` - The label identifying the counter submetric.
///
/// # Returns
///
/// Returns the counter submetric.
///
/// # Panics
///
/// Panics if no labeled_counter by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_counter_get(metric_id: u32, label: &str) -> LabeledCounterMetric {
match metric_id {
6 => super::test::labeled_counter_metric.get(label),
7 => super::test::labeled_counter_metric_labels.get(label),
_ => panic!("No labeled_counter for metric id {}", metric_id),
}
}
/// Gets the submetric from the specified labeled_counter metric, by enum.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label_enum` - The label enum identifying the counter submetric.
///
/// # Returns
///
/// Returns the counter submetric.
///
/// # Panics
///
/// Panics if no labeled_counter by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_counter_enum_get(metric_id: u32, label_enum: u16) -> LabeledCounterMetric {
match metric_id {
7 => super::test::labeled_counter_metric_labels.get(labeled_enum_to_str(metric_id, label_enum)),
_ => panic!("No labeled_counter for metric id {}", metric_id),
}
}
/// Gets the submetric from the specified labeled_string metric.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label` - The label identifying the string submetric.
///
/// # Returns
///
/// Returns the string submetric.
///
/// # Panics
///
/// Panics if no labeled_string by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_string_get(metric_id: u32, label: &str) -> LabeledStringMetric {
match metric_id {
8 => super::test::labeled_string_metric.get(label),
9 => super::test::labeled_string_metric_labels.get(label),
_ => panic!("No labeled_string for metric id {}", metric_id),
}
}
/// Gets the submetric from the specified labeled_string metric, by enum.
///
/// # Arguments
///
/// * `metric_id` - The metric's ID to look up
/// * `label_enum` - The label enum identifying the string submetric.
///
/// # Returns
///
/// Returns the string submetric.
///
/// # Panics
///
/// Panics if no labeled_string by the given metric ID could be found.
#[allow(unused_variables)]
pub(crate) fn labeled_string_enum_get(metric_id: u32, label_enum: u16) -> LabeledStringMetric {
match metric_id {
9 => super::test::labeled_string_metric_labels.get(labeled_enum_to_str(metric_id, label_enum)),
_ => panic!("No labeled_string for metric id {}", metric_id),
}
}
pub(crate) fn labeled_enum_to_str(metric_id: u32, label: u16) -> &'static str {
match metric_id {
5 => super::test::LabeledBooleanMetricLabelsLabel::from(label).into(),
7 => super::test::LabeledCounterMetricLabelsLabel::from(label).into(),
9 => super::test::LabeledStringMetricLabelsLabel::from(label).into(),
_ => panic!("Can't turn label enum to string for metric {} which isn't a labeled metric with static labels", metric_id),
}
}
pub(crate) mod submetric_maps {
use std::sync::{
atomic::AtomicU32,
RwLock,
};
use super::*;
pub(crate) const SUBMETRIC_BIT: u32 = 25;
pub(crate) static NEXT_LABELED_SUBMETRIC_ID: AtomicU32 = AtomicU32::new((1 << SUBMETRIC_BIT) + 1);
pub(crate) static LABELED_METRICS_TO_IDS: Lazy<RwLock<HashMap<(u32, String), u32>>> = Lazy::new(||
RwLock::new(HashMap::new())
);
pub(crate) static LABELED_ENUMS_TO_IDS: Lazy<RwLock<HashMap<(u32, u16), u32>>> = Lazy::new(||
RwLock::new(HashMap::new())
);
pub static BOOLEAN_MAP: Lazy<RwLock<HashMap<MetricId, LabeledBooleanMetric>>> = Lazy::new(||
RwLock::new(HashMap::new())
);
pub static COUNTER_MAP: Lazy<RwLock<HashMap<MetricId, LabeledCounterMetric>>> = Lazy::new(||
RwLock::new(HashMap::new())
);
pub static STRING_MAP: Lazy<RwLock<HashMap<MetricId, LabeledStringMetric>>> = Lazy::new(||
RwLock::new(HashMap::new())
);
}
}