Bug 1824253: Set enabling/disabling urlbar engagement telemetry via S…

…erver Knobs r=mak,TravisLong Differential Revision: https://phabricator.services.mozilla.com/D173494
iaxat · Apr 18, 2023 · 09374b6 · 09374b6
1 parent 8ca8e37
commit 09374b6
Show file tree

Hide file tree

Showing 15 changed files with 48 additions and 291 deletions.
diff --git a/browser/app/profile/firefox.js b/browser/app/profile/firefox.js
@@ -538,9 +538,6 @@ pref("browser.urlbar.shortcuts.history", true);
 
 pref("browser.urlbar.eventTelemetry.enabled", false);
 
-// Whether search engagement telemetry should be recorded.
-pref("browser.urlbar.searchEngagementTelemetry.enabled", false);
-
 // When we send events to Urlbar extensions, we wait this amount of time in
 // milliseconds for them to respond before timing out.
 pref("browser.urlbar.extension.timeout", 400);

diff --git a/browser/components/urlbar/UrlbarController.sys.mjs b/browser/components/urlbar/UrlbarController.sys.mjs
@@ -1167,9 +1167,7 @@ class TelemetryEvent {
       `${method} event: ${JSON.stringify(eventInfo)}`
     );
 
-    if (lazy.UrlbarPrefs.get("searchEngagementTelemetryEnabled")) {
-      Glean.urlbar[method].record(eventInfo);
-    }
+    Glean.urlbar[method].record(eventInfo);
   }
 
   #getInteractionType(
@@ -1348,33 +1346,18 @@ class TelemetryEvent {
   };
 
   #beginObservingPingPrefs() {
-    this.onPrefChanged("searchEngagementTelemetry.enabled");
+    for (const p of Object.keys(this.#PING_PREFS)) {
+      this.onPrefChanged(p);
+    }
     lazy.UrlbarPrefs.addObserver(this);
   }
 
   onPrefChanged(pref) {
-    if (pref === "searchEngagementTelemetry.enabled") {
-      for (const p of Object.keys(this.#PING_PREFS)) {
-        this.onPrefChanged(p);
-      }
-      return;
-    }
-
-    if (!lazy.UrlbarPrefs.get("searchEngagementTelemetryEnabled")) {
-      return;
-    }
-
     const metric = this.#PING_PREFS[pref];
     if (metric) {
       metric.set(lazy.UrlbarPrefs.get(pref));
     }
   }
 
-  onNimbusChanged(variable) {
-    if (variable === "searchEngagementTelemetryEnabled") {
-      this.onPrefChanged("searchEngagementTelemetry.enabled");
-    }
-  }
-
   #previousSearchWordsSet = null;
 }
