From d4da30ccf452697aa4addd72637616e9714b6223 Mon Sep 17 00:00:00 2001
From: Mike Conley <mconley@mozilla.com>
Date: Tue, 23 Feb 2021 00:11:05 +0000
Subject: [PATCH] Bug 1690573 - Migrate the report-site-issue UI access point
 to the Help menu.
 r=denschub,mixedpuppy,fluent-reviewers,webcompat-reviewers,flod

We're not 100% certain if Help is the right spot for this, but we're going
to give it a shot and see. If it turns out it _is_ the right spot, we'll
probably do something a little more self-contained, and less hacky.

I'm leaving the old .properties file just in case we change our mind here.
Yes, we'll want to port to Fluent anyways, but our ultimate choice of where
we put this thing is probably going to dictate where the string lives.

Differential Revision: https://phabricator.services.mozilla.com/D104832
---
 browser/base/content/browser-menubar.inc      |  5 ++
 browser/base/content/browser.js               | 16 ++++++
 browser/base/content/utilityOverlay.js        | 24 +++++++++
 .../report-site-issue/background.js           |  2 +-
 .../experimentalAPIs/helpMenu.js              | 50 +++++++++++++++++++
 .../experimentalAPIs/helpMenu.json            | 28 +++++++++++
 .../report-site-issue/manifest.json           | 15 +++---
 .../extensions/report-site-issue/moz.build    |  2 +
 .../test/browser/browser.ini                  |  3 ++
 browser/locales/en-US/browser/appmenu.ftl     |  2 +
 browser/locales/en-US/browser/menubar.ftl     |  2 +
 .../bug_1690573_report_site_issue.py          | 34 +++++++++++++
 12 files changed, 175 insertions(+), 8 deletions(-)
 create mode 100644 browser/extensions/report-site-issue/experimentalAPIs/helpMenu.js
 create mode 100644 browser/extensions/report-site-issue/experimentalAPIs/helpMenu.json
 create mode 100644 python/l10n/fluent_migrations/bug_1690573_report_site_issue.py

diff --git a/browser/base/content/browser-menubar.inc b/browser/base/content/browser-menubar.inc
index 058c1e5835e0..1e53703302e8 100644
--- a/browser/base/content/browser-menubar.inc
+++ b/browser/base/content/browser-menubar.inc
@@ -484,6 +484,11 @@
                           onclick="checkForMiddleClick(this, event);"
                           data-l10n-id="menu-help-taskmanager"
                           appmenu-data-l10n-id="appmenu-help-taskmanager"/>
+                <menuitem id="help_reportSiteIssue"
+                          oncommand="ReportSiteIssue();"
+                          data-l10n-id="menu-help-report-site-issue"
+                          appmenu-data-l10n-id="appmenu-help-report-site-issue"
+                          hidden="true"/>
                 <menuitem id="menu_HelpPopup_reportPhishingtoolmenu"
                           disabled="true"
                           oncommand="openUILink(gSafeBrowsing.getReportURL('Phish'), event, {triggeringPrincipal: Services.scriptSecurityManager.createNullPrincipal({})});"
diff --git a/browser/base/content/browser.js b/browser/base/content/browser.js
index 0a9b87d73774..921232685524 100644
--- a/browser/base/content/browser.js
+++ b/browser/base/content/browser.js
@@ -8132,6 +8132,22 @@ function ReportFalseDeceptiveSite() {
   }
 }
 
