chore: Cleanup and add extra pref, b=no-bug, c=tests, tabs

Author: mr-cheffy

locales/en-US/browser/browser/preferences/zen-preferences.ftl

@@ -61,6 +61,8 @@ zen-tabs-close-on-back-with-no-history =
 
 zen-tabs-cycle-by-attribute =
   .label = Ctrl+Tab cycles within Essential or Workspace tabs only
+zen-tabs-cycle-ignore-pending-tabs =
+  .label = Ignore Pending tabs when cycling with Ctrl+Tab
 zen-tabs-cycle-by-attribute-warning = Ctrl+Tab will cycle by recently used order, as it is enabled
 
 zen-look-and-feel-compact-toolbar-themed =

prefs/zen/zen.yaml

@@ -38,5 +38,8 @@
 - name: zen.tabs.close-on-back-with-no-history
   value: true
 
-- name: zen.tabs.cycle-by-attribute
+- name: zen.tabs.ctrl-tab.ignore-essential-tabs
+  value: false
+
+- name: zen.tabs.ctrl-tab.ignore-pending-tabs
   value: false

src/browser/components/preferences/zen-settings.js

@@ -708,28 +708,38 @@ var gZenWorkspacesSettings = {
       },
     };
 
-    var toggleZenCycleByAttrWarning = {
+    let toggleZenCycleByAttrWarning = {
       observe() {
         const warning = document.getElementById('zenTabsCycleByAttributeWarning');
         warning.hidden = !(
-          Services.prefs.getBoolPref('zen.tabs.cycle-by-attribute', false) &&
+          Services.prefs.getBoolPref('zen.tabs.ctrl-tab.ignore-essential-tabs', false) &&
           Services.prefs.getBoolPref('browser.ctrlTab.sortByRecentlyUsed', false)
         );
-      }
-    }
-    toggleZenCycleByAttrWarning.observe() // call it once on initial load
+      },
+    };
+
+    toggleZenCycleByAttrWarning.observe(); // call it once on initial load
 
     Services.prefs.addObserver('zen.glance.enabled', tabsUnloaderPrefListener); // We can use the same listener for both prefs
     Services.prefs.addObserver('zen.workspaces.separate-essentials', tabsUnloaderPrefListener);
     Services.prefs.addObserver('zen.glance.activation-method', tabsUnloaderPrefListener);
-    Services.prefs.addObserver('zen.tabs.cycle-by-attribute', toggleZenCycleByAttrWarning);
+    Services.prefs.addObserver(
+      'zen.tabs.ctrl-tab.ignore-essential-tabs',
+      toggleZenCycleByAttrWarning
+    );
     Services.prefs.addObserver('browser.ctrlTab.sortByRecentlyUsed', toggleZenCycleByAttrWarning);
     window.addEventListener('unload', () => {
       Services.prefs.removeObserver('zen.glance.enabled', tabsUnloaderPrefListener);
       Services.prefs.removeObserver('zen.glance.activation-method', tabsUnloaderPrefListener);
       Services.prefs.removeObserver('zen.workspaces.separate-essentials', tabsUnloaderPrefListener);
-      Services.prefs.removeObserver('zen.tabs.cycle-by-attribute', toggleZenCycleByAttrWarning);
-      Services.prefs.removeObserver('browser.ctrlTab.sortByRecentlyUsed', toggleZenCycleByAttrWarning);
+      Services.prefs.removeObserver(
+        'zen.tabs.ctrl-tab.ignore-essential-tabs',
+        toggleZenCycleByAttrWarning
+      );
+      Services.prefs.removeObserver(
+        'browser.ctrlTab.sortByRecentlyUsed',
+        toggleZenCycleByAttrWarning
+      );
     });
   },
 };
@@ -1152,12 +1162,17 @@ Preferences.addAll([
     default: true,
   },
   {
-    id: 'zen.tabs.cycle-by-attribute',
+    id: 'zen.tabs.ctrl-tab.ignore-essential-tabs',
+    type: 'bool',
+    default: false,
+  },
+  {
+    id: 'zen.tabs.ctrl-tab.ignore-pending-tabs',
     type: 'bool',
     default: false,
   },
   {
-    id: 'browser.ctrlTab.sortByRecentlyUsed',
+    id: 'zen.tabs.close-on-back-with-no-history',
     type: 'bool',
     default: false,
   },

src/browser/components/preferences/zenTabsManagement.inc.xhtml

@@ -29,9 +29,10 @@
       <checkbox id="zenTabsCloseOnBackWithNoHistory"
             data-l10n-id="zen-tabs-close-on-back-with-no-history"
             preference="zen.tabs.close-on-back-with-no-history"/>
-      <checkbox id="zenTabsCycleByAttribute"
-            data-l10n-id="zen-tabs-cycle-by-attribute"
-            preference="zen.tabs.cycle-by-attribute"/>
+      <checkbox data-l10n-id="zen-tabs-cycle-ignore-pending-tabs"
+            preference="zen.tabs.ctrl-tab.ignore-pending-tabs"/>
+      <checkbox data-l10n-id="zen-tabs-cycle-by-attribute"
+            preference="zen.tabs.ctrl-tab.ignore-essential-tabs"/>
       <description id="zenTabsCycleByAttributeWarning"
             class="description-deemphasized"
             data-l10n-id="zen-tabs-cycle-by-attribute-warning"

src/toolkit/content/widgets/tabbox-js.patch

@@ -1,26 +1,32 @@
 diff --git a/toolkit/content/widgets/tabbox.js b/toolkit/content/widgets/tabbox.js
-index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84df604086 100644
+index cfe2da6e199667bd668f117cc8972212c7f57da2..470033466eae0e853855e21b86a0722627f9ed4b 100644
 --- a/toolkit/content/widgets/tabbox.js
 +++ b/toolkit/content/widgets/tabbox.js
-@@ -11,6 +11,17 @@
+@@ -11,6 +11,23 @@
      "resource://gre/modules/AppConstants.sys.mjs"
    );
 
 +  const { XPCOMUtils } = ChromeUtils.importESModule(
 +    "resource://gre/modules/XPCOMUtils.sys.mjs"
 +  );
