Support disabling suspendTabsUntilReady in Firefox

gorhill · gorhill · commit 87feb47b5120 · 2019-02-19T12:30:37.000-05:00
The value of `suspendTabsUntilReady` was disregarded in Firefox and
uBO defaulted to always defer tab loading until it was ready.

This commit allows to disable the deferring of tab loading in
Firefox. The new valid values for `suspendTabsUntilReady` are:
- `unset`: leave it to the platform to pick the optimal
  behavior (default)
- `no`: do no suspend tab loading at launch time
- `yes`: suspend tab loading at launch time
diff --git a/src/js/background.js b/src/js/background.js
@@ -53,7 +53,7 @@ const µBlock = (function() { // jshint ignore:line
         requestJournalProcessPeriod: 1000,
         selfieAfter: 11,
         strictBlockingBypassDuration: 120,
-        suspendTabsUntilReady: false,
+        suspendTabsUntilReady: 'unset',
         userResourcesLocation: 'unset'
     };
 
@@ -104,6 +104,11 @@ const µBlock = (function() { // jshint ignore:line
                         if ( out.hasOwnProperty(k) ) { out[k] = o[k]; }
                     }
                     self.log.verbosity = out.consoleLogLevel;
+                    if ( typeof out.suspendTabsUntilReady === 'boolean' ) {
+                        out.suspendTabsUntilReady = out.suspendTabsUntilReady
+                            ? 'yes'
+                            : 'unset';
+                    }
                 }
             }
             catch(ex) {
diff --git a/src/js/storage.js b/src/js/storage.js
@@ -110,6 +110,12 @@
                     this.hiddenSettings[key] = hs[key];
                 }
             }
+            if ( typeof this.hiddenSettings.suspendTabsUntilReady === 'boolean' ) {
+                this.hiddenSettings.suspendTabsUntilReady =
+                    this.hiddenSettings.suspendTabsUntilReady
+                        ? 'yes'
+                        : 'unset';
+            }
         }
         if ( vAPI.localStorage.getItem('immediateHiddenSettings') === null ) {
             this.saveImmediateHiddenSettings();
diff --git a/src/js/traffic.js b/src/js/traffic.js
@@ -1002,8 +1002,10 @@ return {
         if (
             vAPI.net.onBeforeReady instanceof Object &&
             (
-                vAPI.net.onBeforeReady.experimental !== true ||
-                µBlock.hiddenSettings.suspendTabsUntilReady
+                vAPI.net.onBeforeReady.experimental !== true &&
+                µBlock.hiddenSettings.suspendTabsUntilReady !== 'no' ||
+                vAPI.net.onBeforeReady.experimental &&
+                µBlock.hiddenSettings.suspendTabsUntilReady === 'yes'
             )
         ) {
             vAPI.net.onBeforeReady.start();

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ const µBlock = (function() { // jshint ignore:line`
`53`	`53`	`requestJournalProcessPeriod: 1000,`
`54`	`54`	`selfieAfter: 11,`
`55`	`55`	`strictBlockingBypassDuration: 120,`
`56`		`- suspendTabsUntilReady: false,`
	`56`	`+ suspendTabsUntilReady: 'unset',`
`57`	`57`	`userResourcesLocation: 'unset'`
`58`	`58`	`};`
`59`	`59`
`@@ -104,6 +104,11 @@ const µBlock = (function() { // jshint ignore:line`
`104`	`104`	`if ( out.hasOwnProperty(k) ) { out[k] = o[k]; }`
`105`	`105`	`}`
`106`	`106`	`self.log.verbosity = out.consoleLogLevel;`
	`107`	`+ if ( typeof out.suspendTabsUntilReady === 'boolean' ) {`
	`108`	`+ out.suspendTabsUntilReady = out.suspendTabsUntilReady`
	`109`	`+ ? 'yes'`
	`110`	`+ : 'unset';`
	`111`	`+ }`
`107`	`112`	`}`
`108`	`113`	`}`
`109`	`114`	`catch(ex) {`
Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,12 @@`
`110`	`110`	`this.hiddenSettings[key] = hs[key];`
`111`	`111`	`}`
`112`	`112`	`}`
	`113`	`+ if ( typeof this.hiddenSettings.suspendTabsUntilReady === 'boolean' ) {`
	`114`	`+ this.hiddenSettings.suspendTabsUntilReady =`
	`115`	`+ this.hiddenSettings.suspendTabsUntilReady`
	`116`	`+ ? 'yes'`
	`117`	`+ : 'unset';`
	`118`	`+ }`
`113`	`119`	`}`
`114`	`120`	`if ( vAPI.localStorage.getItem('immediateHiddenSettings') === null ) {`
`115`	`121`	`this.saveImmediateHiddenSettings();`
Original file line number	Diff line number	Diff line change
`@@ -1002,8 +1002,10 @@ return {`
`1002`	`1002`	`if (`
`1003`	`1003`	`vAPI.net.onBeforeReady instanceof Object &&`
`1004`	`1004`	`(`
`1005`		`- vAPI.net.onBeforeReady.experimental !== true \|\|`
`1006`		`- µBlock.hiddenSettings.suspendTabsUntilReady`
	`1005`	`+ vAPI.net.onBeforeReady.experimental !== true &&`
	`1006`	`+ µBlock.hiddenSettings.suspendTabsUntilReady !== 'no' \|\|`
	`1007`	`+ vAPI.net.onBeforeReady.experimental &&`
	`1008`	`+ µBlock.hiddenSettings.suspendTabsUntilReady === 'yes'`
`1007`	`1009`	`)`
`1008`	`1010`	`) {`
`1009`	`1011`	`vAPI.net.onBeforeReady.start();`