From b7b84d55d4ea396167cba2fcf81369f48f1a1837 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Fri, 15 Jun 2018 21:20:14 +0100 Subject: [PATCH] resourceloader: Embed 'mediawiki' directly in startup response Embed the essential files to define mw.loader directly as part of the startup module. * This means the internal 'mediawiki' module no longer exists. This is safe to remove because: 1) While registered server-side for loading from startup.js, a PHPUnit structure test disallowed being specified as a dependency. 2) Anything that attempted to load it client-side failed because the module was marked in the registry as 'raw', thereby excluding it from the data sent to the client-side. As such, it was seen as an unknown module that the client refused to fetch from the server. * Deprecate getStartupModules() and getLegacyModules(). These are no longer needed. There are no known callers anywhere in Wikimedia Git or elsewhere indexed by Codesearch, but easy enough to leave as no-op for one release. * Remove ResourceLoaderRawFileModule class. No longer needed. Was created as a hack specifically for the 'mediawiki' module so that it would not leak global variables in debug mode. It has no usage anywhere in Wikimedia Git, nor elsewhere in Codesearch. Remove without deprecation given this was meant to be a 'private' class. * Introduce (private) getBaseModules(). Previously, this list only existed locally in getStartupModulesUrl() by merging getStartupModules() and getLegacyModules(). This value was factored out into its own method. * Make getStartupModulesUrl() private and rename to getBaseModulesUrl(). It is only used internally to export the 'baseModulesUri' value. Its name was already confusing before, but it would've been even more confusing now given it doesn't even call getStartupModules() any more. Bug: T192623 Change-Id: I14ba282d7b65e99ca54b7c2f77ba6e1adaddd11c --- RELEASE-NOTES-1.32 | 2 + autoload.php | 1 - .../ResourceLoaderRawFileModule.php | 52 ---------------- .../ResourceLoaderStartUpModule.php | 59 ++++++++++++++----- jsduck.json | 2 +- maintenance/jsduck/eg-iframe.html | 3 +- resources/Resources.php | 10 ---- .../src/{mediawiki => startup}/mediawiki.js | 10 ++-- .../{mediawiki => startup}/mediawiki.log.js | 0 .../mediawiki.requestIdleCallback.js | 0 resources/src/{ => startup}/startup.js | 4 ++ tests/phpunit/structure/ResourcesTest.php | 7 +-- 12 files changed, 60 insertions(+), 90 deletions(-) delete mode 100644 includes/resourceloader/ResourceLoaderRawFileModule.php rename resources/src/{mediawiki => startup}/mediawiki.js (99%) rename resources/src/{mediawiki => startup}/mediawiki.log.js (100%) rename resources/src/{mediawiki => startup}/mediawiki.requestIdleCallback.js (100%) rename resources/src/{ => startup}/startup.js (97%) diff --git a/RELEASE-NOTES-1.32 b/RELEASE-NOTES-1.32 index 3c60124d40..65bedfb9b5 100644 --- a/RELEASE-NOTES-1.32 +++ b/RELEASE-NOTES-1.32 @@ -219,6 +219,8 @@ because of Phabricator reports. context title is unset is now deprecated; anything creating an EditPage instance should set the context title via ::setContextTitle(). * The 'jquery.hidpi' module (polyfill for IMG srcset) is deprecated. +* ResourceLoaderStartUpModule::getStartupModules() and ::getLegacyModules() + are deprecated. These concepts are obsolete and have no replacement. === Other changes in 1.32 === * … diff --git a/autoload.php b/autoload.php index 6b1f981042..d3f7e980f4 100644 --- a/autoload.php +++ b/autoload.php @@ -1232,7 +1232,6 @@ $wgAutoloadLocalClasses = [ 'ResourceLoaderOOUIFileModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderOOUIFileModule.php', 'ResourceLoaderOOUIImageModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderOOUIImageModule.php', 'ResourceLoaderOOUIModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderOOUIModule.php', - 'ResourceLoaderRawFileModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderRawFileModule.php', 'ResourceLoaderSiteModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderSiteModule.php', 'ResourceLoaderSiteStylesModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderSiteStylesModule.php', 'ResourceLoaderSkinModule' => __DIR__ . '/includes/resourceloader/ResourceLoaderSkinModule.php', diff --git a/includes/resourceloader/ResourceLoaderRawFileModule.php b/includes/resourceloader/ResourceLoaderRawFileModule.php deleted file mode 100644 index beab53eb8d..0000000000 --- a/includes/resourceloader/ResourceLoaderRawFileModule.php +++ /dev/null @@ -1,52 +0,0 @@ -getBaseModulesUrl( $context ); return [ $url => [ 'as' => 'script' ] ]; } /** - * Base modules required for the base environment of ResourceLoader + * Internal modules used by ResourceLoader that cannot be depended on. * + * These module(s) should have isRaw() return true, and are not + * legal dependencies (enforced by structure/ResourcesTest). + * + * @deprecated since 1.32 No longer used. * @return array */ public static function getStartupModules() { - return [ 'jquery', 'mediawiki', 'mediawiki.base' ]; + wfDeprecated( __METHOD__, '1.32' ); + return []; } + /** + * @deprecated since 1.32 No longer used. + * @return array + */ public static function getLegacyModules() { + wfDeprecated( __METHOD__, '1.32' ); + return []; + } + + /** + * Base modules implicitly available to all modules. + * + * @since 1.32 + * @return array + */ + private function getBaseModules() { global $wgIncludeLegacyJavaScript; - $legacyModules = []; + $baseModules = [ 'jquery', 'mediawiki.base' ]; if ( $wgIncludeLegacyJavaScript ) { - $legacyModules[] = 'mediawiki.legacy.wikibits'; + $baseModules[] = 'mediawiki.legacy.wikibits'; } - return $legacyModules; + return $baseModules; } /** * Get the load URL of the startup modules. * - * This is a helper for getScript(), but can also be called standalone, such - * as when generating an AppCache manifest. + * This is a helper for getScript(). * * @param ResourceLoaderContext $context * @return string */ - public static function getStartupModulesUrl( ResourceLoaderContext $context ) { + private function getBaseModulesUrl( ResourceLoaderContext $context ) { $rl = $context->getResourceLoader(); $derivative = new DerivativeResourceLoaderContext( $context ); - $derivative->setModules( array_merge( - self::getStartupModules(), - self::getLegacyModules() - ) ); + $derivative->setModules( $this->getBaseModules() ); $derivative->setOnly( 'scripts' ); // Must setModules() before makeVersionQuery() $derivative->setVersion( $rl->makeVersionQuery( $derivative ) ); @@ -383,7 +399,15 @@ class ResourceLoaderStartUpModule extends ResourceLoaderModule { return '/* Requires only=script */'; } - $out = file_get_contents( "$IP/resources/src/startup.js" ); + $out = file_get_contents( "$IP/resources/src/startup/startup.js" ); + + // Keep in sync with maintenance/jsduck/eg-iframe.html and, + // keep in sync with 'fileHashes' in StartUpModule::getDefinitionSummary(). + $mwLoaderCode = file_get_contents( "$IP/resources/src/startup/mediawiki.js" ) . + file_get_contents( "$IP/resources/src/startup/mediawiki.requestIdleCallback.js" ); + if ( $context->getDebug() ) { + $mwLoaderCode .= file_get_contents( "$IP/resources/src/startup/mediawiki.log.js" ); + } $pairs = array_map( function ( $value ) { $value = FormatJson::encode( $value, ResourceLoader::inDebugMode(), FormatJson::ALL_OK ); @@ -394,13 +418,14 @@ class ResourceLoaderStartUpModule extends ResourceLoaderModule { '$VARS.wgLegacyJavaScriptGlobals' => $this->getConfig()->get( 'LegacyJavaScriptGlobals' ), '$VARS.configuration' => $this->getConfigSettings( $context ), // This url may be preloaded. See getPreloadLinks(). - '$VARS.baseModulesUri' => self::getStartupModulesUrl( $context ), + '$VARS.baseModulesUri' => $this->getBaseModulesUrl( $context ), ] ); $pairs['$CODE.registrations();'] = str_replace( "\n", "\n\t", trim( $this->getModuleRegistrations( $context ) ) ); + $pairs['$CODE.defineLoader();'] = $mwLoaderCode; return strtr( $out, $pairs ); } @@ -430,7 +455,9 @@ class ResourceLoaderStartUpModule extends ResourceLoaderModule { 'moduleHashes' => $this->getAllModuleHashes( $context ), 'fileHashes' => [ - $this->safeFileHash( "$IP/resources/src/startup.js" ), + $this->safeFileHash( "$IP/resources/src/startup/startup.js" ), + $this->safeFileHash( "$IP/resources/src/startup/mediawiki.js" ), + $this->safeFileHash( "$IP/resources/src/startup/mediawiki.requestIdleCallback.js" ), ], ]; return $summary; diff --git a/jsduck.json b/jsduck.json index e61303d345..28473aacb5 100644 --- a/jsduck.json +++ b/jsduck.json @@ -19,7 +19,7 @@ "resources/src/mediawiki.legacy", "resources/src/mediawiki.libs.jpegmeta/jpegmeta.js", "resources/src/mediawiki.skinning", - "resources/src/startup.js" + "resources/src/startup/startup.js" ], "--": [ "maintenance/jsduck/external.js", diff --git a/maintenance/jsduck/eg-iframe.html b/maintenance/jsduck/eg-iframe.html index 8475dcaf4e..2c7cd68823 100644 --- a/maintenance/jsduck/eg-iframe.html +++ b/maintenance/jsduck/eg-iframe.html @@ -41,8 +41,9 @@ mw.config = new mw.Map(); } + + - diff --git a/resources/Resources.php b/resources/Resources.php index b4b921fbfc..d0c52d846f 100644 --- a/resources/Resources.php +++ b/resources/Resources.php @@ -843,16 +843,6 @@ return [ /* MediaWiki */ - 'mediawiki' => [ - 'class' => ResourceLoaderRawFileModule::class, - // Keep in sync with maintenance/jsduck/eg-iframe.html - 'scripts' => [ - 'resources/src/mediawiki/mediawiki.js', - 'resources/src/mediawiki/mediawiki.requestIdleCallback.js', - ], - 'debugScripts' => 'resources/src/mediawiki/mediawiki.log.js', - 'targets' => [ 'desktop', 'mobile' ], - ], 'mediawiki.base' => [ // Keep in sync with maintenance/jsduck/eg-iframe.html 'scripts' => [ diff --git a/resources/src/mediawiki/mediawiki.js b/resources/src/startup/mediawiki.js similarity index 99% rename from resources/src/mediawiki/mediawiki.js rename to resources/src/startup/mediawiki.js index 68d9d9e018..8d42c0f024 100644 --- a/resources/src/mediawiki/mediawiki.js +++ b/resources/src/startup/mediawiki.js @@ -8,7 +8,7 @@ * @singleton */ -( function ( $ ) { +( function () { 'use strict'; var mw, StringSet, log, @@ -294,7 +294,7 @@ */ log.warn = console && console.warn && Function.prototype.bind ? Function.prototype.bind.call( console.warn, console ) : - $.noop; + function () {}; /** * Write a message to the browser console's error channel. @@ -305,11 +305,11 @@ * This method is a no-op in browsers that don't implement the Console API. * * @since 1.26 - * @param {Error|...string} msg Messages to output to console + * @param {...Mixed} msg Messages to output to console */ log.error = console && console.error && Function.prototype.bind ? Function.prototype.bind.call( console.error, console ) : - $.noop; + function () {}; /** * Create a property on a host object that, when accessed, will produce @@ -2270,4 +2270,4 @@ // Attach to window and globally alias window.mw = window.mediaWiki = mw; -}( jQuery ) ); +}() ); diff --git a/resources/src/mediawiki/mediawiki.log.js b/resources/src/startup/mediawiki.log.js similarity index 100% rename from resources/src/mediawiki/mediawiki.log.js rename to resources/src/startup/mediawiki.log.js diff --git a/resources/src/mediawiki/mediawiki.requestIdleCallback.js b/resources/src/startup/mediawiki.requestIdleCallback.js similarity index 100% rename from resources/src/mediawiki/mediawiki.requestIdleCallback.js rename to resources/src/startup/mediawiki.requestIdleCallback.js diff --git a/resources/src/startup.js b/resources/src/startup/startup.js similarity index 97% rename from resources/src/startup.js rename to resources/src/startup/startup.js index 7e7548106f..7a50d94358 100644 --- a/resources/src/startup.js +++ b/resources/src/startup/startup.js @@ -140,6 +140,10 @@ window.isCompatible = function ( str ) { if ( window.performance && performance.mark ) { performance.mark( 'mwStartup' ); } + + // This embeds mediawiki.js, which defines 'mw' and 'mw.loader'. + $CODE.defineLoader(); + script = document.createElement( 'script' ); script.src = $VARS.baseModulesUri; script.onload = function () { diff --git a/tests/phpunit/structure/ResourcesTest.php b/tests/phpunit/structure/ResourcesTest.php index 2090e29b77..8a08181c1e 100644 --- a/tests/phpunit/structure/ResourcesTest.php +++ b/tests/phpunit/structure/ResourcesTest.php @@ -45,24 +45,23 @@ class ResourcesTest extends MediaWikiTestCase { } /** - * Verify that nothing explicitly depends on base modules, or other raw modules. + * Verify that nothing explicitly depends on raw modules (such as "query"). * * Depending on them is unsupported as they are not registered client-side by the startup module. * - * TODO Modules can dynamically choose dependencies based on context. This method does not + * @todo Modules can dynamically choose dependencies based on context. This method does not * test such dependencies. The same goes for testMissingDependencies() and * testUnsatisfiableDependencies(). */ public function testIllegalDependencies() { $data = self::getAllModules(); - $illegalDeps = ResourceLoaderStartUpModule::getStartupModules(); + $illegalDeps = []; foreach ( $data['modules'] as $moduleName => $module ) { if ( $module->isRaw() ) { $illegalDeps[] = $moduleName; } } - $illegalDeps = array_unique( $illegalDeps ); /** @var ResourceLoaderModule $module */ foreach ( $data['modules'] as $moduleName => $module ) { -- 2.20.1