aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/includes/recentchanges/RecentChangesUpdateJobTest.php
blob: d67f1f98f24cee92a44756ab851b82896b66422f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?php

use MediaWiki\MainConfigNames;
use Wikimedia\Timestamp\ConvertibleTimestamp;

/**
 * @group Database
 * @covers \MediaWiki\RecentChanges\RecentChangesUpdateJob
 * @author Dreamy Jazz
 */
class RecentChangesUpdateJobTest extends MediaWikiIntegrationTestCase {

	private function addTestingExpiredRows() {
		// Make three testing edits, which will trigger a recentchanges insert. Two of the edits will be made
		// over wgRCMaxAge seconds ago while the other will be made a day ago
		$testPage = $this->getExistingTestPage();
		$testUser = $this->getTestUser()->getAuthority();
		// So that only our two testing edits are present, and nothing from creating the test page or test user
		$this->truncateTable( 'recentchanges' );
		// Fix wgRCMaxAge at a high value to ensure that the recentchanges entries we are creating are not purged
		// by later testing edits.
		$this->overrideConfigValue( MainConfigNames::RCMaxAge, 24 * 3600 * 1000 );
		ConvertibleTimestamp::setFakeTime( '20230405060708' );
		$this->editPage( $testPage, 'testing1234', '', NS_MAIN, $testUser );
		ConvertibleTimestamp::setFakeTime( '20230705060708' );
		$this->editPage( $testPage, 'testing12345', '', NS_MAIN, $testUser );
		ConvertibleTimestamp::setFakeTime( '20240405060708' );
		$this->editPage( $testPage, 'testing123456', '', NS_MAIN, $testUser );
		// Verify that the recentchanges table row count is as expected for the test
		$this->newSelectQueryBuilder()
			->field( 'COUNT(*)' )
			->table( 'recentchanges' )
			->assertFieldValue( 3 );
	}

	public function testNewPurgeJob() {
		$this->addTestingExpiredRows();
		// Set the time as one day beyond the last test edit
		ConvertibleTimestamp::setFakeTime( '20240406060708' );
		// Fix wgRCMaxAge for the test, in case the default value changes.
		$this->overrideConfigValue( MainConfigNames::RCMaxAge, 90 * 24 * 3600 );
		$hookRunAtLeastOnce = false;
		$this->setTemporaryHook( 'RecentChangesPurgeRows', function ( $rows ) use ( &$hookRunAtLeastOnce ) {
			// Check that the first row has the expected columns. Checking just the first row should be fine
			// as the value of $rows should come from ::fetchResultSet which returns the same columns for each
			// returned row.
			$rowAsArray = (array)$rows[0];
			// To get the expected fields, use the value of the items in the 'fields' array. The exception to this
			// is where the key is a string, when it should be used instead (as this is an alias).
			$recentChangeQueryFields = RecentChange::getQueryInfo()['fields'];
			$expectedFields = [];
			foreach ( $recentChangeQueryFields as $key => $value ) {
				if ( is_string( $key ) ) {
					$expectedFields[] = $key;
				} else {
					$expectedFields[] = $value;
				}
			}
			$this->assertArrayEquals(
				$expectedFields,
				array_keys( $rowAsArray ),
				false,
				true,
				'Columns in the provided $row are not as expected'
			);
			$hookRunAtLeastOnce = true;
		} );
		// Call the code we are testing
		$objectUnderTest = RecentChangesUpdateJob::newPurgeJob();
		$this->assertInstanceOf( RecentChangesUpdateJob::class, $objectUnderTest );
		$objectUnderTest->run();
		// Verify that only the edit made a day ago is now in the recentchanges table
		$this->newSelectQueryBuilder()
			->field( 'rc_timestamp' )
			->table( 'recentchanges' )
			->assertFieldValue( $this->getDb()->timestamp( '20240405060708' ) );
		// Verify that the lock placed to do the purge is no longer active.
		$this->assertTrue( $this->getDb()->lockIsFree(
			$this->getDb()->getDomainID() . ':recentchanges-prune', __METHOD__
		) );
		// Check that the RecentChangesPurgeRows hook was run at least once
		$this->assertTrue( $hookRunAtLeastOnce, 'RecentChangesPurgeRows hook was not run' );
	}

	/** @dataProvider provideInvalidTypes */
	public function testWhenTypeForInvalidType( $type ) {
		$this->expectException( InvalidArgumentException::class );
		$objectUnderTest = new RecentChangesUpdateJob( $this->getExistingTestPage()->getTitle(), [ 'type' => $type ] );
		$objectUnderTest->run();
	}

	public static function provideInvalidTypes() {
		return [
			'Type is null' => [ null ],
			'Type is a unrecognised string' => [ 'unknown-type' ],
		];
	}
}