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>
---
 .../browser/browser_urlbar_telemetry_dynamic.js    | 136 +++++++++++++++++++++
 1 file changed, 136 insertions(+)
 create mode 100644 browser/components/urlbar/tests/browser/browser_urlbar_telemetry_dynamic.js

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

diff --git a/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_dynamic.js b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_dynamic.js
new file mode 100644
index 0000000000..d4f4e77d57
--- /dev/null
+++ b/browser/components/urlbar/tests/browser/browser_urlbar_telemetry_dynamic.js
@@ -0,0 +1,136 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ */
+
+/**
+ * This file tests urlbar telemetry for dynamic results.
+ */
+
+"use strict";
+
+ChromeUtils.defineESModuleGetters(this, {
+  UrlbarProvidersManager: "resource:///modules/UrlbarProvidersManager.sys.mjs",
+  UrlbarResult: "resource:///modules/UrlbarResult.sys.mjs",
+  UrlbarTestUtils: "resource://testing-common/UrlbarTestUtils.sys.mjs",
+  UrlbarView: "resource:///modules/UrlbarView.sys.mjs",
+});
+
+const DYNAMIC_TYPE_NAME = "test";
+
+/**
+ * A test URLBar provider.
+ */
+class TestProvider extends UrlbarTestUtils.TestProvider {
+  constructor() {
+    super({
+      priority: Infinity,
+      results: [
+        Object.assign(
+          new UrlbarResult(
+            UrlbarUtils.RESULT_TYPE.DYNAMIC,
+            UrlbarUtils.RESULT_SOURCE.OTHER_LOCAL,
+            {
+              dynamicType: DYNAMIC_TYPE_NAME,
+            }
+          ),
+          { heuristic: true }
+        ),
+      ],
+    });
+  }
+
+  getViewUpdate(result, idsByName) {
+    return {
+      title: {
+        textContent: "This is a dynamic result.",
+      },
+      button: {
+        textContent: "Click Me",
+      },
+    };
+  }
+}
+
+add_task(async function test() {
+  // Add a dynamic result type.
+  UrlbarResult.addDynamicResultType(DYNAMIC_TYPE_NAME);
+  UrlbarView.addDynamicViewTemplate(DYNAMIC_TYPE_NAME, {
+    stylesheet:
+      getRootDirectory(gTestPath) + "urlbarTelemetryUrlbarDynamic.css",
+    children: [
+      {
+        name: "title",
+        tag: "span",
+      },
+      {
+        name: "buttonSpacer",
+        tag: "span",
+      },
+      {
+        name: "button",
+        tag: "span",
+        attributes: {
+          role: "button",
+        },
+      },
+    ],
+  });
+  registerCleanupFunction(() => {
+    UrlbarView.removeDynamicViewTemplate(DYNAMIC_TYPE_NAME);
+    UrlbarResult.removeDynamicResultType(DYNAMIC_TYPE_NAME);
+  });
+
+  // Register a provider that returns the dynamic result type.
+  let provider = new TestProvider();
+  UrlbarProvidersManager.registerProvider(provider);
+  registerCleanupFunction(() => {
+    UrlbarProvidersManager.unregisterProvider(provider);
+  });
+
+  const histograms = snapshotHistograms();
+
+  // Do a search to show the dynamic result.
+  await UrlbarTestUtils.promiseAutocompleteResultPopup({
+    window,
+    waitForFocus,
+    value: "test",
+    fireInputEvent: true,
+  });
+
+  // Press enter on the result's button.  It will be preselected since the
+  // result is the heuristic.
+  await UrlbarTestUtils.promisePopupClose(window, () =>
+    EventUtils.synthesizeKey("KEY_Enter")
+  );
+
+  assertTelemetryResults(
+    histograms,
+    "dynamic",
+    0,
+    UrlbarTestUtils.SELECTED_RESULT_METHODS.enter
+  );
+
+  // Clean up for subsequent tests.
+  gURLBar.handleRevert();
+});
+
+function snapshotHistograms() {
+  Services.telemetry.clearScalars();
+  Services.telemetry.clearEvents();
+  return {
+    resultMethodHist: TelemetryTestUtils.getAndClearHistogram(
+      "FX_URLBAR_SELECTED_RESULT_METHOD"
+    ),
+  };
+}
+
+function assertTelemetryResults(histograms, type, index, method) {
+  TelemetryTestUtils.assertHistogram(histograms.resultMethodHist, method, 1);
+
+  TelemetryTestUtils.assertKeyedScalar(
+    TelemetryTestUtils.getProcessScalars("parent", true, true),
+    `urlbar.picked.${type}`,
+    index,
+    1
+  );
+}
-- 
cgit v1.2.3