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_entrypoint_telemetry.js  | 105 +++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 browser/components/migration/tests/browser/browser_entrypoint_telemetry.js

(limited to 'browser/components/migration/tests/browser/browser_entrypoint_telemetry.js')

diff --git a/browser/components/migration/tests/browser/browser_entrypoint_telemetry.js b/browser/components/migration/tests/browser/browser_entrypoint_telemetry.js
new file mode 100644
index 0000000000..bdeca0fdb5
--- /dev/null
+++ b/browser/components/migration/tests/browser/browser_entrypoint_telemetry.js
@@ -0,0 +1,105 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+ChromeUtils.defineESModuleGetters(this, {
+  TelemetryTestUtils: "resource://testing-common/TelemetryTestUtils.sys.mjs",
+});
+const CONTENT_MODAL_ENABLED_PREF = "browser.migrate.content-modal.enabled";
+const HISTOGRAM_ID = "FX_MIGRATION_ENTRY_POINT_CATEGORICAL";
+const LEGACY_HISTOGRAM_ID = "FX_MIGRATION_ENTRY_POINT";
+
+async function showThenCloseMigrationWizardViaEntrypoint(entrypoint) {
+  let openedPromise = BrowserTestUtils.waitForMigrationWizard(window);
+
+  // On some platforms, this call blocks, so in order to let the test proceed, we
+  // run it on the next tick of the event loop.
+  executeSoon(() => {
+    MigrationUtils.showMigrationWizard(window, {
+      entrypoint,
+    });
+  });
+
+  let wizard = await openedPromise;
+  Assert.ok(wizard, "Migration wizard opened.");
+  await BrowserTestUtils.closeMigrationWizard(wizard);
+}
+
+add_setup(async () => {
+  // Load the initial tab at example.com. This makes it so that if
+  // we're using the new migration wizard, we'll load the about:preferences
+  // page in a new tab rather than overtaking the initial one. This
+  // makes it easier to be consistent with closing and opening
+  // behaviours between the two kinds of migration wizards.
+  let browser = gBrowser.selectedBrowser;
+  BrowserTestUtils.loadURIString(browser, "https://example.com");
+  await BrowserTestUtils.browserLoaded(browser);
+});
+
+/**
+ * Tests that the entrypoint passed to MigrationUtils.showMigrationWizard gets
+ * written to both the FX_MIGRATION_ENTRY_POINT_CATEGORICAL histogram, as well
+ * as the legacy FX_MIGRATION_ENTRY_POINT histogram (but only if using the old
+ * wizard window).
+ */
+add_task(async function test_legacy_wizard() {
+  for (let contentModalEnabled of [true, false]) {
+    info("Testing with content modal enabled: " + contentModalEnabled);
+    await SpecialPowers.pushPrefEnv({
+      set: [[CONTENT_MODAL_ENABLED_PREF, contentModalEnabled]],
+    });
+
+    let histogram = TelemetryTestUtils.getAndClearHistogram(HISTOGRAM_ID);
+    let legacyHistogram =
+      TelemetryTestUtils.getAndClearHistogram(LEGACY_HISTOGRAM_ID);
+
+    // Let's arbitrarily pick the "Bookmarks" entrypoint, and make sure this
+    // is recorded.
+    await showThenCloseMigrationWizardViaEntrypoint(
+      MigrationUtils.MIGRATION_ENTRYPOINTS.BOOKMARKS
+    );
+    let entrypointId = MigrationUtils.getLegacyMigrationEntrypoint(
+      MigrationUtils.MIGRATION_ENTRYPOINTS.BOOKMARKS
+    );
+
+    TelemetryTestUtils.assertHistogram(histogram, entrypointId, 1);
+
+    if (!contentModalEnabled) {
+      TelemetryTestUtils.assertHistogram(legacyHistogram, entrypointId, 1);
+    }
+
+    histogram = TelemetryTestUtils.getAndClearHistogram(HISTOGRAM_ID);
+    legacyHistogram =
+      TelemetryTestUtils.getAndClearHistogram(LEGACY_HISTOGRAM_ID);
+
+    // Now let's pick the "Preferences" entrypoint, and make sure this
+    // is recorded.
+    await showThenCloseMigrationWizardViaEntrypoint(
+      MigrationUtils.MIGRATION_ENTRYPOINTS.PREFERENCES
+    );
+    entrypointId = MigrationUtils.getLegacyMigrationEntrypoint(
+      MigrationUtils.MIGRATION_ENTRYPOINTS.PREFERENCES
+    );
+
+    TelemetryTestUtils.assertHistogram(histogram, entrypointId, 1);
+    if (!contentModalEnabled) {
+      TelemetryTestUtils.assertHistogram(legacyHistogram, entrypointId, 1);
+    }
+
+    histogram = TelemetryTestUtils.getAndClearHistogram(HISTOGRAM_ID);
+    legacyHistogram =
+      TelemetryTestUtils.getAndClearHistogram(LEGACY_HISTOGRAM_ID);
+
+    // Finally, check the fallback by passing in something invalid as an entrypoint.
+    await showThenCloseMigrationWizardViaEntrypoint(undefined);
+    entrypointId = MigrationUtils.getLegacyMigrationEntrypoint(
+      MigrationUtils.MIGRATION_ENTRYPOINTS.UNKNOWN
+    );
+
+    TelemetryTestUtils.assertHistogram(histogram, entrypointId, 1);
+    if (!contentModalEnabled) {
+      TelemetryTestUtils.assertHistogram(legacyHistogram, entrypointId, 1);
+    }
+  }
+});
-- 
cgit v1.2.3