allow reporting webcompat issues through the Shields panel

browser/extensions/api/brave_shields_api.cc

@@ -10,6 +10,7 @@
 #include <utility>
 
 #include "base/strings/string_number_conversions.h"
+#include "brave/browser/brave_webcompat_reporter/webcompat_reporter_dialog.h"
 #include "brave/common/extensions/api/brave_shields.h"
 #include "brave/common/extensions/extension_constants.h"
 #include "brave/components/brave_shields/browser/brave_shields_util.h"
@@ -295,5 +296,29 @@ BraveShieldsGetNoScriptControlTypeFunction::Run() {
   return RespondNow(OneArgument(std::move(result)));
 }
 
+ExtensionFunction::ResponseAction BraveShieldsReportBrokenSiteFunction::Run() {
+  std::unique_ptr<brave_shields::ReportBrokenSite::Params> params(
+      brave_shields::ReportBrokenSite::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get());
+
+  // Get web contents for this tab
+  content::WebContents* contents = nullptr;
+  if (!ExtensionTabUtil::GetTabById(
+        params->tab_id,
+        Profile::FromBrowserContext(browser_context()),
+        false,
+        nullptr,
+        nullptr,
+        &contents,
+        nullptr)) {
+    return RespondNow(Error(tabs_constants::kTabNotFoundError,
+                            base::NumberToString(params->tab_id)));
+  }
+
+  OpenWebcompatReporterDialog(contents);
+
+  return RespondNow(NoArguments());
+}
+
 }  // namespace api
 }  // namespace extensions

browser/extensions/api/brave_shields_api.h

@@ -155,6 +155,17 @@ class BraveShieldsGetNoScriptControlTypeFunction
   ResponseAction Run() override;
 };
 
+class BraveShieldsReportBrokenSiteFunction
+    : public UIThreadExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("braveShields.reportBrokenSite", UNKNOWN)
+
+ protected:
+  ~BraveShieldsReportBrokenSiteFunction() override {}
+
+  ResponseAction Run() override;
+};
+
 }  // namespace api
 }  // namespace extensions
 

common/extensions/api/brave_shields.json

@@ -301,6 +301,17 @@
             "parameters": []
           }
         ]
+      },
+      {
+        "name": "reportBrokenSite",
+        "type": "function",
+        "description": "Bring up a modal for reporting a site broken by Shields to the Brave developers",
+        "parameters": [
+          {
+            "name": "tabId",
+            "type": "integer"
+          }
+        ]
       }
     ]
   }

components/brave_extension/extension/brave_extension/_locales/en_US/messages.json

@@ -24,8 +24,12 @@
     "description": "Message telling the user to disable shields if a site appears broken"
   },
   "disabledMessage": {
-    "message": "You’re browsing this site without any privacy and security protections.",
-    "description": "Message telling the user that shields are disabled"
+    "message": "You’re browsing this site without Brave's privacy and security protections. Does it not work right with Shields up?",
+    "description": "Message telling the user that shields are disabled, and prompting them towards reporting an issue if necessary"
+  },
+  "reportBrokenSite": {
+    "message": "Report a broken site",
+    "description": "Message for the button allowing users to report a broken site to Brave developers"
   },
   "itemsBlocked": {
     "message": "Items blocked",

components/brave_extension/extension/brave_extension/actions/shieldsPanelActions.ts

@@ -19,6 +19,12 @@ export const shieldsToggled: actions.ShieldsToggled = (setting = 'allow') => {
   }
 }
 
+export const reportBrokenSite: actions.ReportBrokenSite = () => {
+  return {
+    type: types.REPORT_BROKEN_SITE
+  }
+}
+
 export const resourceBlocked: actions.ResourceBlocked = (details) => {
   return {
     type: types.RESOURCE_BLOCKED,

components/brave_extension/extension/brave_extension/background/api/shieldsAPI.ts

@@ -163,6 +163,13 @@ export const setAllowScriptOriginsOnce = (origins: Array<string>, tabId: number)
     })
   })
 
+/**
+ * Open a prompt that allows the user to submit a report telling Brave that the current website is broken by Shields.
+ * @param {number} tabId ID of the tab whose contents are being reported
+ */
+export const reportBrokenSite = (tabId: number) =>
+  chrome.braveShields.reportBrokenSite(tabId)
+
 export type GetViewPreferencesData = {
   showAdvancedView: boolean
 }

components/brave_extension/extension/brave_extension/background/reducers/shieldsPanelReducer.ts

@@ -28,7 +28,8 @@ import {
   setAllowCookies,
   toggleShieldsValue,
   requestShieldPanelData,
-  setAllowScriptOriginsOnce
+  setAllowScriptOriginsOnce,
+  reportBrokenSite
 } from '../api/shieldsAPI'
 import { reloadTab } from '../api/tabsAPI'
 
