Bug 1869812 put webcompat reporter panelviews in a template so their contents don't run or load additional script/css, r=twisniewski

gijsk · gijsk · commit edf29b31d07b · 2023-12-13T17:11:19.000Z
Differential Revision: https://phabricator.services.mozilla.com/D196306
diff --git a/browser/base/content/appmenu-viewcache.inc.xhtml b/browser/base/content/appmenu-viewcache.inc.xhtml
@@ -716,4 +716,6 @@
       </html:moz-button-group>
     </vbox>
   </panelview>
+
+#include ../../components/reportbrokensite/content/reportBrokenSitePanel.inc.xhtml
 </html:template>
diff --git a/browser/base/content/main-popupset.inc.xhtml b/browser/base/content/main-popupset.inc.xhtml
@@ -500,7 +500,6 @@
 #include ../../components/controlcenter/content/protectionsPanel.inc.xhtml
 #include ../../components/downloads/content/downloadsPanel.inc.xhtml
 #include ../../components/translations/content/translationsPanel.inc.xhtml
-#include ../../components/reportbrokensite/content/reportBrokenSitePanel.inc.xhtml
 #include browser-allTabsMenu.inc.xhtml
 
   <tooltip id="dynamic-shortcut-tooltip"
diff --git a/browser/components/reportbrokensite/ReportBrokenSite.sys.mjs b/browser/components/reportbrokensite/ReportBrokenSite.sys.mjs
@@ -432,7 +432,6 @@ export var ReportBrokenSite = new (class ReportBrokenSite {
       const multiview = target.closest("panelmultiview");
       this.#recordGleanEvent("send");
       await this.#sendReportAsGleanPing(state);
-      state.reportSentView.hidden = false;
       multiview.showSubView("report-broken-site-popup-reportSentView");
       state.reset();
     });
@@ -506,8 +505,6 @@ export var ReportBrokenSite = new (class ReportBrokenSite {
       state.resetURLToCurrentTab();
     }
 
-    state.mainView.hidden = false;
-
     const { sendMoreInfoLink } = state;
     const { sendMoreInfoEndpoint } = this;
     if (sendMoreInfoLink.href !== sendMoreInfoEndpoint) {
diff --git a/browser/components/reportbrokensite/content/reportBrokenSitePanel.inc.xhtml b/browser/components/reportbrokensite/content/reportBrokenSitePanel.inc.xhtml
@@ -7,7 +7,6 @@
            role="document"
            data-l10n-id="report-broken-site-panel-header"
            data-l10n-attrs="title"
-           hidden="true"
            showheader="true">
   <!-- wants-back-button will be removed in bug 1869574
        (and also from PanelMultiView.sys.mjs)
@@ -101,7 +100,6 @@
            role="dialog"
            data-l10n-id="report-broken-site-panel-report-sent-header"
            data-l10n-attrs="title"
-           hidden="true"
            showheader="true">
   <box class="panel-header panel-header-with-additional-element">
     <image class="checkmark-icon additional-element-on-inline-start"></image>
diff --git a/browser/components/reportbrokensite/test/browser/browser_keyboard_navigation.js b/browser/components/reportbrokensite/test/browser/browser_keyboard_navigation.js
@@ -160,6 +160,7 @@ async function testPressingKey(key, tabToMatch, makePromise, followUp) {
     REPORTABLE_PAGE_URL,
     async function (browser) {
       for (const menu of [AppMenu(), ProtectionsPanel(), HelpMenu()]) {
+        info(`Opening RBS on ${menu.menuDescription}`);
         const rbs = await menu.openReportBrokenSite();
         const promise = makePromise(rbs);
         if (tabToMatch) {
diff --git a/browser/components/reportbrokensite/test/browser/head.js b/browser/components/reportbrokensite/test/browser/head.js
@@ -140,16 +140,16 @@ class ReportBrokenSiteHelper {
     this.win = sourceMenu.win;
   }
 
+  getViewNode(id) {
+    return PanelMultiView.getViewNode(this.win.document, id);
+  }
+
   get mainView() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-mainView"
-    );
+    return this.getViewNode("report-broken-site-popup-mainView");
   }
 
   get sentView() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-reportSentView"
-    );
+    return this.getViewNode("report-broken-site-popup-reportSentView");
   }
 
   get openPanel() {
@@ -249,75 +249,56 @@ class ReportBrokenSiteHelper {
   }
 
   // UI element getters
-
   get URLInput() {
-    return this.win.document.getElementById("report-broken-site-popup-url");
+    return this.getViewNode("report-broken-site-popup-url");
   }
 
   get URLInvalidMessage() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-invalid-url-msg"
-    );
+    return this.getViewNode("report-broken-site-popup-invalid-url-msg");
   }
 
   get reasonInput() {
-    return this.win.document.getElementById("report-broken-site-popup-reason");
+    return this.getViewNode("report-broken-site-popup-reason");
   }
 
   get reasonDropdownPopup() {
     return this.reasonInput.querySelector("menupopup");
   }
 
   get reasonRequiredMessage() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-missing-reason-msg"
-    );
+    return this.getViewNode("report-broken-site-popup-missing-reason-msg");
   }
 
   get reasonLabelRequired() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-reason-label"
