Bug 1882615 - Adapt FOG and JOG to Glean v58 r=perry.mcmanis

Differential Revision: https://phabricator.services.mozilla.com/D203188

Author: chutten

toolkit/components/glean/api/src/private/ping.rs

@@ -30,6 +30,7 @@ impl Ping {
         include_client_id: bool,
         send_if_empty: bool,
         precise_timestamps: bool,
+        include_info_sections: bool,
         reason_codes: Vec<String>,
     ) -> Self {
         if need_ipc() {
@@ -40,6 +41,7 @@ impl Ping {
                 include_client_id,
                 send_if_empty,
                 precise_timestamps,
+                include_info_sections,
                 reason_codes,
             ))
         }
@@ -103,7 +105,7 @@ mod test {
 
     // Smoke test for what should be the generated code.
     static PROTOTYPE_PING: Lazy<Ping> =
-        Lazy::new(|| Ping::new("prototype", false, true, true, vec![]));
+        Lazy::new(|| Ping::new("prototype", false, true, true, true, vec![]));
 
     #[test]
     fn smoke_test_custom_ping() {

toolkit/components/glean/bindings/jog/src/lib.rs

@@ -138,6 +138,7 @@ pub extern "C" fn jog_test_register_ping(
     include_client_id: bool,
     send_if_empty: bool,
     precise_timestamps: bool,
+    include_info_sections: bool,
     reason_codes: &ThinVec<nsCString>,
 ) -> u32 {
     let ping_name = name.to_string();
@@ -150,6 +151,7 @@ pub extern "C" fn jog_test_register_ping(
         include_client_id,
         send_if_empty,
         precise_timestamps,
+        include_info_sections,
         reason_codes,
     )
     .expect("Creation or registration of ping failed.") // permitted to panic in test-only method.
@@ -160,6 +162,7 @@ fn create_and_register_ping(
     include_client_id: bool,
     send_if_empty: bool,
     precise_timestamps: bool,
+    include_info_sections: bool,
     reason_codes: Vec<String>,
 ) -> Result<u32, Box<dyn std::error::Error>> {
     let ns_name = nsCString::from(&ping_name);
@@ -168,6 +171,7 @@ fn create_and_register_ping(
         include_client_id,
         send_if_empty,
         precise_timestamps,
+        include_info_sections,
         reason_codes,
     );
     extern "C" {
@@ -214,6 +218,7 @@ struct PingDefinitionData {
     include_client_id: bool,
     send_if_empty: bool,
     precise_timestamps: bool,
+    include_info_sections: bool,
     reason_codes: Option<Vec<String>>,
 }
 
@@ -260,6 +265,7 @@ pub extern "C" fn jog_load_jogfile(jogfile_path: &nsAString) -> bool {
             ping.include_client_id,
             ping.send_if_empty,
             ping.precise_timestamps,
+            ping.include_info_sections,
             ping.reason_codes.unwrap_or_else(Vec::new),
         );
     }

toolkit/components/glean/build_scripts/glean_parser_ext/jog.py

@@ -55,6 +55,7 @@
     "include_client_id",
     "send_if_empty",
     "precise_timestamps",
+    "include_info_sections",
     "reason_codes",
 ]
 

toolkit/components/glean/build_scripts/glean_parser_ext/templates/jog_factory.jinja2

@@ -137,10 +137,11 @@ pub fn create_and_register_ping(
     include_client_id: bool,
     send_if_empty: bool,
     precise_timestamps: bool,
+    include_info_sections: bool,
     reason_codes: Vec<String>,
 ) -> Result<u32, Box<dyn std::error::Error>> {
     let ping_id = NEXT_PING_ID.fetch_add(1, Ordering::SeqCst);
-    let ping = Ping::new(ping_name, include_client_id, send_if_empty, precise_timestamps, reason_codes);
+    let ping = Ping::new(ping_name, include_client_id, send_if_empty, precise_timestamps, include_info_sections, reason_codes);
     assert!(
         __jog_metric_maps::PING_MAP.write()?.insert(ping_id.into(), ping).is_none(),
         "We should never insert a runtime ping with an already-used id."

toolkit/components/glean/build_scripts/glean_parser_ext/templates/rust_pings.jinja2

@@ -20,6 +20,7 @@ pub static {{ obj.name|snake_case }}: Lazy<Ping> = Lazy::new(|| {
         {{ obj.include_client_id|rust }},
         {{ obj.send_if_empty|rust }},
         {{ obj.precise_timestamps|rust }},
+        {{ obj.include_info_sections|rust }},
         {{ obj.reason_codes|rust }},
     )
 });

toolkit/components/glean/src/init/viaduct_uploader.rs

@@ -2,7 +2,7 @@
 // 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 url::Url;
 use viaduct::{Error::*, Request};
 
@@ -19,11 +19,11 @@ 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 {
+    /// * `upload_request` - the ping and its metadata to upload.
+    fn upload(&self, upload_request: PingUploadRequest) -> UploadResult {
+        let PingUploadRequest {
+            url, body, headers, ..
+        } = upload_request;
         log::trace!("FOG Ping Uploader uploading to {}", url);
         let url_clone = url.clone();
         let result: std::result::Result<UploadResult, viaduct::Error> = (move || {

toolkit/components/glean/tests/pytest/jogfile_output

@@ -303,6 +303,7 @@
       true,
       false,
       true,
+      true,
       [
         "background",
         "dirty_startup",
@@ -314,13 +315,15 @@
       true,
       true,
       true,
+      true,
       []
     ],
     [
       "not-events",
       true,
       false,
       true,
+      true,
       [
         "background",
         "max_capacity",
@@ -332,6 +335,7 @@
       true,
       false,
       true,
+      true,
       [
         "overdue",
         "reschedule",

toolkit/components/glean/tests/pytest/pings_test_output

@@ -20,6 +20,7 @@ pub static not_baseline: Lazy<Ping> = Lazy::new(|| {
         true,
         false,
         true,
+        true,
         vec!["background".into(), "dirty_startup".into(), "foreground".into()],
     )
 });
@@ -36,6 +37,7 @@ pub static not_deletion_request: Lazy<Ping> = Lazy::new(|| {
         true,
         true,
         true,
+        true,
         vec![],
     )
 });
@@ -50,6 +52,7 @@ pub static not_events: Lazy<Ping> = Lazy::new(|| {
         true,
         false,
         true,
+        true,
         vec!["background".into(), "max_capacity".into(), "startup".into()],
     )
 });
@@ -68,6 +71,7 @@ pub static not_metrics: Lazy<Ping> = Lazy::new(|| {
         true,
         false,
         true,
+        true,
         vec!["overdue".into(), "reschedule".into(), "today".into(), "tomorrow".into(), "upgrade".into()],
     )
 });

toolkit/components/glean/tests/xpcshell/test_JOG.js

@@ -289,7 +289,7 @@ add_task(async function test_jog_custom_pings() {
     `"ping"`,
     false
   );
-  Services.fog.testRegisterRuntimePing("jog-ping", true, true, true, []);
+  Services.fog.testRegisterRuntimePing("jog-ping", true, true, true, true, []);
   Assert.ok("jogPing" in GleanPings);
   let submitted = false;
   Glean.jogCat.jogPingBool.set(false);
@@ -642,7 +642,9 @@ add_task(function test_jog_dotted_categories_work() {
 
 add_task(async function test_jog_ping_works() {
   const kReason = "reason-1";
-  Services.fog.testRegisterRuntimePing("my-ping", true, true, true, [kReason]);
+  Services.fog.testRegisterRuntimePing("my-ping", true, true, true, true, [
+    kReason,
+  ]);
   let submitted = false;
   GleanPings.myPing.testBeforeNextSubmit(reason => {
     submitted = true;
@@ -652,6 +654,20 @@ add_task(async function test_jog_ping_works() {
   Assert.ok(submitted, "Ping must have been submitted");
 });
 
+add_task(async function test_jog_noinfo_ping_works() {
+  const kReason = "reason-1";
+  Services.fog.testRegisterRuntimePing("noinfo-ping", true, true, true, false, [
+    kReason,
+  ]);
+  let submitted = false;
+  GleanPings.noinfoPing.testBeforeNextSubmit(reason => {
+    submitted = true;
+    Assert.equal(kReason, reason);
+  });
+  GleanPings.noinfoPing.submit("reason-1");
+  Assert.ok(submitted, "Ping must have been submitted");
+});
+
 add_task(function test_jog_name_collision() {
   Assert.ok("aCounter" in Glean.testOnlyJog);
   Assert.equal(undefined, Glean.testOnlyJog.aCounter.testGetValue());

toolkit/components/glean/xpcom/FOG.cpp

@@ -419,12 +419,13 @@ FOG::TestRegisterRuntimePing(const nsACString& aName,
                              const bool aIncludeClientId,
                              const bool aSendIfEmpty,
                              const bool aPreciseTimestamps,
+                             const bool aIncludeInfoSections,
                              const nsTArray<nsCString>& aReasonCodes,
                              uint32_t* aPingIdOut) {
   *aPingIdOut = 0;
-  *aPingIdOut =
-      glean::jog::jog_test_register_ping(&aName, aIncludeClientId, aSendIfEmpty,
-                                         aPreciseTimestamps, &aReasonCodes);
+  *aPingIdOut = glean::jog::jog_test_register_ping(
+      &aName, aIncludeClientId, aSendIfEmpty, aPreciseTimestamps,
+      aIncludeInfoSections, &aReasonCodes);
   return NS_OK;
 }
 

toolkit/components/glean/xpcom/nsIFOG.idl

@@ -180,11 +180,14 @@ interface nsIFOG : nsISupports
    * @param aName - The ping's name.
    * @param aIncludeClientId - Whether the ping should include the client_id.
    * @param aSendIfEmpty - Whether the ping should send even if empty.
+   * @param aIncludeInfoSections - Whether the ping should include
+   *                               {client|ping}_info sections.
    * @param aReasonCodes - The list of valid reasons for ping submission.
    */
   uint32_t testRegisterRuntimePing(in ACString aName,
                                    in boolean aIncludeClientId,
                                    in boolean aSendIfEmpty,
                                    in boolean aPreciseTimestamps,
+                                   in boolean aIncludeInfoSections,
                                    in Array<ACString> aReasonCodes);
 };