wiki.techinc.nl/tests/phpunit/includes/watcheditem/WatchedItemStoreUnitTest.php
Umherirrender a1de8b8700 Tests: Mark more more closures as static
Result of a new sniff I25a17fb22b6b669e817317a0f45051ae9c608208

Bug: T274036
Change-Id: I695873737167a75f0d94901fa40383a33984ca55
2021-02-09 02:55:57 +00:00

3041 lines
85 KiB
PHP

<?php
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\User\UserIdentityValue;
use PHPUnit\Framework\MockObject\MockObject;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\LBFactory;
use Wikimedia\Rdbms\LoadBalancer;
use Wikimedia\TestingAccessWrapper;
/**
* @author Addshore
*
* @covers WatchedItemStore
*
* TODO convert this to actually be a Unit test
*/
class WatchedItemStoreUnitTest extends MediaWikiIntegrationTestCase {
/**
* @return MockObject|IDatabase
*/
private function getMockDb() {
return $this->createMock( IDatabase::class );
}
/**
* @param IDatabase $mockDb
* @param string|null $expectedConnectionType
* @return MockObject|LoadBalancer
*/
private function getMockLoadBalancer(
$mockDb,
$expectedConnectionType = null
) {
$mock = $this->getMockBuilder( LoadBalancer::class )
->disableOriginalConstructor()
->getMock();
if ( $expectedConnectionType !== null ) {
$mock->expects( $this->any() )
->method( 'getConnectionRef' )
->with( $expectedConnectionType )
->will( $this->returnValue( $mockDb ) );
} else {
$mock->expects( $this->any() )
->method( 'getConnectionRef' )
->will( $this->returnValue( $mockDb ) );
}
return $mock;
}
/**
* @param IDatabase $mockDb
* @param string|null $expectedConnectionType
* @return MockObject|LBFactory
*/
private function getMockLBFactory(
$mockDb,
$expectedConnectionType = null
) {
$loadBalancer = $this->getMockLoadBalancer( $mockDb, $expectedConnectionType );
$mock = $this->getMockBuilder( LBFactory::class )
->disableOriginalConstructor()
->getMock();
$mock->expects( $this->any() )
->method( 'getMainLB' )
->will( $this->returnValue( $loadBalancer ) );
return $mock;
}
/**
* @return MockObject|JobQueueGroup
*/
private function getMockJobQueueGroup() {
$mock = $this->getMockBuilder( JobQueueGroup::class )
->disableOriginalConstructor()
->getMock();
$mock->expects( $this->any() )
->method( 'push' )
->will( $this->returnCallback( static function ( Job $job ) {
$job->run();
} ) );
$mock->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback( static function ( Job $job ) {
$job->run();
} ) );
return $mock;
}
/**
* @return MockObject|HashBagOStuff
*/
private function getMockCache() {
$mock = $this->getMockBuilder( HashBagOStuff::class )
->disableOriginalConstructor()
->setMethods( [ 'get', 'set', 'delete', 'makeKey' ] )
->getMock();
$mock->expects( $this->any() )
->method( 'makeKey' )
->will( $this->returnCallback( static function ( ...$args ) {
return implode( ':', $args );
} ) );
return $mock;
}
/**
* @param bool $readOnly
* @return MockObject|ReadOnlyMode
*/
private function getMockReadOnlyMode( $readOnly = false ) {
$mock = $this->getMockBuilder( ReadOnlyMode::class )
->disableOriginalConstructor()
->getMock();
$mock->expects( $this->any() )
->method( 'isReadOnly' )
->will( $this->returnValue( $readOnly ) );
return $mock;
}
/**
* Assumes that only getSubjectPage and getTalkPage will ever be called, and everything passed
* to them will have namespace 0.
* @return NamespaceInfo
*/
private function getMockNsInfo() : NamespaceInfo {
$mock = $this->createMock( NamespaceInfo::class );
$mock->method( 'getSubjectPage' )->will( $this->returnArgument( 0 ) );
$mock->method( 'getTalkPage' )->will( $this->returnCallback(
static function ( $target ) {
return new TitleValue( 1, $target->getDbKey() );
}
) );
$mock->expects( $this->never() )
->method( $this->anythingBut( 'getSubjectPage', 'getTalkPage' ) );
return $mock;
}
/**
* No methods may be called except provided callbacks, if any.
*
* @param array $callbacks Keys are method names, values are callbacks
* @param array $counts Keys are method names, values are expected number of times to be called
* (default is any number is okay)
* @return RevisionLookup
*/
private function getMockRevisionLookup(
array $callbacks = [], array $counts = []
) : RevisionLookup {
$mock = $this->createMock( RevisionLookup::class );
foreach ( $callbacks as $method => $callback ) {
$count = isset( $counts[$method] ) ? $this->exactly( $counts[$method] ) : $this->any();
$mock->expects( $count )
->method( $method )
->will( $this->returnCallback( $callbacks[$method] ) );
}
$mock->expects( $this->never() )
->method( $this->anythingBut( ...array_keys( $callbacks ) ) );
return $mock;
}
/**
* @param IDatabase $mockDb
* @return MockObject|LinkBatchFactory
*/
private function getMockLinkBatchFactory( $mockDb ) {
return new LinkBatchFactory(
$this->createMock( LinkCache::class ),
$this->createMock( TitleFormatter::class ),
$this->createMock( Language::class ),
$this->createMock( GenderCache::class ),
$this->getMockLoadBalancer( $mockDb )
);
}
/**
* @param array $mocks Associative array providing mocks to use when constructing the
* WatchedItemStore. Anything not provided will fall back to a default. Valid keys:
* * lbFactory
* * db
* * queueGroup
* * cache
* * readOnlyMode
* * nsInfo
* * revisionLookup
* * expiryEnabled
* * maxExpiryDuration
* @return WatchedItemStore
*/
private function newWatchedItemStore( array $mocks = [] ) : WatchedItemStore {
$options = new ServiceOptions( WatchedItemStore::CONSTRUCTOR_OPTIONS, [
'UpdateRowsPerQuery' => 1000,
'WatchlistExpiry' => $mocks['expiryEnabled'] ?? true,
'WatchlistExpiryMaxDuration' => $mocks['maxExpiryDuration'] ?? null,
] );
// TODO mocking and convert to a Unit test
$userFactory = MediaWikiServices::getInstance()->getUserFactory();
$db = $mocks['db'] ?? $this->getMockDb();
return new WatchedItemStore(
$options,
$mocks['lbFactory'] ??
$this->getMockLBFactory( $db ),
$mocks['queueGroup'] ?? $this->getMockJobQueueGroup(),
new HashBagOStuff(),
$mocks['cache'] ?? $this->getMockCache(),
$mocks['readOnlyMode'] ?? $this->getMockReadOnlyMode(),
$mocks['nsInfo'] ?? $this->getMockNsInfo(),
$mocks['revisionLookup'] ?? $this->getMockRevisionLookup(),
$this->createHookContainer(),
$this->getMockLinkBatchFactory( $db ),
$userFactory
);
}
public function testClearWatchedItems() {
$user = new UserIdentityValue( 7, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'selectField' )
->with(
[ 'watchlist' ],
'COUNT(*)',
[
'wl_user' => $user->getId(),
],
$this->isType( 'string' )
)
->will( $this->returnValue( 12 ) );
$mockDb->expects( $this->once() )
->method( 'delete' )
->with(
'watchlist',
[ 'wl_user' => 7 ],
$this->isType( 'string' )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( 'RM-KEY' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false ] );
TestingAccessWrapper::newFromObject( $store )
->cacheIndex = [ 0 => [ 'F' => [ 7 => 'RM-KEY', 9 => 'KEEP-KEY' ] ] ];
$this->assertTrue( $store->clearUserWatchedItems( $user ) );
}
public function testClearWatchedItems_watchlistExpiry() {
$user = new UserIdentityValue( 7, 'MockUser', 0 );
$mockDb = $this->getMockDb();
// Select watchlist IDs.
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->willReturn( [ 1, 2 ] );
$mockDb->expects( $this->exactly( 2 ) )
->method( 'delete' )
->withConsecutive(
[
'watchlist',
[ 'wl_id' => [ 1, 2 ] ]
],
[
'watchlist_expiry',
[ 'we_item' => [ 1, 2 ] ]
]
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( 'RM-KEY' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => true ] );
TestingAccessWrapper::newFromObject( $store )
->cacheIndex = [ 0 => [ 'F' => [ 7 => 'RM-KEY', 9 => 'KEEP-KEY' ] ] ];
$this->assertTrue( $store->clearUserWatchedItems( $user ) );
}
public function testClearWatchedItems_tooManyItemsWatched() {
$user = new UserIdentityValue( 7, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'selectField' )
->with(
[ 'watchlist' ],
'COUNT(*)',
[
'wl_user' => $user->getId(),
],
$this->isType( 'string' )
)
->will( $this->returnValue( 99999 ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false ] );
$this->assertFalse( $store->clearUserWatchedItems( $user ) );
}
public function testCountWatchedItems() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectField' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
'COUNT(*)',
[
'wl_user' => $user->getId(),
'we_expiry IS NULL OR we_expiry > 20200101000000'
],
$this->isType( 'string' )
)
->will( $this->returnValue( '12' ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals( 12, $store->countWatchedItems( $user ) );
}
public function testCountWatchers() {
$titleValue = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectField' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
'COUNT(*)',
[
'wl_namespace' => $titleValue->getNamespace(),
'wl_title' => $titleValue->getDBkey(),
'we_expiry IS NULL OR we_expiry > 20200101000000'
],
$this->isType( 'string' )
)
->will( $this->returnValue( '7' ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals( 7, $store->countWatchers( $titleValue ) );
}
public function testCountWatchersMultiple() {
$titleValues = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 0, 'OtherDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$mockDb = $this->getMockDb();
$dbResult = [
(object)[ 'wl_title' => 'SomeDbKey', 'wl_namespace' => '0', 'watchers' => '100' ],
(object)[ 'wl_title' => 'OtherDbKey', 'wl_namespace' => '0', 'watchers' => '300' ],
(object)[ 'wl_title' => 'AnotherDbKey', 'wl_namespace' => '1', 'watchers' => '500' ],
];
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ [ 'SomeDbKey' => 1, 'OtherDbKey' => 1 ], [ 'AnotherDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
[
'makeWhereFrom2d return value',
'we_expiry IS NULL OR we_expiry > 20200101000000'
],
$this->isType( 'string' ),
[
'GROUP BY' => [ 'wl_namespace', 'wl_title' ],
]
)
->will(
$this->returnValue( $dbResult )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$expected = [
0 => [ 'SomeDbKey' => 100, 'OtherDbKey' => 300 ],
1 => [ 'AnotherDbKey' => 500 ],
];
$this->assertEquals( $expected, $store->countWatchersMultiple( $titleValues ) );
}
public function provideIntWithDbUnsafeVersion() {
return [
[ 50 ],
[ "50; DROP TABLE watchlist;\n--" ],
];
}
/**
* @dataProvider provideIntWithDbUnsafeVersion
*/
public function testCountWatchersMultiple_withMinimumWatchers( $minWatchers ) {
$titleValues = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 0, 'OtherDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$mockDb = $this->getMockDb();
$dbResult = [
(object)[ 'wl_title' => 'SomeDbKey', 'wl_namespace' => '0', 'watchers' => '100' ],
(object)[ 'wl_title' => 'OtherDbKey', 'wl_namespace' => '0', 'watchers' => '300' ],
(object)[ 'wl_title' => 'AnotherDbKey', 'wl_namespace' => '1', 'watchers' => '500' ],
];
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ [ 'SomeDbKey' => 1, 'OtherDbKey' => 1 ], [ 'AnotherDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
[
'makeWhereFrom2d return value',
'we_expiry IS NULL OR we_expiry > 20200101000000'
],
$this->isType( 'string' ),
[
'GROUP BY' => [ 'wl_namespace', 'wl_title' ],
'HAVING' => 'COUNT(*) >= 50',
]
)
->will(
$this->returnValue( $dbResult )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$expected = [
0 => [ 'SomeDbKey' => 100, 'OtherDbKey' => 300 ],
1 => [ 'AnotherDbKey' => 500 ],
];
$this->assertEquals(
$expected,
$store->countWatchersMultiple( $titleValues, [ 'minimumWatchers' => $minWatchers ] )
);
}
public function testCountVisitingWatchers() {
$titleValue = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectField' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
'COUNT(*)',
[
'wl_namespace' => $titleValue->getNamespace(),
'wl_title' => $titleValue->getDBkey(),
'wl_notificationtimestamp >= \'TS111TS\' OR wl_notificationtimestamp IS NULL',
'we_expiry IS NULL OR we_expiry > \'20200101000000\''
],
$this->isType( 'string' )
)
->will( $this->returnValue( '7' ) );
$mockDb->expects( $this->exactly( 2 ) )
->method( 'addQuotes' )
->will( $this->returnCallback( static function ( $value ) {
return "'$value'";
} ) );
$mockDb->expects( $this->exactly( 2 ) )
->method( 'timestamp' )
->will( $this->returnCallback( static function ( $value ) {
if ( $value === 0 ) {
return '20200101000000';
}
return 'TS' . $value . 'TS';
} ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals( 7, $store->countVisitingWatchers( $titleValue, '111' ) );
}
public function testCountVisitingWatchersMultiple() {
$titleValuesWithThresholds = [
[ new TitleValue( 0, 'SomeDbKey' ), '111' ],
[ new TitleValue( 0, 'OtherDbKey' ), '111' ],
[ new TitleValue( 1, 'AnotherDbKey' ), '123' ],
];
$dbResult = [
(object)[ 'wl_title' => 'SomeDbKey', 'wl_namespace' => '0', 'watchers' => '100' ],
(object)[ 'wl_title' => 'OtherDbKey', 'wl_namespace' => '0', 'watchers' => '300' ],
(object)[ 'wl_title' => 'AnotherDbKey', 'wl_namespace' => '1', 'watchers' => '500' ],
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 2 * 3 + 1 ) )
->method( 'addQuotes' )
->will( $this->returnCallback( static function ( $value ) {
return "'$value'";
} ) );
$mockDb->expects( $this->exactly( 4 ) )
->method( 'timestamp' )
->will( $this->returnCallback( static function ( $value ) {
if ( $value === 0 ) {
return '20200101000000';
}
return 'TS' . $value . 'TS';
} ) );
$mockDb->expects( $this->any() )
->method( 'makeList' )
->with(
$this->isType( 'array' ),
$this->isType( 'int' )
)
->will( $this->returnCallback( static function ( $a, $conj ) {
$sqlConj = $conj === LIST_AND ? ' AND ' : ' OR ';
return implode( $sqlConj, array_map( static function ( $s ) {
return '(' . $s . ')';
}, $a
) );
} ) );
$mockDb->expects( $this->never() )
->method( 'makeWhereFrom2d' );
$expectedCond =
'((wl_namespace = 0) AND (' .
"(((wl_title = 'SomeDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS111TS') OR (wl_notificationtimestamp IS NULL)" .
')) OR (' .
"(wl_title = 'OtherDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS111TS') OR (wl_notificationtimestamp IS NULL)" .
'))))' .
') OR ((wl_namespace = 1) AND (' .
"(((wl_title = 'AnotherDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS123TS') OR (wl_notificationtimestamp IS NULL)" .
')))))';
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
[
$expectedCond,
'we_expiry IS NULL OR we_expiry > \'20200101000000\''
],
$this->isType( 'string' ),
[
'GROUP BY' => [ 'wl_namespace', 'wl_title' ],
]
)
->will(
$this->returnValue( $dbResult )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$expected = [
0 => [ 'SomeDbKey' => 100, 'OtherDbKey' => 300 ],
1 => [ 'AnotherDbKey' => 500 ],
];
$this->assertEquals(
$expected,
$store->countVisitingWatchersMultiple( $titleValuesWithThresholds )
);
}
public function testCountVisitingWatchersMultiple_withMissingTargets() {
$titleValuesWithThresholds = [
[ new TitleValue( 0, 'SomeDbKey' ), '111' ],
[ new TitleValue( 0, 'OtherDbKey' ), '111' ],
[ new TitleValue( 1, 'AnotherDbKey' ), '123' ],
[ new TitleValue( 0, 'SomeNotExisitingDbKey' ), null ],
[ new TitleValue( 0, 'OtherNotExisitingDbKey' ), null ],
];
$dbResult = [
(object)[ 'wl_title' => 'SomeDbKey', 'wl_namespace' => '0', 'watchers' => '100' ],
(object)[ 'wl_title' => 'OtherDbKey', 'wl_namespace' => '0', 'watchers' => '300' ],
(object)[ 'wl_title' => 'AnotherDbKey', 'wl_namespace' => '1', 'watchers' => '500' ],
(object)[ 'wl_title' => 'SomeNotExisitingDbKey', 'wl_namespace' => '0', 'watchers' => '100' ],
(object)[ 'wl_title' => 'OtherNotExisitingDbKey', 'wl_namespace' => '0', 'watchers' => '200' ],
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 2 * 3 ) )
->method( 'addQuotes' )
->will( $this->returnCallback( static function ( $value ) {
return "'$value'";
} ) );
$mockDb->expects( $this->exactly( 3 ) )
->method( 'timestamp' )
->will( $this->returnCallback( static function ( $value ) {
return 'TS' . $value . 'TS';
} ) );
$mockDb->expects( $this->any() )
->method( 'makeList' )
->with(
$this->isType( 'array' ),
$this->isType( 'int' )
)
->will( $this->returnCallback( static function ( $a, $conj ) {
$sqlConj = $conj === LIST_AND ? ' AND ' : ' OR ';
return implode( $sqlConj, array_map( static function ( $s ) {
return '(' . $s . ')';
}, $a
) );
} ) );
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ [ 'SomeNotExisitingDbKey' => 1, 'OtherNotExisitingDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$expectedCond =
'((wl_namespace = 0) AND (' .
"(((wl_title = 'SomeDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS111TS') OR (wl_notificationtimestamp IS NULL)" .
')) OR (' .
"(wl_title = 'OtherDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS111TS') OR (wl_notificationtimestamp IS NULL)" .
'))))' .
') OR ((wl_namespace = 1) AND (' .
"(((wl_title = 'AnotherDbKey') AND (" .
"(wl_notificationtimestamp >= 'TS123TS') OR (wl_notificationtimestamp IS NULL)" .
'))))' .
') OR ' .
'(makeWhereFrom2d return value)';
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist' ],
[ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
[ $expectedCond ],
$this->isType( 'string' ),
[
'GROUP BY' => [ 'wl_namespace', 'wl_title' ],
]
)
->will(
$this->returnValue( $dbResult )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false
] );
$expected = [
0 => [
'SomeDbKey' => 100, 'OtherDbKey' => 300,
'SomeNotExisitingDbKey' => 100, 'OtherNotExisitingDbKey' => 200
],
1 => [ 'AnotherDbKey' => 500 ],
];
$this->assertEquals(
$expected,
$store->countVisitingWatchersMultiple( $titleValuesWithThresholds )
);
}
/**
* @dataProvider provideIntWithDbUnsafeVersion
*/
public function testCountVisitingWatchersMultiple_withMinimumWatchers( $minWatchers ) {
$titleValuesWithThresholds = [
[ new TitleValue( 0, 'SomeDbKey' ), '111' ],
[ new TitleValue( 0, 'OtherDbKey' ), '111' ],
[ new TitleValue( 1, 'AnotherDbKey' ), '123' ],
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->any() )
->method( 'makeList' )
->will( $this->returnValue( 'makeList return value' ) );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist' ],
[ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
[ 'makeList return value' ],
$this->isType( 'string' ),
[
'GROUP BY' => [ 'wl_namespace', 'wl_title' ],
'HAVING' => 'COUNT(*) >= 50',
]
)
->will(
$this->returnValue( [] )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false
] );
$expected = [
0 => [ 'SomeDbKey' => 0, 'OtherDbKey' => 0 ],
1 => [ 'AnotherDbKey' => 0 ],
];
$this->assertEquals(
$expected,
$store->countVisitingWatchersMultiple( $titleValuesWithThresholds, $minWatchers )
);
}
public function testCountUnreadNotifications() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectRowCount' )
->with(
'watchlist',
'1',
[
"wl_notificationtimestamp IS NOT NULL",
'wl_user' => 1,
],
$this->isType( 'string' )
)
->will( $this->returnValue( '9' ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals( 9, $store->countUnreadNotifications( $user ) );
}
/**
* @dataProvider provideIntWithDbUnsafeVersion
*/
public function testCountUnreadNotifications_withUnreadLimit_overLimit( $limit ) {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectRowCount' )
->with(
'watchlist',
'1',
[
"wl_notificationtimestamp IS NOT NULL",
'wl_user' => 1,
],
$this->isType( 'string' ),
[ 'LIMIT' => 50 ]
)
->will( $this->returnValue( '50' ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertSame(
true,
$store->countUnreadNotifications( $user, $limit )
);
}
/**
* @dataProvider provideIntWithDbUnsafeVersion
*/
public function testCountUnreadNotifications_withUnreadLimit_underLimit( $limit ) {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->exactly( 1 ) )
->method( 'selectRowCount' )
->with(
'watchlist',
'1',
[
"wl_notificationtimestamp IS NOT NULL",
'wl_user' => 1,
],
$this->isType( 'string' ),
[ 'LIMIT' => 50 ]
)
->will( $this->returnValue( '9' ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
9,
$store->countUnreadNotifications( $user, $limit )
);
}
public function testDuplicateEntry_nothingToDuplicate() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_user', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_namespace' => 0,
'wl_title' => 'Old_Title',
],
'WatchedItemStore::fetchWatchedItemsForPage',
[ 'FOR UPDATE' ],
[ 'watchlist_expiry' => [ 'LEFT JOIN', [ 'wl_id = we_item' ] ] ]
)
->will( $this->returnValue( new FakeResultWrapper( [] ) ) );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb ] );
$store->duplicateEntry(
new TitleValue( 0, 'Old_Title' ),
new TitleValue( 0, 'New_Title' )
);
}
public function testDuplicateEntry_somethingToDuplicate() {
$fakeRows = [
(object)[
'wl_user' => '1',
'wl_notificationtimestamp' => '20151212010101',
],
(object)[
'wl_user' => '2',
'wl_notificationtimestamp' => null,
],
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->at( 0 ) )
->method( 'select' )
->with(
[ 'watchlist' ],
[ 'wl_user', 'wl_notificationtimestamp' ],
[
'wl_namespace' => 0,
'wl_title' => 'Old_Title',
]
)
->will( $this->returnValue( new FakeResultWrapper( $fakeRows ) ) );
$mockDb->expects( $this->at( 1 ) )
->method( 'replace' )
->with(
'watchlist',
[ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
[
[
'wl_user' => 1,
'wl_namespace' => 0,
'wl_title' => 'New_Title',
'wl_notificationtimestamp' => '20151212010101',
],
[
'wl_user' => 2,
'wl_namespace' => 0,
'wl_title' => 'New_Title',
'wl_notificationtimestamp' => null,
],
],
$this->isType( 'string' )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false,
] );
$store->duplicateEntry(
new TitleValue( 0, 'Old_Title' ),
new TitleValue( 0, 'New_Title' )
);
}
public function testDuplicateAllAssociatedEntries_nothingToDuplicate() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->at( 0 ) )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_user', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_namespace' => 0,
'wl_title' => 'Old_Title',
]
)
->will( $this->returnValue( new FakeResultWrapper( [] ) ) );
$mockDb->expects( $this->at( 1 ) )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_user', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_namespace' => 1,
'wl_title' => 'Old_Title',
]
)
->will( $this->returnValue( new FakeResultWrapper( [] ) ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$store->duplicateAllAssociatedEntries(
new TitleValue( 0, 'Old_Title' ),
new TitleValue( 0, 'New_Title' )
);
}
public function provideLinkTargetPairs() {
return [
[ new TitleValue( 0, 'Old_Title' ), new TitleValue( 0, 'New_Title' ) ],
[ new TitleValue( 0, 'Old_Title' ), new TitleValue( 0, 'New_Title' ) ],
];
}
/**
* @dataProvider provideLinkTargetPairs
*/
public function testDuplicateAllAssociatedEntries_somethingToDuplicate(
LinkTarget $oldTarget,
LinkTarget $newTarget
) {
$fakeRows = [
(object)[
'wl_user' => '1',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => null,
],
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->at( 0 ) )
->method( 'select' )
->with(
[ 'watchlist' ],
[ 'wl_user', 'wl_notificationtimestamp' ],
[
'wl_namespace' => $oldTarget->getNamespace(),
'wl_title' => $oldTarget->getDBkey(),
]
)
->will( $this->returnValue( new FakeResultWrapper( $fakeRows ) ) );
$mockDb->expects( $this->at( 1 ) )
->method( 'replace' )
->with(
'watchlist',
[ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
[
[
'wl_user' => 1,
'wl_namespace' => $newTarget->getNamespace(),
'wl_title' => $newTarget->getDBkey(),
'wl_notificationtimestamp' => '20151212010101',
],
],
$this->isType( 'string' )
);
$mockDb->expects( $this->at( 2 ) )
->method( 'select' )
->with(
[ 'watchlist' ],
[ 'wl_user', 'wl_notificationtimestamp' ],
[
'wl_namespace' => $oldTarget->getNamespace() + 1,
'wl_title' => $oldTarget->getDBkey(),
]
)
->will( $this->returnValue( new FakeResultWrapper( $fakeRows ) ) );
$mockDb->expects( $this->at( 3 ) )
->method( 'replace' )
->with(
'watchlist',
[ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
[
[
'wl_user' => 1,
'wl_namespace' => $newTarget->getNamespace() + 1,
'wl_title' => $newTarget->getDBkey(),
'wl_notificationtimestamp' => '20151212010101',
],
],
$this->isType( 'string' )
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'cache' => $mockCache,
'expiryEnabled' => false,
] );
$store->duplicateAllAssociatedEntries(
$oldTarget,
$newTarget
);
}
public function testAddWatch_nonAnonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'insert' )
->with(
'watchlist',
[
[
'wl_user' => 1,
'wl_namespace' => 0,
'wl_title' => 'Some_Page',
'wl_notificationtimestamp' => null,
]
]
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:Some_Page:1' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$store->addWatch(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'Some_Page' )
);
}
public function testAddWatch_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'insert' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )
->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$store->addWatch(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'Some_Page' )
);
}
public function testAddWatchBatchForUser_readOnlyDBReturnsFalse() {
$store = $this->newWatchedItemStore(
[ 'readOnlyMode' => $this->getMockReadOnlyMode( true ) ] );
$this->assertFalse(
$store->addWatchBatchForUser(
new UserIdentityValue( 1, 'MockUser', 0 ),
[ new TitleValue( 0, 'Some_Page' ), new TitleValue( 1, 'Some_Page' ) ]
)
);
}
public function testAddWatchBatchForUser_nonAnonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'insert' )
->with(
'watchlist',
[
[
'wl_user' => 1,
'wl_namespace' => 0,
'wl_title' => 'Some_Page',
'wl_notificationtimestamp' => null,
],
[
'wl_user' => 1,
'wl_namespace' => 1,
'wl_title' => 'Some_Page',
'wl_notificationtimestamp' => null,
]
]
);
$mockDb->expects( $this->once() )
->method( 'affectedRows' )
->willReturn( 2 );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->exactly( 2 ) )
->method( 'delete' );
$mockCache->expects( $this->at( 1 ) )
->method( 'delete' )
->with( '0:Some_Page:1' );
$mockCache->expects( $this->at( 3 ) )
->method( 'delete' )
->with( '1:Some_Page:1' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$mockUser = new UserIdentityValue( 1, 'MockUser', 0 );
$this->assertTrue(
$store->addWatchBatchForUser(
$mockUser,
[ new TitleValue( 0, 'Some_Page' ), new TitleValue( 1, 'Some_Page' ) ]
)
);
}
public function testAddWatchBatchForUser_anonymousUsersAreSkipped() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'insert' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )
->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->addWatchBatchForUser(
new UserIdentityValue( 0, 'AnonUser', 0 ),
[ new TitleValue( 0, 'Other_Page' ) ]
)
);
}
public function testAddWatchBatchReturnsTrue_whenGivenEmptyList() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'insert' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )
->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertTrue(
$store->addWatchBatchForUser( $user, [] )
);
}
public function testLoadWatchedItem_existingItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => '20300101000000'
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->once() )
->method( 'set' )
->with(
'0:SomeDbKey:1'
);
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$watchedItem = $store->loadWatchedItem(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
);
$this->assertInstanceOf( WatchedItem::class, $watchedItem );
$this->assertSame( 1, $watchedItem->getUser()->getId() );
$this->assertEquals( 'SomeDbKey', $watchedItem->getLinkTarget()->getDBkey() );
$this->assertSame( '20300101000000', $watchedItem->getExpiry() );
$this->assertSame( 0, $watchedItem->getLinkTarget()->getNamespace() );
}
public function testLoadWatchedItem_noItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->will( $this->returnValue( [] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->loadWatchedItem(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testLoadWatchedItem_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'select' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->loadWatchedItem(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testRemoveWatch_existingItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->willReturn( [ 1, 2 ] );
$mockDb->expects( $this->exactly( 2 ) )
->method( 'delete' )
->withConsecutive(
[
'watchlist',
[ 'wl_id' => [ 1, 2 ] ]
],
[
'watchlist_expiry',
[ 'we_item' => [ 1, 2 ] ]
]
);
$mockDb->expects( $this->exactly( 2 ) )
->method( 'affectedRows' )
->willReturn( 2 );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->withConsecutive(
[ '0:SomeDbKey:1' ],
[ '1:SomeDbKey:1' ]
);
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertTrue(
$store->removeWatch(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testRemoveWatch_noItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->willReturn( null );
$mockDb->expects( $this->never() )
->method( 'delete' );
$mockDb->expects( $this->never() )
->method( 'affectedRows' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->withConsecutive(
[ '0:SomeDbKey:1' ],
[ '1:SomeDbKey:1' ]
);
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->removeWatch(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testRemoveWatch_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'delete' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )
->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->removeWatch(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testGetWatchedItem_existingItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => '20300101000000'
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->once() )
->method( 'get' )
->with(
'0:SomeDbKey:1'
)
->will( $this->returnValue( null ) );
$mockCache->expects( $this->once() )
->method( 'set' )
->with(
'0:SomeDbKey:1'
);
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$watchedItem = $store->getWatchedItem(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
);
$this->assertInstanceOf( WatchedItem::class, $watchedItem );
$this->assertSame( 1, $watchedItem->getUser()->getId() );
$this->assertEquals( 'SomeDbKey', $watchedItem->getLinkTarget()->getDBkey() );
$this->assertSame( '20300101000000', $watchedItem->getExpiry() );
$this->assertSame( 0, $watchedItem->getLinkTarget()->getNamespace() );
}
public function testGetWatchedItem_cachedItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockUser = new UserIdentityValue( 1, 'MockUser', 0 );
$linkTarget = new TitleValue( 0, 'SomeDbKey' );
$cachedItem = new WatchedItem( $mockUser, $linkTarget, '20151212010101' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'get' )
->with(
'0:SomeDbKey:1'
)
->will( $this->returnValue( $cachedItem ) );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
$cachedItem,
$store->getWatchedItem(
$mockUser,
$linkTarget
)
);
}
public function testGetWatchedItem_noItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->once() )
->method( 'get' )
->with( '0:SomeDbKey:1' )
->will( $this->returnValue( false ) );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->getWatchedItem(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testGetWatchedItem_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->getWatchedItem(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testGetWatchedItemsForUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[ 'wl_user' => 1, 'we_expiry IS NULL OR we_expiry > 20200101000000' ]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'Foo1',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => '20300101000000'
],
(object)[
'wl_namespace' => 1,
'wl_title' => 'Foo2',
'wl_notificationtimestamp' => null,
],
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$watchedItems = $store->getWatchedItemsForUser( $user );
$this->assertIsArray( $watchedItems );
$this->assertCount( 2, $watchedItems );
foreach ( $watchedItems as $watchedItem ) {
$this->assertInstanceOf( WatchedItem::class, $watchedItem );
}
$this->assertEquals(
new WatchedItem(
$user,
new TitleValue( 0, 'Foo1' ),
'20151212010101',
'20300101000000'
),
$watchedItems[0]
);
$this->assertEquals(
new WatchedItem( $user, new TitleValue( 1, 'Foo2' ), null ),
$watchedItems[1]
);
}
public function provideDbTypes() {
return [
[ false, DB_REPLICA ],
[ true, DB_MASTER ],
];
}
/**
* @dataProvider provideDbTypes
*/
public function testGetWatchedItemsForUser_optionsAndEmptyResult( $forWrite, $dbType ) {
$mockDb = $this->getMockDb();
$mockCache = $this->getMockCache();
$mockLoadBalancer = $this->getMockLBFactory( $mockDb, $dbType );
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[ 'wl_user' => 1, 'we_expiry IS NULL OR we_expiry > 20200101000000' ],
$this->isType( 'string' ),
[ 'ORDER BY' => [ 'wl_namespace ASC', 'wl_title ASC' ] ]
)
->will( $this->returnValue( [] ) );
$store = $this->newWatchedItemStore(
[ 'lbFactory' => $mockLoadBalancer, 'cache' => $mockCache ] );
$watchedItems = $store->getWatchedItemsForUser(
$user,
[ 'forWrite' => $forWrite, 'sort' => WatchedItemStore::SORT_ASC ]
);
$this->assertEquals( [], $watchedItems );
}
public function testGetWatchedItemsForUser_sortByExpiry() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[
'wl_namespace',
'wl_title',
'wl_notificationtimestamp',
'we_expiry',
'wl_has_expiry' => null
],
[ 'wl_user' => 1, 'we_expiry IS NULL OR we_expiry > 20200101000000' ]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'Foo1',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => '20300101000000'
],
(object)[
'wl_namespace' => 0,
'wl_title' => 'Foo2',
'wl_notificationtimestamp' => '20151212010101',
'we_expiry' => '20300701000000'
],
(object)[
'wl_namespace' => 1,
'wl_title' => 'Foo3',
'wl_notificationtimestamp' => null,
],
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$watchedItems = $store->getWatchedItemsForUser(
$user,
[ 'sortByExpiry' => true, 'sort' => WatchedItemStore::SORT_ASC ]
);
$this->assertIsArray( $watchedItems );
$this->assertCount( 3, $watchedItems );
foreach ( $watchedItems as $watchedItem ) {
$this->assertInstanceOf( WatchedItem::class, $watchedItem );
}
$this->assertEquals(
new WatchedItem(
$user,
new TitleValue( 0, 'Foo1' ),
'20151212010101',
'20300101000000'
),
$watchedItems[0]
);
$this->assertEquals(
new WatchedItem( $user, new TitleValue( 1, 'Foo3' ), null ),
$watchedItems[2]
);
}
public function testGetWatchedItemsForUser_badSortOptionThrowsException() {
$store = $this->newWatchedItemStore();
$this->expectException( InvalidArgumentException::class );
$store->getWatchedItemsForUser(
new UserIdentityValue( 1, 'MockUser', 0 ),
[ 'sort' => 'foo' ]
);
}
public function testIsWatchedItem_existingItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->once() )
->method( 'get' )
->with( '0:SomeDbKey:1' )
->will( $this->returnValue( false ) );
$mockCache->expects( $this->once() )
->method( 'set' )
->with(
'0:SomeDbKey:1'
);
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertTrue(
$store->isWatched(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testIsWatchedItem_noItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$mockCache->expects( $this->once() )
->method( 'get' )
->with( '0:SomeDbKey:1' )
->will( $this->returnValue( false ) );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->isWatched(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testIsWatchedItem_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->isWatched(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testGetNotificationTimestampsBatch() {
$targets = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$mockDb = $this->getMockDb();
$dbResult = [
(object)[
'wl_namespace' => '0',
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
],
(object)[
'wl_namespace' => '1',
'wl_title' => 'AnotherDbKey',
'wl_notificationtimestamp' => null,
],
];
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ [ 'SomeDbKey' => 1 ], [ 'AnotherDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
'watchlist',
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
[
'makeWhereFrom2d return value',
'wl_user' => 1
],
$this->isType( 'string' )
)
->will( $this->returnValue( $dbResult ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->exactly( 2 ) )
->method( 'get' )
->withConsecutive(
[ '0:SomeDbKey:1' ],
[ '1:AnotherDbKey:1' ]
)
->will( $this->returnValue( null ) );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[
0 => [ 'SomeDbKey' => '20151212010101', ],
1 => [ 'AnotherDbKey' => null, ],
],
$store->getNotificationTimestampsBatch(
new UserIdentityValue( 1, 'MockUser', 0 ), $targets )
);
}
public function testGetNotificationTimestampsBatch_notWatchedTarget() {
$targets = [
new TitleValue( 0, 'OtherDbKey' ),
];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ [ 'OtherDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
'watchlist',
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
[
'makeWhereFrom2d return value',
'wl_user' => 1
],
$this->isType( 'string' )
)
->will( $this->returnValue( (object)[] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->once() )
->method( 'get' )
->with( '0:OtherDbKey:1' )
->will( $this->returnValue( null ) );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[
0 => [ 'OtherDbKey' => false, ],
],
$store->getNotificationTimestampsBatch(
new UserIdentityValue( 1, 'MockUser', 0 ), $targets )
);
}
public function testGetNotificationTimestampsBatch_cachedItem() {
$targets = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$cachedItem = new WatchedItem( $user, $targets[0], '20151212010101' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'makeWhereFrom2d' )
->with(
[ 1 => [ 'AnotherDbKey' => 1 ] ],
$this->isType( 'string' ),
$this->isType( 'string' )
)
->will( $this->returnValue( 'makeWhereFrom2d return value' ) );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
'watchlist',
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
[
'makeWhereFrom2d return value',
'wl_user' => 1
],
$this->isType( 'string' )
)
->will( $this->returnValue( [
(object)[ 'wl_namespace' => '1', 'wl_title' => 'AnotherDbKey', 'wl_notificationtimestamp' => null, ]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->at( 1 ) )
->method( 'get' )
->with( '0:SomeDbKey:1' )
->will( $this->returnValue( $cachedItem ) );
$mockCache->expects( $this->at( 3 ) )
->method( 'get' )
->with( '1:AnotherDbKey:1' )
->will( $this->returnValue( null ) );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[
0 => [ 'SomeDbKey' => '20151212010101', ],
1 => [ 'AnotherDbKey' => null, ],
],
$store->getNotificationTimestampsBatch( $user, $targets )
);
}
public function testGetNotificationTimestampsBatch_allItemsCached() {
$targets = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$cachedItems = [
new WatchedItem( $user, $targets[0], '20151212010101' ),
new WatchedItem( $user, $targets[1], null ),
];
$mockDb = $this->createNoOpMock( IDatabase::class );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->at( 1 ) )
->method( 'get' )
->with( '0:SomeDbKey:1' )
->will( $this->returnValue( $cachedItems[0] ) );
$mockCache->expects( $this->at( 3 ) )
->method( 'get' )
->with( '1:AnotherDbKey:1' )
->will( $this->returnValue( $cachedItems[1] ) );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[
0 => [ 'SomeDbKey' => '20151212010101', ],
1 => [ 'AnotherDbKey' => null, ],
],
$store->getNotificationTimestampsBatch( $user, $targets )
);
}
public function testGetNotificationTimestampsBatch_anonymousUser() {
$targets = [
new TitleValue( 0, 'SomeDbKey' ),
new TitleValue( 1, 'AnotherDbKey' ),
];
$mockDb = $this->createNoOpMock( IDatabase::class );
$mockCache = $this->createNoOpMock( HashBagOStuff::class );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[
0 => [ 'SomeDbKey' => false, ],
1 => [ 'AnotherDbKey' => false, ],
],
$store->getNotificationTimestampsBatch(
new UserIdentityValue( 0, 'AnonUser', 0 ), $targets )
);
}
public function testResetNotificationTimestamp_anonymousUser() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->resetNotificationTimestamp(
new UserIdentityValue( 0, 'AnonUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testResetNotificationTimestamp_noItem() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertFalse(
$store->resetNotificationTimestamp(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' )
)
);
}
public function testResetNotificationTimestamp_item() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$title = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'set' )
->with(
'0:SomeDbKey:1',
$this->isInstanceOf( WatchedItem::class )
);
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockQueueGroup->expects( $this->once() )
->method( 'lazyPush' )
->willReturnCallback( static function ( ActivityUpdateJob $job ) {
// don't run
} );
// We don't care if these methods actually do anything here
$mockRevisionLookup = $this->getMockRevisionLookup( [
'getRevisionByTitle' => static function () {
return null;
},
'getTimestampFromId' => static function () {
return '00000000000000';
},
] );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title
)
);
}
public function testResetNotificationTimestamp_noItemForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$title = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
// We don't care if these methods actually do anything here
$mockRevisionLookup = $this->getMockRevisionLookup( [
'getRevisionByTitle' => static function () {
return null;
},
'getTimestampFromId' => static function () {
return '00000000000000';
},
] );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->willReturnCallback( static function ( ActivityUpdateJob $job ) {
// don't run
} );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'force'
)
);
}
private function verifyCallbackJob(
ActivityUpdateJob $job,
LinkTarget $expectedTitle,
$expectedUserId,
callable $notificationTimestampCondition
) {
$this->assertEquals( $expectedTitle->getDBkey(), $job->getTitle()->getDBkey() );
$this->assertEquals( $expectedTitle->getNamespace(), $job->getTitle()->getNamespace() );
$jobParams = $job->getParams();
$this->assertArrayHasKey( 'type', $jobParams );
$this->assertEquals( 'updateWatchlistNotification', $jobParams['type'] );
$this->assertArrayHasKey( 'userid', $jobParams );
$this->assertEquals( $expectedUserId, $jobParams['userid'] );
$this->assertArrayHasKey( 'notifTime', $jobParams );
$this->assertTrue( $notificationTimestampCondition( $jobParams['notifTime'] ) );
}
public function testResetNotificationTimestamp_oldidSpecifiedLatestRevisionForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$oldid = 22;
$title = new TitleValue( 0, 'SomeTitle' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->never() )
->method( 'selectRow' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeTitle:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockRevisionRecord = $this->createNoOpMock( RevisionRecord::class );
$mockRevisionLookup = $this->getMockRevisionLookup( [
'getTimestampFromId' => static function () {
return '00000000000000';
},
'getRevisionById' => function ( $id, $flags ) use ( $oldid, $mockRevisionRecord ) {
$this->assertSame( $oldid, $id );
$this->assertSame( 0, $flags );
return $mockRevisionRecord;
},
'getNextRevision' =>
function ( $oldRev ) use ( $mockRevisionRecord ) {
$this->assertSame( $mockRevisionRecord, $oldRev );
return false;
},
], [
'getNextRevision' => 1,
] );
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback(
function ( ActivityUpdateJob $job ) use ( $title, $user ) {
$this->verifyCallbackJob(
$job,
$title,
$user->getId(),
static function ( $time ) {
return $time === null;
}
);
}
) );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'force',
$oldid
)
);
}
public function testResetNotificationTimestamp_oldidSpecifiedNotLatestRevisionForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$oldid = 22;
$title = new TitleValue( 0, 'SomeDbKey' );
$mockRevision = $this->createNoOpMock( RevisionRecord::class );
$mockNextRevision = $this->createNoOpMock( RevisionRecord::class );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101',
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'set' )
->with( '0:SomeDbKey:1', $this->isType( 'object' ) );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockRevisionLookup = $this->getMockRevisionLookup(
[
'getTimestampFromId' => function ( $oldidParam ) use ( $oldid ) {
$this->assertSame( $oldid, $oldidParam );
},
'getRevisionById' => function ( $id ) use ( $oldid, $mockRevision ) {
$this->assertSame( $oldid, $id );
return $mockRevision;
},
'getNextRevision' =>
function ( RevisionRecord $rev ) use ( $mockRevision, $mockNextRevision ) {
$this->assertSame( $mockRevision, $rev );
return $mockNextRevision;
},
],
[
'getTimestampFromId' => 2,
'getRevisionById' => 1,
'getNextRevision' => 1,
]
);
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback(
function ( ActivityUpdateJob $job ) use ( $title, $user ) {
$this->verifyCallbackJob(
$job,
$title,
$user->getId(),
static function ( $time ) {
return $time !== null && $time > '20151212010101';
}
);
}
) );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'force',
$oldid
)
);
}
public function testResetNotificationTimestamp_notWatchedPageForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$oldid = 22;
$title = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( false ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockRevision = $this->createNoOpMock( RevisionRecord::class );
$mockNextRevision = $this->createNoOpMock( RevisionRecord::class );
$mockRevisionLookup = $this->getMockRevisionLookup(
[
'getTimestampFromId' => function ( $oldidParam ) use ( $oldid ) {
$this->assertSame( $oldid, $oldidParam );
},
'getRevisionById' => function ( $id ) use ( $oldid, $mockRevision ) {
$this->assertSame( $oldid, $id );
return $mockRevision;
},
'getNextRevision' =>
function ( RevisionRecord $rev ) use ( $mockRevision, $mockNextRevision ) {
$this->assertSame( $mockRevision, $rev );
return $mockNextRevision;
},
],
[
'getTimestampFromId' => 1,
'getRevisionById' => 1,
'getNextRevision' => 1,
]
);
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback(
function ( ActivityUpdateJob $job ) use ( $title, $user ) {
$this->verifyCallbackJob(
$job,
$title,
$user->getId(),
static function ( $time ) {
return $time === null;
}
);
}
) );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'force',
$oldid
)
);
}
public function testResetNotificationTimestamp_futureNotificationTimestampForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$oldid = 22;
$title = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000'
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '30151212010101',
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'set' )
->with( '0:SomeDbKey:1', $this->isType( 'object' ) );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockRevision = $this->createNoOpMock( RevisionRecord::class );
$mockNextRevision = $this->createNoOpMock( RevisionRecord::class );
$mockRevisionLookup = $this->getMockRevisionLookup(
[
'getTimestampFromId' => function ( $oldidParam ) use ( $oldid ) {
$this->assertEquals( $oldid, $oldidParam );
},
'getRevisionById' => function ( $id ) use ( $oldid, $mockRevision ) {
$this->assertSame( $oldid, $id );
return $mockRevision;
},
'getNextRevision' =>
function ( RevisionRecord $rev ) use ( $mockRevision, $mockNextRevision ) {
$this->assertSame( $mockRevision, $rev );
return $mockNextRevision;
},
],
[
'getTimestampFromId' => 2,
'getRevisionById' => 1,
'getNextRevision' => 1,
]
);
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback(
function ( ActivityUpdateJob $job ) use ( $title, $user ) {
$this->verifyCallbackJob(
$job,
$title,
$user->getId(),
static function ( $time ) {
return $time === '30151212010101';
}
);
}
) );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'force',
$oldid
)
);
}
public function testResetNotificationTimestamp_futureNotificationTimestampNotForced() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$oldid = 22;
$title = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$makeListSql = "wl_namespace = 0 AND wl_title = 'SomeDbKey'";
$mockDb->expects( $this->exactly( 2 ) )
->method( 'makeList' )
->willReturnOnConsecutiveCalls( $makeListSql, $makeListSql );
$mockDb->expects( $this->once() )
->method( 'select' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
[ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp', 'we_expiry' ],
[
'wl_user' => 1,
$makeListSql,
'we_expiry IS NULL OR we_expiry > 20200101000000',
]
)
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '30151212010101',
]
] ) );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->once() )
->method( 'set' )
->with( '0:SomeDbKey:1', $this->isType( 'object' ) );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$mockQueueGroup = $this->getMockJobQueueGroup();
$mockRevision = $this->createNoOpMock( RevisionRecord::class );
$mockNextRevision = $this->createNoOpMock( RevisionRecord::class );
$mockRevisionLookup = $this->getMockRevisionLookup(
[
'getTimestampFromId' => function ( $oldidParam ) use ( $oldid ) {
$this->assertEquals( $oldid, $oldidParam );
},
'getRevisionById' => function ( $id ) use ( $oldid, $mockRevision ) {
$this->assertSame( $oldid, $id );
return $mockRevision;
},
'getNextRevision' =>
function ( RevisionRecord $rev ) use ( $mockRevision, $mockNextRevision ) {
$this->assertSame( $mockRevision, $rev );
return $mockNextRevision;
},
],
[
'getTimestampFromId' => 2,
'getRevisionById' => 1,
'getNextRevision' => 1,
]
);
$store = $this->newWatchedItemStore( [
'db' => $mockDb,
'queueGroup' => $mockQueueGroup,
'cache' => $mockCache,
'revisionLookup' => $mockRevisionLookup,
] );
$mockQueueGroup->expects( $this->any() )
->method( 'lazyPush' )
->will( $this->returnCallback(
function ( ActivityUpdateJob $job ) use ( $title, $user ) {
$this->verifyCallbackJob(
$job,
$title,
$user->getId(),
static function ( $time ) {
return $time === false;
}
);
}
) );
$this->assertTrue(
$store->resetNotificationTimestamp(
$user,
$title,
'',
$oldid
)
);
}
public function testSetNotificationTimestampsForUser_anonUser() {
$store = $this->newWatchedItemStore();
$this->assertFalse( $store->setNotificationTimestampsForUser(
new UserIdentityValue( 0, 'AnonUser', 0 ), '' ) );
}
public function testSetNotificationTimestampsForUser_allRows() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$timestamp = '20100101010101';
$store = $this->newWatchedItemStore();
// Note: This does not actually assert the job is correct
$callableCallCounter = 0;
$mockCallback = function ( $callable ) use ( &$callableCallCounter ) {
$callableCallCounter++;
$this->assertIsCallable( $callable );
};
$scopedOverride = $store->overrideDeferredUpdatesAddCallableUpdateCallback( $mockCallback );
$this->assertTrue(
$store->setNotificationTimestampsForUser( $user, $timestamp )
);
$this->assertSame( 1, $callableCallCounter );
}
public function testSetNotificationTimestampsForUser_nullTimestamp() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$timestamp = null;
$store = $this->newWatchedItemStore();
// Note: This does not actually assert the job is correct
$callableCallCounter = 0;
$mockCallback = function ( $callable ) use ( &$callableCallCounter ) {
$callableCallCounter++;
$this->assertIsCallable( $callable );
};
$scopedOverride = $store->overrideDeferredUpdatesAddCallableUpdateCallback( $mockCallback );
$this->assertTrue(
$store->setNotificationTimestampsForUser( $user, $timestamp )
);
}
public function testSetNotificationTimestampsForUser_specificTargets() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$timestamp = '20100101010101';
$targets = [ new TitleValue( 0, 'Foo' ), new TitleValue( 0, 'Bar' ) ];
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'update' )
->with(
'watchlist',
[ 'wl_notificationtimestamp' => 'TS' . $timestamp . 'TS' ],
[ 'wl_user' => 1, 'wl_namespace' => 0, 'wl_title' => [ 'Foo', 'Bar' ] ]
)
->will( $this->returnValue( true ) );
$mockDb->expects( $this->exactly( 1 ) )
->method( 'timestamp' )
->will( $this->returnCallback( static function ( $value ) {
return 'TS' . $value . 'TS';
} ) );
$mockDb->expects( $this->once() )
->method( 'affectedRows' )
->will( $this->returnValue( 2 ) );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb ] );
$this->assertTrue(
$store->setNotificationTimestampsForUser( $user, $timestamp, $targets )
);
}
public function testUpdateNotificationTimestamp_watchersExist() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
'wl_user',
[
'wl_user != 1',
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp IS NULL',
'we_expiry IS NULL OR we_expiry > 20200101000000',
]
)
->will( $this->returnValue( [ '2', '3' ] ) );
$mockDb->expects( $this->once() )
->method( 'update' )
->with(
'watchlist',
[ 'wl_notificationtimestamp' => null ],
[
'wl_user' => [ 2, 3 ],
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
]
);
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$this->assertEquals(
[ 2, 3 ],
$store->updateNotificationTimestamp(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' ),
'20151212010101'
)
);
}
public function testUpdateNotificationTimestamp_noWatchers() {
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->with(
[ 'watchlist', 'watchlist_expiry' ],
'wl_user',
[
'wl_user != 1',
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp IS NULL',
'we_expiry IS NULL OR we_expiry > 20200101000000',
],
'WatchedItemStore::updateNotificationTimestamp',
[],
[ 'watchlist_expiry' => [ 'LEFT JOIN', 'wl_id = we_item' ] ]
)
->will(
$this->returnValue( [] )
);
$mockDb->expects( $this->never() )
->method( 'update' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->never() )->method( 'set' );
$mockCache->expects( $this->never() )->method( 'get' );
$mockCache->expects( $this->never() )->method( 'delete' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$watchers = $store->updateNotificationTimestamp(
new UserIdentityValue( 1, 'MockUser', 0 ),
new TitleValue( 0, 'SomeDbKey' ),
'20151212010101'
);
$this->assertSame( [], $watchers );
}
public function testUpdateNotificationTimestamp_clearsCachedItems() {
$user = new UserIdentityValue( 1, 'MockUser', 0 );
$titleValue = new TitleValue( 0, 'SomeDbKey' );
$mockDb = $this->getMockDb();
$mockDb->expects( $this->once() )
->method( 'select' )
->will( $this->returnValue( [
(object)[
'wl_namespace' => 0,
'wl_title' => 'SomeDbKey',
'wl_notificationtimestamp' => '20151212010101'
]
] ) );
$mockDb->expects( $this->once() )
->method( 'selectFieldValues' )
->will(
$this->returnValue( [ '2', '3' ] )
);
$mockDb->expects( $this->once() )
->method( 'update' );
$mockCache = $this->getMockCache();
$mockCache->expects( $this->once() )
->method( 'set' )
->with( '0:SomeDbKey:1', $this->isType( 'object' ) );
$mockCache->expects( $this->once() )
->method( 'get' )
->with( '0:SomeDbKey:1' );
$mockCache->expects( $this->once() )
->method( 'delete' )
->with( '0:SomeDbKey:1' );
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
// This will add the item to the cache
$store->getWatchedItem( $user, $titleValue );
$store->updateNotificationTimestamp(
new UserIdentityValue( 1, 'MockUser', 0 ),
$titleValue,
'20151212010101'
);
}
public function testRemoveExpired() {
$mockDb = $this->getMockDb();
// addQuotes is used for the expiry value.
$mockDb->expects( $this->once() )
->method( 'addQuotes' )
->willReturn( '20200101000000' );
// Select watchlist IDs.
$mockDb->expects( $this->exactly( 2 ) )
->method( 'selectFieldValues' )
->withConsecutive(
// Select expired items.
[
'watchlist_expiry',
'we_item',
[ 'we_expiry <= 20200101000000' ],
'WatchedItemStore::removeExpired',
[ 'LIMIT' => 2 ]
],
// Select orphaned items.
[
[ 'watchlist_expiry', 'watchlist' ],
'we_item',
[ 'wl_id' => null, 'we_expiry' => null ],
'WatchedItemStore::removeExpired',
[],
[ 'watchlist' => [ 'LEFT JOIN', 'wl_id = we_item' ] ]
]
)
->willReturnOnConsecutiveCalls(
[ 1, 2 ],
[ 3 ]
);
// Return whatever is passed to makeList, to be tested below.
$mockDb->expects( $this->once() )
->method( 'makeList' )
->willReturnArgument( 0 );
// Delete from watchlist and watchlist_expiry.
$mockDb->expects( $this->exactly( 3 ) )
->method( 'delete' )
->withConsecutive(
// Delete expired items from watchlist
[
'watchlist',
[ 'wl_id' => [ 1, 2 ] ],
'WatchedItemStore::removeExpired'
],
// Delete expired items from watchlist_expiry
[
'watchlist_expiry',
[ 'we_item' => [ 1, 2 ] ],
'WatchedItemStore::removeExpired'
],
// Delete orphaned items
[
'watchlist_expiry',
[ 'we_item' => [ 3 ] ],
'WatchedItemStore::removeExpired'
]
);
$mockCache = $this->getMockCache();
$store = $this->newWatchedItemStore( [ 'db' => $mockDb, 'cache' => $mockCache ] );
$store->removeExpired( 2, true );
}
}