3 use Wikimedia\TestingAccessWrapper
;
5 class ResourceLoaderTest
extends ResourceLoaderTestCase
{
7 protected function setUp() {
10 $this->setMwGlobals( [
11 'wgShowExceptionDetails' => true,
16 * Ensure the ResourceLoaderRegisterModules hook is called.
18 * @covers ResourceLoader::__construct
20 public function testConstructRegistrationHook() {
21 $resourceLoaderRegisterModulesHook = false;
23 $this->setMwGlobals( 'wgHooks', [
24 'ResourceLoaderRegisterModules' => [
25 function ( &$resourceLoader ) use ( &$resourceLoaderRegisterModulesHook ) {
26 $resourceLoaderRegisterModulesHook = true;
31 $unused = new ResourceLoader();
33 $resourceLoaderRegisterModulesHook,
34 'Hook ResourceLoaderRegisterModules called'
39 * @covers ResourceLoader::register
40 * @covers ResourceLoader::getModule
42 public function testRegisterValidObject() {
43 $module = new ResourceLoaderTestModule();
44 $resourceLoader = new EmptyResourceLoader();
45 $resourceLoader->register( 'test', $module );
46 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
50 * @covers ResourceLoader::register
51 * @covers ResourceLoader::getModule
53 public function testRegisterValidArray() {
54 $module = new ResourceLoaderTestModule();
55 $resourceLoader = new EmptyResourceLoader();
56 // Covers case of register() setting $rl->moduleInfos,
57 // but $rl->modules lazy-populated by getModule()
58 $resourceLoader->register( 'test', [ 'object' => $module ] );
59 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
63 * @covers ResourceLoader::register
65 public function testRegisterEmptyString() {
66 $module = new ResourceLoaderTestModule();
67 $resourceLoader = new EmptyResourceLoader();
68 $resourceLoader->register( '', $module );
69 $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
73 * @covers ResourceLoader::register
75 public function testRegisterInvalidName() {
76 $resourceLoader = new EmptyResourceLoader();
77 $this->setExpectedException( MWException
::class, "name 'test!invalid' is invalid" );
78 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
82 * @covers ResourceLoader::register
84 public function testRegisterInvalidType() {
85 $resourceLoader = new EmptyResourceLoader();
86 $this->setExpectedException( MWException
::class, 'ResourceLoader module info type error' );
87 $resourceLoader->register( 'test', new stdClass() );
91 * @covers ResourceLoader::register
93 public function testRegisterDuplicate() {
94 $logger = $this->getMockBuilder( Psr\Log\LoggerInterface
::class )->getMock();
95 $logger->expects( $this->once() )
96 ->method( 'warning' );
97 $resourceLoader = new EmptyResourceLoader( null, $logger );
99 $module1 = new ResourceLoaderTestModule();
100 $module2 = new ResourceLoaderTestModule();
101 $resourceLoader->register( 'test', $module1 );
102 $resourceLoader->register( 'test', $module2 );
103 $this->assertSame( $module2, $resourceLoader->getModule( 'test' ) );
107 * @covers ResourceLoader::getModuleNames
109 public function testGetModuleNames() {
110 // Use an empty one so that core and extension modules don't get in.
111 $resourceLoader = new EmptyResourceLoader();
112 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
113 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
115 [ 'test.foo', 'test.bar' ],
116 $resourceLoader->getModuleNames()
120 public function provideTestIsFileModule() {
121 $fileModuleObj = $this->getMockBuilder( ResourceLoaderFileModule
::class )
122 ->disableOriginalConstructor()
126 new ResourceLoaderTestModule()
128 'FileModule object' => [ false,
131 'simple empty' => [ true,
134 'simple scripts' => [ true,
135 [ 'scripts' => 'example.js' ]
137 'simple scripts, raw and targets' => [ true, [
138 'scripts' => [ 'a.js', 'b.js' ],
140 'targets' => [ 'desktop', 'mobile' ],
142 'FileModule' => [ true,
143 [ 'class' => ResourceLoaderFileModule
::class, 'scripts' => 'example.js' ]
145 'TestModule' => [ false,
146 [ 'class' => ResourceLoaderTestModule
::class, 'scripts' => 'example.js' ]
148 'SkinModule (FileModule subclass)' => [ true,
149 [ 'class' => ResourceLoaderSkinModule
::class, 'scripts' => 'example.js' ]
151 'JqueryMsgModule (FileModule subclass)' => [ true, [
152 'class' => ResourceLoaderJqueryMsgModule
::class,
153 'scripts' => 'example.js',
155 'WikiModule' => [ false, [
156 'class' => ResourceLoaderWikiModule
::class,
157 'scripts' => [ 'MediaWiki:Example.js' ],
163 * @dataProvider provideTestIsFileModule
164 * @covers ResourceLoader::isFileModule
166 public function testIsFileModule( $expected, $module ) {
167 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
168 $rl->register( 'test', $module );
169 $this->assertSame( $expected, $rl->isFileModule( 'test' ) );
173 * @covers ResourceLoader::isFileModule
175 public function testIsFileModuleUnknown() {
176 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
177 $this->assertSame( false, $rl->isFileModule( 'unknown' ) );
181 * @covers ResourceLoader::isModuleRegistered
183 public function testIsModuleRegistered() {
184 $rl = new EmptyResourceLoader();
185 $rl->register( 'test', new ResourceLoaderTestModule() );
186 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
187 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
191 * @covers ResourceLoader::getModule
193 public function testGetModuleUnknown() {
194 $rl = new EmptyResourceLoader();
195 $this->assertSame( null, $rl->getModule( 'test' ) );
199 * @covers ResourceLoader::getModule
201 public function testGetModuleClass() {
202 $rl = new EmptyResourceLoader();
203 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
204 $this->assertInstanceOf(
205 ResourceLoaderTestModule
::class,
206 $rl->getModule( 'test' )
211 * @covers ResourceLoader::getModule
213 public function testGetModuleFactory() {
214 $factory = function ( array $info ) {
215 $this->assertArrayHasKey( 'kitten', $info );
216 return new ResourceLoaderTestModule( $info );
219 $rl = new EmptyResourceLoader();
220 $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
221 $this->assertInstanceOf(
222 ResourceLoaderTestModule
::class,
223 $rl->getModule( 'test' )
228 * @covers ResourceLoader::getModule
230 public function testGetModuleClassDefault() {
231 $rl = new EmptyResourceLoader();
232 $rl->register( 'test', [] );
233 $this->assertInstanceOf(
234 ResourceLoaderFileModule
::class,
235 $rl->getModule( 'test' ),
236 'Array-style module registrations default to FileModule'
241 * @covers ResourceLoader::getLessCompiler
243 public function testLessImportDirs() {
244 $rl = new EmptyResourceLoader();
245 $lc = $rl->getLessCompiler( [ 'foo' => '2px', 'Foo' => '#eeeeee' ] );
246 $basePath = dirname( dirname( __DIR__
) ) . '/data/less';
247 $lc->SetImportDirs( [
248 "$basePath/common" => '',
250 $css = $lc->parseFile( "$basePath/module/use-import-dir.less" )->getCss();
251 $this->assertStringEqualsFile( "$basePath/module/styles.css", $css );
254 public static function providePackedModules() {
257 'Example from makePackedModulesString doc comment',
258 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
259 'foo.bar,baz|bar.baz,quux',
262 'Example from expandModuleNames doc comment',
263 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
264 'jquery.foo,bar|jquery.ui.baz,quux',
267 'Regression fixed in r87497 (7fee86c38e) with dotless names',
268 [ 'foo', 'bar', 'baz' ],
272 'Prefixless modules after a prefixed module',
273 [ 'single.module', 'foobar', 'foobaz' ],
274 'single.module|foobar,foobaz',
278 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
279 'foo|foo.baz,bar|baz.quux',
280 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
286 * @dataProvider providePackedModules
287 * @covers ResourceLoader::makePackedModulesString
289 public function testMakePackedModulesString( $desc, $modules, $packed ) {
290 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
294 * @dataProvider providePackedModules
295 * @covers ResourceLoaderContext::expandModuleNames
297 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
299 $unpacked ?
: $modules,
300 ResourceLoaderContext
::expandModuleNames( $packed ),
305 public static function provideAddSource() {
307 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
308 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
311 'foowiki' => 'https://example.org/w/load.php',
312 'bazwiki' => 'https://example.com/w/load.php',
315 [ 'foowiki', 'bazwiki' ]
321 * @dataProvider provideAddSource
322 * @covers ResourceLoader::addSource
323 * @covers ResourceLoader::getSources
325 public function testAddSource( $name, $info, $expected ) {
326 $rl = new ResourceLoader
;
327 $rl->addSource( $name, $info );
328 if ( is_array( $expected ) ) {
329 foreach ( $expected as $source ) {
330 $this->assertArrayHasKey( $source, $rl->getSources() );
333 $this->assertArrayHasKey( $expected, $rl->getSources() );
338 * @covers ResourceLoader::addSource
340 public function testAddSourceDupe() {
341 $rl = new ResourceLoader
;
342 $this->setExpectedException(
343 MWException
::class, 'ResourceLoader duplicate source addition error'
345 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
346 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
350 * @covers ResourceLoader::addSource
352 public function testAddSourceInvalid() {
353 $rl = new ResourceLoader
;
354 $this->setExpectedException( MWException
::class, 'with no "loadScript" key' );
355 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
358 public static function provideLoaderImplement() {
361 'title' => 'Implement scripts, styles and messages',
363 'name' => 'test.example',
364 'scripts' => 'mw.example();',
365 'styles' => [ 'css' => [ '.mw-example {}' ] ],
366 'messages' => [ 'example' => '' ],
369 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
380 'title' => 'Implement scripts',
382 'name' => 'test.example',
383 'scripts' => 'mw.example();',
386 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
391 'title' => 'Implement styles',
393 'name' => 'test.example',
395 'styles' => [ 'css' => [ '.mw-example {}' ] ],
397 'expected' => 'mw.loader.implement( "test.example", [], {
404 'title' => 'Implement scripts and messages',
406 'name' => 'test.example',
407 'scripts' => 'mw.example();',
408 'messages' => [ 'example' => '' ],
410 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
417 'title' => 'Implement scripts and templates',
419 'name' => 'test.example',
420 'scripts' => 'mw.example();',
421 'templates' => [ 'example.html' => '' ],
423 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
430 'title' => 'Implement unwrapped user script',
433 'scripts' => 'mw.example( 1 );',
436 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
439 'title' => 'Implement multi-file script',
441 'name' => 'test.multifile',
446 'content' => 'mw.example( 1 );',
450 'content' => [ 'n' => 2 ],
454 'content' => 'mw.example( 3 );'
457 'main' => 'three.js',
461 mw.loader.implement( "test.multifile", {
464 "one.js": function ( require, module ) {
470 "three.js": function ( require, module ) {
481 * @dataProvider provideLoaderImplement
482 * @covers ResourceLoader::makeLoaderImplementScript
483 * @covers ResourceLoader::trimArray
485 public function testMakeLoaderImplementScript( $case ) {
488 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' ), 'packageFiles' => [],
490 ResourceLoader
::clearCache();
491 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
493 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
496 $rl->makeLoaderImplementScript(
498 ( $case['wrap'] && is_string( $case['scripts'] ) )
499 ?
new XmlJsCode( $case['scripts'] )
504 $case['packageFiles']
510 * @covers ResourceLoader::makeLoaderImplementScript
512 public function testMakeLoaderImplementScriptInvalid() {
513 $this->setExpectedException( MWException
::class, 'Invalid scripts error' );
514 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
515 $rl->makeLoaderImplementScript(
521 null // package files
526 * @covers ResourceLoader::makeLoaderRegisterScript
528 public function testMakeLoaderRegisterScript() {
530 'mw.loader.register( [
536 ResourceLoader
::makeLoaderRegisterScript( [
537 [ 'test.name', '1234567' ],
539 'Nested array parameter'
543 'mw.loader.register( [
572 ResourceLoader
::makeLoaderRegisterScript( [
573 [ 'test.foo', '100' , [], null, null ],
574 [ 'test.bar', '200', [ 'test.unknown' ], null ],
575 [ 'test.baz', '300', [ 'test.quux', 'test.foo' ], null ],
576 [ 'test.quux', '400', [], null, null, 'return true;' ],
578 'Compact dependency indexes'
583 * @covers ResourceLoader::makeLoaderSourcesScript
585 public function testMakeLoaderSourcesScript() {
587 'mw.loader.addSource( {
588 "local": "/w/load.php"
590 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
593 'mw.loader.addSource( {
594 "local": "/w/load.php"
596 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
599 'mw.loader.addSource( {
600 "local": "/w/load.php",
601 "example": "https://example.org/w/load.php"
603 ResourceLoader
::makeLoaderSourcesScript( [
604 'local' => '/w/load.php',
605 'example' => 'https://example.org/w/load.php'
609 'mw.loader.addSource( [] );',
610 ResourceLoader
::makeLoaderSourcesScript( [] )
614 private static function fakeSources() {
617 'loadScript' => '//example.org/w/load.php',
618 'apiScript' => '//example.org/w/api.php',
621 'loadScript' => '//example.com/w/load.php',
622 'apiScript' => '//example.com/w/api.php',
628 * @covers ResourceLoader::getLoadScript
630 public function testGetLoadScript() {
631 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
632 $rl = new ResourceLoader();
633 $sources = self
::fakeSources();
634 $rl->addSource( $sources );
635 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
636 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
640 $rl->getLoadScript( 'thiswasneverreigstered' );
641 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
642 } catch ( MWException
$e ) {
643 $this->assertTrue( true );
647 protected function getFailFerryMock( $getter = 'getScript' ) {
648 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
649 ->setMethods( [ $getter ] )
651 $mock->method( $getter )->will( $this->throwException(
652 new Exception( 'Ferry not found' )
657 protected function getSimpleModuleMock( $script = '' ) {
658 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
659 ->setMethods( [ 'getScript' ] )
661 $mock->method( 'getScript' )->willReturn( $script );
665 protected function getSimpleStyleModuleMock( $styles = '' ) {
666 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
667 ->setMethods( [ 'getStyles' ] )
669 $mock->method( 'getStyles' )->willReturn( [ '' => $styles ] );
674 * @covers ResourceLoader::getCombinedVersion
676 public function testGetCombinedVersion() {
677 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
678 // Disable log from outputErrorAndLog
679 ->setMethods( [ 'outputErrorAndLog' ] )->getMock();
681 'foo' => self
::getSimpleModuleMock(),
682 'ferry' => self
::getFailFerryMock(),
683 'bar' => self
::getSimpleModuleMock(),
685 $context = $this->getResourceLoaderContext( [], $rl );
689 $rl->getCombinedVersion( $context, [] ),
694 ResourceLoader
::makeHash( self
::BLANK_VERSION
),
695 $rl->getCombinedVersion( $context, [ 'foo' ] ),
699 // Verify that getCombinedVersion() does not throw when ferry fails.
700 // Instead it gracefully continues to combine the remaining modules.
702 ResourceLoader
::makeHash( self
::BLANK_VERSION
. self
::BLANK_VERSION
),
703 $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
704 'compute foo+ferry+bar (T152266)'
708 public static function provideMakeModuleResponseConcat() {
714 'expected' => "foo()\n" . 'mw.loader.state( {
717 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
718 'message' => 'Script without semi-colon',
725 'expected' => "foo()\nbar()\n" . 'mw.loader.state( {
729 'minified' => "foo()\nbar()\n" . 'mw.loader.state({"foo":"ready","bar":"ready"});',
730 'message' => 'Two scripts without semi-colon',
734 'foo' => "foo()\n// bar();"
736 'expected' => "foo()\n// bar();\n" . 'mw.loader.state( {
739 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
740 'message' => 'Script with semi-colon in comment (T162719)',
744 foreach ( $testcases as $i => $case ) {
751 $ret["#$i (minified)"] = [
762 * Verify how multiple scripts and mw.loader.state() calls are concatenated.
764 * @dataProvider provideMakeModuleResponseConcat
765 * @covers ResourceLoader::makeModuleResponse
767 public function testMakeModuleResponseConcat( $scripts, $expected, $debug, $message = null ) {
768 $rl = new EmptyResourceLoader();
769 $modules = array_map( function ( $script ) {
770 return self
::getSimpleModuleMock( $script );
772 $rl->register( $modules );
774 $this->setMwGlobals( 'wgResourceLoaderDebug', $debug );
775 $context = $this->getResourceLoaderContext(
777 'modules' => implode( '|', array_keys( $modules ) ),
783 $response = $rl->makeModuleResponse( $context, $modules );
784 $this->assertSame( [], $rl->getErrors(), 'Errors' );
785 $this->assertEquals( $expected, $response, $message ?
: 'Response' );
789 * @covers ResourceLoader::makeModuleResponse
791 public function testMakeModuleResponseEmpty() {
792 $rl = new EmptyResourceLoader();
793 $context = $this->getResourceLoaderContext(
794 [ 'modules' => '', 'only' => 'scripts' ],
798 $response = $rl->makeModuleResponse( $context, [] );
799 $this->assertSame( [], $rl->getErrors(), 'Errors' );
800 $this->assertRegExp( '/^\/\*.+no modules were requested.+\*\/$/ms', $response );
804 * Verify that when building module content in a load.php response,
805 * an exception from one module will not break script output from
808 * @covers ResourceLoader::makeModuleResponse
810 public function testMakeModuleResponseError() {
812 'foo' => self
::getSimpleModuleMock( 'foo();' ),
813 'ferry' => self
::getFailFerryMock(),
814 'bar' => self
::getSimpleModuleMock( 'bar();' ),
816 $rl = new EmptyResourceLoader();
817 $rl->register( $modules );
818 $context = $this->getResourceLoaderContext(
820 'modules' => 'foo|ferry|bar',
826 // Disable log from makeModuleResponse via outputErrorAndLog
827 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
829 $response = $rl->makeModuleResponse( $context, $modules );
830 $errors = $rl->getErrors();
832 $this->assertCount( 1, $errors );
833 $this->assertRegExp( '/Ferry not found/', $errors[0] );
835 "foo();\nbar();\n" . 'mw.loader.state( {
845 * Verify that exceptions in PHP for one module will not break others
846 * (stylesheet response).
848 * @covers ResourceLoader::makeModuleResponse
850 public function testMakeModuleResponseErrorCSS() {
852 'foo' => self
::getSimpleStyleModuleMock( '.foo{}' ),
853 'ferry' => self
::getFailFerryMock( 'getStyles' ),
854 'bar' => self
::getSimpleStyleModuleMock( '.bar{}' ),
856 $rl = new EmptyResourceLoader();
857 $rl->register( $modules );
858 $context = $this->getResourceLoaderContext(
860 'modules' => 'foo|ferry|bar',
867 // Disable log from makeModuleResponse via outputErrorAndLog
868 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
870 $response = $rl->makeModuleResponse( $context, $modules );
871 $errors = $rl->getErrors();
873 $this->assertCount( 2, $errors );
874 $this->assertRegExp( '/Ferry not found/', $errors[0] );
875 $this->assertRegExp( '/Problem.+"ferry":\s*"error"/ms', $errors[1] );
883 * Verify that when building the startup module response,
884 * an exception from one module class will not break the entire
885 * startup module response. See T152266.
887 * @covers ResourceLoader::makeModuleResponse
889 public function testMakeModuleResponseStartupError() {
890 $rl = new EmptyResourceLoader();
892 'foo' => self
::getSimpleModuleMock( 'foo();' ),
893 'ferry' => self
::getFailFerryMock(),
894 'bar' => self
::getSimpleModuleMock( 'bar();' ),
895 'startup' => [ 'class' => ResourceLoaderStartUpModule
::class ],
897 $context = $this->getResourceLoaderContext(
899 'modules' => 'startup',
906 [ 'foo', 'ferry', 'bar', 'startup' ],
907 $rl->getModuleNames(),
911 // Disable log from makeModuleResponse via outputErrorAndLog
912 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
914 $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
915 $response = $rl->makeModuleResponse( $context, $modules );
916 $errors = $rl->getErrors();
918 $this->assertRegExp( '/Ferry not found/', $errors[0] );
919 $this->assertCount( 1, $errors );
921 '/isCompatible.*window\.RLQ/s',
923 'startup response undisrupted (T152266)'
926 '/register\([^)]+"ferry",\s*""/s',
928 'startup response registers broken module'
931 '/state\([^)]+"ferry":\s*"error"/s',
933 'startup response sets state to error'
938 * Integration test for modules sending extra HTTP response headers.
940 * @covers ResourceLoaderModule::getHeaders
941 * @covers ResourceLoaderModule::buildContent
942 * @covers ResourceLoader::makeModuleResponse
944 public function testMakeModuleResponseExtraHeaders() {
945 $module = $this->getMockBuilder( ResourceLoaderTestModule
::class )
946 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
947 $module->method( 'getPreloadLinks' )->willReturn( [
948 'https://example.org/script.js' => [ 'as' => 'script' ],
951 $rl = new EmptyResourceLoader();
955 $context = $this->getResourceLoaderContext(
956 [ 'modules' => 'foo', 'only' => 'scripts' ],
960 $modules = [ 'foo' => $rl->getModule( 'foo' ) ];
961 $response = $rl->makeModuleResponse( $context, $modules );
962 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
966 'Link: <https://example.org/script.js>;rel=preload;as=script'
974 * @covers ResourceLoaderModule::getHeaders
975 * @covers ResourceLoaderModule::buildContent
976 * @covers ResourceLoader::makeModuleResponse
978 public function testMakeModuleResponseExtraHeadersMulti() {
979 $foo = $this->getMockBuilder( ResourceLoaderTestModule
::class )
980 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
981 $foo->method( 'getPreloadLinks' )->willReturn( [
982 'https://example.org/script.js' => [ 'as' => 'script' ],
985 $bar = $this->getMockBuilder( ResourceLoaderTestModule
::class )
986 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
987 $bar->method( 'getPreloadLinks' )->willReturn( [
988 '/example.png' => [ 'as' => 'image' ],
989 '/example.jpg' => [ 'as' => 'image' ],
992 $rl = new EmptyResourceLoader();
993 $rl->register( [ 'foo' => $foo, 'bar' => $bar ] );
994 $context = $this->getResourceLoaderContext(
995 [ 'modules' => 'foo|bar', 'only' => 'scripts' ],
999 $modules = [ 'foo' => $rl->getModule( 'foo' ), 'bar' => $rl->getModule( 'bar' ) ];
1000 $response = $rl->makeModuleResponse( $context, $modules );
1001 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
1002 $this->assertEquals(
1004 'Link: <https://example.org/script.js>;rel=preload;as=script',
1005 'Link: </example.png>;rel=preload;as=image,</example.jpg>;rel=preload;as=image'
1013 * @covers ResourceLoader::respond
1015 public function testRespondEmpty() {
1016 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1018 'tryRespondNotModified',
1019 'sendResponseHeaders',
1020 'measureResponseTime',
1023 $context = $this->getResourceLoaderContext( [ 'modules' => '' ], $rl );
1025 $rl->expects( $this->once() )->method( 'measureResponseTime' );
1026 $this->expectOutputRegex( '/no modules were requested/' );
1028 $rl->respond( $context );
1032 * @covers ResourceLoader::respond
1034 public function testRespondSimple() {
1035 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1036 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1038 'measureResponseTime',
1039 'tryRespondNotModified',
1040 'sendResponseHeaders',
1041 'makeModuleResponse',
1044 $rl->register( 'test', $module );
1045 $context = $this->getResourceLoaderContext(
1046 [ 'modules' => 'test', 'only' => null ],
1050 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1051 ->with( $context, [ 'test' => $module ] )
1052 ->willReturn( 'implement_foo;' );
1053 $this->expectOutputRegex( '/^implement_foo;/' );
1055 $rl->respond( $context );
1059 * @covers ResourceLoader::respond
1061 public function testRespondInternalFailures() {
1062 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1063 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1065 'measureResponseTime',
1066 'preloadModuleInfo',
1067 'getCombinedVersion',
1068 'tryRespondNotModified',
1069 'makeModuleResponse',
1070 'sendResponseHeaders',
1073 $rl->register( 'test', $module );
1074 $context = $this->getResourceLoaderContext( [ 'modules' => 'test' ], $rl );
1075 // Disable logging from outputErrorAndLog
1076 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
1078 $rl->expects( $this->once() )->method( 'preloadModuleInfo' )
1079 ->willThrowException( new Exception( 'Preload error' ) );
1080 $rl->expects( $this->once() )->method( 'getCombinedVersion' )
1081 ->willThrowException( new Exception( 'Version error' ) );
1082 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1083 ->with( $context, [ 'test' => $module ] )
1084 ->willReturn( 'foo;' );
1085 // Internal errors should be caught and logged without affecting module output
1086 $this->expectOutputRegex( '/^\/\*.+Preload error.+Version error.+\*\/.*foo;/ms' );
1088 $rl->respond( $context );
1092 * @covers ResourceLoader::measureResponseTime
1094 public function testMeasureResponseTime() {
1095 $stats = $this->getMockBuilder( NullStatsdDataFactory
::class )
1096 ->setMethods( [ 'timing' ] )->getMock();
1097 $this->setService( 'StatsdDataFactory', $stats );
1099 $stats->expects( $this->once() )->method( 'timing' )
1100 ->with( 'resourceloader.responseTime', $this->anything() );
1102 $timing = new Timing();
1103 $timing->mark( 'requestShutdown' );
1104 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader
);
1105 $rl->measureResponseTime( $timing );
1106 DeferredUpdates
::doUpdates();