tor-browser

commit e0bf6829df84c54895a3766ded736435a08e6583
parent 26079b173d2ac9ddb5e5215ce65acac1a0514390
Author: Mark Banner <standard8@mozilla.com>
Date:   Mon, 13 Oct 2025 13:14:27 +0000

Bug 1992354 - Rename UrlbarInput.eventTelemetryCategory to UrlbarInput.sapName. r=urlbar-reviewers,dao

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

Diffstat:
M
browser/base/content/browser-init.js
 | 
2
+-
M
browser/base/content/browser.js
 | 
2
+-
M
browser/components/urlbar/UrlbarInput.sys.mjs
 | 
25
++++++++++++-------------

3 files changed, 14 insertions(+), 15 deletions(-)
diff --git a/browser/base/content/browser-init.js b/browser/base/content/browser-init.js
@@ -167,7 +167,7 @@ var gBrowserInit = {
     if (Services.prefs.getBoolPref("browser.search.widget.new", false)) {
       new UrlbarInput({
         textbox: document.getElementById("searchbar-new"),
-        eventTelemetryCategory: "searchbar",
+        sapName: "searchbar",
       });
     }
 
diff --git a/browser/base/content/browser.js b/browser/base/content/browser.js
@@ -371,7 +371,7 @@ ChromeUtils.defineLazyGetter(this, "gURLBar", () => {
   let urlbar = new UrlbarInput({
     textbox: document.getElementById("urlbar"),
     isAddressbar: true,
-    eventTelemetryCategory: "urlbar",
+    sapName: "urlbar",
   });
 
   let beforeFocusOrSelect = event => {
diff --git a/browser/components/urlbar/UrlbarInput.sys.mjs b/browser/components/urlbar/UrlbarInput.sys.mjs
@@ -92,9 +92,10 @@ export class UrlbarInput {
   #allowBreakout = false;
   #breakoutBlockerCount = 0;
   /**
-   * The source of the UrlbarInput for storing in events, e.g. `urlbar`, `searchbar`.
+   * The search access point name of the UrlbarInput for use with telemetry or
+   * logging, e.g. `urlbar`, `searchbar`.
    */
-  #eventTelemetryCategory;
+  #sapName;
   #userTypedValue;
 
   /**
@@ -102,13 +103,14 @@ export class UrlbarInput {
    *   The initial options for UrlbarInput.
    * @param {HTMLDivElement} options.textbox
    *   The container element.
-   * @param {string} options.eventTelemetryCategory
-   *   The source of the UrlbarInput for storing in events, e.g. `urlbar`, `searchbar`.
+   * @param {string} options.sapName
+   *   The search access point name of the UrlbarInput for use with telemetry or
+   *   logging, e.g. `urlbar`, `searchbar`.
    * @param {boolean} [options.isAddressbar]
    *   Whether this instance is meant to display the browser's current address,
    *   as opposed to being just a search input.
    */
-  constructor({ textbox, eventTelemetryCategory, isAddressbar = false }) {
+  constructor({ textbox, sapName, isAddressbar = false }) {
     this.textbox = textbox;
     this.isAddressbar = !!isAddressbar;
     this.window = this.textbox.ownerGlobal;
@@ -132,7 +134,7 @@ export class UrlbarInput {
     this._suppressStartQuery = false;
     this._suppressPrimaryAdjustment = false;
     this._untrimmedValue = "";
-    this.#eventTelemetryCategory = eventTelemetryCategory;
+    this.#sapName = sapName;
 
     this.QueryInterface = ChromeUtils.generateQI([
       "nsIObserver",
@@ -1205,7 +1207,7 @@ export class UrlbarInput {
     let openParams = {
       allowInheritPrincipal: false,
       globalHistoryOptions: {
-        triggeringSource: this.#eventTelemetryCategory,
+        triggeringSource: this.#sapName,
         triggeringSearchEngine: result.payload?.engine,
         triggeringSponsoredURL: result.payload?.isSponsored
           ? result.payload.url
@@ -1556,7 +1558,7 @@ export class UrlbarInput {
     if (result.payload.sendAttributionRequest) {
       lazy.PartnerLinkAttribution.makeRequest({
         targetURL: result.payload.url,
-        source: this.#eventTelemetryCategory,
+        source: this.#sapName,
         campaignID: Services.prefs.getStringPref(
           "browser.partnerlink.campaign.topsites"
         ),
@@ -2029,10 +2031,7 @@ export class UrlbarInput {
       // TODO: record SAP telemetry, see Bug 1961789.
     } else {
       url = searchEngine.searchForm;
-      lazy.BrowserSearchTelemetry.recordSearchForm(
-        searchEngine,
-        this.#eventTelemetryCategory
-      );
+      lazy.BrowserSearchTelemetry.recordSearchForm(searchEngine, this.#sapName);
     }
 
     this._lastSearchString = "";
@@ -2551,7 +2550,7 @@ export class UrlbarInput {
         return "urlbar-persisted";
       }
     }
-    return this.#eventTelemetryCategory;
+    return this.#sapName;
   }
 
   // Private methods below.