Bug 1861676 - Use the new queryParamNames SERP telemetry parameter by default. r=search-reviewers,jteow

Differential Revision: https://phabricator.services.mozilla.com/D191649
2023-11-03 10:35:04 +00:00 · 2023-11-03 10:35:04 +00:00 · 7537024af5
--- a/browser/actors/SearchSERPTelemetryChild.sys.mjs
+++ b/browser/actors/SearchSERPTelemetryChild.sys.mjs
@ -1232,10 +1232,12 @@ export class SearchSERPTelemetryChild extends JSWindowActorChild {
      // To check this, we look for the presence of the query parameter
      // that contains a search term.
      let queries = new URLSearchParams(url.split("#")[0].split("?")[1]);
-      if (queries.has(provider.queryParamName)) {
+      for (let queryParamName of provider.queryParamNames) {
+        if (queries.get(queryParamName)) {
          return true;
        }
      }
+    }
    return false;
  }

--- a/browser/components/search/SearchSERPTelemetry.sys.mjs
+++ b/browser/components/search/SearchSERPTelemetry.sys.mjs
@ -720,7 +720,14 @@ class TelemetryHandler {
    // To check this, we look for the presence of the query parameter
    // that contains a search term.
    let queries = new URLSearchParams(url.split("#")[0].split("?")[1]);
-    if (!queries.get(searchProviderInfo.queryParamName)) {
+    let hasQuery = false;
+    for (let queryParamName of searchProviderInfo.queryParamNames) {
+      if (queries.get(queryParamName)) {
+        hasQuery = true;
+        break;
+      }
+    }
+    if (!hasQuery) {
      return null;
    }
    // Default to organic to simplify things.
--- a/browser/components/search/schema/search-telemetry-schema.json
+++ b/browser/components/search/schema/search-telemetry-schema.json
@ -1,6 +1,11 @@
 {
  "type": "object",
-  "required": ["telemetryId", "searchPageRegexp", "queryParamName"],
+  "required": [
+    "telemetryId",
+    "searchPageRegexp",
+    "queryParamName",
+    "queryParamNames"
+  ],
  "properties": {
    "telemetryId": {
      "type": "string",
--- a/browser/components/search/test/browser/telemetry/browser_search_glean_serp_event_telemetry_categorization_enabled_by_nimbus_variable.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_glean_serp_event_telemetry_categorization_enabled_by_nimbus_variable.js
@ -36,7 +36,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_glean_serp_event_telemetry_enabled_by_nimbus_variable.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_glean_serp_event_telemetry_enabled_by_nimbus_variable.js
@ -25,7 +25,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_abandonment.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_abandonment.js
@ -12,7 +12,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_adImpression_component.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_adImpression_component.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_categorization_timing.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_categorization_timing.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_domain_categorization_download_timer.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_domain_categorization_download_timer.js
@ -27,7 +27,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_domain_categorization_reporting.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_domain_categorization_reporting.js
@ -23,7 +23,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_cached.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_cached.js
@ -12,7 +12,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_cached_serp.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_cached_serp.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_content.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_content.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_searchbox_with_content.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_multiple_tabs.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_multiple_tabs.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_non_ad.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_non_ad.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_query_params.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_query_params.js
@ -15,7 +15,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_redirect.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_redirect.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_target.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_engagement_target.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_private.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_private.js
@ -13,7 +13,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["mozAttr"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_shopping.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_shopping.js
@ -15,7 +15,7 @@ const BASE_TEST_PROVIDER = {
  telemetryId: "example",
  searchPageRegexp:
    /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd/,
-  queryParamName: "s",
+  queryParamNames: ["s"],
  codeParamName: "abc",
  taggedCodes: ["ff"],
  extraAdServersRegexps: [/^https:\/\/example\.org\/ad/],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources.js
@ -16,7 +16,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_clicks.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_clicks.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_data_attributes.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_data_attributes.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example-data-attributes",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetryAd_dataAttributes(?:_none|_href)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    adServerAttributes: ["xyz"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_load_events.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_ads_load_events.js
@ -14,7 +14,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "slow-page-load",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/slow_loading_page_with_ads(_on_load_event)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_in_content.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_in_content.js
@ -12,7 +12,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_navigation.js
+++ b/browser/components/search/test/browser/telemetry/browser_search_telemetry_sources_navigation.js
@ -12,7 +12,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.org\/browser\/browser\/components\/search\/test\/browser\/telemetry\/searchTelemetry(?:Ad)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],
--- a/browser/components/search/test/unit/test_urlTelemetry_generic.js
+++ b/browser/components/search/test/unit/test_urlTelemetry_generic.js
@ -16,7 +16,7 @@ const TEST_PROVIDER_INFO = [
  {
    telemetryId: "example",
    searchPageRegexp: /^https:\/\/www\.example\.com\/search/,
-    queryParamName: "q",
+    queryParamNames: ["q"],
    codeParamName: "abc",
    taggedCodes: ["ff", "tb"],
    expectedOrganicCodes: ["baz"],
@ -36,7 +36,7 @@ const TEST_PROVIDER_INFO = [
  {
    telemetryId: "example2",
    searchPageRegexp: /^https:\/\/www\.example2\.com\/search/,
-    queryParamName: "q",
+    queryParamNames: ["a", "q"],
    codeParamName: "abc",
    taggedCodes: ["ff", "tb"],
    expectedOrganicCodes: ["baz"],
--- a/browser/components/urlbar/tests/browser/browser_urlbar_telemetry.js
+++ b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry.js
@ -1026,7 +1026,7 @@ add_task(async function test_privateWindow() {
    {
      telemetryId: "example",
      searchPageRegexp: "^https://example\\.com/",
-      queryParamName: "q",
+      queryParamNames: ["q"],
    },
  ]);

--- a/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_handoff.js
+++ b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_handoff.js
@ -12,7 +12,7 @@ const TEST_PROVIDER_INFO = [
    telemetryId: "example",
    searchPageRegexp:
      /^https:\/\/example.com\/browser\/browser\/components\/search\/test\/browser\/searchTelemetry(?:Ad)?.html/,
-    queryParamName: "s",
+    queryParamNames: ["s"],
    codeParamName: "abc",
    taggedCodes: ["ff"],
    followOnParamNames: ["a"],