-+  const lazyPrefs = {};
++  const lazyZenPrefs = {};
 +  XPCOMUtils.defineLazyPreferenceGetter(
-+    lazyPrefs,
++    lazyZenPrefs,
 +    "cycleByAttribute",
-+    "zen.tabs.cycle-by-attribute",
++    "zen.tabs.ctrl-tab.ignore-essential-tabs",
++    false
++  );
++  XPCOMUtils.defineLazyPreferenceGetter(
++    lazyZenPrefs,
++    "ignorePendingTabs",
++    "zen.tabs.ctrl-tab.ignore-pending-tabs",
 +    false
 +  );
 +
    let imports = {};
    ChromeUtils.defineESModuleGetters(imports, {
      ShortcutUtils: "resource://gre/modules/ShortcutUtils.sys.mjs",
-@@ -213,7 +224,7 @@
+@@ -213,7 +230,7 @@
      ) {
        this._inAsyncOperation = false;
        if (oldPanel != this._selectedPanel) {
@@ -29,7 +35,7 @@ index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84
          this._selectedPanel?.classList.add("deck-selected");
        }
        this.setAttribute("selectedIndex", val);
-@@ -697,7 +708,7 @@
+@@ -697,7 +714,7 @@
        if (!tab) {
          return;
        }
@@ -38,15 +44,15 @@ index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84
          if (otherTab != tab && otherTab.selected) {
            otherTab._selected = false;
          }
-@@ -733,6 +744,7 @@
+@@ -733,6 +750,7 @@
       * @param {MozTab|null} [val]
       */
      set selectedItem(val) {
 +      val = window.gZenGlanceManager?.getTabOrGlanceChild(val) || val;
        if (val && !val.selected) {
          // The selectedIndex setter ignores invalid values
          // such as -1 if |val| isn't one of our child nodes.
-@@ -910,7 +922,7 @@
+@@ -910,7 +928,7 @@
          if (tab == startTab) {
            return null;
          }
@@ -55,7 +61,7 @@ index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84
            return tab;
          }
        }
-@@ -972,13 +984,27 @@
+@@ -972,13 +990,30 @@
       * @param {boolean} [aWrap]
       */
      advanceSelectedTab(aDir, aWrap) {
@@ -72,7 +78,10 @@ index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84
 +        if (!tab.visible) {
 +          return false
 +        }
-+        if (!lazyPrefs.cycleByAttribute) {
++        if (lazyZenPrefs.ignorePendingTabs && tab.hasAttribute("pending")) {
++          return false
++        }
++        if (!lazyZenPrefs.cycleByAttribute) {
 +          return true
 +        }
 +        if (startTab.hasAttribute("zen-essential")) {
@@ -84,7 +93,7 @@ index cfe2da6e199667bd668f117cc8972212c7f57da2..3a007eaddd7f9de9d1e4f936113baf84
        // Handle keyboard navigation for a hidden tab that can be selected, like the Firefox View tab,
        // which has a random placement in this.allTabs.
        if (startTab.hidden) {
-@@ -991,7 +1017,7 @@
+@@ -991,7 +1026,7 @@
          newTab = this.findNextTab(startTab, {
            direction: aDir,
            wrap: aWrap,

src/zen/tests/tabs/browser_tabs_cycle_by_attribute.js

@@ -56,7 +56,7 @@ add_setup(async () => {
 
 add_task(async function cycleTabsByAttribute() {
   await SpecialPowers.pushPrefEnv({
-    set: [['zen.tabs.cycle-by-attribute', true]],
+    set: [['zen.tabs.ctrl-tab.ignore-essential-tabs', true]],
   });
 
   const essentialTabs = gBrowser.tabs.filter((tab) => tab.hasAttribute('zen-essential'));