Bug 1650956 - browser.tabs.remove() now calls removeTabs(). r=robwu

Removing multiple tabs via extensions now calls `gBrowser.removeTabs()`
once for each window that has tabs being removed. Also adds automated
browser tests for removing one tab or multiple tabs.

Differential Revision: https://phabricator.services.mozilla.com/D93438

browser/base/content/tabbrowser.js

@@ -3222,7 +3222,7 @@
       this.removeTabs(selectedTabs);
     },
 
-    removeTabs(tabs) {
+    removeTabs(tabs, { animate = true } = {}) {
       // When 'closeWindowWithLastTab' pref is enabled, closing all tabs
       // can be considered equivalent to closing the window.
       if (
@@ -3240,7 +3240,8 @@
       try {
         let tabsWithBeforeUnload = [];
         let lastToClose;
-        let aParams = { animate: true, prewarmed: true };
+        let aParams = { animate, prewarmed: true };
+
         for (let tab of tabs) {
           if (tab.selected) {
             lastToClose = tab;

browser/components/extensions/parent/ext-tabs.js

@@ -48,7 +48,7 @@ XPCOMUtils.defineLazyGetter(this, "strBundle", function() {
   );
 });
 
-var { ExtensionError } = ExtensionUtils;
+var { DefaultMap, ExtensionError } = ExtensionUtils;
 
 const TABHIDE_PREFNAME = "extensions.webextensions.tabhide.enabled";
 
@@ -803,8 +803,25 @@ this.tabs = class extends ExtensionAPI {
         },
 
         async remove(tabIds) {
-          for (let nativeTab of getNativeTabsFromIDArray(tabIds)) {
-            nativeTab.ownerGlobal.gBrowser.removeTab(nativeTab);
+          let nativeTabs = getNativeTabsFromIDArray(tabIds);
+
+          if (nativeTabs.length === 1) {
+            nativeTabs[0].ownerGlobal.gBrowser.removeTab(nativeTabs[0]);
+            return;
+          }
+
+          // Or for multiple tabs, first group them by window
+          let windowTabMap = new DefaultMap(() => []);
+          for (let nativeTab of nativeTabs) {
+            windowTabMap.get(nativeTab.ownerGlobal).push(nativeTab);
+          }
+
+          // Then make one call to removeTabs() for each window, to keep the
+          // count accurate for SessionStore.getLastClosedTabCount().
+          // Note: always passing {animate: false} so that way all tabs are
+          // actually closed when the browser.tabs.remove() promise resolves
+          for (let [eachWindow, tabsToClose] of windowTabMap.entries()) {
+            eachWindow.gBrowser.removeTabs(tabsToClose, { animate: false });
           }
         },
 

browser/components/extensions/test/browser/browser.ini

@@ -261,6 +261,7 @@ skip-if = !e10s
 [browser_ext_tabs_readerMode.js]
 [browser_ext_tabs_reload.js]
 [browser_ext_tabs_reload_bypass_cache.js]
+[browser_ext_tabs_remove.js]
 [browser_ext_tabs_saveAsPDF.js]
 [browser_ext_tabs_sendMessage.js]
 [browser_ext_tabs_sharingState.js]

browser/components/extensions/test/browser/browser_ext_tabs_remove.js

@@ -0,0 +1,206 @@
+/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* vim: set sts=2 sw=2 et tw=80: */
+"use strict";
+
+add_task(async function undoCloseAfterExtRemovesOneTab() {
+  let initialTab = gBrowser.selectedTab;
+
+  let extension = ExtensionTestUtils.loadExtension({
+    manifest: {
+      permissions: ["tabs"],
+    },
+
+    background: async function() {
+      let tabs = await browser.tabs.query({});
+
+      browser.test.assertEq(3, tabs.length, "Should have 3 tabs");
+
+      let tabIdsToRemove = (
+        await browser.tabs.query({
+          url: "https://example.com/closeme/*",
+        })
+      ).map(tab => tab.id);
+
+      await browser.tabs.remove(tabIdsToRemove);
+      browser.test.sendMessage("removedtabs");
+    },
+  });
+
+  await Promise.all([
+    BrowserTestUtils.openNewForegroundTab(gBrowser, "https://example.com/1"),
+    BrowserTestUtils.openNewForegroundTab(
+      gBrowser,
+      "https://example.com/closeme/2"
+    ),
+  ]);
+
+  await extension.startup();
+  await extension.awaitMessage("removedtabs");
+
+  is(
+    gBrowser.tabs.length,
+    2,
+    "Once extension has closed a tab, there should be 2 tabs open"
+  );
+
+  is(
+    SessionStore.getLastClosedTabCount(window),
+    1,
+    "SessionStore should know that one tab was closed"
+  );
+
+  undoCloseTab();
+
+  is(
+    gBrowser.tabs.length,
+    3,
+    "All tabs should be restored for a total of 3 tabs"
+  );
+
+  await BrowserTestUtils.waitForEvent(gBrowser.tabs[2], "SSTabRestored");
+
+  is(
+    gBrowser.tabs[2].linkedBrowser.currentURI.spec,
+    "https://example.com/closeme/2",
+    "Restored tab at index 2 should have expected URL"
+  );
+
+  await extension.unload();
+  gBrowser.removeAllTabsBut(initialTab);
+});
+
+add_task(async function undoCloseAfterExtRemovesMultipleTabs() {
+  let initialTab = gBrowser.selectedTab;
+
+  let extension = ExtensionTestUtils.loadExtension({
+    manifest: {
+      permissions: ["tabs"],
+    },
+
+    background: async function() {
+      let tabIds = (await browser.tabs.query({})).map(tab => tab.id);
+
+      browser.test.assertEq(
+        8,
+        tabIds.length,
+        "Should have 8 total tabs (4 in each window: the initial blank tab and the 3 opened by this test)"
+      );
+
+      let tabIdsToRemove = (
+        await browser.tabs.query({
+          url: "https://example.com/closeme/*",
+        })
+      ).map(tab => tab.id);
+
+      await browser.tabs.remove(tabIdsToRemove);
+
+      browser.test.sendMessage("removedtabs");
+    },
+  });
+
+  await Promise.all([
+    BrowserTestUtils.openNewForegroundTab(gBrowser, "https://example.com/1"),
+    BrowserTestUtils.openNewForegroundTab(
+      gBrowser,
+      "https://example.com/closeme/2"
+    ),
+    BrowserTestUtils.openNewForegroundTab(
+      gBrowser,
+      "https://example.com/closeme/3"
+    ),
+  ]);
+
+  let window2 = await BrowserTestUtils.openNewBrowserWindow();
+
+  await Promise.all([
+    BrowserTestUtils.openNewForegroundTab(
+      window2.gBrowser,
+      "https://example.com/4"
+    ),
+    BrowserTestUtils.openNewForegroundTab(
+      window2.gBrowser,
+      "https://example.com/closeme/5"
+    ),
+    BrowserTestUtils.openNewForegroundTab(
+      window2.gBrowser,
+      "https://example.com/closeme/6"
+    ),
+  ]);
+
+  await extension.startup();
+  await extension.awaitMessage("removedtabs");
+
+  is(
+    gBrowser.tabs.length,
+    2,
+    "Original window should have 2 tabs still open, after closing tabs"
+  );
+
+  is(
+    window2.gBrowser.tabs.length,
+    2,
+    "Second window should have 2 tabs still open, after closing tabs"
+  );
+
+  is(
+    SessionStore.getLastClosedTabCount(window),
+    2,
+    "SessionStore of original window should know that multiple tabs were closed"
+  );
+
+  is(
+    SessionStore.getLastClosedTabCount(window2),
+    2,
+    "SessionStore of second window should know that multiple tabs were closed"
+  );
+
+  undoCloseTab();
+  window2.undoCloseTab();
+
+  is(
+    gBrowser.tabs.length,
+    4,
+    "All tabs in original window should be restored for a total of 4 tabs"
+  );
+
+  is(
+    window2.gBrowser.tabs.length,
+    4,
+    "All tabs in second window should be restored for a total of 4 tabs"
+  );
+
+  await Promise.all([
+    BrowserTestUtils.waitForEvent(gBrowser.tabs[2], "SSTabRestored"),
+    BrowserTestUtils.waitForEvent(gBrowser.tabs[3], "SSTabRestored"),
+    BrowserTestUtils.waitForEvent(window2.gBrowser.tabs[2], "SSTabRestored"),
+    BrowserTestUtils.waitForEvent(window2.gBrowser.tabs[3], "SSTabRestored"),
+  ]);
+
+  is(
+    gBrowser.tabs[2].linkedBrowser.currentURI.spec,
+    "https://example.com/closeme/2",
+    "Original window restored tab at index 2 should have expected URL"
+  );
+
+  is(
+    gBrowser.tabs[3].linkedBrowser.currentURI.spec,
+    "https://example.com/closeme/3",
+    "Original window restored tab at index 3 should have expected URL"
+  );
+
+  is(
+    window2.gBrowser.tabs[2].linkedBrowser.currentURI.spec,
+    "https://example.com/closeme/5",
+    "Second window restored tab at index 2 should have expected URL"
+  );
+
+  is(
+    window2.gBrowser.tabs[3].linkedBrowser.currentURI.spec,
+    "https://example.com/closeme/6",
+    "Second window restored tab at index 3 should have expected URL"
+  );
+
+  await extension.unload();
+  await BrowserTestUtils.closeWindow(window2);
+  gBrowser.removeAllTabsBut(initialTab);
+});