Source code
Revision control
Copy as Markdown
Other Tools
// 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
use std::sync::Arc;
use crate::common_metric_data::CommonMetricDataInternal;
use crate::error_recording::{record_error, test_get_num_recorded_errors, ErrorType};
use crate::metrics::JsonValue;
use crate::metrics::Metric;
use crate::metrics::MetricType;
use crate::storage::StorageManager;
use crate::CommonMetricData;
use crate::Glean;
/// An object metric.
///
/// Record structured data.
/// The value must adhere to a predefined structure and is serialized into JSON.
#[derive(Clone, Debug)]
pub struct ObjectMetric {
meta: Arc<CommonMetricDataInternal>,
}
impl MetricType for ObjectMetric {
fn meta(&self) -> &CommonMetricDataInternal {
&self.meta
}
}
// IMPORTANT:
//
// When changing this implementation, make sure all the operations are
// also declared in the related trait in `../traits/`.
impl ObjectMetric {
/// Creates a new object metric.
pub fn new(meta: CommonMetricData) -> Self {
Self {
meta: Arc::new(meta.into()),
}
}
/// Sets to the specified structure.
///
/// # Arguments
///
/// * `glean` - the Glean instance this metric belongs to.
/// * `value` - the value to set.
#[doc(hidden)]
pub fn set_sync(&self, glean: &Glean, value: JsonValue) {
if !self.should_record(glean) {
return;
}
let value = Metric::Object(serde_json::to_string(&value).unwrap());
glean.storage().record(glean, &self.meta, &value)
}
/// Sets to the specified structure.
///
/// No additional verification is done.
/// The shape needs to be externally verified.
///
/// # Arguments
///
/// * `value` - the value to set.
pub fn set(&self, value: JsonValue) {
let metric = self.clone();
crate::launch_with_glean(move |glean| metric.set_sync(glean, value))
}
/// Sets to the specified structure.
///
/// Parses the passed JSON string.
/// If it can't be parsed into a valid object it records an invalid value error.
///
/// Note: This does not check the structure. This needs to be done by the wrapper.
///
/// # Arguments
///
/// * `object` - JSON representation of the object to set.
pub fn set_string(&self, object: String) {
let metric = self.clone();
crate::launch_with_glean(move |glean| {
let object = match serde_json::from_str(&object) {
Ok(object) => object,
Err(_) => {
let msg = "Value did not match predefined schema";
record_error(glean, &metric.meta, ErrorType::InvalidValue, msg, None);
return;
}
};
metric.set_sync(glean, object)
})
}
/// Record an `InvalidValue` error for this metric.
///
/// Only to be used by the RLB.
// errors
pub fn record_schema_error(&self) {
let metric = self.clone();
crate::launch_with_glean(move |glean| {
let msg = "Value did not match predefined schema";
record_error(glean, &metric.meta, ErrorType::InvalidValue, msg, None);
});
}
/// Get current value
#[doc(hidden)]
pub fn get_value<'a, S: Into<Option<&'a str>>>(
&self,
glean: &Glean,
ping_name: S,
) -> Option<String> {
let queried_ping_name = ping_name
.into()
.unwrap_or_else(|| &self.meta().inner.send_in_pings[0]);
match StorageManager.snapshot_metric_for_test(
glean.storage(),
queried_ping_name,
&self.meta.identifier(glean),
self.meta.inner.lifetime,
) {
Some(Metric::Object(o)) => Some(o),
_ => None,
}
}
/// **Test-only API (exported for FFI purposes).**
///
/// Gets the currently stored value as JSON.
///
/// This doesn't clear the stored value.
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue> {
crate::block_on_dispatcher();
let value = crate::core::with_glean(|glean| self.get_value(glean, ping_name.as_deref()));
// We only store valid JSON
value.map(|val| serde_json::from_str(&val).unwrap())
}
/// **Exported for test purposes.**
///
/// Gets the number of recorded errors for the given metric and error type.
///
/// # Arguments
///
/// * `error` - The type of error
/// * `ping_name` - represents the optional name of the ping to retrieve the
/// metric for. inner to the first value in `send_in_pings`.
///
/// # Returns
///
/// The number of errors reported.
pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32 {
crate::block_on_dispatcher();
crate::core::with_glean(|glean| {
test_get_num_recorded_errors(glean, self.meta(), error).unwrap_or(0)
})
}
}