Detect overflow for explicit (un)pinning of toolbar button to overflo…

…w menu

Detect toolbar button in fixed overflow menu:
- Add a call to `getPlacementOfWidget`
- This check covers the case when the toolbar button is explicitly pinned/unpinned to the Overflow menu by the user.

Context:
- The original patch only detected the toolbar button in the non-fixed overflow menu, which only covered the case when the toolbar button was moved into and out of the overflow menu by a window resize.
- Per jaws, the fixed versus non-fixed Overflow menus live in two different areas of the browser chrome, where "the non-fixed overflow panel is the area that is basically an extension of the navigation-toolbar."
- With both checks together, we cover both of the cases in which the toolbar button can be moved into and out of the Overflow menu.

src/experiment_apis/customizableUI/api.js

@@ -1,14 +1,14 @@
 /* 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/. */
-/* global ChromeUtils ExtensionAPI ExtensionCommon */
+/* global ChromeUtils ExtensionAPI */
 
 this.customizableUI = class extends ExtensionAPI {
   getAPI(context) {
-    const {Services} = ChromeUtils.import('resource://gre/modules/Services.jsm');
-    ChromeUtils.import('resource://gre/modules/ExtensionCommon.jsm');
+    const {CustomizableUI} = ChromeUtils.import('resource:///modules/CustomizableUI.jsm');
+    const {ExtensionCommon} = ChromeUtils.import('resource://gre/modules/ExtensionCommon.jsm');
     const {EventManager} = ExtensionCommon;
-    const {CustomizableUI} = ChromeUtils.import('resource:///modules/CustomizableUI.jsm', {});
+    const {Services} = ChromeUtils.import('resource://gre/modules/Services.jsm');
     return {
       customizableUI: {
         onWidgetRemoved: new EventManager(
@@ -27,8 +27,12 @@ this.customizableUI = class extends ExtensionAPI {
           },
         ).api(),
         async isWidgetInOverflow(widgetId) {
+          const {area} = CustomizableUI.getPlacementOfWidget(widgetId);
           const browserWindow = Services.wm.getMostRecentWindow('navigator:browser');
-          return CustomizableUI.getWidget(widgetId).forWindow(browserWindow).overflowed;
+          // First check is for the non-fixed overflow menu (e.g. widget moved by resizing window)
+          // Second is for fixed overflow menu (e.g. widget moved by (un)pinning button to overflow)
+          return (CustomizableUI.getWidget(widgetId).forWindow(browserWindow).overflowed
+            || area === 'widget-overflow-fixed-list');
         },
       },
     };

src/experiment_apis/customizableUI/schema.json

@@ -5,7 +5,7 @@
       {
         "name": "onWidgetRemoved",
         "type": "function",
-        "description": "Fired when a widget is removed from the browser chrome",
+        "description": "Fired when a widget is removed from the browser chrome.",
         "parameters": [
           {
             "name": "widgetId",
@@ -19,7 +19,7 @@
       {
         "name": "isWidgetInOverflow",
         "type": "function",
-        "description": "Returns a boolean for whether or not the provided widget in the provided window is in the overflow menu or not.",
+        "description": "Determine whether or not a widget is in the overflow menu.",
         "async": true,
         "parameters": [
           {