MediaWiki  1.29.2
ResourceLoaderStartUpModuleTest.php
Go to the documentation of this file.
1 <?php
2 
4 
5  protected static function expandPlaceholders( $text ) {
6  return strtr( $text, [
7  '{blankVer}' => self::BLANK_VERSION
8  ] );
9  }
10 
11  public function provideGetModuleRegistrations() {
12  return [
13  [ [
14  'msg' => 'Empty registry',
15  'modules' => [],
16  'out' => '
17 mw.loader.addSource( {
18  "local": "/w/load.php"
19 } );
20 mw.loader.register( [] );'
21  ] ],
22  [ [
23  'msg' => 'Basic registry',
24  'modules' => [
25  'test.blank' => new ResourceLoaderTestModule(),
26  ],
27  'out' => '
28 mw.loader.addSource( {
29  "local": "/w/load.php"
30 } );
31 mw.loader.register( [
32  [
33  "test.blank",
34  "{blankVer}"
35  ]
36 ] );',
37  ] ],
38  [ [
39  'msg' => 'Omit raw modules from registry',
40  'modules' => [
41  'test.raw' => new ResourceLoaderTestModule( [ 'isRaw' => true ] ),
42  'test.blank' => new ResourceLoaderTestModule(),
43  ],
44  'out' => '
45 mw.loader.addSource( {
46  "local": "/w/load.php"
47 } );
48 mw.loader.register( [
49  [
50  "test.blank",
51  "{blankVer}"
52  ]
53 ] );',
54  ] ],
55  [ [
56  'msg' => 'Version falls back gracefully if getVersionHash throws',
57  'modules' => [
58  'test.fail' => (
59  ( $mock = $this->getMockBuilder( 'ResourceLoaderTestModule' )
60  ->setMethods( [ 'getVersionHash' ] )->getMock() )
61  && $mock->method( 'getVersionHash' )->will(
62  $this->throwException( new Exception )
63  )
64  ) ? $mock : $mock
65  ],
66  'out' => '
67 mw.loader.addSource( {
68  "local": "/w/load.php"
69 } );
70 mw.loader.register( [
71  [
72  "test.fail",
73  ""
74  ]
75 ] );
76 mw.loader.state( {
77  "test.fail": "error"
78 } );',
79  ] ],
80  [ [
81  'msg' => 'Use version from getVersionHash',
82  'modules' => [
83  'test.version' => (
84  ( $mock = $this->getMockBuilder( 'ResourceLoaderTestModule' )
85  ->setMethods( [ 'getVersionHash' ] )->getMock() )
86  && $mock->method( 'getVersionHash' )->willReturn( '1234567' )
87  ) ? $mock : $mock
88  ],
89  'out' => '
90 mw.loader.addSource( {
91  "local": "/w/load.php"
92 } );
93 mw.loader.register( [
94  [
95  "test.version",
96  "1234567"
97  ]
98 ] );',
99  ] ],
100  [ [
101  'msg' => 'Re-hash version from getVersionHash if too long',
102  'modules' => [
103  'test.version' => (
104  ( $mock = $this->getMockBuilder( 'ResourceLoaderTestModule' )
105  ->setMethods( [ 'getVersionHash' ] )->getMock() )
106  && $mock->method( 'getVersionHash' )->willReturn( '12345678' )
107  ) ? $mock : $mock
108  ],
109  'out' => '
110 mw.loader.addSource( {
111  "local": "/w/load.php"
112 } );
113 mw.loader.register( [
114  [
115  "test.version",
116  "016es8l"
117  ]
118 ] );',
119  ] ],
120  [ [
121  'msg' => 'Group signature',
122  'modules' => [
123  'test.blank' => new ResourceLoaderTestModule(),
124  'test.group.foo' => new ResourceLoaderTestModule( [ 'group' => 'x-foo' ] ),
125  'test.group.bar' => new ResourceLoaderTestModule( [ 'group' => 'x-bar' ] ),
126  ],
127  'out' => '
128 mw.loader.addSource( {
129  "local": "/w/load.php"
130 } );
131 mw.loader.register( [
132  [
133  "test.blank",
134  "{blankVer}"
135  ],
136  [
137  "test.group.foo",
138  "{blankVer}",
139  [],
140  "x-foo"
141  ],
142  [
143  "test.group.bar",
144  "{blankVer}",
145  [],
146  "x-bar"
147  ]
148 ] );'
149  ] ],
150  [ [
151  'msg' => 'Different target (non-test should not be registered)',
152  'modules' => [
153  'test.blank' => new ResourceLoaderTestModule(),
154  'test.target.foo' => new ResourceLoaderTestModule( [ 'targets' => [ 'x-foo' ] ] ),
155  ],
156  'out' => '
157 mw.loader.addSource( {
158  "local": "/w/load.php"
159 } );
160 mw.loader.register( [
161  [
162  "test.blank",
163  "{blankVer}"
164  ]
165 ] );'
166  ] ],
167  [ [
168  'msg' => 'Foreign source',
169  'sources' => [
170  'example' => [
171  'loadScript' => 'http://example.org/w/load.php',
172  'apiScript' => 'http://example.org/w/api.php',
173  ],
174  ],
175  'modules' => [
176  'test.blank' => new ResourceLoaderTestModule( [ 'source' => 'example' ] ),
177  ],
178  'out' => '
179 mw.loader.addSource( {
180  "local": "/w/load.php",
181  "example": "http://example.org/w/load.php"
182 } );
183 mw.loader.register( [
184  [
185  "test.blank",
186  "{blankVer}",
187  [],
188  null,
189  "example"
190  ]
191 ] );'
192  ] ],
193  [ [
194  'msg' => 'Conditional dependency function',
195  'modules' => [
196  'test.x.core' => new ResourceLoaderTestModule(),
197  'test.x.polyfill' => new ResourceLoaderTestModule( [
198  'skipFunction' => 'return true;'
199  ] ),
200  'test.y.polyfill' => new ResourceLoaderTestModule( [
201  'skipFunction' =>
202  'return !!(' .
203  ' window.JSON &&' .
204  ' JSON.parse &&' .
205  ' JSON.stringify' .
206  ');'
207  ] ),
208  'test.z.foo' => new ResourceLoaderTestModule( [
209  'dependencies' => [
210  'test.x.core',
211  'test.x.polyfill',
212  'test.y.polyfill',
213  ],
214  ] ),
215  ],
216  'out' => '
217 mw.loader.addSource( {
218  "local": "/w/load.php"
219 } );
220 mw.loader.register( [
221  [
222  "test.x.core",
223  "{blankVer}"
224  ],
225  [
226  "test.x.polyfill",
227  "{blankVer}",
228  [],
229  null,
230  null,
231  "return true;"
232  ],
233  [
234  "test.y.polyfill",
235  "{blankVer}",
236  [],
237  null,
238  null,
239  "return !!( window.JSON \u0026\u0026 JSON.parse \u0026\u0026 JSON.stringify);"
240  ],
241  [
242  "test.z.foo",
243  "{blankVer}",
244  [
245  0,
246  1,
247  2
248  ]
249  ]
250 ] );',
251  ] ],
252  [ [
253  // This may seem like an edge case, but a plain MediaWiki core install
254  // with a few extensions installed is likely far more complex than this
255  // even, not to mention an install like Wikipedia.
256  // TODO: Make this even more realistic.
257  'msg' => 'Advanced (everything combined)',
258  'sources' => [
259  'example' => [
260  'loadScript' => 'http://example.org/w/load.php',
261  'apiScript' => 'http://example.org/w/api.php',
262  ],
263  ],
264  'modules' => [
265  'test.blank' => new ResourceLoaderTestModule(),
266  'test.x.core' => new ResourceLoaderTestModule(),
267  'test.x.util' => new ResourceLoaderTestModule( [
268  'dependencies' => [
269  'test.x.core',
270  ],
271  ] ),
272  'test.x.foo' => new ResourceLoaderTestModule( [
273  'dependencies' => [
274  'test.x.core',
275  ],
276  ] ),
277  'test.x.bar' => new ResourceLoaderTestModule( [
278  'dependencies' => [
279  'test.x.core',
280  'test.x.util',
281  ],
282  ] ),
283  'test.x.quux' => new ResourceLoaderTestModule( [
284  'dependencies' => [
285  'test.x.foo',
286  'test.x.bar',
287  'test.x.util',
288  'test.x.unknown',
289  ],
290  ] ),
291  'test.group.foo.1' => new ResourceLoaderTestModule( [
292  'group' => 'x-foo',
293  ] ),
294  'test.group.foo.2' => new ResourceLoaderTestModule( [
295  'group' => 'x-foo',
296  ] ),
297  'test.group.bar.1' => new ResourceLoaderTestModule( [
298  'group' => 'x-bar',
299  ] ),
300  'test.group.bar.2' => new ResourceLoaderTestModule( [
301  'group' => 'x-bar',
302  'source' => 'example',
303  ] ),
304  'test.target.foo' => new ResourceLoaderTestModule( [
305  'targets' => [ 'x-foo' ],
306  ] ),
307  'test.target.bar' => new ResourceLoaderTestModule( [
308  'source' => 'example',
309  'targets' => [ 'x-foo' ],
310  ] ),
311  ],
312  'out' => '
313 mw.loader.addSource( {
314  "local": "/w/load.php",
315  "example": "http://example.org/w/load.php"
316 } );
317 mw.loader.register( [
318  [
319  "test.blank",
320  "{blankVer}"
321  ],
322  [
323  "test.x.core",
324  "{blankVer}"
325  ],
326  [
327  "test.x.util",
328  "{blankVer}",
329  [
330  1
331  ]
332  ],
333  [
334  "test.x.foo",
335  "{blankVer}",
336  [
337  1
338  ]
339  ],
340  [
341  "test.x.bar",
342  "{blankVer}",
343  [
344  2
345  ]
346  ],
347  [
348  "test.x.quux",
349  "{blankVer}",
350  [
351  3,
352  4,
353  "test.x.unknown"
354  ]
355  ],
356  [
357  "test.group.foo.1",
358  "{blankVer}",
359  [],
360  "x-foo"
361  ],
362  [
363  "test.group.foo.2",
364  "{blankVer}",
365  [],
366  "x-foo"
367  ],
368  [
369  "test.group.bar.1",
370  "{blankVer}",
371  [],
372  "x-bar"
373  ],
374  [
375  "test.group.bar.2",
376  "{blankVer}",
377  [],
378  "x-bar",
379  "example"
380  ]
381 ] );'
382  ] ],
383  ];
384  }
385 
392  public function testGetModuleRegistrations( $case ) {
393  if ( isset( $case['sources'] ) ) {
394  $this->setMwGlobals( 'wgResourceLoaderSources', $case['sources'] );
395  }
396 
398  $rl = $context->getResourceLoader();
399  $rl->register( $case['modules'] );
400  $module = new ResourceLoaderStartUpModule();
401  $out = ltrim( $case['out'], "\n" );
402 
403  $this->assertEquals(
404  self::expandPlaceholders( $out ),
405  $module->getModuleRegistrations( $context ),
406  $case['msg']
407  );
408  }
409 
410  public static function provideRegistrations() {
411  return [
412  [ [
413  'test.blank' => new ResourceLoaderTestModule(),
414  'test.min' => new ResourceLoaderTestModule( [
415  'skipFunction' =>
416  'return !!(' .
417  ' window.JSON &&' .
418  ' JSON.parse &&' .
419  ' JSON.stringify' .
420  ');',
421  'dependencies' => [
422  'test.blank',
423  ],
424  ] ),
425  ] ]
426  ];
427  }
432  public function testRegistrationsMinified( $modules ) {
433  $this->setMwGlobals( 'wgResourceLoaderDebug', false );
434 
436  $rl = $context->getResourceLoader();
437  $rl->register( $modules );
438  $module = new ResourceLoaderStartUpModule();
439  $out = 'mw.loader.addSource({"local":"/w/load.php"});' . "\n"
440  . 'mw.loader.register(['
441  . '["test.blank","{blankVer}"],'
442  . '["test.min","{blankVer}",[0],null,null,'
443  . '"return!!(window.JSON\u0026\u0026JSON.parse\u0026\u0026JSON.stringify);"'
444  . ']]);';
445 
446  $this->assertEquals(
447  self::expandPlaceholders( $out ),
448  $module->getModuleRegistrations( $context ),
449  'Minified output'
450  );
451  }
452 
459  $rl = $context->getResourceLoader();
460  $rl->register( $modules );
461  $module = new ResourceLoaderStartUpModule();
462  $out =
463 'mw.loader.addSource( {
464  "local": "/w/load.php"
465 } );
466 mw.loader.register( [
467  [
468  "test.blank",
469  "{blankVer}"
470  ],
471  [
472  "test.min",
473  "{blankVer}",
474  [
475  0
476  ],
477  null,
478  null,
479  "return !!( window.JSON \u0026\u0026 JSON.parse \u0026\u0026 JSON.stringify);"
480  ]
481 ] );';
482 
483  $this->assertEquals(
484  self::expandPlaceholders( $out ),
485  $module->getModuleRegistrations( $context ),
486  'Unminified output'
487  );
488  }
489 
490 }
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
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
ResourceLoaderStartUpModuleTest\expandPlaceholders
static expandPlaceholders( $text)
Definition: ResourceLoaderStartUpModuleTest.php:5
ResourceLoaderStartUpModuleTest\testRegistrationsMinified
testRegistrationsMinified( $modules)
ResourceLoaderStartUpModule::getModuleRegistrations provideRegistrations.
Definition: ResourceLoaderStartUpModuleTest.php:432
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Definition: MediaWikiTestCase.php:658
$modules
$modules
Definition: HTMLFormElement.php:12
ResourceLoaderStartUpModuleTest\testGetModuleRegistrations
testGetModuleRegistrations( $case)
provideGetModuleRegistrations ResourceLoaderStartUpModule::getModuleRegistrations ResourceLoaderStart...
Definition: ResourceLoaderStartUpModuleTest.php:392
ResourceLoaderTestModule
Definition: ResourceLoaderTestCase.php:84
ResourceLoaderStartUpModule
Definition: ResourceLoaderStartUpModule.php:25
ResourceLoaderStartUpModuleTest\testRegistrationsUnminified
testRegistrationsUnminified( $modules)
ResourceLoaderStartUpModule::getModuleRegistrations provideRegistrations.
Definition: ResourceLoaderStartUpModuleTest.php:457
ResourceLoaderStartUpModuleTest\provideRegistrations
static provideRegistrations()
Definition: ResourceLoaderStartUpModuleTest.php:410
ResourceLoaderTestCase\getResourceLoaderContext
getResourceLoaderContext( $options=[], ResourceLoader $rl=null)
Definition: ResourceLoaderTestCase.php:22
ResourceLoaderStartUpModuleTest
Definition: ResourceLoaderStartUpModuleTest.php:3
ResourceLoaderStartUpModuleTest\provideGetModuleRegistrations
provideGetModuleRegistrations()
Definition: ResourceLoaderStartUpModuleTest.php:11
ResourceLoaderTestCase
Definition: ResourceLoaderTestCase.php:7
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:783