+/**
+ * This is a temporary hack to connect a Help menu item for reporting
+ * site issues to the WebCompat team's Site Compatability Reporter
+ * WebExtension, which ships by default and is enabled on pre-release
+ * channels.
+ *
+ * Once we determine if Help is the right place for it, we'll do something
+ * slightly better than this.
+ *
+ * See bug 1690573.
+ */
+function ReportSiteIssue() {
+  let subject = { wrappedJSObject: gBrowser.selectedTab };
+  Services.obs.notifyObservers(subject, "report-site-issue");
+}
+
 /**
  * Format a URL
  * eg:
diff --git a/browser/base/content/utilityOverlay.js b/browser/base/content/utilityOverlay.js
index d28afc484228..65aa4c1c5f8d 100644
--- a/browser/base/content/utilityOverlay.js
+++ b/browser/base/content/utilityOverlay.js
@@ -1099,6 +1099,30 @@ function buildHelpMenu() {
   if (typeof gSafeBrowsing != "undefined") {
     gSafeBrowsing.setReportPhishingMenu();
   }
+
+  // We're testing to see if the WebCompat team's "Report Site Issue"
+  // access point makes sense in the Help menu. Normally checking this
+  // pref wouldn't be enough, since there's also the case that the
+  // add-on has somehow been disabled by the user or third-party software
+  // without flipping the pref. Since this add-on is only used on pre-release
+  // channels, and since the jury is still out on whether or not the Help menu
+  // is the right place for this item, we're going to do a least-effort
+  // approach here and assume that the pref is enough to determine whether the
+  // menuitem should appear.
+  //
+  // See bug 1690573 for further details.
+  let reportSiteIssueEnabled = Services.prefs.getBoolPref(
+    "extensions.webcompat-reporter.enabled",
+    false
+  );
+  let reportSiteIssue = document.getElementById("help_reportSiteIssue");
+  reportSiteIssue.hidden = !reportSiteIssueEnabled;
+  if (reportSiteIssueEnabled) {
+    let uri = gBrowser.currentURI;
+    let isReportablePage =
+      uri && (uri.schemeIs("http") || uri.schemeIs("https"));
+    reportSiteIssue.disabled = !isReportablePage;
+  }
 }
 
 function isElementVisible(aElement) {
diff --git a/browser/extensions/report-site-issue/background.js b/browser/extensions/report-site-issue/background.js
index d5c4edcbd7f0..23b6afdfde7a 100644
--- a/browser/extensions/report-site-issue/background.js
+++ b/browser/extensions/report-site-issue/background.js
@@ -19,7 +19,7 @@ const FRAMEWORK_KEYS = ["hasFastClick", "hasMobify", "hasMarfeel"];
 
 browser.pageActionExtras.setLabelForHistogram("webcompat");
 
-browser.pageAction.onClicked.addListener(tab => {
+browser.helpMenu.onHelpMenuCommand.addListener(tab => {
   return getWebCompatInfoForTab(tab).then(
     info => {
       return openWebCompatTab(info);
diff --git a/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.js b/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.js
new file mode 100644
index 000000000000..89df78eb433e
--- /dev/null
+++ b/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.js
@@ -0,0 +1,50 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+"use strict";
+
+/* global ExtensionAPI */
+
+ChromeUtils.defineModuleGetter(
+  this,
+  "Services",
+  "resource://gre/modules/Services.jsm"
+);
+
+ChromeUtils.defineModuleGetter(
+  this,
+  "ExtensionCommon",
+  "resource://gre/modules/ExtensionCommon.jsm"
+);
+
+const TOPIC = "report-site-issue";
+
+this.helpMenu = class extends ExtensionAPI {
+  getAPI(context) {
+    const { tabManager } = context.extension;
+    let EventManager = ExtensionCommon.EventManager;
+
+    return {
+      helpMenu: {
+        onHelpMenuCommand: new EventManager({
+          context,
+          name: "helpMenu",
+          register: fire => {
+            let observer = (subject, topic, data) => {
+              let nativeTab = subject.wrappedJSObject;
+              let tab = tabManager.convert(nativeTab);
+              fire.async(tab);
+            };
+
+            Services.obs.addObserver(observer, TOPIC);
+
+            return () => {
+              Services.obs.removeObserver(observer, TOPIC);
+            };
+          },
+        }).api(),
+      },
+    };
+  }
+};
diff --git a/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.json b/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.json
new file mode 100644
index 000000000000..9ecc2bc0243e
--- /dev/null
+++ b/browser/extensions/report-site-issue/experimentalAPIs/helpMenu.json
@@ -0,0 +1,28 @@
+[
+  {
+    "namespace": "helpMenu",
+    "events": [
+      {
+        "name": "onHelpMenuCommand",
+        "type": "function",
+        "async": "callback",
+        "description": "Fired when the command event for the Report Site Issue menuitem in Help is fired.",
+        "parameters": [
+          {
+            "type": "function",
+            "name": "callback",
+            "optional": true,
+            "parameters": [
+              {
+                "name": "tab",
+                "$ref": "tabs.Tab",
+                "optional": true,
+                "description": "Details about the selected tab in the window where the menuitem command fired."
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]
\ No newline at end of file
diff --git a/browser/extensions/report-site-issue/manifest.json b/browser/extensions/report-site-issue/manifest.json
index d0afa9e79574..a5fc38d2f6ad 100644
--- a/browser/extensions/report-site-issue/manifest.json
+++ b/browser/extensions/report-site-issue/manifest.json
@@ -27,6 +27,14 @@
         "paths": [["browserInfo"]]
       }
     },
+    "helpMenu": {
+      "schema": "experimentalAPIs/helpMenu.json",
+      "parent": {
+        "scopes": ["addon_parent"],
+        "script": "experimentalAPIs/helpMenu.js",
+        "paths": [["helpMenu"]]
+      }
+    },
     "l10n": {
       "schema": "experimentalAPIs/l10n.json",
       "parent": {
@@ -67,12 +75,5 @@
     "scripts": [
       "background.js"
     ]
-  },
-  "page_action": {
-    "browser_style": true,
-    "default_icon": "icons/lightbulb.svg",
-    "default_title": "Report Site Issue…",
-    "pinned": false,
-    "show_matches": ["http://*/*", "https://*/*"]
   }
 }
diff --git a/browser/extensions/report-site-issue/moz.build b/browser/extensions/report-site-issue/moz.build
index e3e92a33198f..17a2ea1c7642 100644
--- a/browser/extensions/report-site-issue/moz.build
+++ b/browser/extensions/report-site-issue/moz.build
@@ -19,6 +19,8 @@ FINAL_TARGET_FILES.features["webcompat-reporter@mozilla.org"].experimentalAPIs +
     "experimentalAPIs/aboutConfigPrefs.json",
     "experimentalAPIs/browserInfo.js",
     "experimentalAPIs/browserInfo.json",
+    "experimentalAPIs/helpMenu.js",
+    "experimentalAPIs/helpMenu.json",
     "experimentalAPIs/l10n.js",
     "experimentalAPIs/l10n.json",
     "experimentalAPIs/pageActionExtras.js",
diff --git a/browser/extensions/report-site-issue/test/browser/browser.ini b/browser/extensions/report-site-issue/test/browser/browser.ini
index 39861d8cc613..a33c24de719c 100644
--- a/browser/extensions/report-site-issue/test/browser/browser.ini
+++ b/browser/extensions/report-site-issue/test/browser/browser.ini
@@ -7,5 +7,8 @@ support-files =
   webcompat.html
 
 [browser_disabled_cleanup.js]
+skip-if = true # Disabled until bug 1693119 is landed
 [browser_button_state.js]
+skip-if = true # Disabled until bug 1693119 is landed
 [browser_report_site_issue.js]
+skip-if = true # Disabled until bug 1693119 is landed
diff --git a/browser/locales/en-US/browser/appmenu.ftl b/browser/locales/en-US/browser/appmenu.ftl
index 6d9d98a4e12d..759cc0c89d48 100644
--- a/browser/locales/en-US/browser/appmenu.ftl
+++ b/browser/locales/en-US/browser/appmenu.ftl
@@ -132,6 +132,8 @@ appmenu-help-troubleshooting-info =
     .accesskey = T
 appmenu-help-taskmanager =
     .label = Task Manager
+appmenu-help-report-site-issue =
+    .label = Report Site Issue…
 appmenu-help-feedback-page =
     .label = Submit Feedback…
     .accesskey = S
diff --git a/browser/locales/en-US/browser/menubar.ftl b/browser/locales/en-US/browser/menubar.ftl
index 7a544d1d4fdc..ea55ba38e50a 100644
--- a/browser/locales/en-US/browser/menubar.ftl
+++ b/browser/locales/en-US/browser/menubar.ftl
@@ -307,6 +307,8 @@ menu-help-troubleshooting-info =
     .accesskey = T
 menu-help-taskmanager =
     .label = Task Manager
+menu-help-report-site-issue =
+    .label = Report Site Issue…
 menu-help-feedback-page =
     .label = Submit Feedback…
     .accesskey = S
diff --git a/python/l10n/fluent_migrations/bug_1690573_report_site_issue.py b/python/l10n/fluent_migrations/bug_1690573_report_site_issue.py
new file mode 100644
index 000000000000..5cfab372829c
--- /dev/null
+++ b/python/l10n/fluent_migrations/bug_1690573_report_site_issue.py
@@ -0,0 +1,34 @@
+# coding=utf8
+
+# Any copyright is dedicated to the Public Domain.
+# http://creativecommons.org/publicdomain/zero/1.0/
+
+from __future__ import absolute_import
+from fluent.migrate.helpers import transforms_from
+
+
+def migrate(ctx):
+    """Bug 1690573 - Port Report Site Issue WebExtension strings to Fluent, part {index}."""
+    ctx.add_transforms(
+        "browser/browser/menubar.ftl",
+        "browser/browser/menubar.ftl",
+        transforms_from(
+            """
+menu-help-report-site-issue =
+    .label = { COPY(from_path, "wc-reporter.label2") }
+""",
+            from_path="browser/extensions/report-site-issue/webcompat.properties",
+        ),
+    )
+
+    ctx.add_transforms(
+        "browser/browser/appmenu.ftl",
+        "browser/browser/appmenu.ftl",
+        transforms_from(
+            """
+appmenu-help-report-site-issue =
+    .label = { COPY(from_path, "wc-reporter.label2") }
+""",
+            from_path="browser/extensions/report-site-issue/webcompat.properties",
+        ),
+    )