3 use Wikimedia\TestingAccessWrapper
;
5 class ResourceLoaderTest
extends ResourceLoaderTestCase
{
7 protected function setUp() {
10 $this->setMwGlobals( [
11 'wgResourceLoaderLESSImportPaths' => [
12 dirname( dirname( __DIR__
) ) . '/data/less/common',
14 'wgResourceLoaderLESSVars' => [
19 // Clear ResourceLoaderGetConfigVars hooks (called by StartupModule)
20 // to avoid notices during testMakeModuleResponse for missing
21 // wgResourceLoaderLESSVars keys in extension hooks.
23 'wgShowExceptionDetails' => true,
28 * Ensure the ResourceLoaderRegisterModules hook is called.
30 * @covers ResourceLoader::__construct
32 public function testConstructRegistrationHook() {
33 $resourceLoaderRegisterModulesHook = false;
35 $this->setMwGlobals( 'wgHooks', [
36 'ResourceLoaderRegisterModules' => [
37 function ( &$resourceLoader ) use ( &$resourceLoaderRegisterModulesHook ) {
38 $resourceLoaderRegisterModulesHook = true;
43 $unused = new ResourceLoader();
45 $resourceLoaderRegisterModulesHook,
46 'Hook ResourceLoaderRegisterModules called'
51 * @covers ResourceLoader::register
52 * @covers ResourceLoader::getModule
54 public function testRegisterValidObject() {
55 $module = new ResourceLoaderTestModule();
56 $resourceLoader = new EmptyResourceLoader();
57 $resourceLoader->register( 'test', $module );
58 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
62 * @covers ResourceLoader::register
63 * @covers ResourceLoader::getModule
65 public function testRegisterValidArray() {
66 $module = new ResourceLoaderTestModule();
67 $resourceLoader = new EmptyResourceLoader();
68 // Covers case of register() setting $rl->moduleInfos,
69 // but $rl->modules lazy-populated by getModule()
70 $resourceLoader->register( 'test', [ 'object' => $module ] );
71 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
75 * @covers ResourceLoader::register
77 public function testRegisterEmptyString() {
78 $module = new ResourceLoaderTestModule();
79 $resourceLoader = new EmptyResourceLoader();
80 $resourceLoader->register( '', $module );
81 $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
85 * @covers ResourceLoader::register
87 public function testRegisterInvalidName() {
88 $resourceLoader = new EmptyResourceLoader();
89 $this->setExpectedException( 'MWException', "name 'test!invalid' is invalid" );
90 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
94 * @covers ResourceLoader::register
96 public function testRegisterInvalidType() {
97 $resourceLoader = new EmptyResourceLoader();
98 $this->setExpectedException( 'MWException', 'ResourceLoader module info type error' );
99 $resourceLoader->register( 'test', new stdClass() );
103 * @covers ResourceLoader::getModuleNames
105 public function testGetModuleNames() {
106 // Use an empty one so that core and extension modules don't get in.
107 $resourceLoader = new EmptyResourceLoader();
108 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
109 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
111 [ 'test.foo', 'test.bar' ],
112 $resourceLoader->getModuleNames()
117 * @covers ResourceLoader::isModuleRegistered
119 public function testIsModuleRegistered() {
120 $rl = new EmptyResourceLoader();
121 $rl->register( 'test', new ResourceLoaderTestModule() );
122 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
123 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
127 * @covers ResourceLoader::getModule
129 public function testGetModuleUnknown() {
130 $rl = new EmptyResourceLoader();
131 $this->assertSame( null, $rl->getModule( 'test' ) );
135 * @covers ResourceLoader::getModule
137 public function testGetModuleClass() {
138 $rl = new EmptyResourceLoader();
139 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
140 $this->assertInstanceOf(
141 ResourceLoaderTestModule
::class,
142 $rl->getModule( 'test' )
147 * @covers ResourceLoader::getModule
149 public function testGetModuleFactory() {
150 $factory = function( array $info ) {
151 $this->assertArrayHasKey( 'kitten', $info );
152 return new ResourceLoaderTestModule( $info );
155 $rl = new EmptyResourceLoader();
156 $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
157 $this->assertInstanceOf(
158 ResourceLoaderTestModule
::class,
159 $rl->getModule( 'test' )
164 * @covers ResourceLoader::getModule
166 public function testGetModuleClassDefault() {
167 $rl = new EmptyResourceLoader();
168 $rl->register( 'test', [] );
169 $this->assertInstanceOf(
170 ResourceLoaderFileModule
::class,
171 $rl->getModule( 'test' ),
172 'Array-style module registrations default to FileModule'
177 * @covers ResourceLoaderFileModule::compileLessFile
179 public function testLessFileCompilation() {
180 $context = $this->getResourceLoaderContext();
181 $basePath = __DIR__
. '/../../data/less/module';
182 $module = new ResourceLoaderFileModule( [
183 'localBasePath' => $basePath,
184 'styles' => [ 'styles.less' ],
186 $module->setName( 'test.less' );
187 $styles = $module->getStyles( $context );
188 $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
191 public static function providePackedModules() {
194 'Example from makePackedModulesString doc comment',
195 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
196 'foo.bar,baz|bar.baz,quux',
199 'Example from expandModuleNames doc comment',
200 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
201 'jquery.foo,bar|jquery.ui.baz,quux',
204 'Regression fixed in r88706 with dotless names',
205 [ 'foo', 'bar', 'baz' ],
209 'Prefixless modules after a prefixed module',
210 [ 'single.module', 'foobar', 'foobaz' ],
211 'single.module|foobar,foobaz',
215 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
216 'foo|foo.baz,bar|baz.quux',
217 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
223 * @dataProvider providePackedModules
224 * @covers ResourceLoader::makePackedModulesString
226 public function testMakePackedModulesString( $desc, $modules, $packed ) {
227 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
231 * @dataProvider providePackedModules
232 * @covers ResourceLoaderContext::expandModuleNames
234 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
236 $unpacked ?
: $modules,
237 ResourceLoaderContext
::expandModuleNames( $packed ),
242 public static function provideAddSource() {
244 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
245 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
248 'foowiki' => 'https://example.org/w/load.php',
249 'bazwiki' => 'https://example.com/w/load.php',
252 [ 'foowiki', 'bazwiki' ]
258 * @dataProvider provideAddSource
259 * @covers ResourceLoader::addSource
260 * @covers ResourceLoader::getSources
262 public function testAddSource( $name, $info, $expected ) {
263 $rl = new ResourceLoader
;
264 $rl->addSource( $name, $info );
265 if ( is_array( $expected ) ) {
266 foreach ( $expected as $source ) {
267 $this->assertArrayHasKey( $source, $rl->getSources() );
270 $this->assertArrayHasKey( $expected, $rl->getSources() );
275 * @covers ResourceLoader::addSource
277 public function testAddSourceDupe() {
278 $rl = new ResourceLoader
;
279 $this->setExpectedException( 'MWException', 'ResourceLoader duplicate source addition error' );
280 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
281 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
285 * @covers ResourceLoader::addSource
287 public function testAddSourceInvalid() {
288 $rl = new ResourceLoader
;
289 $this->setExpectedException( 'MWException', 'with no "loadScript" key' );
290 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
293 public static function provideLoaderImplement() {
296 'title' => 'Implement scripts, styles and messages',
298 'name' => 'test.example',
299 'scripts' => 'mw.example();',
300 'styles' => [ 'css' => [ '.mw-example {}' ] ],
301 'messages' => [ 'example' => '' ],
304 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
315 'title' => 'Implement scripts',
317 'name' => 'test.example',
318 'scripts' => 'mw.example();',
321 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
326 'title' => 'Implement styles',
328 'name' => 'test.example',
330 'styles' => [ 'css' => [ '.mw-example {}' ] ],
332 'expected' => 'mw.loader.implement( "test.example", [], {
339 'title' => 'Implement scripts and messages',
341 'name' => 'test.example',
342 'scripts' => 'mw.example();',
343 'messages' => [ 'example' => '' ],
345 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
352 'title' => 'Implement scripts and templates',
354 'name' => 'test.example',
355 'scripts' => 'mw.example();',
356 'templates' => [ 'example.html' => '' ],
358 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
365 'title' => 'Implement unwrapped user script',
368 'scripts' => 'mw.example( 1 );',
371 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
377 * @dataProvider provideLoaderImplement
378 * @covers ResourceLoader::makeLoaderImplementScript
379 * @covers ResourceLoader::trimArray
381 public function testMakeLoaderImplementScript( $case ) {
384 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' )
386 ResourceLoader
::clearCache();
387 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
389 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
392 $rl->makeLoaderImplementScript(
394 ( $case['wrap'] && is_string( $case['scripts'] ) )
395 ?
new XmlJsCode( $case['scripts'] )
405 * @covers ResourceLoader::makeLoaderImplementScript
407 public function testMakeLoaderImplementScriptInvalid() {
408 $this->setExpectedException( 'MWException', 'Invalid scripts error' );
409 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
410 $rl->makeLoaderImplementScript(
420 * @covers ResourceLoader::makeLoaderRegisterScript
422 public function testMakeLoaderRegisterScript() {
424 'mw.loader.register( [
430 ResourceLoader
::makeLoaderRegisterScript( [
431 [ 'test.name', '1234567' ],
433 'Nested array parameter'
437 'mw.loader.register( "test.name", "1234567" );',
438 ResourceLoader
::makeLoaderRegisterScript(
442 'Variadic parameters'
447 * @covers ResourceLoader::makeLoaderSourcesScript
449 public function testMakeLoaderSourcesScript() {
451 'mw.loader.addSource( "local", "/w/load.php" );',
452 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
455 'mw.loader.addSource( {
456 "local": "/w/load.php"
458 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
461 'mw.loader.addSource( {
462 "local": "/w/load.php",
463 "example": "https://example.org/w/load.php"
465 ResourceLoader
::makeLoaderSourcesScript( [
466 'local' => '/w/load.php',
467 'example' => 'https://example.org/w/load.php'
471 'mw.loader.addSource( [] );',
472 ResourceLoader
::makeLoaderSourcesScript( [] )
476 private static function fakeSources() {
479 'loadScript' => '//example.org/w/load.php',
480 'apiScript' => '//example.org/w/api.php',
483 'loadScript' => '//example.com/w/load.php',
484 'apiScript' => '//example.com/w/api.php',
490 * @covers ResourceLoader::getLoadScript
492 public function testGetLoadScript() {
493 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
494 $rl = new ResourceLoader();
495 $sources = self
::fakeSources();
496 $rl->addSource( $sources );
497 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
498 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
502 $rl->getLoadScript( 'thiswasneverreigstered' );
503 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
504 } catch ( MWException
$e ) {
505 $this->assertTrue( true );
509 protected function getFailFerryMock() {
510 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
511 ->setMethods( [ 'getScript' ] )
513 $mock->method( 'getScript' )->will( $this->throwException(
514 new Exception( 'Ferry not found' )
519 protected function getSimpleModuleMock( $script = '' ) {
520 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
521 ->setMethods( [ 'getScript' ] )
523 $mock->method( 'getScript' )->willReturn( $script );
528 * @covers ResourceLoader::getCombinedVersion
530 public function testGetCombinedVersion() {
531 $rl = new EmptyResourceLoader();
533 'foo' => self
::getSimpleModuleMock(),
534 'ferry' => self
::getFailFerryMock(),
535 'bar' => self
::getSimpleModuleMock(),
537 $context = $this->getResourceLoaderContext( [], $rl );
540 ResourceLoader
::makeHash( self
::BLANK_VERSION
),
541 $rl->getCombinedVersion( $context, [ 'foo' ] ),
545 // Verify that getCombinedVersion() does not throw when ferry fails.
546 // Instead it gracefully continues to combine the remaining modules.
548 ResourceLoader
::makeHash( self
::BLANK_VERSION
. self
::BLANK_VERSION
),
549 $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
550 'compute foo+ferry+bar (T152266)'
555 * Verify that when building module content in a load.php response,
556 * an exception from one module will not break script output from
559 public function testMakeModuleResponseError() {
561 'foo' => self
::getSimpleModuleMock( 'foo();' ),
562 'ferry' => self
::getFailFerryMock(),
563 'bar' => self
::getSimpleModuleMock( 'bar();' ),
565 $rl = new EmptyResourceLoader();
566 $rl->register( $modules );
567 $context = $this->getResourceLoaderContext(
569 'modules' => 'foo|ferry|bar',
575 $response = $rl->makeModuleResponse( $context, $modules );
576 $errors = $rl->getErrors();
578 $this->assertCount( 1, $errors );
579 $this->assertRegExp( '/Ferry not found/', $errors[0] );
581 'foo();bar();mw.loader.state( {
591 * Verify that when building the startup module response,
592 * an exception from one module class will not break the entire
593 * startup module response. See T152266.
595 public function testMakeModuleResponseStartupError() {
596 $rl = new EmptyResourceLoader();
598 'foo' => self
::getSimpleModuleMock( 'foo();' ),
599 'ferry' => self
::getFailFerryMock(),
600 'bar' => self
::getSimpleModuleMock( 'bar();' ),
601 'startup' => [ 'class' => 'ResourceLoaderStartUpModule' ],
603 $context = $this->getResourceLoaderContext(
605 'modules' => 'startup',
612 [ 'foo', 'ferry', 'bar', 'startup' ],
613 $rl->getModuleNames(),
617 $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
618 $response = $rl->makeModuleResponse( $context, $modules );
619 $errors = $rl->getErrors();
621 $this->assertRegExp( '/Ferry not found/', $errors[0] );
622 $this->assertCount( 1, $errors );
624 '/isCompatible.*function startUp/s',
626 'startup response undisrupted (T152266)'
629 '/register\([^)]+"ferry",\s*""/s',
631 'startup response registers broken module'
634 '/state\([^)]+"ferry":\s*"error"/s',
636 'startup response sets state to error'