4de7250830
This reverts commit bc200b6a1a reapplying
the patch. It has been modified slightly to temporarily work
with the beta cluster's unsupported configuration.
Bug: T207038
Change-Id: Ie86a5b59fbf93a400796a4cac3724207830092b5
655 lines
16 KiB
PHP
655 lines
16 KiB
PHP
<?php
|
|
|
|
use Wikimedia\TestingAccessWrapper;
|
|
|
|
/**
|
|
* @group ResourceLoader
|
|
*/
|
|
class ResourceLoaderSkinModuleTest extends ResourceLoaderTestCase {
|
|
public static function provideApplyFeaturesCompatibility() {
|
|
return [
|
|
[
|
|
[
|
|
'content-thumbnails' => true,
|
|
],
|
|
[
|
|
'content-media' => true,
|
|
],
|
|
'The `content-thumbnails` feature is mapped to `content-media`.'
|
|
],
|
|
[
|
|
[
|
|
'content-parser-output' => true,
|
|
],
|
|
[
|
|
'content-body' => true,
|
|
],
|
|
'The new `content-parser-output` module was renamed to `content-body`.'
|
|
],
|
|
[
|
|
[
|
|
'content' => true,
|
|
],
|
|
[
|
|
'content-media' => true,
|
|
],
|
|
'The `content` feature is mapped to `content-media`.'
|
|
],
|
|
[
|
|
[
|
|
'content-links' => true,
|
|
],
|
|
[
|
|
'content-links-external' => true,
|
|
'content-links' => true,
|
|
],
|
|
'The `content-links` feature will also enable `content-links-external` if it not specified.'
|
|
],
|
|
[
|
|
[
|
|
'element' => true,
|
|
],
|
|
[
|
|
'element' => true,
|
|
'content-links' => true,
|
|
],
|
|
'The `element` feature will turn on `content-links` if not specified.'
|
|
],
|
|
[
|
|
[
|
|
'content-links-external' => false,
|
|
'content-links' => true,
|
|
],
|
|
[
|
|
'content-links-external' => false,
|
|
'content-links' => true,
|
|
],
|
|
'The `content-links` feature has no impact on content-links-external value.'
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideApplyFeaturesCompatibility
|
|
* @covers ResourceLoaderSkinModule::applyFeaturesCompatibility
|
|
*/
|
|
public function testApplyFeaturesCompatibility( array $features, array $expected, $msg ) {
|
|
// Test protected method
|
|
$class = TestingAccessWrapper::newFromClass( ResourceLoaderSkinModule::class );
|
|
$actual = $class->applyFeaturesCompatibility( $features );
|
|
$this->assertEquals( $expected, $actual, $msg );
|
|
}
|
|
|
|
public static function provideGetAvailableLogos() {
|
|
return [
|
|
[
|
|
[
|
|
'Logos' => [],
|
|
'Logo' => '/logo.png',
|
|
],
|
|
[
|
|
'1x' => '/logo.png',
|
|
]
|
|
],
|
|
[
|
|
[
|
|
'Logos' => [
|
|
'svg' => '/logo.svg',
|
|
'2x' => 'logo-2x.png'
|
|
],
|
|
'Logo' => '/logo.png',
|
|
],
|
|
[
|
|
'svg' => '/logo.svg',
|
|
'2x' => 'logo-2x.png',
|
|
'1x' => '/logo.png',
|
|
]
|
|
],
|
|
[
|
|
[
|
|
'Logos' => [
|
|
'wordmark' => [
|
|
'src' => '/logo-wordmark.png',
|
|
'width' => 100,
|
|
'height' => 15,
|
|
],
|
|
'1x' => '/logo.png',
|
|
'svg' => '/logo.svg',
|
|
'2x' => 'logo-2x.png'
|
|
],
|
|
],
|
|
[
|
|
'wordmark' => [
|
|
'src' => '/logo-wordmark.png',
|
|
'width' => 100,
|
|
'height' => 15,
|
|
'style' => 'width: 6.25em; height: 0.9375em;',
|
|
],
|
|
'1x' => '/logo.png',
|
|
'svg' => '/logo.svg',
|
|
'2x' => 'logo-2x.png',
|
|
]
|
|
]
|
|
];
|
|
}
|
|
|
|
public static function provideGetStyles() {
|
|
// phpcs:disable Generic.Files.LineLength
|
|
return [
|
|
[
|
|
'parent' => [],
|
|
'logo' => '/logo.png',
|
|
'expected' => [
|
|
'all' => [ '.mw-wiki-logo { background-image: url(/logo.png); }' ],
|
|
],
|
|
],
|
|
[
|
|
'parent' => [
|
|
'screen' => '.example {}',
|
|
],
|
|
'logo' => '/logo.png',
|
|
'expected' => [
|
|
'screen' => [ '.example {}' ],
|
|
'all' => [ '.mw-wiki-logo { background-image: url(/logo.png); }' ],
|
|
],
|
|
],
|
|
[
|
|
'parent' => [],
|
|
'logo' => [
|
|
'1x' => '/logo.png',
|
|
'1.5x' => '/logo@1.5x.png',
|
|
'2x' => '/logo@2x.png',
|
|
],
|
|
'expected' => [
|
|
'all' => [ <<<CSS
|
|
.mw-wiki-logo { background-image: url(/logo.png); }
|
|
CSS
|
|
],
|
|
'(-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (min-resolution: 1.5dppx), (min-resolution: 144dpi)' => [ <<<CSS
|
|
.mw-wiki-logo { background-image: url(/logo@1.5x.png);background-size: 135px auto; }
|
|
CSS
|
|
],
|
|
'(-webkit-min-device-pixel-ratio: 2), (min--moz-device-pixel-ratio: 2), (min-resolution: 2dppx), (min-resolution: 192dpi)' => [ <<<CSS
|
|
.mw-wiki-logo { background-image: url(/logo@2x.png);background-size: 135px auto; }
|
|
CSS
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'parent' => [],
|
|
'logo' => [
|
|
'1x' => '/logo.png',
|
|
'svg' => '/logo.svg',
|
|
],
|
|
'expected' => [
|
|
'all' => [ <<<CSS
|
|
.mw-wiki-logo { background-image: url(/logo.png); }
|
|
CSS
|
|
, <<<CSS
|
|
.mw-wiki-logo { background-image: -webkit-linear-gradient(transparent, transparent), url(/logo.svg); background-image: linear-gradient(transparent, transparent), url(/logo.svg);background-size: 135px auto; }
|
|
CSS
|
|
],
|
|
],
|
|
],
|
|
];
|
|
// phpcs:enable
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGetStyles
|
|
* @covers ResourceLoaderSkinModule
|
|
*/
|
|
public function testGetStyles( $parent, $logo, $expected ) {
|
|
$module = $this->getMockBuilder( ResourceLoaderSkinModule::class )
|
|
->onlyMethods( [ 'readStyleFiles', 'getLogoData' ] )
|
|
->getMock();
|
|
$module->expects( $this->once() )->method( 'readStyleFiles' )
|
|
->willReturn( $parent );
|
|
$module->expects( $this->once() )->method( 'getLogoData' )
|
|
->willReturn( $logo );
|
|
$module->setConfig( new HashConfig( [
|
|
'ParserEnableLegacyMediaDOM' => false,
|
|
] + self::getSettings() ) );
|
|
|
|
$ctx = $this->getMockBuilder( ResourceLoaderContext::class )
|
|
->disableOriginalConstructor()->getMock();
|
|
|
|
$this->assertEquals(
|
|
$expected,
|
|
$module->getStyles( $ctx )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGetAvailableLogos
|
|
* @covers ResourceLoaderSkinModule::getAvailableLogos
|
|
*/
|
|
public function testGetAvailableLogos( $config, $expected ) {
|
|
$logos = ResourceLoaderSkinModule::getAvailableLogos( new HashConfig( $config ) );
|
|
$this->assertSame( $logos, $expected );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule::getAvailableLogos
|
|
*/
|
|
public function testGetAvailableLogosRuntimeException() {
|
|
$this->expectException( \RuntimeException::class );
|
|
ResourceLoaderSkinModule::getAvailableLogos( new HashConfig( [
|
|
'Logo' => false,
|
|
'Logos' => false,
|
|
'LogoHD' => false,
|
|
] ) );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule::isKnownEmpty
|
|
*/
|
|
public function testIsKnownEmpty() {
|
|
$module = $this->getMockBuilder( ResourceLoaderSkinModule::class )
|
|
->disableOriginalConstructor()->onlyMethods( [] )->getMock();
|
|
$ctx = $this->getMockBuilder( ResourceLoaderContext::class )
|
|
->disableOriginalConstructor()->getMock();
|
|
|
|
$this->assertFalse( $module->isKnownEmpty( $ctx ) );
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGetLogoData
|
|
* @covers ResourceLoaderSkinModule::getLogoData
|
|
*/
|
|
public function testGetLogoData( $config, $expected, $baseDir = null ) {
|
|
if ( $baseDir ) {
|
|
$this->setMwGlobals( 'IP', $baseDir );
|
|
}
|
|
// Allow testing of protected method
|
|
$module = TestingAccessWrapper::newFromObject( new ResourceLoaderSkinModule() );
|
|
|
|
$this->assertEquals(
|
|
$expected,
|
|
$module->getLogoData( new HashConfig( $config ) )
|
|
);
|
|
}
|
|
|
|
public function provideGetLogoData() {
|
|
return [
|
|
'wordmark' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'wordmark' => [
|
|
'src' => '/img/wordmark.png',
|
|
'width' => 120,
|
|
'height' => 20,
|
|
],
|
|
],
|
|
],
|
|
'expected' => '/img/default.png',
|
|
],
|
|
'simple' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
],
|
|
],
|
|
'expected' => '/img/default.png',
|
|
],
|
|
'default and 2x' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'expected' => [
|
|
'1x' => '/img/default.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'default and all HiDPIs' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'1.5x' => '/img/one-point-five.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'expected' => [
|
|
'1x' => '/img/default.png',
|
|
'1.5x' => '/img/one-point-five.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'default and SVG' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'svg' => '/img/vector.svg',
|
|
],
|
|
],
|
|
'expected' => [
|
|
'1x' => '/img/default.png',
|
|
'svg' => '/img/vector.svg',
|
|
],
|
|
],
|
|
'everything' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'1.5x' => '/img/one-point-five.png',
|
|
'2x' => '/img/two-x.png',
|
|
'svg' => '/img/vector.svg',
|
|
],
|
|
],
|
|
'expected' => [
|
|
'1x' => '/img/default.png',
|
|
'svg' => '/img/vector.svg',
|
|
],
|
|
],
|
|
'versioned url' => [
|
|
'config' => [
|
|
'ResourceBasePath' => '/w',
|
|
'UploadPath' => '/w/images',
|
|
'Logos' => [
|
|
'1x' => '/w/test.jpg',
|
|
],
|
|
],
|
|
'expected' => '/w/test.jpg?edcf2',
|
|
'baseDir' => dirname( dirname( __DIR__ ) ) . '/data/media',
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providePreloadLinks
|
|
* @covers ResourceLoaderSkinModule::getPreloadLinks
|
|
* @covers ResourceLoaderSkinModule::getLogoPreloadlinks
|
|
* @covers ResourceLoaderSkinModule::getLogoData
|
|
*/
|
|
public function testPreloadLinkHeaders( $config, $installPath, $result ) {
|
|
$this->setMwGlobals( [ 'IP' => $installPath ] );
|
|
$ctx = $this->getMockBuilder( ResourceLoaderContext::class )
|
|
->disableOriginalConstructor()->getMock();
|
|
$module = new ResourceLoaderSkinModule();
|
|
$module->setConfig( new HashConfig( $config + self::getSettings() ) );
|
|
|
|
$this->assertEquals( [ $result ], $module->getHeaders( $ctx ) );
|
|
}
|
|
|
|
public function providePreloadLinks() {
|
|
return [
|
|
[
|
|
[
|
|
'ResourceBasePath' => '/w',
|
|
'Logo' => false,
|
|
'LogoHD' => false,
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'1.5x' => '/img/one-point-five.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'/dummy',
|
|
'Link: </img/default.png>;rel=preload;as=image;media=' .
|
|
'not all and (min-resolution: 1.5dppx),' .
|
|
'</img/one-point-five.png>;rel=preload;as=image;media=' .
|
|
'(min-resolution: 1.5dppx) and (max-resolution: 1.999999dppx),' .
|
|
'</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
|
|
],
|
|
[
|
|
[
|
|
'ResourceBasePath' => '/w',
|
|
'Logo' => false,
|
|
'LogoHD' => false,
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
],
|
|
],
|
|
'/dummy',
|
|
'Link: </img/default.png>;rel=preload;as=image'
|
|
],
|
|
[
|
|
[
|
|
'ResourceBasePath' => '/w',
|
|
'Logo' => false,
|
|
'LogoHD' => false,
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'2x' => '/img/two-x.png',
|
|
],
|
|
],
|
|
'/dummy',
|
|
'Link: </img/default.png>;rel=preload;as=image;media=' .
|
|
'not all and (min-resolution: 2dppx),' .
|
|
'</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
|
|
],
|
|
[
|
|
[
|
|
'ResourceBasePath' => '/w',
|
|
'Logo' => false,
|
|
'LogoHD' => false,
|
|
'Logos' => [
|
|
'1x' => '/img/default.png',
|
|
'svg' => '/img/vector.svg',
|
|
],
|
|
],
|
|
'/dummy',
|
|
'Link: </img/vector.svg>;rel=preload;as=image'
|
|
|
|
],
|
|
[
|
|
[
|
|
'ResourceBasePath' => '/w',
|
|
'Logo' => false,
|
|
'LogoHD' => false,
|
|
'Logos' => [
|
|
'1x' => '/w/test.jpg',
|
|
],
|
|
'UploadPath' => '/w/images',
|
|
],
|
|
dirname( dirname( __DIR__ ) ) . '/data/media',
|
|
'Link: </w/test.jpg?edcf2>;rel=preload;as=image',
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule::getPreloadLinks
|
|
*/
|
|
public function testNoPreloadLogos() {
|
|
$module = new ResourceLoaderSkinModule( [ 'features' => [ 'logo' => false ] ] );
|
|
$context =
|
|
$this->getMockBuilder( ResourceLoaderContext::class )
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
$preloadLinks = $module->getPreloadLinks( $context );
|
|
$this->assertArrayEquals( [], $preloadLinks );
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule::getPreloadLinks
|
|
*/
|
|
public function testPreloadLogos() {
|
|
$module = new ResourceLoaderSkinModule();
|
|
$module->setConfig( self::getMinimalConfig() );
|
|
$context = $this->getMockBuilder( ResourceLoaderContext::class )
|
|
->disableOriginalConstructor()->getMock();
|
|
|
|
$preloadLinks = $module->getPreloadLinks( $context );
|
|
$this->assertNotSameSize( [], $preloadLinks );
|
|
}
|
|
|
|
/**
|
|
* Covers ResourceLoaderSkinModule::FEATURE_FILES, but not annotatable.
|
|
*
|
|
* @dataProvider provideFeatureFiles
|
|
* @coversNothing
|
|
*
|
|
* @param string $file
|
|
*/
|
|
public function testFeatureFilesExist( string $file ): void {
|
|
$this->assertFileExists( $file );
|
|
}
|
|
|
|
public function provideFeatureFiles(): Generator {
|
|
global $IP;
|
|
|
|
$featureFiles = ( new ReflectionClass( ResourceLoaderSkinModule::class ) )
|
|
->getConstant( 'FEATURE_FILES' );
|
|
|
|
foreach ( $featureFiles as $feature => $files ) {
|
|
foreach ( $files as $media => $stylesheets ) {
|
|
foreach ( $stylesheets as $stylesheet ) {
|
|
yield "$feature: $media: $stylesheet" => [ "$IP/$stylesheet" ];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public static function provideGetStyleFilesFeatureStylesOrder() {
|
|
global $IP;
|
|
$featureFiles = ( new ReflectionClass( ResourceLoaderSkinModule::class ) )
|
|
->getConstant( 'FEATURE_FILES' );
|
|
|
|
$normalizePath = new ResourceLoaderFilePath(
|
|
$featureFiles['normalize']['all'][0],
|
|
$IP,
|
|
'/w'
|
|
);
|
|
$elementsPath = new ResourceLoaderFilePath(
|
|
$featureFiles['elements']['screen'][0],
|
|
$IP,
|
|
'/w'
|
|
);
|
|
$cbPath = new ResourceLoaderFilePath(
|
|
$featureFiles['content-body']['screen'][0],
|
|
$IP,
|
|
'/w'
|
|
);
|
|
|
|
return [
|
|
[
|
|
[ 'elements', 'normalize' ],
|
|
[
|
|
'test.styles/styles.css' => [
|
|
'media' => 'screen'
|
|
]
|
|
],
|
|
[ $normalizePath ],
|
|
[ $elementsPath, 'test.styles/styles.css' ],
|
|
'opt-out by default policy results in correct order'
|
|
],
|
|
[
|
|
[
|
|
'content-body' => false,
|
|
'elements' => true,
|
|
'normalize' => true,
|
|
'toc' => false,
|
|
],
|
|
[
|
|
'test.styles/styles.css' => [
|
|
'media' => 'screen'
|
|
]
|
|
],
|
|
[ $normalizePath ],
|
|
[ $elementsPath, 'test.styles/styles.css' ],
|
|
'opt-in by default policy results in correct order'
|
|
],
|
|
|
|
[
|
|
[ 'content-parser-output' ],
|
|
[ 'test.styles/all.css' ],
|
|
[
|
|
$cbPath
|
|
],
|
|
[
|
|
'test.styles/all.css'
|
|
],
|
|
'content-parser-output mapped to content-body styles'
|
|
],
|
|
|
|
[
|
|
[ 'normalize' ],
|
|
[ 'test.styles/styles.css' => [ 'media' => 'screen' ] ],
|
|
[ $normalizePath ],
|
|
[ 'test.styles/styles.css' ],
|
|
'module provided styles come after skin defined'
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule::getStyleFiles
|
|
* @dataProvider provideGetStyleFilesFeatureStylesOrder
|
|
* @param array $features
|
|
* @param array $styles
|
|
* @param array $expectedAllStyles array of styles
|
|
* @param array $expectedScreenStyles array of styles
|
|
* @param string $msg to show for debugging
|
|
*/
|
|
public function testGetStyleFilesFeatureStylesOrder(
|
|
$features, $styles, $expectedAllStyles, $expectedScreenStyles, $msg
|
|
): void {
|
|
$ctx = $this->createMock( ResourceLoaderContext::class );
|
|
$module = new ResourceLoaderSkinModule(
|
|
[
|
|
// The ordering should be controlled by ResourceLoaderSkinModule
|
|
// `normalize` will be outputted before `elements` despite the ordering
|
|
'features' => $features,
|
|
'styles' => $styles,
|
|
]
|
|
);
|
|
$module->setConfig( self::getMinimalConfig() );
|
|
|
|
$expected = [
|
|
'all' => $expectedAllStyles,
|
|
'screen' => $expectedScreenStyles,
|
|
];
|
|
|
|
$actual = $module->getStyleFiles( $ctx );
|
|
unset( $actual['print'] ); // not testing print for now
|
|
$this->assertEquals(
|
|
array_values( $expected ),
|
|
array_values( $actual )
|
|
);
|
|
}
|
|
|
|
public static function provideInvalidFeatures() {
|
|
yield 'listed unknown' => [
|
|
[ 'logo', 'unknown' ],
|
|
];
|
|
|
|
yield 'enabled unknown' => [
|
|
[
|
|
'logo' => true,
|
|
'toc' => false,
|
|
'unknown' => true,
|
|
],
|
|
];
|
|
|
|
yield 'disbled unknown' => [
|
|
[
|
|
'logo' => true,
|
|
'toc' => false,
|
|
'unknown' => false,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @covers ResourceLoaderSkinModule
|
|
* @dataProvider provideInvalidFeatures
|
|
*/
|
|
public function testConstructInvalidFeatures( array $features ) {
|
|
$this->expectException( InvalidArgumentException::class );
|
|
$this->expectExceptionMessage( "Feature 'unknown' is not recognised" );
|
|
$module = new ResourceLoaderSkinModule( [
|
|
'features' => $features,
|
|
] );
|
|
}
|
|
}
|