From: Timo Tijhof <krinklemail@gmail.com>
Date: Thu, 11 Aug 2016 01:39:30 +0000 (-0700)
Subject: resourceloader: Make cache-eval in mw.loader.work asynchronous
X-Git-Tag: 1.31.0-rc.0~5348^2~1
X-Git-Url: https://git.heureux-cyclage.org/?a=commitdiff_plain;h=482ad8d9fb2e8273cefc4a5a557604b093944c8b;p=lhc%2Fweb%2Fwiklou.git

resourceloader: Make cache-eval in mw.loader.work asynchronous

* Add 'if !batch.length' in work() to avoid needless initialisation
  of mw.loader.store(). work() can be called without anything in
  the batch because using() will call enqueue() for any non-ready
  modules in order to get a job callback. This will invoke
  work() as side-effect but will have no work to do.

  This was previously here but got moved in 488c5d9.

* Add 'if !implementations.length' to avoid needless scheduling
  of an idle callback when none of the modules in the batch
  are found in local storage (e.g. first view).

Bug: T142129
Change-Id: Icd39423aec35f25162d2443b1f0507f6f0c748a3
---

diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js
index 7ceb5fe9ee..122f232736 100644
--- a/resources/src/mediawiki/mediawiki.js
+++ b/resources/src/mediawiki/mediawiki.js
@@ -1195,7 +1195,7 @@
 					// Force jQuery behaviour to be for crossDomain. Otherwise jQuery would use
 					// XHR for a same domain request instead of <script>, which changes the request
 					// headers (potentially missing a cache hit), and reduces caching in general
-					// since browsers cache XHR much less (if at all). And XHR means we retreive
+					// since browsers cache XHR much less (if at all). And XHR means we retrieve
 					// text, so we'd need to $.globalEval, which then messes up line numbers.
 					crossDomain: true,
 					cache: true
@@ -1667,6 +1667,34 @@
 				}
 			}
 
+			/**
+			 * Evaluate a batch of load.php responses retrieved from mw.loader.store.
+			 *
+			 * @private
+			 * @param {string[]} implementations Array containing pieces of JavaScript code in the
+			 *  form of calls to mw.loader#implement().
+			 * @param {Function} cb Callback in case of failure
+			 * @param {Error} cb.err
+			 */
+			function batchEval( implementations, cb ) {
+				if ( !implementations.length ) {
+					return;
+				}
+				mw.requestIdleCallback( function iterate( deadline ) {
+					while ( implementations[ 0 ] && deadline.timeRemaining() > 5 ) {
+						try {
+							$.globalEval( implementations.shift() );
+						} catch ( err ) {
+							cb( err );
+							return;
+						}
+					}
+					if ( implementations[ 0 ] ) {
+						mw.requestIdleCallback( iterate );
+					}
+				} );
+			}
+
 			/* Public Members */
 			return {
 				/**
@@ -1691,7 +1719,7 @@
 				 * @protected
 				 */
 				work: function () {
-					var q, batch, concatSource, origBatch;
+					var q, batch, implementations, sourceModules;
 
 					batch = [];
 
@@ -1708,50 +1736,50 @@
 						}
 					}
 
+					// Now that the queue has been processed into a batch, clear the queue.
+					// This MUST happen before we initiate any eval or network request. Otherwise,
+					// it is possible for a cached script to instantly trigger the same work queue
+					// again; all before we've cleared it causing each request to include modules
+					// which are already loaded.
+					queue = [];
+
+					if ( !batch.length ) {
+						return;
+					}
+
 					mw.loader.store.init();
 					if ( mw.loader.store.enabled ) {
-						concatSource = [];
-						origBatch = batch;
+						implementations = [];
+						sourceModules = [];
 						batch = $.grep( batch, function ( module ) {
-							var source = mw.loader.store.get( module );
-							if ( source ) {
-								concatSource.push( source );
+							var implementation = mw.loader.store.get( module );
+							if ( implementation ) {
+								implementations.push( implementation );
+								sourceModules.push( module );
 								return false;
 							}
 							return true;
 						} );
-						try {
-							$.globalEval( concatSource.join( ';' ) );
-						} catch ( err ) {
+						batchEval( implementations, function ( err ) {
 							// Not good, the cached mw.loader.implement calls failed! This should
 							// never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
 							// Depending on how corrupt the string is, it is likely that some
 							// modules' implement() succeeded while the ones after the error will
 							// never run and leave their modules in the 'loading' state forever.
-
 							// Since this is an error not caused by an individual module but by
 							// something that infected the implement call itself, don't take any
 							// risks and clear everything in this cache.
 							mw.loader.store.clear();
-							// Re-add the ones still pending back to the batch and let the server
-							// repopulate these modules to the cache.
-							// This means that at most one module will be useless (the one that had
-							// the error) instead of all of them.
 							mw.track( 'resourceloader.exception', { exception: err, source: 'store-eval' } );
-							origBatch = $.grep( origBatch, function ( module ) {
+
+							// Re-add the failed ones that are still pending back to the batch
+							var failed = $.grep( sourceModules, function ( module ) {
 								return registry[ module ].state === 'loading';
 							} );
-							batch = batch.concat( origBatch );
-						}
+							batchRequest( failed );
+						} );
 					}
 
-					// Now that the queue has been processed into a batch, clear up the queue.
-					// This MUST happen before we initiate any network request. Else it's possible
-					// that a script will be locally cached, instantly load, and work the queue
-					// again; all before we've cleared it causing each request to include modules
-					// which are already loaded.
-					queue = [];
-
 					batchRequest( batch );
 				},