From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Sun, 18 Sep 2016 12:54:36 +0000 (+0200)
Subject: Correct error handling for exceptions in 'user' module
X-Git-Tag: 1.31.0-rc.0~5383^2
X-Git-Url: http://git.cyclocoop.org/%28?a=commitdiff_plain;h=ba257035b07;hp=2e90f89aa95f6f85f0ba82f6bd0b9c8ff77cf777;p=lhc%2Fweb%2Fwiklou.git

Correct error handling for exceptions in 'user' module

Rearrange code so that the try...catch which is supposed to catch
exceptions when evalling code actually catches them. Evaluation of
'user' module was wrapped in `mw.loader.using( 'site' ).always( ... )`,
so it could be executed asynchronously, so try...catch never caught
exceptions from it; they bubbled up to all kinds of weird places and
broke things in confusing ways.

I think the same issue could occur for any module when waiting for
legacy modules to load ('wgResourceLoaderLegacyModules').

Bug: T145970
Change-Id: I91e7d0b4e50c786f7302e30a2b7ed43c3cd0da6c
---

diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/mediawiki/mediawiki.js
index 04807f4e4f..89bb83b99d 100644
--- a/resources/src/mediawiki/mediawiki.js
+++ b/resources/src/mediawiki/mediawiki.js
@@ -1278,35 +1278,46 @@
 				registry[ module ].state = 'executing';
 
 				runScript = function () {
-					var script, markModuleReady, nestedAddScript, legacyWait,
+					var script, markModuleReady, nestedAddScript, legacyWait, implicitDependencies,
 						// Expand to include dependencies since we have to exclude both legacy modules
 						// and their dependencies from the legacyWait (to prevent a circular dependency).
 						legacyModules = resolve( mw.config.get( 'wgResourceLoaderLegacyModules', [] ) );
-					try {
-						script = registry[ module ].script;
-						markModuleReady = function () {
-							registry[ module ].state = 'ready';
-							handlePending( module );
-						};
-						nestedAddScript = function ( arr, callback, i ) {
-							// Recursively call queueModuleScript() in its own callback
-							// for each element of arr.
-							if ( i >= arr.length ) {
-								// We're at the end of the array
-								callback();
-								return;
-							}
 
-							queueModuleScript( arr[ i ], module ).always( function () {
-								nestedAddScript( arr, callback, i + 1 );
-							} );
-						};
+					script = registry[ module ].script;
+					markModuleReady = function () {
+						registry[ module ].state = 'ready';
+						handlePending( module );
+					};
+					nestedAddScript = function ( arr, callback, i ) {
+						// Recursively call queueModuleScript() in its own callback
+						// for each element of arr.
+						if ( i >= arr.length ) {
+							// We're at the end of the array
+							callback();
+							return;
+						}
 
-						legacyWait = ( $.inArray( module, legacyModules ) !== -1 )
-							? $.Deferred().resolve()
-							: mw.loader.using( legacyModules );
+						queueModuleScript( arr[ i ], module ).always( function () {
+							nestedAddScript( arr, callback, i + 1 );
+						} );
+					};
+
+					implicitDependencies = ( $.inArray( module, legacyModules ) !== -1 )
+						? []
+						: legacyModules;
 
-						legacyWait.always( function () {
+					if ( module === 'user' ) {
+						// Implicit dependency on the site module. Not real dependency because
+						// it should run after 'site' regardless of whether it succeeds or fails.
+						implicitDependencies.push( 'site' );
+					}
+
+					legacyWait = implicitDependencies.length
+						? mw.loader.using( implicitDependencies )
+						: $.Deferred().resolve();
+
+					legacyWait.always( function () {
+						try {
 							if ( $.isArray( script ) ) {
 								nestedAddScript( script, markModuleReady, 0 );
 							} else if ( typeof script === 'function' ) {
@@ -1319,29 +1330,21 @@
 								// Site and user modules are legacy scripts that run in the global scope.
 								// This is transported as a string instead of a function to avoid needing
 								// to use string manipulation to undo the function wrapper.
-								if ( module === 'user' ) {
-									// Implicit dependency on the site module. Not real dependency because
-									// it should run after 'site' regardless of whether it succeeds or fails.
-									mw.loader.using( 'site' ).always( function () {
-										$.globalEval( script );
-										markModuleReady();
-									} );
-								} else {
-									$.globalEval( script );
-									markModuleReady();
-								}
+								$.globalEval( script );
+								markModuleReady();
+
 							} else {
 								// Module without script
 								markModuleReady();
 							}
-						} );
-					} catch ( e ) {
-						// This needs to NOT use mw.log because these errors are common in production mode
-						// and not in debug mode, such as when a symbol that should be global isn't exported
-						registry[ module ].state = 'error';
-						mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
-						handlePending( module );
-					}
+						} catch ( e ) {
+							// This needs to NOT use mw.log because these errors are common in production mode
+							// and not in debug mode, such as when a symbol that should be global isn't exported
+							registry[ module ].state = 'error';
+							mw.track( 'resourceloader.exception', { exception: e, module: module, source: 'module-execute' } );
+							handlePending( module );
+						}
+					} );
 				};
 
 				// Add localizations to message system