Bug 1877295 - Toolbar button option for returning to about:welcome r=pdahiya,fluent-reviewers,Gijs,desktop-theme-reviewers,omc-reviewers,bolsson

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

Author: AllegroFox

browser/base/content/browser.xhtml

@@ -99,6 +99,7 @@
   <link rel="localization" href="browser/shopping.ftl"/>
   <link rel="localization" href="preview/shopping.ftl"/>
   <link rel="localization" href="preview/profiles.ftl"/>
+  <link rel="localization" href="preview/onboarding.ftl"/>
 
   <title data-l10n-id="browser-main-window-title"></title>
 

browser/components/BrowserGlue.sys.mjs

@@ -9,6 +9,7 @@ const lazy = {};
 
 ChromeUtils.defineESModuleGetters(lazy, {
   AboutNewTab: "resource:///modules/AboutNewTab.sys.mjs",
+  AWToolbarButton: "resource:///modules/aboutwelcome/AWToolbarUtils.sys.mjs",
   ASRouter: "resource:///modules/asrouter/ASRouter.sys.mjs",
   ASRouterDefaultConfig:
     "resource:///modules/asrouter/ASRouterDefaultConfig.sys.mjs",
@@ -2951,6 +2952,20 @@ BrowserGlue.prototype = {
         },
       },
 
+      // Add the setup button if this is the first startup
+      {
+        name: "AWToolbarButton.SetupButton",
+        task: async () => {
+          if (
+            lazy.AWToolbarButton.hasToolbarButtonEnabled &&
+            // Not in automation: the button changes CUI state, breaking tests
+            !Cu.isInAutomation
+          ) {
+            await lazy.AWToolbarButton.maybeAddSetupButton();
+          }
+        },
+      },
+
       {
         name: "ASRouterNewTabHook.createInstance",
         task: () => {

browser/components/aboutwelcome/actors/AboutWelcomeChild.sys.mjs

@@ -20,6 +20,15 @@ ChromeUtils.defineLazyGetter(lazy, "log", () => {
   return new Logger("AboutWelcomeChild");
 });
 
+const DID_SEE_FINAL_SCREEN_PREF = "browser.aboutwelcome.didSeeFinalScreen";
+
+XPCOMUtils.defineLazyPreferenceGetter(
+  lazy,
+  "toolbarEntrypoint",
+  "browser.aboutwelcome.entrypoint",
+  ""
+);
+
 export class AboutWelcomeChild extends JSWindowActorChild {
   // Can be used to avoid accesses to the document/contentWindow after it's
   // destroyed, which may throw unhandled exceptions.
@@ -233,6 +242,9 @@ export class AboutWelcomeChild extends JSWindowActorChild {
    * @param {object} eventData
    */
   AWSendEventTelemetry(eventData) {
+    if (lazy.toolbarEntrypoint) {
+      eventData.event_context.entrypoint = lazy.toolbarEntrypoint;
+    }
     this.AWSendToParent("TELEMETRY_EVENT", {
       ...eventData,
       event_context: {
@@ -256,10 +268,24 @@ export class AboutWelcomeChild extends JSWindowActorChild {
     return this.wrapPromise(this.sendQuery("AWPage:WAIT_FOR_MIGRATION_CLOSE"));
   }
 
+  setDidSeeFinalScreen() {
+    this.AWSendToParent("SPECIAL_ACTION", {
+      type: "SET_PREF",
+      data: {
+        pref: {
+          name: DID_SEE_FINAL_SCREEN_PREF,
+          value: true,
+        },
+      },
+    });
+  }
+
   AWFinish() {
     const shouldFocusNewtabUrlBar =
       lazy.NimbusFeatures.aboutwelcome.getVariable("newtabUrlBarFocus");
 
+    this.setDidSeeFinalScreen();
+
     this.contentWindow.location.href = "about:home";
     if (shouldFocusNewtabUrlBar) {
       this.AWSendToParent("SPECIAL_ACTION", {

browser/components/aboutwelcome/actors/AboutWelcomeParent.sys.mjs

@@ -85,6 +85,8 @@ class AboutWelcomeObserver {
 
   stop() {
     lazy.log.debug(`Terminate reason is ${this.terminateReason}`);
+    // Clear the entrypoint pref
+    Services.prefs.clearUserPref("browser.aboutwelcome.entrypoint");
     Services.obs.removeObserver(this, "quit-application");
     if (!this.win) {
       return;

browser/components/aboutwelcome/content/onboarding.ftl

@@ -19,3 +19,8 @@ amo-picker-subtitle = Extensions are like apps for your browser, and they let yo
 amo-picker-install-button-label = Add to { -brand-short-name }
 amo-picker-install-complete-label = Installed
 amo-picker-collection-link = Explore more add-ons
+
+# Button label for the experimental return to about:welcome toolbar button
+browser-aboutwelcome-button =
+    .label = Finish setup
+    .tooltiptext = Finish setting up { -brand-short-name }.

browser/components/aboutwelcome/modules/AWToolbarUtils.sys.mjs

@@ -0,0 +1,79 @@
+/* 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/. */
+
+import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
+
+const lazy = {};
+
+ChromeUtils.defineESModuleGetters(lazy, {
+  CustomizableUI: "resource:///modules/CustomizableUI.sys.mjs",
+});
+
+export const AWToolbarButton = {
+  async maybeAddSetupButton() {
+    // First check if we've already completed onboarding, in which
+    // case we should remove the button.
+    if (AWToolbarButton.didSeeFinalScreen) {
+      AWToolbarButton.removeSetupButtonIfOnboardingComplete();
+      return;
+    }
+    // Otherwise, check if this is a new profile where we need to add it.
+    if (AWToolbarButton.hasToolbarButtonEnabled) {
+      lazy.CustomizableUI.createWidget({
+        id: "aboutwelcome-button",
+        l10nId: "browser-aboutwelcome-button",
+        defaultArea: lazy.CustomizableUI.AREA_BOOKMARKS,
+        type: "button",
+        onCreated(aNode) {
+          aNode.className = "bookmark-item chromeclass-toolbar-additional";
+        },
+        onClick(aEvent) {
+          AWToolbarButton.openWelcome(aEvent.view);
+        },
+      });
+    }
+  },
+
+  removeSetupButtonIfOnboardingComplete() {
+    //Look for completion of Onboarding (we're using an AWFinish()
+    //call from about:welcome as a proxy here)
+    if (
+      AWToolbarButton.didSeeFinalScreen ||
+      !AWToolbarButton.hasToolbarButtonEnabled
+    ) {
+      lazy.CustomizableUI.destroyWidget("aboutwelcome-button");
+    }
+  },
+
+  openWelcome(win) {
+    Services.prefs.setStringPref(
+      "browser.aboutwelcome.entrypoint",
+      "toolbarButton"
+    );
+    let viewURL = "about:welcome";
+    win.gBrowser.addTrustedTab(viewURL, {
+      inBackground: false,
+    });
+  },
+};
+
+XPCOMUtils.defineLazyPreferenceGetter(
+  AWToolbarButton,
+  "didSeeFinalScreen",
+  "browser.aboutwelcome.didSeeFinalScreen",
+  false,
+  () => {
+    AWToolbarButton.removeSetupButtonIfOnboardingComplete();
+  }
+);
+
+XPCOMUtils.defineLazyPreferenceGetter(
+  AWToolbarButton,
+  "hasToolbarButtonEnabled",
+  "browser.aboutwelcome.toolbarButtonEnabled",
+  false,
+  () => {
+    AWToolbarButton.removeSetupButtonIfOnboardingComplete();
+  }
+);

browser/components/aboutwelcome/moz.build

@@ -22,6 +22,7 @@ EXTRA_JS_MODULES.aboutwelcome += [
     "modules/AboutWelcomeDefaults.sys.mjs",
     "modules/AboutWelcomeTelemetry.sys.mjs",
     "modules/AWScreenUtils.sys.mjs",
+    "modules/AWToolbarUtils.sys.mjs",
 ]
 
 XPCSHELL_TESTS_MANIFESTS += [

browser/components/aboutwelcome/tests/browser/browser.toml

@@ -37,6 +37,9 @@ skip-if = ["os == 'linux' && bits == 64"] # Bug 1757875
 ["browser_aboutwelcome_multistage_mr.js"]
 skip-if = ["os == 'linux' && bits == 64 && debug"] # Bug 1812050
 
+["browser_aboutwelcome_multistage_transitions.js"]
+skip-if = ["debug"] # Bug 1875203
+
 ["browser_aboutwelcome_multistage_video.js"]
 
 ["browser_aboutwelcome_observer.js"]
@@ -50,11 +53,10 @@ skip-if = [
 
 ["browser_aboutwelcome_screen_targeting.js"]
 
+["browser_aboutwelcome_toolbar_button.js"]
+
 ["browser_aboutwelcome_upgrade_multistage_mr.js"]
 skip-if = [
   "win11_2009 && debug",
   "os == 'linux' && debug", # Bug 1804804 - disabled on win && linux for extremely high failure rate
 ]
-
-["browser_aboutwelcome_multistage_transitions.js"]
-skip-if = ["debug"] # Bug 1875203

browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_toolbar_button.js

@@ -0,0 +1,64 @@
+"use strict";
+
+const { AboutWelcomeTelemetry } = ChromeUtils.importESModule(
+  "resource:///modules/aboutwelcome/AboutWelcomeTelemetry.sys.mjs"
+);
+const { AWToolbarButton } = ChromeUtils.importESModule(
+  "resource:///modules/aboutwelcome/AWToolbarUtils.sys.mjs"
+);
+
+const TOOLBAR_PREF = "browser.aboutwelcome.toolbarButtonEnabled";
+const DID_SEE_FINAL_SCREEN_PREF = "browser.aboutwelcome.didSeeFinalScreen";
+
+async function openNewTab() {
+  let tab = await BrowserTestUtils.openNewForegroundTab(
+    gBrowser,
+    "about:newtab",
+    false
+  );
+
+  registerCleanupFunction(async () => {
+    BrowserTestUtils.removeTab(tab);
+    await SpecialPowers.popPrefEnv();
+  });
+
+  return tab.linkedBrowser;
+}
+
+add_task(async function test_add_and_remove_toolbar_button() {
+  // Clear the final screen pref, which may have been set by other tests
+  await SpecialPowers.pushPrefEnv({
+    set: [[DID_SEE_FINAL_SCREEN_PREF, false]],
+  });
+  // Open newtab
+  let win = await BrowserTestUtils.openNewBrowserWindow();
+  win.BrowserOpenTab();
+  ok(win, "browser exists");
+  // Try to add the button. It shouldn't add because the pref is false
+  await AWToolbarButton.maybeAddSetupButton();
+  ok(
+    !win.document.getElementById("aboutwelcome-button"),
+    "Button should not exist"
+  );
+  // Set the pref and try again
+  await SpecialPowers.pushPrefEnv({
+    set: [[TOOLBAR_PREF, true]],
+  });
+  await AWToolbarButton.maybeAddSetupButton();
+  // The button should exist
+  ok(
+    win.document.getElementById("aboutwelcome-button"),
+    "Button should be added."
+  );
+  // Switch the pref to false and check again
+  await SpecialPowers.pushPrefEnv({
+    set: [[TOOLBAR_PREF, false]],
+  });
+  ok(
+    !win.document.getElementById("aboutwelcome-button"),
+    "Button should be removed"
+  );
+  // Cleanup
+  await SpecialPowers.popPrefEnv();
+  await BrowserTestUtils.closeWindow(win);
+});