4 * Holds tests for LoadBalancer MediaWiki class.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
24 use Wikimedia\Rdbms\DBError
;
25 use Wikimedia\Rdbms\DatabaseDomain
;
26 use Wikimedia\Rdbms\Database
;
27 use Wikimedia\Rdbms\LoadBalancer
;
28 use Wikimedia\Rdbms\LoadMonitorNull
;
29 use Wikimedia\TestingAccessWrapper
;
34 * @covers \Wikimedia\Rdbms\LoadBalancer
36 class LoadBalancerTest
extends MediaWikiTestCase
{
37 private function makeServerConfig( $flags = DBO_DEFAULT
) {
38 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
41 'host' => $wgDBserver,
42 'dbname' => $wgDBname,
43 'tablePrefix' => $this->dbPrefix(),
45 'password' => $wgDBpassword,
47 'dbDirectory' => $wgSQLiteDataDir,
54 * @covers LoadBalancer::getLocalDomainID()
55 * @covers LoadBalancer::resolveDomainID()
57 public function testWithoutReplica() {
61 $lb = new LoadBalancer( [
62 // Simulate web request with DBO_TRX
63 'servers' => [ $this->makeServerConfig( DBO_TRX
) ],
64 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
65 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
66 'chronologyCallback' => function () use ( &$called ) {
71 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
72 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
73 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
74 $this->assertSame( 'my_test_wiki', $lb->resolveDomainID( 'my_test_wiki' ) );
75 $this->assertSame( $ld->getId(), $lb->resolveDomainID( false ) );
76 $this->assertSame( $ld->getId(), $lb->resolveDomainID( $ld ) );
77 $this->assertFalse( $called );
79 $dbw = $lb->getConnection( DB_MASTER
);
80 $this->assertTrue( $called );
81 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
82 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
83 $this->assertWriteAllowed( $dbw );
85 $dbr = $lb->getConnection( DB_REPLICA
);
86 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
87 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
89 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
90 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
92 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
93 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
94 $this->assertNotEquals(
95 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
97 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
99 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
100 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
101 $this->assertNotEquals(
102 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
104 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
105 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
111 public function testWithReplica() {
114 // Simulate web request with DBO_TRX
115 $lb = $this->newMultiServerLocalLoadBalancer( [], [ 'flags' => DBO_TRX
] );
117 $this->assertEquals( 8, $lb->getServerCount() );
118 $this->assertTrue( $lb->hasReplicaServers() );
119 $this->assertTrue( $lb->hasStreamingReplicaServers() );
121 $dbw = $lb->getConnection( DB_MASTER
);
122 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
124 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
125 $dbw->getLBInfo( 'clusterMasterHost' ),
126 'cluster master set' );
127 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
128 $this->assertWriteAllowed( $dbw );
130 $dbr = $lb->getConnection( DB_REPLICA
);
131 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
132 $this->assertTrue( $dbr->isReadOnly(), 'replica shows as replica' );
134 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
135 $dbr->getLBInfo( 'clusterMasterHost' ),
136 'cluster master set' );
137 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
138 $this->assertWriteForbidden( $dbr );
140 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
141 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
143 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
144 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
145 $this->assertNotEquals(
146 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
148 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
150 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
151 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
152 $this->assertNotEquals(
153 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
155 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
156 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
162 private function newSingleServerLocalLoadBalancer() {
165 return new LoadBalancer( [
166 'servers' => [ $this->makeServerConfig() ],
167 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
171 private function newMultiServerLocalLoadBalancer(
172 $lbExtra = [], $srvExtra = [], $masterOnly = false
174 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
179 'host' => $wgDBserver,
180 'dbname' => $wgDBname,
181 'tablePrefix' => $this->dbPrefix(),
183 'password' => $wgDBpassword,
185 'dbDirectory' => $wgSQLiteDataDir,
186 'load' => $masterOnly ?
100 : 0,
190 'host' => $wgDBserver,
191 'dbname' => $wgDBname,
192 'tablePrefix' => $this->dbPrefix(),
194 'password' => $wgDBpassword,
196 'dbDirectory' => $wgSQLiteDataDir,
197 'load' => $masterOnly ?
0 : 100,
200 'host' => $wgDBserver,
201 'dbname' => $wgDBname,
202 'tablePrefix' => $this->dbPrefix(),
204 'password' => $wgDBpassword,
206 'dbDirectory' => $wgSQLiteDataDir,
207 'load' => $masterOnly ?
0 : 100,
211 'host' => $wgDBserver,
212 'dbname' => $wgDBname,
213 'tablePrefix' => $this->dbPrefix(),
215 'password' => $wgDBpassword,
217 'dbDirectory' => $wgSQLiteDataDir,
220 'recentchanges' => 100,
224 // Logging replica DBs
226 'host' => $wgDBserver,
227 'dbname' => $wgDBname,
228 'tablePrefix' => $this->dbPrefix(),
230 'password' => $wgDBpassword,
232 'dbDirectory' => $wgSQLiteDataDir,
239 'host' => $wgDBserver,
240 'dbname' => $wgDBname,
241 'tablePrefix' => $this->dbPrefix(),
243 'password' => $wgDBpassword,
245 'dbDirectory' => $wgSQLiteDataDir,
251 // Maintenance query replica DBs
253 'host' => $wgDBserver,
254 'dbname' => $wgDBname,
255 'tablePrefix' => $this->dbPrefix(),
257 'password' => $wgDBpassword,
259 'dbDirectory' => $wgSQLiteDataDir,
265 // Replica DB that only has a copy of some static tables
267 'host' => $wgDBserver,
268 'dbname' => $wgDBname,
269 'tablePrefix' => $this->dbPrefix(),
271 'password' => $wgDBpassword,
273 'dbDirectory' => $wgSQLiteDataDir,
282 return new LoadBalancer( $lbExtra +
[
283 'servers' => $servers,
284 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
285 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
286 'loadMonitorClass' => LoadMonitorNull
::class
290 private function assertWriteForbidden( Database
$db ) {
292 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
293 $this->fail( 'Write operation should have failed!' );
294 } catch ( DBError
$ex ) {
295 // check that the exception message contains "Write operation"
296 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
298 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
299 // re-throw original error, to preserve stack trace
305 private function assertWriteAllowed( Database
$db ) {
306 $table = $db->tableName( 'some_table' );
307 // Trigger a transaction so that rollback() will remove all the tables.
308 // Don't do this for MySQL/Oracle as they auto-commit transactions for DDL
309 // statements such as CREATE TABLE.
310 $useAtomicSection = in_array( $db->getType(), [ 'sqlite', 'postgres', 'mssql' ], true );
312 $db->dropTable( 'some_table' ); // clear for sanity
313 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
315 if ( $useAtomicSection ) {
316 $db->startAtomic( __METHOD__
);
318 // Use only basic SQL and trivial types for these queries for compatibility
319 $this->assertNotSame(
321 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
324 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
325 $this->assertNotSame(
327 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
330 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
332 if ( !$useAtomicSection ) {
333 // Drop the table to clean up, ignoring any error.
334 $db->dropTable( 'some_table' );
336 // Rollback the atomic section for sqlite's benefit.
337 $db->rollback( __METHOD__
, 'flush' );
338 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
342 public function testServerAttributes() {
345 'dbname' => 'my_unittest_wiki',
346 'tablePrefix' => 'unittest_',
348 'dbDirectory' => "some_directory",
353 $lb = new LoadBalancer( [
354 'servers' => $servers,
355 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
356 'loadMonitorClass' => LoadMonitorNull
::class
359 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
364 'user' => 'wikiuser',
365 'password' => 'none',
366 'dbname' => 'my_unittest_wiki',
367 'tablePrefix' => 'unittest_',
371 [ // emulated replica
373 'user' => 'wikiuser',
374 'password' => 'none',
375 'dbname' => 'my_unittest_wiki',
376 'tablePrefix' => 'unittest_',
382 $lb = new LoadBalancer( [
383 'servers' => $servers,
384 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
385 'loadMonitorClass' => LoadMonitorNull
::class
388 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
392 * @covers LoadBalancer::openConnection()
393 * @covers LoadBalancer::getAnyOpenConnection()
395 function testOpenConnection() {
396 $lb = $this->newSingleServerLocalLoadBalancer();
398 $i = $lb->getWriterIndex();
399 $this->assertEquals( null, $lb->getAnyOpenConnection( $i ) );
401 $conn1 = $lb->getConnection( $i );
402 $this->assertNotEquals( null, $conn1 );
403 $this->assertEquals( $conn1, $lb->getAnyOpenConnection( $i ) );
404 $this->assertFalse( $conn1->getFlag( DBO_TRX
) );
406 $conn2 = $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
407 $this->assertNotEquals( null, $conn2 );
408 $this->assertFalse( $conn2->getFlag( DBO_TRX
) );
410 if ( $lb->getServerAttributes( $i )[Database
::ATTR_DB_LEVEL_LOCKING
] ) {
411 $this->assertEquals( null,
412 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
413 $this->assertEquals( $conn1,
415 $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
), $lb::CONN_TRX_AUTOCOMMIT
);
417 $this->assertEquals( $conn2,
418 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
419 $this->assertEquals( $conn2,
420 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
) );
422 $conn2->startAtomic( __METHOD__
);
424 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
425 $conn2->endAtomic( __METHOD__
);
426 $this->fail( "No exception thrown." );
427 } catch ( DBUnexpectedError
$e ) {
429 'Handle requested with CONN_TRX_AUTOCOMMIT yet it has a transaction',
433 $conn2->endAtomic( __METHOD__
);
439 public function testTransactionCallbackChains() {
440 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
444 'host' => $wgDBserver,
445 'dbname' => $wgDBname,
446 'tablePrefix' => $this->dbPrefix(),
448 'password' => $wgDBpassword,
450 'dbDirectory' => $wgSQLiteDataDir,
452 'flags' => DBO_TRX
// simulate a web request with DBO_TRX
456 $lb = new LoadBalancer( [
457 'servers' => $servers,
458 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
461 $conn1 = $lb->openConnection( $lb->getWriterIndex(), false );
462 $conn2 = $lb->openConnection( $lb->getWriterIndex(), '' );
465 $lb->forEachOpenMasterConnection( function () use ( &$count ) {
468 $this->assertEquals( 2, $count, 'Connection handle count' );
471 $lb->setTransactionListener( 'test-listener', function () use ( &$tlCalls ) {
475 $lb->beginMasterChanges( __METHOD__
);
476 $bc = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
477 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
479 $conn2->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
481 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
483 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
489 $lb->finalizeMasterChanges();
490 $lb->approveMasterChanges( [] );
491 $lb->commitMasterChanges( __METHOD__
);
492 $lb->runMasterTransactionIdleCallbacks();
493 $lb->runMasterTransactionListenerCallbacks();
495 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $bc );
496 $this->assertEquals( 2, $tlCalls );
499 $lb->beginMasterChanges( __METHOD__
);
500 $ac = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
501 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
503 $conn2->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
505 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
507 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
513 $lb->finalizeMasterChanges();
514 $lb->approveMasterChanges( [] );
515 $lb->commitMasterChanges( __METHOD__
);
516 $lb->runMasterTransactionIdleCallbacks();
517 $lb->runMasterTransactionListenerCallbacks();
519 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $ac );
520 $this->assertEquals( 2, $tlCalls );
526 public function testDBConnRefReadsMasterAndReplicaRoles() {
527 $lb = $this->newSingleServerLocalLoadBalancer();
529 $rConn = $lb->getConnectionRef( DB_REPLICA
);
530 $wConn = $lb->getConnectionRef( DB_MASTER
);
531 $wConn2 = $lb->getConnectionRef( 0 );
533 $v = [ 'value' => '1', '1' ];
534 $sql = 'SELECT MAX(1) AS value';
535 foreach ( [ $rConn, $wConn, $wConn2 ] as $conn ) {
536 $conn->clearFlag( $conn::DBO_TRX
);
538 $res = $conn->query( $sql, __METHOD__
);
539 $this->assertEquals( $v, $conn->fetchRow( $res ) );
541 $res = $conn->query( $sql, __METHOD__
, $conn::QUERY_REPLICA_ROLE
);
542 $this->assertEquals( $v, $conn->fetchRow( $res ) );
545 $wConn->getScopedLockAndFlush( 'key', __METHOD__
, 1 );
546 $wConn2->getScopedLockAndFlush( 'key2', __METHOD__
, 1 );
550 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
552 public function testDBConnRefWritesReplicaRole() {
553 $lb = $this->newSingleServerLocalLoadBalancer();
555 $rConn = $lb->getConnectionRef( DB_REPLICA
);
557 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
561 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
563 public function testDBConnRefWritesReplicaRoleIndex() {
564 $lb = $this->newMultiServerLocalLoadBalancer();
566 $rConn = $lb->getConnectionRef( 1 );
568 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
572 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
574 public function testDBConnRefWritesReplicaRoleInsert() {
575 $lb = $this->newMultiServerLocalLoadBalancer();
577 $rConn = $lb->getConnectionRef( DB_REPLICA
);
579 $rConn->insert( 'test', [ 't' => 1 ], __METHOD__
);
582 public function testQueryGroupIndex() {
583 $lb = $this->newMultiServerLocalLoadBalancer( [ 'defaultGroup' => false ] );
584 /** @var LoadBalancer $lbWrapper */
585 $lbWrapper = TestingAccessWrapper
::newFromObject( $lb );
587 $rGeneric = $lb->getConnectionRef( DB_REPLICA
);
588 $mainIndexPicked = $rGeneric->getLBInfo( 'serverIndex' );
590 $this->assertEquals( $mainIndexPicked, $lbWrapper->getExistingReaderIndex( false ) );
591 $this->assertTrue( in_array( $mainIndexPicked, [ 1, 2 ] ) );
592 for ( $i = 0; $i < 300; ++
$i ) {
593 $rLog = $lb->getConnectionRef( DB_REPLICA
, [] );
596 $rLog->getLBInfo( 'serverIndex' ),
597 "Main index unchanged" );
600 $rRC = $lb->getConnectionRef( DB_REPLICA
, [ 'recentchanges' ] );
601 $rWL = $lb->getConnectionRef( DB_REPLICA
, [ 'watchlist' ] );
603 $this->assertEquals( 3, $rRC->getLBInfo( 'serverIndex' ) );
604 $this->assertEquals( 3, $rWL->getLBInfo( 'serverIndex' ) );
606 $rLog = $lb->getConnectionRef( DB_REPLICA
, [ 'logging', 'watchlist' ] );
607 $logIndexPicked = $rLog->getLBInfo( 'serverIndex' );
609 $this->assertEquals( $logIndexPicked, $lbWrapper->getExistingReaderIndex( 'logging' ) );
610 $this->assertTrue( in_array( $logIndexPicked, [ 4, 5 ] ) );
612 for ( $i = 0; $i < 300; ++
$i ) {
613 $rLog = $lb->getConnectionRef( DB_REPLICA
, [ 'logging', 'watchlist' ] );
615 $logIndexPicked, $rLog->getLBInfo( 'serverIndex' ), "Index unchanged" );
618 $rVslow = $lb->getConnectionRef( DB_REPLICA
, [ 'vslow', 'logging' ] );
619 $vslowIndexPicked = $rVslow->getLBInfo( 'serverIndex' );
621 $this->assertEquals( $vslowIndexPicked, $lbWrapper->getExistingReaderIndex( 'vslow' ) );
622 $this->assertEquals( 6, $vslowIndexPicked );
625 public function testNonZeroMasterLoad() {
626 $lb = $this->newMultiServerLocalLoadBalancer( [], [ 'flags' => DBO_DEFAULT
], true );
627 // Make sure that no infinite loop occurs (T226678)
628 $rGeneric = $lb->getConnectionRef( DB_REPLICA
);
629 $this->assertEquals( $lb->getWriterIndex(), $rGeneric->getLBInfo( 'serverIndex' ) );