1 files changed, 110 insertions, 0 deletions
diff --git a/browser/components/search/test/browser/browser_rich_suggestions.js b/browser/components/search/test/browser/browser_rich_suggestions.js
new file mode 100644
index 0000000000..b92cdb5a6a
--- /dev/null
+++ b/browser/components/search/test/browser/browser_rich_suggestions.js
@@ -0,0 +1,110 @@
+/* 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/. */
+
+const CONFIG_DEFAULT = [
+  {
+    webExtension: { id: "basic@search.mozilla.org" },
+    urls: {
+      trending: {
+        fullPath:
+          "https://example.com/browser/browser/components/search/test/browser/trendingSuggestionEngine.sjs?richsuggestions=true",
+        query: "",
+      },
+    },
+    appliesTo: [{ included: { everywhere: true } }],
+    default: "yes",
+  },
+];
+
+SearchTestUtils.init(this);
+
+add_setup(async () => {
+  // Use engines in test directory
+  let searchExtensions = getChromeDir(getResolvedURI(gTestPath));
+  searchExtensions.append("search-engines");
+  await SearchTestUtils.useMochitestEngines(searchExtensions);
+
+  await SpecialPowers.pushPrefEnv({
+    set: [
+      ["browser.urlbar.suggest.searches", true],
+      ["browser.urlbar.trending.featureGate", true],
+      ["browser.urlbar.trending.requireSearchMode", false],
+      ["browser.urlbar.eventTelemetry.enabled", true],
+      // Bug 1775917: Disable the persisted-search-terms search tip because if
+      // not dismissed, it can cause issues with other search tests.
+      ["browser.urlbar.tipShownCount.searchTip_persist", 999],
+    ],
+  });
+
+  SearchTestUtils.useMockIdleService();
+  await SearchTestUtils.updateRemoteSettingsConfig(CONFIG_DEFAULT);
+
+  registerCleanupFunction(async () => {
+    let settingsWritten = SearchTestUtils.promiseSearchNotification(
+      "write-settings-to-disk-complete"
+    );
+    await SearchTestUtils.updateRemoteSettingsConfig();
+    await settingsWritten;
+  });
+});
+
+add_task(async function test_trending_results() {
+  await check_results({ featureEnabled: true });
+  await check_results({ featureEnabled: false });
+});
+
+async function check_results({ featureEnabled = false }) {
+  Services.telemetry.clearEvents();
+  Services.telemetry.clearScalars();
+  await SpecialPowers.pushPrefEnv({
+    set: [["browser.urlbar.richSuggestions.featureGate", featureEnabled]],
+  });
+
+  await UrlbarTestUtils.promiseAutocompleteResultPopup({
+    window,
+    value: "",
+    waitForFocus: SimpleTest.waitForFocus,
+  });
+
+  let numResults = UrlbarTestUtils.getResultCount(window);
+
+  for (let i = 0; i < numResults; i++) {
+    let { result } = await UrlbarTestUtils.getDetailsOfResultAt(window, i);
+    Assert.equal(result.type, UrlbarUtils.RESULT_TYPE.SEARCH);
+    Assert.equal(result.providerName, "SearchSuggestions");
+    Assert.equal(result.payload.engine, "basic");
+    Assert.equal(result.payload.isRichSuggestion, featureEnabled);
+    if (featureEnabled) {
+      Assert.equal(typeof result.payload.description, "string");
+      Assert.ok(result.payload.icon.startsWith("data:"));
+    }
+  }
+
+  info("Select first remote search suggestion & hit Enter.");
+  EventUtils.synthesizeKey("KEY_ArrowDown", {}, window);
+  EventUtils.synthesizeKey("VK_RETURN", {}, window);
+
+  let event = {
+    category: "urlbar",
+    method: "engagement",
+    object: "enter",
+    value: "typed",
+    extra: {
+      elapsed: val => parseInt(val) > 0,
+      numChars: "0",
+      numWords: "0",
+      selIndex: "0",
+      selType: featureEnabled ? "trending_rich" : "trending",
+      provider: "SearchSuggestions",
+    },
+  };
+
+  TelemetryTestUtils.assertEvents([event], {
+    category: "urlbar",
+  });
+  let scalars = TelemetryTestUtils.getProcessScalars("parent", false, true);
+  TelemetryTestUtils.assertScalar(scalars, "urlbar.engagement", 1);
+
+  await SpecialPowers.popPrefEnv();
+}