Merging upstream version 125.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

3 files changed, 184 insertions, 44 deletions

diff --git a/toolkit/components/glean/src/init/viaduct_uploader.rs b/toolkit/components/glean/src/init/viaduct_uploader.rs
index d9ce4e0488..a009e664bc 100644
--- a/toolkit/components/glean/src/init/viaduct_uploader.rs
+++ b/toolkit/components/glean/src/init/viaduct_uploader.rs
@@ -2,7 +2,9 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use glean::net::{PingUploader, UploadResult};
+use glean::net::{PingUploadRequest, PingUploader, UploadResult};
+use once_cell::sync::OnceCell;
+use std::sync::Once;
 use url::Url;
 use viaduct::{Error::*, Request};
 
@@ -19,55 +21,176 @@ impl PingUploader for ViaductUploader {
     ///
     /// # Arguments
     ///
-    /// * `url` - the URL path to upload the data to.
-    /// * `body` - the serialized text data to send.
-    /// * `headers` - a vector of tuples containing the headers to send with
-    ///   the request, i.e. (Name, Value).
-    fn upload(&self, url: String, body: Vec<u8>, headers: Vec<(String, String)>) -> UploadResult {
-        log::trace!("FOG Ping Uploader uploading to {}", url);
-        let url_clone = url.clone();
-        let result: std::result::Result<UploadResult, viaduct::Error> = (move || {
-            // SAFETY NOTE: Safe because it returns a primitive by value.
-            if unsafe { FOG_TooLateToSend() } {
-                log::trace!("Attempted to send ping too late into shutdown.");
-                return Ok(UploadResult::done());
-            }
-            let debug_tagged = headers.iter().any(|(name, _)| name == "X-Debug-ID");
-            let localhost_port = static_prefs::pref!("telemetry.fog.test.localhost_port");
-            if localhost_port < 0
-                || (localhost_port == 0 && !debug_tagged && cfg!(feature = "disable_upload"))
-            {
-                log::info!("FOG Ping uploader faking success");
-                return Ok(UploadResult::http_status(200));
-            }
-            let parsed_url = Url::parse(&url_clone)?;
-
-            log::info!("FOG Ping uploader uploading to {:?}", parsed_url);
-
-            let mut req = Request::post(parsed_url.clone()).body(body.clone());
-            for (header_key, header_value) in &headers {
-                req = req.header(header_key.to_owned(), header_value)?;
-            }
-
-            log::trace!("FOG Ping Uploader sending ping to {}", parsed_url);
-            let res = req.send()?;
-            Ok(UploadResult::http_status(res.status as i32))
-        })();
+    /// * `upload_request` - the ping and its metadata to upload.
+    fn upload(&self, upload_request: PingUploadRequest) -> UploadResult {
+        log::trace!("FOG Ping Uploader uploading to {}", upload_request.url);
+
+        // SAFETY NOTE: Safe because it returns a primitive by value.
+        if unsafe { FOG_TooLateToSend() } {
+            log::trace!("Attempted to send ping too late into shutdown.");
+            return UploadResult::done();
+        }
+
+        let debug_tagged = upload_request
+            .headers
+            .iter()
+            .any(|(name, _)| name == "X-Debug-ID");
+        let localhost_port = static_prefs::pref!("telemetry.fog.test.localhost_port");
+        if localhost_port < 0
+            || (localhost_port == 0 && !debug_tagged && cfg!(feature = "disable_upload"))
+        {
+            log::info!("FOG Ping uploader faking success");
+            return UploadResult::http_status(200);
+        }
+
+        // Localhost-destined pings are sent without OHTTP,
+        // even if configured to use OHTTP.
+        let result = if localhost_port == 0 && should_ohttp_upload(&upload_request) {
+            ohttp_upload(upload_request)
+        } else {
+            viaduct_upload(upload_request)
+        };
+
         log::trace!(
-            "FOG Ping Uploader completed uploading to {} (Result {:?})",
-            url,
+            "FOG Ping Uploader completed uploading (Result {:?})",
             result
         );
+
         match result {
             Ok(result) => result,
-            Err(NonTlsUrl | UrlError(_)) => UploadResult::unrecoverable_failure(),
-            Err(
+            Err(ViaductUploaderError::Viaduct(ve)) => match ve {
+                NonTlsUrl | UrlError(_) => UploadResult::unrecoverable_failure(),
                 RequestHeaderError(_)
                 | BackendError(_)
                 | NetworkError(_)
                 | BackendNotInitialized
-                | SetBackendError,
-            ) => UploadResult::recoverable_failure(),
+                | SetBackendError => UploadResult::recoverable_failure(),
+            },
+            Err(
+                ViaductUploaderError::Bhttp(_)
+                | ViaductUploaderError::Ohttp(_)
+                | ViaductUploaderError::Fatal,
+            ) => UploadResult::unrecoverable_failure(),
         }
     }
 }
+
+fn viaduct_upload(upload_request: PingUploadRequest) -> Result<UploadResult, ViaductUploaderError> {
+    let parsed_url = Url::parse(&upload_request.url)?;
+
+    log::info!("FOG viaduct uploader uploading to {:?}", parsed_url);
+
+    let mut req = Request::post(parsed_url.clone()).body(upload_request.body);
+    for (header_key, header_value) in &upload_request.headers {
+        req = req.header(header_key.to_owned(), header_value)?;
+    }
+
+    log::trace!("FOG viaduct uploader sending ping to {:?}", parsed_url);
+    let res = req.send()?;
+    Ok(UploadResult::http_status(res.status as i32))
+}
+
+fn should_ohttp_upload(upload_request: &PingUploadRequest) -> bool {
+    crate::ohttp_pings::uses_ohttp(&upload_request.ping_name)
+        && !upload_request.body_has_info_sections
+}
+
+fn ohttp_upload(upload_request: PingUploadRequest) -> Result<UploadResult, ViaductUploaderError> {
+    static CELL: OnceCell<Vec<u8>> = once_cell::sync::OnceCell::new();
+    let config = CELL.get_or_try_init(|| get_config())?;
+
+    let binary_request = bhttp_encode(upload_request)?;
+
+    static OHTTP_INIT: Once = Once::new();
+    OHTTP_INIT.call_once(|| {
+        ohttp::init();
+    });
+
+    let ohttp_request = ohttp::ClientRequest::new(config)?;
+    let (capsule, ohttp_response) = ohttp_request.encapsulate(&binary_request)?;
+
+    const OHTTP_RELAY_URL: &str = "https://mozilla-ohttp.fastly-edge.com/";
+    let parsed_relay_url = Url::parse(OHTTP_RELAY_URL)?;
+
+    log::trace!("FOG ohttp uploader uploading to {}", parsed_relay_url);
+
+    const OHTTP_MESSAGE_CONTENT_TYPE: &str = "message/ohttp-req";
+    let req = Request::post(parsed_relay_url)
+        .header(
+            viaduct::header_names::CONTENT_TYPE,
+            OHTTP_MESSAGE_CONTENT_TYPE,
+        )?
+        .body(capsule);
+    let res = req.send()?;
+
+    if res.status == 200 {
+        // This just tells us the HTTP went well. Check OHTTP's status.
+        let binary_response = ohttp_response.decapsulate(&res.body)?;
+        let mut cursor = std::io::Cursor::new(binary_response);
+        let bhttp_message = bhttp::Message::read_bhttp(&mut cursor)?;
+        let res = bhttp_message
+            .control()
+            .status()
+            .ok_or(ViaductUploaderError::Fatal)?;
+        Ok(UploadResult::http_status(res as i32))
+    } else {
+        Ok(UploadResult::http_status(res.status as i32))
+    }
+}
+
+fn get_config() -> Result<Vec<u8>, ViaductUploaderError> {
+    const OHTTP_CONFIG_URL: &str =
+        "https://prod.ohttp-gateway.prod.webservices.mozgcp.net/ohttp-configs";
+    log::trace!("Getting OHTTP config from {}", OHTTP_CONFIG_URL);
+    let parsed_config_url = Url::parse(OHTTP_CONFIG_URL)?;
+    Ok(Request::get(parsed_config_url).send()?.body)
+}
+
+/// Encode the ping upload request in binary HTTP.
+/// (draft-ietf-httpbis-binary-message)
+fn bhttp_encode(upload_request: PingUploadRequest) -> Result<Vec<u8>, ViaductUploaderError> {
+    let parsed_url = Url::parse(&upload_request.url)?;
+    let mut message = bhttp::Message::request(
+        "POST".into(),
+        parsed_url.scheme().into(),
+        parsed_url
+            .host_str()
+            .ok_or(ViaductUploaderError::Fatal)?
+            .into(),
+        parsed_url.path().into(),
+    );
+
+    upload_request
+        .headers
+        .into_iter()
+        .for_each(|(k, v)| message.put_header(k, v));
+
+    message.write_content(upload_request.body);
+
+    let mut encoded = vec![];
+    message.write_bhttp(bhttp::Mode::KnownLength, &mut encoded)?;
+
+    Ok(encoded)
+}
+
+/// Unioned error across upload backends.
+#[derive(Debug, thiserror::Error)]
+enum ViaductUploaderError {
+    #[error("bhttp::Error {0}")]
+    Bhttp(#[from] bhttp::Error),
+
+    #[error("ohttp::Error {0}")]
+    Ohttp(#[from] ohttp::Error),
+
+    #[error("viaduct::Error {0}")]
+    Viaduct(#[from] viaduct::Error),
+
+    #[error("Fatal upload error")]
+    Fatal,
+}
+
+impl From<url::ParseError> for ViaductUploaderError {
+    fn from(e: url::ParseError) -> Self {
+        ViaductUploaderError::Viaduct(viaduct::Error::from(e))
+    }
+}
diff --git a/toolkit/components/glean/src/lib.rs b/toolkit/components/glean/src/lib.rs
index 79f3258bb7..b682f43066 100644
--- a/toolkit/components/glean/src/lib.rs
+++ b/toolkit/components/glean/src/lib.rs
@@ -28,6 +28,7 @@ extern crate cstr;
 extern crate xpcom;
 
 mod init;
+mod ohttp_pings;
 
 pub use init::fog_init;
 
@@ -46,6 +47,7 @@ static mut PENDING_BUF: Vec<u8> = Vec::new();
 // IPC serialization/deserialization methods
 // Crucially important that the first two not be called on multiple threads.
 
+/// # Safety
 /// Only safe if only called on a single thread (the same single thread you call
 /// fog_give_ipc_buf on).
 #[no_mangle]
@@ -59,6 +61,7 @@ pub unsafe extern "C" fn fog_serialize_ipc_buf() -> usize {
     }
 }
 
+/// # Safety
 /// Only safe if called on a single thread (the same single thread you call
 /// fog_serialize_ipc_buf on), and if buf points to an allocated buffer of at
 /// least buf_len bytes.
@@ -73,6 +76,7 @@ pub unsafe extern "C" fn fog_give_ipc_buf(buf: *mut u8, buf_len: usize) -> usize
     pending_len
 }
 
+/// # Safety
 /// Only safe if buf points to an allocated buffer of at least buf_len bytes.
 /// No ownership is transfered to Rust by this method: caller owns the memory at
 /// buf before and after this call.
@@ -92,9 +96,9 @@ pub unsafe extern "C" fn fog_use_ipc_buf(buf: *const u8, buf_len: usize) {
 pub extern "C" fn fog_set_debug_view_tag(value: &nsACString) -> nsresult {
     let result = glean::set_debug_view_tag(&value.to_string());
     if result {
-        return NS_OK;
+        NS_OK
     } else {
-        return NS_ERROR_FAILURE;
+        NS_ERROR_FAILURE
     }
 }
 
@@ -137,7 +141,7 @@ pub extern "C" fn fog_set_experiment_active(
         extra_values.len(),
         "Experiment extra keys and values differ in length."
     );
-    let extra = if extra_keys.len() == 0 {
+    let extra = if extra_keys.is_empty() {
         None
     } else {
         Some(
diff --git a/toolkit/components/glean/src/ohttp_pings.rs b/toolkit/components/glean/src/ohttp_pings.rs
new file mode 100644
index 0000000000..71b9512a8b
--- /dev/null
+++ b/toolkit/components/glean/src/ohttp_pings.rs
@@ -0,0 +1,13 @@
+// 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
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+//! This file contains the generated logic for ohttp pings.
+//!
+//! The contents of this module are generated by
+//! `toolkit/components/glean/build_scripts/glean_parser_ext/run_glean_parser.py`, from
+//! ping definitions files identified by `toolkit/components/glean/metrics_index.py`.
+
+include!(mozbuild::objdir_path!(
+    "toolkit/components/glean/src/ohttp_pings.rs"
+));