Bug 2053447: Part 2 - Port the existing LaunchOnLogin code.r=hsohaney

Port the WindowsDefaultLaunchOnLogin to use the new generic LaunchOnLogin interface

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

Author: iain-mozilla

browser/app/profile/firefox.js

@@ -351,8 +351,14 @@ pref("browser.startup.couldRestoreSession.count", 0);
 // users as it is not implemented anywhere else.
 #if defined(XP_WIN)
 pref("browser.startup.preXulSkeletonUI", true);
+#endif
+
+// These are called browser.startup.windowsLaunchOnLogin.* because they originated
+// on Windows, but they now operate on macOS as well.
+// They can't be changed until there are no experiments running that are using the
+// old name - https://bugzilla.mozilla.org/show_bug.cgi?id=2059749
 
-// Whether the checkbox to enable Windows launch on login is shown
+// Whether the checkbox to enable Launch on login is shown
 pref("browser.startup.windowsLaunchOnLogin.enabled", true);
 // Whether to show the launch on login infobar notification
 pref("browser.startup.windowsLaunchOnLogin.disableLaunchOnLoginPrompt", false);
@@ -363,7 +369,6 @@ pref("browser.startup.windowsLaunchOnLogin.disableLaunchOnLoginPrompt", false);
 // direction.
 pref("browser.startup.windowsLaunchOnLogin.defaultEnabled", false);
 pref("browser.startup.windowsLaunchOnLogin.alreadyApplied", false);
-#endif
 
 // Show an upgrade dialog on major upgrades.
 pref("browser.startup.upgradeDialog.enabled", false);

browser/components/BrowserComponents.manifest

@@ -186,9 +186,9 @@ category browser-idle-startup resource:///modules/UpdatePolicyEnforcer.sys.mjs U
 #endif
 #ifdef XP_WIN
 category browser-idle-startup resource:///modules/WindowsJumpLists.sys.mjs WinTaskbarJumpList.startup
-category browser-idle-startup resource:///modules/DefaultWindowsLaunchOnLogin.sys.mjs DefaultWindowsLaunchOnLogin.maybeEnableOnFirstRun
 #endif
 #if defined(XP_WIN) || defined(XP_MACOSX)
+category browser-idle-startup resource:///modules/DefaultLaunchOnLogin.sys.mjs DefaultLaunchOnLogin.maybeEnableOnFirstRun
 category browser-idle-startup moz-src:///browser/components/shell/StartupOSIntegration.sys.mjs StartupOSIntegration.onStartupIdle
 #endif
 

…ogin/DefaultWindowsLaunchOnLogin.sys.mjs …unchonlogin/DefaultLaunchOnLogin.sys.mjsbrowser/components/defaultwindowslaunchonlogin/DefaultWindowsLaunchOnLogin.sys.mjs renamed to browser/components/defaultlaunchonlogin/DefaultLaunchOnLogin.sys.mjs browser/components/defaultwindowslaunchonlogin/DefaultWindowsLaunchOnLogin.sys.mjs renamed to browser/components/defaultlaunchonlogin/DefaultLaunchOnLogin.sys.mjs

@@ -4,25 +4,27 @@
 
 import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
 
-export const DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID =
+// These IDs and preferences contain Windows in their name as legacy
+// and changing them to be OS agnostic would break existing installs.
+export const DEFAULT_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID =
   "defaultWindowsLaunchOnLogin";
 
-export const DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF =
+export const DEFAULT_LAUNCH_ON_LOGIN_PREF =
   "browser.startup.windowsLaunchOnLogin.defaultEnabled";
-export const DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF =
+export const DEFAULT_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF =
   "browser.startup.windowsLaunchOnLogin.alreadyApplied";
 
 const lazy = XPCOMUtils.declareLazy({
   AppConstants: "resource://gre/modules/AppConstants.sys.mjs",
   ExperimentAPI: "resource://nimbus/ExperimentAPI.sys.mjs",
-  WindowsLaunchOnLogin: "resource://gre/modules/WindowsLaunchOnLogin.sys.mjs",
+  LaunchOnLogin: "resource://gre/modules/LaunchOnLogin.sys.mjs",
   profileService: {
     service: "@mozilla.org/toolkit/profile-service;1",
     iid: Ci.nsIToolkitProfileService,
   },
 });
 
