resourceloader: Simplify StringSet fallback
[lhc/web/wiklou.git] / resources / src / startup / mediawiki.js
1 /**
2 * Base library for MediaWiki.
3 *
4 * Exposed globally as `mw`, with `mediaWiki` as alias.
5 *
6 * @class mw
7 * @alternateClassName mediaWiki
8 * @singleton
9 */
10 /* global $VARS, $CODE */
11
12 ( function () {
13 'use strict';
14
15 var mw, StringSet, log,
16 trackQueue = [];
17
18 /**
19 * FNV132 hash function
20 *
21 * This function implements the 32-bit version of FNV-1.
22 * It is equivalent to hash( 'fnv132', ... ) in PHP, except
23 * its output is base 36 rather than hex.
24 * See <https://en.wikipedia.org/wiki/FNV_hash_function>
25 *
26 * @private
27 * @param {string} str String to hash
28 * @return {string} hash as an seven-character base 36 string
29 */
30 function fnv132( str ) {
31 /* eslint-disable no-bitwise */
32 var hash = 0x811C9DC5,
33 i;
34
35 for ( i = 0; i < str.length; i++ ) {
36 hash += ( hash << 1 ) + ( hash << 4 ) + ( hash << 7 ) + ( hash << 8 ) + ( hash << 24 );
37 hash ^= str.charCodeAt( i );
38 }
39
40 hash = ( hash >>> 0 ).toString( 36 );
41 while ( hash.length < 7 ) {
42 hash = '0' + hash;
43 }
44
45 return hash;
46 /* eslint-enable no-bitwise */
47 }
48
49 function defineFallbacks() {
50 // <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set>
51 /**
52 * @private
53 * @class
54 */
55 StringSet = window.Set || function StringSet() {
56 var set = Object.create( null );
57 this.add = function ( value ) {
58 set[ value ] = true;
59 };
60 this.has = function ( value ) {
61 return value in set;
62 };
63 };
64 }
65
66 /**
67 * Alias property to the global object.
68 *
69 * @private
70 * @static
71 * @member mw.Map
72 * @param {mw.Map} map
73 * @param {string} key
74 * @param {Mixed} value
75 */
76 function setGlobalMapValue( map, key, value ) {
77 map.values[ key ] = value;
78 log.deprecate(
79 window,
80 key,
81 value,
82 // Deprecation notice for mw.config globals (T58550, T72470)
83 map === mw.config && 'Use mw.config instead.'
84 );
85 }
86
87 /**
88 * Log a message to window.console, if possible.
89 *
90 * Useful to force logging of some errors that are otherwise hard to detect (i.e., this logs
91 * also in production mode). Gets console references in each invocation instead of caching the
92 * reference, so that debugging tools loaded later are supported (e.g. Firebug Lite in IE).
93 *
94 * @private
95 * @param {string} topic Stream name passed by mw.track
96 * @param {Object} data Data passed by mw.track
97 * @param {Error} [data.exception]
98 * @param {string} data.source Error source
99 * @param {string} [data.module] Name of module which caused the error
100 */
101 function logError( topic, data ) {
102 /* eslint-disable no-console */
103 var msg,
104 e = data.exception,
105 source = data.source,
106 module = data.module,
107 console = window.console;
108
109 if ( console && console.log ) {
110 msg = ( e ? 'Exception' : 'Error' ) + ' in ' + source;
111 if ( module ) {
112 msg += ' in module ' + module;
113 }
114 msg += ( e ? ':' : '.' );
115 console.log( msg );
116
117 // If we have an exception object, log it to the warning channel to trigger
118 // proper stacktraces in browsers that support it.
119 if ( e && console.warn ) {
120 console.warn( e );
121 }
122 }
123 /* eslint-enable no-console */
124 }
125
126 /**
127 * Create an object that can be read from or written to via methods that allow
128 * interaction both with single and multiple properties at once.
129 *
130 * @private
131 * @class mw.Map
132 *
133 * @constructor
134 * @param {boolean} [global=false] Whether to synchronise =values to the global
135 * window object (for backwards-compatibility with mw.config; T72470). Values are
136 * copied in one direction only. Changes to globals do not reflect in the map.
137 */
138 function Map( global ) {
139 this.values = Object.create( null );
140 if ( global === true ) {
141 // Override #set to also set the global variable
142 this.set = function ( selection, value ) {
143 var s;
144 if ( arguments.length > 1 ) {
145 if ( typeof selection !== 'string' ) {
146 return false;
147 }
148 setGlobalMapValue( this, selection, value );
149 return true;
150 }
151 if ( typeof selection === 'object' ) {
152 for ( s in selection ) {
153 setGlobalMapValue( this, s, selection[ s ] );
154 }
155 return true;
156 }
157 return false;
158 };
159 }
160 }
161
162 Map.prototype = {
163 constructor: Map,
164
165 /**
166 * Get the value of one or more keys.
167 *
168 * If called with no arguments, all values are returned.
169 *
170 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
171 * @param {Mixed} [fallback=null] Value for keys that don't exist.
172 * @return {Mixed|Object|null} If selection was a string, returns the value,
173 * If selection was an array, returns an object of key/values.
174 * If no selection is passed, a new object with all key/values is returned.
175 */
176 get: function ( selection, fallback ) {
177 var results, i;
178 fallback = arguments.length > 1 ? fallback : null;
179
180 if ( Array.isArray( selection ) ) {
181 results = {};
182 for ( i = 0; i < selection.length; i++ ) {
183 if ( typeof selection[ i ] === 'string' ) {
184 results[ selection[ i ] ] = selection[ i ] in this.values ?
185 this.values[ selection[ i ] ] :
186 fallback;
187 }
188 }
189 return results;
190 }
191
192 if ( typeof selection === 'string' ) {
193 return selection in this.values ?
194 this.values[ selection ] :
195 fallback;
196 }
197
198 if ( selection === undefined ) {
199 results = {};
200 for ( i in this.values ) {
201 results[ i ] = this.values[ i ];
202 }
203 return results;
204 }
205
206 // Invalid selection key
207 return fallback;
208 },
209
210 /**
211 * Set one or more key/value pairs.
212 *
213 * @param {string|Object} selection Key to set value for, or object mapping keys to values
214 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
215 * @return {boolean} True on success, false on failure
216 */
217 set: function ( selection, value ) {
218 var s;
219 // Use `arguments.length` because `undefined` is also a valid value.
220 if ( arguments.length > 1 ) {
221 if ( typeof selection !== 'string' ) {
222 return false;
223 }
224 this.values[ selection ] = value;
225 return true;
226 }
227 if ( typeof selection === 'object' ) {
228 for ( s in selection ) {
229 this.values[ s ] = selection[ s ];
230 }
231 return true;
232 }
233 return false;
234 },
235
236 /**
237 * Check if one or more keys exist.
238 *
239 * @param {Mixed} selection Key or array of keys to check
240 * @return {boolean} True if the key(s) exist
241 */
242 exists: function ( selection ) {
243 var i;
244 if ( Array.isArray( selection ) ) {
245 for ( i = 0; i < selection.length; i++ ) {
246 if ( typeof selection[ i ] !== 'string' || !( selection[ i ] in this.values ) ) {
247 return false;
248 }
249 }
250 return true;
251 }
252 return typeof selection === 'string' && selection in this.values;
253 }
254 };
255
256 defineFallbacks();
257
258 /* eslint-disable no-console */
259 log = ( function () {
260 /**
261 * Write a verbose message to the browser's console in debug mode.
262 *
263 * This method is mainly intended for verbose logging. It is a no-op in production mode.
264 * In ResourceLoader debug mode, it will use the browser's console if available, with
265 * fallback to creating a console interface in the DOM and logging messages there.
266 *
267 * See {@link mw.log} for other logging methods.
268 *
269 * @member mw
270 * @param {...string} msg Messages to output to console.
271 */
272 var log = function () {},
273 console = window.console;
274
275 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
276 // when adding or removing mw.log methods below!
277
278 /**
279 * Collection of methods to help log messages to the console.
280 *
281 * @class mw.log
282 * @singleton
283 */
284
285 /**
286 * Write a message to the browser console's warning channel.
287 *
288 * This method is a no-op in browsers that don't implement the Console API.
289 *
290 * @param {...string} msg Messages to output to console
291 */
292 log.warn = console && console.warn && Function.prototype.bind ?
293 Function.prototype.bind.call( console.warn, console ) :
294 function () {};
295
296 /**
297 * Write a message to the browser console's error channel.
298 *
299 * Most browsers also print a stacktrace when calling this method if the
300 * argument is an Error object.
301 *
302 * This method is a no-op in browsers that don't implement the Console API.
303 *
304 * @since 1.26
305 * @param {...Mixed} msg Messages to output to console
306 */
307 log.error = console && console.error && Function.prototype.bind ?
308 Function.prototype.bind.call( console.error, console ) :
309 function () {};
310
311 /**
312 * Create a property on a host object that, when accessed, will produce
313 * a deprecation warning in the console.
314 *
315 * @param {Object} obj Host object of deprecated property
316 * @param {string} key Name of property to create in `obj`
317 * @param {Mixed} val The value this property should return when accessed
318 * @param {string} [msg] Optional text to include in the deprecation message
319 * @param {string} [logName=key] Optional custom name for the feature.
320 * This is used instead of `key` in the message and `mw.deprecate` tracking.
321 */
322 log.deprecate = !Object.defineProperty ? function ( obj, key, val ) {
323 obj[ key ] = val;
324 } : function ( obj, key, val, msg, logName ) {
325 var stacks;
326 function maybeLog() {
327 var name,
328 trace = new Error().stack;
329 if ( !stacks ) {
330 stacks = new StringSet();
331 }
332 if ( !stacks.has( trace ) ) {
333 stacks.add( trace );
334 name = logName || key;
335 mw.track( 'mw.deprecate', name );
336 mw.log.warn(
337 'Use of "' + name + '" is deprecated.' + ( msg ? ( ' ' + msg ) : '' )
338 );
339 }
340 }
341 // Support: Safari 5.0
342 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
343 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
344 try {
345 Object.defineProperty( obj, key, {
346 configurable: true,
347 enumerable: true,
348 get: function () {
349 maybeLog();
350 return val;
351 },
352 set: function ( newVal ) {
353 maybeLog();
354 val = newVal;
355 }
356 } );
357 } catch ( err ) {
358 obj[ key ] = val;
359 }
360 };
361
362 return log;
363 }() );
364 /* eslint-enable no-console */
365
366 /**
367 * @class mw
368 */
369 mw = {
370 redefineFallbacksForTest: function () {
371 if ( !window.QUnit ) {
372 throw new Error( 'Reset not allowed outside unit tests' );
373 }
374 defineFallbacks();
375 },
376
377 /**
378 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
379 *
380 * On browsers that implement the Navigation Timing API, this function will produce
381 * floating-point values with microsecond precision that are guaranteed to be monotonic.
382 * On all other browsers, it will fall back to using `Date`.
383 *
384 * @return {number} Current time
385 */
386 now: function () {
387 // Optimisation: Define the shortcut on first call, not at module definition.
388 var perf = window.performance,
389 navStart = perf && perf.timing && perf.timing.navigationStart;
390
391 // Define the relevant shortcut
392 mw.now = navStart && typeof perf.now === 'function' ?
393 function () { return navStart + perf.now(); } :
394 Date.now;
395
396 return mw.now();
397 },
398
399 /**
400 * List of all analytic events emitted so far.
401 *
402 * @private
403 * @property {Array}
404 */
405 trackQueue: trackQueue,
406
407 track: function ( topic, data ) {
408 trackQueue.push( { topic: topic, timeStamp: mw.now(), data: data } );
409 // The base module extends this method to fire events here
410 },
411
412 /**
413 * Track an early error event via mw.track and send it to the window console.
414 *
415 * @private
416 * @param {string} topic Topic name
417 * @param {Object} data Data describing the event, encoded as an object; see mw#logError
418 */
419 trackError: function ( topic, data ) {
420 mw.track( topic, data );
421 logError( topic, data );
422 },
423
424 // Expose Map constructor
425 Map: Map,
426
427 /**
428 * Map of configuration values.
429 *
430 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
431 * on mediawiki.org.
432 *
433 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
434 * global `window` object.
435 *
436 * @property {mw.Map} config
437 */
438 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
439 config: null,
440
441 /**
442 * Empty object for third-party libraries, for cases where you don't
443 * want to add a new global, or the global is bad and needs containment
444 * or wrapping.
445 *
446 * @property
447 */
448 libs: {},
449
450 /**
451 * Access container for deprecated functionality that can be moved from
452 * from their legacy location and attached to this object (e.g. a global
453 * function that is deprecated and as stop-gap can be exposed through here).
454 *
455 * This was reserved for future use but never ended up being used.
456 *
457 * @deprecated since 1.22 Let deprecated identifiers keep their original name
458 * and use mw.log#deprecate to create an access container for tracking.
459 * @property
460 */
461 legacy: {},
462
463 /**
464 * Store for messages.
465 *
466 * @property {mw.Map}
467 */
468 messages: new Map(),
469
470 /**
471 * Store for templates associated with a module.
472 *
473 * @property {mw.Map}
474 */
475 templates: new Map(),
476
477 // Expose mw.log
478 log: log,
479
480 /**
481 * Client for ResourceLoader server end point.
482 *
483 * This client is in charge of maintaining the module registry and state
484 * machine, initiating network (batch) requests for loading modules, as
485 * well as dependency resolution and execution of source code.
486 *
487 * For more information, refer to
488 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
489 *
490 * @class mw.loader
491 * @singleton
492 */
493 loader: ( function () {
494
495 /**
496 * Fired via mw.track on various resource loading errors.
497 *
498 * @event resourceloader_exception
499 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
500 * object, but in theory module code could manually throw something else, and that
501 * might also end up here.
502 * @param {string} [module] Name of the module which caused the error. Omitted if the
503 * error is not module-related or the module cannot be easily identified due to
504 * batched handling.
505 * @param {string} source Source of the error. Possible values:
506 *
507 * - style: stylesheet error (only affects old IE where a special style loading method
508 * is used)
509 * - load-callback: exception thrown by user callback
510 * - module-execute: exception thrown by module code
511 * - resolve: failed to sort dependencies for a module in mw.loader.load
512 * - store-eval: could not evaluate module code cached in localStorage
513 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
514 * - store-localstorage-json: JSON conversion error in mw.loader.store
515 * - store-localstorage-update: localStorage conversion error in mw.loader.store.
516 */
517
518 /**
519 * Fired via mw.track on resource loading error conditions.
520 *
521 * @event resourceloader_assert
522 * @param {string} source Source of the error. Possible values:
523 *
524 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
525 * bug; see <https://phabricator.wikimedia.org/T59567> for details
526 */
527
528 /**
529 * Mapping of registered modules.
530 *
531 * See #implement and #execute for exact details on support for script, style and messages.
532 *
533 * Format:
534 *
535 * {
536 * 'moduleName': {
537 * // From mw.loader.register()
538 * 'version': '########' (hash)
539 * 'dependencies': ['required.foo', 'bar.also', ...]
540 * 'group': 'somegroup', (or) null
541 * 'source': 'local', (or) 'anotherwiki'
542 * 'skip': 'return !!window.Example', (or) null
543 * 'module': export Object
544 *
545 * // Set from execute() or mw.loader.state()
546 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
547 *
548 * // Optionally added at run-time by mw.loader.implement()
549 * 'skipped': true
550 * 'script': closure, array of urls, or string
551 * 'style': { ... } (see #execute)
552 * 'messages': { 'key': 'value', ... }
553 * }
554 * }
555 *
556 * State machine:
557 *
558 * - `registered`:
559 * The module is known to the system but not yet required.
560 * Meta data is registered via mw.loader#register. Calls to that method are
561 * generated server-side by the startup module.
562 * - `loading`:
563 * The module was required through mw.loader (either directly or as dependency of
564 * another module). The client will fetch module contents from the server.
565 * The contents are then stashed in the registry via mw.loader#implement.
566 * - `loaded`:
567 * The module has been loaded from the server and stashed via mw.loader#implement.
568 * Once the module has no more dependencies in-flight, the module will be executed,
569 * controlled via #requestPropagation and #doPropagation.
570 * - `executing`:
571 * The module is being executed.
572 * - `ready`:
573 * The module has been successfully executed.
574 * - `error`:
575 * The module (or one of its dependencies) produced an error during execution.
576 * - `missing`:
577 * The module was registered client-side and requested, but the server denied knowledge
578 * of the module's existence.
579 *
580 * @property
581 * @private
582 */
583 var registry = Object.create( null ),
584 // Mapping of sources, keyed by source-id, values are strings.
585 //
586 // Format:
587 //
588 // {
589 // 'sourceId': 'http://example.org/w/load.php'
590 // }
591 //
592 sources = Object.create( null ),
593
594 // For queueModuleScript()
595 handlingPendingRequests = false,
596 pendingRequests = [],
597
598 // List of modules to be loaded
599 queue = [],
600
601 /**
602 * List of callback jobs waiting for modules to be ready.
603 *
604 * Jobs are created by #enqueue() and run by #doPropagation().
605 * Typically when a job is created for a module, the job's dependencies contain
606 * both the required module and all its recursive dependencies.
607 *
608 * Format:
609 *
610 * {
611 * 'dependencies': [ module names ],
612 * 'ready': Function callback
613 * 'error': Function callback
614 * }
615 *
616 * @property {Object[]} jobs
617 * @private
618 */
619 jobs = [],
620
621 // For #requestPropagation() and #doPropagation()
622 willPropagate = false,
623 errorModules = [],
624
625 /**
626 * @private
627 * @property {Array} baseModules
628 */
629 baseModules = $VARS.baseModules,
630
631 /**
632 * For #addEmbeddedCSS() and #addLink()
633 *
634 * @private
635 * @property {HTMLElement|null} marker
636 */
637 marker = document.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
638
639 // For #addEmbeddedCSS()
640 nextCssBuffer,
641 rAF = window.requestAnimationFrame || setTimeout;
642
643 /**
644 * Create a new style element and add it to the DOM.
645 *
646 * @private
647 * @param {string} text CSS text
648 * @param {Node|null} [nextNode] The element where the style tag
649 * should be inserted before
650 * @return {HTMLElement} Reference to the created style element
651 */
652 function newStyleTag( text, nextNode ) {
653 var el = document.createElement( 'style' );
654 el.appendChild( document.createTextNode( text ) );
655 if ( nextNode && nextNode.parentNode ) {
656 nextNode.parentNode.insertBefore( el, nextNode );
657 } else {
658 document.head.appendChild( el );
659 }
660 return el;
661 }
662
663 /**
664 * @private
665 * @param {Object} cssBuffer
666 */
667 function flushCssBuffer( cssBuffer ) {
668 var i;
669 // Mark this object as inactive now so that further calls to addEmbeddedCSS() from
670 // the callbacks go to a new buffer instead of this one (T105973)
671 cssBuffer.active = false;
672 newStyleTag( cssBuffer.cssText, marker );
673 for ( i = 0; i < cssBuffer.callbacks.length; i++ ) {
674 cssBuffer.callbacks[ i ]();
675 }
676 }
677
678 /**
679 * Add a bit of CSS text to the current browser page.
680 *
681 * The creation and insertion of the `<style>` element is debounced for two reasons:
682 *
683 * - Performing the insertion before the next paint round via requestAnimationFrame
684 * avoids forced or wasted style recomputations, which are expensive in browsers.
685 * - Reduce how often new stylesheets are inserted by letting additional calls to this
686 * function accumulate into a buffer for at least one JavaScript tick. Modules are
687 * received from the server in batches, which means there is likely going to be many
688 * calls to this function in a row within the same tick / the same call stack.
689 * See also T47810.
690 *
691 * @private
692 * @param {string} cssText CSS text to be added in a `<style>` tag.
693 * @param {Function} callback Called after the insertion has occurred
694 */
695 function addEmbeddedCSS( cssText, callback ) {
696 // Create a buffer if:
697 // - We don't have one yet.
698 // - The previous one is closed.
699 // - The next CSS chunk syntactically needs to be at the start of a stylesheet (T37562).
700 if ( !nextCssBuffer || nextCssBuffer.active === false || cssText.slice( 0, '@import'.length ) === '@import' ) {
701 nextCssBuffer = {
702 cssText: '',
703 callbacks: [],
704 active: null
705 };
706 }
707
708 // Linebreak for somewhat distinguishable sections
709 nextCssBuffer.cssText += '\n' + cssText;
710 nextCssBuffer.callbacks.push( callback );
711
712 if ( nextCssBuffer.active === null ) {
713 nextCssBuffer.active = true;
714 // The flushCssBuffer callback has its parameter bound by reference, which means
715 // 1) We can still extend the buffer from our object reference after this point.
716 // 2) We can safely re-assign the variable (not the object) to start a new buffer.
717 rAF( flushCssBuffer.bind( null, nextCssBuffer ) );
718 }
719 }
720
721 /**
722 * @private
723 * @param {Array} modules List of module names
724 * @return {string} Hash of concatenated version hashes.
725 */
726 function getCombinedVersion( modules ) {
727 var hashes = modules.reduce( function ( result, module ) {
728 return result + registry[ module ].version;
729 }, '' );
730 return fnv132( hashes );
731 }
732
733 /**
734 * Determine whether all dependencies are in state 'ready', which means we may
735 * execute the module or job now.
736 *
737 * @private
738 * @param {Array} modules Names of modules to be checked
739 * @return {boolean} True if all modules are in state 'ready', false otherwise
740 */
741 function allReady( modules ) {
742 var i;
743 for ( i = 0; i < modules.length; i++ ) {
744 if ( mw.loader.getState( modules[ i ] ) !== 'ready' ) {
745 return false;
746 }
747 }
748 return true;
749 }
750
751 /**
752 * Determine whether all direct and base dependencies are in state 'ready'
753 *
754 * @private
755 * @param {string} module Name of the module to be checked
756 * @return {boolean} True if all direct/base dependencies are in state 'ready'; false otherwise
757 */
758 function allWithImplicitReady( module ) {
759 return allReady( registry[ module ].dependencies ) &&
760 ( baseModules.indexOf( module ) !== -1 || allReady( baseModules ) );
761 }
762
763 /**
764 * Determine whether all dependencies are in state 'ready', which means we may
765 * execute the module or job now.
766 *
767 * @private
768 * @param {Array} modules Names of modules to be checked
769 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
770 */
771 function anyFailed( modules ) {
772 var i, state;
773 for ( i = 0; i < modules.length; i++ ) {
774 state = mw.loader.getState( modules[ i ] );
775 if ( state === 'error' || state === 'missing' ) {
776 return true;
777 }
778 }
779 return false;
780 }
781
782 /**
783 * Handle propagation of module state changes and reactions to them.
784 *
785 * - When a module reaches a failure state, this should be propagated to
786 * modules that depend on the failed module.
787 * - When a module reaches a final state, pending job callbacks for the
788 * module from mw.loader.using() should be called.
789 * - When a module reaches the 'ready' state from #execute(), consider
790 * executing dependant modules now having their dependencies satisfied.
791 * - When a module reaches the 'loaded' state from mw.loader.implement,
792 * consider executing it, if it has no unsatisfied dependencies.
793 *
794 * @private
795 */
796 function doPropagation() {
797 var errorModule, baseModuleError, module, i, failed, job,
798 didPropagate = true;
799
800 // Keep going until the last iteration performed no actions.
801 do {
802 didPropagate = false;
803
804 // Stage 1: Propagate failures
805 while ( errorModules.length ) {
806 errorModule = errorModules.shift();
807 baseModuleError = baseModules.indexOf( errorModule ) !== -1;
808 for ( module in registry ) {
809 if ( registry[ module ].state !== 'error' && registry[ module ].state !== 'missing' ) {
810 if ( baseModuleError && baseModules.indexOf( module ) === -1 ) {
811 // Propate error from base module to all regular (non-base) modules
812 registry[ module ].state = 'error';
813 didPropagate = true;
814 } else if ( registry[ module ].dependencies.indexOf( errorModule ) !== -1 ) {
815 // Propagate error from dependency to depending module
816 registry[ module ].state = 'error';
817 // .. and propagate it further
818 errorModules.push( module );
819 didPropagate = true;
820 }
821 }
822 }
823 }
824
825 // Stage 2: Execute 'loaded' modules with no unsatisfied dependencies
826 for ( module in registry ) {
827 if ( registry[ module ].state === 'loaded' && allWithImplicitReady( module ) ) {
828 // Recursively execute all dependent modules that were already loaded
829 // (waiting for execution) and no longer have unsatisfied dependencies.
830 // Base modules may have dependencies amongst eachother to ensure correct
831 // execution order. Regular modules wait for all base modules.
832 // eslint-disable-next-line no-use-before-define
833 execute( module );
834 didPropagate = true;
835 }
836 }
837
838 // Stage 3: Invoke job callbacks that are no longer blocked
839 for ( i = 0; i < jobs.length; i++ ) {
840 job = jobs[ i ];
841 failed = anyFailed( job.dependencies );
842 if ( failed || allReady( job.dependencies ) ) {
843 jobs.splice( i, 1 );
844 i -= 1;
845 try {
846 if ( failed && job.error ) {
847 job.error( new Error( 'Module has failed dependencies' ), job.dependencies );
848 } else if ( !failed && job.ready ) {
849 job.ready();
850 }
851 } catch ( e ) {
852 // A user-defined callback raised an exception.
853 // Swallow it to protect our state machine!
854 mw.trackError( 'resourceloader.exception', {
855 exception: e,
856 source: 'load-callback'
857 } );
858 }
859 didPropagate = true;
860 }
861 }
862 } while ( didPropagate );
863
864 willPropagate = false;
865 }
866
867 /**
868 * Request a (debounced) call to doPropagation().
869 *
870 * @private
871 */
872 function requestPropagation() {
873 if ( willPropagate ) {
874 // Already scheduled, or, we're already in a doPropagation stack.
875 return;
876 }
877 willPropagate = true;
878 // Yield for two reasons:
879 // * Allow successive calls to mw.loader.implement() from the same
880 // load.php response, or from the same asyncEval() to be in the
881 // propagation batch.
882 // * Allow the browser to breathe between the reception of
883 // module source code and the execution of it.
884 //
885 // Use a high priority because the user may be waiting for interactions
886 // to start being possible. But, first provide a moment (up to 'timeout')
887 // for native input event handling (e.g. scrolling/typing/clicking).
888 mw.requestIdleCallback( doPropagation, { timeout: 1 } );
889 }
890
891 /**
892 * Update a module's state in the registry and make sure any neccesary
893 * propagation will occur. See #doPropagation for more about propagation.
894 * See #registry for more about how states are used.
895 *
896 * @private
897 * @param {string} module
898 * @param {string} state
899 */
900 function setAndPropagate( module, state ) {
901 registry[ module ].state = state;
902 if ( state === 'loaded' || state === 'ready' || state === 'error' || state === 'missing' ) {
903 if ( state === 'ready' ) {
904 // Queue to later be synced to the local module store.
905 mw.loader.store.add( module );
906 } else if ( state === 'error' || state === 'missing' ) {
907 errorModules.push( module );
908 }
909 requestPropagation();
910 }
911 }
912
913 /**
914 * Resolve dependencies and detect circular references.
915 *
916 * @private
917 * @param {string} module Name of the top-level module whose dependencies shall be
918 * resolved and sorted.
919 * @param {Array} resolved Returns a topological sort of the given module and its
920 * dependencies, such that later modules depend on earlier modules. The array
921 * contains the module names. If the array contains already some module names,
922 * this function appends its result to the pre-existing array.
923 * @param {StringSet} [unresolved] Used to track the current dependency
924 * chain, and to report loops in the dependency graph.
925 * @throws {Error} If any unregistered module or a dependency loop is encountered
926 */
927 function sortDependencies( module, resolved, unresolved ) {
928 var i, deps, skip;
929
930 if ( !( module in registry ) ) {
931 throw new Error( 'Unknown dependency: ' + module );
932 }
933
934 if ( registry[ module ].skip !== null ) {
935 // eslint-disable-next-line no-new-func
936 skip = new Function( registry[ module ].skip );
937 registry[ module ].skip = null;
938 if ( skip() ) {
939 registry[ module ].skipped = true;
940 registry[ module ].dependencies = [];
941 setAndPropagate( module, 'ready' );
942 return;
943 }
944 }
945
946 if ( resolved.indexOf( module ) !== -1 ) {
947 // Module already resolved; nothing to do
948 return;
949 }
950 // Create unresolved if not passed in
951 if ( !unresolved ) {
952 unresolved = new StringSet();
953 }
954
955 // Add base modules
956 if ( baseModules.indexOf( module ) === -1 ) {
957 baseModules.forEach( function ( baseModule ) {
958 if ( resolved.indexOf( baseModule ) === -1 ) {
959 resolved.push( baseModule );
960 }
961 } );
962 }
963
964 // Tracks down dependencies
965 deps = registry[ module ].dependencies;
966 unresolved.add( module );
967 for ( i = 0; i < deps.length; i++ ) {
968 if ( resolved.indexOf( deps[ i ] ) === -1 ) {
969 if ( unresolved.has( deps[ i ] ) ) {
970 throw new Error(
971 'Circular reference detected: ' + module + ' -> ' + deps[ i ]
972 );
973 }
974
975 sortDependencies( deps[ i ], resolved, unresolved );
976 }
977 }
978 resolved.push( module );
979 }
980
981 /**
982 * Get names of module that a module depends on, in their proper dependency order.
983 *
984 * @private
985 * @param {string[]} modules Array of string module names
986 * @return {Array} List of dependencies, including 'module'.
987 * @throws {Error} If an unregistered module or a dependency loop is encountered
988 */
989 function resolve( modules ) {
990 var i, resolved = [];
991 for ( i = 0; i < modules.length; i++ ) {
992 sortDependencies( modules[ i ], resolved );
993 }
994 return resolved;
995 }
996
997 /**
998 * Like #resolve(), except it will silently ignore modules that
999 * are missing or have missing dependencies.
1000 *
1001 * @private
1002 * @param {string[]} modules Array of string module names
1003 * @return {Array} List of dependencies.
1004 */
1005 function resolveStubbornly( modules ) {
1006 var i, saved, resolved = [];
1007 for ( i = 0; i < modules.length; i++ ) {
1008 saved = resolved.slice();
1009 try {
1010 sortDependencies( modules[ i ], resolved );
1011 } catch ( err ) {
1012 // This module is unknown or has unknown dependencies.
1013 // Undo any incomplete resolutions made and keep going.
1014 resolved = saved;
1015 mw.trackError( 'resourceloader.exception', {
1016 exception: err,
1017 source: 'resolve'
1018 } );
1019 }
1020 }
1021 return resolved;
1022 }
1023
1024 /**
1025 * Load and execute a script.
1026 *
1027 * @private
1028 * @param {string} src URL to script, will be used as the src attribute in the script tag
1029 * @param {Function} [callback] Callback to run after request resolution
1030 */
1031 function addScript( src, callback ) {
1032 var script = document.createElement( 'script' );
1033 script.src = src;
1034 script.onload = script.onerror = function () {
1035 if ( script.parentNode ) {
1036 script.parentNode.removeChild( script );
1037 }
1038 script = null;
1039 if ( callback ) {
1040 callback();
1041 callback = null;
1042 }
1043 };
1044 document.head.appendChild( script );
1045 }
1046
1047 /**
1048 * Queue the loading and execution of a script for a particular module.
1049 *
1050 * This does for debug mode what runScript() does for production.
1051 *
1052 * @private
1053 * @param {string} src URL of the script
1054 * @param {string} moduleName Name of currently executing module
1055 * @param {Function} callback Callback to run after addScript() resolution
1056 */
1057 function queueModuleScript( src, moduleName, callback ) {
1058 pendingRequests.push( function () {
1059 // Keep in sync with execute()/runScript().
1060 if ( moduleName !== 'jquery' ) {
1061 window.require = mw.loader.require;
1062 window.module = registry[ moduleName ].module;
1063 }
1064 addScript( src, function () {
1065 // 'module.exports' should not persist after the file is executed to
1066 // avoid leakage to unrelated code. 'require' should be kept, however,
1067 // as asynchronous access to 'require' is allowed and expected. (T144879)
1068 delete window.module;
1069 callback();
1070 // Start the next one (if any)
1071 if ( pendingRequests[ 0 ] ) {
1072 pendingRequests.shift()();
1073 } else {
1074 handlingPendingRequests = false;
1075 }
1076 } );
1077 } );
1078 if ( !handlingPendingRequests && pendingRequests[ 0 ] ) {
1079 handlingPendingRequests = true;
1080 pendingRequests.shift()();
1081 }
1082 }
1083
1084 /**
1085 * Utility function for execute()
1086 *
1087 * @ignore
1088 * @param {string} [media] Media attribute
1089 * @param {string} url URL
1090 */
1091 function addLink( media, url ) {
1092 var el = document.createElement( 'link' );
1093
1094 el.rel = 'stylesheet';
1095 if ( media && media !== 'all' ) {
1096 el.media = media;
1097 }
1098 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1099 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1100 el.href = url;
1101
1102 if ( marker && marker.parentNode ) {
1103 marker.parentNode.insertBefore( el, marker );
1104 } else {
1105 document.head.appendChild( el );
1106 }
1107 }
1108
1109 /**
1110 * @private
1111 * @param {string} code JavaScript code
1112 */
1113 function domEval( code ) {
1114 var script = document.createElement( 'script' );
1115 if ( mw.config.get( 'wgCSPNonce' ) !== false ) {
1116 script.nonce = mw.config.get( 'wgCSPNonce' );
1117 }
1118 script.text = code;
1119 document.head.appendChild( script );
1120 script.parentNode.removeChild( script );
1121 }
1122
1123 /**
1124 * Add one or more modules to the module load queue.
1125 *
1126 * See also #work().
1127 *
1128 * @private
1129 * @param {string[]} dependencies Array of module names in the registry
1130 * @param {Function} [ready] Callback to execute when all dependencies are ready
1131 * @param {Function} [error] Callback to execute when any dependency fails
1132 */
1133 function enqueue( dependencies, ready, error ) {
1134 if ( allReady( dependencies ) ) {
1135 // Run ready immediately
1136 if ( ready !== undefined ) {
1137 ready();
1138 }
1139 return;
1140 }
1141
1142 if ( anyFailed( dependencies ) ) {
1143 if ( error !== undefined ) {
1144 // Execute error immediately if any dependencies have errors
1145 error(
1146 new Error( 'One or more dependencies failed to load' ),
1147 dependencies
1148 );
1149 }
1150 return;
1151 }
1152
1153 // Not all dependencies are ready, add to the load queue...
1154
1155 // Add ready and error callbacks if they were given
1156 if ( ready !== undefined || error !== undefined ) {
1157 jobs.push( {
1158 // Narrow down the list to modules that are worth waiting for
1159 dependencies: dependencies.filter( function ( module ) {
1160 var state = registry[ module ].state;
1161 return state === 'registered' || state === 'loaded' || state === 'loading' || state === 'executing';
1162 } ),
1163 ready: ready,
1164 error: error
1165 } );
1166 }
1167
1168 dependencies.forEach( function ( module ) {
1169 // Only queue modules that are still in the initial 'registered' state
1170 // (not ones already loading, ready or error).
1171 if ( registry[ module ].state === 'registered' && queue.indexOf( module ) === -1 ) {
1172 // Private modules must be embedded in the page. Don't bother queuing
1173 // these as the server will deny them anyway (T101806).
1174 if ( registry[ module ].group === 'private' ) {
1175 setAndPropagate( module, 'error' );
1176 return;
1177 }
1178 queue.push( module );
1179 }
1180 } );
1181
1182 mw.loader.work();
1183 }
1184
1185 /**
1186 * Executes a loaded module, making it ready to use
1187 *
1188 * @private
1189 * @param {string} module Module name to execute
1190 */
1191 function execute( module ) {
1192 var key, value, media, i, urls, cssHandle, siteDeps, siteDepErr, runScript,
1193 cssPending = 0;
1194
1195 if ( registry[ module ].state !== 'loaded' ) {
1196 throw new Error( 'Module in state "' + registry[ module ].state + '" may not be executed: ' + module );
1197 }
1198
1199 registry[ module ].state = 'executing';
1200 $CODE.profileExecuteStart();
1201
1202 runScript = function () {
1203 var script, markModuleReady, nestedAddScript;
1204
1205 $CODE.profileScriptStart();
1206 script = registry[ module ].script;
1207 markModuleReady = function () {
1208 $CODE.profileScriptEnd();
1209 setAndPropagate( module, 'ready' );
1210 };
1211 nestedAddScript = function ( arr, callback, i ) {
1212 // Recursively call queueModuleScript() in its own callback
1213 // for each element of arr.
1214 if ( i >= arr.length ) {
1215 // We're at the end of the array
1216 callback();
1217 return;
1218 }
1219
1220 queueModuleScript( arr[ i ], module, function () {
1221 nestedAddScript( arr, callback, i + 1 );
1222 } );
1223 };
1224
1225 try {
1226 if ( Array.isArray( script ) ) {
1227 nestedAddScript( script, markModuleReady, 0 );
1228 } else if ( typeof script === 'function' ) {
1229 // Keep in sync with queueModuleScript() for debug mode
1230 if ( module === 'jquery' ) {
1231 // This is a special case for when 'jquery' itself is being loaded.
1232 // - The standard jquery.js distribution does not set `window.jQuery`
1233 // in CommonJS-compatible environments (Node.js, AMD, RequireJS, etc.).
1234 // - MediaWiki's 'jquery' module also bundles jquery.migrate.js, which
1235 // in a CommonJS-compatible environment, will use require('jquery'),
1236 // but that can't work when we're still inside that module.
1237 script();
1238 } else {
1239 // Pass jQuery twice so that the signature of the closure which wraps
1240 // the script can bind both '$' and 'jQuery'.
1241 script( window.$, window.$, mw.loader.require, registry[ module ].module );
1242 }
1243 markModuleReady();
1244
1245 } else if ( typeof script === 'string' ) {
1246 // Site and user modules are legacy scripts that run in the global scope.
1247 // This is transported as a string instead of a function to avoid needing
1248 // to use string manipulation to undo the function wrapper.
1249 domEval( script );
1250 markModuleReady();
1251
1252 } else {
1253 // Module without script
1254 markModuleReady();
1255 }
1256 } catch ( e ) {
1257 // Use mw.track instead of mw.log because these errors are common in production mode
1258 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1259 setAndPropagate( module, 'error' );
1260 $CODE.profileScriptEnd();
1261 mw.trackError( 'resourceloader.exception', {
1262 exception: e,
1263 module: module,
1264 source: 'module-execute'
1265 } );
1266 }
1267 };
1268
1269 // Add localizations to message system
1270 if ( registry[ module ].messages ) {
1271 mw.messages.set( registry[ module ].messages );
1272 }
1273
1274 // Initialise templates
1275 if ( registry[ module ].templates ) {
1276 mw.templates.set( module, registry[ module ].templates );
1277 }
1278
1279 // Adding of stylesheets is asynchronous via addEmbeddedCSS().
1280 // The below function uses a counting semaphore to make sure we don't call
1281 // runScript() until after this module's stylesheets have been inserted
1282 // into the DOM.
1283 cssHandle = function () {
1284 // Increase semaphore, when creating a callback for addEmbeddedCSS.
1285 cssPending++;
1286 return function () {
1287 var runScriptCopy;
1288 // Decrease semaphore, when said callback is invoked.
1289 cssPending--;
1290 if ( cssPending === 0 ) {
1291 // Paranoia:
1292 // This callback is exposed to addEmbeddedCSS, which is outside the execute()
1293 // function and is not concerned with state-machine integrity. In turn,
1294 // addEmbeddedCSS() actually exposes stuff further into the browser (rAF).
1295 // If increment and decrement callbacks happen in the wrong order, or start
1296 // again afterwards, then this branch could be reached multiple times.
1297 // To protect the integrity of the state-machine, prevent that from happening
1298 // by making runScript() cannot be called more than once. We store a private
1299 // reference when we first reach this branch, then deference the original, and
1300 // call our reference to it.
1301 runScriptCopy = runScript;
1302 runScript = undefined;
1303 runScriptCopy();
1304 }
1305 };
1306 };
1307
1308 // Process styles (see also mw.loader.implement)
1309 // * back-compat: { <media>: css }
1310 // * back-compat: { <media>: [url, ..] }
1311 // * { "css": [css, ..] }
1312 // * { "url": { <media>: [url, ..] } }
1313 if ( registry[ module ].style ) {
1314 for ( key in registry[ module ].style ) {
1315 value = registry[ module ].style[ key ];
1316 media = undefined;
1317
1318 if ( key !== 'url' && key !== 'css' ) {
1319 // Backwards compatibility, key is a media-type
1320 if ( typeof value === 'string' ) {
1321 // back-compat: { <media>: css }
1322 // Ignore 'media' because it isn't supported (nor was it used).
1323 // Strings are pre-wrapped in "@media". The media-type was just ""
1324 // (because it had to be set to something).
1325 // This is one of the reasons why this format is no longer used.
1326 addEmbeddedCSS( value, cssHandle() );
1327 } else {
1328 // back-compat: { <media>: [url, ..] }
1329 media = key;
1330 key = 'bc-url';
1331 }
1332 }
1333
1334 // Array of css strings in key 'css',
1335 // or back-compat array of urls from media-type
1336 if ( Array.isArray( value ) ) {
1337 for ( i = 0; i < value.length; i++ ) {
1338 if ( key === 'bc-url' ) {
1339 // back-compat: { <media>: [url, ..] }
1340 addLink( media, value[ i ] );
1341 } else if ( key === 'css' ) {
1342 // { "css": [css, ..] }
1343 addEmbeddedCSS( value[ i ], cssHandle() );
1344 }
1345 }
1346 // Not an array, but a regular object
1347 // Array of urls inside media-type key
1348 } else if ( typeof value === 'object' ) {
1349 // { "url": { <media>: [url, ..] } }
1350 for ( media in value ) {
1351 urls = value[ media ];
1352 for ( i = 0; i < urls.length; i++ ) {
1353 addLink( media, urls[ i ] );
1354 }
1355 }
1356 }
1357 }
1358 }
1359
1360 // End profiling of execute()-self before we call runScript(),
1361 // which we want to measure separately without overlap.
1362 $CODE.profileExecuteEnd();
1363
1364 if ( module === 'user' ) {
1365 // Implicit dependency on the site module. Not a real dependency because it should
1366 // run after 'site' regardless of whether it succeeds or fails.
1367 // Note: This is a simplified version of mw.loader.using(), inlined here because
1368 // mw.loader.using() is part of mediawiki.base (depends on jQuery; T192623).
1369 try {
1370 siteDeps = resolve( [ 'site' ] );
1371 } catch ( e ) {
1372 siteDepErr = e;
1373 runScript();
1374 }
1375 if ( siteDepErr === undefined ) {
1376 enqueue( siteDeps, runScript, runScript );
1377 }
1378 } else if ( cssPending === 0 ) {
1379 // Regular module without styles
1380 runScript();
1381 }
1382 // else: runScript will get called via cssHandle()
1383 }
1384
1385 function sortQuery( o ) {
1386 var key,
1387 sorted = {},
1388 a = [];
1389
1390 for ( key in o ) {
1391 a.push( key );
1392 }
1393 a.sort();
1394 for ( key = 0; key < a.length; key++ ) {
1395 sorted[ a[ key ] ] = o[ a[ key ] ];
1396 }
1397 return sorted;
1398 }
1399
1400 /**
1401 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1402 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1403 *
1404 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1405 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1406 *
1407 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1408 * because its implementation needs to keep track of potential string size in order
1409 * to decide when to split the requests due to url size.
1410 *
1411 * @private
1412 * @param {Object} moduleMap Module map
1413 * @return {Object}
1414 * @return {string} return.str Module query string
1415 * @return {Array} return.list List of module names in matching order
1416 */
1417 function buildModulesString( moduleMap ) {
1418 var p, prefix,
1419 str = [],
1420 list = [];
1421
1422 function restore( suffix ) {
1423 return p + suffix;
1424 }
1425
1426 for ( prefix in moduleMap ) {
1427 p = prefix === '' ? '' : prefix + '.';
1428 str.push( p + moduleMap[ prefix ].join( ',' ) );
1429 list.push.apply( list, moduleMap[ prefix ].map( restore ) );
1430 }
1431 return {
1432 str: str.join( '|' ),
1433 list: list
1434 };
1435 }
1436
1437 /**
1438 * Resolve indexed dependencies.
1439 *
1440 * ResourceLoader uses an optimisation to save space which replaces module names in
1441 * dependency lists with the index of that module within the array of module
1442 * registration data if it exists. The benefit is a significant reduction in the data
1443 * size of the startup module. This function changes those dependency lists back to
1444 * arrays of strings.
1445 *
1446 * @private
1447 * @param {Array} modules Modules array
1448 */
1449 function resolveIndexedDependencies( modules ) {
1450 var i, j, deps;
1451 function resolveIndex( dep ) {
1452 return typeof dep === 'number' ? modules[ dep ][ 0 ] : dep;
1453 }
1454 for ( i = 0; i < modules.length; i++ ) {
1455 deps = modules[ i ][ 2 ];
1456 if ( deps ) {
1457 for ( j = 0; j < deps.length; j++ ) {
1458 deps[ j ] = resolveIndex( deps[ j ] );
1459 }
1460 }
1461 }
1462 }
1463
1464 /**
1465 * @private
1466 * @param {Object} params Map of parameter names to values
1467 * @return {string}
1468 */
1469 function makeQueryString( params ) {
1470 return Object.keys( params ).map( function ( key ) {
1471 return encodeURIComponent( key ) + '=' + encodeURIComponent( params[ key ] );
1472 } ).join( '&' );
1473 }
1474
1475 /**
1476 * Create network requests for a batch of modules.
1477 *
1478 * This is an internal method for #work(). This must not be called directly
1479 * unless the modules are already registered, and no request is in progress,
1480 * and the module state has already been set to `loading`.
1481 *
1482 * @private
1483 * @param {string[]} batch
1484 */
1485 function batchRequest( batch ) {
1486 var reqBase, splits, maxQueryLength, b, bSource, bGroup,
1487 source, group, i, modules, sourceLoadScript,
1488 currReqBase, currReqBaseLength, moduleMap, currReqModules, l,
1489 lastDotIndex, prefix, suffix, bytesAdded;
1490
1491 /**
1492 * Start the currently drafted request to the server.
1493 *
1494 * @ignore
1495 */
1496 function doRequest() {
1497 // Optimisation: Inherit (Object.create), not copy ($.extend)
1498 var query = Object.create( currReqBase ),
1499 packed = buildModulesString( moduleMap );
1500 query.modules = packed.str;
1501 // The packing logic can change the effective order, even if the input was
1502 // sorted. As such, the call to getCombinedVersion() must use this
1503 // effective order, instead of currReqModules, as otherwise the combined
1504 // version will not match the hash expected by the server based on
1505 // combining versions from the module query string in-order. (T188076)
1506 query.version = getCombinedVersion( packed.list );
1507 query = sortQuery( query );
1508 addScript( sourceLoadScript + '?' + makeQueryString( query ) );
1509 }
1510
1511 if ( !batch.length ) {
1512 return;
1513 }
1514
1515 // Always order modules alphabetically to help reduce cache
1516 // misses for otherwise identical content.
1517 batch.sort();
1518
1519 // Query parameters common to all requests
1520 reqBase = {
1521 skin: mw.config.get( 'skin' ),
1522 lang: mw.config.get( 'wgUserLanguage' ),
1523 debug: mw.config.get( 'debug' )
1524 };
1525 maxQueryLength = mw.config.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1526
1527 // Split module list by source and by group.
1528 splits = Object.create( null );
1529 for ( b = 0; b < batch.length; b++ ) {
1530 bSource = registry[ batch[ b ] ].source;
1531 bGroup = registry[ batch[ b ] ].group;
1532 if ( !splits[ bSource ] ) {
1533 splits[ bSource ] = Object.create( null );
1534 }
1535 if ( !splits[ bSource ][ bGroup ] ) {
1536 splits[ bSource ][ bGroup ] = [];
1537 }
1538 splits[ bSource ][ bGroup ].push( batch[ b ] );
1539 }
1540
1541 for ( source in splits ) {
1542 sourceLoadScript = sources[ source ];
1543
1544 for ( group in splits[ source ] ) {
1545
1546 // Cache access to currently selected list of
1547 // modules for this group from this source.
1548 modules = splits[ source ][ group ];
1549
1550 // Query parameters common to requests for this module group
1551 // Optimisation: Inherit (Object.create), not copy ($.extend)
1552 currReqBase = Object.create( reqBase );
1553 // User modules require a user name in the query string.
1554 if ( group === 'user' && mw.config.get( 'wgUserName' ) !== null ) {
1555 currReqBase.user = mw.config.get( 'wgUserName' );
1556 }
1557
1558 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1559 // > '&modules='.length === 9
1560 // > '&version=1234567'.length === 16
1561 // > 9 + 16 = 25
1562 currReqBaseLength = makeQueryString( currReqBase ).length + 25;
1563
1564 // We may need to split up the request to honor the query string length limit,
1565 // so build it piece by piece.
1566 l = currReqBaseLength;
1567 moduleMap = Object.create( null ); // { prefix: [ suffixes ] }
1568 currReqModules = [];
1569
1570 for ( i = 0; i < modules.length; i++ ) {
1571 // Determine how many bytes this module would add to the query string
1572 lastDotIndex = modules[ i ].lastIndexOf( '.' );
1573 // If lastDotIndex is -1, substr() returns an empty string
1574 prefix = modules[ i ].substr( 0, lastDotIndex );
1575 suffix = modules[ i ].slice( lastDotIndex + 1 );
1576 bytesAdded = moduleMap[ prefix ] ?
1577 suffix.length + 3 : // '%2C'.length == 3
1578 modules[ i ].length + 3; // '%7C'.length == 3
1579
1580 // If the url would become too long, create a new one, but don't create empty requests
1581 if ( maxQueryLength > 0 && currReqModules.length && l + bytesAdded > maxQueryLength ) {
1582 // Dispatch what we've got...
1583 doRequest();
1584 // .. and start again.
1585 l = currReqBaseLength;
1586 moduleMap = Object.create( null );
1587 currReqModules = [];
1588
1589 mw.track( 'resourceloader.splitRequest', { maxQueryLength: maxQueryLength } );
1590 }
1591 if ( !moduleMap[ prefix ] ) {
1592 moduleMap[ prefix ] = [];
1593 }
1594 l += bytesAdded;
1595 moduleMap[ prefix ].push( suffix );
1596 currReqModules.push( modules[ i ] );
1597 }
1598 // If there's anything left in moduleMap, request that too
1599 if ( currReqModules.length ) {
1600 doRequest();
1601 }
1602 }
1603 }
1604 }
1605
1606 /**
1607 * @private
1608 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1609 * form of calls to mw.loader#implement().
1610 * @param {Function} cb Callback in case of failure
1611 * @param {Error} cb.err
1612 */
1613 function asyncEval( implementations, cb ) {
1614 if ( !implementations.length ) {
1615 return;
1616 }
1617 mw.requestIdleCallback( function () {
1618 try {
1619 domEval( implementations.join( ';' ) );
1620 } catch ( err ) {
1621 cb( err );
1622 }
1623 } );
1624 }
1625
1626 /**
1627 * Make a versioned key for a specific module.
1628 *
1629 * @private
1630 * @param {string} module Module name
1631 * @return {string|null} Module key in format '`[name]@[version]`',
1632 * or null if the module does not exist
1633 */
1634 function getModuleKey( module ) {
1635 return module in registry ? ( module + '@' + registry[ module ].version ) : null;
1636 }
1637
1638 /**
1639 * @private
1640 * @param {string} key Module name or '`[name]@[version]`'
1641 * @return {Object}
1642 */
1643 function splitModuleKey( key ) {
1644 var index = key.indexOf( '@' );
1645 if ( index === -1 ) {
1646 return {
1647 name: key,
1648 version: ''
1649 };
1650 }
1651 return {
1652 name: key.slice( 0, index ),
1653 version: key.slice( index + 1 )
1654 };
1655 }
1656
1657 /**
1658 * @private
1659 * @param {string} module
1660 * @param {string|number} [version]
1661 * @param {string[]} [dependencies]
1662 * @param {string} [group]
1663 * @param {string} [source]
1664 * @param {string} [skip]
1665 */
1666 function registerOne( module, version, dependencies, group, source, skip ) {
1667 if ( module in registry ) {
1668 throw new Error( 'module already registered: ' + module );
1669 }
1670 registry[ module ] = {
1671 // Exposed to execute() for mw.loader.implement() closures.
1672 // Import happens via require().
1673 module: {
1674 exports: {}
1675 },
1676 version: String( version || '' ),
1677 dependencies: dependencies || [],
1678 group: typeof group === 'string' ? group : null,
1679 source: typeof source === 'string' ? source : 'local',
1680 state: 'registered',
1681 skip: typeof skip === 'string' ? skip : null
1682 };
1683 }
1684
1685 /* Public Members */
1686 return {
1687 /**
1688 * The module registry is exposed as an aid for debugging and inspecting page
1689 * state; it is not a public interface for modifying the registry.
1690 *
1691 * @see #registry
1692 * @property
1693 * @private
1694 */
1695 moduleRegistry: registry,
1696
1697 /**
1698 * @inheritdoc #newStyleTag
1699 * @method
1700 */
1701 addStyleTag: newStyleTag,
1702
1703 enqueue: enqueue,
1704
1705 resolve: resolve,
1706
1707 /**
1708 * Start loading of all queued module dependencies.
1709 *
1710 * @private
1711 */
1712 work: function () {
1713 var q, batch, implementations, sourceModules;
1714
1715 batch = [];
1716
1717 // Appends a list of modules from the queue to the batch
1718 for ( q = 0; q < queue.length; q++ ) {
1719 // Only load modules which are registered
1720 if ( queue[ q ] in registry && registry[ queue[ q ] ].state === 'registered' ) {
1721 // Prevent duplicate entries
1722 if ( batch.indexOf( queue[ q ] ) === -1 ) {
1723 batch.push( queue[ q ] );
1724 // Mark registered modules as loading
1725 registry[ queue[ q ] ].state = 'loading';
1726 }
1727 }
1728 }
1729
1730 // Now that the queue has been processed into a batch, clear the queue.
1731 // This MUST happen before we initiate any eval or network request. Otherwise,
1732 // it is possible for a cached script to instantly trigger the same work queue
1733 // again; all before we've cleared it causing each request to include modules
1734 // which are already loaded.
1735 queue = [];
1736
1737 if ( !batch.length ) {
1738 return;
1739 }
1740
1741 mw.loader.store.init();
1742 if ( mw.loader.store.enabled ) {
1743 implementations = [];
1744 sourceModules = [];
1745 batch = batch.filter( function ( module ) {
1746 var implementation = mw.loader.store.get( module );
1747 if ( implementation ) {
1748 implementations.push( implementation );
1749 sourceModules.push( module );
1750 return false;
1751 }
1752 return true;
1753 } );
1754 asyncEval( implementations, function ( err ) {
1755 var failed;
1756 // Not good, the cached mw.loader.implement calls failed! This should
1757 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1758 // Depending on how corrupt the string is, it is likely that some
1759 // modules' implement() succeeded while the ones after the error will
1760 // never run and leave their modules in the 'loading' state forever.
1761 mw.loader.store.stats.failed++;
1762
1763 // Since this is an error not caused by an individual module but by
1764 // something that infected the implement call itself, don't take any
1765 // risks and clear everything in this cache.
1766 mw.loader.store.clear();
1767
1768 mw.trackError( 'resourceloader.exception', {
1769 exception: err,
1770 source: 'store-eval'
1771 } );
1772 // Re-add the failed ones that are still pending back to the batch
1773 failed = sourceModules.filter( function ( module ) {
1774 return registry[ module ].state === 'loading';
1775 } );
1776 batchRequest( failed );
1777 } );
1778 }
1779
1780 batchRequest( batch );
1781 },
1782
1783 /**
1784 * Register a source.
1785 *
1786 * The #work() method will use this information to split up requests by source.
1787 *
1788 * mw.loader.addSource( { mediawikiwiki: 'https://www.mediawiki.org/w/load.php' } );
1789 *
1790 * @private
1791 * @param {Object} ids An object mapping ids to load.php end point urls
1792 * @throws {Error} If source id is already registered
1793 */
1794 addSource: function ( ids ) {
1795 var id;
1796 for ( id in ids ) {
1797 if ( id in sources ) {
1798 throw new Error( 'source already registered: ' + id );
1799 }
1800 sources[ id ] = ids[ id ];
1801 }
1802 },
1803
1804 /**
1805 * Register a module, letting the system know about it and its properties.
1806 *
1807 * The startup module calls this method.
1808 *
1809 * When using multiple module registration by passing an array, dependencies that
1810 * are specified as references to modules within the array will be resolved before
1811 * the modules are registered.
1812 *
1813 * @param {string|Array} modules Module name or array of arrays, each containing
1814 * a list of arguments compatible with this method
1815 * @param {string|number} [version] Module version hash (falls backs to empty string)
1816 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1817 * @param {string[]} [dependencies] Array of module names on which this module depends.
1818 * @param {string} [group=null] Group which the module is in
1819 * @param {string} [source='local'] Name of the source
1820 * @param {string} [skip=null] Script body of the skip function
1821 */
1822 register: function ( modules ) {
1823 var i;
1824 if ( typeof modules === 'object' ) {
1825 resolveIndexedDependencies( modules );
1826 // Optimisation: Up to 55% faster.
1827 // Typically called only once, and with a batch.
1828 // See <https://gist.github.com/Krinkle/f06fdb3de62824c6c16f02a0e6ce0e66>
1829 // Benchmarks taught us that the code for adding an object to `registry`
1830 // should actually be inline, or in a simple function that does no
1831 // arguments manipulation, and isn't also the caller itself.
1832 // JS semantics make it hard to optimise recursion to a different
1833 // signature of itself.
1834 for ( i = 0; i < modules.length; i++ ) {
1835 registerOne.apply( null, modules[ i ] );
1836 }
1837 } else {
1838 registerOne.apply( null, arguments );
1839 }
1840 },
1841
1842 /**
1843 * Implement a module given the components that make up the module.
1844 *
1845 * When #load() or #using() requests one or more modules, the server
1846 * response contain calls to this function.
1847 *
1848 * @param {string} module Name of module and current module version. Formatted
1849 * as '`[name]@[version]`". This version should match the requested version
1850 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1851 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1852 * @param {Function|Array|string} [script] Function with module code, list of URLs
1853 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1854 * @param {Object} [style] Should follow one of the following patterns:
1855 *
1856 * { "css": [css, ..] }
1857 * { "url": { <media>: [url, ..] } }
1858 *
1859 * And for backwards compatibility (needs to be supported forever due to caching):
1860 *
1861 * { <media>: css }
1862 * { <media>: [url, ..] }
1863 *
1864 * The reason css strings are not concatenated anymore is T33676. We now check
1865 * whether it's safe to extend the stylesheet.
1866 *
1867 * @private
1868 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1869 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1870 */
1871 implement: function ( module, script, style, messages, templates ) {
1872 var split = splitModuleKey( module ),
1873 name = split.name,
1874 version = split.version;
1875 // Automatically register module
1876 if ( !( name in registry ) ) {
1877 mw.loader.register( name );
1878 }
1879 // Check for duplicate implementation
1880 if ( registry[ name ].script !== undefined ) {
1881 throw new Error( 'module already implemented: ' + name );
1882 }
1883 if ( version ) {
1884 // Without this reset, if there is a version mismatch between the
1885 // requested and received module version, then mw.loader.store would
1886 // cache the response under the requested key. Thus poisoning the cache
1887 // indefinitely with a stale value. (T117587)
1888 registry[ name ].version = version;
1889 }
1890 // Attach components
1891 registry[ name ].script = script || null;
1892 registry[ name ].style = style || null;
1893 registry[ name ].messages = messages || null;
1894 registry[ name ].templates = templates || null;
1895 // The module may already have been marked as erroneous
1896 if ( registry[ name ].state !== 'error' && registry[ name ].state !== 'missing' ) {
1897 setAndPropagate( name, 'loaded' );
1898 }
1899 },
1900
1901 /**
1902 * Load an external script or one or more modules.
1903 *
1904 * This method takes a list of unrelated modules. Use cases:
1905 *
1906 * - A web page will be composed of many different widgets. These widgets independently
1907 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
1908 * have problems, or are no longer known (e.g. cached HTML), the other modules
1909 * should still be loaded.
1910 * - This method is used for preloading, which must not throw. Later code that
1911 * calls #using() will handle the error.
1912 *
1913 * @param {string|Array} modules Either the name of a module, array of modules,
1914 * or a URL of an external script or style
1915 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
1916 * external script or style; acceptable values are "text/css" and
1917 * "text/javascript"; if no type is provided, text/javascript is assumed.
1918 */
1919 load: function ( modules, type ) {
1920 var filtered, l;
1921
1922 // Allow calling with a url or single dependency as a string
1923 if ( typeof modules === 'string' ) {
1924 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
1925 if ( /^(https?:)?\/?\//.test( modules ) ) {
1926 if ( type === 'text/css' ) {
1927 l = document.createElement( 'link' );
1928 l.rel = 'stylesheet';
1929 l.href = modules;
1930 document.head.appendChild( l );
1931 return;
1932 }
1933 if ( type === 'text/javascript' || type === undefined ) {
1934 addScript( modules );
1935 return;
1936 }
1937 // Unknown type
1938 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type );
1939 }
1940 // Called with single module
1941 modules = [ modules ];
1942 }
1943
1944 // Filter out top-level modules that are unknown or failed to load before.
1945 filtered = modules.filter( function ( module ) {
1946 var state = mw.loader.getState( module );
1947 return state !== 'error' && state !== 'missing';
1948 } );
1949 // Resolve remaining list using the known dependency tree.
1950 // This also filters out modules with unknown dependencies. (T36853)
1951 filtered = resolveStubbornly( filtered );
1952 // Some modules are not yet ready, add to module load queue.
1953 enqueue( filtered, undefined, undefined );
1954 },
1955
1956 /**
1957 * Change the state of one or more modules.
1958 *
1959 * @param {Object} states Object of module name/state pairs
1960 */
1961 state: function ( states ) {
1962 var module, state;
1963 for ( module in states ) {
1964 state = states[ module ];
1965 if ( !( module in registry ) ) {
1966 mw.loader.register( module );
1967 }
1968 setAndPropagate( module, state );
1969 }
1970 },
1971
1972 /**
1973 * Get the version of a module.
1974 *
1975 * @param {string} module Name of module
1976 * @return {string|null} The version, or null if the module (or its version) is not
1977 * in the registry.
1978 */
1979 getVersion: function ( module ) {
1980 return module in registry ? registry[ module ].version : null;
1981 },
1982
1983 /**
1984 * Get the state of a module.
1985 *
1986 * @param {string} module Name of module
1987 * @return {string|null} The state, or null if the module (or its state) is not
1988 * in the registry.
1989 */
1990 getState: function ( module ) {
1991 return module in registry ? registry[ module ].state : null;
1992 },
1993
1994 /**
1995 * Get the names of all registered modules.
1996 *
1997 * @return {Array}
1998 */
1999 getModuleNames: function () {
2000 return Object.keys( registry );
2001 },
2002
2003 /**
2004 * Get the exported value of a module.
2005 *
2006 * This static method is publicly exposed for debugging purposes
2007 * only and must not be used in production code. In production code,
2008 * please use the dynamically provided `require()` function instead.
2009 *
2010 * In case of lazy-loaded modules via mw.loader#using(), the returned
2011 * Promise provides the function, see #using() for examples.
2012 *
2013 * @private
2014 * @since 1.27
2015 * @param {string} moduleName Module name
2016 * @return {Mixed} Exported value
2017 */
2018 require: function ( moduleName ) {
2019 var state = mw.loader.getState( moduleName );
2020
2021 // Only ready modules can be required
2022 if ( state !== 'ready' ) {
2023 // Module may've forgotten to declare a dependency
2024 throw new Error( 'Module "' + moduleName + '" is not loaded.' );
2025 }
2026
2027 return registry[ moduleName ].module.exports;
2028 },
2029
2030 /**
2031 * On browsers that implement the localStorage API, the module store serves as a
2032 * smart complement to the browser cache. Unlike the browser cache, the module store
2033 * can slice a concatenated response from ResourceLoader into its constituent
2034 * modules and cache each of them separately, using each module's versioning scheme
2035 * to determine when the cache should be invalidated.
2036 *
2037 * @private
2038 * @singleton
2039 * @class mw.loader.store
2040 */
2041 store: {
2042 // Whether the store is in use on this page.
2043 enabled: null,
2044
2045 // Modules whose string representation exceeds 100 kB are
2046 // ineligible for storage. See bug T66721.
2047 MODULE_SIZE_MAX: 100 * 1000,
2048
2049 // The contents of the store, mapping '[name]@[version]' keys
2050 // to module implementations.
2051 items: {},
2052
2053 // Names of modules to be stored during the next update.
2054 // See add() and update().
2055 queue: [],
2056
2057 // Cache hit stats
2058 stats: { hits: 0, misses: 0, expired: 0, failed: 0 },
2059
2060 /**
2061 * Construct a JSON-serializable object representing the content of the store.
2062 *
2063 * @return {Object} Module store contents.
2064 */
2065 toJSON: function () {
2066 return { items: mw.loader.store.items, vary: mw.loader.store.getVary() };
2067 },
2068
2069 /**
2070 * Get the localStorage key for the entire module store. The key references
2071 * $wgDBname to prevent clashes between wikis which share a common host.
2072 *
2073 * @return {string} localStorage item key
2074 */
2075 getStoreKey: function () {
2076 return 'MediaWikiModuleStore:' + mw.config.get( 'wgDBname' );
2077 },
2078
2079 /**
2080 * Get a key on which to vary the module cache.
2081 *
2082 * @return {string} String of concatenated vary conditions.
2083 */
2084 getVary: function () {
2085 return mw.config.get( 'skin' ) + ':' +
2086 mw.config.get( 'wgResourceLoaderStorageVersion' ) + ':' +
2087 mw.config.get( 'wgUserLanguage' );
2088 },
2089
2090 /**
2091 * Initialize the store.
2092 *
2093 * Retrieves store from localStorage and (if successfully retrieved) decoding
2094 * the stored JSON value to a plain object.
2095 *
2096 * The try / catch block is used for JSON & localStorage feature detection.
2097 * See the in-line documentation for Modernizr's localStorage feature detection
2098 * code for a full account of why we need a try / catch:
2099 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2100 */
2101 init: function () {
2102 var raw, data;
2103
2104 if ( this.enabled !== null ) {
2105 // Init already ran
2106 return;
2107 }
2108
2109 if (
2110 // Disabled because localStorage quotas are tight and (in Firefox's case)
2111 // shared by multiple origins.
2112 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2113 /Firefox/.test( navigator.userAgent ) ||
2114
2115 // Disabled by configuration.
2116 !mw.config.get( 'wgResourceLoaderStorageEnabled' )
2117 ) {
2118 // Clear any previous store to free up space. (T66721)
2119 this.clear();
2120 this.enabled = false;
2121 return;
2122 }
2123 if ( mw.config.get( 'debug' ) ) {
2124 // Disable module store in debug mode
2125 this.enabled = false;
2126 return;
2127 }
2128
2129 try {
2130 // This a string we stored, or `null` if the key does not (yet) exist.
2131 raw = localStorage.getItem( this.getStoreKey() );
2132 // If we get here, localStorage is available; mark enabled
2133 this.enabled = true;
2134 // If null, JSON.parse() will cast to string and re-parse, still null.
2135 data = JSON.parse( raw );
2136 if ( data && typeof data.items === 'object' && data.vary === this.getVary() ) {
2137 this.items = data.items;
2138 return;
2139 }
2140 } catch ( e ) {
2141 mw.trackError( 'resourceloader.exception', {
2142 exception: e,
2143 source: 'store-localstorage-init'
2144 } );
2145 }
2146
2147 // If we get here, one of four things happened:
2148 //
2149 // 1. localStorage did not contain our store key.
2150 // This means `raw` is `null`, and we're on a fresh page view (cold cache).
2151 // The store was enabled, and `items` starts fresh.
2152 //
2153 // 2. localStorage contained parseable data under our store key,
2154 // but it's not applicable to our current context (see getVary).
2155 // The store was enabled, and `items` starts fresh.
2156 //
2157 // 3. JSON.parse threw (localStorage contained corrupt data).
2158 // This means `raw` contains a string.
2159 // The store was enabled, and `items` starts fresh.
2160 //
2161 // 4. localStorage threw (disabled or otherwise unavailable).
2162 // This means `raw` was never assigned.
2163 // We will disable the store below.
2164 if ( raw === undefined ) {
2165 // localStorage failed; disable store
2166 this.enabled = false;
2167 }
2168 },
2169
2170 /**
2171 * Retrieve a module from the store and update cache hit stats.
2172 *
2173 * @param {string} module Module name
2174 * @return {string|boolean} Module implementation or false if unavailable
2175 */
2176 get: function ( module ) {
2177 var key;
2178
2179 if ( !this.enabled ) {
2180 return false;
2181 }
2182
2183 key = getModuleKey( module );
2184 if ( key in this.items ) {
2185 this.stats.hits++;
2186 return this.items[ key ];
2187 }
2188 this.stats.misses++;
2189 return false;
2190 },
2191
2192 /**
2193 * Queue the name of a module that the next update should consider storing.
2194 *
2195 * @since 1.32
2196 * @param {string} module Module name
2197 */
2198 add: function ( module ) {
2199 if ( !this.enabled ) {
2200 return;
2201 }
2202 this.queue.push( module );
2203 this.requestUpdate();
2204 },
2205
2206 /**
2207 * Add the contents of the named module to the in-memory store.
2208 *
2209 * This method does not guarantee that the module will be stored.
2210 * Inspection of the module's meta data and size will ultimately decide that.
2211 *
2212 * This method is considered internal to mw.loader.store and must only
2213 * be called if the store is enabled.
2214 *
2215 * @private
2216 * @param {string} module Module name
2217 */
2218 set: function ( module ) {
2219 var key, args, src,
2220 descriptor = mw.loader.moduleRegistry[ module ];
2221
2222 key = getModuleKey( module );
2223
2224 if (
2225 // Already stored a copy of this exact version
2226 key in this.items ||
2227 // Module failed to load
2228 !descriptor ||
2229 descriptor.state !== 'ready' ||
2230 // Unversioned, private, or site-/user-specific
2231 !descriptor.version ||
2232 descriptor.group === 'private' ||
2233 descriptor.group === 'user' ||
2234 // Partial descriptor
2235 // (e.g. skipped module, or style module with state=ready)
2236 [ descriptor.script, descriptor.style, descriptor.messages,
2237 descriptor.templates ].indexOf( undefined ) !== -1
2238 ) {
2239 // Decline to store
2240 return;
2241 }
2242
2243 try {
2244 args = [
2245 JSON.stringify( key ),
2246 typeof descriptor.script === 'function' ?
2247 String( descriptor.script ) :
2248 JSON.stringify( descriptor.script ),
2249 JSON.stringify( descriptor.style ),
2250 JSON.stringify( descriptor.messages ),
2251 JSON.stringify( descriptor.templates )
2252 ];
2253 } catch ( e ) {
2254 mw.trackError( 'resourceloader.exception', {
2255 exception: e,
2256 source: 'store-localstorage-json'
2257 } );
2258 return;
2259 }
2260
2261 src = 'mw.loader.implement(' + args.join( ',' ) + ');';
2262 if ( src.length > this.MODULE_SIZE_MAX ) {
2263 return;
2264 }
2265 this.items[ key ] = src;
2266 },
2267
2268 /**
2269 * Iterate through the module store, removing any item that does not correspond
2270 * (in name and version) to an item in the module registry.
2271 */
2272 prune: function () {
2273 var key, module;
2274
2275 for ( key in this.items ) {
2276 module = key.slice( 0, key.indexOf( '@' ) );
2277 if ( getModuleKey( module ) !== key ) {
2278 this.stats.expired++;
2279 delete this.items[ key ];
2280 } else if ( this.items[ key ].length > this.MODULE_SIZE_MAX ) {
2281 // This value predates the enforcement of a size limit on cached modules.
2282 delete this.items[ key ];
2283 }
2284 }
2285 },
2286
2287 /**
2288 * Clear the entire module store right now.
2289 */
2290 clear: function () {
2291 this.items = {};
2292 try {
2293 localStorage.removeItem( this.getStoreKey() );
2294 } catch ( e ) {}
2295 },
2296
2297 /**
2298 * Request a sync of the in-memory store back to persisted localStorage.
2299 *
2300 * This function debounces updates. The debouncing logic should account
2301 * for the following factors:
2302 *
2303 * - Writing to localStorage is an expensive operation that must not happen
2304 * during the critical path of initialising and executing module code.
2305 * Instead, it should happen at a later time after modules have been given
2306 * time and priority to do their thing first.
2307 *
2308 * - This method is called from mw.loader.store.add(), which will be called
2309 * hundreds of times on a typical page, including within the same call-stack
2310 * and eventloop-tick. This is because responses from load.php happen in
2311 * batches. As such, we want to allow all modules from the same load.php
2312 * response to be written to disk with a single flush, not many.
2313 *
2314 * - Repeatedly deleting and creating timers is non-trivial.
2315 *
2316 * - localStorage is shared by all pages from the same origin, if multiple
2317 * pages are loaded with different module sets, the possibility exists that
2318 * modules saved by one page will be clobbered by another. The impact of
2319 * this is minor, it merely causes a less efficient cache use, and the
2320 * problem would be corrected by subsequent page views.
2321 *
2322 * This method is considered internal to mw.loader.store and must only
2323 * be called if the store is enabled.
2324 *
2325 * @private
2326 * @method
2327 */
2328 requestUpdate: ( function () {
2329 var hasPendingWrites = false;
2330
2331 function flushWrites() {
2332 var data, key;
2333
2334 // Remove anything from the in-memory store that came from previous page
2335 // loads that no longer corresponds with current module names and versions.
2336 mw.loader.store.prune();
2337 // Process queued module names, serialise their contents to the in-memory store.
2338 while ( mw.loader.store.queue.length ) {
2339 mw.loader.store.set( mw.loader.store.queue.shift() );
2340 }
2341
2342 key = mw.loader.store.getStoreKey();
2343 try {
2344 // Replacing the content of the module store might fail if the new
2345 // contents would exceed the browser's localStorage size limit. To
2346 // avoid clogging the browser with stale data, always remove the old
2347 // value before attempting to set the new one.
2348 localStorage.removeItem( key );
2349 data = JSON.stringify( mw.loader.store );
2350 localStorage.setItem( key, data );
2351 } catch ( e ) {
2352 mw.trackError( 'resourceloader.exception', {
2353 exception: e,
2354 source: 'store-localstorage-update'
2355 } );
2356 }
2357
2358 // Let the next call to requestUpdate() create a new timer.
2359 hasPendingWrites = false;
2360 }
2361
2362 function onTimeout() {
2363 // Defer the actual write via requestIdleCallback
2364 mw.requestIdleCallback( flushWrites );
2365 }
2366
2367 return function () {
2368 // On the first call to requestUpdate(), create a timer that
2369 // waits at least two seconds, then calls onTimeout.
2370 // The main purpose is to allow the current batch of load.php
2371 // responses to complete before we do anything. This batch can
2372 // trigger many hundreds of calls to requestUpdate().
2373 if ( !hasPendingWrites ) {
2374 hasPendingWrites = true;
2375 setTimeout( onTimeout, 2000 );
2376 }
2377 };
2378 }() )
2379 }
2380 };
2381 }() ),
2382
2383 // Skeleton user object, extended by the 'mediawiki.user' module.
2384 /**
2385 * @class mw.user
2386 * @singleton
2387 */
2388 user: {
2389 /**
2390 * @property {mw.Map}
2391 */
2392 options: new Map(),
2393 /**
2394 * @property {mw.Map}
2395 */
2396 tokens: new Map()
2397 },
2398
2399 // OOUI widgets specific to MediaWiki
2400 widgets: {}
2401
2402 };
2403
2404 // Attach to window and globally alias
2405 window.mw = window.mediaWiki = mw;
2406 }() );