tor-browser

browser_setDefaultBrowser.js (6562B)

---

/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */

ChromeUtils.defineESModuleGetters(this, {
 ASRouter: "resource:///modules/asrouter/ASRouter.sys.mjs",
 ExperimentAPI: "resource://nimbus/ExperimentAPI.sys.mjs",
 NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
 NimbusTestUtils: "resource://testing-common/NimbusTestUtils.sys.mjs",
 sinon: "resource://testing-common/Sinon.sys.mjs",
});

const setDefaultBrowserUserChoiceStub = async () => {
 throw Components.Exception("", Cr.NS_ERROR_WDBA_NO_PROGID);
};

const defaultAgentStub = sinon
 .stub(ShellService, "defaultAgent")
 .value({ setDefaultBrowserUserChoiceAsync: setDefaultBrowserUserChoiceStub });

const _userChoiceImpossibleTelemetryResultStub = sinon
 .stub(ShellService, "_userChoiceImpossibleTelemetryResult")
 .callsFake(() => null);

const userChoiceStub = sinon
 .stub(ShellService, "setAsDefaultUserChoice")
 .resolves();
const setDefaultStub = sinon.stub();
const shellStub = sinon
 .stub(ShellService, "shellService")
 .value({ setDefaultBrowser: setDefaultStub });

const sendTriggerStub = sinon.stub(ASRouter, "sendTriggerMessage");

registerCleanupFunction(() => {
 sinon.restore();
});

let defaultUserChoice;
add_task(async function need_user_choice() {
 await ShellService.setDefaultBrowser();
 defaultUserChoice = userChoiceStub.called;

 Assert.notStrictEqual(
   defaultUserChoice,
   undefined,
   "Decided which default browser method to use"
 );
 Assert.equal(
   setDefaultStub.notCalled,
   defaultUserChoice,
   "Only one default behavior was used"
 );
});

add_task(async function remote_disable() {
 if (defaultUserChoice === false) {
   info("Default behavior already not user choice, so nothing to test");
   return;
 }

 userChoiceStub.resetHistory();
 setDefaultStub.resetHistory();
 let doCleanup = await NimbusTestUtils.enrollWithFeatureConfig(
   {
     featureId: NimbusFeatures.shellService.featureId,
     value: {
       setDefaultBrowserUserChoice: false,
       enabled: true,
     },
   },
   { isRollout: true }
 );

 await ShellService.setDefaultBrowser();

 Assert.ok(
   userChoiceStub.notCalled,
   "Set default with user choice disabled via nimbus"
 );
 Assert.ok(setDefaultStub.called, "Used plain set default instead");

 await doCleanup();
});

add_task(async function restore_default() {
 if (defaultUserChoice === undefined) {
   info("No default user choice behavior set, so nothing to test");
   return;
 }

 userChoiceStub.resetHistory();
 setDefaultStub.resetHistory();

 await ShellService.setDefaultBrowser();

 Assert.equal(
   userChoiceStub.called,
   defaultUserChoice,
   "Set default with user choice restored to original"
 );
 Assert.equal(
   setDefaultStub.notCalled,
   defaultUserChoice,
   "Plain set default behavior restored to original"
 );
});

add_task(async function ensure_fallback() {
 if (AppConstants.platform != "win") {
   info("Nothing to test on non-Windows");
   return;
 }

 let userChoicePromise = Promise.resolve();
 userChoiceStub.callsFake(function (...args) {
   return (userChoicePromise = userChoiceStub.wrappedMethod.apply(this, args));
 });
 userChoiceStub.resetHistory();
 setDefaultStub.resetHistory();
 let doCleanup = await NimbusTestUtils.enrollWithFeatureConfig(
   {
     featureId: NimbusFeatures.shellService.featureId,
     value: {
       setDefaultBrowserUserChoice: true,
       setDefaultPDFHandler: false,
       enabled: true,
     },
   },
   { isRollout: true }
 );

 await ShellService.setDefaultBrowser();

 Assert.ok(userChoiceStub.called, "Set default with user choice called");

 let message = "";
 await userChoicePromise.catch(err => (message = err.message || ""));

 Assert.ok(
   message.includes("ErrExeProgID"),
   "Set default with user choice threw an expected error"
 );
 Assert.ok(setDefaultStub.called, "Fallbacked to plain set default");

 await doCleanup();
});

async function setUpNotificationTests(guidanceEnabled, oneClick) {
 sinon.reset();
 const experimentCleanup = await NimbusTestUtils.enrollWithFeatureConfig(
   {
     featureId: NimbusFeatures.shellService.featureId,
     value: {
       setDefaultGuidanceNotifications: guidanceEnabled,
       setDefaultBrowserUserChoice: oneClick,
       setDefaultBrowserUserChoiceRegRename: oneClick,
       enabled: true,
     },
   },
   { isRollout: true }
 );

 const doCleanup = async () => {
   await experimentCleanup();
   sinon.reset();
 };

 await ShellService.setDefaultBrowser();
 return doCleanup;
}

add_task(
 async function show_notification_when_set_to_default_guidance_enabled_and_one_click_disabled() {
   if (!AppConstants.isPlatformAndVersionAtLeast("win", 10)) {
     info("Nothing to test on non-Windows or older Windows versions");
     return;
   }
   const doCleanup = await setUpNotificationTests(
     true, // guidance enabled
     false // one-click disabled
   );

   Assert.ok(setDefaultStub.called, "Fallback method used to set default");

   Assert.equal(
     sendTriggerStub.firstCall.args[0].id,
     "deeplinkedToWindowsSettingsUI",
     `Set to default guidance message trigger was sent`
   );

   await doCleanup();
 }
);

add_task(
 async function do_not_show_notification_when_set_to_default_guidance_disabled_and_one_click_enabled() {
   if (!AppConstants.isPlatformAndVersionAtLeast("win", 10)) {
     info("Nothing to test on non-Windows or older Windows versions");
     return;
   }

   const doCleanup = await setUpNotificationTests(
     false, // guidance disabled
     true // one-click enabled
   );

   Assert.ok(setDefaultStub.notCalled, "Fallback method not called");

   Assert.equal(
     sendTriggerStub.callCount,
     0,
     `Set to default guidance message trigger was not sent`
   );

   await doCleanup();
 }
);

add_task(
 async function do_not_show_notification_when_set_to_default_guidance_enabled_and_one_click_enabled() {
   if (!AppConstants.isPlatformAndVersionAtLeast("win", 10)) {
     info("Nothing to test on non-Windows or older Windows versions");
     return;
   }

   const doCleanup = await setUpNotificationTests(
     true, // guidance enabled
     true // one-click enabled
   );

   Assert.ok(setDefaultStub.notCalled, "Fallback method not called");
   Assert.equal(
     sendTriggerStub.callCount,
     0,
     `Set to default guidance message trigger was not sent`
   );
   await doCleanup();
 }
);