Bug 2065138 - Honor checkDefaultBrowser pref for campaign set default actions r=omc-reviewers,mviar

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

Author: mkaply

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

@@ -45,6 +45,8 @@ ChromeUtils.defineLazyGetter(
 const DID_SEE_ABOUT_WELCOME_PREF = "trailhead.firstrun.didSeeAboutWelcome";
 const DID_HANDLE_CAMAPAIGN_ACTION_PREF =
   "trailhead.firstrun.didHandleCampaignAction";
+const CHECK_DEFAULT_BROWSER_PREF = "browser.shell.checkDefaultBrowser";
+const SET_DEFAULT_CAMPAIGN_ACTIONS = ["SET_DEFAULT_BROWSER", "PIN_AND_DEFAULT"];
 const EXPERIMENTS_GATE_PREF = "browser.aboutwelcome.experimentsGate.enabled";
 const EXPERIMENTS_GATE_MAX_MS_PREF =
   "browser.aboutwelcome.experimentsGate.maxDisplayMs";
@@ -382,6 +384,12 @@ export class AboutWelcomeParent extends JSWindowActorParent {
         if (
           !Services.prefs.getBoolPref(DID_HANDLE_CAMAPAIGN_ACTION_PREF, false)
         ) {
+          if (
+            SET_DEFAULT_CAMPAIGN_ACTIONS.includes(data) &&
+            !Services.prefs.getBoolPref(CHECK_DEFAULT_BROWSER_PREF, true)
+          ) {
+            break;
+          }
           lazy.SpecialMessageActions.handleAction({ type: data }, browser);
           try {
             Services.prefs.setBoolPref(DID_HANDLE_CAMAPAIGN_ACTION_PREF, true);

browser/components/aboutwelcome/tests/browser/browser_aboutwelcome_campaign_actions.js

@@ -43,7 +43,10 @@ add_task(async function test_unhandled_campaign_action() {
   const TEST_PROTON_JSON = JSON.stringify(TEST_PROTON_CONTENT);
 
   await setAboutWelcomePref(true);
-  await pushPrefs(["browser.aboutwelcome.screens", TEST_PROTON_JSON]);
+  await pushPrefs(
+    ["browser.aboutwelcome.screens", TEST_PROTON_JSON],
+    ["browser.shell.checkDefaultBrowser", true]
+  );
 
   AttributionCode._clearCache();
   const data = await AttributionCode.getAttrDataAsync();
@@ -90,7 +93,50 @@ add_task(async function test_unhandled_campaign_action() {
     await ASRouter.forceAttribution("");
     Services.prefs.clearUserPref(DID_HANDLE_CAMAPAIGN_ACTION_PREF);
     Services.prefs.clearUserPref("browser.aboutwelcome.screens");
-
-    sandbox.restore();
   });
+
+  sandbox.restore();
+});
+
+add_task(async function test_campaign_action_honors_default_browser_pref() {
+  const sandbox = sinon.createSandbox();
+  const handleActionStub = sandbox
+    .stub(SpecialMessageActions, "handleAction")
+    .resolves();
+
+  Services.prefs.clearUserPref(DID_HANDLE_CAMAPAIGN_ACTION_PREF);
+  await AttributionCode.deleteFileAsync();
+  await ASRouter.forceAttribution(TEST_ATTRIBUTION_DATA);
+
+  await setAboutWelcomePref(true);
+  await pushPrefs(
+    ["browser.aboutwelcome.screens", JSON.stringify(TEST_PROTON_CONTENT)],
+    ["browser.shell.checkDefaultBrowser", false]
+  );
+
+  AttributionCode._clearCache();
+  const data = await AttributionCode.getAttrDataAsync();
+
+  Assert.equal(
+    data.campaign,
+    "set_default_browser",
+    "Attribution campaign should be set"
+  );
+
+  let tab = await BrowserTestUtils.openNewForegroundTab(
+    gBrowser,
+    "about:welcome",
+    true
+  );
+
+  sinon.assert.notCalled(handleActionStub);
+
+  Assert.equal(
+    Services.prefs.getBoolPref(DID_HANDLE_CAMAPAIGN_ACTION_PREF, false),
+    false,
+    "Campaign action is left unhandled so it can run if the pref is restored"
+  );
+
+  BrowserTestUtils.removeTab(tab);
+  sandbox.restore();
 });