diff --git a/browser/components/urlbar/UrlbarPrefs.sys.mjs b/browser/components/urlbar/UrlbarPrefs.sys.mjs
@@ -129,10 +129,6 @@ const PREF_URLBAR_DEFAULTS = new Map([
   // Applies URL highlighting and other styling to the text in the urlbar input.
   ["formatting.enabled", true],
 
-  // Whether search engagement telemetry should be recorded. This pref is a
-  // fallback for the Nimbus variable `searchEngagementTelemetryEnabled`.
-  ["searchEngagementTelemetry.enabled", false],
-
   // Interval time until taking pause impression telemetry.
   ["searchEngagementTelemetry.pauseImpressionIntervalMs", 1000],
 

diff --git a/browser/components/urlbar/metrics.yaml b/browser/components/urlbar/metrics.yaml
@@ -12,6 +12,7 @@ $tags:
 
 urlbar:
   abandonment:
+    disabled: true
     type: event
     description: Recorded when the user abandons a search (blurring the urlbar).
     extra_keys:
@@ -129,6 +130,7 @@ urlbar:
       - [email protected]
     expires: never
   engagement:
+    disabled: true
     type: event
     description: Recorded when the user executes an action on a result.
     extra_keys:
@@ -323,6 +325,7 @@ urlbar:
       - [email protected]
     expires: never
   impression:
+    disabled: true
     type: event
     description: Recorded when urlbar results are shown to the user.
     extra_keys:

diff --git a/browser/components/urlbar/tests/engagementTelemetry/browser/browser.ini b/browser/components/urlbar/tests/engagementTelemetry/browser/browser.ini
@@ -8,7 +8,6 @@ support-files =
   head-groups.js
   head-interaction.js
   head-n_chars_n_words.js
-  head-preferences.js
   head-sap.js
   head-search_mode.js
   ../../browser-tips/head.js
@@ -23,7 +22,6 @@ skip-if =
 [browser_glean_telemetry_abandonment_interaction_persisted_search_terms_disabled.js]
 [browser_glean_telemetry_abandonment_interaction_persisted_search_terms_enabled.js]
 [browser_glean_telemetry_abandonment_n_chars_n_words.js]
-[browser_glean_telemetry_abandonment_preferences.js]
 [browser_glean_telemetry_abandonment_sap.js]
 [browser_glean_telemetry_abandonment_search_mode.js]
 [browser_glean_telemetry_abandonment_tips.js]
@@ -33,7 +31,6 @@ skip-if =
 [browser_glean_telemetry_engagement_interaction_persisted_search_terms_disabled.js]
 [browser_glean_telemetry_engagement_interaction_persisted_search_terms_enabled.js]
 [browser_glean_telemetry_engagement_n_chars_n_words.js]
-[browser_glean_telemetry_engagement_preferences.js]
 [browser_glean_telemetry_engagement_sap.js]
 [browser_glean_telemetry_engagement_search_mode.js]
 [browser_glean_telemetry_engagement_selected_result.js]

diff --git a/...lbar/tests/engagementTelemetry/browser/browser_glean_telemetry_abandonment_preferences.js b/...lbar/tests/engagementTelemetry/browser/browser_glean_telemetry_abandonment_preferences.js
diff --git a/...ents/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_abandonment_tips.js b/...ents/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_abandonment_tips.js
@@ -11,9 +11,12 @@ Services.scriptloader.loadSubScript(
 );
 
 add_setup(async function() {
+  Services.fog.setMetricsFeatureConfig(
+    JSON.stringify({ "urlbar.abandonment": false })
+  );
+
   await SpecialPowers.pushPrefEnv({
     set: [
-      ["browser.urlbar.searchEngagementTelemetry.enabled", true],
       ["browser.urlbar.searchTips.test.ignoreShowLimits", true],
       ["browser.urlbar.showSearchTerms.featureGate", true],
     ],
@@ -30,6 +33,7 @@ add_setup(async function() {
   await Services.search.moveEngine(engine, 0);
 
   registerCleanupFunction(async function() {
+    Services.fog.setMetricsFeatureConfig("{}");
     await SpecialPowers.popPrefEnv();
     await Services.search.setDefault(
       originalDefaultEngine,

diff --git a/...rlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_engagement_preferences.js b/...rlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_engagement_preferences.js
diff --git a/...nents/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_engagement_tips.js b/...nents/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_engagement_tips.js
@@ -17,13 +17,15 @@ ChromeUtils.defineESModuleGetters(this, {
 add_setup(async function() {
   makeProfileResettable();
 
+  Services.fog.setMetricsFeatureConfig(
+    JSON.stringify({ "urlbar.engagement": false })
+  );
   await SpecialPowers.pushPrefEnv({
-    set: [
-      ["browser.urlbar.searchEngagementTelemetry.enabled", true],
-      ["browser.urlbar.quickactions.enabled", false],
-    ],
+    set: [["browser.urlbar.quickactions.enabled", false]],
   });
+
   registerCleanupFunction(async function() {
+    Services.fog.setMetricsFeatureConfig("{}");
     await SpecialPowers.popPrefEnv();
   });
 });

diff --git a/...rlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_impression_preferences.js b/...rlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_impression_preferences.js
@@ -6,41 +6,7 @@
 // Test the impression telemetry behavior with its preferences.
 
 add_setup(async function() {
-  await initPreferencesTest();
-});
-
-add_task(async function enabled() {
-  await doSearchEngagementTelemetryTest({
-    enabled: true,
-    trigger: () => waitForPauseImpression(),
-    assert: () =>
-      assertImpressionTelemetry([{ reason: "pause", sap: "urlbar_newtab" }]),
-  });
-});
-
-add_task(async function disabled() {
-  await doSearchEngagementTelemetryTest({
-    enabled: false,
-    trigger: () => waitForPauseImpression(),
-    assert: () => assertImpressionTelemetry([]),
-  });
-});
-
-add_task(async function nimbusEnabled() {
-  await doNimbusTest({
-    enabled: true,
-    trigger: () => waitForPauseImpression(),
-    assert: () =>
-      assertImpressionTelemetry([{ reason: "pause", sap: "urlbar_newtab" }]),
-  });
-});
-
-add_task(async function nimbusDisabled() {
-  await doNimbusTest({
-    enabled: false,
-    trigger: () => waitForPauseImpression(),
-    assert: () => assertImpressionTelemetry([]),
-  });
+  await setup();
 });
 
 add_task(async function pauseImpressionIntervalMs() {
@@ -50,7 +16,6 @@ add_task(async function pauseImpressionIntervalMs() {
   );
   await SpecialPowers.pushPrefEnv({
     set: [
-      ["browser.urlbar.searchEngagementTelemetry.enabled", true],
       [
         "browser.urlbar.searchEngagementTelemetry.pauseImpressionIntervalMs",
         originalInterval + additionalInterval,

diff --git a/...ts/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_record_preferences.js b/...ts/urlbar/tests/engagementTelemetry/browser/browser_glean_telemetry_record_preferences.js
@@ -6,22 +6,18 @@
 // Test for preference telemetry.
 
 add_setup(async function() {
-  // Simulate initialization for TelemetryEvent.
-  // 1. Turn browser.urlbar.searchEngagementTelemetry.enabled on.
-  // 2. Remove all Glean data.
-  // 3. Call onPrefChanged() that will be called from TelemetryEvent constructor.
-  await SpecialPowers.pushPrefEnv({
-    set: [["browser.urlbar.searchEngagementTelemetry.enabled", true]],
-  });
   await Services.fog.testFlushAllChildren();
   Services.fog.testResetFOG();
-  gURLBar.controller.engagementEvent.onPrefChanged(
-    "searchEngagementTelemetry.enabled"
-  );
+
+  // Create a new window in order to initialize TelemetryEvent of
+  // UrlbarController.
+  const win = await BrowserTestUtils.openNewBrowserWindow();
+  registerCleanupFunction(async function() {
+    await BrowserTestUtils.closeWindow(win);
+  });
 });
 
 add_task(async function prefMaxRichResults() {
-  Assert.ok(UrlbarPrefs.get("maxRichResults"), "Sanity check");
   Assert.equal(
     Glean.urlbar.prefMaxResults.testGetValue(),
     UrlbarPrefs.get("maxRichResults"),
@@ -56,66 +52,3 @@ add_task(async function prefSuggestTopsites() {
     "Record prefSuggestTopsites when the suggest.topsites pref is updated"
   );
 });
-
-add_task(async function searchEngagementTelemetryEnabled() {
-  info("Disable search engagement telemetry");
-  await SpecialPowers.pushPrefEnv({
-    set: [["browser.urlbar.searchEngagementTelemetry.enabled", false]],
-  });
-  await SpecialPowers.pushPrefEnv({
-    set: [
-      ["browser.urlbar.suggest.topsites", !UrlbarPrefs.get("suggest.topsites")],
-      ["browser.urlbar.maxRichResults", 100],
-    ],
-  });
-  Assert.notEqual(
-    Glean.urlbar.prefMaxResults.testGetValue(),
-    UrlbarPrefs.get("maxRichResults"),
-    "Did not record prefMaxResults"
-  );
-  Assert.notEqual(
-    Glean.urlbar.prefSuggestTopsites.testGetValue(),
-    UrlbarPrefs.get("suggest.topsites"),
-    "Did not record prefSuggestTopsites"
-  );
-
-  info("Enable search engagement telemetry");
-  await SpecialPowers.pushPrefEnv({
-    set: [["browser.urlbar.searchEngagementTelemetry.enabled", true]],
-  });
-  Assert.equal(
-    Glean.urlbar.prefMaxResults.testGetValue(),
-    UrlbarPrefs.get("maxRichResults"),
-    "Update prefMaxResults when search engagement telemetry is enabled"
-  );
-  Assert.equal(
-    Glean.urlbar.prefSuggestTopsites.testGetValue(),
-    UrlbarPrefs.get("suggest.topsites"),
-    "Update prefSuggestTopsites when search engagement telemetry is enabled"
-  );
-});
-
-add_task(async function nimbusSearchEngagementTelemetryEnabled() {
-  info("Disable search engagement telemetry");
-  await SpecialPowers.pushPrefEnv({
-    set: [["browser.urlbar.searchEngagementTelemetry.enabled", false]],
-  });
-
-  info("Enable search engagement telemetry from Nimbus");
-  // eslint-disable-next-line mozilla/valid-lazy
-  const doCleanup = await lazy.UrlbarTestUtils.initNimbusFeature({
-    searchEngagementTelemetryEnabled: true,
-  });
-  Assert.equal(
-    Glean.urlbar.prefMaxResults.testGetValue(),
-    UrlbarPrefs.get("maxRichResults"),
-    "Update prefMaxResults when search engagement telemetry is enabled"
-  );
-  Assert.equal(
-    Glean.urlbar.prefSuggestTopsites.testGetValue(),
-    UrlbarPrefs.get("suggest.topsites"),
-    "Update prefSuggestTopsites when search engagement telemetry is enabled"
-  );
-
-  doCleanup();
-});