use Wikimedia\TestingAccessWrapper;
/**
- * @group Cache
+ * @group ResourceLoader
* @covers MessageBlobStore
*/
class MessageBlobStoreTest extends PHPUnit\Framework\TestCase {
protected function setUp() {
parent::setUp();
- // MediaWiki tests defaults $wgMainWANCache to CACHE_NONE.
- // Use hash instead so that caching is observed
- $this->wanCache = $this->getMockBuilder( WANObjectCache::class )
- ->setConstructorArgs( [ [
- 'cache' => new HashBagOStuff(),
- 'pool' => 'test',
- 'relayer' => new EventRelayerNull( [] )
- ] ] )
- ->setMethods( [ 'makePurgeValue' ] )
- ->getMock();
-
- $this->wanCache->expects( $this->any() )
- ->method( 'makePurgeValue' )
- ->will( $this->returnCallback( function ( $timestamp, $holdoff ) {
- // Disable holdoff as it messes with testing. Aside from a 0-second holdoff,
- // make sure that "time" passes between getMulti() check init and the set()
- // in recacheMessageBlob(). This especially matters for Windows clocks.
- $ts = (float)$timestamp - 0.0001;
-
- return WANObjectCache::PURGE_VAL_PREFIX . $ts . ':0';
- } ) );
- }
-
- protected function makeBlobStore( $methods = null, $rl = null ) {
- $blobStore = $this->getMockBuilder( MessageBlobStore::class )
- ->setConstructorArgs( [ $rl ?? $this->createMock( ResourceLoader::class ) ] )
- ->setMethods( $methods )
- ->getMock();
-
- $access = TestingAccessWrapper::newFromObject( $blobStore );
- $access->wanCache = $this->wanCache;
- return $blobStore;
- }
-
- protected function makeModule( array $messages ) {
- $module = new ResourceLoaderTestModule( [ 'messages' => $messages ] );
- $module->setName( 'test.blobstore' );
- return $module;
- }
-
- /** @covers MessageBlobStore::setLogger */
- public function testSetLogger() {
- $blobStore = $this->makeBlobStore();
- $this->assertSame( null, $blobStore->setLogger( new Psr\Log\NullLogger() ) );
- }
-
- /** @covers MessageBlobStore::getResourceLoader */
- public function testGetResourceLoader() {
- // Call protected method
- $blobStore = TestingAccessWrapper::newFromObject( $this->makeBlobStore() );
- $this->assertInstanceOf(
- ResourceLoader::class,
- $blobStore->getResourceLoader()
- );
+ // MediaWiki's test wrapper sets $wgMainWANCache to CACHE_NONE.
+ // Use HashBagOStuff here so that we can observe caching.
+ $this->wanCache = new WANObjectCache( [
+ 'cache' => new HashBagOStuff()
+ ] );
+
+ $this->clock = 1301655600.000;
+ $this->wanCache->setMockTime( $this->clock );
}
- /** @covers MessageBlobStore::fetchMessage */
- public function testFetchMessage() {
+ public function testBlobCreation() {
$module = $this->makeModule( [ 'mainpage' ] );
- $rl = new ResourceLoader();
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
$blobStore = $this->makeBlobStore( null, $rl );
$this->assertEquals( '{"mainpage":"Main Page"}', $blob, 'Generated blob' );
}
- /** @covers MessageBlobStore::fetchMessage */
- public function testFetchMessageFail() {
- $module = $this->makeModule( [ 'i-dont-exist' ] );
- $rl = new ResourceLoader();
+ public function testBlobCreation_empty() {
+ $module = $this->makeModule( [] );
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
$blobStore = $this->makeBlobStore( null, $rl );
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"i-dont-exist":"\u29fci-dont-exist\u29fd"}', $blob, 'Generated blob' );
+ $this->assertEquals( '{}', $blob, 'Generated blob' );
}
- public function testGetBlob() {
- $module = $this->makeModule( [ 'foo' ] );
- $rl = new ResourceLoader();
+ public function testBlobCreation_unknownMessage() {
+ $module = $this->makeModule( [ 'i-dont-exist', 'mainpage', 'i-dont-exist2' ] );
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
+ $blobStore = $this->makeBlobStore( null, $rl );
- $blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
- $blobStore->expects( $this->once() )
- ->method( 'fetchMessage' )
- ->will( $this->returnValue( 'Example' ) );
-
+ // Generating a blob should continue without errors,
+ // with keys of unknown messages excluded from the blob.
$blob = $blobStore->getBlob( $module, 'en' );
-
- $this->assertEquals( '{"foo":"Example"}', $blob, 'Generated blob' );
+ $this->assertEquals( '{"mainpage":"Main Page"}', $blob, 'Generated blob' );
}
- public function testGetBlobCached() {
+ public function testMessageCachingAndPurging() {
$module = $this->makeModule( [ 'example' ] );
- $rl = new ResourceLoader();
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
-
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
+
+ // Advance this new WANObjectCache instance to a normal state,
+ // by doing one "get" and letting its hold off period expire.
+ // Without this, the first real "get" would lazy-initialise the
+ // checkKey and thus reject the first "set".
+ $blobStore->getBlob( $module, 'en' );
+ $this->clock += 20;
+
+ // Arrange version 1 of a message
$blobStore->expects( $this->once() )
->method( 'fetchMessage' )
- ->will( $this->returnValue( 'First' ) );
+ ->will( $this->returnValue( 'First version' ) );
- $module = $this->makeModule( [ 'example' ] );
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"First"}', $blob, 'Generated blob' );
+ $this->assertEquals( '{"example":"First version"}', $blob, 'Blob for v1' );
+ // Arrange version 2
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
- $blobStore->expects( $this->never() )
+ $blobStore->expects( $this->once() )
->method( 'fetchMessage' )
- ->will( $this->returnValue( 'Second' ) );
+ ->will( $this->returnValue( 'Second version' ) );
+ $this->clock += 20;
- $module = $this->makeModule( [ 'example' ] );
+ // Assert
+ // We do not validate whether a cached message is up-to-date.
+ // Instead, changes to messages will send us a purge.
+ // When cache is not purged or expired, it must be used.
+ $blob = $blobStore->getBlob( $module, 'en' );
+ $this->assertEquals( '{"example":"First version"}', $blob, 'Reuse cached v1 blob' );
+
+ // Purge cache
+ $blobStore->updateMessage( 'example' );
+ $this->clock += 20;
+
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"First"}', $blob, 'Cache hit' );
+ $this->assertEquals( '{"example":"Second version"}', $blob, 'Updated blob for v2' );
}
- public function testUpdateMessage() {
+ public function testPurgeEverything() {
$module = $this->makeModule( [ 'example' ] );
- $rl = new ResourceLoader();
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
- $blobStore->expects( $this->once() )
+ // Advance this new WANObjectCache instance to a normal state.
+ $blobStore->getBlob( $module, 'en' );
+ $this->clock += 20;
+
+ // Arrange version 1 and 2
+ $blobStore->expects( $this->exactly( 2 ) )
->method( 'fetchMessage' )
- ->will( $this->returnValue( 'First' ) );
+ ->will( $this->onConsecutiveCalls( 'First', 'Second' ) );
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"First"}', $blob, 'Generated blob' );
+ $this->assertEquals( '{"example":"First"}', $blob, 'Blob for v1' );
- $blobStore->updateMessage( 'example' );
+ $this->clock += 20;
- $module = $this->makeModule( [ 'example' ] );
- $rl = new ResourceLoader();
- $rl->register( $module->getName(), $module );
- $blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
- $blobStore->expects( $this->once() )
- ->method( 'fetchMessage' )
- ->will( $this->returnValue( 'Second' ) );
+ // Assert
+ $blob = $blobStore->getBlob( $module, 'en' );
+ $this->assertEquals( '{"example":"First"}', $blob, 'Blob for v1 again' );
+ // Purge everything
+ $blobStore->clear();
+ $this->clock += 20;
+
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"Second"}', $blob, 'Updated blob' );
+ $this->assertEquals( '{"example":"Second"}', $blob, 'Blob for v2' );
}
- public function testValidation() {
+ public function testValidateAgainstModuleRegistry() {
+ // Arrange version 1 of a module
$module = $this->makeModule( [ 'foo' ] );
- $rl = new ResourceLoader();
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
-
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
$blobStore->expects( $this->once() )
->method( 'fetchMessage' )
->will( $this->returnValueMap( [
+ // message key, language code, message value
[ 'foo', 'en', 'Hello' ],
] ) );
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"foo":"Hello"}', $blob, 'Generated blob' );
+ $this->assertEquals( '{"foo":"Hello"}', $blob, 'Blob for v1' );
- // Now, imagine a change to the module is deployed. The module now contains
- // message 'foo' and 'bar'. While updateMessage() was not called (since no
- // message values were changed) it should detect the change in list of
- // message keys.
+ // Arrange version 2 of module
+ // While message values may be out of date, the set of messages returned
+ // must always match the set of message keys required by the module.
+ // We do not receive purges for this because no messages were changed.
$module = $this->makeModule( [ 'foo', 'bar' ] );
- $rl = new ResourceLoader();
+ $rl = new EmptyResourceLoader();
$rl->register( $module->getName(), $module );
-
$blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
$blobStore->expects( $this->exactly( 2 ) )
->method( 'fetchMessage' )
->will( $this->returnValueMap( [
+ // message key, language code, message value
[ 'foo', 'en', 'Hello' ],
[ 'bar', 'en', 'World' ],
] ) );
+ // Assert
$blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"foo":"Hello","bar":"World"}', $blob, 'Updated blob' );
+ $this->assertEquals( '{"foo":"Hello","bar":"World"}', $blob, 'Blob for v2' );
}
- public function testClear() {
- $module = $this->makeModule( [ 'example' ] );
- $rl = new ResourceLoader();
- $rl->register( $module->getName(), $module );
- $blobStore = $this->makeBlobStore( [ 'fetchMessage' ], $rl );
- $blobStore->expects( $this->exactly( 2 ) )
- ->method( 'fetchMessage' )
- ->will( $this->onConsecutiveCalls( 'First', 'Second' ) );
-
- $now = microtime( true );
- $this->wanCache->setMockTime( $now );
-
- $blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"First"}', $blob, 'Generated blob' );
+ public function testSetLoggedIsVoid() {
+ $blobStore = $this->makeBlobStore();
+ $this->assertSame( null, $blobStore->setLogger( new Psr\Log\NullLogger() ) );
+ }
- $blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"First"}', $blob, 'Cache-hit' );
+ private function makeBlobStore( $methods = null, $rl = null ) {
+ $blobStore = $this->getMockBuilder( MessageBlobStore::class )
+ ->setConstructorArgs( [ $rl ?? $this->createMock( ResourceLoader::class ) ] )
+ ->setMethods( $methods )
+ ->getMock();
- $now += 1;
- $blobStore->clear();
+ $access = TestingAccessWrapper::newFromObject( $blobStore );
+ $access->wanCache = $this->wanCache;
+ return $blobStore;
+ }
- $blob = $blobStore->getBlob( $module, 'en' );
- $this->assertEquals( '{"example":"Second"}', $blob, 'Updated blob' );
+ private function makeModule( array $messages ) {
+ $module = new ResourceLoaderTestModule( [ 'messages' => $messages ] );
+ $module->setName( 'test.blobstore' );
+ return $module;
}
}
dépôts / lhc / web / wiklou.git / blobdiff