/**
* @group ResourceLoader
+ * @covers ResourceLoaderClientHtml
*/
class ResourceLoaderClientHtmlTest extends PHPUnit\Framework\TestCase {
use MediaWikiCoversValidator;
- 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,
- '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.private' => [ 'group' => 'private' ],
- 'test.shouldembed.empty' => [ 'shouldEmbed' => true, 'isKnownEmpty' => true ],
- 'test.shouldembed' => [ 'shouldEmbed' => true ],
- 'test.user' => [ 'group' => 'user' ],
-
- 'test.styles.pure' => [ 'type' => ResourceLoaderModule::LOAD_STYLES ],
- 'test.styles.mixed' => [],
- 'test.styles.noscript' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'group' => 'noscript',
- ],
- 'test.styles.user' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'group' => 'user',
- ],
- 'test.styles.user.empty' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'group' => 'user',
- 'isKnownEmpty' => true,
- ],
- 'test.styles.private' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'group' => 'private',
- 'styles' => '.private{}',
- ],
- 'test.styles.shouldembed' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'shouldEmbed' => true,
- 'styles' => '.shouldembed{}',
- ],
- 'test.styles.deprecated' => [
- 'type' => ResourceLoaderModule::LOAD_STYLES,
- 'deprecated' => 'Deprecation message.',
- ],
-
- 'test.scripts' => [],
- 'test.scripts.user' => [ 'group' => 'user' ],
- 'test.scripts.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
- 'test.scripts.raw' => [ 'isRaw' => true ],
- 'test.scripts.shouldembed' => [ 'shouldEmbed' => true ],
-
- 'test.ordering.a' => [ 'shouldEmbed' => false ],
- 'test.ordering.b' => [ 'shouldEmbed' => false ],
- 'test.ordering.c' => [ 'shouldEmbed' => true, 'styles' => '.orderingC{}' ],
- 'test.ordering.d' => [ 'shouldEmbed' => true, 'styles' => '.orderingD{}' ],
- 'test.ordering.e' => [ 'shouldEmbed' => false ],
- ];
- 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::getData
- * @covers ResourceLoaderClientHtml::getContext
- */
public function testGetData() {
$context = self::makeContext();
$context->getResourceLoader()->register( self::makeSampleModules() );
$expected = [
'states' => [
+ // The below are NOT queued for loading via `mw.loader.load(Array)`.
+ // Instead we tell the client to set their state to "loading" so that
+ // if they are needed as dependencies, the client will not try to
+ // load them on-demand, because the server is taking care of them already.
+ // Either:
+ // - Embedded as inline scripts in the HTML (e.g. user-private code, and
+ // previews). Once that script tag is reached, the state is "loaded".
+ // - Loaded directly from the HTML with a dedicated HTTP request (e.g.
+ // user scripts, which vary by a 'user' and 'version' parameter that
+ // the static user-agnostic startup module won't have).
'test.private' => 'loading',
- 'test.shouldembed.empty' => 'ready',
'test.shouldembed' => 'loading',
'test.user' => 'loading',
+ // The below are known to the server to be empty scripts, or to be
+ // synchronously loaded stylesheets. These start in the "ready" state.
+ 'test.shouldembed.empty' => 'ready',
'test.styles.pure' => 'ready',
'test.styles.user.empty' => 'ready',
'test.styles.private' => 'ready',
$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() );
] );
// phpcs:disable 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":"loading","test.styles.pure":"ready","test.styles.private":"ready","test.styles.deprecated":"ready"});'
+ $expected = '<script>'
+ . 'document.documentElement.className=document.documentElement.className.replace(/(^|\s)client-nojs(\s|$)/,"$1client-js$2");'
+ . 'RLCONF={"key":"value"};'
+ . 'RLSTATE={"test.exempt":"ready","test.private":"loading","test.styles.pure":"ready","test.styles.private":"ready","test.styles.deprecated":"ready"};'
+ . 'RLPAGEMODULES=["test"];'
+ . '</script>' . "\n"
+ . '<script>(RLQ=window.RLQ||[]).push(function(){'
. 'mw.loader.implement("test.private@{blankVer}",null,{"css":[]});'
- . 'RLPAGEMODULES=["test"];mw.loader.load(RLPAGEMODULES);'
. '});</script>' . "\n"
- . '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.deprecated%2Cpure&only=styles&skin=fallback"/>' . "\n"
+ . '<link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.styles.deprecated%2Cpure&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>';
+ . '<script async="" src="/w/load.php?lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
// phpcs:enable
$expected = self::expandVariables( $expected );
- $this->assertEquals( $expected, $client->getHeadHtml() );
+ $this->assertSame( $expected, (string)$client->getHeadHtml() );
}
/**
* Confirm that 'target' is passed down to the startup module's load url.
- *
- * @covers ResourceLoaderClientHtml::getHeadHtml
*/
public function testGetHeadHtmlWithTarget() {
$client = new ResourceLoaderClientHtml(
);
// phpcs:disable Generic.Files.LineLength
- $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
- . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback&target=example"></script>';
+ $expected = '<script>document.documentElement.className=document.documentElement.className.replace(/(^|\s)client-nojs(\s|$)/,"$1client-js$2");</script>' . "\n"
+ . '<script async="" src="/w/load.php?lang=nl&modules=startup&only=scripts&skin=fallback&target=example"></script>';
// phpcs:enable
- $this->assertEquals( $expected, $client->getHeadHtml() );
+ $this->assertSame( $expected, (string)$client->getHeadHtml() );
}
/**
* Confirm that 'safemode' is passed down to startup.
- *
- * @covers ResourceLoaderClientHtml::getHeadHtml
*/
public function testGetHeadHtmlWithSafemode() {
$client = new ResourceLoaderClientHtml(
);
// phpcs:disable Generic.Files.LineLength
- $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
- . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&safemode=1&skin=fallback"></script>';
+ $expected = '<script>document.documentElement.className=document.documentElement.className.replace(/(^|\s)client-nojs(\s|$)/,"$1client-js$2");</script>' . "\n"
+ . '<script async="" src="/w/load.php?lang=nl&modules=startup&only=scripts&safemode=1&skin=fallback"></script>';
// phpcs:enable
- $this->assertEquals( $expected, $client->getHeadHtml() );
+ $this->assertSame( $expected, (string)$client->getHeadHtml() );
}
/**
* Confirm that a null 'target' is the same as no target.
- *
- * @covers ResourceLoaderClientHtml::getHeadHtml
*/
public function testGetHeadHtmlWithNullTarget() {
$client = new ResourceLoaderClientHtml(
);
// phpcs:disable Generic.Files.LineLength
- $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
- . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
+ $expected = '<script>document.documentElement.className=document.documentElement.className.replace(/(^|\s)client-nojs(\s|$)/,"$1client-js$2");</script>' . "\n"
+ . '<script async="" src="/w/load.php?lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
// phpcs:enable
- $this->assertEquals( $expected, $client->getHeadHtml() );
+ $this->assertSame( $expected, (string)$client->getHeadHtml() );
}
- /**
- * @covers ResourceLoaderClientHtml::getBodyHtml
- * @covers ResourceLoaderClientHtml::getLoad
- */
public function testGetBodyHtml() {
$context = self::makeContext();
$context->getResourceLoader()->register( self::makeSampleModules() );
'test.styles.deprecated',
] );
// phpcs:disable Generic.Files.LineLength
- $expected = '<script>(window.RLQ=window.RLQ||[]).push(function(){'
+ $expected = '<script>(RLQ=window.RLQ||[]).push(function(){'
. 'mw.log.warn("This page is using the deprecated ResourceLoader module \"test.styles.deprecated\".\nDeprecation message.");'
. '});</script>';
// phpcs:enable
- $this->assertEquals( $expected, $client->getBodyHtml() );
+ $this->assertSame( $expected, (string)$client->getBodyHtml() );
}
public static function provideMakeLoad() {
'modules' => [ 'test.private' ],
'only' => ResourceLoaderModule::TYPE_COMBINED,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.private@{blankVer}",null,{"css":[]});});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.private@{blankVer}",null,{"css":[]});});</script>',
],
[
'context' => [],
'modules' => [ 'test.scripts.raw' ],
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
'extra' => [],
- 'output' => '<script async="" src="/w/load.php?debug=false&lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback"></script>',
+ 'output' => '<script async="" src="/w/load.php?lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback"></script>',
],
[
'context' => [],
'modules' => [ 'test.scripts.raw' ],
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
'extra' => [ 'sync' => '1' ],
- 'output' => '<script src="/w/load.php?debug=false&lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback&sync=1"></script>',
+ 'output' => '<script src="/w/load.php?lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback&sync=1"></script>',
],
[
'context' => [],
'modules' => [ 'test.scripts.user' ],
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts.user\u0026only=scripts\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?lang=nl\u0026modules=test.scripts.user\u0026only=scripts\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
],
[
'context' => [],
'modules' => [ 'test.user' ],
'only' => ResourceLoaderModule::TYPE_COMBINED,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.user\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?lang=nl\u0026modules=test.user\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
],
[
'context' => [ 'debug' => 'true' ],
'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
'only' => ResourceLoaderModule::TYPE_STYLES,
'extra' => [],
- 'output' => '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.mixed%2Cpure&only=styles&skin=fallback"/>',
+ 'output' => '<link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.styles.mixed%2Cpure&only=styles&skin=fallback"/>',
],
[
'context' => [],
'modules' => [ 'test.styles.noscript' ],
'only' => ResourceLoaderModule::TYPE_STYLES,
'extra' => [],
- 'output' => '<noscript><link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.noscript&only=styles&skin=fallback"/></noscript>',
+ 'output' => '<noscript><link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.styles.noscript&only=styles&skin=fallback"/></noscript>',
],
[
'context' => [],
'modules' => [ 'test.shouldembed' ],
'only' => ResourceLoaderModule::TYPE_COMBINED,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.shouldembed@09p30q0",null,{"css":[]});});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.shouldembed@09p30q0",null,{"css":[]});});</script>',
],
[
'context' => [],
'modules' => [ 'test.scripts.shouldembed' ],
'only' => ResourceLoaderModule::TYPE_SCRIPTS,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.state({"test.scripts.shouldembed":"ready"});});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.state({"test.scripts.shouldembed":"ready"});});</script>',
],
[
'context' => [],
'modules' => [ 'test', 'test.shouldembed' ],
'only' => ResourceLoaderModule::TYPE_COMBINED,
'extra' => [],
- 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test\u0026skin=fallback");mw.loader.implement("test.shouldembed@09p30q0",null,{"css":[]});});</script>',
+ 'output' => '<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?lang=nl\u0026modules=test\u0026skin=fallback");mw.loader.implement("test.shouldembed@09p30q0",null,{"css":[]});});</script>',
],
[
'context' => [],
'only' => ResourceLoaderModule::TYPE_STYLES,
'extra' => [],
'output' =>
- '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>' . "\n"
+ '<link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>' . "\n"
. '<style>.shouldembed{}</style>'
],
[
'only' => ResourceLoaderModule::TYPE_STYLES,
'extra' => [],
'output' =>
- '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.ordering.a%2Cb&only=styles&skin=fallback"/>' . "\n"
+ '<link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.ordering.a%2Cb&only=styles&skin=fallback"/>' . "\n"
. '<style>.orderingC{}.orderingD{}</style>' . "\n"
- . '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.ordering.e&only=styles&skin=fallback"/>'
+ . '<link rel="stylesheet" href="/w/load.php?lang=nl&modules=test.ordering.e&only=styles&skin=fallback"/>'
],
];
// phpcs:enable
/**
* @dataProvider provideMakeLoad
- * @covers ResourceLoaderClientHtml::makeLoad
- * @covers ResourceLoaderClientHtml::makeContext
- * @covers ResourceLoader::makeModuleResponse
+ * @covers ResourceLoaderClientHtml
* @covers ResourceLoaderModule::getModuleContent
- * @covers ResourceLoader::getCombinedVersion
- * @covers ResourceLoader::createLoaderURL
- * @covers ResourceLoader::createLoaderQuery
- * @covers ResourceLoader::makeLoaderQuery
- * @covers ResourceLoader::makeInlineScript
+ * @covers ResourceLoader
*/
public function testMakeLoad(
array $contextQuery,
$context->getResourceLoader()->register( self::makeSampleModules() );
$actual = ResourceLoaderClientHtml::makeLoad( $context, $modules, $type, $extraQuery, false );
$expected = self::expandVariables( $expected );
- $this->assertEquals( $expected, (string)$actual );
+ $this->assertSame( $expected, (string)$actual );
+ }
+
+ public function testGetDocumentAttributes() {
+ $client = new ResourceLoaderClientHtml( self::makeContext() );
+ $this->assertInternalType( 'array', $client->getDocumentAttributes() );
+ }
+
+ private static function expandVariables( $text ) {
+ return strtr( $text, [
+ '{blankVer}' => ResourceLoaderTestCase::BLANK_VERSION
+ ] );
+ }
+
+ private static function makeContext( $extraQuery = [] ) {
+ $conf = new HashConfig( [
+ 'ResourceModuleSkinStyles' => [],
+ 'ResourceModules' => [],
+ 'EnableJavaScriptTest' => false,
+ 'LoadScript' => '/w/load.php',
+ ] );
+ return new ResourceLoaderContext(
+ new ResourceLoader( $conf ),
+ new FauxRequest( array_merge( [
+ 'lang' => 'nl',
+ 'skin' => 'fallback',
+ 'user' => 'Example',
+ 'target' => 'phpunit',
+ ], $extraQuery ) )
+ );
+ }
+
+ private static function makeModule( array $options = [] ) {
+ return new ResourceLoaderTestModule( $options );
+ }
+
+ private static function makeSampleModules() {
+ $modules = [
+ 'test' => [],
+ 'test.private' => [ 'group' => 'private' ],
+ 'test.shouldembed.empty' => [ 'shouldEmbed' => true, 'isKnownEmpty' => true ],
+ 'test.shouldembed' => [ 'shouldEmbed' => true ],
+ 'test.user' => [ 'group' => 'user' ],
+
+ 'test.styles.pure' => [ 'type' => ResourceLoaderModule::LOAD_STYLES ],
+ 'test.styles.mixed' => [],
+ 'test.styles.noscript' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'group' => 'noscript',
+ ],
+ 'test.styles.user' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'group' => 'user',
+ ],
+ 'test.styles.user.empty' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'group' => 'user',
+ 'isKnownEmpty' => true,
+ ],
+ 'test.styles.private' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'group' => 'private',
+ 'styles' => '.private{}',
+ ],
+ 'test.styles.shouldembed' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'shouldEmbed' => true,
+ 'styles' => '.shouldembed{}',
+ ],
+ 'test.styles.deprecated' => [
+ 'type' => ResourceLoaderModule::LOAD_STYLES,
+ 'deprecated' => 'Deprecation message.',
+ ],
+
+ 'test.scripts' => [],
+ 'test.scripts.user' => [ 'group' => 'user' ],
+ 'test.scripts.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
+ 'test.scripts.raw' => [ 'isRaw' => true ],
+ 'test.scripts.shouldembed' => [ 'shouldEmbed' => true ],
+
+ 'test.ordering.a' => [ 'shouldEmbed' => false ],
+ 'test.ordering.b' => [ 'shouldEmbed' => false ],
+ 'test.ordering.c' => [ 'shouldEmbed' => true, 'styles' => '.orderingC{}' ],
+ 'test.ordering.d' => [ 'shouldEmbed' => true, 'styles' => '.orderingD{}' ],
+ 'test.ordering.e' => [ 'shouldEmbed' => false ],
+ ];
+ return array_map( function ( $options ) {
+ return self::makeModule( $options );
+ }, $modules );
}
}
dépôts / lhc / web / wiklou.git / blobdiff