-export var DefaultWindowsLaunchOnLogin = {
+export var DefaultLaunchOnLogin = {
   /**
    * `browser-idle-startup` category entry point.
    *
@@ -44,7 +46,7 @@ export var DefaultWindowsLaunchOnLogin = {
     let isFirstRun = lazy.profileService.isFirstRun;
     let isOfficialBuild = lazy.AppConstants.MOZILLA_OFFICIAL;
     let alreadyApplied = Services.prefs.getBoolPref(
-      DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF,
+      DEFAULT_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF,
       false
     );
 
@@ -55,6 +57,7 @@ export var DefaultWindowsLaunchOnLogin = {
     ) {
       isFirstRun = true;
       isOfficialBuild = true;
+      alreadyApplied = false;
     }
 
     await this.enableOnFirstRunIfNeeded(
@@ -79,7 +82,7 @@ export var DefaultWindowsLaunchOnLogin = {
    */
   async enableOnFirstRunIfNeeded(isFirstRun, isOfficialBuild, alreadyApplied) {
     if (
-      lazy.AppConstants.platform !== "win" ||
+      !lazy.LaunchOnLogin.isSupported() ||
       !isOfficialBuild ||
       !isFirstRun ||
       alreadyApplied
@@ -91,23 +94,21 @@ export var DefaultWindowsLaunchOnLogin = {
     // applied its value before we read the pref below.
     await this.waitForNimbusReady();
 
-    if (
-      !Services.prefs.getBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, false)
-    ) {
+    if (!Services.prefs.getBoolPref(DEFAULT_LAUNCH_ON_LOGIN_PREF, false)) {
       return;
     }
 
     // Mark the launch on login as applied so we don't do it again
     Services.prefs.setBoolPref(
-      DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF,
+      DEFAULT_LAUNCH_ON_LOGIN_ALREADY_APPLIED_PREF,
       true
     );
 
-    if (!(await lazy.WindowsLaunchOnLogin.getLaunchOnLoginApproved())) {
+    if (!(await lazy.LaunchOnLogin.isAllowed())) {
       return;
     }
 
-    await lazy.WindowsLaunchOnLogin.createLaunchOnLogin();
+    await lazy.LaunchOnLogin.enable();
   },
 
   /**

…ts/defaultwindowslaunchonlogin/moz.build …omponents/defaultlaunchonlogin/moz.buildbrowser/components/defaultwindowslaunchonlogin/moz.build renamed to browser/components/defaultlaunchonlogin/moz.build browser/components/defaultwindowslaunchonlogin/moz.build renamed to browser/components/defaultlaunchonlogin/moz.build

@@ -6,7 +6,7 @@ with Files("**"):
     BUG_COMPONENT = ("Firefox", "Shell Integration")
 
 EXTRA_JS_MODULES += [
-    "DefaultWindowsLaunchOnLogin.sys.mjs",
+    "DefaultLaunchOnLogin.sys.mjs",
 ]
 
 XPCSHELL_TESTS_MANIFESTS += ["tests/xpcshell.toml"]

…ests/test_DefaultWindowsLaunchOnLogin.js …login/tests/test_DefaultLaunchOnLogin.jsbrowser/components/defaultwindowslaunchonlogin/tests/test_DefaultWindowsLaunchOnLogin.js renamed to browser/components/defaultlaunchonlogin/tests/test_DefaultLaunchOnLogin.js browser/components/defaultwindowslaunchonlogin/tests/test_DefaultWindowsLaunchOnLogin.js renamed to browser/components/defaultlaunchonlogin/tests/test_DefaultLaunchOnLogin.js

@@ -11,27 +11,24 @@ const { AppConstants } = ChromeUtils.importESModule(
   "resource://gre/modules/AppConstants.sys.mjs"
 );
 const {
-  DefaultWindowsLaunchOnLogin,
-  DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
-  DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF,
+  DefaultLaunchOnLogin,
+  DEFAULT_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
+  DEFAULT_LAUNCH_ON_LOGIN_PREF,
 } = ChromeUtils.importESModule(
-  "resource:///modules/DefaultWindowsLaunchOnLogin.sys.mjs"
+  "resource:///modules/DefaultLaunchOnLogin.sys.mjs"
 );
-const { WindowsLaunchOnLogin } = ChromeUtils.importESModule(
-  "resource://gre/modules/WindowsLaunchOnLogin.sys.mjs"
+const { LaunchOnLogin } = ChromeUtils.importESModule(
+  "resource://gre/modules/LaunchOnLogin.sys.mjs"
 );
 const { NimbusTestUtils } = ChromeUtils.importESModule(
   "resource://testing-common/NimbusTestUtils.sys.mjs"
 );
 const { updateAppInfo } = ChromeUtils.importESModule(
   "resource://testing-common/AppInfo.sys.mjs"
 );
-const { MockRegistry } = ChromeUtils.importESModule(
-  "resource://testing-common/MockRegistry.sys.mjs"
-);
 
 const CATEGORY_NAME = "browser-idle-startup";
-const MODULE_URI = "resource:///modules/DefaultWindowsLaunchOnLogin.sys.mjs";
+const MODULE_URI = "resource:///modules/DefaultLaunchOnLogin.sys.mjs";
 
 NimbusTestUtils.init(this);
 
@@ -40,22 +37,6 @@ add_setup(async () => {
   // FOG needs a profile
   do_get_profile();
 
-  registry = new MockRegistry();
-
-  // It's expected that these keys exist
-  registry.setValue(
-    Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER,
-    "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run",
-    "",
-    ""
-  );
-  registry.setValue(
-    Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER,
-    "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\StartupApproved\\Run",
-    "",
-    ""
-  );
-
   Services.fog.initializeFOG();
   Services.fog.testResetFOG();
   updateAppInfo();
@@ -64,12 +45,11 @@ add_setup(async () => {
 
   registerCleanupFunction(() => {
     nimbusTestCleanup();
-    registry.shutdown();
   });
 });
 
 // Runs enableOnFirstRunIfNeeded with the Nimbus wait stubbed out and the
-// WindowsLaunchOnLogin side effects stubbed. Sets the defaultEnabled pref to
+// LaunchOnLogin side effects stubbed. Sets the defaultEnabled pref to
 // prefValue -- in production Nimbus writes that pref via setPref, so driving the
 // pref directly exercises the module's decision logic; the Nimbus -> pref
 // linkage is covered separately by test_nimbus_enrollment_sets_pref.
@@ -81,62 +61,60 @@ async function runWith(
   prefValue
 ) {
   let sandbox = sinon.createSandbox();
-  sandbox.stub(DefaultWindowsLaunchOnLogin, "waitForNimbusReady").resolves();
+  sandbox.stub(DefaultLaunchOnLogin, "waitForNimbusReady").resolves();
   let approvedStub = sandbox
-    .stub(WindowsLaunchOnLogin, "getLaunchOnLoginApproved")
+    .stub(LaunchOnLogin, "isAllowed")
     .resolves(approved);
-  let createStub = sandbox
-    .stub(WindowsLaunchOnLogin, "createLaunchOnLogin")
-    .resolves();
+  let createStub = sandbox.stub(LaunchOnLogin, "enable").resolves();
 
-  Services.prefs.setBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, prefValue);
+  Services.prefs.setBoolPref(DEFAULT_LAUNCH_ON_LOGIN_PREF, prefValue);
 
   try {
-    await DefaultWindowsLaunchOnLogin.enableOnFirstRunIfNeeded(
+    await DefaultLaunchOnLogin.enableOnFirstRunIfNeeded(
       isFirstRun,
       isOfficialBuild,
       alreadyApplied
     );
     return { approvedStub, createStub };
   } finally {
     sandbox.restore();
-    Services.prefs.clearUserPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF);
+    Services.prefs.clearUserPref(DEFAULT_LAUNCH_ON_LOGIN_PREF);
   }
 }
 
 add_task(async function test_is_registered_in_idle_startup() {
   const entry = Services.catMan.getCategoryEntry(CATEGORY_NAME, MODULE_URI);
   Assert.equal(
     entry,
-    "DefaultWindowsLaunchOnLogin.maybeEnableOnFirstRun",
+    "DefaultLaunchOnLogin.maybeEnableOnFirstRun",
     "Entry should point to `maybeEnableOnFirstRun` in `browser-idle-startup`"
   );
 });
 
 add_task(
   {
     skip_if: () =>
-      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
+      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "linux",
   },
   async function test_disabled_when_pref_off() {
     let { createStub } = await runWith(true, true, true, false, false);
     Assert.ok(
       !createStub.called,
-      "createLaunchOnLogin should not be called when the pref is off"
+      "LaunchOnLogin.enable should not be called when the pref is off"
     );
   }
 );
 
 add_task(
   {
     skip_if: () =>
-      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
+      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "linux",
   },
   async function test_enabled_when_pref_on() {
     let { createStub } = await runWith(true, true, true, false, true);
     Assert.ok(
       createStub.calledOnce,
-      "createLaunchOnLogin should be called when the pref is on"
+      "LaunchOnLogin.enable should be called when the pref is on"
     );
   }
 );
@@ -146,31 +124,31 @@ add_task(
 add_task(
   {
     skip_if: () =>
-      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
+      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "linux",
   },
   async function test_nimbus_enrollment_sets_pref() {
     let cleanup = await NimbusTestUtils.enrollWithFeatureConfig(
       {
-        featureId: DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
+        featureId: DEFAULT_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
         value: { enabled: true },
       },
       { isRollout: true }
     );
     Assert.ok(
-      Services.prefs.getBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, false),
+      Services.prefs.getBoolPref(DEFAULT_LAUNCH_ON_LOGIN_PREF, false),
       "enrolling with enabled:true sets the defaultEnabled pref to true"
     );
     await cleanup();
 
     cleanup = await NimbusTestUtils.enrollWithFeatureConfig(
       {
-        featureId: DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
+        featureId: DEFAULT_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
         value: { enabled: false },
       },
       { isRollout: true }
     );
     Assert.ok(
-      !Services.prefs.getBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, true),
+      !Services.prefs.getBoolPref(DEFAULT_LAUNCH_ON_LOGIN_PREF, true),
       "enrolling with enabled:false sets the defaultEnabled pref to false"
     );
     await cleanup();
@@ -181,22 +159,22 @@ add_task(async function test_skips_when_not_first_run() {
   let { createStub } = await runWith(false, true, true, false, true);
   Assert.ok(
     !createStub.called,
-    "createLaunchOnLogin should not be called when isFirstRun is false"
+    "LaunchOnLogin.enable should not be called when isFirstRun is false"
   );
 });
 
 add_task(async function test_skips_on_unofficial_build() {
   let { createStub } = await runWith(true, false, true, false, true);
   Assert.ok(
     !createStub.called,
-    "createLaunchOnLogin should not be called on developer builds"
+    "LaunchOnLogin.enable should not be called on developer builds"
   );
 });
 
 add_task(
   {
     skip_if: () =>
-      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
+      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "linux",
   },
   async function test_skips_when_windows_policy_denies() {
     let { createStub, approvedStub } = await runWith(
@@ -212,15 +190,15 @@ add_task(
     );
     Assert.ok(
       !createStub.called,
-      "createLaunchOnLogin should not be called when Windows policy denies"
+      "LaunchOnLogin should not be called when Windows policy denies"
     );
   }
 );
 
 add_task(
   {
     skip_if: () =>
-      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
+      !AppConstants.MOZ_NORMANDY || AppConstants.platform !== "linux",
   },
   async function test_skips_when_already_applied() {
     let { createStub, approvedStub } = await runWith(
@@ -237,7 +215,7 @@ add_task(
 
     Assert.ok(
       !createStub.called,
-      "createLaunchOnLogin should not be called when already applied is true"
+      "LaunchOnLogin.enable should not be called when already applied is true"
     );
   }
 );

browser/components/defaultlaunchonlogin/tests/xpcshell.toml

@@ -0,0 +1,9 @@
+[DEFAULT]
+skip-if = [
+  "os == 'linux' && os_version == '22.04' && arch == 'x86_64' && display == 'wayland'",
+  "os == 'linux' && os_version == '24.04' && arch == 'x86_64' && display == 'x11'",
+]
+
+firefox-appdir = "browser"
+
+["test_DefaultLaunchOnLogin.js"]

browser/components/defaultwindowslaunchonlogin/tests/xpcshell.toml

@@ -88,10 +88,10 @@ if CONFIG["MOZ_SELECTABLE_PROFILES"]:
     DIRS += ["profiles"]
 
 if CONFIG["MOZ_WIDGET_TOOLKIT"] == "cocoa":
-    DIRS += ["touchbar"]
+    DIRS += ["defaultlaunchonlogin", "touchbar"]
 elif CONFIG["MOZ_WIDGET_TOOLKIT"] == "windows":
     DIRS += [
-        "defaultwindowslaunchonlogin",
+        "defaultlaunchonlogin",
         "installerprefs",
     ]