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()
116 public function provideTestIsFileModule() {
117 $fileModuleObj = $this->getMockBuilder( ResourceLoaderFileModule
::class )
118 ->disableOriginalConstructor()
122 new ResourceLoaderTestModule()
124 'FileModule object' => [ false,
127 'simple empty' => [ true,
130 'simple scripts' => [ true,
131 [ 'scripts' => 'example.js' ]
133 'simple scripts, raw and targets' => [ true, [
134 'scripts' => [ 'a.js', 'b.js' ],
136 'targets' => [ 'desktop', 'mobile' ],
138 'FileModule' => [ true,
139 [ 'class' => ResourceLoaderFileModule
::class, 'scripts' => 'example.js' ]
141 'TestModule' => [ false,
142 [ 'class' => ResourceLoaderTestModule
::class, 'scripts' => 'example.js' ]
144 'SkinModule (FileModule subclass)' => [ true,
145 [ 'class' => ResourceLoaderSkinModule
::class, 'scripts' => 'example.js' ]
147 'JqueryMsgModule (FileModule subclass)' => [ true, [
148 'class' => ResourceLoaderJqueryMsgModule
::class,
149 'scripts' => 'example.js',
151 'WikiModule' => [ false, [
152 'class' => ResourceLoaderWikiModule
::class,
153 'scripts' => [ 'MediaWiki:Example.js' ],
159 * @dataProvider provideTestIsFileModule
160 * @covers ResourceLoader::isFileModule
162 public function testIsFileModule( $expected, $module ) {
163 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
164 $rl->register( 'test', $module );
165 $this->assertSame( $expected, $rl->isFileModule( 'test' ) );
169 * @covers ResourceLoader::isFileModule
171 public function testIsFileModuleUnknown() {
172 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
173 $this->assertSame( false, $rl->isFileModule( 'unknown' ) );
177 * @covers ResourceLoader::isModuleRegistered
179 public function testIsModuleRegistered() {
180 $rl = new EmptyResourceLoader();
181 $rl->register( 'test', new ResourceLoaderTestModule() );
182 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
183 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
187 * @covers ResourceLoader::getModule
189 public function testGetModuleUnknown() {
190 $rl = new EmptyResourceLoader();
191 $this->assertSame( null, $rl->getModule( 'test' ) );
195 * @covers ResourceLoader::getModule
197 public function testGetModuleClass() {
198 $rl = new EmptyResourceLoader();
199 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
200 $this->assertInstanceOf(
201 ResourceLoaderTestModule
::class,
202 $rl->getModule( 'test' )
207 * @covers ResourceLoader::getModule
209 public function testGetModuleFactory() {
210 $factory = function ( array $info ) {
211 $this->assertArrayHasKey( 'kitten', $info );
212 return new ResourceLoaderTestModule( $info );
215 $rl = new EmptyResourceLoader();
216 $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
217 $this->assertInstanceOf(
218 ResourceLoaderTestModule
::class,
219 $rl->getModule( 'test' )
224 * @covers ResourceLoader::getModule
226 public function testGetModuleClassDefault() {
227 $rl = new EmptyResourceLoader();
228 $rl->register( 'test', [] );
229 $this->assertInstanceOf(
230 ResourceLoaderFileModule
::class,
231 $rl->getModule( 'test' ),
232 'Array-style module registrations default to FileModule'
237 * @covers ResourceLoaderFileModule::compileLessFile
239 public function testLessFileCompilation() {
240 $context = $this->getResourceLoaderContext();
241 $basePath = __DIR__
. '/../../data/less/module';
242 $module = new ResourceLoaderFileModule( [
243 'localBasePath' => $basePath,
244 'styles' => [ 'styles.less' ],
246 $module->setName( 'test.less' );
247 $styles = $module->getStyles( $context );
248 $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
251 public static function providePackedModules() {
254 'Example from makePackedModulesString doc comment',
255 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
256 'foo.bar,baz|bar.baz,quux',
259 'Example from expandModuleNames doc comment',
260 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
261 'jquery.foo,bar|jquery.ui.baz,quux',
264 'Regression fixed in r88706 with dotless names',
265 [ 'foo', 'bar', 'baz' ],
269 'Prefixless modules after a prefixed module',
270 [ 'single.module', 'foobar', 'foobaz' ],
271 'single.module|foobar,foobaz',
275 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
276 'foo|foo.baz,bar|baz.quux',
277 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
283 * @dataProvider providePackedModules
284 * @covers ResourceLoader::makePackedModulesString
286 public function testMakePackedModulesString( $desc, $modules, $packed ) {
287 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
291 * @dataProvider providePackedModules
292 * @covers ResourceLoaderContext::expandModuleNames
294 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
296 $unpacked ?
: $modules,
297 ResourceLoaderContext
::expandModuleNames( $packed ),
302 public static function provideAddSource() {
304 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
305 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
308 'foowiki' => 'https://example.org/w/load.php',
309 'bazwiki' => 'https://example.com/w/load.php',
312 [ 'foowiki', 'bazwiki' ]
318 * @dataProvider provideAddSource
319 * @covers ResourceLoader::addSource
320 * @covers ResourceLoader::getSources
322 public function testAddSource( $name, $info, $expected ) {
323 $rl = new ResourceLoader
;
324 $rl->addSource( $name, $info );
325 if ( is_array( $expected ) ) {
326 foreach ( $expected as $source ) {
327 $this->assertArrayHasKey( $source, $rl->getSources() );
330 $this->assertArrayHasKey( $expected, $rl->getSources() );
335 * @covers ResourceLoader::addSource
337 public function testAddSourceDupe() {
338 $rl = new ResourceLoader
;
339 $this->setExpectedException( 'MWException', 'ResourceLoader duplicate source addition error' );
340 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
341 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
345 * @covers ResourceLoader::addSource
347 public function testAddSourceInvalid() {
348 $rl = new ResourceLoader
;
349 $this->setExpectedException( 'MWException', 'with no "loadScript" key' );
350 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
353 public static function provideLoaderImplement() {
356 'title' => 'Implement scripts, styles and messages',
358 'name' => 'test.example',
359 'scripts' => 'mw.example();',
360 'styles' => [ 'css' => [ '.mw-example {}' ] ],
361 'messages' => [ 'example' => '' ],
364 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
375 'title' => 'Implement scripts',
377 'name' => 'test.example',
378 'scripts' => 'mw.example();',
381 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
386 'title' => 'Implement styles',
388 'name' => 'test.example',
390 'styles' => [ 'css' => [ '.mw-example {}' ] ],
392 'expected' => 'mw.loader.implement( "test.example", [], {
399 'title' => 'Implement scripts and messages',
401 'name' => 'test.example',
402 'scripts' => 'mw.example();',
403 'messages' => [ 'example' => '' ],
405 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
412 'title' => 'Implement scripts and templates',
414 'name' => 'test.example',
415 'scripts' => 'mw.example();',
416 'templates' => [ 'example.html' => '' ],
418 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
425 'title' => 'Implement unwrapped user script',
428 'scripts' => 'mw.example( 1 );',
431 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
437 * @dataProvider provideLoaderImplement
438 * @covers ResourceLoader::makeLoaderImplementScript
439 * @covers ResourceLoader::trimArray
441 public function testMakeLoaderImplementScript( $case ) {
444 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' )
446 ResourceLoader
::clearCache();
447 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
449 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
452 $rl->makeLoaderImplementScript(
454 ( $case['wrap'] && is_string( $case['scripts'] ) )
455 ?
new XmlJsCode( $case['scripts'] )
465 * @covers ResourceLoader::makeLoaderImplementScript
467 public function testMakeLoaderImplementScriptInvalid() {
468 $this->setExpectedException( 'MWException', 'Invalid scripts error' );
469 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
470 $rl->makeLoaderImplementScript(
480 * @covers ResourceLoader::makeLoaderRegisterScript
482 public function testMakeLoaderRegisterScript() {
484 'mw.loader.register( [
490 ResourceLoader
::makeLoaderRegisterScript( [
491 [ 'test.name', '1234567' ],
493 'Nested array parameter'
497 'mw.loader.register( "test.name", "1234567" );',
498 ResourceLoader
::makeLoaderRegisterScript(
502 'Variadic parameters'
507 * @covers ResourceLoader::makeLoaderSourcesScript
509 public function testMakeLoaderSourcesScript() {
511 'mw.loader.addSource( "local", "/w/load.php" );',
512 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
515 'mw.loader.addSource( {
516 "local": "/w/load.php"
518 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
521 'mw.loader.addSource( {
522 "local": "/w/load.php",
523 "example": "https://example.org/w/load.php"
525 ResourceLoader
::makeLoaderSourcesScript( [
526 'local' => '/w/load.php',
527 'example' => 'https://example.org/w/load.php'
531 'mw.loader.addSource( [] );',
532 ResourceLoader
::makeLoaderSourcesScript( [] )
536 private static function fakeSources() {
539 'loadScript' => '//example.org/w/load.php',
540 'apiScript' => '//example.org/w/api.php',
543 'loadScript' => '//example.com/w/load.php',
544 'apiScript' => '//example.com/w/api.php',
550 * @covers ResourceLoader::getLoadScript
552 public function testGetLoadScript() {
553 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
554 $rl = new ResourceLoader();
555 $sources = self
::fakeSources();
556 $rl->addSource( $sources );
557 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
558 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
562 $rl->getLoadScript( 'thiswasneverreigstered' );
563 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
564 } catch ( MWException
$e ) {
565 $this->assertTrue( true );
569 protected function getFailFerryMock() {
570 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
571 ->setMethods( [ 'getScript' ] )
573 $mock->method( 'getScript' )->will( $this->throwException(
574 new Exception( 'Ferry not found' )
579 protected function getSimpleModuleMock( $script = '' ) {
580 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
581 ->setMethods( [ 'getScript' ] )
583 $mock->method( 'getScript' )->willReturn( $script );
588 * @covers ResourceLoader::getCombinedVersion
590 public function testGetCombinedVersion() {
591 $rl = new EmptyResourceLoader();
593 'foo' => self
::getSimpleModuleMock(),
594 'ferry' => self
::getFailFerryMock(),
595 'bar' => self
::getSimpleModuleMock(),
597 $context = $this->getResourceLoaderContext( [], $rl );
601 $rl->getCombinedVersion( $context, [] ),
606 ResourceLoader
::makeHash( self
::BLANK_VERSION
),
607 $rl->getCombinedVersion( $context, [ 'foo' ] ),
611 // Verify that getCombinedVersion() does not throw when ferry fails.
612 // Instead it gracefully continues to combine the remaining modules.
614 ResourceLoader
::makeHash( self
::BLANK_VERSION
. self
::BLANK_VERSION
),
615 $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
616 'compute foo+ferry+bar (T152266)'
620 public static function provideMakeModuleResponseConcat() {
626 'expected' => "foo()\n" . 'mw.loader.state( {
629 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
630 'message' => 'Script without semi-colon',
637 'expected' => "foo()\nbar()\n" . 'mw.loader.state( {
641 'minified' => "foo()\nbar()\n" . 'mw.loader.state({"foo":"ready","bar":"ready"});',
642 'message' => 'Two scripts without semi-colon',
646 'foo' => "foo()\n// bar();"
648 'expected' => "foo()\n// bar();\n" . 'mw.loader.state( {
651 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
652 'message' => 'Script with semi-colon in comment (T162719)',
656 foreach ( $testcases as $i => $case ) {
663 $ret["#$i (minified)"] = [
674 * Verify how multiple scripts and mw.loader.state() calls are concatenated.
676 * @dataProvider provideMakeModuleResponseConcat
677 * @covers ResourceLoader::makeModuleResponse
679 public function testMakeModuleResponseConcat( $scripts, $expected, $debug, $message = null ) {
680 $rl = new EmptyResourceLoader();
681 $modules = array_map( function ( $script ) {
682 return self
::getSimpleModuleMock( $script );
684 $rl->register( $modules );
686 $this->setMwGlobals( 'wgResourceLoaderDebug', $debug );
687 $context = $this->getResourceLoaderContext(
689 'modules' => implode( '|', array_keys( $modules ) ),
695 $response = $rl->makeModuleResponse( $context, $modules );
696 $this->assertSame( [], $rl->getErrors(), 'Errors' );
697 $this->assertEquals( $expected, $response, $message ?
: 'Response' );
701 * Verify that when building module content in a load.php response,
702 * an exception from one module will not break script output from
705 * @covers ResourceLoader::makeModuleResponse
707 public function testMakeModuleResponseError() {
709 'foo' => self
::getSimpleModuleMock( 'foo();' ),
710 'ferry' => self
::getFailFerryMock(),
711 'bar' => self
::getSimpleModuleMock( 'bar();' ),
713 $rl = new EmptyResourceLoader();
714 $rl->register( $modules );
715 $context = $this->getResourceLoaderContext(
717 'modules' => 'foo|ferry|bar',
723 $response = $rl->makeModuleResponse( $context, $modules );
724 $errors = $rl->getErrors();
726 $this->assertCount( 1, $errors );
727 $this->assertRegExp( '/Ferry not found/', $errors[0] );
729 "foo();\nbar();\n" . 'mw.loader.state( {
739 * Verify that when building the startup module response,
740 * an exception from one module class will not break the entire
741 * startup module response. See T152266.
743 * @covers ResourceLoader::makeModuleResponse
745 public function testMakeModuleResponseStartupError() {
746 $rl = new EmptyResourceLoader();
748 'foo' => self
::getSimpleModuleMock( 'foo();' ),
749 'ferry' => self
::getFailFerryMock(),
750 'bar' => self
::getSimpleModuleMock( 'bar();' ),
751 'startup' => [ 'class' => 'ResourceLoaderStartUpModule' ],
753 $context = $this->getResourceLoaderContext(
755 'modules' => 'startup',
762 [ 'foo', 'ferry', 'bar', 'startup' ],
763 $rl->getModuleNames(),
767 $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
768 $response = $rl->makeModuleResponse( $context, $modules );
769 $errors = $rl->getErrors();
771 $this->assertRegExp( '/Ferry not found/', $errors[0] );
772 $this->assertCount( 1, $errors );
774 '/isCompatible.*function startUp/s',
776 'startup response undisrupted (T152266)'
779 '/register\([^)]+"ferry",\s*""/s',
781 'startup response registers broken module'
784 '/state\([^)]+"ferry":\s*"error"/s',
786 'startup response sets state to error'