3 use Wikimedia\TestingAccessWrapper
;
4 use MediaWiki\MediaWikiServices
;
6 class ResourceLoaderTest
extends ResourceLoaderTestCase
{
8 protected function setUp() {
11 $this->setMwGlobals( [
12 'wgShowExceptionDetails' => true,
17 * Ensure the ResourceLoaderRegisterModules hook is called.
20 public function testServiceWiring() {
21 $this->overrideMwServices();
24 $this->setMwGlobals( 'wgHooks', [
25 'ResourceLoaderRegisterModules' => [
26 function ( &$resourceLoader ) use ( &$ranHook ) {
32 MediaWikiServices
::getInstance()->getResourceLoader();
34 $this->assertSame( 1, $ranHook, 'Hook was called' );
38 * @covers ResourceLoader::register
39 * @covers ResourceLoader::getModule
41 public function testRegisterValidObject() {
42 $module = new ResourceLoaderTestModule();
43 $resourceLoader = new EmptyResourceLoader();
44 $resourceLoader->register( 'test', $module );
45 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
49 * @covers ResourceLoader::register
50 * @covers ResourceLoader::getModule
52 public function testRegisterValidArray() {
53 $module = new ResourceLoaderTestModule();
54 $resourceLoader = new EmptyResourceLoader();
55 // Covers case of register() setting $rl->moduleInfos,
56 // but $rl->modules lazy-populated by getModule()
57 $resourceLoader->register( 'test', [ 'object' => $module ] );
58 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
62 * @covers ResourceLoader::register
64 public function testRegisterEmptyString() {
65 $module = new ResourceLoaderTestModule();
66 $resourceLoader = new EmptyResourceLoader();
67 $resourceLoader->register( '', $module );
68 $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
72 * @covers ResourceLoader::register
74 public function testRegisterInvalidName() {
75 $resourceLoader = new EmptyResourceLoader();
76 $this->setExpectedException( MWException
::class, "name 'test!invalid' is invalid" );
77 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
81 * @covers ResourceLoader::register
83 public function testRegisterInvalidType() {
84 $resourceLoader = new EmptyResourceLoader();
85 $this->setExpectedException( MWException
::class, 'ResourceLoader module info type error' );
86 $resourceLoader->register( 'test', new stdClass() );
90 * @covers ResourceLoader::register
92 public function testRegisterDuplicate() {
93 $logger = $this->getMockBuilder( Psr\Log\LoggerInterface
::class )->getMock();
94 $logger->expects( $this->once() )
95 ->method( 'warning' );
96 $resourceLoader = new EmptyResourceLoader( null, $logger );
98 $module1 = new ResourceLoaderTestModule();
99 $module2 = new ResourceLoaderTestModule();
100 $resourceLoader->register( 'test', $module1 );
101 $resourceLoader->register( 'test', $module2 );
102 $this->assertSame( $module2, $resourceLoader->getModule( 'test' ) );
106 * @covers ResourceLoader::getModuleNames
108 public function testGetModuleNames() {
109 // Use an empty one so that core and extension modules don't get in.
110 $resourceLoader = new EmptyResourceLoader();
111 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
112 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
114 [ 'test.foo', 'test.bar' ],
115 $resourceLoader->getModuleNames()
119 public function provideTestIsFileModule() {
120 $fileModuleObj = $this->getMockBuilder( ResourceLoaderFileModule
::class )
121 ->disableOriginalConstructor()
125 new ResourceLoaderTestModule()
127 'FileModule object' => [ false,
130 'simple empty' => [ true,
133 'simple scripts' => [ true,
134 [ 'scripts' => 'example.js' ]
136 'simple scripts, raw and targets' => [ true, [
137 'scripts' => [ 'a.js', 'b.js' ],
139 'targets' => [ 'desktop', 'mobile' ],
141 'FileModule' => [ true,
142 [ 'class' => ResourceLoaderFileModule
::class, 'scripts' => 'example.js' ]
144 'TestModule' => [ false,
145 [ 'class' => ResourceLoaderTestModule
::class, 'scripts' => 'example.js' ]
147 'SkinModule (FileModule subclass)' => [ true,
148 [ 'class' => ResourceLoaderSkinModule
::class, 'scripts' => 'example.js' ]
150 'WikiModule' => [ false, [
151 'class' => ResourceLoaderWikiModule
::class,
152 'scripts' => [ 'MediaWiki:Example.js' ],
158 * @dataProvider provideTestIsFileModule
159 * @covers ResourceLoader::isFileModule
161 public function testIsFileModule( $expected, $module ) {
162 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
163 $rl->register( 'test', $module );
164 $this->assertSame( $expected, $rl->isFileModule( 'test' ) );
168 * @covers ResourceLoader::isFileModule
170 public function testIsFileModuleUnknown() {
171 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
172 $this->assertSame( false, $rl->isFileModule( 'unknown' ) );
176 * @covers ResourceLoader::isModuleRegistered
178 public function testIsModuleRegistered() {
179 $rl = new EmptyResourceLoader();
180 $rl->register( 'test', new ResourceLoaderTestModule() );
181 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
182 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
186 * @covers ResourceLoader::getModule
188 public function testGetModuleUnknown() {
189 $rl = new EmptyResourceLoader();
190 $this->assertSame( null, $rl->getModule( 'test' ) );
194 * @covers ResourceLoader::getModule
196 public function testGetModuleClass() {
197 $rl = new EmptyResourceLoader();
198 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
199 $this->assertInstanceOf(
200 ResourceLoaderTestModule
::class,
201 $rl->getModule( 'test' )
206 * @covers ResourceLoader::getModule
208 public function testGetModuleFactory() {
209 $factory = function ( array $info ) {
210 $this->assertArrayHasKey( 'kitten', $info );
211 return new ResourceLoaderTestModule( $info );
214 $rl = new EmptyResourceLoader();
215 $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
216 $this->assertInstanceOf(
217 ResourceLoaderTestModule
::class,
218 $rl->getModule( 'test' )
223 * @covers ResourceLoader::getModule
225 public function testGetModuleClassDefault() {
226 $rl = new EmptyResourceLoader();
227 $rl->register( 'test', [] );
228 $this->assertInstanceOf(
229 ResourceLoaderFileModule
::class,
230 $rl->getModule( 'test' ),
231 'Array-style module registrations default to FileModule'
236 * @covers ResourceLoader::getLessCompiler
238 public function testLessImportDirs() {
239 $rl = new EmptyResourceLoader();
240 $lc = $rl->getLessCompiler( [ 'foo' => '2px', 'Foo' => '#eeeeee' ] );
241 $basePath = dirname( dirname( __DIR__
) ) . '/data/less';
242 $lc->SetImportDirs( [
243 "$basePath/common" => '',
245 $css = $lc->parseFile( "$basePath/module/use-import-dir.less" )->getCss();
246 $this->assertStringEqualsFile( "$basePath/module/styles.css", $css );
249 public static function providePackedModules() {
252 'Example from makePackedModulesString doc comment',
253 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
254 'foo.bar,baz|bar.baz,quux',
257 'Example from expandModuleNames doc comment',
258 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
259 'jquery.foo,bar|jquery.ui.baz,quux',
262 'Regression fixed in r87497 (7fee86c38e) with dotless names',
263 [ 'foo', 'bar', 'baz' ],
267 'Prefixless modules after a prefixed module',
268 [ 'single.module', 'foobar', 'foobaz' ],
269 'single.module|foobar,foobaz',
273 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
274 'foo|foo.baz,bar|baz.quux',
275 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
281 * @dataProvider providePackedModules
282 * @covers ResourceLoader::makePackedModulesString
284 public function testMakePackedModulesString( $desc, $modules, $packed ) {
285 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
289 * @dataProvider providePackedModules
290 * @covers ResourceLoader::expandModuleNames
292 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
294 $unpacked ?
: $modules,
295 ResourceLoader
::expandModuleNames( $packed ),
300 public static function provideAddSource() {
302 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
303 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
306 'foowiki' => 'https://example.org/w/load.php',
307 'bazwiki' => 'https://example.com/w/load.php',
310 [ 'foowiki', 'bazwiki' ]
316 * @dataProvider provideAddSource
317 * @covers ResourceLoader::addSource
318 * @covers ResourceLoader::getSources
320 public function testAddSource( $name, $info, $expected ) {
321 $rl = new ResourceLoader
;
322 $rl->addSource( $name, $info );
323 if ( is_array( $expected ) ) {
324 foreach ( $expected as $source ) {
325 $this->assertArrayHasKey( $source, $rl->getSources() );
328 $this->assertArrayHasKey( $expected, $rl->getSources() );
333 * @covers ResourceLoader::addSource
335 public function testAddSourceDupe() {
336 $rl = new ResourceLoader
;
337 $this->setExpectedException(
338 MWException
::class, '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
::class, '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 );" );',
434 'title' => 'Implement multi-file script',
436 'name' => 'test.multifile',
441 'content' => 'mw.example( 1 );',
445 'content' => [ 'n' => 2 ],
449 'content' => 'mw.example( 3 );'
452 'main' => 'three.js',
456 mw.loader.implement( "test.multifile", {
459 "one.js": function ( require, module ) {
465 "three.js": function ( require, module ) {
476 * @dataProvider provideLoaderImplement
477 * @covers ResourceLoader::makeLoaderImplementScript
478 * @covers ResourceLoader::trimArray
480 public function testMakeLoaderImplementScript( $case ) {
483 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' ), 'packageFiles' => [],
485 ResourceLoader
::clearCache();
486 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
488 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
491 $rl->makeLoaderImplementScript(
493 ( $case['wrap'] && is_string( $case['scripts'] ) )
494 ?
new XmlJsCode( $case['scripts'] )
499 $case['packageFiles']
505 * @covers ResourceLoader::makeLoaderImplementScript
507 public function testMakeLoaderImplementScriptInvalid() {
508 $this->setExpectedException( MWException
::class, 'Invalid scripts error' );
509 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
510 $rl->makeLoaderImplementScript(
516 null // package files
521 * @covers ResourceLoader::makeLoaderRegisterScript
523 public function testMakeLoaderRegisterScript() {
525 'mw.loader.register( [
531 ResourceLoader
::makeLoaderRegisterScript( [
532 [ 'test.name', '1234567' ],
534 'Nested array parameter'
538 'mw.loader.register( [
567 ResourceLoader
::makeLoaderRegisterScript( [
568 [ 'test.foo', '100' , [], null, null ],
569 [ 'test.bar', '200', [ 'test.unknown' ], null ],
570 [ 'test.baz', '300', [ 'test.quux', 'test.foo' ], null ],
571 [ 'test.quux', '400', [], null, null, 'return true;' ],
573 'Compact dependency indexes'
578 * @covers ResourceLoader::makeLoaderSourcesScript
580 public function testMakeLoaderSourcesScript() {
582 'mw.loader.addSource( {
583 "local": "/w/load.php"
585 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
588 'mw.loader.addSource( {
589 "local": "/w/load.php"
591 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
594 'mw.loader.addSource( {
595 "local": "/w/load.php",
596 "example": "https://example.org/w/load.php"
598 ResourceLoader
::makeLoaderSourcesScript( [
599 'local' => '/w/load.php',
600 'example' => 'https://example.org/w/load.php'
604 'mw.loader.addSource( [] );',
605 ResourceLoader
::makeLoaderSourcesScript( [] )
609 private static function fakeSources() {
612 'loadScript' => '//example.org/w/load.php',
613 'apiScript' => '//example.org/w/api.php',
616 'loadScript' => '//example.com/w/load.php',
617 'apiScript' => '//example.com/w/api.php',
623 * @covers ResourceLoader::getLoadScript
625 public function testGetLoadScript() {
626 $rl = new ResourceLoader();
627 $sources = self
::fakeSources();
628 $rl->addSource( $sources );
629 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
630 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
634 $rl->getLoadScript( 'thiswasneverreigstered' );
635 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
636 } catch ( MWException
$e ) {
637 $this->assertTrue( true );
641 protected function getFailFerryMock( $getter = 'getScript' ) {
642 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
643 ->setMethods( [ $getter ] )
645 $mock->method( $getter )->will( $this->throwException(
646 new Exception( 'Ferry not found' )
651 protected function getSimpleModuleMock( $script = '' ) {
652 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
653 ->setMethods( [ 'getScript' ] )
655 $mock->method( 'getScript' )->willReturn( $script );
659 protected function getSimpleStyleModuleMock( $styles = '' ) {
660 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
661 ->setMethods( [ 'getStyles' ] )
663 $mock->method( 'getStyles' )->willReturn( [ '' => $styles ] );
668 * @covers ResourceLoader::getCombinedVersion
670 public function testGetCombinedVersion() {
671 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
672 // Disable log from outputErrorAndLog
673 ->setMethods( [ 'outputErrorAndLog' ] )->getMock();
675 'foo' => self
::getSimpleModuleMock(),
676 'ferry' => self
::getFailFerryMock(),
677 'bar' => self
::getSimpleModuleMock(),
679 $context = $this->getResourceLoaderContext( [], $rl );
683 $rl->getCombinedVersion( $context, [] ),
688 ResourceLoader
::makeHash( self
::BLANK_VERSION
),
689 $rl->getCombinedVersion( $context, [ 'foo' ] ),
693 // Verify that getCombinedVersion() does not throw when ferry fails.
694 // Instead it gracefully continues to combine the remaining modules.
696 ResourceLoader
::makeHash( self
::BLANK_VERSION
. self
::BLANK_VERSION
),
697 $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
698 'compute foo+ferry+bar (T152266)'
702 public static function provideMakeModuleResponseConcat() {
708 'expected' => "foo()\n" . 'mw.loader.state( {
711 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
712 'message' => 'Script without semi-colon',
719 'expected' => "foo()\nbar()\n" . 'mw.loader.state( {
723 'minified' => "foo()\nbar()\n" . 'mw.loader.state({"foo":"ready","bar":"ready"});',
724 'message' => 'Two scripts without semi-colon',
728 'foo' => "foo()\n// bar();"
730 'expected' => "foo()\n// bar();\n" . 'mw.loader.state( {
733 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
734 'message' => 'Script with semi-colon in comment (T162719)',
738 foreach ( $testcases as $i => $case ) {
745 $ret["#$i (minified)"] = [
756 * Verify how multiple scripts and mw.loader.state() calls are concatenated.
758 * @dataProvider provideMakeModuleResponseConcat
759 * @covers ResourceLoader::makeModuleResponse
761 public function testMakeModuleResponseConcat( $scripts, $expected, $debug, $message = null ) {
762 $rl = new EmptyResourceLoader();
763 $modules = array_map( function ( $script ) {
764 return self
::getSimpleModuleMock( $script );
766 $rl->register( $modules );
768 $context = $this->getResourceLoaderContext(
770 'modules' => implode( '|', array_keys( $modules ) ),
772 'debug' => $debug ?
'true' : 'false',
777 $response = $rl->makeModuleResponse( $context, $modules );
778 $this->assertSame( [], $rl->getErrors(), 'Errors' );
779 $this->assertEquals( $expected, $response, $message ?
: 'Response' );
783 * @covers ResourceLoader::makeModuleResponse
785 public function testMakeModuleResponseEmpty() {
786 $rl = new EmptyResourceLoader();
787 $context = $this->getResourceLoaderContext(
788 [ 'modules' => '', 'only' => 'scripts' ],
792 $response = $rl->makeModuleResponse( $context, [] );
793 $this->assertSame( [], $rl->getErrors(), 'Errors' );
794 $this->assertRegExp( '/^\/\*.+no modules were requested.+\*\/$/ms', $response );
798 * Verify that when building module content in a load.php response,
799 * an exception from one module will not break script output from
802 * @covers ResourceLoader::makeModuleResponse
804 public function testMakeModuleResponseError() {
806 'foo' => self
::getSimpleModuleMock( 'foo();' ),
807 'ferry' => self
::getFailFerryMock(),
808 'bar' => self
::getSimpleModuleMock( 'bar();' ),
810 $rl = new EmptyResourceLoader();
811 $rl->register( $modules );
812 $context = $this->getResourceLoaderContext(
814 'modules' => 'foo|ferry|bar',
820 // Disable log from makeModuleResponse via outputErrorAndLog
821 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
823 $response = $rl->makeModuleResponse( $context, $modules );
824 $errors = $rl->getErrors();
826 $this->assertCount( 1, $errors );
827 $this->assertRegExp( '/Ferry not found/', $errors[0] );
829 "foo();\nbar();\n" . 'mw.loader.state( {
839 * Verify that exceptions in PHP for one module will not break others
840 * (stylesheet response).
842 * @covers ResourceLoader::makeModuleResponse
844 public function testMakeModuleResponseErrorCSS() {
846 'foo' => self
::getSimpleStyleModuleMock( '.foo{}' ),
847 'ferry' => self
::getFailFerryMock( 'getStyles' ),
848 'bar' => self
::getSimpleStyleModuleMock( '.bar{}' ),
850 $rl = new EmptyResourceLoader();
851 $rl->register( $modules );
852 $context = $this->getResourceLoaderContext(
854 'modules' => 'foo|ferry|bar',
861 // Disable log from makeModuleResponse via outputErrorAndLog
862 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
864 $response = $rl->makeModuleResponse( $context, $modules );
865 $errors = $rl->getErrors();
867 $this->assertCount( 2, $errors );
868 $this->assertRegExp( '/Ferry not found/', $errors[0] );
869 $this->assertRegExp( '/Problem.+"ferry":\s*"error"/ms', $errors[1] );
877 * Verify that when building the startup module response,
878 * an exception from one module class will not break the entire
879 * startup module response. See T152266.
881 * @covers ResourceLoader::makeModuleResponse
883 public function testMakeModuleResponseStartupError() {
884 $rl = new EmptyResourceLoader();
886 'foo' => self
::getSimpleModuleMock( 'foo();' ),
887 'ferry' => self
::getFailFerryMock(),
888 'bar' => self
::getSimpleModuleMock( 'bar();' ),
889 'startup' => [ 'class' => ResourceLoaderStartUpModule
::class ],
891 $context = $this->getResourceLoaderContext(
893 'modules' => 'startup',
900 [ 'foo', 'ferry', 'bar', 'startup' ],
901 $rl->getModuleNames(),
905 // Disable log from makeModuleResponse via outputErrorAndLog
906 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
908 $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
909 $response = $rl->makeModuleResponse( $context, $modules );
910 $errors = $rl->getErrors();
912 $this->assertRegExp( '/Ferry not found/', $errors[0] );
913 $this->assertCount( 1, $errors );
915 '/isCompatible.*window\.RLQ/s',
917 'startup response undisrupted (T152266)'
920 '/register\([^)]+"ferry",\s*""/s',
922 'startup response registers broken module'
925 '/state\([^)]+"ferry":\s*"error"/s',
927 'startup response sets state to error'
932 * Integration test for modules sending extra HTTP response headers.
934 * @covers ResourceLoaderModule::getHeaders
935 * @covers ResourceLoaderModule::buildContent
936 * @covers ResourceLoader::makeModuleResponse
938 public function testMakeModuleResponseExtraHeaders() {
939 $module = $this->getMockBuilder( ResourceLoaderTestModule
::class )
940 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
941 $module->method( 'getPreloadLinks' )->willReturn( [
942 'https://example.org/script.js' => [ 'as' => 'script' ],
945 $rl = new EmptyResourceLoader();
949 $context = $this->getResourceLoaderContext(
950 [ 'modules' => 'foo', 'only' => 'scripts' ],
954 $modules = [ 'foo' => $rl->getModule( 'foo' ) ];
955 $response = $rl->makeModuleResponse( $context, $modules );
956 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
960 'Link: <https://example.org/script.js>;rel=preload;as=script'
968 * @covers ResourceLoaderModule::getHeaders
969 * @covers ResourceLoaderModule::buildContent
970 * @covers ResourceLoader::makeModuleResponse
972 public function testMakeModuleResponseExtraHeadersMulti() {
973 $foo = $this->getMockBuilder( ResourceLoaderTestModule
::class )
974 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
975 $foo->method( 'getPreloadLinks' )->willReturn( [
976 'https://example.org/script.js' => [ 'as' => 'script' ],
979 $bar = $this->getMockBuilder( ResourceLoaderTestModule
::class )
980 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
981 $bar->method( 'getPreloadLinks' )->willReturn( [
982 '/example.png' => [ 'as' => 'image' ],
983 '/example.jpg' => [ 'as' => 'image' ],
986 $rl = new EmptyResourceLoader();
987 $rl->register( [ 'foo' => $foo, 'bar' => $bar ] );
988 $context = $this->getResourceLoaderContext(
989 [ 'modules' => 'foo|bar', 'only' => 'scripts' ],
993 $modules = [ 'foo' => $rl->getModule( 'foo' ), 'bar' => $rl->getModule( 'bar' ) ];
994 $response = $rl->makeModuleResponse( $context, $modules );
995 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
998 'Link: <https://example.org/script.js>;rel=preload;as=script',
999 'Link: </example.png>;rel=preload;as=image,</example.jpg>;rel=preload;as=image'
1007 * @covers ResourceLoader::respond
1009 public function testRespondEmpty() {
1010 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1012 'tryRespondNotModified',
1013 'sendResponseHeaders',
1014 'measureResponseTime',
1017 $context = $this->getResourceLoaderContext( [ 'modules' => '' ], $rl );
1019 $rl->expects( $this->once() )->method( 'measureResponseTime' );
1020 $this->expectOutputRegex( '/no modules were requested/' );
1022 $rl->respond( $context );
1026 * @covers ResourceLoader::respond
1028 public function testRespondSimple() {
1029 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1030 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1032 'measureResponseTime',
1033 'tryRespondNotModified',
1034 'sendResponseHeaders',
1035 'makeModuleResponse',
1038 $rl->register( 'test', $module );
1039 $context = $this->getResourceLoaderContext(
1040 [ 'modules' => 'test', 'only' => null ],
1044 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1045 ->with( $context, [ 'test' => $module ] )
1046 ->willReturn( 'implement_foo;' );
1047 $this->expectOutputRegex( '/^implement_foo;/' );
1049 $rl->respond( $context );
1053 * @covers ResourceLoader::respond
1055 public function testRespondInternalFailures() {
1056 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1057 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1059 'measureResponseTime',
1060 'preloadModuleInfo',
1061 'getCombinedVersion',
1062 'tryRespondNotModified',
1063 'makeModuleResponse',
1064 'sendResponseHeaders',
1067 $rl->register( 'test', $module );
1068 $context = $this->getResourceLoaderContext( [ 'modules' => 'test' ], $rl );
1069 // Disable logging from outputErrorAndLog
1070 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
1072 $rl->expects( $this->once() )->method( 'preloadModuleInfo' )
1073 ->willThrowException( new Exception( 'Preload error' ) );
1074 $rl->expects( $this->once() )->method( 'getCombinedVersion' )
1075 ->willThrowException( new Exception( 'Version error' ) );
1076 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1077 ->with( $context, [ 'test' => $module ] )
1078 ->willReturn( 'foo;' );
1079 // Internal errors should be caught and logged without affecting module output
1080 $this->expectOutputRegex( '/^\/\*.+Preload error.+Version error.+\*\/.*foo;/ms' );
1082 $rl->respond( $context );
1086 * @covers ResourceLoader::measureResponseTime
1088 public function testMeasureResponseTime() {
1089 $stats = $this->getMockBuilder( NullStatsdDataFactory
::class )
1090 ->setMethods( [ 'timing' ] )->getMock();
1091 $this->setService( 'StatsdDataFactory', $stats );
1093 $stats->expects( $this->once() )->method( 'timing' )
1094 ->with( 'resourceloader.responseTime', $this->anything() );
1096 $timing = new Timing();
1097 $timing->mark( 'requestShutdown' );
1098 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader
);
1099 $rl->measureResponseTime( $timing );
1100 DeferredUpdates
::doUpdates();