mod common;
use crate::common::*;
use serde_json::json;
use glean_core::metrics::*;
use glean_core::storage::StorageManager;
use glean_core::{test_get_num_recorded_errors, CommonMetricData, ErrorType, Glean, Lifetime};
#[test]
fn list_can_store_multiple_items() {
let (glean, _t) = new_glean();
let list: StringListMetric = StringListMetric::new(CommonMetricData {
name: "list".into(),
category: "local".into(),
send_in_pings: vec!["core".into()],
..Default::default()
});
list.add(&glean, "first");
assert_eq!(list.test_get_value(&glean, "core").unwrap(), vec!["first"]);
list.add(&glean, "second");
assert_eq!(
list.test_get_value(&glean, "core").unwrap(),
vec!["first", "second"]
);
list.set(&glean, vec!["third".into()]);
assert_eq!(list.test_get_value(&glean, "core").unwrap(), vec!["third"]);
list.add(&glean, "fourth");
assert_eq!(
list.test_get_value(&glean, "core").unwrap(),
vec!["third", "fourth"]
);
}
#[test]
fn stringlist_serializer_should_correctly_serialize_stringlists() {
let (_t, tmpname) = tempdir();
let cfg = glean_core::Configuration {
data_path: tmpname,
application_id: GLOBAL_APPLICATION_ID.into(),
upload_enabled: true,
max_events: None,
};
{
let glean = Glean::new(cfg.clone()).unwrap();
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::User,
..Default::default()
});
metric.set(&glean, vec!["test_string_1".into(), "test_string_2".into()]);
}
{
let glean = Glean::new(cfg.clone()).unwrap();
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), "store1", true)
.unwrap();
assert_eq!(
json!({"string_list": {"telemetry.test.string_list_metric": ["test_string_1", "test_string_2"]}}),
snapshot
);
}
}
#[test]
fn set_properly_sets_the_value_in_all_stores() {
let (glean, _t) = new_glean();
let store_names: Vec<String> = vec!["store1".into(), "store2".into()];
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: store_names.clone(),
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
});
metric.set(&glean, vec!["test_string_1".into(), "test_string_2".into()]);
for store_name in store_names {
let snapshot = StorageManager
.snapshot_as_json(glean.storage(), &store_name, true)
.unwrap();
assert_eq!(
json!({"string_list": {"telemetry.test.string_list_metric": ["test_string_1", "test_string_2"]}}),
snapshot
);
}
}
#[test]
fn long_string_values_are_truncated() {
let (glean, _t) = new_glean();
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
});
let test_string = "0123456789".repeat(20);
metric.add(&glean, test_string.clone());
assert_eq!(
vec![test_string[..50].to_string()],
metric.test_get_value(&glean, "store1").unwrap()
);
assert_eq!(
Ok(1),
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None)
);
metric.set(&glean, vec![test_string.clone()]);
assert_eq!(
vec![test_string[..50].to_string()],
metric.test_get_value(&glean, "store1").unwrap()
);
assert_eq!(
Ok(2),
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None)
);
}
#[test]
fn disabled_string_lists_dont_record() {
let (glean, _t) = new_glean();
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: vec!["store1".into()],
disabled: true,
lifetime: Lifetime::Ping,
..Default::default()
});
metric.add(&glean, "test_string".repeat(20));
assert_eq!(None, metric.test_get_value(&glean, "store1"));
metric.set(&glean, vec!["test_string_2".repeat(20)]);
assert_eq!(None, metric.test_get_value(&glean, "store1"));
assert!(
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None).is_err()
);
}
#[test]
fn string_lists_dont_exceed_max_items() {
let (glean, _t) = new_glean();
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
});
for _n in 1..21 {
metric.add(&glean, "test_string");
}
let expected: Vec<String> = "test_string "
.repeat(20)
.split_whitespace()
.map(|s| s.to_string())
.collect();
assert_eq!(expected, metric.test_get_value(&glean, "store1").unwrap());
metric.add(&glean, "test_string");
assert_eq!(expected, metric.test_get_value(&glean, "store1").unwrap());
assert_eq!(
Ok(1),
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None)
);
let too_many: Vec<String> = "test_string "
.repeat(21)
.split_whitespace()
.map(|s| s.to_string())
.collect();
metric.set(&glean, too_many);
assert_eq!(expected, metric.test_get_value(&glean, "store1").unwrap());
assert_eq!(
Ok(2),
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None)
);
}
#[test]
fn set_does_not_record_error_when_receiving_empty_list() {
let (glean, _t) = new_glean();
let metric = StringListMetric::new(CommonMetricData {
name: "string_list_metric".into(),
category: "telemetry.test".into(),
send_in_pings: vec!["store1".into()],
disabled: false,
lifetime: Lifetime::Ping,
..Default::default()
});
metric.set(&glean, vec![]);
assert_eq!(Some(vec![]), metric.test_get_value(&glean, "store1"));
assert!(
test_get_num_recorded_errors(&glean, metric.meta(), ErrorType::InvalidValue, None).is_err()
);
}