Bug 1885189 - remove test-only uses of prompts.tabChromePromptSubDialog, r=mconley,credential-management-reviewers,mtigley

gijsk · gijsk · commit b10b8fe1841c · 2024-03-13T22:19:59.000Z
Differential Revision: https://phabricator.services.mozilla.com/D204538
diff --git a/browser/base/content/test/tabPrompts/browser_contentOrigins.js b/browser/base/content/test/tabPrompts/browser_contentOrigins.js
@@ -129,10 +129,7 @@ async function checkDialog(
 
 add_setup(async function () {
   await SpecialPowers.pushPrefEnv({
-    set: [
-      ["prompts.modalType.httpAuth", Ci.nsIPrompt.MODAL_TYPE_TAB],
-      ["prompts.tabChromePromptSubDialog", true],
-    ],
+    set: [["prompts.modalType.httpAuth", Ci.nsIPrompt.MODAL_TYPE_TAB]],
   });
 });
 
diff --git a/browser/components/originattributes/test/browser/browser_httpauth.js b/browser/components/originattributes/test/browser/browser_httpauth.js
@@ -6,11 +6,6 @@ let authPromptModalType = Services.prefs.getIntPref(
   "prompts.modalType.httpAuth"
 );
 
-let commonDialogEnabled =
-  authPromptModalType === Services.prompt.MODAL_TYPE_WINDOW ||
-  (authPromptModalType === Services.prompt.MODAL_TYPE_TAB &&
-    Services.prefs.getBoolPref("prompts.tabChromePromptSubDialog"));
-
 let server = new HttpServer();
 server.registerPathHandler("/file.html", fileHandler);
 server.start(-1);
@@ -38,23 +33,15 @@ function fileHandler(metadata, response) {
 }
 
 function onCommonDialogLoaded(subject) {
-  let dialog;
-  if (commonDialogEnabled) {
-    dialog = subject.Dialog;
-  } else {
-    let promptBox =
-      subject.ownerGlobal.gBrowser.selectedBrowser.tabModalPromptBox;
-    dialog = promptBox.getPrompt(subject).Dialog;
-  }
+  let dialog = subject.Dialog;
+
   // Submit random account and password
   dialog.ui.loginTextbox.setAttribute("value", Math.random());
   dialog.ui.password1Textbox.setAttribute("value", Math.random());
   dialog.ui.button0.click();
 }
 
-let authPromptTopic = commonDialogEnabled
-  ? "common-dialog-loaded"
-  : "tabmodal-dialog-loaded";
+let authPromptTopic = "common-dialog-loaded";
 Services.obs.addObserver(onCommonDialogLoaded, authPromptTopic);
 
 registerCleanupFunction(() => {
diff --git a/toolkit/components/passwordmgr/test/mochitest/pwmgr_common.js b/toolkit/components/passwordmgr/test/mochitest/pwmgr_common.js
@@ -30,15 +30,6 @@ let authPromptModalType = SpecialPowers.Services.prefs.getIntPref(
   "prompts.modalType.httpAuth"
 );
 
-// Whether the auth prompt is a commonDialog.xhtml or a TabModalPrompt
-let authPromptIsCommonDialog =
-  authPromptModalType === SpecialPowers.Services.prompt.MODAL_TYPE_WINDOW ||
-  (authPromptModalType === SpecialPowers.Services.prompt.MODAL_TYPE_TAB &&
-    SpecialPowers.Services.prefs.getBoolPref(
-      "prompts.tabChromePromptSubDialog",
-      false
-    ));
-
 /**
  * Recreate a DOM tree using the outerHTML to ensure that any event listeners
  * and internal state for the elements are removed.
diff --git a/toolkit/components/passwordmgr/test/mochitest/test_bug_627616.html b/toolkit/components/passwordmgr/test/mochitest/test_bug_627616.html
@@ -117,30 +117,12 @@
         sendAsyncMessage("prepareForNextTestDone");
       });
 
-      const modalType = Services.prefs.getIntPref(
-        "prompts.modalType.httpAuth"
-      );
-      const authPromptIsCommonDialog =
-        modalType === Services.prompt.MODAL_TYPE_WINDOW
-          || (modalType === Services.prompt.MODAL_TYPE_TAB
-            && Services.prefs.getBoolPref(
-        "prompts.tabChromePromptSubDialog",
-        false
-      ));
-
-      const dialogObserverTopic = authPromptIsCommonDialog
-        ? "common-dialog-loaded" : "tabmodal-dialog-loaded";
+      const dialogObserverTopic = "common-dialog-loaded";
 
       function dialogObserver(subj, _topic, _data) {
-        if (authPromptIsCommonDialog) {
-          subj.Dialog.ui.prompt.document
-          .getElementById("commonDialog")
-          .acceptDialog();
-        } else {
-          const prompt = subj.ownerGlobal.gBrowser.selectedBrowser
-            .tabModalPromptBox.getPrompt(subj);
-          prompt.Dialog.ui.button0.click(); // Accept button
-        }
+        subj.Dialog.ui.prompt.document
+        .getElementById("commonDialog")
+        .acceptDialog();
         sendAsyncMessage("promptAccepted");
       }
 
diff --git a/toolkit/components/prompts/test/PromptTestUtils.sys.mjs b/toolkit/components/prompts/test/PromptTestUtils.sys.mjs
@@ -6,30 +6,9 @@
  * nsIPromptService.
  */
 
-import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
 import { BrowserTestUtils } from "resource://testing-common/BrowserTestUtils.sys.mjs";
 import { TestUtils } from "resource://testing-common/TestUtils.sys.mjs";
 
-const kPrefs = {};
-
-// Whether prompts with modal type TAB are shown as SubDialog (true) or
-// TabModalPrompt (false).
-XPCOMUtils.defineLazyPreferenceGetter(
-  kPrefs,
-  "tabPromptSubDialogEnabled",
-  "prompts.tabChromePromptSubDialog",
-  false
-);
-
-function isCommonDialog(modalType) {
-  return (
-    modalType === Services.prompt.MODAL_TYPE_WINDOW ||
-    (kPrefs.tabPromptSubDialogEnabled &&
-      modalType === Services.prompt.MODAL_TYPE_TAB) ||
-    modalType === Services.prompt.MODAL_TYPE_CONTENT
-  );
-}
-
 export let PromptTestUtils = {
   /**
    * Wait for a prompt from nsIPrompt or nsIPromptsService, interact with it and
@@ -75,13 +54,7 @@ export let PromptTestUtils = {
     let promptClosePromise;
 
     // Get parent window to listen for prompt close event
-    let win;
-    if (isCommonDialog(dialog.args.modalType)) {
-      win = dialog.ui.prompt?.opener;
-    } else {
-      // Tab prompts should always have a parent window
-      win = dialog.ui.prompt.win;
-    }
+    let win = dialog.ui.prompt?.opener;
 
     if (win) {
       promptClosePromise = BrowserTestUtils.waitForEvent(
@@ -151,65 +124,50 @@ export let PromptTestUtils = {
       }
     }
 
-    let topic = isCommonDialog(modalType)
-      ? "common-dialog-loaded"
-      : "tabmodal-dialog-loaded";
+    let topic = "common-dialog-loaded";
 
     let dialog;
     await TestUtils.topicObserved(topic, subject => {
       // If we are not given a browser, use the currently selected browser of the window
       let browser =
         parentBrowser || subject.ownerGlobal.gBrowser?.selectedBrowser;
-      if (isCommonDialog(modalType)) {
-        // Is not associated with given parent window, skip
-        if (parentWindow && subject.opener !== parentWindow) {
-          return false;
-        }
-
-        // For tab prompts, ensure that the associated browser matches.
-        if (browser && modalType == Services.prompt.MODAL_TYPE_TAB) {
-          let dialogBox = parentWindow.gBrowser.getTabDialogBox(browser);
-          let hasMatchingDialog = dialogBox
-            .getTabDialogManager()
-            ._dialogs.some(
-              d => d._frame?.browsingContext == subject.browsingContext
-            );
-          if (!hasMatchingDialog) {
-            return false;
-          }
-        }
+      // Is not associated with given parent window, skip
+      if (parentWindow && subject.opener !== parentWindow) {
+        return false;
+      }
 
-        if (browser && modalType == Services.prompt.MODAL_TYPE_CONTENT) {
-          let dialogBox = parentWindow.gBrowser.getTabDialogBox(browser);
-          let hasMatchingDialog = dialogBox
-            .getContentDialogManager()
-            ._dialogs.some(
-              d => d._frame?.browsingContext == subject.browsingContext
-            );
-          if (!hasMatchingDialog) {
-            return false;
-          }
+      // For tab prompts, ensure that the associated browser matches.
+      if (browser && modalType == Services.prompt.MODAL_TYPE_TAB) {
+        let dialogBox = parentWindow.gBrowser.getTabDialogBox(browser);
+        let hasMatchingDialog = dialogBox
+          .getTabDialogManager()
+          ._dialogs.some(
+            d => d._frame?.browsingContext == subject.browsingContext
+          );
+        if (!hasMatchingDialog) {
+          return false;
         }
+      }
 
-        // subject is the window object of the prompt which has a Dialog object
-        // attached.
-        dialog = subject.Dialog;
-      } else {
-        // subject is the tabprompt dom node
-        // Get the full prompt object which has the dialog object
-        let prompt = browser.tabModalPromptBox.getPrompt(subject);
-
-        // Is not associated with given parent browser, skip.
-        if (!prompt) {
+      if (browser && modalType == Services.prompt.MODAL_TYPE_CONTENT) {
+        let dialogBox = parentWindow.gBrowser.getTabDialogBox(browser);
+        let hasMatchingDialog = dialogBox
+          .getContentDialogManager()
+          ._dialogs.some(
+            d => d._frame?.browsingContext == subject.browsingContext
+          );
+        if (!hasMatchingDialog) {
           return false;
         }
-
-        dialog = prompt.Dialog;
       }
 
+      // subject is the window object of the prompt which has a Dialog object
+      // attached.
+      dialog = subject.Dialog;
+
       // Not the modalType we're looking for.
       // For window prompts dialog.args.modalType is undefined.
-      if (isCommonDialog(modalType) && dialog.args.modalType !== modalType) {
+      if (dialog.args.modalType !== modalType) {
         return false;
       }
 
diff --git a/toolkit/components/prompts/test/chromeScript.js b/toolkit/components/prompts/test/chromeScript.js
@@ -8,11 +8,6 @@ const { BrowserTestUtils } = ChromeUtils.importESModule(
   "resource://testing-common/BrowserTestUtils.sys.mjs"
 );
 
-var tabSubDialogsEnabled = Services.prefs.getBoolPref(
-  "prompts.tabChromePromptSubDialog",
-  false
-);
-
 // Define these to make EventUtils happy.
 let window = this;
 let parent = {};
@@ -86,27 +81,15 @@ async function handlePrompt(action, modalType, isSelect) {
   let ui;
   let browserWin = Services.wm.getMostRecentWindow("navigator:browser");
 
-  if (!tabSubDialogsEnabled && modalType === Services.prompt.MODAL_TYPE_TAB) {
-    let gBrowser = browserWin.gBrowser;
-    let promptManager = gBrowser.getTabModalPromptBox(gBrowser.selectedBrowser);
-    let prompts = promptManager.listPrompts();
-    if (!prompts.length) {
-      return false; // try again in a bit
-    }
+  let doc = getDialogDoc();
+  if (!doc) {
+    return false; // try again in a bit
+  }
 
-    ui = prompts[0].Dialog.ui;
-    checkTabModal(prompts[0], gBrowser.selectedBrowser);
+  if (isSelect) {
+    ui = doc;
   } else {
-    let doc = getDialogDoc();
-    if (!doc) {
-      return false; // try again in a bit
-    }
-
-    if (isSelect) {
-      ui = doc;
-    } else {
-      ui = doc.defaultView.Dialog.ui;
-    }
+    ui = doc.defaultView.Dialog.ui;
   }
 
   let dialogClosed = BrowserTestUtils.waitForEvent(
