3 use Wikimedia\TestingAccessWrapper
;
6 * @group ResourceLoader
8 class ResourceLoaderClientHtmlTest
extends PHPUnit\Framework\TestCase
{
10 use MediaWikiCoversValidator
;
12 protected static function expandVariables( $text ) {
13 return strtr( $text, [
14 '{blankVer}' => ResourceLoaderTestCase
::BLANK_VERSION
18 protected static function makeContext( $extraQuery = [] ) {
19 $conf = new HashConfig( [
20 'ResourceLoaderSources' => [],
21 'ResourceModuleSkinStyles' => [],
22 'ResourceModules' => [],
23 'EnableJavaScriptTest' => false,
24 'ResourceLoaderDebug' => false,
25 'LoadScript' => '/w/load.php',
27 return new ResourceLoaderContext(
28 new ResourceLoader( $conf ),
29 new FauxRequest( array_merge( [
33 'target' => 'phpunit',
38 protected static function makeModule( array $options = [] ) {
39 return new ResourceLoaderTestModule( $options );
42 protected static function makeSampleModules() {
45 'test.private' => [ 'group' => 'private' ],
46 'test.shouldembed.empty' => [ 'shouldEmbed' => true, 'isKnownEmpty' => true ],
47 'test.shouldembed' => [ 'shouldEmbed' => true ],
48 'test.user' => [ 'group' => 'user' ],
50 'test.styles.pure' => [ 'type' => ResourceLoaderModule
::LOAD_STYLES
],
51 'test.styles.mixed' => [],
52 'test.styles.noscript' => [
53 'type' => ResourceLoaderModule
::LOAD_STYLES
,
54 'group' => 'noscript',
56 'test.styles.user' => [
57 'type' => ResourceLoaderModule
::LOAD_STYLES
,
60 'test.styles.user.empty' => [
61 'type' => ResourceLoaderModule
::LOAD_STYLES
,
63 'isKnownEmpty' => true,
65 'test.styles.private' => [
66 'type' => ResourceLoaderModule
::LOAD_STYLES
,
68 'styles' => '.private{}',
70 'test.styles.shouldembed' => [
71 'type' => ResourceLoaderModule
::LOAD_STYLES
,
72 'shouldEmbed' => true,
73 'styles' => '.shouldembed{}',
75 'test.styles.deprecated' => [
76 'type' => ResourceLoaderModule
::LOAD_STYLES
,
77 'deprecated' => 'Deprecation message.',
81 'test.scripts.user' => [ 'group' => 'user' ],
82 'test.scripts.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
83 'test.scripts.raw' => [ 'isRaw' => true ],
84 'test.scripts.shouldembed' => [ 'shouldEmbed' => true ],
86 'test.ordering.a' => [ 'shouldEmbed' => false ],
87 'test.ordering.b' => [ 'shouldEmbed' => false ],
88 'test.ordering.c' => [ 'shouldEmbed' => true, 'styles' => '.orderingC{}' ],
89 'test.ordering.d' => [ 'shouldEmbed' => true, 'styles' => '.orderingD{}' ],
90 'test.ordering.e' => [ 'shouldEmbed' => false ],
92 return array_map( function ( $options ) {
93 return self
::makeModule( $options );
98 * @covers ResourceLoaderClientHtml::getDocumentAttributes
100 public function testGetDocumentAttributes() {
101 $client = new ResourceLoaderClientHtml( self
::makeContext() );
102 $this->assertInternalType( 'array', $client->getDocumentAttributes() );
106 * @covers ResourceLoaderClientHtml::__construct
107 * @covers ResourceLoaderClientHtml::setModules
108 * @covers ResourceLoaderClientHtml::setModuleStyles
109 * @covers ResourceLoaderClientHtml::setModuleScripts
110 * @covers ResourceLoaderClientHtml::getData
111 * @covers ResourceLoaderClientHtml::getContext
113 public function testGetData() {
114 $context = self
::makeContext();
115 $context->getResourceLoader()->register( self
::makeSampleModules() );
117 $client = new ResourceLoaderClientHtml( $context );
118 $client->setModules( [
121 'test.shouldembed.empty',
126 $client->setModuleStyles( [
128 'test.styles.user.empty',
129 'test.styles.private',
131 'test.styles.shouldembed',
132 'test.styles.deprecated',
133 'test.unregistered.styles',
135 $client->setModuleScripts( [
138 'test.scripts.user.empty',
139 'test.scripts.shouldembed',
140 'test.unregistered.scripts',
145 'test.private' => 'loading',
146 'test.shouldembed.empty' => 'ready',
147 'test.shouldembed' => 'loading',
148 'test.user' => 'loading',
149 'test.styles.pure' => 'ready',
150 'test.styles.user.empty' => 'ready',
151 'test.styles.private' => 'ready',
152 'test.styles.shouldembed' => 'ready',
153 'test.styles.deprecated' => 'ready',
154 'test.scripts' => 'loading',
155 'test.scripts.user' => 'loading',
156 'test.scripts.user.empty' => 'ready',
157 'test.scripts.shouldembed' => 'loading',
164 'test.styles.deprecated',
169 'test.scripts.shouldembed',
172 'styles' => [ 'test.styles.private', 'test.styles.shouldembed' ],
179 'styledeprecations' => [
182 [ 'This page is using the deprecated ResourceLoader module "test.styles.deprecated".
183 Deprecation message.' ]
188 $access = TestingAccessWrapper
::newFromObject( $client );
189 $this->assertEquals( $expected, $access->getData() );
193 * @covers ResourceLoaderClientHtml::setConfig
194 * @covers ResourceLoaderClientHtml::setExemptStates
195 * @covers ResourceLoaderClientHtml::getHeadHtml
196 * @covers ResourceLoaderClientHtml::getLoad
197 * @covers ResourceLoader::makeLoaderStateScript
199 public function testGetHeadHtml() {
200 $context = self
::makeContext();
201 $context->getResourceLoader()->register( self
::makeSampleModules() );
203 $client = new ResourceLoaderClientHtml( $context, [
206 $client->setConfig( [ 'key' => 'value' ] );
207 $client->setModules( [
211 $client->setModuleStyles( [
213 'test.styles.private',
214 'test.styles.deprecated',
216 $client->setModuleScripts( [
219 $client->setExemptStates( [
220 'test.exempt' => 'ready',
223 // phpcs:disable Generic.Files.LineLength
224 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
225 . '<script>(window.RLQ=window.RLQ||[]).push(function(){'
226 . 'mw.config.set({"key":"value"});'
227 . 'mw.loader.state({"test.exempt":"ready","test.private":"loading","test.styles.pure":"ready","test.styles.private":"ready","test.styles.deprecated":"ready","test.scripts":"loading"});'
228 . 'mw.loader.implement("test.private@{blankVer}",function($,jQuery,require,module){},{"css":[]});'
229 . 'mw.loader.load(["test"]);'
230 . 'mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts\u0026only=scripts\u0026skin=fallback");'
231 . 'mw.log.warn("This page is using the deprecated ResourceLoader module \"test.styles.deprecated\".\nDeprecation message.");'
232 . '});</script>' . "\n"
233 . '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.deprecated%2Cpure&only=styles&skin=fallback"/>' . "\n"
234 . '<style>.private{}</style>' . "\n"
235 . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
237 $expected = self
::expandVariables( $expected );
239 $this->assertEquals( $expected, $client->getHeadHtml() );
243 * Confirm that 'target' is passed down to the startup module's load url.
245 * @covers ResourceLoaderClientHtml::getHeadHtml
247 public function testGetHeadHtmlWithTarget() {
248 $client = new ResourceLoaderClientHtml(
250 [ 'target' => 'example' ]
253 // phpcs:disable Generic.Files.LineLength
254 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
255 . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback&target=example"></script>';
258 $this->assertEquals( $expected, $client->getHeadHtml() );
262 * Confirm that a null 'target' is the same as no target.
264 * @covers ResourceLoaderClientHtml::getHeadHtml
266 public function testGetHeadHtmlWithNullTarget() {
267 $client = new ResourceLoaderClientHtml(
272 // phpcs:disable Generic.Files.LineLength
273 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
274 . '<script async="" src="/w/load.php?debug=false&lang=nl&modules=startup&only=scripts&skin=fallback"></script>';
277 $this->assertEquals( $expected, $client->getHeadHtml() );
281 * @covers ResourceLoaderClientHtml::getBodyHtml
282 * @covers ResourceLoaderClientHtml::getLoad
284 public function testGetBodyHtml() {
285 $context = self
::makeContext();
286 $context->getResourceLoader()->register( self
::makeSampleModules() );
288 $client = new ResourceLoaderClientHtml( $context );
289 $client->setConfig( [ 'key' => 'value' ] );
290 $client->setModules( [
292 'test.private.bottom',
294 $client->setModuleScripts( [
299 $expected = self
::expandVariables( $expected );
301 $this->assertEquals( $expected, $client->getBodyHtml() );
304 public static function provideMakeLoad() {
305 // phpcs:disable Generic.Files.LineLength
309 'modules' => [ 'test.unknown' ],
310 'only' => ResourceLoaderModule
::TYPE_STYLES
,
315 'modules' => [ 'test.styles.private' ],
316 'only' => ResourceLoaderModule
::TYPE_STYLES
,
317 'output' => '<style>.private{}</style>',
321 'modules' => [ 'test.private' ],
322 'only' => ResourceLoaderModule
::TYPE_COMBINED
,
323 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.private@{blankVer}",function($,jQuery,require,module){},{"css":[]});});</script>',
327 // Eg. startup module
328 'modules' => [ 'test.scripts.raw' ],
329 'only' => ResourceLoaderModule
::TYPE_SCRIPTS
,
330 'output' => '<script async="" src="/w/load.php?debug=false&lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback"></script>',
333 'context' => [ 'sync' => true ],
334 'modules' => [ 'test.scripts.raw' ],
335 'only' => ResourceLoaderModule
::TYPE_SCRIPTS
,
336 'output' => '<script src="/w/load.php?debug=false&lang=nl&modules=test.scripts.raw&only=scripts&skin=fallback&sync=1"></script>',
340 'modules' => [ 'test.scripts.user' ],
341 'only' => ResourceLoaderModule
::TYPE_SCRIPTS
,
342 '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>',
346 'modules' => [ 'test.user' ],
347 'only' => ResourceLoaderModule
::TYPE_COMBINED
,
348 '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>',
351 'context' => [ 'debug' => true ],
352 'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
353 'only' => ResourceLoaderModule
::TYPE_STYLES
,
354 'output' => '<link rel="stylesheet" href="/w/load.php?debug=true&lang=nl&modules=test.styles.mixed&only=styles&skin=fallback"/>' . "\n"
355 . '<link rel="stylesheet" href="/w/load.php?debug=true&lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>',
358 'context' => [ 'debug' => false ],
359 'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
360 'only' => ResourceLoaderModule
::TYPE_STYLES
,
361 'output' => '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.mixed%2Cpure&only=styles&skin=fallback"/>',
365 'modules' => [ 'test.styles.noscript' ],
366 'only' => ResourceLoaderModule
::TYPE_STYLES
,
367 'output' => '<noscript><link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.noscript&only=styles&skin=fallback"/></noscript>',
371 'modules' => [ 'test.shouldembed' ],
372 'only' => ResourceLoaderModule
::TYPE_COMBINED
,
373 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.shouldembed@09p30q0",function($,jQuery,require,module){},{"css":[]});});</script>',
377 'modules' => [ 'test.styles.shouldembed' ],
378 'only' => ResourceLoaderModule
::TYPE_STYLES
,
379 'output' => '<style>.shouldembed{}</style>',
383 'modules' => [ 'test.scripts.shouldembed' ],
384 'only' => ResourceLoaderModule
::TYPE_SCRIPTS
,
385 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.state({"test.scripts.shouldembed":"ready"});});</script>',
389 'modules' => [ 'test', 'test.shouldembed' ],
390 'only' => ResourceLoaderModule
::TYPE_COMBINED
,
391 '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",function($,jQuery,require,module){},{"css":[]});});</script>',
395 'modules' => [ 'test.styles.pure', 'test.styles.shouldembed' ],
396 'only' => ResourceLoaderModule
::TYPE_STYLES
,
398 '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.styles.pure&only=styles&skin=fallback"/>' . "\n"
399 . '<style>.shouldembed{}</style>'
403 'modules' => [ 'test.ordering.a', 'test.ordering.e', 'test.ordering.b', 'test.ordering.d', 'test.ordering.c' ],
404 'only' => ResourceLoaderModule
::TYPE_STYLES
,
406 '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.ordering.a%2Cb&only=styles&skin=fallback"/>' . "\n"
407 . '<style>.orderingC{}.orderingD{}</style>' . "\n"
408 . '<link rel="stylesheet" href="/w/load.php?debug=false&lang=nl&modules=test.ordering.e&only=styles&skin=fallback"/>'
415 * @dataProvider provideMakeLoad
416 * @covers ResourceLoaderClientHtml::makeLoad
417 * @covers ResourceLoaderClientHtml::makeContext
418 * @covers ResourceLoader::makeModuleResponse
419 * @covers ResourceLoaderModule::getModuleContent
420 * @covers ResourceLoader::getCombinedVersion
421 * @covers ResourceLoader::createLoaderURL
422 * @covers ResourceLoader::createLoaderQuery
423 * @covers ResourceLoader::makeLoaderQuery
424 * @covers ResourceLoader::makeInlineScript
426 public function testMakeLoad( array $extraQuery, array $modules, $type, $expected ) {
427 $context = self
::makeContext( $extraQuery );
428 $context->getResourceLoader()->register( self
::makeSampleModules() );
429 $actual = ResourceLoaderClientHtml
::makeLoad( $context, $modules, $type, $extraQuery, false );
430 $expected = self
::expandVariables( $expected );
431 $this->assertEquals( $expected, (string)$actual );