From 6bf0a5cb5034a7e684dcc3500e841785237ce2dd Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 7 Apr 2024 19:32:43 +0200
Subject: Adding upstream version 1:115.7.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../tests/browser/browser_urlbar_telemetry_tip.js  | 130 +++++++++++++++++++++
 1 file changed, 130 insertions(+)
 create mode 100644 browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js

(limited to 'browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js')

diff --git a/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js
new file mode 100644
index 0000000000..c234bc3ed8
--- /dev/null
+++ b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_tip.js
@@ -0,0 +1,130 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ */
+
+/**
+ * This file tests urlbar telemetry for tip results.
+ */
+
+"use strict";
+
+ChromeUtils.defineESModuleGetters(this, {
+  UrlbarProvider: "resource:///modules/UrlbarUtils.sys.mjs",
+  UrlbarProvidersManager: "resource:///modules/UrlbarProvidersManager.sys.mjs",
+  UrlbarResult: "resource:///modules/UrlbarResult.sys.mjs",
+  UrlbarTestUtils: "resource://testing-common/UrlbarTestUtils.sys.mjs",
+});
+
+function snapshotHistograms() {
+  Services.telemetry.clearScalars();
+  Services.telemetry.clearEvents();
+  return {
+    resultMethodHist: TelemetryTestUtils.getAndClearHistogram(
+      "FX_URLBAR_SELECTED_RESULT_METHOD"
+    ),
+    search_hist: TelemetryTestUtils.getAndClearKeyedHistogram("SEARCH_COUNTS"),
+  };
+}
+
+function assertTelemetryResults(histograms, type, index, method) {
+  TelemetryTestUtils.assertHistogram(histograms.resultMethodHist, method, 1);
+
+  TelemetryTestUtils.assertKeyedScalar(
+    TelemetryTestUtils.getProcessScalars("parent", true, true),
+    `urlbar.picked.${type}`,
+    index,
+    1
+  );
+}
+
+add_setup(async function () {
+  await SpecialPowers.pushPrefEnv({
+    set: [
+      // Disable search suggestions in the urlbar.
+      ["browser.urlbar.suggest.searches", false],
+      // Turn autofill off.
+      ["browser.urlbar.autoFill", false],
+    ],
+  });
+  await PlacesUtils.history.clear();
+  await PlacesUtils.bookmarks.eraseEverything();
+});
+
+add_task(async function test() {
+  // Add a restricting provider that returns a preselected heuristic tip result.
+  let provider = new TipProvider([
+    Object.assign(
+      new UrlbarResult(
+        UrlbarUtils.RESULT_TYPE.TIP,
+        UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
+        {
+          helpUrl: "https://example.com/",
+          type: "test",
+          titleL10n: { id: "urlbar-search-tips-confirm" },
+          buttons: [
+            {
+              url: "https://example.com/",
+              l10n: { id: "urlbar-search-tips-confirm" },
+            },
+          ],
+        }
+      ),
+      { heuristic: true }
+    ),
+  ]);
+  UrlbarProvidersManager.registerProvider(provider);
+
+  const histograms = snapshotHistograms();
+
+  let tab = await BrowserTestUtils.openNewForegroundTab(
+    gBrowser,
+    "about:blank"
+  );
+
+  // Show the view and press enter to select the tip.
+  await UrlbarTestUtils.promiseAutocompleteResultPopup({
+    window,
+    waitForFocus,
+    value: "test",
+    fireInputEvent: true,
+  });
+  EventUtils.synthesizeKey("KEY_Enter");
+
+  assertTelemetryResults(
+    histograms,
+    "tip",
+    0,
+    UrlbarTestUtils.SELECTED_RESULT_METHODS.enter
+  );
+
+  UrlbarProvidersManager.unregisterProvider(provider);
+  BrowserTestUtils.removeTab(tab);
+});
+
+/**
+ * A test URLBar provider.
+ */
+class TipProvider extends UrlbarProvider {
+  constructor(results) {
+    super();
+    this._results = results;
+  }
+  get name() {
+    return "TestProviderTip";
+  }
+  get type() {
+    return UrlbarUtils.PROVIDER_TYPE.PROFILE;
+  }
+  isActive(context) {
+    return true;
+  }
+  getPriority(context) {
+    return 1;
+  }
+  async startQuery(context, addCallback) {
+    context.preselected = true;
+    for (const result of this._results) {
+      addCallback(this, result);
+    }
+  }
+}
-- 
cgit v1.2.3