-    );
+    return this.getViewNode("report-broken-site-popup-reason-label");
   }
 
   get reasonLabelOptional() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-reason-optional-label"
-    );
+    return this.getViewNode("report-broken-site-popup-reason-optional-label");
   }
 
   get descriptionTextarea() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-description"
-    );
+    return this.getViewNode("report-broken-site-popup-description");
   }
 
   get sendMoreInfoLink() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-send-more-info-link"
-    );
+    return this.getViewNode("report-broken-site-popup-send-more-info-link");
   }
 
   get backButton() {
     return this.mainView.querySelector(".subviewbutton-back");
   }
 
   get sendButton() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-send-button"
-    );
+    return this.getViewNode("report-broken-site-popup-send-button");
   }
 
   get cancelButton() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-cancel-button"
-    );
+    return this.getViewNode("report-broken-site-popup-cancel-button");
   }
 
   get okayButton() {
-    return this.win.document.getElementById(
-      "report-broken-site-popup-okay-button"
-    );
+    return this.getViewNode("report-broken-site-popup-okay-button");
   }
 
   // Test helpers
@@ -334,9 +315,7 @@ class ReportBrokenSiteHelper {
   }
 
   chooseReason(value) {
-    const item = this.win.document.getElementById(
-      `report-broken-site-popup-reason-${value}`
-    );
+    const item = this.getViewNode(`report-broken-site-popup-reason-${value}`);
     const input = this.reasonInput;
     input.selectedItem = item;
     input.dispatchEvent(
@@ -498,6 +477,10 @@ class MenuHelper {
     this.win = win;
   }
 
+  getViewNode(id) {
+    return PanelMultiView.getViewNode(this.win.document, id);
+  }
+
   get showsBackButton() {
     return true;
   }
@@ -567,21 +550,15 @@ class AppMenuHelper extends MenuHelper {
   menuDescription = "AppMenu";
 
   get reportBrokenSite() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "appMenu-report-broken-site-button"
-    );
+    return this.getViewNode("appMenu-report-broken-site-button");
   }
 
   get reportSiteIssue() {
     return undefined;
   }
 
   get popup() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "appMenu-popup"
-    );
+    return this.win.document.getElementById("appMenu-popup");
   }
 
   async open() {
@@ -599,24 +576,15 @@ class AppMenuHelpSubmenuHelper extends MenuHelper {
   menuDescription = "AppMenu help sub-menu";
 
   get reportBrokenSite() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "appMenu_help_reportBrokenSite"
-    );
+    return this.getViewNode("appMenu_help_reportBrokenSite");
   }
 
   get reportSiteIssue() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "appMenu_help_reportSiteIssue"
-    );
+    return this.getViewNode("appMenu_help_reportSiteIssue");
   }
 
   get popup() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "appMenu-popup"
-    );
+    return this.win.document.getElementById("appMenu-popup");
   }
 
   async open() {
@@ -625,8 +593,7 @@ class AppMenuHelpSubmenuHelper extends MenuHelper {
     const anchor = this.win.document.getElementById("PanelUI-menu-button");
     this.win.PanelUI.showHelpView(anchor);
 
-    const appMenuHelpSubview =
-      this.win.document.getElementById("PanelUI-helpView");
+    const appMenuHelpSubview = this.getViewNode("PanelUI-helpView");
     await BrowserTestUtils.waitForEvent(appMenuHelpSubview, "ViewShown");
   }
 
@@ -645,31 +612,19 @@ class HelpMenuHelper extends MenuHelper {
   }
 
   get reportBrokenSite() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "help_reportBrokenSite"
-    );
+    return this.win.document.getElementById("help_reportBrokenSite");
   }
 
   get reportSiteIssue() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "help_reportSiteIssue"
-    );
+    return this.win.document.getElementById("help_reportSiteIssue");
   }
 
   get popup() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "PanelUI-helpView"
-    );
+    return this.getViewNode("PanelUI-helpView");
   }
 
   get helpMenu() {
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "menu_HelpPopup"
-    );
+    return this.win.document.getElementById("menu_HelpPopup");
   }
 
   async openReportBrokenSite() {
@@ -720,10 +675,7 @@ class ProtectionsPanelHelper extends MenuHelper {
 
   get reportBrokenSite() {
     this.win.gProtectionsHandler._initializePopup();
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "protections-popup-report-broken-site-button"
-    );
+    return this.getViewNode("protections-popup-report-broken-site-button");
   }
 
   get reportSiteIssue() {
@@ -732,10 +684,7 @@ class ProtectionsPanelHelper extends MenuHelper {
 
   get popup() {
     this.win.gProtectionsHandler._initializePopup();
-    return this.win.PanelMultiView.getViewNode(
-      this.win.document,
-      "protections-popup"
-    );
+    return this.win.document.getElementById("protections-popup");
   }
 
   async open() {
@@ -753,7 +702,7 @@ class ProtectionsPanelHelper extends MenuHelper {
     if (this.opened) {
       const popup = this.popup;
       const promise = BrowserTestUtils.waitForEvent(popup, "popuphidden");
-      this.win.PanelMultiView.hidePopup(popup, false);
+      PanelMultiView.hidePopup(popup, false);
       await promise;
     }
   }
