2 * Base library for MediaWiki.
4 * Exposed globally as `mw`, with `mediaWiki` as alias.
7 * @alternateClassName mediaWiki
10 /* global $VARS, $CODE */
15 var mw
, StringSet
, log
,
19 * FNV132 hash function
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>
27 * @param {string} str String to hash
28 * @return {string} hash as an seven-character base 36 string
30 function fnv132( str
) {
31 /* eslint-disable no-bitwise */
32 var hash
= 0x811C9DC5,
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
);
40 hash
= ( hash
>>> 0 ).toString( 36 );
41 while ( hash
.length
< 7 ) {
46 /* eslint-enable no-bitwise */
49 function defineFallbacks() {
50 // <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set>
55 StringSet
= window
.Set
|| function StringSet() {
56 var set = Object
.create( null );
57 this.add = function ( value
) {
60 this.has = function ( value
) {
67 * Alias property to the global object.
74 * @param {Mixed} value
76 function setGlobalMapValue( map
, key
, value
) {
77 map
.values
[ key
] = value
;
82 // Deprecation notice for mw.config globals (T58550, T72470)
83 map
=== mw
.config
&& 'Use mw.config instead.'
88 * Log a message to window.console, if possible.
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).
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
101 function logError( topic
, data
) {
102 /* eslint-disable no-console */
105 source
= data
.source
,
106 module
= data
.module
,
107 console
= window
.console
;
109 if ( console
&& console
.log
) {
110 msg
= ( e
? 'Exception' : 'Error' ) + ' in ' + source
;
112 msg
+= ' in module ' + module
;
114 msg
+= ( e
? ':' : '.' );
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
) {
123 /* eslint-enable no-console */
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.
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.
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
) {
144 if ( arguments
.length
> 1 ) {
145 if ( typeof selection
!== 'string' ) {
148 setGlobalMapValue( this, selection
, value
);
151 if ( typeof selection
=== 'object' ) {
152 for ( s
in selection
) {
153 setGlobalMapValue( this, s
, selection
[ s
] );
166 * Get the value of one or more keys.
168 * If called with no arguments, all values are returned.
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.
176 get: function ( selection
, fallback
) {
178 fallback
= arguments
.length
> 1 ? fallback
: null;
180 if ( Array
.isArray( selection
) ) {
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
] ] :
192 if ( typeof selection
=== 'string' ) {
193 return selection
in this.values
?
194 this.values
[ selection
] :
198 if ( selection
=== undefined ) {
200 for ( i
in this.values
) {
201 results
[ i
] = this.values
[ i
];
206 // Invalid selection key
211 * Set one or more key/value pairs.
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
217 set: function ( selection
, value
) {
219 // Use `arguments.length` because `undefined` is also a valid value.
220 if ( arguments
.length
> 1 ) {
221 if ( typeof selection
!== 'string' ) {
224 this.values
[ selection
] = value
;
227 if ( typeof selection
=== 'object' ) {
228 for ( s
in selection
) {
229 this.values
[ s
] = selection
[ s
];
237 * Check if one or more keys exist.
239 * @param {Mixed} selection Key or array of keys to check
240 * @return {boolean} True if the key(s) exist
242 exists: function ( selection
) {
244 if ( Array
.isArray( selection
) ) {
245 for ( i
= 0; i
< selection
.length
; i
++ ) {
246 if ( typeof selection
[ i
] !== 'string' || !( selection
[ i
] in this.values
) ) {
252 return typeof selection
=== 'string' && selection
in this.values
;
258 log
= ( function () {
260 * Write a verbose message to the browser's console in debug mode.
262 * This method is mainly intended for verbose logging. It is a no-op in production mode.
263 * In ResourceLoader debug mode, it will use the browser's console if available, with
264 * fallback to creating a console interface in the DOM and logging messages there.
266 * See {@link mw.log} for other logging methods.
269 * @param {...string} msg Messages to output to console.
271 var log = function () {},
272 console
= window
.console
;
274 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
275 // when adding or removing mw.log methods below!
278 * Collection of methods to help log messages to the console.
285 * Write a message to the browser console's warning channel.
287 * This method is a no-op in browsers that don't implement the Console API.
289 * @param {...string} msg Messages to output to console
291 log
.warn
= console
&& console
.warn
?
292 Function
.prototype.bind
.call( console
.warn
, console
) :
296 * Write a message to the browser console's error channel.
298 * Most browsers also print a stacktrace when calling this method if the
299 * argument is an Error object.
301 * This method is a no-op in browsers that don't implement the Console API.
304 * @param {...Mixed} msg Messages to output to console
306 log
.error
= console
&& console
.error
?
307 Function
.prototype.bind
.call( console
.error
, console
) :
311 * Create a property on a host object that, when accessed, will produce
312 * a deprecation warning in the console.
314 * @param {Object} obj Host object of deprecated property
315 * @param {string} key Name of property to create in `obj`
316 * @param {Mixed} val The value this property should return when accessed
317 * @param {string} [msg] Optional text to include in the deprecation message
318 * @param {string} [logName=key] Optional custom name for the feature.
319 * This is used instead of `key` in the message and `mw.deprecate` tracking.
321 log
.deprecate = function ( obj
, key
, val
, msg
, logName
) {
323 function maybeLog() {
325 trace
= new Error().stack
;
327 stacks
= new StringSet();
329 if ( !stacks
.has( trace
) ) {
331 name
= logName
|| key
;
332 mw
.track( 'mw.deprecate', name
);
334 'Use of "' + name
+ '" is deprecated.' + ( msg
? ( ' ' + msg
) : '' )
338 // Support: Safari 5.0
339 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
340 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
342 Object
.defineProperty( obj
, key
, {
349 set: function ( newVal
) {
366 redefineFallbacksForTest: function () {
367 if ( !window
.QUnit
) {
368 throw new Error( 'Reset not allowed outside unit tests' );
374 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
376 * On browsers that implement the Navigation Timing API, this function will produce
377 * floating-point values with microsecond precision that are guaranteed to be monotonic.
378 * On all other browsers, it will fall back to using `Date`.
380 * @return {number} Current time
383 // Optimisation: Define the shortcut on first call, not at module definition.
384 var perf
= window
.performance
,
385 navStart
= perf
&& perf
.timing
&& perf
.timing
.navigationStart
;
387 // Define the relevant shortcut
388 mw
.now
= navStart
&& typeof perf
.now
=== 'function' ?
389 function () { return navStart
+ perf
.now(); } :
396 * List of all analytic events emitted so far.
401 trackQueue
: trackQueue
,
403 track: function ( topic
, data
) {
404 trackQueue
.push( { topic
: topic
, timeStamp
: mw
.now(), data
: data
} );
405 // The base module extends this method to fire events here
409 * Track an early error event via mw.track and send it to the window console.
412 * @param {string} topic Topic name
413 * @param {Object} data Data describing the event, encoded as an object; see mw#logError
415 trackError: function ( topic
, data
) {
416 mw
.track( topic
, data
);
417 logError( topic
, data
);
420 // Expose Map constructor
424 * Map of configuration values.
426 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
429 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
430 * global `window` object.
432 * @property {mw.Map} config
434 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
438 * Empty object for third-party libraries, for cases where you don't
439 * want to add a new global, or the global is bad and needs containment
447 * Access container for deprecated functionality that can be moved from
448 * from their legacy location and attached to this object (e.g. a global
449 * function that is deprecated and as stop-gap can be exposed through here).
451 * This was reserved for future use but never ended up being used.
453 * @deprecated since 1.22 Let deprecated identifiers keep their original name
454 * and use mw.log#deprecate to create an access container for tracking.
460 * Store for messages.
467 * Store for templates associated with a module.
471 templates
: new Map(),
477 * Client for ResourceLoader server end point.
479 * This client is in charge of maintaining the module registry and state
480 * machine, initiating network (batch) requests for loading modules, as
481 * well as dependency resolution and execution of source code.
483 * For more information, refer to
484 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
489 loader
: ( function () {
492 * Fired via mw.track on various resource loading errors.
494 * @event resourceloader_exception
495 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
496 * object, but in theory module code could manually throw something else, and that
497 * might also end up here.
498 * @param {string} [module] Name of the module which caused the error. Omitted if the
499 * error is not module-related or the module cannot be easily identified due to
501 * @param {string} source Source of the error. Possible values:
503 * - style: stylesheet error (only affects old IE where a special style loading method
505 * - load-callback: exception thrown by user callback
506 * - module-execute: exception thrown by module code
507 * - resolve: failed to sort dependencies for a module in mw.loader.load
508 * - store-eval: could not evaluate module code cached in localStorage
509 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
510 * - store-localstorage-json: JSON conversion error in mw.loader.store
511 * - store-localstorage-update: localStorage conversion error in mw.loader.store.
515 * Fired via mw.track on resource loading error conditions.
517 * @event resourceloader_assert
518 * @param {string} source Source of the error. Possible values:
520 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
521 * bug; see <https://phabricator.wikimedia.org/T59567> for details
525 * Mapping of registered modules.
527 * See #implement and #execute for exact details on support for script, style and messages.
533 * // From mw.loader.register()
534 * 'version': '########' (hash)
535 * 'dependencies': ['required.foo', 'bar.also', ...]
536 * 'group': 'somegroup', (or) null
537 * 'source': 'local', (or) 'anotherwiki'
538 * 'skip': 'return !!window.Example', (or) null
539 * 'module': export Object
541 * // Set from execute() or mw.loader.state()
542 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
544 * // Optionally added at run-time by mw.loader.implement()
546 * 'script': closure, array of urls, or string
547 * 'style': { ... } (see #execute)
548 * 'messages': { 'key': 'value', ... }
555 * The module is known to the system but not yet required.
556 * Meta data is registered via mw.loader#register. Calls to that method are
557 * generated server-side by the startup module.
559 * The module was required through mw.loader (either directly or as dependency of
560 * another module). The client will fetch module contents from the server.
561 * The contents are then stashed in the registry via mw.loader#implement.
563 * The module has been loaded from the server and stashed via mw.loader#implement.
564 * Once the module has no more dependencies in-flight, the module will be executed,
565 * controlled via #requestPropagation and #doPropagation.
567 * The module is being executed.
569 * The module has been successfully executed.
571 * The module (or one of its dependencies) produced an error during execution.
573 * The module was registered client-side and requested, but the server denied knowledge
574 * of the module's existence.
579 var registry
= Object
.create( null ),
580 // Mapping of sources, keyed by source-id, values are strings.
585 // 'sourceId': 'http://example.org/w/load.php'
588 sources
= Object
.create( null ),
590 // For queueModuleScript()
591 handlingPendingRequests
= false,
592 pendingRequests
= [],
594 // List of modules to be loaded
598 * List of callback jobs waiting for modules to be ready.
600 * Jobs are created by #enqueue() and run by #doPropagation().
601 * Typically when a job is created for a module, the job's dependencies contain
602 * both the required module and all its recursive dependencies.
607 * 'dependencies': [ module names ],
608 * 'ready': Function callback
609 * 'error': Function callback
612 * @property {Object[]} jobs
617 // For #requestPropagation() and #doPropagation()
618 willPropagate
= false,
623 * @property {Array} baseModules
625 baseModules
= $VARS
.baseModules
,
628 * For #addEmbeddedCSS() and #addLink()
631 * @property {HTMLElement|null} marker
633 marker
= document
.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
635 // For #addEmbeddedCSS()
637 rAF
= window
.requestAnimationFrame
|| setTimeout
;
640 * Create a new style element and add it to the DOM.
643 * @param {string} text CSS text
644 * @param {Node|null} [nextNode] The element where the style tag
645 * should be inserted before
646 * @return {HTMLElement} Reference to the created style element
648 function newStyleTag( text
, nextNode
) {
649 var el
= document
.createElement( 'style' );
650 el
.appendChild( document
.createTextNode( text
) );
651 if ( nextNode
&& nextNode
.parentNode
) {
652 nextNode
.parentNode
.insertBefore( el
, nextNode
);
654 document
.head
.appendChild( el
);
661 * @param {Object} cssBuffer
663 function flushCssBuffer( cssBuffer
) {
665 // Mark this object as inactive now so that further calls to addEmbeddedCSS() from
666 // the callbacks go to a new buffer instead of this one (T105973)
667 cssBuffer
.active
= false;
668 newStyleTag( cssBuffer
.cssText
, marker
);
669 for ( i
= 0; i
< cssBuffer
.callbacks
.length
; i
++ ) {
670 cssBuffer
.callbacks
[ i
]();
675 * Add a bit of CSS text to the current browser page.
677 * The creation and insertion of the `<style>` element is debounced for two reasons:
679 * - Performing the insertion before the next paint round via requestAnimationFrame
680 * avoids forced or wasted style recomputations, which are expensive in browsers.
681 * - Reduce how often new stylesheets are inserted by letting additional calls to this
682 * function accumulate into a buffer for at least one JavaScript tick. Modules are
683 * received from the server in batches, which means there is likely going to be many
684 * calls to this function in a row within the same tick / the same call stack.
688 * @param {string} cssText CSS text to be added in a `<style>` tag.
689 * @param {Function} callback Called after the insertion has occurred
691 function addEmbeddedCSS( cssText
, callback
) {
692 // Create a buffer if:
693 // - We don't have one yet.
694 // - The previous one is closed.
695 // - The next CSS chunk syntactically needs to be at the start of a stylesheet (T37562).
696 if ( !nextCssBuffer
|| nextCssBuffer
.active
=== false || cssText
.slice( 0, '@import'.length
) === '@import' ) {
704 // Linebreak for somewhat distinguishable sections
705 nextCssBuffer
.cssText
+= '\n' + cssText
;
706 nextCssBuffer
.callbacks
.push( callback
);
708 if ( nextCssBuffer
.active
=== null ) {
709 nextCssBuffer
.active
= true;
710 // The flushCssBuffer callback has its parameter bound by reference, which means
711 // 1) We can still extend the buffer from our object reference after this point.
712 // 2) We can safely re-assign the variable (not the object) to start a new buffer.
713 rAF( flushCssBuffer
.bind( null, nextCssBuffer
) );
719 * @param {Array} modules List of module names
720 * @return {string} Hash of concatenated version hashes.
722 function getCombinedVersion( modules
) {
723 var hashes
= modules
.reduce( function ( result
, module
) {
724 return result
+ registry
[ module
].version
;
726 return fnv132( hashes
);
730 * Determine whether all dependencies are in state 'ready', which means we may
731 * execute the module or job now.
734 * @param {Array} modules Names of modules to be checked
735 * @return {boolean} True if all modules are in state 'ready', false otherwise
737 function allReady( modules
) {
739 for ( i
= 0; i
< modules
.length
; i
++ ) {
740 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
748 * Determine whether all direct and base dependencies are in state 'ready'
751 * @param {string} module Name of the module to be checked
752 * @return {boolean} True if all direct/base dependencies are in state 'ready'; false otherwise
754 function allWithImplicitReady( module
) {
755 return allReady( registry
[ module
].dependencies
) &&
756 ( baseModules
.indexOf( module
) !== -1 || allReady( baseModules
) );
760 * Determine whether all dependencies are in state 'ready', which means we may
761 * execute the module or job now.
764 * @param {Array} modules Names of modules to be checked
765 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
767 function anyFailed( modules
) {
769 for ( i
= 0; i
< modules
.length
; i
++ ) {
770 state
= mw
.loader
.getState( modules
[ i
] );
771 if ( state
=== 'error' || state
=== 'missing' ) {
779 * Handle propagation of module state changes and reactions to them.
781 * - When a module reaches a failure state, this should be propagated to
782 * modules that depend on the failed module.
783 * - When a module reaches a final state, pending job callbacks for the
784 * module from mw.loader.using() should be called.
785 * - When a module reaches the 'ready' state from #execute(), consider
786 * executing dependant modules now having their dependencies satisfied.
787 * - When a module reaches the 'loaded' state from mw.loader.implement,
788 * consider executing it, if it has no unsatisfied dependencies.
792 function doPropagation() {
793 var errorModule
, baseModuleError
, module
, i
, failed
, job
,
796 // Keep going until the last iteration performed no actions.
798 didPropagate
= false;
800 // Stage 1: Propagate failures
801 while ( errorModules
.length
) {
802 errorModule
= errorModules
.shift();
803 baseModuleError
= baseModules
.indexOf( errorModule
) !== -1;
804 for ( module
in registry
) {
805 if ( registry
[ module
].state
!== 'error' && registry
[ module
].state
!== 'missing' ) {
806 if ( baseModuleError
&& baseModules
.indexOf( module
) === -1 ) {
807 // Propate error from base module to all regular (non-base) modules
808 registry
[ module
].state
= 'error';
810 } else if ( registry
[ module
].dependencies
.indexOf( errorModule
) !== -1 ) {
811 // Propagate error from dependency to depending module
812 registry
[ module
].state
= 'error';
813 // .. and propagate it further
814 errorModules
.push( module
);
821 // Stage 2: Execute 'loaded' modules with no unsatisfied dependencies
822 for ( module
in registry
) {
823 if ( registry
[ module
].state
=== 'loaded' && allWithImplicitReady( module
) ) {
824 // Recursively execute all dependent modules that were already loaded
825 // (waiting for execution) and no longer have unsatisfied dependencies.
826 // Base modules may have dependencies amongst eachother to ensure correct
827 // execution order. Regular modules wait for all base modules.
828 // eslint-disable-next-line no-use-before-define
834 // Stage 3: Invoke job callbacks that are no longer blocked
835 for ( i
= 0; i
< jobs
.length
; i
++ ) {
837 failed
= anyFailed( job
.dependencies
);
838 if ( failed
|| allReady( job
.dependencies
) ) {
842 if ( failed
&& job
.error
) {
843 job
.error( new Error( 'Module has failed dependencies' ), job
.dependencies
);
844 } else if ( !failed
&& job
.ready
) {
848 // A user-defined callback raised an exception.
849 // Swallow it to protect our state machine!
850 mw
.trackError( 'resourceloader.exception', {
852 source
: 'load-callback'
858 } while ( didPropagate
);
860 willPropagate
= false;
864 * Request a (debounced) call to doPropagation().
868 function requestPropagation() {
869 if ( willPropagate
) {
870 // Already scheduled, or, we're already in a doPropagation stack.
873 willPropagate
= true;
874 // Yield for two reasons:
875 // * Allow successive calls to mw.loader.implement() from the same
876 // load.php response, or from the same asyncEval() to be in the
877 // propagation batch.
878 // * Allow the browser to breathe between the reception of
879 // module source code and the execution of it.
881 // Use a high priority because the user may be waiting for interactions
882 // to start being possible. But, first provide a moment (up to 'timeout')
883 // for native input event handling (e.g. scrolling/typing/clicking).
884 mw
.requestIdleCallback( doPropagation
, { timeout
: 1 } );
888 * Update a module's state in the registry and make sure any neccesary
889 * propagation will occur. See #doPropagation for more about propagation.
890 * See #registry for more about how states are used.
893 * @param {string} module
894 * @param {string} state
896 function setAndPropagate( module
, state
) {
897 registry
[ module
].state
= state
;
898 if ( state
=== 'loaded' || state
=== 'ready' || state
=== 'error' || state
=== 'missing' ) {
899 if ( state
=== 'ready' ) {
900 // Queue to later be synced to the local module store.
901 mw
.loader
.store
.add( module
);
902 } else if ( state
=== 'error' || state
=== 'missing' ) {
903 errorModules
.push( module
);
905 requestPropagation();
910 * Resolve dependencies and detect circular references.
913 * @param {string} module Name of the top-level module whose dependencies shall be
914 * resolved and sorted.
915 * @param {Array} resolved Returns a topological sort of the given module and its
916 * dependencies, such that later modules depend on earlier modules. The array
917 * contains the module names. If the array contains already some module names,
918 * this function appends its result to the pre-existing array.
919 * @param {StringSet} [unresolved] Used to track the current dependency
920 * chain, and to report loops in the dependency graph.
921 * @throws {Error} If any unregistered module or a dependency loop is encountered
923 function sortDependencies( module
, resolved
, unresolved
) {
926 if ( !( module
in registry
) ) {
927 throw new Error( 'Unknown dependency: ' + module
);
930 if ( registry
[ module
].skip
!== null ) {
931 // eslint-disable-next-line no-new-func
932 skip
= new Function( registry
[ module
].skip
);
933 registry
[ module
].skip
= null;
935 registry
[ module
].skipped
= true;
936 registry
[ module
].dependencies
= [];
937 setAndPropagate( module
, 'ready' );
942 if ( resolved
.indexOf( module
) !== -1 ) {
943 // Module already resolved; nothing to do
946 // Create unresolved if not passed in
948 unresolved
= new StringSet();
952 if ( baseModules
.indexOf( module
) === -1 ) {
953 baseModules
.forEach( function ( baseModule
) {
954 if ( resolved
.indexOf( baseModule
) === -1 ) {
955 resolved
.push( baseModule
);
960 // Tracks down dependencies
961 deps
= registry
[ module
].dependencies
;
962 unresolved
.add( module
);
963 for ( i
= 0; i
< deps
.length
; i
++ ) {
964 if ( resolved
.indexOf( deps
[ i
] ) === -1 ) {
965 if ( unresolved
.has( deps
[ i
] ) ) {
967 'Circular reference detected: ' + module
+ ' -> ' + deps
[ i
]
971 sortDependencies( deps
[ i
], resolved
, unresolved
);
974 resolved
.push( module
);
978 * Get names of module that a module depends on, in their proper dependency order.
981 * @param {string[]} modules Array of string module names
982 * @return {Array} List of dependencies, including 'module'.
983 * @throws {Error} If an unregistered module or a dependency loop is encountered
985 function resolve( modules
) {
986 var i
, resolved
= [];
987 for ( i
= 0; i
< modules
.length
; i
++ ) {
988 sortDependencies( modules
[ i
], resolved
);
994 * Like #resolve(), except it will silently ignore modules that
995 * are missing or have missing dependencies.
998 * @param {string[]} modules Array of string module names
999 * @return {Array} List of dependencies.
1001 function resolveStubbornly( modules
) {
1002 var i
, saved
, resolved
= [];
1003 for ( i
= 0; i
< modules
.length
; i
++ ) {
1004 saved
= resolved
.slice();
1006 sortDependencies( modules
[ i
], resolved
);
1008 // This module is unknown or has unknown dependencies.
1009 // Undo any incomplete resolutions made and keep going.
1011 mw
.trackError( 'resourceloader.exception', {
1021 * Load and execute a script.
1024 * @param {string} src URL to script, will be used as the src attribute in the script tag
1025 * @param {Function} [callback] Callback to run after request resolution
1027 function addScript( src
, callback
) {
1028 var script
= document
.createElement( 'script' );
1030 script
.onload
= script
.onerror = function () {
1031 if ( script
.parentNode
) {
1032 script
.parentNode
.removeChild( script
);
1040 document
.head
.appendChild( script
);
1044 * Queue the loading and execution of a script for a particular module.
1046 * This does for debug mode what runScript() does for production.
1049 * @param {string} src URL of the script
1050 * @param {string} moduleName Name of currently executing module
1051 * @param {Function} callback Callback to run after addScript() resolution
1053 function queueModuleScript( src
, moduleName
, callback
) {
1054 pendingRequests
.push( function () {
1055 // Keep in sync with execute()/runScript().
1056 if ( moduleName
!== 'jquery' ) {
1057 window
.require
= mw
.loader
.require
;
1058 window
.module
= registry
[ moduleName
].module
;
1060 addScript( src
, function () {
1061 // 'module.exports' should not persist after the file is executed to
1062 // avoid leakage to unrelated code. 'require' should be kept, however,
1063 // as asynchronous access to 'require' is allowed and expected. (T144879)
1064 delete window
.module
;
1066 // Start the next one (if any)
1067 if ( pendingRequests
[ 0 ] ) {
1068 pendingRequests
.shift()();
1070 handlingPendingRequests
= false;
1074 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1075 handlingPendingRequests
= true;
1076 pendingRequests
.shift()();
1081 * Utility function for execute()
1084 * @param {string} [media] Media attribute
1085 * @param {string} url URL
1087 function addLink( media
, url
) {
1088 var el
= document
.createElement( 'link' );
1090 el
.rel
= 'stylesheet';
1091 if ( media
&& media
!== 'all' ) {
1094 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1095 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1098 if ( marker
&& marker
.parentNode
) {
1099 marker
.parentNode
.insertBefore( el
, marker
);
1101 document
.head
.appendChild( el
);
1107 * @param {string} code JavaScript code
1109 function domEval( code
) {
1110 var script
= document
.createElement( 'script' );
1111 if ( mw
.config
.get( 'wgCSPNonce' ) !== false ) {
1112 script
.nonce
= mw
.config
.get( 'wgCSPNonce' );
1115 document
.head
.appendChild( script
);
1116 script
.parentNode
.removeChild( script
);
1120 * Add one or more modules to the module load queue.
1125 * @param {string[]} dependencies Array of module names in the registry
1126 * @param {Function} [ready] Callback to execute when all dependencies are ready
1127 * @param {Function} [error] Callback to execute when any dependency fails
1129 function enqueue( dependencies
, ready
, error
) {
1130 if ( allReady( dependencies
) ) {
1131 // Run ready immediately
1132 if ( ready
!== undefined ) {
1138 if ( anyFailed( dependencies
) ) {
1139 if ( error
!== undefined ) {
1140 // Execute error immediately if any dependencies have errors
1142 new Error( 'One or more dependencies failed to load' ),
1149 // Not all dependencies are ready, add to the load queue...
1151 // Add ready and error callbacks if they were given
1152 if ( ready
!== undefined || error
!== undefined ) {
1154 // Narrow down the list to modules that are worth waiting for
1155 dependencies
: dependencies
.filter( function ( module
) {
1156 var state
= registry
[ module
].state
;
1157 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1164 dependencies
.forEach( function ( module
) {
1165 // Only queue modules that are still in the initial 'registered' state
1166 // (not ones already loading, ready or error).
1167 if ( registry
[ module
].state
=== 'registered' && queue
.indexOf( module
) === -1 ) {
1168 // Private modules must be embedded in the page. Don't bother queuing
1169 // these as the server will deny them anyway (T101806).
1170 if ( registry
[ module
].group
=== 'private' ) {
1171 setAndPropagate( module
, 'error' );
1174 queue
.push( module
);
1182 * Executes a loaded module, making it ready to use
1185 * @param {string} module Module name to execute
1187 function execute( module
) {
1188 var key
, value
, media
, i
, urls
, cssHandle
, siteDeps
, siteDepErr
, runScript
,
1191 if ( registry
[ module
].state
!== 'loaded' ) {
1192 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1195 registry
[ module
].state
= 'executing';
1196 $CODE
.profileExecuteStart();
1198 runScript = function () {
1199 var script
, markModuleReady
, nestedAddScript
;
1201 $CODE
.profileScriptStart();
1202 script
= registry
[ module
].script
;
1203 markModuleReady = function () {
1204 $CODE
.profileScriptEnd();
1205 setAndPropagate( module
, 'ready' );
1207 nestedAddScript = function ( arr
, callback
, i
) {
1208 // Recursively call queueModuleScript() in its own callback
1209 // for each element of arr.
1210 if ( i
>= arr
.length
) {
1211 // We're at the end of the array
1216 queueModuleScript( arr
[ i
], module
, function () {
1217 nestedAddScript( arr
, callback
, i
+ 1 );
1222 if ( Array
.isArray( script
) ) {
1223 nestedAddScript( script
, markModuleReady
, 0 );
1224 } else if ( typeof script
=== 'function' ) {
1225 // Keep in sync with queueModuleScript() for debug mode
1226 if ( module
=== 'jquery' ) {
1227 // This is a special case for when 'jquery' itself is being loaded.
1228 // - The standard jquery.js distribution does not set `window.jQuery`
1229 // in CommonJS-compatible environments (Node.js, AMD, RequireJS, etc.).
1230 // - MediaWiki's 'jquery' module also bundles jquery.migrate.js, which
1231 // in a CommonJS-compatible environment, will use require('jquery'),
1232 // but that can't work when we're still inside that module.
1235 // Pass jQuery twice so that the signature of the closure which wraps
1236 // the script can bind both '$' and 'jQuery'.
1237 script( window
.$, window
.$, mw
.loader
.require
, registry
[ module
].module
);
1241 } else if ( typeof script
=== 'string' ) {
1242 // Site and user modules are legacy scripts that run in the global scope.
1243 // This is transported as a string instead of a function to avoid needing
1244 // to use string manipulation to undo the function wrapper.
1249 // Module without script
1253 // Use mw.track instead of mw.log because these errors are common in production mode
1254 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1255 setAndPropagate( module
, 'error' );
1256 $CODE
.profileScriptEnd();
1257 mw
.trackError( 'resourceloader.exception', {
1260 source
: 'module-execute'
1265 // Add localizations to message system
1266 if ( registry
[ module
].messages
) {
1267 mw
.messages
.set( registry
[ module
].messages
);
1270 // Initialise templates
1271 if ( registry
[ module
].templates
) {
1272 mw
.templates
.set( module
, registry
[ module
].templates
);
1275 // Adding of stylesheets is asynchronous via addEmbeddedCSS().
1276 // The below function uses a counting semaphore to make sure we don't call
1277 // runScript() until after this module's stylesheets have been inserted
1279 cssHandle = function () {
1280 // Increase semaphore, when creating a callback for addEmbeddedCSS.
1282 return function () {
1284 // Decrease semaphore, when said callback is invoked.
1286 if ( cssPending
=== 0 ) {
1288 // This callback is exposed to addEmbeddedCSS, which is outside the execute()
1289 // function and is not concerned with state-machine integrity. In turn,
1290 // addEmbeddedCSS() actually exposes stuff further into the browser (rAF).
1291 // If increment and decrement callbacks happen in the wrong order, or start
1292 // again afterwards, then this branch could be reached multiple times.
1293 // To protect the integrity of the state-machine, prevent that from happening
1294 // by making runScript() cannot be called more than once. We store a private
1295 // reference when we first reach this branch, then deference the original, and
1296 // call our reference to it.
1297 runScriptCopy
= runScript
;
1298 runScript
= undefined;
1304 // Process styles (see also mw.loader.implement)
1305 // * back-compat: { <media>: css }
1306 // * back-compat: { <media>: [url, ..] }
1307 // * { "css": [css, ..] }
1308 // * { "url": { <media>: [url, ..] } }
1309 if ( registry
[ module
].style
) {
1310 for ( key
in registry
[ module
].style
) {
1311 value
= registry
[ module
].style
[ key
];
1314 if ( key
!== 'url' && key
!== 'css' ) {
1315 // Backwards compatibility, key is a media-type
1316 if ( typeof value
=== 'string' ) {
1317 // back-compat: { <media>: css }
1318 // Ignore 'media' because it isn't supported (nor was it used).
1319 // Strings are pre-wrapped in "@media". The media-type was just ""
1320 // (because it had to be set to something).
1321 // This is one of the reasons why this format is no longer used.
1322 addEmbeddedCSS( value
, cssHandle() );
1324 // back-compat: { <media>: [url, ..] }
1330 // Array of css strings in key 'css',
1331 // or back-compat array of urls from media-type
1332 if ( Array
.isArray( value
) ) {
1333 for ( i
= 0; i
< value
.length
; i
++ ) {
1334 if ( key
=== 'bc-url' ) {
1335 // back-compat: { <media>: [url, ..] }
1336 addLink( media
, value
[ i
] );
1337 } else if ( key
=== 'css' ) {
1338 // { "css": [css, ..] }
1339 addEmbeddedCSS( value
[ i
], cssHandle() );
1342 // Not an array, but a regular object
1343 // Array of urls inside media-type key
1344 } else if ( typeof value
=== 'object' ) {
1345 // { "url": { <media>: [url, ..] } }
1346 for ( media
in value
) {
1347 urls
= value
[ media
];
1348 for ( i
= 0; i
< urls
.length
; i
++ ) {
1349 addLink( media
, urls
[ i
] );
1356 // End profiling of execute()-self before we call runScript(),
1357 // which we want to measure separately without overlap.
1358 $CODE
.profileExecuteEnd();
1360 if ( module
=== 'user' ) {
1361 // Implicit dependency on the site module. Not a real dependency because it should
1362 // run after 'site' regardless of whether it succeeds or fails.
1363 // Note: This is a simplified version of mw.loader.using(), inlined here because
1364 // mw.loader.using() is part of mediawiki.base (depends on jQuery; T192623).
1366 siteDeps
= resolve( [ 'site' ] );
1371 if ( siteDepErr
=== undefined ) {
1372 enqueue( siteDeps
, runScript
, runScript
);
1374 } else if ( cssPending
=== 0 ) {
1375 // Regular module without styles
1378 // else: runScript will get called via cssHandle()
1381 function sortQuery( o
) {
1390 for ( key
= 0; key
< a
.length
; key
++ ) {
1391 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1397 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1398 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1400 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1401 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1403 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1404 * because its implementation needs to keep track of potential string size in order
1405 * to decide when to split the requests due to url size.
1408 * @param {Object} moduleMap Module map
1410 * @return {string} return.str Module query string
1411 * @return {Array} return.list List of module names in matching order
1413 function buildModulesString( moduleMap
) {
1418 function restore( suffix
) {
1422 for ( prefix
in moduleMap
) {
1423 p
= prefix
=== '' ? '' : prefix
+ '.';
1424 str
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1425 list
.push
.apply( list
, moduleMap
[ prefix
].map( restore
) );
1428 str
: str
.join( '|' ),
1434 * Resolve indexed dependencies.
1436 * ResourceLoader uses an optimisation to save space which replaces module names in
1437 * dependency lists with the index of that module within the array of module
1438 * registration data if it exists. The benefit is a significant reduction in the data
1439 * size of the startup module. This function changes those dependency lists back to
1440 * arrays of strings.
1443 * @param {Array} modules Modules array
1445 function resolveIndexedDependencies( modules
) {
1447 function resolveIndex( dep
) {
1448 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1450 for ( i
= 0; i
< modules
.length
; i
++ ) {
1451 deps
= modules
[ i
][ 2 ];
1453 for ( j
= 0; j
< deps
.length
; j
++ ) {
1454 deps
[ j
] = resolveIndex( deps
[ j
] );
1462 * @param {Object} params Map of parameter names to values
1465 function makeQueryString( params
) {
1466 return Object
.keys( params
).map( function ( key
) {
1467 return encodeURIComponent( key
) + '=' + encodeURIComponent( params
[ key
] );
1472 * Create network requests for a batch of modules.
1474 * This is an internal method for #work(). This must not be called directly
1475 * unless the modules are already registered, and no request is in progress,
1476 * and the module state has already been set to `loading`.
1479 * @param {string[]} batch
1481 function batchRequest( batch
) {
1482 var reqBase
, splits
, maxQueryLength
, b
, bSource
, bGroup
,
1483 source
, group
, i
, modules
, sourceLoadScript
,
1484 currReqBase
, currReqBaseLength
, moduleMap
, currReqModules
, l
,
1485 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1488 * Start the currently drafted request to the server.
1492 function doRequest() {
1493 // Optimisation: Inherit (Object.create), not copy ($.extend)
1494 var query
= Object
.create( currReqBase
),
1495 packed
= buildModulesString( moduleMap
);
1496 query
.modules
= packed
.str
;
1497 // The packing logic can change the effective order, even if the input was
1498 // sorted. As such, the call to getCombinedVersion() must use this
1499 // effective order, instead of currReqModules, as otherwise the combined
1500 // version will not match the hash expected by the server based on
1501 // combining versions from the module query string in-order. (T188076)
1502 query
.version
= getCombinedVersion( packed
.list
);
1503 query
= sortQuery( query
);
1504 addScript( sourceLoadScript
+ '?' + makeQueryString( query
) );
1507 if ( !batch
.length
) {
1511 // Always order modules alphabetically to help reduce cache
1512 // misses for otherwise identical content.
1515 // Query parameters common to all requests
1517 skin
: mw
.config
.get( 'skin' ),
1518 lang
: mw
.config
.get( 'wgUserLanguage' ),
1519 debug
: mw
.config
.get( 'debug' )
1521 maxQueryLength
= mw
.config
.get( 'wgResourceLoaderMaxQueryLength', 2000 );
1523 // Split module list by source and by group.
1524 splits
= Object
.create( null );
1525 for ( b
= 0; b
< batch
.length
; b
++ ) {
1526 bSource
= registry
[ batch
[ b
] ].source
;
1527 bGroup
= registry
[ batch
[ b
] ].group
;
1528 if ( !splits
[ bSource
] ) {
1529 splits
[ bSource
] = Object
.create( null );
1531 if ( !splits
[ bSource
][ bGroup
] ) {
1532 splits
[ bSource
][ bGroup
] = [];
1534 splits
[ bSource
][ bGroup
].push( batch
[ b
] );
1537 for ( source
in splits
) {
1538 sourceLoadScript
= sources
[ source
];
1540 for ( group
in splits
[ source
] ) {
1542 // Cache access to currently selected list of
1543 // modules for this group from this source.
1544 modules
= splits
[ source
][ group
];
1546 // Query parameters common to requests for this module group
1547 // Optimisation: Inherit (Object.create), not copy ($.extend)
1548 currReqBase
= Object
.create( reqBase
);
1549 // User modules require a user name in the query string.
1550 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1551 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1554 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1555 // > '&modules='.length === 9
1556 // > '&version=1234567'.length === 16
1558 currReqBaseLength
= makeQueryString( currReqBase
).length
+ 25;
1560 // We may need to split up the request to honor the query string length limit,
1561 // so build it piece by piece.
1562 l
= currReqBaseLength
;
1563 moduleMap
= Object
.create( null ); // { prefix: [ suffixes ] }
1564 currReqModules
= [];
1566 for ( i
= 0; i
< modules
.length
; i
++ ) {
1567 // Determine how many bytes this module would add to the query string
1568 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1569 // If lastDotIndex is -1, substr() returns an empty string
1570 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1571 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1572 bytesAdded
= moduleMap
[ prefix
] ?
1573 suffix
.length
+ 3 : // '%2C'.length == 3
1574 modules
[ i
].length
+ 3; // '%7C'.length == 3
1576 // If the url would become too long, create a new one, but don't create empty requests
1577 if ( maxQueryLength
> 0 && currReqModules
.length
&& l
+ bytesAdded
> maxQueryLength
) {
1578 // Dispatch what we've got...
1580 // .. and start again.
1581 l
= currReqBaseLength
;
1582 moduleMap
= Object
.create( null );
1583 currReqModules
= [];
1585 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: maxQueryLength
} );
1587 if ( !moduleMap
[ prefix
] ) {
1588 moduleMap
[ prefix
] = [];
1591 moduleMap
[ prefix
].push( suffix
);
1592 currReqModules
.push( modules
[ i
] );
1594 // If there's anything left in moduleMap, request that too
1595 if ( currReqModules
.length
) {
1604 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1605 * form of calls to mw.loader#implement().
1606 * @param {Function} cb Callback in case of failure
1607 * @param {Error} cb.err
1609 function asyncEval( implementations
, cb
) {
1610 if ( !implementations
.length
) {
1613 mw
.requestIdleCallback( function () {
1615 domEval( implementations
.join( ';' ) );
1623 * Make a versioned key for a specific module.
1626 * @param {string} module Module name
1627 * @return {string|null} Module key in format '`[name]@[version]`',
1628 * or null if the module does not exist
1630 function getModuleKey( module
) {
1631 return module
in registry
? ( module
+ '@' + registry
[ module
].version
) : null;
1636 * @param {string} key Module name or '`[name]@[version]`'
1639 function splitModuleKey( key
) {
1640 var index
= key
.indexOf( '@' );
1641 if ( index
=== -1 ) {
1648 name
: key
.slice( 0, index
),
1649 version
: key
.slice( index
+ 1 )
1655 * @param {string} module
1656 * @param {string|number} [version]
1657 * @param {string[]} [dependencies]
1658 * @param {string} [group]
1659 * @param {string} [source]
1660 * @param {string} [skip]
1662 function registerOne( module
, version
, dependencies
, group
, source
, skip
) {
1663 if ( module
in registry
) {
1664 throw new Error( 'module already registered: ' + module
);
1666 registry
[ module
] = {
1667 // Exposed to execute() for mw.loader.implement() closures.
1668 // Import happens via require().
1672 version
: String( version
|| '' ),
1673 dependencies
: dependencies
|| [],
1674 group
: typeof group
=== 'string' ? group
: null,
1675 source
: typeof source
=== 'string' ? source
: 'local',
1676 state
: 'registered',
1677 skip
: typeof skip
=== 'string' ? skip
: null
1681 /* Public Members */
1684 * The module registry is exposed as an aid for debugging and inspecting page
1685 * state; it is not a public interface for modifying the registry.
1691 moduleRegistry
: registry
,
1694 * @inheritdoc #newStyleTag
1697 addStyleTag
: newStyleTag
,
1704 * Start loading of all queued module dependencies.
1709 var q
, batch
, implementations
, sourceModules
;
1713 // Appends a list of modules from the queue to the batch
1714 for ( q
= 0; q
< queue
.length
; q
++ ) {
1715 // Only load modules which are registered
1716 if ( queue
[ q
] in registry
&& registry
[ queue
[ q
] ].state
=== 'registered' ) {
1717 // Prevent duplicate entries
1718 if ( batch
.indexOf( queue
[ q
] ) === -1 ) {
1719 batch
.push( queue
[ q
] );
1720 // Mark registered modules as loading
1721 registry
[ queue
[ q
] ].state
= 'loading';
1726 // Now that the queue has been processed into a batch, clear the queue.
1727 // This MUST happen before we initiate any eval or network request. Otherwise,
1728 // it is possible for a cached script to instantly trigger the same work queue
1729 // again; all before we've cleared it causing each request to include modules
1730 // which are already loaded.
1733 if ( !batch
.length
) {
1737 mw
.loader
.store
.init();
1738 if ( mw
.loader
.store
.enabled
) {
1739 implementations
= [];
1741 batch
= batch
.filter( function ( module
) {
1742 var implementation
= mw
.loader
.store
.get( module
);
1743 if ( implementation
) {
1744 implementations
.push( implementation
);
1745 sourceModules
.push( module
);
1750 asyncEval( implementations
, function ( err
) {
1752 // Not good, the cached mw.loader.implement calls failed! This should
1753 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1754 // Depending on how corrupt the string is, it is likely that some
1755 // modules' implement() succeeded while the ones after the error will
1756 // never run and leave their modules in the 'loading' state forever.
1757 mw
.loader
.store
.stats
.failed
++;
1759 // Since this is an error not caused by an individual module but by
1760 // something that infected the implement call itself, don't take any
1761 // risks and clear everything in this cache.
1762 mw
.loader
.store
.clear();
1764 mw
.trackError( 'resourceloader.exception', {
1766 source
: 'store-eval'
1768 // Re-add the failed ones that are still pending back to the batch
1769 failed
= sourceModules
.filter( function ( module
) {
1770 return registry
[ module
].state
=== 'loading';
1772 batchRequest( failed
);
1776 batchRequest( batch
);
1780 * Register a source.
1782 * The #work() method will use this information to split up requests by source.
1784 * mw.loader.addSource( { mediawikiwiki: 'https://www.mediawiki.org/w/load.php' } );
1787 * @param {Object} ids An object mapping ids to load.php end point urls
1788 * @throws {Error} If source id is already registered
1790 addSource: function ( ids
) {
1793 if ( id
in sources
) {
1794 throw new Error( 'source already registered: ' + id
);
1796 sources
[ id
] = ids
[ id
];
1801 * Register a module, letting the system know about it and its properties.
1803 * The startup module calls this method.
1805 * When using multiple module registration by passing an array, dependencies that
1806 * are specified as references to modules within the array will be resolved before
1807 * the modules are registered.
1809 * @param {string|Array} modules Module name or array of arrays, each containing
1810 * a list of arguments compatible with this method
1811 * @param {string|number} [version] Module version hash (falls backs to empty string)
1812 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1813 * @param {string[]} [dependencies] Array of module names on which this module depends.
1814 * @param {string} [group=null] Group which the module is in
1815 * @param {string} [source='local'] Name of the source
1816 * @param {string} [skip=null] Script body of the skip function
1818 register: function ( modules
) {
1820 if ( typeof modules
=== 'object' ) {
1821 resolveIndexedDependencies( modules
);
1822 // Optimisation: Up to 55% faster.
1823 // Typically called only once, and with a batch.
1824 // See <https://gist.github.com/Krinkle/f06fdb3de62824c6c16f02a0e6ce0e66>
1825 // Benchmarks taught us that the code for adding an object to `registry`
1826 // should actually be inline, or in a simple function that does no
1827 // arguments manipulation, and isn't also the caller itself.
1828 // JS semantics make it hard to optimise recursion to a different
1829 // signature of itself.
1830 for ( i
= 0; i
< modules
.length
; i
++ ) {
1831 registerOne
.apply( null, modules
[ i
] );
1834 registerOne
.apply( null, arguments
);
1839 * Implement a module given the components that make up the module.
1841 * When #load() or #using() requests one or more modules, the server
1842 * response contain calls to this function.
1844 * @param {string} module Name of module and current module version. Formatted
1845 * as '`[name]@[version]`". This version should match the requested version
1846 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1847 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1848 * @param {Function|Array|string} [script] Function with module code, list of URLs
1849 * to load via `<script src>`, or string of module code for `$.globalEval()`.
1850 * @param {Object} [style] Should follow one of the following patterns:
1852 * { "css": [css, ..] }
1853 * { "url": { <media>: [url, ..] } }
1855 * And for backwards compatibility (needs to be supported forever due to caching):
1858 * { <media>: [url, ..] }
1860 * The reason css strings are not concatenated anymore is T33676. We now check
1861 * whether it's safe to extend the stylesheet.
1864 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1865 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1867 implement: function ( module
, script
, style
, messages
, templates
) {
1868 var split
= splitModuleKey( module
),
1870 version
= split
.version
;
1871 // Automatically register module
1872 if ( !( name
in registry
) ) {
1873 mw
.loader
.register( name
);
1875 // Check for duplicate implementation
1876 if ( registry
[ name
].script
!== undefined ) {
1877 throw new Error( 'module already implemented: ' + name
);
1880 // Without this reset, if there is a version mismatch between the
1881 // requested and received module version, then mw.loader.store would
1882 // cache the response under the requested key. Thus poisoning the cache
1883 // indefinitely with a stale value. (T117587)
1884 registry
[ name
].version
= version
;
1886 // Attach components
1887 registry
[ name
].script
= script
|| null;
1888 registry
[ name
].style
= style
|| null;
1889 registry
[ name
].messages
= messages
|| null;
1890 registry
[ name
].templates
= templates
|| null;
1891 // The module may already have been marked as erroneous
1892 if ( registry
[ name
].state
!== 'error' && registry
[ name
].state
!== 'missing' ) {
1893 setAndPropagate( name
, 'loaded' );
1898 * Load an external script or one or more modules.
1900 * This method takes a list of unrelated modules. Use cases:
1902 * - A web page will be composed of many different widgets. These widgets independently
1903 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
1904 * have problems, or are no longer known (e.g. cached HTML), the other modules
1905 * should still be loaded.
1906 * - This method is used for preloading, which must not throw. Later code that
1907 * calls #using() will handle the error.
1909 * @param {string|Array} modules Either the name of a module, array of modules,
1910 * or a URL of an external script or style
1911 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
1912 * external script or style; acceptable values are "text/css" and
1913 * "text/javascript"; if no type is provided, text/javascript is assumed.
1915 load: function ( modules
, type
) {
1918 // Allow calling with a url or single dependency as a string
1919 if ( typeof modules
=== 'string' ) {
1920 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
1921 if ( /^(https?:)?\/?\//.test( modules
) ) {
1922 if ( type
=== 'text/css' ) {
1923 l
= document
.createElement( 'link' );
1924 l
.rel
= 'stylesheet';
1926 document
.head
.appendChild( l
);
1929 if ( type
=== 'text/javascript' || type
=== undefined ) {
1930 addScript( modules
);
1934 throw new Error( 'invalid type for external url, must be text/css or text/javascript. not ' + type
);
1936 // Called with single module
1937 modules
= [ modules
];
1940 // Filter out top-level modules that are unknown or failed to load before.
1941 filtered
= modules
.filter( function ( module
) {
1942 var state
= mw
.loader
.getState( module
);
1943 return state
!== 'error' && state
!== 'missing';
1945 // Resolve remaining list using the known dependency tree.
1946 // This also filters out modules with unknown dependencies. (T36853)
1947 filtered
= resolveStubbornly( filtered
);
1948 // Some modules are not yet ready, add to module load queue.
1949 enqueue( filtered
, undefined, undefined );
1953 * Change the state of one or more modules.
1955 * @param {Object} states Object of module name/state pairs
1957 state: function ( states
) {
1959 for ( module
in states
) {
1960 state
= states
[ module
];
1961 if ( !( module
in registry
) ) {
1962 mw
.loader
.register( module
);
1964 setAndPropagate( module
, state
);
1969 * Get the version of a module.
1971 * @param {string} module Name of module
1972 * @return {string|null} The version, or null if the module (or its version) is not
1975 getVersion: function ( module
) {
1976 return module
in registry
? registry
[ module
].version
: null;
1980 * Get the state of a module.
1982 * @param {string} module Name of module
1983 * @return {string|null} The state, or null if the module (or its state) is not
1986 getState: function ( module
) {
1987 return module
in registry
? registry
[ module
].state
: null;
1991 * Get the names of all registered modules.
1995 getModuleNames: function () {
1996 return Object
.keys( registry
);
2000 * Get the exported value of a module.
2002 * This static method is publicly exposed for debugging purposes
2003 * only and must not be used in production code. In production code,
2004 * please use the dynamically provided `require()` function instead.
2006 * In case of lazy-loaded modules via mw.loader#using(), the returned
2007 * Promise provides the function, see #using() for examples.
2011 * @param {string} moduleName Module name
2012 * @return {Mixed} Exported value
2014 require: function ( moduleName
) {
2015 var state
= mw
.loader
.getState( moduleName
);
2017 // Only ready modules can be required
2018 if ( state
!== 'ready' ) {
2019 // Module may've forgotten to declare a dependency
2020 throw new Error( 'Module "' + moduleName
+ '" is not loaded.' );
2023 return registry
[ moduleName
].module
.exports
;
2027 * On browsers that implement the localStorage API, the module store serves as a
2028 * smart complement to the browser cache. Unlike the browser cache, the module store
2029 * can slice a concatenated response from ResourceLoader into its constituent
2030 * modules and cache each of them separately, using each module's versioning scheme
2031 * to determine when the cache should be invalidated.
2035 * @class mw.loader.store
2038 // Whether the store is in use on this page.
2041 // Modules whose string representation exceeds 100 kB are
2042 // ineligible for storage. See bug T66721.
2043 MODULE_SIZE_MAX
: 100 * 1000,
2045 // The contents of the store, mapping '[name]@[version]' keys
2046 // to module implementations.
2049 // Names of modules to be stored during the next update.
2050 // See add() and update().
2054 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2057 * Construct a JSON-serializable object representing the content of the store.
2059 * @return {Object} Module store contents.
2061 toJSON: function () {
2062 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2066 * Get the localStorage key for the entire module store. The key references
2067 * $wgDBname to prevent clashes between wikis which share a common host.
2069 * @return {string} localStorage item key
2071 getStoreKey: function () {
2072 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2076 * Get a key on which to vary the module cache.
2078 * @return {string} String of concatenated vary conditions.
2080 getVary: function () {
2081 return mw
.config
.get( 'skin' ) + ':' +
2082 mw
.config
.get( 'wgResourceLoaderStorageVersion' ) + ':' +
2083 mw
.config
.get( 'wgUserLanguage' );
2087 * Initialize the store.
2089 * Retrieves store from localStorage and (if successfully retrieved) decoding
2090 * the stored JSON value to a plain object.
2092 * The try / catch block is used for JSON & localStorage feature detection.
2093 * See the in-line documentation for Modernizr's localStorage feature detection
2094 * code for a full account of why we need a try / catch:
2095 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2100 if ( this.enabled
!== null ) {
2106 // Disabled because localStorage quotas are tight and (in Firefox's case)
2107 // shared by multiple origins.
2108 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2109 /Firefox/.test( navigator
.userAgent
) ||
2111 // Disabled by configuration.
2112 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2114 // Clear any previous store to free up space. (T66721)
2116 this.enabled
= false;
2119 if ( mw
.config
.get( 'debug' ) ) {
2120 // Disable module store in debug mode
2121 this.enabled
= false;
2126 // This a string we stored, or `null` if the key does not (yet) exist.
2127 raw
= localStorage
.getItem( this.getStoreKey() );
2128 // If we get here, localStorage is available; mark enabled
2129 this.enabled
= true;
2130 // If null, JSON.parse() will cast to string and re-parse, still null.
2131 data
= JSON
.parse( raw
);
2132 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== this.getVary() ) {
2133 this.items
= data
.items
;
2137 mw
.trackError( 'resourceloader.exception', {
2139 source
: 'store-localstorage-init'
2143 // If we get here, one of four things happened:
2145 // 1. localStorage did not contain our store key.
2146 // This means `raw` is `null`, and we're on a fresh page view (cold cache).
2147 // The store was enabled, and `items` starts fresh.
2149 // 2. localStorage contained parseable data under our store key,
2150 // but it's not applicable to our current context (see getVary).
2151 // The store was enabled, and `items` starts fresh.
2153 // 3. JSON.parse threw (localStorage contained corrupt data).
2154 // This means `raw` contains a string.
2155 // The store was enabled, and `items` starts fresh.
2157 // 4. localStorage threw (disabled or otherwise unavailable).
2158 // This means `raw` was never assigned.
2159 // We will disable the store below.
2160 if ( raw
=== undefined ) {
2161 // localStorage failed; disable store
2162 this.enabled
= false;
2167 * Retrieve a module from the store and update cache hit stats.
2169 * @param {string} module Module name
2170 * @return {string|boolean} Module implementation or false if unavailable
2172 get: function ( module
) {
2175 if ( !this.enabled
) {
2179 key
= getModuleKey( module
);
2180 if ( key
in this.items
) {
2182 return this.items
[ key
];
2184 this.stats
.misses
++;
2189 * Queue the name of a module that the next update should consider storing.
2192 * @param {string} module Module name
2194 add: function ( module
) {
2195 if ( !this.enabled
) {
2198 this.queue
.push( module
);
2199 this.requestUpdate();
2203 * Add the contents of the named module to the in-memory store.
2205 * This method does not guarantee that the module will be stored.
2206 * Inspection of the module's meta data and size will ultimately decide that.
2208 * This method is considered internal to mw.loader.store and must only
2209 * be called if the store is enabled.
2212 * @param {string} module Module name
2214 set: function ( module
) {
2216 descriptor
= mw
.loader
.moduleRegistry
[ module
];
2218 key
= getModuleKey( module
);
2221 // Already stored a copy of this exact version
2222 key
in this.items
||
2223 // Module failed to load
2225 descriptor
.state
!== 'ready' ||
2226 // Unversioned, private, or site-/user-specific
2227 !descriptor
.version
||
2228 descriptor
.group
=== 'private' ||
2229 descriptor
.group
=== 'user' ||
2230 // Partial descriptor
2231 // (e.g. skipped module, or style module with state=ready)
2232 [ descriptor
.script
, descriptor
.style
, descriptor
.messages
,
2233 descriptor
.templates
].indexOf( undefined ) !== -1
2241 JSON
.stringify( key
),
2242 typeof descriptor
.script
=== 'function' ?
2243 String( descriptor
.script
) :
2244 JSON
.stringify( descriptor
.script
),
2245 JSON
.stringify( descriptor
.style
),
2246 JSON
.stringify( descriptor
.messages
),
2247 JSON
.stringify( descriptor
.templates
)
2250 mw
.trackError( 'resourceloader.exception', {
2252 source
: 'store-localstorage-json'
2257 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2258 if ( src
.length
> this.MODULE_SIZE_MAX
) {
2261 this.items
[ key
] = src
;
2265 * Iterate through the module store, removing any item that does not correspond
2266 * (in name and version) to an item in the module registry.
2268 prune: function () {
2271 for ( key
in this.items
) {
2272 module
= key
.slice( 0, key
.indexOf( '@' ) );
2273 if ( getModuleKey( module
) !== key
) {
2274 this.stats
.expired
++;
2275 delete this.items
[ key
];
2276 } else if ( this.items
[ key
].length
> this.MODULE_SIZE_MAX
) {
2277 // This value predates the enforcement of a size limit on cached modules.
2278 delete this.items
[ key
];
2284 * Clear the entire module store right now.
2286 clear: function () {
2289 localStorage
.removeItem( this.getStoreKey() );
2294 * Request a sync of the in-memory store back to persisted localStorage.
2296 * This function debounces updates. The debouncing logic should account
2297 * for the following factors:
2299 * - Writing to localStorage is an expensive operation that must not happen
2300 * during the critical path of initialising and executing module code.
2301 * Instead, it should happen at a later time after modules have been given
2302 * time and priority to do their thing first.
2304 * - This method is called from mw.loader.store.add(), which will be called
2305 * hundreds of times on a typical page, including within the same call-stack
2306 * and eventloop-tick. This is because responses from load.php happen in
2307 * batches. As such, we want to allow all modules from the same load.php
2308 * response to be written to disk with a single flush, not many.
2310 * - Repeatedly deleting and creating timers is non-trivial.
2312 * - localStorage is shared by all pages from the same origin, if multiple
2313 * pages are loaded with different module sets, the possibility exists that
2314 * modules saved by one page will be clobbered by another. The impact of
2315 * this is minor, it merely causes a less efficient cache use, and the
2316 * problem would be corrected by subsequent page views.
2318 * This method is considered internal to mw.loader.store and must only
2319 * be called if the store is enabled.
2324 requestUpdate
: ( function () {
2325 var hasPendingWrites
= false;
2327 function flushWrites() {
2330 // Remove anything from the in-memory store that came from previous page
2331 // loads that no longer corresponds with current module names and versions.
2332 mw
.loader
.store
.prune();
2333 // Process queued module names, serialise their contents to the in-memory store.
2334 while ( mw
.loader
.store
.queue
.length
) {
2335 mw
.loader
.store
.set( mw
.loader
.store
.queue
.shift() );
2338 key
= mw
.loader
.store
.getStoreKey();
2340 // Replacing the content of the module store might fail if the new
2341 // contents would exceed the browser's localStorage size limit. To
2342 // avoid clogging the browser with stale data, always remove the old
2343 // value before attempting to set the new one.
2344 localStorage
.removeItem( key
);
2345 data
= JSON
.stringify( mw
.loader
.store
);
2346 localStorage
.setItem( key
, data
);
2348 mw
.trackError( 'resourceloader.exception', {
2350 source
: 'store-localstorage-update'
2354 // Let the next call to requestUpdate() create a new timer.
2355 hasPendingWrites
= false;
2358 function onTimeout() {
2359 // Defer the actual write via requestIdleCallback
2360 mw
.requestIdleCallback( flushWrites
);
2363 return function () {
2364 // On the first call to requestUpdate(), create a timer that
2365 // waits at least two seconds, then calls onTimeout.
2366 // The main purpose is to allow the current batch of load.php
2367 // responses to complete before we do anything. This batch can
2368 // trigger many hundreds of calls to requestUpdate().
2369 if ( !hasPendingWrites
) {
2370 hasPendingWrites
= true;
2371 setTimeout( onTimeout
, 2000 );
2379 // Skeleton user object, extended by the 'mediawiki.user' module.
2386 * @property {mw.Map}
2390 * @property {mw.Map}
2395 // OOUI widgets specific to MediaWiki
2400 // Attach to window and globally alias
2401 window
.mw
= window
.mediaWiki
= mw
;