resourceloader: Fold legacy modules into base modules request
authorTimo Tijhof <krinklemail@gmail.com>
Sun, 10 Apr 2016 02:05:14 +0000 (03:05 +0100)
committerKrinkle <krinklemail@gmail.com>
Tue, 11 Apr 2017 22:56:38 +0000 (22:56 +0000)
Follows-up 0ac4f998 (restore "blocking" legacy modules).

After d790562, legacy modules in the top queue were no longer consistently
loaded before the bottom queue due to the top queue being async.

The implied dependency was made explicit by 0ac4f998 by forcing all modules
to wait for legacy modules before executing.

This had the negative side-effect of putting an extra HTTP request between
the startup module request, base modules request, and actual execution
of page modules.

(Indentation aligns with when a request is triggered.)

Before:
 1. Request: Startup module.
   2. Request: Base modules
   3. Request: Legacy modules
     4. Page module request (or local store hit) and execution

After:
 1. Request: Startup module.
   2. Request: Base+legacy modules
     3. Page module request (or local store hit) and execution

This could alternatively be fixed by moving the top queue to be before
the embedded modules and enforcing the embed in a different way.
It could also be fixed by debouncing module load calls so they naturally
end up in the same request as page modules.

However for now I'm addressing this by adding legacy modules to the
list of modules in the initial load request from the startup module.

This was not possible before because the legacy wikibits had dependencies
and base modules cannot have dependencies. Fixed in I7f9f61ea81ad1ef.

Bug: T159911
Change-Id: I54f087655e1cde1b8ff1ca5fe56e82f7f7d80965

includes/resourceloader/ResourceLoaderStartUpModule.php
includes/skins/Skin.php
resources/src/mediawiki/mediawiki.js

index 04b2f72..d92dc0a 100644 (file)
@@ -112,7 +112,6 @@ class ResourceLoaderStartUpModule extends ResourceLoaderModule {
                        'wgIllegalFileChars' => Title::convertByteClassToUnicodeClass( $illegalFileChars ),
                        'wgResourceLoaderStorageVersion' => $conf->get( 'ResourceLoaderStorageVersion' ),
                        'wgResourceLoaderStorageEnabled' => $conf->get( 'ResourceLoaderStorageEnabled' ),
-                       'wgResourceLoaderLegacyModules' => self::getLegacyModules(),
                        'wgForeignUploadTargets' => $conf->get( 'ForeignUploadTargets' ),
                        'wgEnableUploads' => $conf->get( 'EnableUploads' ),
                ];
@@ -330,9 +329,11 @@ class ResourceLoaderStartUpModule extends ResourceLoaderModule {
         */
        public static function getStartupModulesUrl( ResourceLoaderContext $context ) {
                $rl = $context->getResourceLoader();
-
                $derivative = new DerivativeResourceLoaderContext( $context );
-               $derivative->setModules( self::getStartupModules() );
+               $derivative->setModules( array_merge(
+                       self::getStartupModules(),
+                       self::getLegacyModules()
+               ) );
                $derivative->setOnly( 'scripts' );
                // Must setModules() before makeVersionQuery()
                $derivative->setVersion( $rl->makeVersionQuery( $derivative ) );
index 52678d4..99658f2 100644 (file)
@@ -164,8 +164,6 @@ abstract class Skin extends ContextSource {
                        'content' => [
                                'mediawiki.page.ready',
                        ],
-                       // modules that exist for legacy reasons
-                       'legacy' => ResourceLoaderStartUpModule::getLegacyModules(),
                        // modules relating to search functionality
                        'search' => [],
                        // modules relating to functionality relating to watching an article
index 86a9a0a..a49db79 100644 (file)
                                registry[ module ].state = 'executing';
 
                                runScript = function () {
-                                       var script, markModuleReady, nestedAddScript, legacyWait, implicitDependencies,
-                                               // Expand to include dependencies since we have to exclude both legacy modules
-                                               // and their dependencies from the legacyWait (to prevent a circular dependency).
-                                               legacyModules = resolve( mw.config.get( 'wgResourceLoaderLegacyModules', [] ) );
+                                       var script, markModuleReady, nestedAddScript, implicitDependencies, implicitWait;
 
                                        script = registry[ module ].script;
                                        markModuleReady = function () {
                                                } );
                                        };
 
-                                       implicitDependencies = ( $.inArray( module, legacyModules ) !== -1 ) ?
-                                               [] :
-                                               legacyModules;
+                                       implicitDependencies = [];
 
                                        if ( module === 'user' ) {
                                                // Implicit dependency on the site module. Not real dependency because
                                                implicitDependencies.push( 'site' );
                                        }
 
-                                       legacyWait = implicitDependencies.length ?
+                                       implicitWait = implicitDependencies.length ?
                                                mw.loader.using( implicitDependencies ) :
                                                $.Deferred().resolve();
 
-                                       legacyWait.always( function () {
+                                       implicitWait.always( function () {
                                                try {
                                                        if ( Array.isArray( script ) ) {
                                                                nestedAddScript( script, markModuleReady, 0 );