tests/phpunit/includes/resourceloader/ResourceLoaderClientHtmlTest.php

   1 <?php
   2
   3 use Wikimedia\TestingAccessWrapper;
   4
   5 /**
   6  * @group ResourceLoader
   7  */
   8 class ResourceLoaderClientHtmlTest extends PHPUnit\Framework\TestCase {
   9
  10         use MediaWikiCoversValidator;
  11
  12         protected static function expandVariables( $text ) {
  13                 return strtr( $text, [
  14                         '{blankVer}' => ResourceLoaderTestCase::BLANK_VERSION
  15                 ] );
  16         }
  17
  18         protected static function makeContext( $extraQuery = [] ) {
  19                 $conf = new HashConfig( [
  20                         'ResourceLoaderSources' => [],
  21                         'ResourceModuleSkinStyles' => [],
  22                         'ResourceModules' => [],
  23                         'EnableJavaScriptTest' => false,
  24                         'ResourceLoaderDebug' => false,
  25                         'LoadScript' => '/w/load.php',
  26                 ] );
  27                 return new ResourceLoaderContext(
  28                         new ResourceLoader( $conf ),
  29                         new FauxRequest( array_merge( [
  30                                 'lang' => 'nl',
  31                                 'skin' => 'fallback',
  32                                 'user' => 'Example',
  33                                 'target' => 'phpunit',
  34                         ], $extraQuery ) )
  35                 );
  36         }
  37
  38         protected static function makeModule( array $options = [] ) {
  39                 return new ResourceLoaderTestModule( $options );
  40         }
  41
  42         protected static function makeSampleModules() {
  43                 $modules = [
  44                         'test' => [],
  45                         'test.private' => [ 'group' => 'private' ],
  46                         'test.shouldembed.empty' => [ 'shouldEmbed' => true, 'isKnownEmpty' => true ],
  47                         'test.shouldembed' => [ 'shouldEmbed' => true ],
  48                         'test.user' => [ 'group' => 'user' ],
  49
  50                         'test.styles.pure' => [ 'type' => ResourceLoaderModule::LOAD_STYLES ],
  51                         'test.styles.mixed' => [],
  52                         'test.styles.noscript' => [
  53                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  54                                 'group' => 'noscript',
  55                         ],
  56                         'test.styles.user' => [
  57                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  58                                 'group' => 'user',
  59                         ],
  60                         'test.styles.user.empty' => [
  61                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  62                                 'group' => 'user',
  63                                 'isKnownEmpty' => true,
  64                         ],
  65                         'test.styles.private' => [
  66                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  67                                 'group' => 'private',
  68                                 'styles' => '.private{}',
  69                         ],
  70                         'test.styles.shouldembed' => [
  71                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  72                                 'shouldEmbed' => true,
  73                                 'styles' => '.shouldembed{}',
  74                         ],
  75                         'test.styles.deprecated' => [
  76                                 'type' => ResourceLoaderModule::LOAD_STYLES,
  77                                 'deprecated' => 'Deprecation message.',
  78                         ],
  79
  80                         'test.scripts' => [],
  81                         'test.scripts.user' => [ 'group' => 'user' ],
  82                         'test.scripts.user.empty' => [ 'group' => 'user', 'isKnownEmpty' => true ],
  83                         'test.scripts.raw' => [ 'isRaw' => true ],
  84                         'test.scripts.shouldembed' => [ 'shouldEmbed' => true ],
  85
  86                         'test.ordering.a' => [ 'shouldEmbed' => false ],
  87                         'test.ordering.b' => [ 'shouldEmbed' => false ],
  88                         'test.ordering.c' => [ 'shouldEmbed' => true, 'styles' => '.orderingC{}' ],
  89                         'test.ordering.d' => [ 'shouldEmbed' => true, 'styles' => '.orderingD{}' ],
  90                         'test.ordering.e' => [ 'shouldEmbed' => false ],
  91                 ];
  92                 return array_map( function ( $options ) {
  93                         return self::makeModule( $options );
  94                 }, $modules );
  95         }
  96
  97         /**
  98          * @covers ResourceLoaderClientHtml::getDocumentAttributes
  99          */
 100         public function testGetDocumentAttributes() {
 101                 $client = new ResourceLoaderClientHtml( self::makeContext() );
 102                 $this->assertInternalType( 'array', $client->getDocumentAttributes() );
 103         }
 104
 105         /**
 106          * @covers ResourceLoaderClientHtml::__construct
 107          * @covers ResourceLoaderClientHtml::setModules
 108          * @covers ResourceLoaderClientHtml::setModuleStyles
 109          * @covers ResourceLoaderClientHtml::setModuleScripts
 110          * @covers ResourceLoaderClientHtml::getData
 111          * @covers ResourceLoaderClientHtml::getContext
 112          */
 113         public function testGetData() {
 114                 $context = self::makeContext();
 115                 $context->getResourceLoader()->register( self::makeSampleModules() );
 116
 117                 $client = new ResourceLoaderClientHtml( $context );
 118                 $client->setModules( [
 119                         'test',
 120                         'test.private',
 121                         'test.shouldembed.empty',
 122                         'test.shouldembed',
 123                         'test.user',
 124                         'test.unregistered',
 125                 ] );
 126                 $client->setModuleStyles( [
 127                         'test.styles.mixed',
 128                         'test.styles.user.empty',
 129                         'test.styles.private',
 130                         'test.styles.pure',
 131                         'test.styles.shouldembed',
 132                         'test.styles.deprecated',
 133                         'test.unregistered.styles',
 134                 ] );
 135                 $client->setModuleScripts( [
 136                         'test.scripts',
 137                         'test.scripts.user',
 138                         'test.scripts.user.empty',
 139                         'test.scripts.shouldembed',
 140                         'test.unregistered.scripts',
 141                 ] );
 142
 143                 $expected = [
 144                         'states' => [
 145                                 'test.private' => 'loading',
 146                                 'test.shouldembed.empty' => 'ready',
 147                                 'test.shouldembed' => 'loading',
 148                                 'test.user' => 'loading',
 149                                 'test.styles.pure' => 'ready',
 150                                 'test.styles.user.empty' => 'ready',
 151                                 'test.styles.private' => 'ready',
 152                                 'test.styles.shouldembed' => 'ready',
 153                                 'test.styles.deprecated' => 'ready',
 154                                 'test.scripts' => 'loading',
 155                                 'test.scripts.user' => 'loading',
 156                                 'test.scripts.user.empty' => 'ready',
 157                                 'test.scripts.shouldembed' => 'loading',
 158                         ],
 159                         'general' => [
 160                                 'test',
 161                         ],
 162                         'styles' => [
 163                                 'test.styles.pure',
 164                                 'test.styles.deprecated',
 165                         ],
 166                         'scripts' => [
 167                                 'test.scripts',
 168                                 'test.scripts.user',
 169                                 'test.scripts.shouldembed',
 170                         ],
 171                         'embed' => [
 172                                 'styles' => [ 'test.styles.private', 'test.styles.shouldembed' ],
 173                                 'general' => [
 174                                         'test.private',
 175                                         'test.shouldembed',
 176                                         'test.user',
 177                                 ],
 178                         ],
 179                         'styledeprecations' => [
 180                                 Xml::encodeJsCall(
 181                                         'mw.log.warn',
 182                                         [ 'This page is using the deprecated ResourceLoader module "test.styles.deprecated".
 183 Deprecation message.' ]
 184                                 )
 185                         ],
 186                 ];
 187
 188                 $access = TestingAccessWrapper::newFromObject( $client );
 189                 $this->assertEquals( $expected, $access->getData() );
 190         }
 191
 192         /**
 193          * @covers ResourceLoaderClientHtml::setConfig
 194          * @covers ResourceLoaderClientHtml::setExemptStates
 195          * @covers ResourceLoaderClientHtml::getHeadHtml
 196          * @covers ResourceLoaderClientHtml::getLoad
 197          * @covers ResourceLoader::makeLoaderStateScript
 198          */
 199         public function testGetHeadHtml() {
 200                 $context = self::makeContext();
 201                 $context->getResourceLoader()->register( self::makeSampleModules() );
 202
 203                 $client = new ResourceLoaderClientHtml( $context );
 204                 $client->setConfig( [ 'key' => 'value' ] );
 205                 $client->setModules( [
 206                         'test',
 207                         'test.private',
 208                 ] );
 209                 $client->setModuleStyles( [
 210                         'test.styles.pure',
 211                         'test.styles.private',
 212                         'test.styles.deprecated',
 213                 ] );
 214                 $client->setModuleScripts( [
 215                         'test.scripts',
 216                 ] );
 217                 $client->setExemptStates( [
 218                         'test.exempt' => 'ready',
 219                 ] );
 220
 221                 // phpcs:disable Generic.Files.LineLength
 222                 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
 223                         . '<script>(window.RLQ=window.RLQ||[]).push(function(){'
 224                         . 'mw.config.set({"key":"value"});'
 225                         . 'mw.loader.state({"test.exempt":"ready","test.private":"loading","test.styles.pure":"ready","test.styles.private":"ready","test.styles.deprecated":"ready","test.scripts":"loading"});'
 226                         . 'mw.loader.implement("test.private@{blankVer}",function($,jQuery,require,module){},{"css":[]});'
 227                         . 'mw.loader.load(["test"]);'
 228                         . 'mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts\u0026only=scripts\u0026skin=fallback");'
 229                         . 'mw.log.warn("This page is using the deprecated ResourceLoader module \"test.styles.deprecated\".\nDeprecation message.");'
 230                         . '});</script>' . "\n"
 231                         . '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.styles.deprecated%2Cpure&amp;only=styles&amp;skin=fallback"/>' . "\n"
 232                         . '<style>.private{}</style>' . "\n"
 233                         . '<script async="" src="/w/load.php?debug=false&amp;lang=nl&amp;modules=startup&amp;only=scripts&amp;skin=fallback"></script>';
 234                 // phpcs:enable
 235                 $expected = self::expandVariables( $expected );
 236
 237                 $this->assertEquals( $expected, $client->getHeadHtml( false ) );
 238         }
 239
 240         /**
 241          * Confirm that 'target' is passed down to the startup module's load url.
 242          *
 243          * @covers ResourceLoaderClientHtml::getHeadHtml
 244          */
 245         public function testGetHeadHtmlWithTarget() {
 246                 $client = new ResourceLoaderClientHtml(
 247                         self::makeContext(),
 248                         [ 'target' => 'example' ]
 249                 );
 250
 251                 // phpcs:disable Generic.Files.LineLength
 252                 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
 253                         . '<script async="" src="/w/load.php?debug=false&amp;lang=nl&amp;modules=startup&amp;only=scripts&amp;skin=fallback&amp;target=example"></script>';
 254                 // phpcs:enable
 255
 256                 $this->assertEquals( $expected, $client->getHeadHtml( false ) );
 257         }
 258
 259         /**
 260          * Confirm that a null 'target' is the same as no target.
 261          *
 262          * @covers ResourceLoaderClientHtml::getHeadHtml
 263          */
 264         public function testGetHeadHtmlWithNullTarget() {
 265                 $client = new ResourceLoaderClientHtml(
 266                         self::makeContext(),
 267                         [ 'target' => null ]
 268                 );
 269
 270                 // phpcs:disable Generic.Files.LineLength
 271                 $expected = '<script>document.documentElement.className = document.documentElement.className.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );</script>' . "\n"
 272                         . '<script async="" src="/w/load.php?debug=false&amp;lang=nl&amp;modules=startup&amp;only=scripts&amp;skin=fallback"></script>';
 273                 // phpcs:enable
 274
 275                 $this->assertEquals( $expected, $client->getHeadHtml( false ) );
 276         }
 277
 278         /**
 279          * @covers ResourceLoaderClientHtml::getBodyHtml
 280          * @covers ResourceLoaderClientHtml::getLoad
 281          */
 282         public function testGetBodyHtml() {
 283                 $context = self::makeContext();
 284                 $context->getResourceLoader()->register( self::makeSampleModules() );
 285
 286                 $client = new ResourceLoaderClientHtml( $context );
 287                 $client->setConfig( [ 'key' => 'value' ] );
 288                 $client->setModules( [
 289                         'test',
 290                         'test.private.bottom',
 291                 ] );
 292                 $client->setModuleScripts( [
 293                         'test.scripts',
 294                 ] );
 295
 296                 $expected = '';
 297                 $expected = self::expandVariables( $expected );
 298
 299                 $this->assertEquals( $expected, $client->getBodyHtml() );
 300         }
 301
 302         public static function provideMakeLoad() {
 303                 // phpcs:disable Generic.Files.LineLength
 304                 return [
 305                         [
 306                                 'context' => [],
 307                                 'modules' => [ 'test.unknown' ],
 308                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 309                                 'output' => '',
 310                         ],
 311                         [
 312                                 'context' => [],
 313                                 'modules' => [ 'test.styles.private' ],
 314                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 315                                 'output' => '<style>.private{}</style>',
 316                         ],
 317                         [
 318                                 'context' => [],
 319                                 'modules' => [ 'test.private' ],
 320                                 'only' => ResourceLoaderModule::TYPE_COMBINED,
 321                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.private@{blankVer}",function($,jQuery,require,module){},{"css":[]});});</script>',
 322                         ],
 323                         [
 324                                 'context' => [],
 325                                 // Eg. startup module
 326                                 'modules' => [ 'test.scripts.raw' ],
 327                                 'only' => ResourceLoaderModule::TYPE_SCRIPTS,
 328                                 'output' => '<script async="" src="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.scripts.raw&amp;only=scripts&amp;skin=fallback"></script>',
 329                         ],
 330                         [
 331                                 'context' => [ 'sync' => true ],
 332                                 'modules' => [ 'test.scripts.raw' ],
 333                                 'only' => ResourceLoaderModule::TYPE_SCRIPTS,
 334                                 'output' => '<script src="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.scripts.raw&amp;only=scripts&amp;skin=fallback&amp;sync=1"></script>',
 335                         ],
 336                         [
 337                                 'context' => [],
 338                                 'modules' => [ 'test.scripts.user' ],
 339                                 'only' => ResourceLoaderModule::TYPE_SCRIPTS,
 340                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.scripts.user\u0026only=scripts\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
 341                         ],
 342                         [
 343                                 'context' => [],
 344                                 'modules' => [ 'test.user' ],
 345                                 'only' => ResourceLoaderModule::TYPE_COMBINED,
 346                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test.user\u0026skin=fallback\u0026user=Example\u0026version=0a56zyi");});</script>',
 347                         ],
 348                         [
 349                                 'context' => [ 'debug' => true ],
 350                                 'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
 351                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 352                                 'output' => '<link rel="stylesheet" href="/w/load.php?debug=true&amp;lang=nl&amp;modules=test.styles.mixed&amp;only=styles&amp;skin=fallback"/>' . "\n"
 353                                         . '<link rel="stylesheet" href="/w/load.php?debug=true&amp;lang=nl&amp;modules=test.styles.pure&amp;only=styles&amp;skin=fallback"/>',
 354                         ],
 355                         [
 356                                 'context' => [ 'debug' => false ],
 357                                 'modules' => [ 'test.styles.pure', 'test.styles.mixed' ],
 358                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 359                                 'output' => '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.styles.mixed%2Cpure&amp;only=styles&amp;skin=fallback"/>',
 360                         ],
 361                         [
 362                                 'context' => [],
 363                                 'modules' => [ 'test.styles.noscript' ],
 364                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 365                                 'output' => '<noscript><link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.styles.noscript&amp;only=styles&amp;skin=fallback"/></noscript>',
 366                         ],
 367                         [
 368                                 'context' => [],
 369                                 'modules' => [ 'test.shouldembed' ],
 370                                 'only' => ResourceLoaderModule::TYPE_COMBINED,
 371                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.implement("test.shouldembed@09p30q0",function($,jQuery,require,module){},{"css":[]});});</script>',
 372                         ],
 373                         [
 374                                 'context' => [],
 375                                 'modules' => [ 'test.styles.shouldembed' ],
 376                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 377                                 'output' => '<style>.shouldembed{}</style>',
 378                         ],
 379                         [
 380                                 'context' => [],
 381                                 'modules' => [ 'test.scripts.shouldembed' ],
 382                                 'only' => ResourceLoaderModule::TYPE_SCRIPTS,
 383                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.state({"test.scripts.shouldembed":"ready"});});</script>',
 384                         ],
 385                         [
 386                                 'context' => [],
 387                                 'modules' => [ 'test', 'test.shouldembed' ],
 388                                 'only' => ResourceLoaderModule::TYPE_COMBINED,
 389                                 'output' => '<script>(window.RLQ=window.RLQ||[]).push(function(){mw.loader.load("/w/load.php?debug=false\u0026lang=nl\u0026modules=test\u0026skin=fallback");mw.loader.implement("test.shouldembed@09p30q0",function($,jQuery,require,module){},{"css":[]});});</script>',
 390                         ],
 391                         [
 392                                 'context' => [],
 393                                 'modules' => [ 'test.styles.pure', 'test.styles.shouldembed' ],
 394                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 395                                 'output' =>
 396                                         '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.styles.pure&amp;only=styles&amp;skin=fallback"/>' . "\n"
 397                                         . '<style>.shouldembed{}</style>'
 398                         ],
 399                         [
 400                                 'context' => [],
 401                                 'modules' => [ 'test.ordering.a', 'test.ordering.e', 'test.ordering.b', 'test.ordering.d', 'test.ordering.c' ],
 402                                 'only' => ResourceLoaderModule::TYPE_STYLES,
 403                                 'output' =>
 404                                         '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.ordering.a%2Cb&amp;only=styles&amp;skin=fallback"/>' . "\n"
 405                                         . '<style>.orderingC{}.orderingD{}</style>' . "\n"
 406                                         . '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=nl&amp;modules=test.ordering.e&amp;only=styles&amp;skin=fallback"/>'
 407                         ],
 408                 ];
 409                 // phpcs:enable
 410         }
 411
 412         /**
 413          * @dataProvider provideMakeLoad
 414          * @covers ResourceLoaderClientHtml::makeLoad
 415          * @covers ResourceLoaderClientHtml::makeContext
 416          * @covers ResourceLoader::makeModuleResponse
 417          * @covers ResourceLoaderModule::getModuleContent
 418          * @covers ResourceLoader::getCombinedVersion
 419          * @covers ResourceLoader::createLoaderURL
 420          * @covers ResourceLoader::createLoaderQuery
 421          * @covers ResourceLoader::makeLoaderQuery
 422          * @covers ResourceLoader::makeInlineScript
 423          */
 424         public function testMakeLoad( array $extraQuery, array $modules, $type, $expected ) {
 425                 $context = self::makeContext( $extraQuery );
 426                 $context->getResourceLoader()->register( self::makeSampleModules() );
 427                 $actual = ResourceLoaderClientHtml::makeLoad( $context, $modules, $type, $extraQuery, false );
 428                 $expected = self::expandVariables( $expected );
 429                 $this->assertEquals( $expected, (string)$actual );
 430         }
 431 }