wiki.techinc.nl/tests/phpunit/includes/resourceloader/DerivativeResourceLoaderContextTest.php
Brad Jorsch 3f1142045f Generalize ResourceLoader 'excludepage' functionality
There has long been a hack for previewing edits to user JS/CSS, where
OutputPage would pass an 'excludepage' parameter to
ResourceLoaderUserModule to tell it not to load one particular page and
would instead embed that page statically. That's nice, but there are
other places where we could use the same thing.

This patch generalizes it:
* DerivativeResourceLoaderContext may now contain a callback for mapping
  titles to replacement Content objects.
* ResourceLoaderWikiModule::getContent() uses the overrides, and
  requests embedding when they're used. All subclasses in Gerrit should
  pick it up automatically.
* OutputPage gains methods for callers to add to the override mapping,
  which it passes on to RL. It loses a bunch of the special casing it
  had for the 'user' and 'user.styles' modules.
* EditPage sets the overrides on OutputPage when doing the preview, as
  does ApiParse for prop=headhtml. TemplateSandbox does too in I83fa0856.
* OutputPage::userCanPreview() gets less specific to editing user CSS
  and JS, since RL now handles the embedding based on the actual
  modules' dependencies and EditPage only requests it on preview.

ApiParse also gets a new hook to support TemplateSandbox's API
integration (used in I83fa0856).

Bug: T112474
Change-Id: Ib9d2ce42931c1de8372e231314a1f672d7e2ac0e
2018-04-25 00:37:08 +00:00

143 lines
4.3 KiB
PHP

<?php
/**
* @group ResourceLoader
* @covers DerivativeResourceLoaderContext
*/
class DerivativeResourceLoaderContextTest extends PHPUnit\Framework\TestCase {
use MediaWikiCoversValidator;
protected static function getContext() {
$request = new FauxRequest( [
'lang' => 'zh',
'modules' => 'test.context',
'only' => 'scripts',
'skin' => 'fallback',
'target' => 'test',
] );
return new ResourceLoaderContext( new ResourceLoader(), $request );
}
public function testGetInherited() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
// Request parameters
$this->assertEquals( $derived->getDebug(), false );
$this->assertEquals( $derived->getLanguage(), 'zh' );
$this->assertEquals( $derived->getModules(), [ 'test.context' ] );
$this->assertEquals( $derived->getOnly(), 'scripts' );
$this->assertEquals( $derived->getSkin(), 'fallback' );
$this->assertEquals( $derived->getUser(), null );
// Misc
$this->assertEquals( $derived->getDirection(), 'ltr' );
$this->assertEquals( $derived->getHash(), 'zh|fallback|||scripts|||||' );
}
public function testModules() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setModules( [ 'test.override' ] );
$this->assertEquals( $derived->getModules(), [ 'test.override' ] );
}
public function testLanguage() {
$context = self::getContext();
$derived = new DerivativeResourceLoaderContext( $context );
$derived->setLanguage( 'nl' );
$this->assertEquals( $derived->getLanguage(), 'nl' );
}
public function testDirection() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setLanguage( 'nl' );
$this->assertEquals( $derived->getDirection(), 'ltr' );
$derived->setLanguage( 'he' );
$this->assertEquals( $derived->getDirection(), 'rtl' );
$derived->setDirection( 'ltr' );
$this->assertEquals( $derived->getDirection(), 'ltr' );
}
public function testSkin() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setSkin( 'override' );
$this->assertEquals( $derived->getSkin(), 'override' );
}
public function testUser() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setUser( 'Example' );
$this->assertEquals( $derived->getUser(), 'Example' );
}
public function testDebug() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setDebug( true );
$this->assertEquals( $derived->getDebug(), true );
}
public function testOnly() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setOnly( 'styles' );
$this->assertEquals( $derived->getOnly(), 'styles' );
$derived->setOnly( null );
$this->assertEquals( $derived->getOnly(), null );
}
public function testVersion() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setVersion( 'hw1' );
$this->assertEquals( $derived->getVersion(), 'hw1' );
}
public function testRaw() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$derived->setRaw( true );
$this->assertEquals( $derived->getRaw(), true );
}
public function testGetHash() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$this->assertEquals( $derived->getHash(), 'zh|fallback|||scripts|||||' );
$derived->setLanguage( 'nl' );
$derived->setUser( 'Example' );
// Assert that subclass is able to clear parent class "hash" member
$this->assertEquals( $derived->getHash(), 'nl|fallback||Example|scripts|||||' );
}
public function testContentOverrides() {
$derived = new DerivativeResourceLoaderContext( self::getContext() );
$this->assertNull( $derived->getContentOverrideCallback() );
$override = function ( Title $t ) {
return null;
};
$derived->setContentOverrideCallback( $override );
$this->assertSame( $override, $derived->getContentOverrideCallback() );
$derived2 = new DerivativeResourceLoaderContext( $derived );
$this->assertSame( $override, $derived2->getContentOverrideCallback() );
}
public function testAccessors() {
$context = self::getContext();
$derived = new DerivativeResourceLoaderContext( $context );
$this->assertSame( $derived->getRequest(), $context->getRequest() );
$this->assertSame( $derived->getResourceLoader(), $context->getResourceLoader() );
}
}