MediaWiki  1.30.0
ResourceLoaderTest.php
Go to the documentation of this file.
1 <?php
2 
3 use Wikimedia\TestingAccessWrapper;
4 
6 
7  protected function setUp() {
8  parent::setUp();
9 
10  $this->setMwGlobals( [
11  'wgResourceLoaderLESSImportPaths' => [
12  dirname( dirname( __DIR__ ) ) . '/data/less/common',
13  ],
14  'wgResourceLoaderLESSVars' => [
15  'foo' => '2px',
16  'Foo' => '#eeeeee',
17  'bar' => 5,
18  ],
19  // Clear ResourceLoaderGetConfigVars hooks (called by StartupModule)
20  // to avoid notices during testMakeModuleResponse for missing
21  // wgResourceLoaderLESSVars keys in extension hooks.
22  'wgHooks' => [],
23  'wgShowExceptionDetails' => true,
24  ] );
25  }
26 
32  public function testConstructRegistrationHook() {
33  $resourceLoaderRegisterModulesHook = false;
34 
35  $this->setMwGlobals( 'wgHooks', [
36  'ResourceLoaderRegisterModules' => [
37  function ( &$resourceLoader ) use ( &$resourceLoaderRegisterModulesHook ) {
38  $resourceLoaderRegisterModulesHook = true;
39  }
40  ]
41  ] );
42 
43  $unused = new ResourceLoader();
44  $this->assertTrue(
45  $resourceLoaderRegisterModulesHook,
46  'Hook ResourceLoaderRegisterModules called'
47  );
48  }
49 
54  public function testRegisterValidObject() {
55  $module = new ResourceLoaderTestModule();
57  $resourceLoader->register( 'test', $module );
58  $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
59  }
60 
65  public function testRegisterValidArray() {
66  $module = new ResourceLoaderTestModule();
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' ) );
72  }
73 
77  public function testRegisterEmptyString() {
78  $module = new ResourceLoaderTestModule();
80  $resourceLoader->register( '', $module );
81  $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
82  }
83 
87  public function testRegisterInvalidName() {
89  $this->setExpectedException( 'MWException', "name 'test!invalid' is invalid" );
90  $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
91  }
92 
96  public function testRegisterInvalidType() {
98  $this->setExpectedException( 'MWException', 'ResourceLoader module info type error' );
99  $resourceLoader->register( 'test', new stdClass() );
100  }
101 
105  public function testGetModuleNames() {
106  // Use an empty one so that core and extension modules don't get in.
108  $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
109  $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
110  $this->assertEquals(
111  [ 'test.foo', 'test.bar' ],
112  $resourceLoader->getModuleNames()
113  );
114  }
115 
116  public function provideTestIsFileModule() {
117  $fileModuleObj = $this->getMockBuilder( ResourceLoaderFileModule::class )
118  ->disableOriginalConstructor()
119  ->getMock();
120  return [
121  'object' => [ false,
123  ],
124  'FileModule object' => [ false,
125  $fileModuleObj
126  ],
127  'simple empty' => [ true,
128  []
129  ],
130  'simple scripts' => [ true,
131  [ 'scripts' => 'example.js' ]
132  ],
133  'simple scripts, raw and targets' => [ true, [
134  'scripts' => [ 'a.js', 'b.js' ],
135  'raw' => true,
136  'targets' => [ 'desktop', 'mobile' ],
137  ] ],
138  'FileModule' => [ true,
139  [ 'class' => ResourceLoaderFileModule::class, 'scripts' => 'example.js' ]
140  ],
141  'TestModule' => [ false,
142  [ 'class' => ResourceLoaderTestModule::class, 'scripts' => 'example.js' ]
143  ],
144  'SkinModule (FileModule subclass)' => [ true,
145  [ 'class' => ResourceLoaderSkinModule::class, 'scripts' => 'example.js' ]
146  ],
147  'JqueryMsgModule (FileModule subclass)' => [ true, [
149  'scripts' => 'example.js',
150  ] ],
151  'WikiModule' => [ false, [
153  'scripts' => [ 'MediaWiki:Example.js' ],
154  ] ],
155  ];
156  }
157 
162  public function testIsFileModule( $expected, $module ) {
163  $rl = TestingAccessWrapper::newFromObject( new EmptyResourceLoader() );
164  $rl->register( 'test', $module );
165  $this->assertSame( $expected, $rl->isFileModule( 'test' ) );
166  }
167 
171  public function testIsFileModuleUnknown() {
172  $rl = TestingAccessWrapper::newFromObject( new EmptyResourceLoader() );
173  $this->assertSame( false, $rl->isFileModule( 'unknown' ) );
174  }
175 
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' ) );
184  }
185 
189  public function testGetModuleUnknown() {
190  $rl = new EmptyResourceLoader();
191  $this->assertSame( null, $rl->getModule( 'test' ) );
192  }
193 
197  public function testGetModuleClass() {
198  $rl = new EmptyResourceLoader();
199  $rl->register( 'test', [ 'class' => ResourceLoaderTestModule::class ] );
200  $this->assertInstanceOf(
202  $rl->getModule( 'test' )
203  );
204  }
205 
209  public function testGetModuleFactory() {
210  $factory = function ( array $info ) {
211  $this->assertArrayHasKey( 'kitten', $info );
212  return new ResourceLoaderTestModule( $info );
213  };
214 
215  $rl = new EmptyResourceLoader();
216  $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
217  $this->assertInstanceOf(
219  $rl->getModule( 'test' )
220  );
221  }
222 
226  public function testGetModuleClassDefault() {
227  $rl = new EmptyResourceLoader();
228  $rl->register( 'test', [] );
229  $this->assertInstanceOf(
231  $rl->getModule( 'test' ),
232  'Array-style module registrations default to FileModule'
233  );
234  }
235 
239  public function testLessFileCompilation() {
241  $basePath = __DIR__ . '/../../data/less/module';
242  $module = new ResourceLoaderFileModule( [
243  'localBasePath' => $basePath,
244  'styles' => [ 'styles.less' ],
245  ] );
246  $module->setName( 'test.less' );
247  $styles = $module->getStyles( $context );
248  $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
249  }
250 
251  public static function providePackedModules() {
252  return [
253  [
254  'Example from makePackedModulesString doc comment',
255  [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
256  'foo.bar,baz|bar.baz,quux',
257  ],
258  [
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',
262  ],
263  [
264  'Regression fixed in r88706 with dotless names',
265  [ 'foo', 'bar', 'baz' ],
266  'foo,bar,baz',
267  ],
268  [
269  'Prefixless modules after a prefixed module',
270  [ 'single.module', 'foobar', 'foobaz' ],
271  'single.module|foobar,foobaz',
272  ],
273  [
274  'Ordering',
275  [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
276  'foo|foo.baz,bar|baz.quux',
277  [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
278  ]
279  ];
280  }
281 
286  public function testMakePackedModulesString( $desc, $modules, $packed ) {
287  $this->assertEquals( $packed, ResourceLoader::makePackedModulesString( $modules ), $desc );
288  }
289 
294  public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
295  $this->assertEquals(
296  $unpacked ?: $modules,
298  $desc
299  );
300  }
301 
302  public static function provideAddSource() {
303  return [
304  [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
305  [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
306  [
307  [
308  'foowiki' => 'https://example.org/w/load.php',
309  'bazwiki' => 'https://example.com/w/load.php',
310  ],
311  null,
312  [ 'foowiki', 'bazwiki' ]
313  ]
314  ];
315  }
316 
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() );
328  }
329  } else {
330  $this->assertArrayHasKey( $expected, $rl->getSources() );
331  }
332  }
333 
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' );
342  }
343 
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' ] );
351  }
352 
353  public static function provideLoaderImplement() {
354  return [
355  [ [
356  'title' => 'Implement scripts, styles and messages',
357 
358  'name' => 'test.example',
359  'scripts' => 'mw.example();',
360  'styles' => [ 'css' => [ '.mw-example {}' ] ],
361  'messages' => [ 'example' => '' ],
362  'templates' => [],
363 
364  'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
365 mw.example();
366 }, {
367  "css": [
368  ".mw-example {}"
369  ]
370 }, {
371  "example": ""
372 } );',
373  ] ],
374  [ [
375  'title' => 'Implement scripts',
376 
377  'name' => 'test.example',
378  'scripts' => 'mw.example();',
379  'styles' => [],
380 
381  'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
382 mw.example();
383 } );',
384  ] ],
385  [ [
386  'title' => 'Implement styles',
387 
388  'name' => 'test.example',
389  'scripts' => [],
390  'styles' => [ 'css' => [ '.mw-example {}' ] ],
391 
392  'expected' => 'mw.loader.implement( "test.example", [], {
393  "css": [
394  ".mw-example {}"
395  ]
396 } );',
397  ] ],
398  [ [
399  'title' => 'Implement scripts and messages',
400 
401  'name' => 'test.example',
402  'scripts' => 'mw.example();',
403  'messages' => [ 'example' => '' ],
404 
405  'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
406 mw.example();
407 }, {}, {
408  "example": ""
409 } );',
410  ] ],
411  [ [
412  'title' => 'Implement scripts and templates',
413 
414  'name' => 'test.example',
415  'scripts' => 'mw.example();',
416  'templates' => [ 'example.html' => '' ],
417 
418  'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
419 mw.example();
420 }, {}, {}, {
421  "example.html": ""
422 } );',
423  ] ],
424  [ [
425  'title' => 'Implement unwrapped user script',
426 
427  'name' => 'user',
428  'scripts' => 'mw.example( 1 );',
429  'wrap' => false,
430 
431  'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
432  ] ],
433  ];
434  }
435 
441  public function testMakeLoaderImplementScript( $case ) {
442  $case += [
443  'wrap' => true,
444  'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' )
445  ];
446  ResourceLoader::clearCache();
447  $this->setMwGlobals( 'wgResourceLoaderDebug', true );
448 
449  $rl = TestingAccessWrapper::newFromClass( 'ResourceLoader' );
450  $this->assertEquals(
451  $case['expected'],
452  $rl->makeLoaderImplementScript(
453  $case['name'],
454  ( $case['wrap'] && is_string( $case['scripts'] ) )
455  ? new XmlJsCode( $case['scripts'] )
456  : $case['scripts'],
457  $case['styles'],
458  $case['messages'],
459  $case['templates']
460  )
461  );
462  }
463 
468  $this->setExpectedException( 'MWException', 'Invalid scripts error' );
469  $rl = TestingAccessWrapper::newFromClass( 'ResourceLoader' );
470  $rl->makeLoaderImplementScript(
471  'test', // name
472  123, // scripts
473  null, // styles
474  null, // messages
475  null // templates
476  );
477  }
478 
482  public function testMakeLoaderRegisterScript() {
483  $this->assertEquals(
484  'mw.loader.register( [
485  [
486  "test.name",
487  "1234567"
488  ]
489 ] );',
490  ResourceLoader::makeLoaderRegisterScript( [
491  [ 'test.name', '1234567' ],
492  ] ),
493  'Nested array parameter'
494  );
495 
496  $this->assertEquals(
497  'mw.loader.register( "test.name", "1234567" );',
498  ResourceLoader::makeLoaderRegisterScript(
499  'test.name',
500  '1234567'
501  ),
502  'Variadic parameters'
503  );
504  }
505 
509  public function testMakeLoaderSourcesScript() {
510  $this->assertEquals(
511  'mw.loader.addSource( "local", "/w/load.php" );',
512  ResourceLoader::makeLoaderSourcesScript( 'local', '/w/load.php' )
513  );
514  $this->assertEquals(
515  'mw.loader.addSource( {
516  "local": "/w/load.php"
517 } );',
518  ResourceLoader::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
519  );
520  $this->assertEquals(
521  'mw.loader.addSource( {
522  "local": "/w/load.php",
523  "example": "https://example.org/w/load.php"
524 } );',
525  ResourceLoader::makeLoaderSourcesScript( [
526  'local' => '/w/load.php',
527  'example' => 'https://example.org/w/load.php'
528  ] )
529  );
530  $this->assertEquals(
531  'mw.loader.addSource( [] );',
532  ResourceLoader::makeLoaderSourcesScript( [] )
533  );
534  }
535 
536  private static function fakeSources() {
537  return [
538  'examplewiki' => [
539  'loadScript' => '//example.org/w/load.php',
540  'apiScript' => '//example.org/w/api.php',
541  ],
542  'example2wiki' => [
543  'loadScript' => '//example.com/w/load.php',
544  'apiScript' => '//example.com/w/api.php',
545  ],
546  ];
547  }
548 
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'] );
559  }
560 
561  try {
562  $rl->getLoadScript( 'thiswasneverreigstered' );
563  $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
564  } catch ( MWException $e ) {
565  $this->assertTrue( true );
566  }
567  }
568 
569  protected function getFailFerryMock() {
570  $mock = $this->getMockBuilder( ResourceLoaderTestModule::class )
571  ->setMethods( [ 'getScript' ] )
572  ->getMock();
573  $mock->method( 'getScript' )->will( $this->throwException(
574  new Exception( 'Ferry not found' )
575  ) );
576  return $mock;
577  }
578 
579  protected function getSimpleModuleMock( $script = '' ) {
580  $mock = $this->getMockBuilder( ResourceLoaderTestModule::class )
581  ->setMethods( [ 'getScript' ] )
582  ->getMock();
583  $mock->method( 'getScript' )->willReturn( $script );
584  return $mock;
585  }
586 
590  public function testGetCombinedVersion() {
591  $rl = $this->getMockBuilder( EmptyResourceLoader::class )
592  // Disable log from outputErrorAndLog
593  ->setMethods( [ 'outputErrorAndLog' ] )->getMock();
594  $rl->register( [
595  'foo' => self::getSimpleModuleMock(),
596  'ferry' => self::getFailFerryMock(),
597  'bar' => self::getSimpleModuleMock(),
598  ] );
599  $context = $this->getResourceLoaderContext( [], $rl );
600 
601  $this->assertEquals(
602  '',
603  $rl->getCombinedVersion( $context, [] ),
604  'empty list'
605  );
606 
607  $this->assertEquals(
608  ResourceLoader::makeHash( self::BLANK_VERSION ),
609  $rl->getCombinedVersion( $context, [ 'foo' ] ),
610  'compute foo'
611  );
612 
613  // Verify that getCombinedVersion() does not throw when ferry fails.
614  // Instead it gracefully continues to combine the remaining modules.
615  $this->assertEquals(
616  ResourceLoader::makeHash( self::BLANK_VERSION . self::BLANK_VERSION ),
617  $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
618  'compute foo+ferry+bar (T152266)'
619  );
620  }
621 
622  public static function provideMakeModuleResponseConcat() {
623  $testcases = [
624  [
625  'modules' => [
626  'foo' => 'foo()',
627  ],
628  'expected' => "foo()\n" . 'mw.loader.state( {
629  "foo": "ready"
630 } );',
631  'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
632  'message' => 'Script without semi-colon',
633  ],
634  [
635  'modules' => [
636  'foo' => 'foo()',
637  'bar' => 'bar()',
638  ],
639  'expected' => "foo()\nbar()\n" . 'mw.loader.state( {
640  "foo": "ready",
641  "bar": "ready"
642 } );',
643  'minified' => "foo()\nbar()\n" . 'mw.loader.state({"foo":"ready","bar":"ready"});',
644  'message' => 'Two scripts without semi-colon',
645  ],
646  [
647  'modules' => [
648  'foo' => "foo()\n// bar();"
649  ],
650  'expected' => "foo()\n// bar();\n" . 'mw.loader.state( {
651  "foo": "ready"
652 } );',
653  'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
654  'message' => 'Script with semi-colon in comment (T162719)',
655  ],
656  ];
657  $ret = [];
658  foreach ( $testcases as $i => $case ) {
659  $ret["#$i"] = [
660  $case['modules'],
661  $case['expected'],
662  true, // debug
663  $case['message'],
664  ];
665  $ret["#$i (minified)"] = [
666  $case['modules'],
667  $case['minified'],
668  false, // debug
669  $case['message'],
670  ];
671  }
672  return $ret;
673  }
674 
681  public function testMakeModuleResponseConcat( $scripts, $expected, $debug, $message = null ) {
682  $rl = new EmptyResourceLoader();
683  $modules = array_map( function ( $script ) {
684  return self::getSimpleModuleMock( $script );
685  }, $scripts );
686  $rl->register( $modules );
687 
688  $this->setMwGlobals( 'wgResourceLoaderDebug', $debug );
690  [
691  'modules' => implode( '|', array_keys( $modules ) ),
692  'only' => 'scripts',
693  ],
694  $rl
695  );
696 
697  $response = $rl->makeModuleResponse( $context, $modules );
698  $this->assertSame( [], $rl->getErrors(), 'Errors' );
699  $this->assertEquals( $expected, $response, $message ?: 'Response' );
700  }
701 
709  public function testMakeModuleResponseError() {
710  $modules = [
711  'foo' => self::getSimpleModuleMock( 'foo();' ),
712  'ferry' => self::getFailFerryMock(),
713  'bar' => self::getSimpleModuleMock( 'bar();' ),
714  ];
715  $rl = new EmptyResourceLoader();
716  $rl->register( $modules );
718  [
719  'modules' => 'foo|ferry|bar',
720  'only' => 'scripts',
721  ],
722  $rl
723  );
724 
725  // Disable log from makeModuleResponse via outputErrorAndLog
726  $this->setLogger( 'exception', new Psr\Log\NullLogger() );
727 
728  $response = $rl->makeModuleResponse( $context, $modules );
729  $errors = $rl->getErrors();
730 
731  $this->assertCount( 1, $errors );
732  $this->assertRegExp( '/Ferry not found/', $errors[0] );
733  $this->assertEquals(
734  "foo();\nbar();\n" . 'mw.loader.state( {
735  "ferry": "error",
736  "foo": "ready",
737  "bar": "ready"
738 } );',
739  $response
740  );
741  }
742 
751  $rl = new EmptyResourceLoader();
752  $rl->register( [
753  'foo' => self::getSimpleModuleMock( 'foo();' ),
754  'ferry' => self::getFailFerryMock(),
755  'bar' => self::getSimpleModuleMock( 'bar();' ),
756  'startup' => [ 'class' => 'ResourceLoaderStartUpModule' ],
757  ] );
759  [
760  'modules' => 'startup',
761  'only' => 'scripts',
762  ],
763  $rl
764  );
765 
766  $this->assertEquals(
767  [ 'foo', 'ferry', 'bar', 'startup' ],
768  $rl->getModuleNames(),
769  'getModuleNames'
770  );
771 
772  // Disable log from makeModuleResponse via outputErrorAndLog
773  $this->setLogger( 'exception', new Psr\Log\NullLogger() );
774 
775  $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
776  $response = $rl->makeModuleResponse( $context, $modules );
777  $errors = $rl->getErrors();
778 
779  $this->assertRegExp( '/Ferry not found/', $errors[0] );
780  $this->assertCount( 1, $errors );
781  $this->assertRegExp(
782  '/isCompatible.*function startUp/s',
783  $response,
784  'startup response undisrupted (T152266)'
785  );
786  $this->assertRegExp(
787  '/register\([^)]+"ferry",\s*""/s',
788  $response,
789  'startup response registers broken module'
790  );
791  $this->assertRegExp(
792  '/state\([^)]+"ferry":\s*"error"/s',
793  $response,
794  'startup response sets state to error'
795  );
796  }
797 
806  $module = $this->getMockBuilder( ResourceLoaderTestModule::class )
807  ->setMethods( [ 'getPreloadLinks' ] )->getMock();
808  $module->method( 'getPreloadLinks' )->willReturn( [
809  'https://example.org/script.js' => [ 'as' => 'script' ],
810  ] );
811 
812  $rl = new EmptyResourceLoader();
813  $rl->register( [
814  'foo' => $module,
815  ] );
817  [ 'modules' => 'foo', 'only' => 'scripts' ],
818  $rl
819  );
820 
821  $modules = [ 'foo' => $rl->getModule( 'foo' ) ];
822  $response = $rl->makeModuleResponse( $context, $modules );
823  $extraHeaders = TestingAccessWrapper::newFromObject( $rl )->extraHeaders;
824 
825  $this->assertEquals(
826  [
827  'Link: <https://example.org/script.js>;rel=preload;as=script'
828  ],
829  $extraHeaders,
830  'Extra headers'
831  );
832  }
833 
840  $foo = $this->getMockBuilder( ResourceLoaderTestModule::class )
841  ->setMethods( [ 'getPreloadLinks' ] )->getMock();
842  $foo->method( 'getPreloadLinks' )->willReturn( [
843  'https://example.org/script.js' => [ 'as' => 'script' ],
844  ] );
845 
846  $bar = $this->getMockBuilder( ResourceLoaderTestModule::class )
847  ->setMethods( [ 'getPreloadLinks' ] )->getMock();
848  $bar->method( 'getPreloadLinks' )->willReturn( [
849  '/example.png' => [ 'as' => 'image' ],
850  '/example.jpg' => [ 'as' => 'image' ],
851  ] );
852 
853  $rl = new EmptyResourceLoader();
854  $rl->register( [ 'foo' => $foo, 'bar' => $bar ] );
856  [ 'modules' => 'foo|bar', 'only' => 'scripts' ],
857  $rl
858  );
859 
860  $modules = [ 'foo' => $rl->getModule( 'foo' ), 'bar' => $rl->getModule( 'bar' ) ];
861  $response = $rl->makeModuleResponse( $context, $modules );
862  $extraHeaders = TestingAccessWrapper::newFromObject( $rl )->extraHeaders;
863  $this->assertEquals(
864  [
865  'Link: <https://example.org/script.js>;rel=preload;as=script',
866  'Link: </example.png>;rel=preload;as=image,</example.jpg>;rel=preload;as=image'
867  ],
868  $extraHeaders,
869  'Extra headers'
870  );
871  }
872 }
ResourceLoaderTest\setUp
setUp()
Definition: ResourceLoaderTest.php:7
ResourceLoaderTest\testIsFileModule
testIsFileModule( $expected, $module)
provideTestIsFileModule ResourceLoader::isFileModule
Definition: ResourceLoaderTest.php:162
ResourceLoaderTest\testMakePackedModulesString
testMakePackedModulesString( $desc, $modules, $packed)
providePackedModules ResourceLoader::makePackedModulesString
Definition: ResourceLoaderTest.php:286
ResourceLoaderTest\testConstructRegistrationHook
testConstructRegistrationHook()
Ensure the ResourceLoaderRegisterModules hook is called.
Definition: ResourceLoaderTest.php:32
ResourceLoaderTest\testRegisterInvalidType
testRegisterInvalidType()
ResourceLoader::register.
Definition: ResourceLoaderTest.php:96
ResourceLoaderTest\testGetModuleClassDefault
testGetModuleClassDefault()
ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:226
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2581
ResourceLoaderTest
Definition: ResourceLoaderTest.php:5
ResourceLoaderTest\testIsFileModuleUnknown
testIsFileModuleUnknown()
ResourceLoader::isFileModule.
Definition: ResourceLoaderTest.php:171
ResourceLoaderTest\testMakeModuleResponseError
testMakeModuleResponseError()
Verify that when building module content in a load.php response, an exception from one module will no...
Definition: ResourceLoaderTest.php:709
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ResourceLoaderTest\testRegisterInvalidName
testRegisterInvalidName()
ResourceLoader::register.
Definition: ResourceLoaderTest.php:87
ResourceLoaderContext\expandModuleNames
static expandModuleNames( $modules)
Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to an array of module names like [ 'jqu...
Definition: ResourceLoaderContext.php:107
ResourceLoaderTest\testMakeLoaderImplementScriptInvalid
testMakeLoaderImplementScriptInvalid()
ResourceLoader::makeLoaderImplementScript.
Definition: ResourceLoaderTest.php:467
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ResourceLoaderTest\testGetModuleNames
testGetModuleNames()
ResourceLoader::getModuleNames.
Definition: ResourceLoaderTest.php:105
$resourceLoader
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2581
ResourceLoaderTest\provideTestIsFileModule
provideTestIsFileModule()
Definition: ResourceLoaderTest.php:116
ResourceLoaderTest\testGetModuleClass
testGetModuleClass()
ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:197
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$debug
$debug
Definition: mcc.php:31
ResourceLoaderFileModule
ResourceLoader module based on local JavaScript/CSS files.
Definition: ResourceLoaderFileModule.php:28
XmlJsCode
A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to interpret a given string a...
Definition: XmlJsCode.php:39
ResourceLoaderTest\provideAddSource
static provideAddSource()
Definition: ResourceLoaderTest.php:302
MWException
MediaWiki exception.
Definition: MWException.php:26
ResourceLoaderTest\testMakeLoaderSourcesScript
testMakeLoaderSourcesScript()
ResourceLoader::makeLoaderSourcesScript.
Definition: ResourceLoaderTest.php:509
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:672
$modules
$modules
Definition: HTMLFormElement.php:12
ResourceLoaderTest\testAddSourceDupe
testAddSourceDupe()
ResourceLoader::addSource.
Definition: ResourceLoaderTest.php:337
ResourceLoaderTest\testMakeLoaderRegisterScript
testMakeLoaderRegisterScript()
ResourceLoader::makeLoaderRegisterScript.
Definition: ResourceLoaderTest.php:482
ResourceLoaderTest\testGetLoadScript
testGetLoadScript()
ResourceLoader::getLoadScript.
Definition: ResourceLoaderTest.php:552
ResourceLoaderTestModule
Definition: ResourceLoaderTestCase.php:85
ResourceLoaderTest\testRegisterValidArray
testRegisterValidArray()
ResourceLoader::register ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:65
ResourceLoaderTest\provideMakeModuleResponseConcat
static provideMakeModuleResponseConcat()
Definition: ResourceLoaderTest.php:622
ResourceLoaderTest\testRegisterEmptyString
testRegisterEmptyString()
ResourceLoader::register.
Definition: ResourceLoaderTest.php:77
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
ResourceLoaderTest\testMakeModuleResponseExtraHeaders
testMakeModuleResponseExtraHeaders()
Integration test for modules sending extra HTTP response headers.
Definition: ResourceLoaderTest.php:805
ResourceLoaderTest\testMakeLoaderImplementScript
testMakeLoaderImplementScript( $case)
provideLoaderImplement ResourceLoader::makeLoaderImplementScript ResourceLoader::trimArray
Definition: ResourceLoaderTest.php:441
ResourceLoaderTest\testMakeModuleResponseConcat
testMakeModuleResponseConcat( $scripts, $expected, $debug, $message=null)
Verify how multiple scripts and mw.loader.state() calls are concatenated.
Definition: ResourceLoaderTest.php:681
ResourceLoaderTest\testRegisterValidObject
testRegisterValidObject()
ResourceLoader::register ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:54
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1965
ResourceLoaderTest\getSimpleModuleMock
getSimpleModuleMock( $script='')
Definition: ResourceLoaderTest.php:579
ResourceLoaderTest\getFailFerryMock
getFailFerryMock()
Definition: ResourceLoaderTest.php:569
$response
this hook is for auditing only $response
Definition: hooks.txt:781
ResourceLoaderTest\testExpandModuleNames
testExpandModuleNames( $desc, $modules, $packed, $unpacked=null)
providePackedModules ResourceLoaderContext::expandModuleNames
Definition: ResourceLoaderTest.php:294
ResourceLoaderTest\testGetCombinedVersion
testGetCombinedVersion()
ResourceLoader::getCombinedVersion.
Definition: ResourceLoaderTest.php:590
ResourceLoaderTest\testAddSourceInvalid
testAddSourceInvalid()
ResourceLoader::addSource.
Definition: ResourceLoaderTest.php:347
MediaWikiTestCase\setLogger
setLogger( $channel, LoggerInterface $logger)
Sets the logger for a specified channel, for the duration of the test.
Definition: MediaWikiTestCase.php:906
ResourceLoaderTest\testMakeModuleResponseExtraHeadersMulti
testMakeModuleResponseExtraHeadersMulti()
ResourceLoaderModule::getHeaders ResourceLoaderModule::buildContent ResourceLoader::makeModuleRespons...
Definition: ResourceLoaderTest.php:839
EmptyResourceLoader
Definition: ResourceLoaderTestCase.php:176
ResourceLoaderTest\testGetModuleFactory
testGetModuleFactory()
ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:209
ResourceLoaderTestCase\getResourceLoaderContext
getResourceLoaderContext( $options=[], ResourceLoader $rl=null)
Definition: ResourceLoaderTestCase.php:23
ResourceLoaderTest\testIsModuleRegistered
testIsModuleRegistered()
ResourceLoader::isModuleRegistered.
Definition: ResourceLoaderTest.php:179
ResourceLoaderTest\fakeSources
static fakeSources()
Definition: ResourceLoaderTest.php:536
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
$basePath
$basePath
Definition: addSite.php:5
ResourceLoaderTest\testLessFileCompilation
testLessFileCompilation()
ResourceLoaderFileModule::compileLessFile.
Definition: ResourceLoaderTest.php:239
$source
$source
Definition: mwdoc-filter.php:46
ResourceLoaderTest\providePackedModules
static providePackedModules()
Definition: ResourceLoaderTest.php:251
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
ResourceLoaderTest\testGetModuleUnknown
testGetModuleUnknown()
ResourceLoader::getModule.
Definition: ResourceLoaderTest.php:189
ResourceLoaderTest\testMakeModuleResponseStartupError
testMakeModuleResponseStartupError()
Verify that when building the startup module response, an exception from one module class will not br...
Definition: ResourceLoaderTest.php:750
ResourceLoaderTest\provideLoaderImplement
static provideLoaderImplement()
Definition: ResourceLoaderTest.php:353
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ResourceLoaderTest\testAddSource
testAddSource( $name, $info, $expected)
provideAddSource ResourceLoader::addSource ResourceLoader::getSources
Definition: ResourceLoaderTest.php:322
ResourceLoaderTestCase
Definition: ResourceLoaderTestCase.php:7