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
//! Glean telemetry integration.
use crate::config::Config;
use glean::{ClientInfoMetrics, Configuration, ConfigurationBuilder};
const APP_ID: &str = if cfg!(mock) {
"firefox.crashreporter.mock"
} else {
"firefox.crashreporter"
};
const TELEMETRY_SERVER: &str = if cfg!(mock) {
} else {
};
/// Initialize glean based on the given configuration.
///
/// When mocking, this should be called on a thread where the mock data is present.
#[cfg_attr(test, allow(dead_code))]
pub fn init(cfg: &Config) {
glean::initialize(config(cfg), client_info_metrics(cfg));
}
fn config(cfg: &Config) -> Configuration {
ConfigurationBuilder::new(true, glean_data_dir(cfg), APP_ID)
.with_server_endpoint(TELEMETRY_SERVER)
.with_use_core_mps(false)
.with_internal_pings(false)
.with_uploader(uploader::Uploader::new())
.build()
}
#[cfg(not(mock))]
fn glean_data_dir(cfg: &Config) -> ::std::path::PathBuf {
cfg.data_dir().join("glean")
}
#[cfg(mock)]
fn glean_data_dir(_cfg: &Config) -> ::std::path::PathBuf {
// Use a (non-mocked) temp directory since glean won't access our mocked API.
::std::env::temp_dir().join("crashreporter-mock/glean")
}
fn client_info_metrics(cfg: &Config) -> ClientInfoMetrics {
glean::ClientInfoMetrics {
app_build: mozbuild::config::MOZ_BUILDID.into(),
app_display_version: env!("CARGO_PKG_VERSION").into(),
channel: None,
locale: cfg.strings.as_ref().map(|s| s.locale()),
}
}
mod uploader {
use crate::net::http;
use glean::net::{PingUploadRequest, PingUploader, UploadResult};
#[derive(Debug)]
pub struct Uploader {
#[cfg(mock)]
mock_data: crate::std::mock::SharedMockData,
}
impl Uploader {
pub fn new() -> Self {
Uploader {
#[cfg(mock)]
mock_data: crate::std::mock::SharedMockData::new(),
}
}
}
impl PingUploader for Uploader {
fn upload(&self, upload_request: PingUploadRequest) -> UploadResult {
let request_builder = http::RequestBuilder::Post {
body: upload_request.body.as_slice(),
headers: upload_request.headers.as_slice(),
};
let do_send = move || match request_builder.build(upload_request.url.as_ref()) {
Err(e) => {
log::error!("failed to build request for glean ping: {e}");
UploadResult::unrecoverable_failure()
}
Ok(request) => match request.send() {
Err(e) => {
log::error!("failed to send glean ping: {e}");
UploadResult::recoverable_failure()
}
Ok(_) => UploadResult::http_status(200),
},
};
#[cfg(mock)]
return self.mock_data.clone().call(do_send);
#[cfg(not(mock))]
return do_send();
}
}
}
#[cfg(test)]
mod test {
use super::*;
use once_cell::sync::Lazy;
use std::sync::{Mutex, MutexGuard};
pub fn test_init(cfg: &Config) -> GleanTest {
GleanTest::new(cfg)
}
pub struct GleanTest {
_guard: MutexGuard<'static, ()>,
}
impl GleanTest {
fn new(cfg: &Config) -> Self {
// Tests using glean can only run serially as glean is initialized as a global static.
static GLOBAL_LOCK: Lazy<Mutex<()>> = Lazy::new(|| Mutex::new(()));
let lock = GLOBAL_LOCK.lock().unwrap();
glean::test_reset_glean(config(cfg), client_info_metrics(cfg), true);
GleanTest { _guard: lock }
}
}
impl Drop for GleanTest {
fn drop(&mut self) {
// `shutdown` ensures any uploads are executed and threads are joined.
// `test_reset_glean` does not do the same (found by source inspection).
glean::shutdown();
glean::test_reset_glean(
ConfigurationBuilder::new(false, ::std::env::temp_dir(), "none.none").build(),
glean::ClientInfoMetrics::unknown(),
true,
);
}
}
}
#[cfg(test)]
pub use test::test_init;
// Env variable set to the file generated by generate_glean.py (by build.rs).
include!(env!("GLEAN_METRICS_FILE"));