Bug 1872935 - Reconcile original categorization ping patches with updated code. r=jteow

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

Author: Stephanie Cunnane

browser/components/search/SearchSERPTelemetry.sys.mjs

@@ -57,6 +57,7 @@ export const CATEGORIZATION_SETTINGS = {
   STARTING_RANK: 2,
   IDLE_TIMEOUT_SECONDS: 60 * 60,
   WAKE_TIMEOUT_MS: 60 * 60 * 1000,
+  PING_SUBMISSION_THRESHOLD: 10,
 };
 
 ChromeUtils.defineLazyGetter(lazy, "logConsole", () => {
@@ -85,13 +86,22 @@ XPCOMUtils.defineLazyPreferenceGetter(
     if (newValue) {
       SearchSERPDomainToCategoriesMap.init();
       SearchSERPCategorizationEventScheduler.init();
+      SERPCategorizationRecorder.init();
     } else {
       SearchSERPDomainToCategoriesMap.uninit();
       SearchSERPCategorizationEventScheduler.uninit();
+      SERPCategorizationRecorder.uninit();
     }
   }
 );
 
+XPCOMUtils.defineLazyPreferenceGetter(
+  lazy,
+  "activityLimit",
+  "telemetry.fog.test.activity_limit",
+  120
+);
+
 export const SearchSERPTelemetryUtils = {
   ACTIONS: {
     CLICKED: "clicked",
@@ -2114,6 +2124,58 @@ class CategorizationEventScheduler {
  * Handles reporting SERP categorization telemetry to Glean.
  */
 class CategorizationRecorder {
+  #init = false;
+
+  // The number of SERP categorizations that have been recorded but not yet
+  // reported in a Glean ping.
+  #serpCategorizationsCount = 0;
+
+  // When the user started interacting with the SERP.
+  #userInteractionStartTime = null;
+
+  async init() {
+    if (this.#init) {
+      return;
+    }
+
+    Services.obs.addObserver(this, "user-interaction-active");
+    Services.obs.addObserver(this, "user-interaction-inactive");
+    this.#init = true;
+    this.submitPing("startup");
+  }
+
+  uninit() {
+    if (this.#init) {
+      Services.obs.removeObserver(this, "user-interaction-active");
+      Services.obs.removeObserver(this, "user-interaction-inactive");
+      this.#resetCategorizationRecorderData();
+      this.#init = false;
+    }
+  }
+
+  observe(subject, topic, data) {
+    switch (topic) {
+      case "user-interaction-active":
+        // If the user is already active, we don't want to overwrite the start
+        // time.
+        if (this.#userInteractionStartTime == null) {
+          this.#userInteractionStartTime = Date.now();
+        }
+        break;
+      case "user-interaction-inactive":
+        let currentTime = Date.now();
+        let activityLimitInMs = lazy.activityLimit * 1000;
+        if (
+          this.#userInteractionStartTime &&
+          currentTime - this.#userInteractionStartTime >= activityLimitInMs
+        ) {
+          this.submitPing("inactivity");
+        }
+        this.#userInteractionStartTime = null;
+        break;
+    }
+  }
+
   /**
    * Helper function for recording the SERP categorization event.
    *
@@ -2125,7 +2187,25 @@ class CategorizationRecorder {
       "Reporting the following categorization result:",
       resultToReport
     );
-    // TODO: Bug 1868476 - Report result to Glean.
+    Glean.serp.categorization.record(resultToReport);
+
+    this.#serpCategorizationsCount++;
+    if (
+      this.#serpCategorizationsCount >=
+      CATEGORIZATION_SETTINGS.PING_SUBMISSION_THRESHOLD
+    ) {
+      this.submitPing("threshold_reached");
+      this.#serpCategorizationsCount = 0;
+    }
+  }
+
+  submitPing(reason) {
+    GleanPings.serpCategorization.submit(reason);
+  }
+
+  #resetCategorizationRecorderData() {
+    this.#serpCategorizationsCount = 0;
+    this.#userInteractionStartTime = null;
   }
 }
 

browser/components/search/moz.build

@@ -18,7 +18,10 @@ BROWSER_CHROME_MANIFESTS += [
     "test/browser/telemetry/browser.toml",
 ]
 
-MARIONETTE_MANIFESTS += ["test/marionette/manifest.toml"]
+MARIONETTE_MANIFESTS += [
+    "test/marionette/manifest.toml",
+    "test/marionette/telemetry/manifest.toml",
+]
 
 XPCSHELL_TESTS_MANIFESTS += ["test/unit/xpcshell.toml"]
 

browser/components/search/test/browser/telemetry/browser.toml

@@ -50,6 +50,12 @@ support-files = ["searchTelemetryDomainCategorizationReporting.html"]
 ["browser_search_telemetry_domain_categorization_extraction.js"]
 support-files = ["searchTelemetryDomainExtraction.html"]
 
+["browser_search_telemetry_domain_categorization_ping_submission.js"]
+support-files = [
+  "searchTelemetryDomainCategorizationReporting.html",
+  "searchTelemetryDomainExtraction.html",
+]
+
 ["browser_search_telemetry_domain_categorization_region.js"]
 support-files = ["searchTelemetryDomainCategorizationReporting.html"]
 

browser/components/search/test/browser/telemetry/browser_search_glean_serp_event_telemetry_categorization_enabled_by_nimbus_variable.js

@@ -179,6 +179,7 @@ add_task(async function test_enable_experiment_when_pref_is_not_enabled() {
   await new Promise(resolve => setTimeout(resolve, 1500));
   BrowserTestUtils.removeTab(tab);
 
+  // We should not record telemetry if the experiment is un-enrolled.
   assertCategorizationValues([]);
 
   // Clean up.