Bug 1901208 - Add an integration test to ensure that searchWith pings are correctly recorded. r=search-reviewers,mcheang

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

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

@@ -63,6 +63,8 @@ support-files = [
 
 ["browser_private_search_perwindowpb.js"]
 
+["browser_remote_override.js"]
+
 ["browser_rich_suggestions.js"]
 support-files = ["trendingSuggestionEngine.sjs"]
 

browser/components/search/test/browser/browser_remote_override.js

@@ -0,0 +1,128 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * Tests that a configuration supplied by search-config-overrides-v2 is
+ * correctly applied to the search engine, and that the searchWith ping is
+ * sent.
+ */
+
+const TEST_CONFIG = [
+  {
+    identifier: "override",
+    recordType: "engine",
+    base: {
+      classification: "unknown",
+      name: "override name",
+      urls: {
+        search: {
+          base: "https://www.example.com/search",
+          params: [
+            {
+              name: "old_param",
+              value: "old_value",
+            },
+          ],
+          searchTermParamName: "q",
+        },
+      },
+    },
+    variants: [
+      {
+        environment: { allRegionsAndLocales: true },
+      },
+    ],
+  },
+  {
+    recordType: "defaultEngines",
+    globalDefault: "basic",
+    specificDefaults: [],
+  },
+  {
+    recordType: "engineOrders",
+    orders: [],
+  },
+];
+
+const TEST_CONFIG_OVERRIDE = [
+  {
+    identifier: "override",
+    urls: {
+      search: {
+        params: [{ name: "new_param", value: "new_value" }],
+      },
+    },
+    telemetrySuffix: "tsfx",
+    clickUrl: "https://example.org/somewhere",
+  },
+];
+
+SearchTestUtils.init(this);
+
+add_setup(async () => {
+  SearchTestUtils.useMockIdleService();
+  await SearchTestUtils.updateRemoteSettingsConfig(
+    TEST_CONFIG,
+    TEST_CONFIG_OVERRIDE
+  );
+  Services.fog.testResetFOG();
+
+  // Sanity check that the search engine is set as default.
+  Assert.equal(
+    Services.search.defaultEngine.identifier,
+    "override-tsfx",
+    "Should have the expected engine set as default"
+  );
+
+  registerCleanupFunction(async () => {
+    let settingsWritten = SearchTestUtils.promiseSearchNotification(
+      "write-settings-to-disk-complete"
+    );
+    await SearchTestUtils.updateRemoteSettingsConfig();
+    await settingsWritten;
+  });
+});
+
+add_task(async function test_remote_override() {
+  let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser);
+
+  await UrlbarTestUtils.promiseAutocompleteResultPopup({
+    window,
+    value: "test",
+  });
+  let matchCount = UrlbarTestUtils.getResultCount(window);
+  Assert.greaterOrEqual(
+    matchCount,
+    1,
+    "Should have at least one item in the results"
+  );
+
+  let pingReceived = Promise.withResolvers();
+  GleanPings.searchWith.testBeforeNextSubmit(() => {
+    Assert.equal(
+      Glean.searchWith.reportingUrl.testGetValue(),
+      "https://example.org/somewhere",
+      "Should have recorded the reporting URL"
+    );
+    Assert.equal(
+      Glean.searchWith.contextId.testGetValue().length,
+      36,
+      "Should have sent a context id with the ping"
+    );
+    pingReceived.resolve();
+  });
+
+  let loadPromise = BrowserTestUtils.browserLoaded(tab.linkedBrowser);
+  EventUtils.sendKey("return");
+  await loadPromise;
+  await pingReceived.promise;
+
+  Assert.equal(
+    tab.linkedBrowser.currentURI.spec,
+    "https://www.example.com/search?new_param=new_value&q=test",
+    "Should have loaded the page with the overridden parameters"
+  );
+
+  BrowserTestUtils.removeTab(tab);
+});