tests/phpunit/includes/OutputPageTest.php

   1 <?php
   2
   3 /**
   4  *
   5  * @author Matthew Flaschen
   6  *
   7  * @group Output
   8  *
   9  * @todo factor tests in this class into providers and test methods
  10  *
  11  */
  12 class OutputPageTest extends MediaWikiTestCase {
  13         const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
  14         const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
  15
  16         /**
  17          * Tests a particular case of transformCssMedia, using the given input, globals,
  18          * expected return, and message
  19          *
  20          * Asserts that $expectedReturn is returned.
  21          *
  22          * options['printableQuery'] - value of query string for printable, or omitted for none
  23          * options['handheldQuery'] - value of query string for handheld, or omitted for none
  24          * options['media'] - passed into the method under the same name
  25          * options['expectedReturn'] - expected return value
  26          * options['message'] - PHPUnit message for assertion
  27          *
  28          * @param array $args Key-value array of arguments as shown above
  29          */
  30         protected function assertTransformCssMediaCase( $args ) {
  31                 $queryData = [];
  32                 if ( isset( $args['printableQuery'] ) ) {
  33                         $queryData['printable'] = $args['printableQuery'];
  34                 }
  35
  36                 if ( isset( $args['handheldQuery'] ) ) {
  37                         $queryData['handheld'] = $args['handheldQuery'];
  38                 }
  39
  40                 $fauxRequest = new FauxRequest( $queryData, false );
  41                 $this->setMwGlobals( [
  42                         'wgRequest' => $fauxRequest,
  43                 ] );
  44
  45                 $actualReturn = OutputPage::transformCssMedia( $args['media'] );
  46                 $this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
  47         }
  48
  49         /**
  50          * Tests print requests
  51          * @covers OutputPage::transformCssMedia
  52          */
  53         public function testPrintRequests() {
  54                 $this->assertTransformCssMediaCase( [
  55                         'printableQuery' => '1',
  56                         'media' => 'screen',
  57                         'expectedReturn' => null,
  58                         'message' => 'On printable request, screen returns null'
  59                 ] );
  60
  61                 $this->assertTransformCssMediaCase( [
  62                         'printableQuery' => '1',
  63                         'media' => self::SCREEN_MEDIA_QUERY,
  64                         'expectedReturn' => null,
  65                         'message' => 'On printable request, screen media query returns null'
  66                 ] );
  67
  68                 $this->assertTransformCssMediaCase( [
  69                         'printableQuery' => '1',
  70                         'media' => self::SCREEN_ONLY_MEDIA_QUERY,
  71                         'expectedReturn' => null,
  72                         'message' => 'On printable request, screen media query with only returns null'
  73                 ] );
  74
  75                 $this->assertTransformCssMediaCase( [
  76                         'printableQuery' => '1',
  77                         'media' => 'print',
  78                         'expectedReturn' => '',
  79                         'message' => 'On printable request, media print returns empty string'
  80                 ] );
  81         }
  82
  83         /**
  84          * Tests screen requests, without either query parameter set
  85          * @covers OutputPage::transformCssMedia
  86          */
  87         public function testScreenRequests() {
  88                 $this->assertTransformCssMediaCase( [
  89                         'media' => 'screen',
  90                         'expectedReturn' => 'screen',
  91                         'message' => 'On screen request, screen media type is preserved'
  92                 ] );
  93
  94                 $this->assertTransformCssMediaCase( [
  95                         'media' => 'handheld',
  96                         'expectedReturn' => 'handheld',
  97                         'message' => 'On screen request, handheld media type is preserved'
  98                 ] );
  99
 100                 $this->assertTransformCssMediaCase( [
 101                         'media' => self::SCREEN_MEDIA_QUERY,
 102                         'expectedReturn' => self::SCREEN_MEDIA_QUERY,
 103                         'message' => 'On screen request, screen media query is preserved.'
 104                 ] );
 105
 106                 $this->assertTransformCssMediaCase( [
 107                         'media' => self::SCREEN_ONLY_MEDIA_QUERY,
 108                         'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
 109                         'message' => 'On screen request, screen media query with only is preserved.'
 110                 ] );
 111
 112                 $this->assertTransformCssMediaCase( [
 113                         'media' => 'print',
 114                         'expectedReturn' => 'print',
 115                         'message' => 'On screen request, print media type is preserved'
 116                 ] );
 117         }
 118
 119         /**
 120          * Tests handheld behavior
 121          * @covers OutputPage::transformCssMedia
 122          */
 123         public function testHandheld() {
 124                 $this->assertTransformCssMediaCase( [
 125                         'handheldQuery' => '1',
 126                         'media' => 'handheld',
 127                         'expectedReturn' => '',
 128                         'message' => 'On request with handheld querystring and media is handheld, returns empty string'
 129                 ] );
 130
 131                 $this->assertTransformCssMediaCase( [
 132                         'handheldQuery' => '1',
 133                         'media' => 'screen',
 134                         'expectedReturn' => null,
 135                         'message' => 'On request with handheld querystring and media is screen, returns null'
 136                 ] );
 137         }
 138
 139         public static function provideMakeResourceLoaderLink() {
 140                 // @codingStandardsIgnoreStart Generic.Files.LineLength
 141                 return array(
 142                         // Load module script only
 143                         array(
 144                                 array( 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ),
 145                                 "<script>(window.RLQ = window.RLQ || []).push(function () {\n"
 146                                         . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.foo\u0026only=scripts\u0026skin=fallback");'
 147                                         . "\n} );</script>"
 148                         ),
 149                         array(
 150                                 // Don't condition wrap raw modules (like the startup module)
 151                                 array( 'test.raw', ResourceLoaderModule::TYPE_SCRIPTS ),
 152                                 '<script async src="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.raw&amp;only=scripts&amp;skin=fallback"></script>'
 153                         ),
 154                         // Load module styles only
 155                         // This also tests the order the modules are put into the url
 156                         array(
 157                                 array( array( 'test.baz', 'test.foo', 'test.bar' ), ResourceLoaderModule::TYPE_STYLES ),
 158
 159                                 '<link rel=stylesheet href="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.bar%2Cbaz%2Cfoo&amp;only=styles&amp;skin=fallback">'
 160                         ),
 161                         // Load private module (only=scripts)
 162                         array(
 163                                 array( 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ),
 164                                 "<script>(window.RLQ = window.RLQ || []).push(function () {\n"
 165                                         . "mw.test.baz({token:123});mw.loader.state({\"test.quux\":\"ready\"});\n"
 166                                         . "} );</script>"
 167                         ),
 168                         // Load private module (combined)
 169                         array(
 170                                 array( 'test.quux', ResourceLoaderModule::TYPE_COMBINED ),
 171                                 "<script>(window.RLQ = window.RLQ || []).push(function () {\n"
 172                                         . "mw.loader.implement(\"test.quux\",function($,jQuery){"
 173                                         . "mw.test.baz({token:123});},{\"css\":[\".mw-icon{transition:none}"
 174                                         . "\"]});\n} );</script>"
 175                         ),
 176                         // Load no modules
 177                         array(
 178                                 array( array(), ResourceLoaderModule::TYPE_COMBINED ),
 179                                 '',
 180                         ),
 181                         // noscript group
 182                         array(
 183                                 array( 'test.noscript', ResourceLoaderModule::TYPE_STYLES ),
 184                                 '<noscript><link rel=stylesheet href="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.noscript&amp;only=styles&amp;skin=fallback"></noscript>'
 185                         ),
 186                         // Load two modules in separate groups
 187                         array(
 188                                 array( array( 'test.group.foo', 'test.group.bar' ), ResourceLoaderModule::TYPE_COMBINED ),
 189                                 "<script>(window.RLQ = window.RLQ || []).push(function () {\n"
 190                                         . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.bar\u0026skin=fallback");'
 191                                         . "\n} );</script>\n"
 192                                         . "<script>(window.RLQ = window.RLQ || []).push(function () {\n"
 193                                         . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.foo\u0026skin=fallback");'
 194                                         . "\n} );</script>"
 195                         ),
 196                 );
 197                 // @codingStandardsIgnoreEnd
 198         }
 199
 200         /**
 201          * @dataProvider provideMakeResourceLoaderLink
 202          * @covers OutputPage::makeResourceLoaderLink
 203          * @covers ResourceLoader::makeLoaderImplementScript
 204          * @covers ResourceLoader::makeModuleResponse
 205          * @covers ResourceLoader::makeInlineScript
 206          * @covers ResourceLoader::makeLoaderStateScript
 207          * @covers ResourceLoader::createLoaderURL
 208          */
 209         public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
 210                 $this->setMwGlobals( [
 211                         'wgResourceLoaderDebug' => false,
 212                         'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
 213                         // Affects whether CDATA is inserted
 214                         'wgWellFormedXml' => false,
 215                 ] );
 216                 $class = new ReflectionClass( 'OutputPage' );
 217                 $method = $class->getMethod( 'makeResourceLoaderLink' );
 218                 $method->setAccessible( true );
 219                 $ctx = new RequestContext();
 220                 $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
 221                 $ctx->setLanguage( 'en' );
 222                 $out = new OutputPage( $ctx );
 223                 $rl = $out->getResourceLoader();
 224                 $rl->setMessageBlobStore( new NullMessageBlobStore() );
 225                 $rl->register( [
 226                         'test.foo' => new ResourceLoaderTestModule( [
 227                                 'script' => 'mw.test.foo( { a: true } );',
 228                                 'styles' => '.mw-test-foo { content: "style"; }',
 229                         ] ),
 230                         'test.bar' => new ResourceLoaderTestModule( [
 231                                 'script' => 'mw.test.bar( { a: true } );',
 232                                 'styles' => '.mw-test-bar { content: "style"; }',
 233                         ] ),
 234                         'test.baz' => new ResourceLoaderTestModule( [
 235                                 'script' => 'mw.test.baz( { a: true } );',
 236                                 'styles' => '.mw-test-baz { content: "style"; }',
 237                         ] ),
 238                         'test.quux' => new ResourceLoaderTestModule( [
 239                                 'script' => 'mw.test.baz( { token: 123 } );',
 240                                 'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
 241                                 'group' => 'private',
 242                         ] ),
 243                         'test.raw' => new ResourceLoaderTestModule( [
 244                                 'script' => 'mw.test.baz( { token: 123 } );',
 245                                 'isRaw' => true,
 246                         ] ),
 247                         'test.noscript' => new ResourceLoaderTestModule( [
 248                                 'styles' => '.mw-test-noscript { content: "style"; }',
 249                                 'group' => 'noscript',
 250                         ] ),
 251                         'test.group.bar' => new ResourceLoaderTestModule( [
 252                                 'styles' => '.mw-group-bar { content: "style"; }',
 253                                 'group' => 'bar',
 254                         ] ),
 255                         'test.group.foo' => new ResourceLoaderTestModule( [
 256                                 'styles' => '.mw-group-foo { content: "style"; }',
 257                                 'group' => 'foo',
 258                         ] ),
 259                 ] );
 260                 $links = $method->invokeArgs( $out, $args );
 261                 $actualHtml = implode( "\n", $links['html'] );
 262                 $this->assertEquals( $expectedHtml, $actualHtml );
 263         }
 264
 265         /**
 266          * @dataProvider provideVaryHeaders
 267          * @covers OutputPage::addVaryHeader
 268          * @covers OutputPage::getVaryHeader
 269          * @covers OutputPage::getKeyHeader
 270          */
 271         public function testVaryHeaders( $calls, $vary, $key ) {
 272                 // get rid of default Vary fields
 273                 $outputPage = $this->getMockBuilder( 'OutputPage' )
 274                         ->setConstructorArgs( [ new RequestContext() ] )
 275                         ->setMethods( [ 'getCacheVaryCookies' ] )
 276                         ->getMock();
 277                 $outputPage->expects( $this->any() )
 278                         ->method( 'getCacheVaryCookies' )
 279                         ->will( $this->returnValue( [] ) );
 280                 TestingAccessWrapper::newFromObject( $outputPage )->mVaryHeader = [];
 281
 282                 foreach ( $calls as $call ) {
 283                         call_user_func_array( [ $outputPage, 'addVaryHeader' ], $call );
 284                 }
 285                 $this->assertEquals( $vary, $outputPage->getVaryHeader(), 'Vary:' );
 286                 $this->assertEquals( $key, $outputPage->getKeyHeader(), 'Key:' );
 287         }
 288
 289         public function provideVaryHeaders() {
 290                 // note: getKeyHeader() automatically adds Vary: Cookie
 291                 return [
 292                         [ // single header
 293                                 [
 294                                         [ 'Cookie' ],
 295                                 ],
 296                                 'Vary: Cookie',
 297                                 'Key: Cookie',
 298                         ],
 299                         [ // non-unique headers
 300                                 [
 301                                         [ 'Cookie' ],
 302                                         [ 'Accept-Language' ],
 303                                         [ 'Cookie' ],
 304                                 ],
 305                                 'Vary: Cookie, Accept-Language',
 306                                 'Key: Cookie,Accept-Language',
 307                         ],
 308                         [ // two headers with single options
 309                                 [
 310                                         [ 'Cookie', [ 'param=phpsessid' ] ],
 311                                         [ 'Accept-Language', [ 'substr=en' ] ],
 312                                 ],
 313                                 'Vary: Cookie, Accept-Language',
 314                                 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
 315                         ],
 316                         [ // one header with multiple options
 317                                 [
 318                                         [ 'Cookie', [ 'param=phpsessid', 'param=userId' ] ],
 319                                 ],
 320                                 'Vary: Cookie',
 321                                 'Key: Cookie;param=phpsessid;param=userId',
 322                         ],
 323                         [ // Duplicate option
 324                                 [
 325                                         [ 'Cookie', [ 'param=phpsessid' ] ],
 326                                         [ 'Cookie', [ 'param=phpsessid' ] ],
 327                                         [ 'Accept-Language', [ 'substr=en', 'substr=en' ] ],
 328                                 ],
 329                                 'Vary: Cookie, Accept-Language',
 330                                 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
 331                         ],
 332                         [ // Same header, different options
 333                                 [
 334                                         [ 'Cookie', [ 'param=phpsessid' ] ],
 335                                         [ 'Cookie', [ 'param=userId' ] ],
 336                                 ],
 337                                 'Vary: Cookie',
 338                                 'Key: Cookie;param=phpsessid;param=userId',
 339                         ],
 340                 ];
 341         }
 342
 343         /**
 344          * @covers OutputPage::haveCacheVaryCookies
 345          */
 346         function testHaveCacheVaryCookies() {
 347                 $request = new FauxRequest();
 348                 $context = new RequestContext();
 349                 $context->setRequest( $request );
 350                 $outputPage = new OutputPage( $context );
 351
 352                 // No cookies are set.
 353                 $this->assertFalse( $outputPage->haveCacheVaryCookies() );
 354
 355                 // 'Token' is present but empty, so it shouldn't count.
 356                 $request->setCookie( 'Token', '' );
 357                 $this->assertFalse( $outputPage->haveCacheVaryCookies() );
 358
 359                 // 'Token' present and nonempty.
 360                 $request->setCookie( 'Token', '123' );
 361                 $this->assertTrue( $outputPage->haveCacheVaryCookies() );
 362         }
 363 }
 364
 365 /**
 366  * MessageBlobStore that doesn't do anything
 367  */
 368 class NullMessageBlobStore extends MessageBlobStore {
 369         public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
 370                 return [];
 371         }
 372
 373         public function insertMessageBlob( $name, ResourceLoaderModule $module, $lang ) {
 374                 return false;
 375         }
 376
 377         public function updateModule( $name, ResourceLoaderModule $module, $lang ) {
 378         }
 379
 380         public function updateMessage( $key ) {
 381         }
 382
 383         public function clear() {
 384         }
 385 }