3 namespace MediaWiki\Tests\Storage
;
8 use MediaWiki\Storage\NameTableAccessException
;
9 use MediaWiki\Storage\NameTableStore
;
10 use MediaWikiTestCase
;
11 use Psr\Log\NullLogger
;
13 use Wikimedia\Rdbms\Database
;
14 use Wikimedia\Rdbms\LoadBalancer
;
15 use Wikimedia\TestingAccessWrapper
;
20 * @covers \MediaWiki\Storage\NameTableStore
22 class NameTableStoreTest
extends MediaWikiTestCase
{
24 public function setUp() {
25 $this->tablesUsed
[] = 'slot_roles';
29 protected function addCoreDBData() {
30 // The default implementation causes the slot_roles to already have content. Skip that.
33 private function populateTable( $values ) {
35 foreach ( $values as $name ) {
36 $insertValues[] = [ 'role_name' => $name ];
38 $this->db
->insert( 'slot_roles', $insertValues );
41 private function getHashWANObjectCache( $cacheBag ) {
42 return new WANObjectCache( [ 'cache' => $cacheBag ] );
47 * @return \PHPUnit_Framework_MockObject_MockObject|LoadBalancer
49 private function getMockLoadBalancer( $db ) {
50 $mock = $this->getMockBuilder( LoadBalancer
::class )
51 ->disableOriginalConstructor()
53 $mock->expects( $this->any() )
54 ->method( 'getConnection' )
59 private function getCallCheckingDb( $insertCalls, $selectCalls ) {
60 $mock = $this->getMockBuilder( Database
::class )
61 ->disableOriginalConstructor()
63 $mock->expects( $this->exactly( $insertCalls ) )
65 ->willReturnCallback( function () {
66 return call_user_func_array( [ $this->db
, 'insert' ], func_get_args() );
68 $mock->expects( $this->exactly( $selectCalls ) )
70 ->willReturnCallback( function () {
71 return call_user_func_array( [ $this->db
, 'select' ], func_get_args() );
73 $mock->expects( $this->exactly( $insertCalls ) )
74 ->method( 'affectedRows' )
75 ->willReturnCallback( function () {
76 return call_user_func_array( [ $this->db
, 'affectedRows' ], func_get_args() );
78 $mock->expects( $this->any() )
79 ->method( 'insertId' )
80 ->willReturnCallback( function () {
81 return call_user_func_array( [ $this->db
, 'insertId' ], func_get_args() );
86 private function getNameTableSqlStore(
90 $normalizationCallback = null,
91 $insertCallback = null
93 return new NameTableStore(
94 $this->getMockLoadBalancer( $this->getCallCheckingDb( $insertCalls, $selectCalls ) ),
95 $this->getHashWANObjectCache( $cacheBag ),
97 'slot_roles', 'role_id', 'role_name',
98 $normalizationCallback,
104 public function provideGetAndAcquireId() {
106 'no wancache, empty table' =>
107 [ new EmptyBagOStuff(), true, 1, [], 'foo', 1 ],
108 'no wancache, one matching value' =>
109 [ new EmptyBagOStuff(), false, 1, [ 'foo' ], 'foo', 1 ],
110 'no wancache, one not matching value' =>
111 [ new EmptyBagOStuff(), true, 1, [ 'bar' ], 'foo', 2 ],
112 'no wancache, multiple, one matching value' =>
113 [ new EmptyBagOStuff(), false, 1, [ 'foo', 'bar' ], 'bar', 2 ],
114 'no wancache, multiple, no matching value' =>
115 [ new EmptyBagOStuff(), true, 1, [ 'foo', 'bar' ], 'baz', 3 ],
116 'wancache, empty table' =>
117 [ new HashBagOStuff(), true, 1, [], 'foo', 1 ],
118 'wancache, one matching value' =>
119 [ new HashBagOStuff(), false, 1, [ 'foo' ], 'foo', 1 ],
120 'wancache, one not matching value' =>
121 [ new HashBagOStuff(), true, 1, [ 'bar' ], 'foo', 2 ],
122 'wancache, multiple, one matching value' =>
123 [ new HashBagOStuff(), false, 1, [ 'foo', 'bar' ], 'bar', 2 ],
124 'wancache, multiple, no matching value' =>
125 [ new HashBagOStuff(), true, 1, [ 'foo', 'bar' ], 'baz', 3 ],
130 * @dataProvider provideGetAndAcquireId
131 * @param BagOStuff $cacheBag to use in the WANObjectCache service
132 * @param bool $needsInsert Does the value we are testing need to be inserted?
133 * @param int $selectCalls Number of times the select DB method will be called
134 * @param string[] $existingValues to be added to the db table
135 * @param string $name name to acquire
136 * @param int $expectedId the id we expect the name to have
138 public function testGetAndAcquireId(
146 // Make sure the table is empty!
147 $this->truncateTable( 'slot_roles' );
149 $this->populateTable( $existingValues );
150 $store = $this->getNameTableSqlStore( $cacheBag, (int)$needsInsert, $selectCalls );
152 // Some names will not initially exist
154 $result = $store->getId( $name );
155 $this->assertSame( $expectedId, $result );
156 } catch ( NameTableAccessException
$e ) {
157 if ( $needsInsert ) {
158 $this->assertTrue( true ); // Expected exception
160 $this->fail( 'Did not expect an exception, but got one: ' . $e->getMessage() );
164 // All names should return their id here
165 $this->assertSame( $expectedId, $store->acquireId( $name ) );
167 // acquireId inserted these names, so now everything should exist with getId
168 $this->assertSame( $expectedId, $store->getId( $name ) );
170 // calling getId again will also still work, and not result in more selects
171 $this->assertSame( $expectedId, $store->getId( $name ) );
174 public function provideTestGetAndAcquireIdNameNormalization() {
175 yield
[ 'A', 'a', 'strtolower' ];
176 yield
[ 'b', 'B', 'strtoupper' ];
184 yield
[ 'ZZ', 'ZZ-a', __CLASS__
. '::appendDashAToString' ];
187 public static function appendDashAToString( $string ) {
188 return $string . '-a';
192 * @dataProvider provideTestGetAndAcquireIdNameNormalization
194 public function testGetAndAcquireIdNameNormalization(
197 $normalizationCallback
199 $store = $this->getNameTableSqlStore(
200 new EmptyBagOStuff(),
203 $normalizationCallback
205 $acquiredId = $store->acquireId( $nameIn );
206 $this->assertSame( $nameOut, $store->getName( $acquiredId ) );
209 public function provideGetName() {
211 [ new HashBagOStuff(), 3, 2 ],
212 [ new EmptyBagOStuff(), 3, 3 ],
217 * @dataProvider provideGetName
219 public function testGetName( $cacheBag, $insertCalls, $selectCalls ) {
220 // Check for operations to in-memory cache (IMC) and persistent cache (PC)
221 $store = $this->getNameTableSqlStore( $cacheBag, $insertCalls, $selectCalls );
223 // Get 1 ID and make sure getName returns correctly
224 $fooId = $store->acquireId( 'foo' ); // regen PC, set IMC, update IMC, tombstone PC
225 $this->assertSame( 'foo', $store->getName( $fooId ) ); // use IMC
227 // Get another ID and make sure getName returns correctly
228 $barId = $store->acquireId( 'bar' ); // update IMC, tombstone PC
229 $this->assertSame( 'bar', $store->getName( $barId ) ); // use IMC
231 // Blitz the cache and make sure it still returns
232 TestingAccessWrapper
::newFromObject( $store )->tableCache
= null; // clear IMC
233 $this->assertSame( 'foo', $store->getName( $fooId ) ); // regen interim PC, set IMC
234 $this->assertSame( 'bar', $store->getName( $barId ) ); // use IMC
236 // Blitz the cache again and get another ID and make sure getName returns correctly
237 TestingAccessWrapper
::newFromObject( $store )->tableCache
= null; // clear IMC
238 $bazId = $store->acquireId( 'baz' ); // set IMC using interim PC, update IMC, tombstone PC
239 $this->assertSame( 'baz', $store->getName( $bazId ) ); // uses IMC
240 $this->assertSame( 'baz', $store->getName( $bazId ) ); // uses IMC
243 public function testGetName_masterFallback() {
244 $store = $this->getNameTableSqlStore( new EmptyBagOStuff(), 1, 2 );
247 $fooId = $store->acquireId( 'foo' );
249 // Empty the process cache, getCachedTable() will now return this empty array
250 TestingAccessWrapper
::newFromObject( $store )->tableCache
= [];
252 // getName should fallback to master, which is why we assert 2 selectCalls above
253 $this->assertSame( 'foo', $store->getName( $fooId ) );
256 public function testGetMap_empty() {
257 $this->populateTable( [] );
258 $store = $this->getNameTableSqlStore( new HashBagOStuff(), 0, 1 );
259 $table = $store->getMap();
260 $this->assertSame( [], $table );
263 public function testGetMap_twoValues() {
264 $this->populateTable( [ 'foo', 'bar' ] );
265 $store = $this->getNameTableSqlStore( new HashBagOStuff(), 0, 1 );
267 // We are using a cache, so 2 calls should only result in 1 select on the db
269 $table = $store->getMap();
271 $expected = [ 1 => 'foo', 2 => 'bar' ];
272 $this->assertSame( $expected, $table );
273 // Make sure the table returned is the same as the cached table
274 $this->assertSame( $expected, TestingAccessWrapper
::newFromObject( $store )->tableCache
);
277 public function testReloadMap() {
278 $this->populateTable( [ 'foo' ] );
279 $store = $this->getNameTableSqlStore( new HashBagOStuff(), 0, 2 );
282 $this->assertCount( 1, $store->getMap() );
284 // add more stuff to the table, so the cache gets out of sync
285 $this->populateTable( [ 'bar' ] );
287 $expected = [ 1 => 'foo', 2 => 'bar' ];
288 $this->assertSame( $expected, $store->reloadMap() );
289 $this->assertSame( $expected, $store->getMap() );
292 public function testCacheRaceCondition() {
293 $wanHashBag = new HashBagOStuff();
294 $store1 = $this->getNameTableSqlStore( $wanHashBag, 1, 1 );
295 $store2 = $this->getNameTableSqlStore( $wanHashBag, 1, 0 );
296 $store3 = $this->getNameTableSqlStore( $wanHashBag, 1, 1 );
298 // Cache the current table in the instances we will use
299 // This simulates multiple requests running simultaneously
304 // Store 2 separate names using different instances
305 $fooId = $store1->acquireId( 'foo' );
306 $barId = $store2->acquireId( 'bar' );
308 // Each of these instances should be aware of what they have inserted
309 $this->assertSame( $fooId, $store1->acquireId( 'foo' ) );
310 $this->assertSame( $barId, $store2->acquireId( 'bar' ) );
312 // A new store should be able to get both of these new Ids
313 // Note: before there was a race condition here where acquireId( 'bar' ) would update the
314 // cache with data missing the 'foo' key that it was not aware of
315 $store4 = $this->getNameTableSqlStore( $wanHashBag, 0, 1 );
316 $this->assertSame( $fooId, $store4->getId( 'foo' ) );
317 $this->assertSame( $barId, $store4->getId( 'bar' ) );
319 // If a store with old cached data tries to acquire these we will get the same ids.
320 $this->assertSame( $fooId, $store3->acquireId( 'foo' ) );
321 $this->assertSame( $barId, $store3->acquireId( 'bar' ) );
324 public function testGetAndAcquireIdInsertCallback() {
325 // FIXME: fails under postgres
326 $this->markTestSkippedIfDbType( 'postgres' );
328 $store = $this->getNameTableSqlStore(
329 new EmptyBagOStuff(),
333 function ( $insertFields ) {
334 $insertFields['role_id'] = 7251;
335 return $insertFields;
338 $this->assertSame( 7251, $store->acquireId( 'A' ) );