e110b95f6febdd795c489b6c9a4f302ed75b4a47
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
,
16 hasOwn
= Object
.prototype.hasOwnProperty
;
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 var hash
= 0x811C9DC5,
34 /* eslint-disable no-bitwise */
35 for ( ; 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 ) {
44 /* 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
) {
104 console
= window
.console
;
106 if ( console
&& console
.log
) {
107 msg
= ( e
? 'Exception' : 'Error' ) +
108 ' in ' + data
.source
+
109 ( data
.module
? ' in module ' + data
.module
: '' ) +
114 // If we have an exception object, log it to the warning channel to trigger
115 // proper stacktraces in browsers that support it.
116 if ( e
&& console
.warn
) {
123 * Create an object that can be read from or written to via methods that allow
124 * interaction both with single and multiple properties at once.
130 * @param {boolean} [global=false] Whether to synchronise =values to the global
131 * window object (for backwards-compatibility with mw.config; T72470). Values are
132 * copied in one direction only. Changes to globals do not reflect in the map.
134 function Map( global
) {
135 this.values
= Object
.create( null );
136 if ( global
=== true ) {
137 // Override #set to also set the global variable
138 this.set = function ( selection
, value
) {
140 if ( arguments
.length
> 1 ) {
141 if ( typeof selection
=== 'string' ) {
142 setGlobalMapValue( this, selection
, value
);
145 } else if ( typeof selection
=== 'object' ) {
146 for ( s
in selection
) {
147 setGlobalMapValue( this, s
, selection
[ s
] );
160 * Get the value of one or more keys.
162 * If called with no arguments, all values are returned.
164 * @param {string|Array} [selection] Key or array of keys to retrieve values for.
165 * @param {Mixed} [fallback=null] Value for keys that don't exist.
166 * @return {Mixed|Object|null} If selection was a string, returns the value,
167 * If selection was an array, returns an object of key/values.
168 * If no selection is passed, a new object with all key/values is returned.
170 get: function ( selection
, fallback
) {
172 fallback
= arguments
.length
> 1 ? fallback
: null;
174 if ( Array
.isArray( selection
) ) {
176 for ( i
= 0; i
< selection
.length
; i
++ ) {
177 if ( typeof selection
[ i
] === 'string' ) {
178 results
[ selection
[ i
] ] = selection
[ i
] in this.values
?
179 this.values
[ selection
[ i
] ] :
186 if ( typeof selection
=== 'string' ) {
187 return selection
in this.values
?
188 this.values
[ selection
] :
192 if ( selection
=== undefined ) {
194 for ( i
in this.values
) {
195 results
[ i
] = this.values
[ i
];
200 // Invalid selection key
205 * Set one or more key/value pairs.
207 * @param {string|Object} selection Key to set value for, or object mapping keys to values
208 * @param {Mixed} [value] Value to set (optional, only in use when key is a string)
209 * @return {boolean} True on success, false on failure
211 set: function ( selection
, value
) {
213 // Use `arguments.length` because `undefined` is also a valid value.
214 if ( arguments
.length
> 1 ) {
216 if ( typeof selection
=== 'string' ) {
217 this.values
[ selection
] = value
;
220 } else if ( typeof selection
=== 'object' ) {
222 for ( s
in selection
) {
223 this.values
[ s
] = selection
[ s
];
231 * Check if one or more keys exist.
233 * @param {Mixed} selection Key or array of keys to check
234 * @return {boolean} True if the key(s) exist
236 exists: function ( selection
) {
238 if ( Array
.isArray( selection
) ) {
239 for ( i
= 0; i
< selection
.length
; i
++ ) {
240 if ( typeof selection
[ i
] !== 'string' || !( selection
[ i
] in this.values
) ) {
246 return typeof selection
=== 'string' && selection
in this.values
;
252 log
= ( function () {
254 * Write a verbose message to the browser's console in debug mode.
256 * This method is mainly intended for verbose logging. It is a no-op in production mode.
257 * In ResourceLoader debug mode, it will use the browser's console if available, with
258 * fallback to creating a console interface in the DOM and logging messages there.
260 * See {@link mw.log} for other logging methods.
263 * @param {...string} msg Messages to output to console.
265 var log = function () {},
266 console
= window
.console
;
268 // Note: Keep list of methods in sync with restoration in mediawiki.log.js
269 // when adding or removing mw.log methods below!
272 * Collection of methods to help log messages to the console.
279 * Write a message to the browser console's warning channel.
281 * This method is a no-op in browsers that don't implement the Console API.
283 * @param {...string} msg Messages to output to console
285 log
.warn
= console
&& console
.warn
?
286 Function
.prototype.bind
.call( console
.warn
, console
) :
290 * Write a message to the browser console's error channel.
292 * Most browsers also print a stacktrace when calling this method if the
293 * argument is an Error object.
295 * This method is a no-op in browsers that don't implement the Console API.
298 * @param {...Mixed} msg Messages to output to console
300 log
.error
= console
&& console
.error
?
301 Function
.prototype.bind
.call( console
.error
, console
) :
305 * Create a property on a host object that, when accessed, will produce
306 * a deprecation warning in the console.
308 * @param {Object} obj Host object of deprecated property
309 * @param {string} key Name of property to create in `obj`
310 * @param {Mixed} val The value this property should return when accessed
311 * @param {string} [msg] Optional text to include in the deprecation message
312 * @param {string} [logName] Name for the feature for logging and tracking
313 * purposes. Except for properties of the window object, tracking is only
314 * enabled if logName is set.
316 log
.deprecate = function ( obj
, key
, val
, msg
, logName
) {
318 function maybeLog() {
319 var name
= logName
|| key
,
320 trace
= new Error().stack
;
322 stacks
= new StringSet();
324 if ( !stacks
.has( trace
) ) {
326 if ( logName
|| obj
=== window
) {
327 mw
.track( 'mw.deprecate', name
);
330 'Use of "' + name
+ '" is deprecated.' + ( msg
? ' ' + msg
: '' )
334 // Support: Safari 5.0
335 // Throws "not supported on DOM Objects" for Node or Element objects (incl. document)
336 // Safari 4.0 doesn't have this method, and it was fixed in Safari 5.1.
338 Object
.defineProperty( obj
, key
, {
345 set: function ( newVal
) {
362 redefineFallbacksForTest: function () {
363 if ( !window
.QUnit
) {
364 throw new Error( 'Not allowed' );
370 * Get the current time, measured in milliseconds since January 1, 1970 (UTC).
372 * On browsers that implement the Navigation Timing API, this function will produce
373 * floating-point values with microsecond precision that are guaranteed to be monotonic.
374 * On all other browsers, it will fall back to using `Date`.
376 * @return {number} Current time
379 // Optimisation: Make startup initialisation faster by defining the
380 // shortcut on first call, not at module definition.
381 var perf
= window
.performance
,
382 navStart
= perf
&& perf
.timing
&& perf
.timing
.navigationStart
;
384 // Define the relevant shortcut
385 mw
.now
= navStart
&& perf
.now
?
386 function () { return navStart
+ perf
.now(); } :
393 * List of all analytic events emitted so far.
395 * Exposed only for use by mediawiki.base.
402 track: function ( topic
, data
) {
403 mw
.trackQueue
.push( { topic
: topic
, timeStamp
: mw
.now(), data
: data
} );
404 // This method is extended by mediawiki.base to also fire events.
408 * Track an early error event via mw.track and send it to the window console.
411 * @param {string} topic Topic name
412 * @param {Object} data Data describing the event, encoded as an object; see mw#logError
414 trackError: function ( topic
, data
) {
415 mw
.track( topic
, data
);
416 logError( topic
, data
);
419 // Expose Map constructor
423 * Map of configuration values.
425 * Check out [the complete list of configuration values](https://www.mediawiki.org/wiki/Manual:Interface/JavaScript#mw.config)
428 * If `$wgLegacyJavaScriptGlobals` is true, this Map will add its values to the
429 * global `window` object.
431 * @property {mw.Map} config
433 // Dummy placeholder later assigned in ResourceLoaderStartUpModule
437 * Empty object for third-party libraries, for cases where you don't
438 * want to add a new global, or the global is bad and needs containment
446 * Access container for deprecated functionality that can be moved from
447 * from their legacy location and attached to this object (e.g. a global
448 * function that is deprecated and as stop-gap can be exposed through here).
450 * This was reserved for future use but never ended up being used.
452 * @deprecated since 1.22 Let deprecated identifiers keep their original name
453 * and use mw.log#deprecate to create an access container for tracking.
459 * Store for messages.
466 * Store for templates associated with a module.
470 templates
: new Map(),
476 * Client for ResourceLoader server end point.
478 * This client is in charge of maintaining the module registry and state
479 * machine, initiating network (batch) requests for loading modules, as
480 * well as dependency resolution and execution of source code.
482 * For more information, refer to
483 * <https://www.mediawiki.org/wiki/ResourceLoader/Features>
488 loader
: ( function () {
491 * Fired via mw.track on various resource loading errors.
493 * @event resourceloader_exception
494 * @param {Error|Mixed} e The error that was thrown. Almost always an Error
495 * object, but in theory module code could manually throw something else, and that
496 * might also end up here.
497 * @param {string} [module] Name of the module which caused the error. Omitted if the
498 * error is not module-related or the module cannot be easily identified due to
500 * @param {string} source Source of the error. Possible values:
502 * - style: stylesheet error (only affects old IE where a special style loading method
504 * - load-callback: exception thrown by user callback
505 * - module-execute: exception thrown by module code
506 * - resolve: failed to sort dependencies for a module in mw.loader.load
507 * - store-eval: could not evaluate module code cached in localStorage
508 * - store-localstorage-init: localStorage or JSON parse error in mw.loader.store.init
509 * - store-localstorage-json: JSON conversion error in mw.loader.store
510 * - store-localstorage-update: localStorage conversion error in mw.loader.store.
514 * Fired via mw.track on resource loading error conditions.
516 * @event resourceloader_assert
517 * @param {string} source Source of the error. Possible values:
519 * - bug-T59567: failed to cache script due to an Opera function -> string conversion
520 * bug; see <https://phabricator.wikimedia.org/T59567> for details
524 * Mapping of registered modules.
526 * See #implement and #execute for exact details on support for script, style and messages.
532 * // From mw.loader.register()
533 * 'version': '########' (hash)
534 * 'dependencies': ['required.foo', 'bar.also', ...]
535 * 'group': 'somegroup', (or) null
536 * 'source': 'local', (or) 'anotherwiki'
537 * 'skip': 'return !!window.Example', (or) null
538 * 'module': export Object
540 * // Set from execute() or mw.loader.state()
541 * 'state': 'registered', 'loaded', 'loading', 'ready', 'error', or 'missing'
543 * // Optionally added at run-time by mw.loader.implement()
545 * 'script': closure, array of urls, or string
546 * 'style': { ... } (see #execute)
547 * 'messages': { 'key': 'value', ... }
554 * The module is known to the system but not yet required.
555 * Meta data is registered via mw.loader#register. Calls to that method are
556 * generated server-side by the startup module.
558 * The module was required through mw.loader (either directly or as dependency of
559 * another module). The client will fetch module contents from the server.
560 * The contents are then stashed in the registry via mw.loader#implement.
562 * The module has been loaded from the server and stashed via mw.loader#implement.
563 * Once the module has no more dependencies in-flight, the module will be executed,
564 * controlled via #requestPropagation and #doPropagation.
566 * The module is being executed.
568 * The module has been successfully executed.
570 * The module (or one of its dependencies) produced an error during execution.
572 * The module was registered client-side and requested, but the server denied knowledge
573 * of the module's existence.
578 var registry
= Object
.create( null ),
579 // Mapping of sources, keyed by source-id, values are strings.
584 // 'sourceId': 'http://example.org/w/load.php'
587 sources
= Object
.create( null ),
589 // For queueModuleScript()
590 handlingPendingRequests
= false,
591 pendingRequests
= [],
593 // List of modules to be loaded
597 * List of callback jobs waiting for modules to be ready.
599 * Jobs are created by #enqueue() and run by #doPropagation().
600 * Typically when a job is created for a module, the job's dependencies contain
601 * both the required module and all its recursive dependencies.
606 * 'dependencies': [ module names ],
607 * 'ready': Function callback
608 * 'error': Function callback
611 * @property {Object[]} jobs
616 // For #requestPropagation() and #doPropagation()
617 willPropagate
= false,
622 * @property {Array} baseModules
624 baseModules
= $VARS
.baseModules
,
627 * For #addEmbeddedCSS() and #addLink()
630 * @property {HTMLElement|null} marker
632 marker
= document
.querySelector( 'meta[name="ResourceLoaderDynamicStyles"]' ),
634 // For #addEmbeddedCSS()
636 rAF
= window
.requestAnimationFrame
|| setTimeout
;
639 * Create a new style element and add it to the DOM.
642 * @param {string} text CSS text
643 * @param {Node|null} [nextNode] The element where the style tag
644 * should be inserted before
645 * @return {HTMLElement} Reference to the created style element
647 function newStyleTag( text
, nextNode
) {
648 var el
= document
.createElement( 'style' );
649 el
.appendChild( document
.createTextNode( text
) );
650 if ( nextNode
&& nextNode
.parentNode
) {
651 nextNode
.parentNode
.insertBefore( el
, nextNode
);
653 document
.head
.appendChild( el
);
660 * @param {Object} cssBuffer
662 function flushCssBuffer( cssBuffer
) {
664 // Mark this object as inactive now so that further calls to addEmbeddedCSS() from
665 // the callbacks go to a new buffer instead of this one (T105973)
666 cssBuffer
.active
= false;
667 newStyleTag( cssBuffer
.cssText
, marker
);
668 for ( i
= 0; i
< cssBuffer
.callbacks
.length
; i
++ ) {
669 cssBuffer
.callbacks
[ i
]();
674 * Add a bit of CSS text to the current browser page.
676 * The creation and insertion of the `<style>` element is debounced for two reasons:
678 * - Performing the insertion before the next paint round via requestAnimationFrame
679 * avoids forced or wasted style recomputations, which are expensive in browsers.
680 * - Reduce how often new stylesheets are inserted by letting additional calls to this
681 * function accumulate into a buffer for at least one JavaScript tick. Modules are
682 * received from the server in batches, which means there is likely going to be many
683 * calls to this function in a row within the same tick / the same call stack.
687 * @param {string} cssText CSS text to be added in a `<style>` tag.
688 * @param {Function} callback Called after the insertion has occurred
690 function addEmbeddedCSS( cssText
, callback
) {
691 // Create a buffer if:
692 // - We don't have one yet.
693 // - The previous one is closed.
694 // - The next CSS chunk syntactically needs to be at the start of a stylesheet (T37562).
695 if ( !nextCssBuffer
|| nextCssBuffer
.active
=== false || cssText
.slice( 0, '@import'.length
) === '@import' ) {
703 // Linebreak for somewhat distinguishable sections
704 nextCssBuffer
.cssText
+= '\n' + cssText
;
705 nextCssBuffer
.callbacks
.push( callback
);
707 if ( nextCssBuffer
.active
=== null ) {
708 nextCssBuffer
.active
= true;
709 // The flushCssBuffer callback has its parameter bound by reference, which means
710 // 1) We can still extend the buffer from our object reference after this point.
711 // 2) We can safely re-assign the variable (not the object) to start a new buffer.
712 rAF( flushCssBuffer
.bind( null, nextCssBuffer
) );
718 * @param {Array} modules List of module names
719 * @return {string} Hash of concatenated version hashes.
721 function getCombinedVersion( modules
) {
722 var hashes
= modules
.reduce( function ( result
, module
) {
723 return result
+ registry
[ module
].version
;
725 return fnv132( hashes
);
729 * Determine whether all dependencies are in state 'ready', which means we may
730 * execute the module or job now.
733 * @param {Array} modules Names of modules to be checked
734 * @return {boolean} True if all modules are in state 'ready', false otherwise
736 function allReady( modules
) {
738 for ( ; i
< modules
.length
; i
++ ) {
739 if ( mw
.loader
.getState( modules
[ i
] ) !== 'ready' ) {
747 * Determine whether all direct and base dependencies are in state 'ready'
750 * @param {string} module Name of the module to be checked
751 * @return {boolean} True if all direct/base dependencies are in state 'ready'; false otherwise
753 function allWithImplicitReady( module
) {
754 return allReady( registry
[ module
].dependencies
) &&
755 ( baseModules
.indexOf( module
) !== -1 || allReady( baseModules
) );
759 * Determine whether all dependencies are in state 'ready', which means we may
760 * execute the module or job now.
763 * @param {Array} modules Names of modules to be checked
764 * @return {boolean} True if no modules are in state 'error' or 'missing', false otherwise
766 function anyFailed( modules
) {
769 for ( ; 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( '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 for ( i
= 0; i
< baseModules
.length
; i
++ ) {
954 if ( resolved
.indexOf( baseModules
[ i
] ) === -1 ) {
955 resolved
.push( baseModules
[ i
] );
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
) {
988 for ( ; i
< modules
.length
; i
++ ) {
989 sortDependencies( modules
[ i
], resolved
);
995 * Like #resolve(), except it will silently ignore modules that
996 * are missing or have missing dependencies.
999 * @param {string[]} modules Array of string module names
1000 * @return {Array} List of dependencies.
1002 function resolveStubbornly( modules
) {
1006 for ( ; i
< modules
.length
; i
++ ) {
1007 saved
= resolved
.slice();
1009 sortDependencies( modules
[ i
], resolved
);
1011 // This module is unknown or has unknown dependencies.
1012 // Undo any incomplete resolutions made and keep going.
1014 mw
.trackError( 'resourceloader.exception', {
1024 * Resolve a relative file path.
1026 * For example, resolveRelativePath( '../foo.js', 'resources/src/bar/bar.js' )
1027 * returns 'resources/src/foo.js'.
1029 * @param {string} relativePath Relative file path, starting with ./ or ../
1030 * @param {string} basePath Path of the file (not directory) relativePath is relative to
1031 * @return {string|null} Resolved path, or null if relativePath does not start with ./ or ../
1033 function resolveRelativePath( relativePath
, basePath
) {
1034 var prefixes
, prefix
, baseDirParts
,
1035 relParts
= relativePath
.match( /^((?:\.\.?\/)+)(.*)$/ );
1041 baseDirParts
= basePath
.split( '/' );
1042 // basePath looks like 'foo/bar/baz.js', so baseDirParts looks like [ 'foo', 'bar, 'baz.js' ]
1043 // Remove the file component at the end, so that we are left with only the directory path
1046 prefixes
= relParts
[ 1 ].split( '/' );
1047 // relParts[ 1 ] looks like '../../', so prefixes looks like [ '..', '..', '' ]
1048 // Remove the empty element at the end
1051 // For every ../ in the path prefix, remove one directory level from baseDirParts
1052 while ( ( prefix
= prefixes
.pop() ) !== undefined ) {
1053 if ( prefix
=== '..' ) {
1058 // If there's anything left of the base path, prepend it to the file path
1059 return ( baseDirParts
.length
? baseDirParts
.join( '/' ) + '/' : '' ) + relParts
[ 2 ];
1063 * Make a require() function scoped to a package file
1065 * @param {Object} moduleObj Module object from the registry
1066 * @param {string} basePath Path of the file this is scoped to. Used for relative paths.
1067 * @return {Function}
1069 function makeRequireFunction( moduleObj
, basePath
) {
1070 return function require( moduleName
) {
1071 var fileName
, fileContent
, result
, moduleParam
,
1072 scriptFiles
= moduleObj
.script
.files
;
1073 fileName
= resolveRelativePath( moduleName
, basePath
);
1074 if ( fileName
=== null ) {
1075 // Not a relative path, so it's a module name
1076 return mw
.loader
.require( moduleName
);
1079 if ( !hasOwn
.call( scriptFiles
, fileName
) ) {
1080 throw new Error( 'Cannot require() undefined file ' + fileName
);
1082 if ( hasOwn
.call( moduleObj
.packageExports
, fileName
) ) {
1083 // File has already been executed, return the cached result
1084 return moduleObj
.packageExports
[ fileName
];
1087 fileContent
= scriptFiles
[ fileName
];
1088 if ( typeof fileContent
=== 'function' ) {
1089 moduleParam
= { exports
: {} };
1090 fileContent( makeRequireFunction( moduleObj
, fileName
), moduleParam
);
1091 result
= moduleParam
.exports
;
1093 // fileContent is raw data, just pass it through
1094 result
= fileContent
;
1096 moduleObj
.packageExports
[ fileName
] = result
;
1102 * Load and execute a script.
1105 * @param {string} src URL to script, will be used as the src attribute in the script tag
1106 * @param {Function} [callback] Callback to run after request resolution
1108 function addScript( src
, callback
) {
1109 // Use a <script> element rather than XHR. Using XHR changes the request
1110 // headers (potentially missing a cache hit), and reduces caching in general
1111 // since browsers cache XHR much less (if at all). And XHR means we retrieve
1112 // text, so we'd need to eval, which then messes up line numbers.
1113 // The drawback is that <script> does not offer progress events, feedback is
1114 // only given after downloading, parsing, and execution have completed.
1115 var script
= document
.createElement( 'script' );
1117 script
.onload
= script
.onerror = function () {
1118 if ( script
.parentNode
) {
1119 script
.parentNode
.removeChild( script
);
1127 document
.head
.appendChild( script
);
1131 * Queue the loading and execution of a script for a particular module.
1133 * This does for debug mode what runScript() does for production.
1136 * @param {string} src URL of the script
1137 * @param {string} moduleName Name of currently executing module
1138 * @param {Function} callback Callback to run after addScript() resolution
1140 function queueModuleScript( src
, moduleName
, callback
) {
1141 pendingRequests
.push( function () {
1142 // Keep in sync with execute()/runScript().
1143 if ( moduleName
!== 'jquery' ) {
1144 window
.require
= mw
.loader
.require
;
1145 window
.module
= registry
[ moduleName
].module
;
1147 addScript( src
, function () {
1148 // 'module.exports' should not persist after the file is executed to
1149 // avoid leakage to unrelated code. 'require' should be kept, however,
1150 // as asynchronous access to 'require' is allowed and expected. (T144879)
1151 delete window
.module
;
1153 // Start the next one (if any)
1154 if ( pendingRequests
[ 0 ] ) {
1155 pendingRequests
.shift()();
1157 handlingPendingRequests
= false;
1161 if ( !handlingPendingRequests
&& pendingRequests
[ 0 ] ) {
1162 handlingPendingRequests
= true;
1163 pendingRequests
.shift()();
1168 * Utility function for execute()
1171 * @param {string} [media] Media attribute
1172 * @param {string} url URL
1174 function addLink( media
, url
) {
1175 var el
= document
.createElement( 'link' );
1177 el
.rel
= 'stylesheet';
1178 if ( media
&& media
!== 'all' ) {
1181 // If you end up here from an IE exception "SCRIPT: Invalid property value.",
1182 // see #addEmbeddedCSS, T33676, T43331, and T49277 for details.
1185 if ( marker
&& marker
.parentNode
) {
1186 marker
.parentNode
.insertBefore( el
, marker
);
1188 document
.head
.appendChild( el
);
1194 * @param {string} code JavaScript code
1196 function domEval( code
) {
1197 var script
= document
.createElement( 'script' );
1198 if ( mw
.config
.get( 'wgCSPNonce' ) !== false ) {
1199 script
.nonce
= mw
.config
.get( 'wgCSPNonce' );
1202 document
.head
.appendChild( script
);
1203 script
.parentNode
.removeChild( script
);
1207 * Add one or more modules to the module load queue.
1212 * @param {string[]} dependencies Array of module names in the registry
1213 * @param {Function} [ready] Callback to execute when all dependencies are ready
1214 * @param {Function} [error] Callback to execute when any dependency fails
1216 function enqueue( dependencies
, ready
, error
) {
1217 if ( allReady( dependencies
) ) {
1218 // Run ready immediately
1219 if ( ready
!== undefined ) {
1225 if ( anyFailed( dependencies
) ) {
1226 if ( error
!== undefined ) {
1227 // Execute error immediately if any dependencies have errors
1229 new Error( 'One or more dependencies failed to load' ),
1236 // Not all dependencies are ready, add to the load queue...
1238 // Add ready and error callbacks if they were given
1239 if ( ready
!== undefined || error
!== undefined ) {
1241 // Narrow down the list to modules that are worth waiting for
1242 dependencies
: dependencies
.filter( function ( module
) {
1243 var state
= registry
[ module
].state
;
1244 return state
=== 'registered' || state
=== 'loaded' || state
=== 'loading' || state
=== 'executing';
1251 dependencies
.forEach( function ( module
) {
1252 // Only queue modules that are still in the initial 'registered' state
1253 // (not ones already loading, ready or error).
1254 if ( registry
[ module
].state
=== 'registered' && queue
.indexOf( module
) === -1 ) {
1255 // Private modules must be embedded in the page. Don't bother queuing
1256 // these as the server will deny them anyway (T101806).
1257 if ( registry
[ module
].group
=== 'private' ) {
1258 setAndPropagate( module
, 'error' );
1260 queue
.push( module
);
1269 * Executes a loaded module, making it ready to use
1272 * @param {string} module Module name to execute
1274 function execute( module
) {
1275 var key
, value
, media
, i
, urls
, cssHandle
, siteDeps
, siteDepErr
, runScript
,
1278 if ( registry
[ module
].state
!== 'loaded' ) {
1279 throw new Error( 'Module in state "' + registry
[ module
].state
+ '" may not be executed: ' + module
);
1282 registry
[ module
].state
= 'executing';
1283 $CODE
.profileExecuteStart();
1285 runScript = function () {
1286 var script
, markModuleReady
, nestedAddScript
, mainScript
;
1288 $CODE
.profileScriptStart();
1289 script
= registry
[ module
].script
;
1290 markModuleReady = function () {
1291 $CODE
.profileScriptEnd();
1292 setAndPropagate( module
, 'ready' );
1294 nestedAddScript = function ( arr
, callback
, i
) {
1295 // Recursively call queueModuleScript() in its own callback
1296 // for each element of arr.
1297 if ( i
>= arr
.length
) {
1298 // We're at the end of the array
1303 queueModuleScript( arr
[ i
], module
, function () {
1304 nestedAddScript( arr
, callback
, i
+ 1 );
1309 if ( Array
.isArray( script
) ) {
1310 nestedAddScript( script
, markModuleReady
, 0 );
1312 typeof script
=== 'function' || (
1313 typeof script
=== 'object' &&
1317 if ( typeof script
=== 'function' ) {
1318 // Keep in sync with queueModuleScript() for debug mode
1319 if ( module
=== 'jquery' ) {
1320 // This is a special case for when 'jquery' itself is being loaded.
1321 // - The standard jquery.js distribution does not set `window.jQuery`
1322 // in CommonJS-compatible environments (Node.js, AMD, RequireJS, etc.).
1323 // - MediaWiki's 'jquery' module also bundles jquery.migrate.js, which
1324 // in a CommonJS-compatible environment, will use require('jquery'),
1325 // but that can't work when we're still inside that module.
1328 // Pass jQuery twice so that the signature of the closure which wraps
1329 // the script can bind both '$' and 'jQuery'.
1330 script( window
.$, window
.$, mw
.loader
.require
, registry
[ module
].module
);
1333 mainScript
= script
.files
[ script
.main
];
1334 if ( typeof mainScript
!== 'function' ) {
1335 throw new Error( 'Main file ' + script
.main
+ ' in module ' + module
+
1336 ' must be of type function, found ' + typeof mainScript
);
1338 // jQuery parameters are not passed for multi-file modules
1340 makeRequireFunction( registry
[ module
], script
.main
),
1341 registry
[ module
].module
1345 } else if ( typeof script
=== 'string' ) {
1346 // Site and user modules are legacy scripts that run in the global scope.
1347 // This is transported as a string instead of a function to avoid needing
1348 // to use string manipulation to undo the function wrapper.
1353 // Module without script
1357 // Use mw.track instead of mw.log because these errors are common in production mode
1358 // (e.g. undefined variable), and mw.log is only enabled in debug mode.
1359 setAndPropagate( module
, 'error' );
1360 $CODE
.profileScriptEnd();
1361 mw
.trackError( 'resourceloader.exception', {
1364 source
: 'module-execute'
1369 // Add localizations to message system
1370 if ( registry
[ module
].messages
) {
1371 mw
.messages
.set( registry
[ module
].messages
);
1374 // Initialise templates
1375 if ( registry
[ module
].templates
) {
1376 mw
.templates
.set( module
, registry
[ module
].templates
);
1379 // Adding of stylesheets is asynchronous via addEmbeddedCSS().
1380 // The below function uses a counting semaphore to make sure we don't call
1381 // runScript() until after this module's stylesheets have been inserted
1383 cssHandle = function () {
1384 // Increase semaphore, when creating a callback for addEmbeddedCSS.
1386 return function () {
1388 // Decrease semaphore, when said callback is invoked.
1390 if ( cssPending
=== 0 ) {
1392 // This callback is exposed to addEmbeddedCSS, which is outside the execute()
1393 // function and is not concerned with state-machine integrity. In turn,
1394 // addEmbeddedCSS() actually exposes stuff further into the browser (rAF).
1395 // If increment and decrement callbacks happen in the wrong order, or start
1396 // again afterwards, then this branch could be reached multiple times.
1397 // To protect the integrity of the state-machine, prevent that from happening
1398 // by making runScript() cannot be called more than once. We store a private
1399 // reference when we first reach this branch, then deference the original, and
1400 // call our reference to it.
1401 runScriptCopy
= runScript
;
1402 runScript
= undefined;
1408 // Process styles (see also mw.loader.implement)
1409 // * back-compat: { <media>: css }
1410 // * back-compat: { <media>: [url, ..] }
1411 // * { "css": [css, ..] }
1412 // * { "url": { <media>: [url, ..] } }
1413 if ( registry
[ module
].style
) {
1414 for ( key
in registry
[ module
].style
) {
1415 value
= registry
[ module
].style
[ key
];
1418 if ( key
!== 'url' && key
!== 'css' ) {
1419 // Backwards compatibility, key is a media-type
1420 if ( typeof value
=== 'string' ) {
1421 // back-compat: { <media>: css }
1422 // Ignore 'media' because it isn't supported (nor was it used).
1423 // Strings are pre-wrapped in "@media". The media-type was just ""
1424 // (because it had to be set to something).
1425 // This is one of the reasons why this format is no longer used.
1426 addEmbeddedCSS( value
, cssHandle() );
1428 // back-compat: { <media>: [url, ..] }
1434 // Array of css strings in key 'css',
1435 // or back-compat array of urls from media-type
1436 if ( Array
.isArray( value
) ) {
1437 for ( i
= 0; i
< value
.length
; i
++ ) {
1438 if ( key
=== 'bc-url' ) {
1439 // back-compat: { <media>: [url, ..] }
1440 addLink( media
, value
[ i
] );
1441 } else if ( key
=== 'css' ) {
1442 // { "css": [css, ..] }
1443 addEmbeddedCSS( value
[ i
], cssHandle() );
1446 // Not an array, but a regular object
1447 // Array of urls inside media-type key
1448 } else if ( typeof value
=== 'object' ) {
1449 // { "url": { <media>: [url, ..] } }
1450 for ( media
in value
) {
1451 urls
= value
[ media
];
1452 for ( i
= 0; i
< urls
.length
; i
++ ) {
1453 addLink( media
, urls
[ i
] );
1460 // End profiling of execute()-self before we call runScript(),
1461 // which we want to measure separately without overlap.
1462 $CODE
.profileExecuteEnd();
1464 if ( module
=== 'user' ) {
1465 // Implicit dependency on the site module. Not a real dependency because it should
1466 // run after 'site' regardless of whether it succeeds or fails.
1467 // Note: This is a simplified version of mw.loader.using(), inlined here because
1468 // mw.loader.using() is part of mediawiki.base (depends on jQuery; T192623).
1470 siteDeps
= resolve( [ 'site' ] );
1475 if ( siteDepErr
=== undefined ) {
1476 enqueue( siteDeps
, runScript
, runScript
);
1478 } else if ( cssPending
=== 0 ) {
1479 // Regular module without styles
1482 // else: runScript will get called via cssHandle()
1485 function sortQuery( o
) {
1494 for ( key
= 0; key
< a
.length
; key
++ ) {
1495 sorted
[ a
[ key
] ] = o
[ a
[ key
] ];
1501 * Converts a module map of the form `{ foo: [ 'bar', 'baz' ], bar: [ 'baz, 'quux' ] }`
1502 * to a query string of the form `foo.bar,baz|bar.baz,quux`.
1504 * See `ResourceLoader::makePackedModulesString()` in PHP, of which this is a port.
1505 * On the server, unpacking is done by `ResourceLoaderContext::expandModuleNames()`.
1507 * Note: This is only half of the logic, the other half has to be in #batchRequest(),
1508 * because its implementation needs to keep track of potential string size in order
1509 * to decide when to split the requests due to url size.
1512 * @param {Object} moduleMap Module map
1514 * @return {string} return.str Module query string
1515 * @return {Array} return.list List of module names in matching order
1517 function buildModulesString( moduleMap
) {
1522 function restore( suffix
) {
1526 for ( prefix
in moduleMap
) {
1527 p
= prefix
=== '' ? '' : prefix
+ '.';
1528 str
.push( p
+ moduleMap
[ prefix
].join( ',' ) );
1529 list
.push
.apply( list
, moduleMap
[ prefix
].map( restore
) );
1532 str
: str
.join( '|' ),
1538 * Resolve indexed dependencies.
1540 * ResourceLoader uses an optimisation to save space which replaces module names in
1541 * dependency lists with the index of that module within the array of module
1542 * registration data if it exists. The benefit is a significant reduction in the data
1543 * size of the startup module. This function changes those dependency lists back to
1544 * arrays of strings.
1547 * @param {Array} modules Modules array
1549 function resolveIndexedDependencies( modules
) {
1551 function resolveIndex( dep
) {
1552 return typeof dep
=== 'number' ? modules
[ dep
][ 0 ] : dep
;
1554 for ( i
= 0; i
< modules
.length
; i
++ ) {
1555 deps
= modules
[ i
][ 2 ];
1557 for ( j
= 0; j
< deps
.length
; j
++ ) {
1558 deps
[ j
] = resolveIndex( deps
[ j
] );
1566 * @param {Object} params Map of parameter names to values
1569 function makeQueryString( params
) {
1570 return Object
.keys( params
).map( function ( key
) {
1571 return encodeURIComponent( key
) + '=' + encodeURIComponent( params
[ key
] );
1576 * Create network requests for a batch of modules.
1578 * This is an internal method for #work(). This must not be called directly
1579 * unless the modules are already registered, and no request is in progress,
1580 * and the module state has already been set to `loading`.
1583 * @param {string[]} batch
1585 function batchRequest( batch
) {
1586 var reqBase
, splits
, b
, bSource
, bGroup
,
1587 source
, group
, i
, modules
, sourceLoadScript
,
1588 currReqBase
, currReqBaseLength
, moduleMap
, currReqModules
, l
,
1589 lastDotIndex
, prefix
, suffix
, bytesAdded
;
1592 * Start the currently drafted request to the server.
1596 function doRequest() {
1597 // Optimisation: Inherit (Object.create), not copy ($.extend)
1598 var query
= Object
.create( currReqBase
),
1599 packed
= buildModulesString( moduleMap
);
1600 query
.modules
= packed
.str
;
1601 // The packing logic can change the effective order, even if the input was
1602 // sorted. As such, the call to getCombinedVersion() must use this
1603 // effective order, instead of currReqModules, as otherwise the combined
1604 // version will not match the hash expected by the server based on
1605 // combining versions from the module query string in-order. (T188076)
1606 query
.version
= getCombinedVersion( packed
.list
);
1607 query
= sortQuery( query
);
1608 addScript( sourceLoadScript
+ '?' + makeQueryString( query
) );
1611 if ( !batch
.length
) {
1615 // Always order modules alphabetically to help reduce cache
1616 // misses for otherwise identical content.
1619 // Query parameters common to all requests
1621 skin
: mw
.config
.get( 'skin' ),
1622 lang
: mw
.config
.get( 'wgUserLanguage' ),
1623 debug
: mw
.config
.get( 'debug' )
1626 // Split module list by source and by group.
1627 splits
= Object
.create( null );
1628 for ( b
= 0; b
< batch
.length
; b
++ ) {
1629 bSource
= registry
[ batch
[ b
] ].source
;
1630 bGroup
= registry
[ batch
[ b
] ].group
;
1631 if ( !splits
[ bSource
] ) {
1632 splits
[ bSource
] = Object
.create( null );
1634 if ( !splits
[ bSource
][ bGroup
] ) {
1635 splits
[ bSource
][ bGroup
] = [];
1637 splits
[ bSource
][ bGroup
].push( batch
[ b
] );
1640 for ( source
in splits
) {
1641 sourceLoadScript
= sources
[ source
];
1643 for ( group
in splits
[ source
] ) {
1645 // Cache access to currently selected list of
1646 // modules for this group from this source.
1647 modules
= splits
[ source
][ group
];
1649 // Query parameters common to requests for this module group
1650 // Optimisation: Inherit (Object.create), not copy ($.extend)
1651 currReqBase
= Object
.create( reqBase
);
1652 // User modules require a user name in the query string.
1653 if ( group
=== 'user' && mw
.config
.get( 'wgUserName' ) !== null ) {
1654 currReqBase
.user
= mw
.config
.get( 'wgUserName' );
1657 // In addition to currReqBase, doRequest() will also add 'modules' and 'version'.
1658 // > '&modules='.length === 9
1659 // > '&version=1234567'.length === 16
1661 currReqBaseLength
= makeQueryString( currReqBase
).length
+ 25;
1663 // We may need to split up the request to honor the query string length limit,
1664 // so build it piece by piece.
1665 l
= currReqBaseLength
;
1666 moduleMap
= Object
.create( null ); // { prefix: [ suffixes ] }
1667 currReqModules
= [];
1669 for ( i
= 0; i
< modules
.length
; i
++ ) {
1670 // Determine how many bytes this module would add to the query string
1671 lastDotIndex
= modules
[ i
].lastIndexOf( '.' );
1672 // If lastDotIndex is -1, substr() returns an empty string
1673 prefix
= modules
[ i
].substr( 0, lastDotIndex
);
1674 suffix
= modules
[ i
].slice( lastDotIndex
+ 1 );
1675 bytesAdded
= moduleMap
[ prefix
] ?
1676 suffix
.length
+ 3 : // '%2C'.length == 3
1677 modules
[ i
].length
+ 3; // '%7C'.length == 3
1679 // If the url would become too long, create a new one, but don't create empty requests
1680 if ( currReqModules
.length
&& l
+ bytesAdded
> mw
.loader
.maxQueryLength
) {
1681 // Dispatch what we've got...
1683 // .. and start again.
1684 l
= currReqBaseLength
;
1685 moduleMap
= Object
.create( null );
1686 currReqModules
= [];
1688 mw
.track( 'resourceloader.splitRequest', { maxQueryLength
: mw
.loader
.maxQueryLength
} );
1690 if ( !moduleMap
[ prefix
] ) {
1691 moduleMap
[ prefix
] = [];
1694 moduleMap
[ prefix
].push( suffix
);
1695 currReqModules
.push( modules
[ i
] );
1697 // If there's anything left in moduleMap, request that too
1698 if ( currReqModules
.length
) {
1707 * @param {string[]} implementations Array containing pieces of JavaScript code in the
1708 * form of calls to mw.loader#implement().
1709 * @param {Function} cb Callback in case of failure
1710 * @param {Error} cb.err
1712 function asyncEval( implementations
, cb
) {
1713 if ( !implementations
.length
) {
1716 mw
.requestIdleCallback( function () {
1718 domEval( implementations
.join( ';' ) );
1726 * Make a versioned key for a specific module.
1729 * @param {string} module Module name
1730 * @return {string|null} Module key in format '`[name]@[version]`',
1731 * or null if the module does not exist
1733 function getModuleKey( module
) {
1734 return module
in registry
? ( module
+ '@' + registry
[ module
].version
) : null;
1739 * @param {string} key Module name or '`[name]@[version]`'
1742 function splitModuleKey( key
) {
1743 var index
= key
.indexOf( '@' );
1744 if ( index
=== -1 ) {
1751 name
: key
.slice( 0, index
),
1752 version
: key
.slice( index
+ 1 )
1758 * @param {string} module
1759 * @param {string|number} [version]
1760 * @param {string[]} [dependencies]
1761 * @param {string} [group]
1762 * @param {string} [source]
1763 * @param {string} [skip]
1765 function registerOne( module
, version
, dependencies
, group
, source
, skip
) {
1766 if ( module
in registry
) {
1767 throw new Error( 'module already registered: ' + module
);
1769 registry
[ module
] = {
1770 // Exposed to execute() for mw.loader.implement() closures.
1771 // Import happens via require().
1775 // module.export objects for each package file inside this module
1777 version
: String( version
|| '' ),
1778 dependencies
: dependencies
|| [],
1779 group
: typeof group
=== 'string' ? group
: null,
1780 source
: typeof source
=== 'string' ? source
: 'local',
1781 state
: 'registered',
1782 skip
: typeof skip
=== 'string' ? skip
: null
1786 /* Public Members */
1789 * The module registry is exposed as an aid for debugging and inspecting page
1790 * state; it is not a public interface for modifying the registry.
1796 moduleRegistry
: registry
,
1799 * Exposed for testing and debugging only.
1801 * @see #batchRequest
1805 maxQueryLength
: $VARS
.maxQueryLength
,
1808 * @inheritdoc #newStyleTag
1811 addStyleTag
: newStyleTag
,
1818 * Start loading of all queued module dependencies.
1823 var implementations
, sourceModules
,
1827 // Appends a list of modules from the queue to the batch
1828 for ( ; q
< queue
.length
; q
++ ) {
1829 // Only load modules which are registered
1830 if ( queue
[ q
] in registry
&& registry
[ queue
[ q
] ].state
=== 'registered' ) {
1831 // Prevent duplicate entries
1832 if ( batch
.indexOf( queue
[ q
] ) === -1 ) {
1833 batch
.push( queue
[ q
] );
1834 // Mark registered modules as loading
1835 registry
[ queue
[ q
] ].state
= 'loading';
1840 // Now that the queue has been processed into a batch, clear the queue.
1841 // This MUST happen before we initiate any eval or network request. Otherwise,
1842 // it is possible for a cached script to instantly trigger the same work queue
1843 // again; all before we've cleared it causing each request to include modules
1844 // which are already loaded.
1847 if ( !batch
.length
) {
1851 mw
.loader
.store
.init();
1852 if ( mw
.loader
.store
.enabled
) {
1853 implementations
= [];
1855 batch
= batch
.filter( function ( module
) {
1856 var implementation
= mw
.loader
.store
.get( module
);
1857 if ( implementation
) {
1858 implementations
.push( implementation
);
1859 sourceModules
.push( module
);
1864 asyncEval( implementations
, function ( err
) {
1866 // Not good, the cached mw.loader.implement calls failed! This should
1867 // never happen, barring ResourceLoader bugs, browser bugs and PEBKACs.
1868 // Depending on how corrupt the string is, it is likely that some
1869 // modules' implement() succeeded while the ones after the error will
1870 // never run and leave their modules in the 'loading' state forever.
1871 mw
.loader
.store
.stats
.failed
++;
1873 // Since this is an error not caused by an individual module but by
1874 // something that infected the implement call itself, don't take any
1875 // risks and clear everything in this cache.
1876 mw
.loader
.store
.clear();
1878 mw
.trackError( 'resourceloader.exception', {
1880 source
: 'store-eval'
1882 // Re-add the failed ones that are still pending back to the batch
1883 failed
= sourceModules
.filter( function ( module
) {
1884 return registry
[ module
].state
=== 'loading';
1886 batchRequest( failed
);
1890 batchRequest( batch
);
1894 * Register a source.
1896 * The #work() method will use this information to split up requests by source.
1898 * mw.loader.addSource( { mediawikiwiki: 'https://www.mediawiki.org/w/load.php' } );
1901 * @param {Object} ids An object mapping ids to load.php end point urls
1902 * @throws {Error} If source id is already registered
1904 addSource: function ( ids
) {
1907 if ( id
in sources
) {
1908 throw new Error( 'source already registered: ' + id
);
1910 sources
[ id
] = ids
[ id
];
1915 * Register a module, letting the system know about it and its properties.
1917 * The startup module calls this method.
1919 * When using multiple module registration by passing an array, dependencies that
1920 * are specified as references to modules within the array will be resolved before
1921 * the modules are registered.
1923 * @param {string|Array} modules Module name or array of arrays, each containing
1924 * a list of arguments compatible with this method
1925 * @param {string|number} [version] Module version hash (falls backs to empty string)
1926 * Can also be a number (timestamp) for compatibility with MediaWiki 1.25 and earlier.
1927 * @param {string[]} [dependencies] Array of module names on which this module depends.
1928 * @param {string} [group=null] Group which the module is in
1929 * @param {string} [source='local'] Name of the source
1930 * @param {string} [skip=null] Script body of the skip function
1932 register: function ( modules
) {
1934 if ( typeof modules
=== 'object' ) {
1935 resolveIndexedDependencies( modules
);
1936 // Optimisation: Up to 55% faster.
1937 // Typically called only once, and with a batch.
1938 // See <https://gist.github.com/Krinkle/f06fdb3de62824c6c16f02a0e6ce0e66>
1939 // Benchmarks taught us that the code for adding an object to `registry`
1940 // should actually be inline, or in a simple function that does no
1941 // arguments manipulation, and isn't also the caller itself.
1942 // JS semantics make it hard to optimise recursion to a different
1943 // signature of itself.
1944 for ( i
= 0; i
< modules
.length
; i
++ ) {
1945 registerOne
.apply( null, modules
[ i
] );
1948 registerOne
.apply( null, arguments
);
1953 * Implement a module given the components that make up the module.
1955 * When #load() or #using() requests one or more modules, the server
1956 * response contain calls to this function.
1958 * @param {string} module Name of module and current module version. Formatted
1959 * as '`[name]@[version]`". This version should match the requested version
1960 * (from #batchRequest and #registry). This avoids race conditions (T117587).
1961 * For back-compat with MediaWiki 1.27 and earlier, the version may be omitted.
1962 * @param {Function|Array|string|Object} [script] Module code. This can be a function,
1963 * a list of URLs to load via `<script src>`, a string for `$.globalEval()`, or an
1964 * object like {"files": {"foo.js":function, "bar.js": function, ...}, "main": "foo.js"}.
1965 * If an object is provided, the main file will be executed immediately, and the other
1966 * files will only be executed if loaded via require(). If a function or string is
1967 * provided, it will be executed/evaluated immediately. If an array is provided, all
1968 * URLs in the array will be loaded immediately, and executed as soon as they arrive.
1969 * @param {Object} [style] Should follow one of the following patterns:
1971 * { "css": [css, ..] }
1972 * { "url": { <media>: [url, ..] } }
1974 * And for backwards compatibility (needs to be supported forever due to caching):
1977 * { <media>: [url, ..] }
1979 * The reason css strings are not concatenated anymore is T33676. We now check
1980 * whether it's safe to extend the stylesheet.
1983 * @param {Object} [messages] List of key/value pairs to be added to mw#messages.
1984 * @param {Object} [templates] List of key/value pairs to be added to mw#templates.
1986 implement: function ( module
, script
, style
, messages
, templates
) {
1987 var split
= splitModuleKey( module
),
1989 version
= split
.version
;
1990 // Automatically register module
1991 if ( !( name
in registry
) ) {
1992 mw
.loader
.register( name
);
1994 // Check for duplicate implementation
1995 if ( registry
[ name
].script
!== undefined ) {
1996 throw new Error( 'module already implemented: ' + name
);
1999 // Without this reset, if there is a version mismatch between the
2000 // requested and received module version, then mw.loader.store would
2001 // cache the response under the requested key. Thus poisoning the cache
2002 // indefinitely with a stale value. (T117587)
2003 registry
[ name
].version
= version
;
2005 // Attach components
2006 registry
[ name
].script
= script
|| null;
2007 registry
[ name
].style
= style
|| null;
2008 registry
[ name
].messages
= messages
|| null;
2009 registry
[ name
].templates
= templates
|| null;
2010 // The module may already have been marked as erroneous
2011 if ( registry
[ name
].state
!== 'error' && registry
[ name
].state
!== 'missing' ) {
2012 setAndPropagate( name
, 'loaded' );
2017 * Load an external script or one or more modules.
2019 * This method takes a list of unrelated modules. Use cases:
2021 * - A web page will be composed of many different widgets. These widgets independently
2022 * queue their ResourceLoader modules (`OutputPage::addModules()`). If any of them
2023 * have problems, or are no longer known (e.g. cached HTML), the other modules
2024 * should still be loaded.
2025 * - This method is used for preloading, which must not throw. Later code that
2026 * calls #using() will handle the error.
2028 * @param {string|Array} modules Either the name of a module, array of modules,
2029 * or a URL of an external script or style
2030 * @param {string} [type='text/javascript'] MIME type to use if calling with a URL of an
2031 * external script or style; acceptable values are "text/css" and
2032 * "text/javascript"; if no type is provided, text/javascript is assumed.
2034 load: function ( modules
, type
) {
2037 // Allow calling with a url or single dependency as a string
2038 if ( typeof modules
=== 'string' ) {
2039 // "https://example.org/x.js", "http://example.org/x.js", "//example.org/x.js", "/x.js"
2040 if ( /^(https?:)?\/?\//.test( modules
) ) {
2041 if ( type
=== 'text/css' ) {
2042 l
= document
.createElement( 'link' );
2043 l
.rel
= 'stylesheet';
2045 document
.head
.appendChild( l
);
2048 if ( type
=== 'text/javascript' || type
=== undefined ) {
2049 addScript( modules
);
2053 throw new Error( 'type must be text/css or text/javascript, found ' + type
);
2055 // Called with single module
2056 modules
= [ modules
];
2059 // Filter out top-level modules that are unknown or failed to load before.
2060 filtered
= modules
.filter( function ( module
) {
2061 var state
= mw
.loader
.getState( module
);
2062 return state
!== 'error' && state
!== 'missing';
2064 // Resolve remaining list using the known dependency tree.
2065 // This also filters out modules with unknown dependencies. (T36853)
2066 filtered
= resolveStubbornly( filtered
);
2067 // Some modules are not yet ready, add to module load queue.
2068 enqueue( filtered
, undefined, undefined );
2072 * Change the state of one or more modules.
2074 * @param {Object} states Object of module name/state pairs
2076 state: function ( states
) {
2078 for ( module
in states
) {
2079 state
= states
[ module
];
2080 if ( !( module
in registry
) ) {
2081 mw
.loader
.register( module
);
2083 setAndPropagate( module
, state
);
2088 * Get the version of a module.
2090 * @param {string} module Name of module
2091 * @return {string|null} The version, or null if the module (or its version) is not
2094 getVersion: function ( module
) {
2095 return module
in registry
? registry
[ module
].version
: null;
2099 * Get the state of a module.
2101 * @param {string} module Name of module
2102 * @return {string|null} The state, or null if the module (or its state) is not
2105 getState: function ( module
) {
2106 return module
in registry
? registry
[ module
].state
: null;
2110 * Get the names of all registered modules.
2114 getModuleNames: function () {
2115 return Object
.keys( registry
);
2119 * Get the exported value of a module.
2121 * This static method is publicly exposed for debugging purposes
2122 * only and must not be used in production code. In production code,
2123 * please use the dynamically provided `require()` function instead.
2125 * In case of lazy-loaded modules via mw.loader#using(), the returned
2126 * Promise provides the function, see #using() for examples.
2130 * @param {string} moduleName Module name
2131 * @return {Mixed} Exported value
2133 require: function ( moduleName
) {
2134 var state
= mw
.loader
.getState( moduleName
);
2136 // Only ready modules can be required
2137 if ( state
!== 'ready' ) {
2138 // Module may've forgotten to declare a dependency
2139 throw new Error( 'Module "' + moduleName
+ '" is not loaded' );
2142 return registry
[ moduleName
].module
.exports
;
2146 * On browsers that implement the localStorage API, the module store serves as a
2147 * smart complement to the browser cache. Unlike the browser cache, the module store
2148 * can slice a concatenated response from ResourceLoader into its constituent
2149 * modules and cache each of them separately, using each module's versioning scheme
2150 * to determine when the cache should be invalidated.
2154 * @class mw.loader.store
2157 // Whether the store is in use on this page.
2160 // Modules whose string representation exceeds 100 kB are
2161 // ineligible for storage. See bug T66721.
2162 MODULE_SIZE_MAX
: 100 * 1000,
2164 // The contents of the store, mapping '[name]@[version]' keys
2165 // to module implementations.
2168 // Names of modules to be stored during the next update.
2169 // See add() and update().
2173 stats
: { hits
: 0, misses
: 0, expired
: 0, failed
: 0 },
2176 * Construct a JSON-serializable object representing the content of the store.
2178 * @return {Object} Module store contents.
2180 toJSON: function () {
2181 return { items
: mw
.loader
.store
.items
, vary
: mw
.loader
.store
.getVary() };
2185 * Get the localStorage key for the entire module store. The key references
2186 * $wgDBname to prevent clashes between wikis which share a common host.
2188 * @return {string} localStorage item key
2190 getStoreKey: function () {
2191 return 'MediaWikiModuleStore:' + mw
.config
.get( 'wgDBname' );
2195 * Get a key on which to vary the module cache.
2197 * @return {string} String of concatenated vary conditions.
2199 getVary: function () {
2200 return mw
.config
.get( 'skin' ) + ':' +
2201 mw
.config
.get( 'wgResourceLoaderStorageVersion' ) + ':' +
2202 mw
.config
.get( 'wgUserLanguage' );
2206 * Initialize the store.
2208 * Retrieves store from localStorage and (if successfully retrieved) decoding
2209 * the stored JSON value to a plain object.
2211 * The try / catch block is used for JSON & localStorage feature detection.
2212 * See the in-line documentation for Modernizr's localStorage feature detection
2213 * code for a full account of why we need a try / catch:
2214 * <https://github.com/Modernizr/Modernizr/blob/v2.7.1/modernizr.js#L771-L796>.
2219 if ( this.enabled
!== null ) {
2225 // Disabled because localStorage quotas are tight and (in Firefox's case)
2226 // shared by multiple origins.
2227 // See T66721, and <https://bugzilla.mozilla.org/show_bug.cgi?id=1064466>.
2228 /Firefox/.test( navigator
.userAgent
) ||
2230 // Disabled by configuration.
2231 !mw
.config
.get( 'wgResourceLoaderStorageEnabled' )
2233 // Clear any previous store to free up space. (T66721)
2235 this.enabled
= false;
2238 if ( mw
.config
.get( 'debug' ) ) {
2239 // Disable module store in debug mode
2240 this.enabled
= false;
2245 // This a string we stored, or `null` if the key does not (yet) exist.
2246 raw
= localStorage
.getItem( this.getStoreKey() );
2247 // If we get here, localStorage is available; mark enabled
2248 this.enabled
= true;
2249 // If null, JSON.parse() will cast to string and re-parse, still null.
2250 data
= JSON
.parse( raw
);
2251 if ( data
&& typeof data
.items
=== 'object' && data
.vary
=== this.getVary() ) {
2252 this.items
= data
.items
;
2256 // Perhaps localStorage was disabled by the user, or got corrupted.
2257 // See point 3 and 4 below. (T195647)
2260 // If we get here, one of four things happened:
2262 // 1. localStorage did not contain our store key.
2263 // This means `raw` is `null`, and we're on a fresh page view (cold cache).
2264 // The store was enabled, and `items` starts fresh.
2266 // 2. localStorage contained parseable data under our store key,
2267 // but it's not applicable to our current context (see getVary).
2268 // The store was enabled, and `items` starts fresh.
2270 // 3. JSON.parse threw (localStorage contained corrupt data).
2271 // This means `raw` contains a string.
2272 // The store was enabled, and `items` starts fresh.
2274 // 4. localStorage threw (disabled or otherwise unavailable).
2275 // This means `raw` was never assigned.
2276 // We will disable the store below.
2277 if ( raw
=== undefined ) {
2278 // localStorage failed; disable store
2279 this.enabled
= false;
2284 * Retrieve a module from the store and update cache hit stats.
2286 * @param {string} module Module name
2287 * @return {string|boolean} Module implementation or false if unavailable
2289 get: function ( module
) {
2292 if ( !this.enabled
) {
2296 key
= getModuleKey( module
);
2297 if ( key
in this.items
) {
2299 return this.items
[ key
];
2302 this.stats
.misses
++;
2307 * Queue the name of a module that the next update should consider storing.
2310 * @param {string} module Module name
2312 add: function ( module
) {
2313 if ( !this.enabled
) {
2316 this.queue
.push( module
);
2317 this.requestUpdate();
2321 * Add the contents of the named module to the in-memory store.
2323 * This method does not guarantee that the module will be stored.
2324 * Inspection of the module's meta data and size will ultimately decide that.
2326 * This method is considered internal to mw.loader.store and must only
2327 * be called if the store is enabled.
2330 * @param {string} module Module name
2332 set: function ( module
) {
2335 descriptor
= mw
.loader
.moduleRegistry
[ module
];
2337 key
= getModuleKey( module
);
2340 // Already stored a copy of this exact version
2341 key
in this.items
||
2342 // Module failed to load
2344 descriptor
.state
!== 'ready' ||
2345 // Unversioned, private, or site-/user-specific
2346 !descriptor
.version
||
2347 descriptor
.group
=== 'private' ||
2348 descriptor
.group
=== 'user' ||
2349 // Partial descriptor
2350 // (e.g. skipped module, or style module with state=ready)
2351 [ descriptor
.script
, descriptor
.style
, descriptor
.messages
,
2352 descriptor
.templates
].indexOf( undefined ) !== -1
2359 if ( typeof descriptor
.script
=== 'function' ) {
2360 // Function literal: cast to string
2361 encodedScript
= String( descriptor
.script
);
2363 // Plain object: serialise as object literal (not JSON),
2364 // making sure to preserve the functions.
2365 typeof descriptor
.script
=== 'object' &&
2366 descriptor
.script
&&
2367 !Array
.isArray( descriptor
.script
)
2369 encodedScript
= '{' +
2370 'main:' + JSON
.stringify( descriptor
.script
.main
) + ',' +
2372 Object
.keys( descriptor
.script
.files
).map( function ( key
) {
2373 var value
= descriptor
.script
.files
[ key
];
2374 return JSON
.stringify( key
) + ':' +
2375 ( typeof value
=== 'function' ? value
: JSON
.stringify( value
) );
2379 // Array of urls, or null.
2380 encodedScript
= JSON
.stringify( descriptor
.script
);
2383 JSON
.stringify( key
),
2385 JSON
.stringify( descriptor
.style
),
2386 JSON
.stringify( descriptor
.messages
),
2387 JSON
.stringify( descriptor
.templates
)
2390 mw
.trackError( 'resourceloader.exception', {
2392 source
: 'store-localstorage-json'
2397 src
= 'mw.loader.implement(' + args
.join( ',' ) + ');';
2398 if ( src
.length
> this.MODULE_SIZE_MAX
) {
2401 this.items
[ key
] = src
;
2405 * Iterate through the module store, removing any item that does not correspond
2406 * (in name and version) to an item in the module registry.
2408 prune: function () {
2411 for ( key
in this.items
) {
2412 module
= key
.slice( 0, key
.indexOf( '@' ) );
2413 if ( getModuleKey( module
) !== key
) {
2414 this.stats
.expired
++;
2415 delete this.items
[ key
];
2416 } else if ( this.items
[ key
].length
> this.MODULE_SIZE_MAX
) {
2417 // This value predates the enforcement of a size limit on cached modules.
2418 delete this.items
[ key
];
2424 * Clear the entire module store right now.
2426 clear: function () {
2429 localStorage
.removeItem( this.getStoreKey() );
2434 * Request a sync of the in-memory store back to persisted localStorage.
2436 * This function debounces updates. The debouncing logic should account
2437 * for the following factors:
2439 * - Writing to localStorage is an expensive operation that must not happen
2440 * during the critical path of initialising and executing module code.
2441 * Instead, it should happen at a later time after modules have been given
2442 * time and priority to do their thing first.
2444 * - This method is called from mw.loader.store.add(), which will be called
2445 * hundreds of times on a typical page, including within the same call-stack
2446 * and eventloop-tick. This is because responses from load.php happen in
2447 * batches. As such, we want to allow all modules from the same load.php
2448 * response to be written to disk with a single flush, not many.
2450 * - Repeatedly deleting and creating timers is non-trivial.
2452 * - localStorage is shared by all pages from the same origin, if multiple
2453 * pages are loaded with different module sets, the possibility exists that
2454 * modules saved by one page will be clobbered by another. The impact of
2455 * this is minor, it merely causes a less efficient cache use, and the
2456 * problem would be corrected by subsequent page views.
2458 * This method is considered internal to mw.loader.store and must only
2459 * be called if the store is enabled.
2464 requestUpdate
: ( function () {
2465 var hasPendingWrites
= false;
2467 function flushWrites() {
2470 // Remove anything from the in-memory store that came from previous page
2471 // loads that no longer corresponds with current module names and versions.
2472 mw
.loader
.store
.prune();
2473 // Process queued module names, serialise their contents to the in-memory store.
2474 while ( mw
.loader
.store
.queue
.length
) {
2475 mw
.loader
.store
.set( mw
.loader
.store
.queue
.shift() );
2478 key
= mw
.loader
.store
.getStoreKey();
2480 // Replacing the content of the module store might fail if the new
2481 // contents would exceed the browser's localStorage size limit. To
2482 // avoid clogging the browser with stale data, always remove the old
2483 // value before attempting to set the new one.
2484 localStorage
.removeItem( key
);
2485 data
= JSON
.stringify( mw
.loader
.store
);
2486 localStorage
.setItem( key
, data
);
2488 mw
.trackError( 'resourceloader.exception', {
2490 source
: 'store-localstorage-update'
2494 // Let the next call to requestUpdate() create a new timer.
2495 hasPendingWrites
= false;
2498 function onTimeout() {
2499 // Defer the actual write via requestIdleCallback
2500 mw
.requestIdleCallback( flushWrites
);
2503 return function () {
2504 // On the first call to requestUpdate(), create a timer that
2505 // waits at least two seconds, then calls onTimeout.
2506 // The main purpose is to allow the current batch of load.php
2507 // responses to complete before we do anything. This batch can
2508 // trigger many hundreds of calls to requestUpdate().
2509 if ( !hasPendingWrites
) {
2510 hasPendingWrites
= true;
2511 setTimeout( onTimeout
, 2000 );
2519 // Skeleton user object, extended by the 'mediawiki.user' module.
2526 * @property {mw.Map}
2530 * @property {mw.Map}
2535 // OOUI widgets specific to MediaWiki
2540 // Attach to window and globally alias
2541 window
.mw
= window
.mediaWiki
= mw
;