45bec76755
Follows-up 6fa1e56. This is already fixed for http caches by
shortening the Cache-Control max-age in case of a version mismatch.
However the client still cached it blindly in mw.loader.store.
Resolve this by communicating to the client what version of the module
was exported. The client can then compare this version to the version
it originally requested and decide not to cache it.
Adopt the module key format (name@version) from mw.loader.store
in mw.loader.implement() as well.
Bug: T117587
Change-Id: I1a7c44d0222893afefac20bef507bdd1a1a87ecd
287 lines
10 KiB
PHP
287 lines
10 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @group ResourceLoader
|
|
*/
|
|
class ResourceLoaderClientHtmlTest extends PHPUnit_Framework_TestCase {
|
|
|
|
protected static function expandVariables( $text ) {
|
|
return strtr( $text, [
|
|
'{blankVer}' => ResourceLoaderTestCase::BLANK_VERSION
|
|
] );
|
|
}
|
|
|
|
protected static function makeContext( $extraQuery = [] ) {
|
|
$conf = new HashConfig( [
|
|
'ResourceLoaderSources' => [],
|
|
'ResourceModuleSkinStyles' => [],
|
|
'ResourceModules' => [],
|
|
'EnableJavaScriptTest' => false,
|
|
'ResourceLoaderDebug' => false,
|
|
'LoadScript' => '/w/load.php',
|
|
] );
|
|
return new ResourceLoaderContext(
|
|
new ResourceLoader( $conf ),
|
|
new FauxRequest( array_merge( [
|
|
'lang' => 'nl',
|
|
'skin' => 'fallback',
|
|
'user' => 'Example',
|
|
'target' => 'phpunit',
|
|
], $extraQuery ) )
|
|
);
|
|
}
|
|
|
|
protected static function makeModule( array $options = [] ) {
|
|
return new ResourceLoaderTestModule( $options );
|
|
}
|
|
|
|
protected static function makeSampleModules() {
|
|
$modules = [
|
|
'test' => [],
|
|
'test.top' => [ 'position' => 'top' ],
|
|
'test.private.top' => [ 'group' => 'private', 'position' => 'top' ],
|
|
'test.private.bottom' => [ 'group' => 'private', 'position' => 'bottom' ],
|
|
|
|
'test.styles.pure' => [ 'type' => ResourceLoaderModule::LOAD_STYLES ],
|
|
'test.styles.mixed' => [],
|
|
'test.styles.noscript' => [ 'group' => 'noscript', 'type' => ResourceLoaderModule::LOAD_STYLES ],
|
|
'test.styles.mixed.user' => [ 'group' => 'user' ],
|
|
'test.styles.mixed.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
|
|
'test.styles.private' => [ 'group' => 'private', 'styles' => '.private{}' ],
|
|
|
|
'test.scripts' => [],
|
|
'test.scripts.top' => [ 'position' => 'top' ],
|
|
'test.scripts.mixed.user' => [ 'group' => 'user' ],
|
|
'test.scripts.mixed.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
|
|
'test.scripts.raw' => [ 'isRaw' => true ],
|
|
];
|
|
return array_map( function ( $options ) {
|
|
return self::makeModule( $options );
|
|
}, $modules );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderClientHtml::getDocumentAttributes
|
|
*/
|
|
public function testGetDocumentAttributes() {
|
|
$client = new ResourceLoaderClientHtml( self::makeContext() );
|
|
$this->assertInternalType( 'array', $client->getDocumentAttributes() );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderClientHtml::__construct
|
|
* @covers ResourceLoaderClientHtml::setModules
|
|
* @covers ResourceLoaderClientHtml::setModuleStyles
|
|
* @covers ResourceLoaderClientHtml::setModuleScripts
|
|
* @covers ResourceLoaderClientHtml::getData
|
|
* @covers ResourceLoaderClientHtml::getContext
|
|
*/
|
|
public function testGetData() {
|
|
$context = self::makeContext();
|
|
$context->getResourceLoader()->register( self::makeSampleModules() );
|
|
|
|
$client = new ResourceLoaderClientHtml( $context );
|
|
$client->setModules( [
|
|
'test',
|
|
'test.private.bottom',
|
|
'test.private.top',
|
|
'test.top',
|
|
'test.unregistered',
|
|
] );
|
|
$client->setModuleStyles( [
|
|
'test.styles.mixed',
|
|
'test.styles.mixed.user.empty',
|
|
'test.styles.private',
|
|
'test.styles.pure',
|
|
'test.unregistered.styles',
|
|
] );
|
|
$client->setModuleScripts( [
|
|
'test.scripts',
|
|
'test.scripts.mixed.user.empty',
|
|
'test.scripts.top',
|
|
'test.unregistered.scripts',
|
|
] );
|
|
|
|
$expected = [
|
|
'states' => [
|
|
'test.private.top' => 'loading',
|
|
'test.private.bottom' => 'loading',
|
|
'test.styles.pure' => 'ready',
|
|
'test.styles.mixed.user.empty' => 'ready',
|
|
'test.styles.private' => 'ready',
|
|
'test.scripts' => 'loading',
|
|
'test.scripts.top' => 'loading',
|
|
'test.scripts.mixed.user.empty' => 'ready',
|
|
],
|
|
'general' => [
|
|
'top' => [ 'test.top' ],
|
|
'bottom' => [ 'test' ],
|
|
],
|
|
'styles' => [
|
|
'test.styles.mixed',
|
|
'test.styles.pure',
|
|
],
|
|
'scripts' => [
|
|
'top' => [ 'test.scripts.top' ],
|
|
'bottom' => [ 'test.scripts' ],
|
|
],
|
|
'embed' => [
|
|
'styles' => [ 'test.styles.private' ],
|
|
'general' => [
|
|
'top' => [ 'test.private.top' ],
|
|
'bottom' => [ 'test.private.bottom' ],
|
|
],
|
|
],
|
|
];
|
|
|
|
$access = TestingAccessWrapper::newFromObject( $client );
|
|
$this->assertEquals( $expected, $access->getData() );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderClientHtml::setConfig
|
|
* @covers ResourceLoaderClientHtml::setExemptStates
|
|
* @covers ResourceLoaderClientHtml::getHeadHtml
|
|
* @covers ResourceLoaderClientHtml::getLoad
|
|
* @covers ResourceLoader::makeLoaderStateScript
|
|
*/
|
|
public function testGetHeadHtml() {
|
|
$context = self::makeContext();
|
|
$context->getResourceLoader()->register( self::makeSampleModules() );
|
|
|
|
$client = new ResourceLoaderClientHtml( $context );
|
|
$client->setConfig( [ 'key' => 'value' ] );
|
|
$client->setModules( [
|
|
'test.top',
|
|
'test.private.top',
|
|
] );
|
|
$client->setModuleStyles( [
|
|
'test.styles.pure',
|
|
'test.styles.private',
|
|
] );
|
|
$client->setModuleScripts( [
|
|
'test.scripts.top',
|
|
] );
|
|
$client->setExemptStates( [
|
|
'test.exempt' => 'ready',
|
|
] );
|
|
|
|
// @codingStandardsIgnoreStart Generic.Files.LineLength
|
|
$expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
|
|
. '<script>(window.RLQ=window.RLQ||[]).push(function(){'
|
|
. 'mw.config.set({"key":"value"});'
|
|
. 'mw.loader.state({"test.exempt":"ready","test.private.top":"loading","test.styles.pure":"ready","test.styles.private":"ready","test.scripts.top":"loading"});'
|
|
. 'mw.loader.implement("test.private.top@{blankVer}",function($,jQuery,require,module){},{"css":[]});'
|
|
. 'mw.loader.load(["test.top"]);'
|
|
. 'mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts.top\u0026only=scripts\u0026skin=fallback");'
|
|
. '});</script>' . "\n"
|
|
. '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>' . "\n"
|
|
. '<style>.private{}</style>' . "\n"
|
|
. '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
|
|
// @codingStandardsIgnoreEnd
|
|
$expected = self::expandVariables( $expected );
|
|
|
|
$this->assertEquals( $expected, $client->getHeadHtml() );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderClientHtml::getBodyHtml
|
|
* @covers ResourceLoaderClientHtml::getLoad
|
|
*/
|
|
public function testGetBodyHtml() {
|
|
$context = self::makeContext();
|
|
$context->getResourceLoader()->register( self::makeSampleModules() );
|
|
|
|
$client = new ResourceLoaderClientHtml( $context );
|
|
$client->setConfig( [ 'key' => 'value' ] );
|
|
$client->setModules( [
|
|
'test',
|
|
'test.private.bottom',
|
|
] );
|
|
$client->setModuleScripts( [
|
|
'test.scripts',
|
|
] );
|
|
|
|
// @codingStandardsIgnoreStart Generic.Files.LineLength
|
|
$expected = '<script>(window.RLQ=window.RLQ||[]).push(function(){'
|
|
. 'mw.loader.implement("test.private.bottom@{blankVer}",function($,jQuery,require,module){},{"css":[]});'
|
|
. 'mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts\u0026only=scripts\u0026skin=fallback");'
|
|
. 'mw.loader.load(["test"]);'
|
|
. '});</script>';
|
|
// @codingStandardsIgnoreEnd
|
|
$expected = self::expandVariables( $expected );
|
|
|
|
$this->assertEquals( $expected, $client->getBodyHtml() );
|
|
}
|
|
|
|
public static function provideMakeLoad() {
|
|
return [
|
|
// @codingStandardsIgnoreStart Generic.Files.LineLength
|
|
[
|
|
'context' => [],
|
|
'modules' => [ 'test.unknown' ],
|
|
'only' => ResourceLoaderModule::TYPE_STYLES,
|
|
'output' => '',
|
|
],
|
|
[
|
|
'context' => [],
|
|
'modules' => [ 'test.styles.private' ],
|
|
'only' => ResourceLoaderModule::TYPE_STYLES,
|
|
'output' => '<style>.private{}</style>',
|
|
],
|
|
[
|
|
'context' => [],
|
|
'modules' => [ 'test.private.top' ],
|
|
'only' => ResourceLoaderModule::TYPE_COMBINED,
|
|
'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.private.top@{blankVer}",function($,jQuery,require,module){},{"css":[]});});</script>',
|
|
],
|
|
[
|
|
'context' => [],
|
|
// Eg. startup module
|
|
'modules' => [ 'test.scripts.raw' ],
|
|
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
|
|
'output' => '<script async="" src="/w/load.php?debug=false&lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback"></script>',
|
|
],
|
|
[
|
|
'context' => [],
|
|
'modules' => [ 'test.scripts.mixed.user' ],
|
|
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
|
|
'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts.mixed.user\u0026only=scripts\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
|
|
],
|
|
[
|
|
'context' => [ 'debug' => true ],
|
|
'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
|
|
'only' => ResourceLoaderModule::TYPE_STYLES,
|
|
'output' => '<link rel="stylesheet" href="/w/load.php?debug=true&lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>' . "\n"
|
|
. '<link rel="stylesheet" href="/w/load.php?debug=true&lang=nl&modules=test.styles.mixed&only=styles&skin=fallback"/>',
|
|
],
|
|
[
|
|
'context' => [],
|
|
'modules' => [ 'test.styles.noscript' ],
|
|
'only' => ResourceLoaderModule::TYPE_STYLES,
|
|
'output' => '<noscript><link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.noscript&only=styles&skin=fallback"/></noscript>',
|
|
],
|
|
// @codingStandardsIgnoreEnd
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideMakeLoad
|
|
* @covers ResourceLoaderClientHtml::makeLoad
|
|
* @covers ResourceLoaderClientHtml::makeContext
|
|
* @covers ResourceLoader::makeModuleResponse
|
|
* @covers ResourceLoaderModule::getModuleContent
|
|
* @covers ResourceLoader::getCombinedVersion
|
|
* @covers ResourceLoader::createLoaderURL
|
|
* @covers ResourceLoader::createLoaderQuery
|
|
* @covers ResourceLoader::makeLoaderQuery
|
|
* @covers ResourceLoader::makeInlineScript
|
|
*/
|
|
public function testMakeLoad( array $extraQuery, array $modules, $type, $expected ) {
|
|
$context = self::makeContext( $extraQuery );
|
|
$context->getResourceLoader()->register( self::makeSampleModules() );
|
|
$actual = ResourceLoaderClientHtml::makeLoad( $context, $modules, $type );
|
|
$expected = self::expandVariables( $expected );
|
|
$this->assertEquals( $expected, (string)$actual );
|
|
}
|
|
}
|