@@ -123,6 +124,16 @@ export default function shieldsPanelReducer (
         .updateTabShieldsData(state, tabId, { braveShields: action.setting })
       break
     }
+    case shieldsPanelTypes.REPORT_BROKEN_SITE: {
+      const tabId: number = shieldsPanelState.getActiveTabId(state)
+      const tabData = shieldsPanelState.getActiveTabData(state)
+      if (!tabData) {
+        console.error('Active tab not found')
+        break
+      }
+      reportBrokenSite(tabId)
+      break
+    }
     case shieldsPanelTypes.HTTPS_EVERYWHERE_TOGGLED: {
       const tabData = shieldsPanelState.getActiveTabData(state)
       if (!tabData) {

components/brave_extension/extension/brave_extension/components/advancedView/header.tsx

@@ -19,7 +19,7 @@ import {
   TotalBlockedStatsNumber,
   TotalBlockedStatsText,
   DisabledContentView,
-  ShieldIcon,
+  ShieldsButton,
   DisabledContentText,
   Toggle
 } from 'brave-ui/features/shields'
@@ -41,6 +41,7 @@ interface CommonProps {
   hostname: string
   isBlockedListOpen: boolean
   shieldsToggled: ShieldsToggled
+  reportBrokenSite: () => void
 }
 
 interface BlockedItemsProps {
@@ -76,7 +77,7 @@ export default class Header extends React.PureComponent<Props, {}> {
   }
 
   render () {
-    const { enabled, favicon, hostname, isBlockedListOpen } = this.props
+    const { enabled, favicon, hostname, isBlockedListOpen, reportBrokenSite } = this.props
     return (
       <ShieldsHeader id='braveShieldsHeader' status={enabled ? 'enabled' : 'disabled'}>
         <MainToggle status={enabled ? 'enabled' : 'disabled'}>
@@ -109,8 +110,8 @@ export default class Header extends React.PureComponent<Props, {}> {
             )
             : (
               <DisabledContentView>
-                <div><ShieldIcon /></div>
                 <DisabledContentText>{getLocale('disabledMessage')}</DisabledContentText>
+                <ShieldsButton level='secondary' type='default' onClick={reportBrokenSite} text={getLocale('reportBrokenSite')} />
               </DisabledContentView>
             )
           }

components/brave_extension/extension/brave_extension/components/advancedView/index.tsx

@@ -22,6 +22,7 @@ import { Tab, PersistentData } from '../../types/state/shieldsPannelState'
 import { isShieldsEnabled, getFavicon } from '../../helpers/shieldsUtils'
 import {
   ShieldsToggled,
+  ReportBrokenSite,
   BlockAdsTrackers,
   HttpsEverywhereToggled,
   BlockJavaScript,
@@ -38,6 +39,7 @@ import {
 interface Props {
   actions: {
     shieldsToggled: ShieldsToggled
+    reportBrokenSite: ReportBrokenSite
     blockAdsTrackers: BlockAdsTrackers
     httpsEverywhereToggled: HttpsEverywhereToggled
     blockJavaScript: BlockJavaScript
@@ -104,6 +106,7 @@ export default class Shields extends React.PureComponent<Props, State> {
           scriptsBlocked={shieldsPanelTabData.javascriptBlocked}
           fingerprintingBlocked={shieldsPanelTabData.fingerprintingBlocked}
           shieldsToggled={actions.shieldsToggled}
+          reportBrokenSite={actions.reportBrokenSite}
         />
         {
           this.isShieldsEnabled && (

components/brave_extension/extension/brave_extension/components/braveShields.tsx

@@ -19,6 +19,7 @@ import * as shieldsAPI from '../background/api/shieldsAPI'
 import { Tab, PersistentData } from '../types/state/shieldsPannelState'
 import {
   ShieldsToggled,
+  ReportBrokenSite,
   BlockAdsTrackers,
   HttpsEverywhereToggled,
   BlockJavaScript,
@@ -35,6 +36,7 @@ import {
 interface Props {
   actions: {
     shieldsToggled: ShieldsToggled
+    reportBrokenSite: ReportBrokenSite
     blockAdsTrackers: BlockAdsTrackers
     httpsEverywhereToggled: HttpsEverywhereToggled
     blockJavaScript: BlockJavaScript

components/brave_extension/extension/brave_extension/components/simpleView/header.tsx

@@ -20,7 +20,7 @@ import {
   TotalBlockedStatsNumber,
   TotalBlockedStatsText,
   DisabledContentView,
-  ShieldIcon,
+  ShieldsButton,
   DisabledContentText,
   Toggle
  } from 'brave-ui/features/shields'
@@ -42,6 +42,7 @@ interface CommonProps {
   hostname: string
   shieldsToggled: ShieldsToggled
   toggleReadOnlyView: () => void
+  reportBrokenSite: () => void
 }
 
 interface BlockedItemsProps {
@@ -72,7 +73,7 @@ export default class Header extends React.PureComponent<Props, {}> {
   }
 
   render () {
-    const { enabled, favicon, hostname, toggleReadOnlyView } = this.props
+    const { enabled, favicon, hostname, toggleReadOnlyView, reportBrokenSite } = this.props
     return (
       <ShieldsHeader status={enabled ? 'enabled' : 'disabled'}>
         <MainToggle status={enabled ? 'enabled' : 'disabled'}>
@@ -106,8 +107,8 @@ export default class Header extends React.PureComponent<Props, {}> {
             )
             : (
               <DisabledContentView>
-                <div><ShieldIcon /></div>
                 <DisabledContentText>{getLocale('disabledMessage')}</DisabledContentText>
+                <ShieldsButton level='secondary' type='default' size='small' onClick={reportBrokenSite} text={getLocale('reportBrokenSite')} />
               </DisabledContentView>
             )
           }

components/brave_extension/extension/brave_extension/components/simpleView/index.tsx

@@ -13,6 +13,7 @@ import Footer from './footer'
 
 import {
   ShieldsToggled,
+  ReportBrokenSite,
   BlockAdsTrackers,
   HttpsEverywhereToggled,
   BlockJavaScript,
@@ -33,6 +34,7 @@ import { getFavicon, isShieldsEnabled } from '../../helpers/shieldsUtils'
 interface Props {
   actions: {
     shieldsToggled: ShieldsToggled
+    reportBrokenSite: ReportBrokenSite
     blockAdsTrackers: BlockAdsTrackers
     httpsEverywhereToggled: HttpsEverywhereToggled
     blockJavaScript: BlockJavaScript
@@ -77,6 +79,7 @@ export default class ShieldsSimpleView extends React.PureComponent<Props, {}> {
           fingerprintingBlocked={shieldsPanelTabData.fingerprintingBlocked}
           shieldsToggled={actions.shieldsToggled}
           toggleReadOnlyView={toggleReadOnlyView}
+          reportBrokenSite={actions.reportBrokenSite}
         />
         <Footer
           enabled={this.isShieldsEnabled}

components/brave_extension/extension/brave_extension/constants/shieldsPanelTypes.ts

@@ -4,6 +4,7 @@
 
 export const SHIELDS_PANEL_DATA_UPDATED = 'SHIELDS_PANEL_DATA_UPDATED'
 export const SHIELDS_TOGGLED = 'SHIELDS_TOGGLED'
+export const REPORT_BROKEN_SITE = 'REPORT_BROKEN_SITE'
 export const RESOURCE_BLOCKED = 'RESOURCE_BLOCKED'
 export const BLOCK_ADS_TRACKERS = 'BLOCK_ADS_TRACKERS'
 export const CONTROLS_TOGGLED = 'CONTROLS_TOGGLED'

components/brave_extension/extension/brave_extension/types/actions/shieldsPanelActions.ts

@@ -41,6 +41,14 @@ export interface ShieldsToggled {
   (setting: BlockOptions): ShieldsToggledReturn
 }
 
+interface ReportBrokenSiteReturn {
+  type: types.REPORT_BROKEN_SITE
+}
+
+export interface ReportBrokenSite {
+  (): ReportBrokenSiteReturn
+}
+
 interface ResourceBlockedReturn {
   type: types.RESOURCE_BLOCKED
   details: BlockDetails
@@ -159,6 +167,7 @@ export interface SetAdvancedViewFirstAccess {
 export type shieldPanelActions =
   ShieldsPanelDataUpdatedReturn |
   ShieldsToggledReturn |
+  ReportBrokenSiteReturn |
   ResourceBlockedReturn |
   BlockAdsTrackersReturn |
   ControlsToggledReturn |

components/brave_extension/extension/brave_extension/types/constants/shieldsPanelTypes.ts

@@ -6,6 +6,7 @@ import * as types from '../../constants/shieldsPanelTypes'
 
 export type SHIELDS_PANEL_DATA_UPDATED = typeof types.SHIELDS_PANEL_DATA_UPDATED
 export type SHIELDS_TOGGLED = typeof types.SHIELDS_TOGGLED
+export type REPORT_BROKEN_SITE = typeof types.REPORT_BROKEN_SITE
 export type RESOURCE_BLOCKED = typeof types.RESOURCE_BLOCKED
 export type BLOCK_ADS_TRACKERS = typeof types.BLOCK_ADS_TRACKERS
 export type CONTROLS_TOGGLED = typeof types.CONTROLS_TOGGLED

components/definitions/chromel.d.ts

@@ -198,6 +198,7 @@ declare namespace chrome.braveShields {
   const getHTTPSEverywhereEnabledAsync: any
   const setNoScriptControlTypeAsync: any
   const getNoScriptControlTypeAsync: any
+  const reportBrokenSite: any
 
   type BraveShieldsViewPreferences = {
     showAdvancedView: boolean