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
;
33 * @covers \Wikimedia\Rdbms\LoadBalancer
35 class LoadBalancerTest
extends MediaWikiTestCase
{
36 private function makeServerConfig( $flags = DBO_DEFAULT
) {
37 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
40 'host' => $wgDBserver,
41 'dbname' => $wgDBname,
42 'tablePrefix' => $this->dbPrefix(),
44 'password' => $wgDBpassword,
46 'dbDirectory' => $wgSQLiteDataDir,
53 * @covers LoadBalancer::getLocalDomainID()
54 * @covers LoadBalancer::resolveDomainID()
56 public function testWithoutReplica() {
60 $lb = new LoadBalancer( [
61 // Simulate web request with DBO_TRX
62 'servers' => [ $this->makeServerConfig( DBO_TRX
) ],
63 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
64 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
65 'chronologyCallback' => function () use ( &$called ) {
70 $ld = DatabaseDomain
::newFromId( $lb->getLocalDomainID() );
71 $this->assertEquals( $wgDBname, $ld->getDatabase(), 'local domain DB set' );
72 $this->assertEquals( $this->dbPrefix(), $ld->getTablePrefix(), 'local domain prefix set' );
73 $this->assertSame( 'my_test_wiki', $lb->resolveDomainID( 'my_test_wiki' ) );
74 $this->assertSame( $ld->getId(), $lb->resolveDomainID( false ) );
75 $this->assertSame( $ld->getId(), $lb->resolveDomainID( $ld ) );
76 $this->assertFalse( $called );
78 $dbw = $lb->getConnection( DB_MASTER
);
79 $this->assertTrue( $called );
80 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
81 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
82 $this->assertWriteAllowed( $dbw );
84 $dbr = $lb->getConnection( DB_REPLICA
);
85 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_REPLICA also gets the master' );
86 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
88 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
89 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
91 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
92 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
93 $this->assertNotEquals(
94 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
96 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
98 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
99 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
100 $this->assertNotEquals(
101 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
103 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
104 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
110 public function testWithReplica() {
113 // Simulate web request with DBO_TRX
114 $lb = $this->newMultiServerLocalLoadBalancer( DBO_TRX
);
116 $dbw = $lb->getConnection( DB_MASTER
);
117 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
119 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
120 $dbw->getLBInfo( 'clusterMasterHost' ),
121 'cluster master set' );
122 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on master" );
123 $this->assertWriteAllowed( $dbw );
125 $dbr = $lb->getConnection( DB_REPLICA
);
126 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'replica shows as replica' );
128 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
129 $dbr->getLBInfo( 'clusterMasterHost' ),
130 'cluster master set' );
131 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX set on replica" );
132 $this->assertWriteForbidden( $dbr );
134 if ( !$lb->getServerAttributes( $lb->getWriterIndex() )[$dbw::ATTR_DB_LEVEL_LOCKING
] ) {
135 $dbwAuto = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
137 $dbwAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
138 $this->assertTrue( $dbw->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on master" );
139 $this->assertNotEquals(
140 $dbw, $dbwAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
142 $dbrAuto = $lb->getConnection( DB_REPLICA
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
144 $dbrAuto->getFlag( $dbw::DBO_TRX
), "No DBO_TRX with CONN_TRX_AUTOCOMMIT" );
145 $this->assertTrue( $dbr->getFlag( $dbw::DBO_TRX
), "DBO_TRX still set on replica" );
146 $this->assertNotEquals(
147 $dbr, $dbrAuto, "CONN_TRX_AUTOCOMMIT uses separate connection" );
149 $dbwAuto2 = $lb->getConnection( DB_MASTER
, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
150 $this->assertEquals( $dbwAuto2, $dbwAuto, "CONN_TRX_AUTOCOMMIT reuses connections" );
156 private function newSingleServerLocalLoadBalancer() {
159 return new LoadBalancer( [
160 'servers' => [ $this->makeServerConfig() ],
161 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
165 private function newMultiServerLocalLoadBalancer( $flags = DBO_DEFAULT
) {
166 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
171 'host' => $wgDBserver,
172 'dbname' => $wgDBname,
173 'tablePrefix' => $this->dbPrefix(),
175 'password' => $wgDBpassword,
177 'dbDirectory' => $wgSQLiteDataDir,
183 'host' => $wgDBserver,
184 'dbname' => $wgDBname,
185 'tablePrefix' => $this->dbPrefix(),
187 'password' => $wgDBpassword,
189 'dbDirectory' => $wgSQLiteDataDir,
194 'host' => $wgDBserver,
195 'dbname' => $wgDBname,
196 'tablePrefix' => $this->dbPrefix(),
198 'password' => $wgDBpassword,
200 'dbDirectory' => $wgSQLiteDataDir,
206 'host' => $wgDBserver,
207 'dbname' => $wgDBname,
208 'tablePrefix' => $this->dbPrefix(),
210 'password' => $wgDBpassword,
212 'dbDirectory' => $wgSQLiteDataDir,
215 'recentchanges' => 100,
220 // Logging replica DBs
222 'host' => $wgDBserver,
223 'dbname' => $wgDBname,
224 'tablePrefix' => $this->dbPrefix(),
226 'password' => $wgDBpassword,
228 'dbDirectory' => $wgSQLiteDataDir,
236 'host' => $wgDBserver,
237 'dbname' => $wgDBname,
238 'tablePrefix' => $this->dbPrefix(),
240 'password' => $wgDBpassword,
242 'dbDirectory' => $wgSQLiteDataDir,
249 // Maintenance query replica DBs
251 'host' => $wgDBserver,
252 'dbname' => $wgDBname,
253 'tablePrefix' => $this->dbPrefix(),
255 'password' => $wgDBpassword,
257 'dbDirectory' => $wgSQLiteDataDir,
266 return new LoadBalancer( [
267 'servers' => $servers,
268 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() ),
269 'queryLogger' => MediaWiki\Logger\LoggerFactory
::getInstance( 'DBQuery' ),
270 'loadMonitorClass' => LoadMonitorNull
::class
274 private function assertWriteForbidden( Database
$db ) {
276 $db->delete( 'some_table', [ 'id' => 57634126 ], __METHOD__
);
277 $this->fail( 'Write operation should have failed!' );
278 } catch ( DBError
$ex ) {
279 // check that the exception message contains "Write operation"
280 $constraint = new PHPUnit_Framework_Constraint_StringContains( 'Write operation' );
282 if ( !$constraint->evaluate( $ex->getMessage(), '', true ) ) {
283 // re-throw original error, to preserve stack trace
289 private function assertWriteAllowed( Database
$db ) {
290 $table = $db->tableName( 'some_table' );
291 // Trigger a transaction so that rollback() will remove all the tables.
292 // Don't do this for MySQL/Oracle as they auto-commit transactions for DDL
293 // statements such as CREATE TABLE.
294 $useAtomicSection = in_array( $db->getType(), [ 'sqlite', 'postgres', 'mssql' ], true );
296 $db->dropTable( 'some_table' ); // clear for sanity
297 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
299 if ( $useAtomicSection ) {
300 $db->startAtomic( __METHOD__
);
302 // Use only basic SQL and trivial types for these queries for compatibility
303 $this->assertNotSame(
305 $db->query( "CREATE TABLE $table (id INT, time INT)", __METHOD__
),
308 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
309 $this->assertNotSame(
311 $db->query( "DELETE FROM $table WHERE id=57634126", __METHOD__
),
314 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
316 if ( !$useAtomicSection ) {
317 // Drop the table to clean up, ignoring any error.
318 $db->dropTable( 'some_table' );
320 // Rollback the atomic section for sqlite's benefit.
321 $db->rollback( __METHOD__
, 'flush' );
322 $this->assertNotEquals( $db::STATUS_TRX_ERROR
, $db->trxStatus() );
326 public function testServerAttributes() {
329 'dbname' => 'my_unittest_wiki',
330 'tablePrefix' => 'unittest_',
332 'dbDirectory' => "some_directory",
337 $lb = new LoadBalancer( [
338 'servers' => $servers,
339 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
340 'loadMonitorClass' => LoadMonitorNull
::class
343 $this->assertTrue( $lb->getServerAttributes( 0 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
348 'user' => 'wikiuser',
349 'password' => 'none',
350 'dbname' => 'my_unittest_wiki',
351 'tablePrefix' => 'unittest_',
355 [ // emulated replica
357 'user' => 'wikiuser',
358 'password' => 'none',
359 'dbname' => 'my_unittest_wiki',
360 'tablePrefix' => 'unittest_',
366 $lb = new LoadBalancer( [
367 'servers' => $servers,
368 'localDomain' => new DatabaseDomain( 'my_unittest_wiki', null, 'unittest_' ),
369 'loadMonitorClass' => LoadMonitorNull
::class
372 $this->assertFalse( $lb->getServerAttributes( 1 )[Database
::ATTR_DB_LEVEL_LOCKING
] );
376 * @covers LoadBalancer::openConnection()
377 * @covers LoadBalancer::getAnyOpenConnection()
379 function testOpenConnection() {
380 $lb = $this->newSingleServerLocalLoadBalancer();
382 $i = $lb->getWriterIndex();
383 $this->assertEquals( null, $lb->getAnyOpenConnection( $i ) );
385 $conn1 = $lb->getConnection( $i );
386 $this->assertNotEquals( null, $conn1 );
387 $this->assertEquals( $conn1, $lb->getAnyOpenConnection( $i ) );
388 $this->assertFalse( $conn1->getFlag( DBO_TRX
) );
390 $conn2 = $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
391 $this->assertNotEquals( null, $conn2 );
392 $this->assertFalse( $conn2->getFlag( DBO_TRX
) );
394 if ( $lb->getServerAttributes( $i )[Database
::ATTR_DB_LEVEL_LOCKING
] ) {
395 $this->assertEquals( null,
396 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
397 $this->assertEquals( $conn1,
399 $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
), $lb::CONN_TRX_AUTOCOMMIT
);
401 $this->assertEquals( $conn2,
402 $lb->getAnyOpenConnection( $i, $lb::CONN_TRX_AUTOCOMMIT
) );
403 $this->assertEquals( $conn2,
404 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
) );
406 $conn2->startAtomic( __METHOD__
);
408 $lb->getConnection( $i, [], false, $lb::CONN_TRX_AUTOCOMMIT
);
409 $conn2->endAtomic( __METHOD__
);
410 $this->fail( "No exception thrown." );
411 } catch ( DBUnexpectedError
$e ) {
413 'Handle requested with CONN_TRX_AUTOCOMMIT yet it has a transaction',
417 $conn2->endAtomic( __METHOD__
);
423 public function testTransactionCallbackChains() {
424 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
428 'host' => $wgDBserver,
429 'dbname' => $wgDBname,
430 'tablePrefix' => $this->dbPrefix(),
432 'password' => $wgDBpassword,
434 'dbDirectory' => $wgSQLiteDataDir,
436 'flags' => DBO_TRX
// simulate a web request with DBO_TRX
440 $lb = new LoadBalancer( [
441 'servers' => $servers,
442 'localDomain' => new DatabaseDomain( $wgDBname, null, $this->dbPrefix() )
445 $conn1 = $lb->openConnection( $lb->getWriterIndex(), false );
446 $conn2 = $lb->openConnection( $lb->getWriterIndex(), '' );
449 $lb->forEachOpenMasterConnection( function () use ( &$count ) {
452 $this->assertEquals( 2, $count, 'Connection handle count' );
455 $lb->setTransactionListener( 'test-listener', function () use ( &$tlCalls ) {
459 $lb->beginMasterChanges( __METHOD__
);
460 $bc = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
461 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
463 $conn2->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
465 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
467 $conn1->onTransactionPreCommitOrIdle( function () use ( &$bc, $conn1, $conn2 ) {
473 $lb->finalizeMasterChanges();
474 $lb->approveMasterChanges( [] );
475 $lb->commitMasterChanges( __METHOD__
);
476 $lb->runMasterTransactionIdleCallbacks();
477 $lb->runMasterTransactionListenerCallbacks();
479 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $bc );
480 $this->assertEquals( 2, $tlCalls );
483 $lb->beginMasterChanges( __METHOD__
);
484 $ac = array_fill_keys( [ 'a', 'b', 'c', 'd' ], 0 );
485 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
487 $conn2->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
489 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
491 $conn1->onTransactionCommitOrIdle( function () use ( &$ac, $conn1, $conn2 ) {
497 $lb->finalizeMasterChanges();
498 $lb->approveMasterChanges( [] );
499 $lb->commitMasterChanges( __METHOD__
);
500 $lb->runMasterTransactionIdleCallbacks();
501 $lb->runMasterTransactionListenerCallbacks();
503 $this->assertEquals( array_fill_keys( [ 'a', 'b', 'c', 'd' ], 1 ), $ac );
504 $this->assertEquals( 2, $tlCalls );
510 public function testDBConnRefReadsMasterAndReplicaRoles() {
511 $lb = $this->newSingleServerLocalLoadBalancer();
513 $rConn = $lb->getConnectionRef( DB_REPLICA
);
514 $wConn = $lb->getConnectionRef( DB_MASTER
);
515 $wConn2 = $lb->getConnectionRef( 0 );
517 $v = [ 'value' => '1', '1' ];
518 $sql = 'SELECT MAX(1) AS value';
519 foreach ( [ $rConn, $wConn, $wConn2 ] as $conn ) {
520 $conn->clearFlag( $conn::DBO_TRX
);
522 $res = $conn->query( $sql, __METHOD__
);
523 $this->assertEquals( $v, $conn->fetchRow( $res ) );
525 $res = $conn->query( $sql, __METHOD__
, $conn::QUERY_REPLICA_ROLE
);
526 $this->assertEquals( $v, $conn->fetchRow( $res ) );
529 $wConn->getScopedLockAndFlush( 'key', __METHOD__
, 1 );
530 $wConn2->getScopedLockAndFlush( 'key2', __METHOD__
, 1 );
534 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
536 public function testDBConnRefWritesReplicaRole() {
537 $lb = $this->newSingleServerLocalLoadBalancer();
539 $rConn = $lb->getConnectionRef( DB_REPLICA
);
541 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
545 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
547 public function testDBConnRefWritesReplicaRoleIndex() {
548 $lb = $this->newMultiServerLocalLoadBalancer();
550 $rConn = $lb->getConnectionRef( 1 );
552 $rConn->query( 'DELETE FROM sometesttable WHERE 1=0' );
556 * @expectedException \Wikimedia\Rdbms\DBReadOnlyRoleError
558 public function testDBConnRefWritesReplicaRoleInsert() {
559 $lb = $this->newMultiServerLocalLoadBalancer();
561 $rConn = $lb->getConnectionRef( DB_REPLICA
);
563 $rConn->insert( 'test', [ 't' => 1 ], __METHOD__
);
566 public function testQueryGroupIndex() {
567 $lb = $this->newMultiServerLocalLoadBalancer();
568 /** @var LoadBalancer $lbWrapper */
569 $lbWrapper = TestingAccessWrapper
::newFromObject( $lb );
571 $rGeneric = $lb->getConnectionRef( DB_REPLICA
);
572 $mainIndexPicked = $rGeneric->getLBInfo( 'serverIndex' );
574 $this->assertEquals( $mainIndexPicked, $lbWrapper->getExistingReaderIndex( false ) );
575 $this->assertTrue( in_array( $mainIndexPicked, [ 1, 2 ] ) );
576 for ( $i = 0; $i < 300; ++
$i ) {
577 $rLog = $lb->getConnectionRef( DB_REPLICA
, [] );
580 $rLog->getLBInfo( 'serverIndex' ),
581 "Main index unchanged" );
584 $rRC = $lb->getConnectionRef( DB_REPLICA
, [ 'recentchanges' ] );
585 $rWL = $lb->getConnectionRef( DB_REPLICA
, [ 'watchlist' ] );
587 $this->assertEquals( 3, $rRC->getLBInfo( 'serverIndex' ) );
588 $this->assertEquals( 3, $rWL->getLBInfo( 'serverIndex' ) );
590 $rLog = $lb->getConnectionRef( DB_REPLICA
, [ 'logging', 'watchlist' ] );
591 $logIndexPicked = $rLog->getLBInfo( 'serverIndex' );
593 $this->assertEquals( $logIndexPicked, $lbWrapper->getExistingReaderIndex( 'logging' ) );
594 $this->assertTrue( in_array( $logIndexPicked, [ 4, 5 ] ) );
596 for ( $i = 0; $i < 300; ++
$i ) {
597 $rLog = $lb->getConnectionRef( DB_REPLICA
, [ 'logging', 'watchlist' ] );
599 $logIndexPicked, $rLog->getLBInfo( 'serverIndex' ), "Index unchanged" );
602 $rVslow = $lb->getConnectionRef( DB_REPLICA
, [ 'vslow', 'logging' ] );
603 $vslowIndexPicked = $rVslow->getLBInfo( 'serverIndex' );
605 $this->assertEquals( $vslowIndexPicked, $lbWrapper->getExistingReaderIndex( 'vslow' ) );
606 $this->assertEquals( 6, $vslowIndexPicked );