wikimedia/mediawiki-extensions-Linter
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Linter synced 2024-11-23 15:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Delete lint error records when content model changes from wikitext

Browse source 
* Determines if new content type is not wikitext and if so
   deletes all existing lint error records for that pageID.

Bug: T298343
Change-Id: I20fac9a0c901f3e7a5cc898566a4487fbe70798f
This commit is contained in:
sbailey 2022-02-08 15:19:12 -08:00
parent e46f7d8f78
commit 0e56c22277
3 changed files with 141 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
extension.json
View file

@ -30,6 +30,7 @@
"APIQuerySiteInfoGeneralInfo": "MediaWiki\\Linter\\Hooks::onAPIQuerySiteInfoGeneralInfo",
"InfoAction": "MediaWiki\\Linter\\Hooks::onInfoAction",
"WikiPageDeletionUpdates": "MediaWiki\\Linter\\Hooks::onWikiPageDeletionUpdates",
"RevisionFromEditComplete": "MediaWiki\\Linter\\Hooks::onRevisionFromEditComplete",
"ParserLogLinterData": "MediaWiki\\Linter\\Hooks::onParserLogLinterData"
},
"APIModules": {

27
includes/Hooks.php
View file

@ -26,6 +26,8 @@ use DatabaseUpdater;
use IContextSource;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\User\UserIdentity;
use MWCallableUpdate;
use OutputPage;
use Title;
@ -121,6 +123,31 @@ class Hooks {
}, __METHOD__ );
}
/**
* Hook: RevisionFromEditComplete
*
* Remove entries from the linter table upon page content model change away from wikitext
*
* @param WikiPage $wikiPage
* @param RevisionRecord $newRevisionRecord
* @param bool|int $originalRevId
* @param UserIdentity $user
* @param string[] &$tags
*/
public static function onRevisionFromEditComplete( WikiPage $wikiPage,
RevisionRecord $newRevisionRecord,
$originalRevId,
UserIdentity $user,
&$tags
) {
if ( in_array( "mw-contentmodelchange", $tags ) &&
$wikiPage->getContentModel() !== "wikitext"
) {
$database = new Database( $wikiPage->getId() );
$database->updateStats( $database->setForPage( [] ) );
}
}
/**
* Hook: APIQuerySiteInfoGeneralInfo
*

113
tests/phpunit/SpecialLintErrorsTest.php
View file

@ -20,8 +20,14 @@
namespace MediaWiki\Linter\Test;
use ContentHandler;
use MediaWiki\Linter\CategoryManager;
use MediaWiki\Linter\Database;
use MediaWiki\Linter\LintError;
use MediaWiki\Linter\RecordLintJob;
use MediaWiki\Linter\SpecialLintErrors;
use Title;
use User;
/**
* @covers MediaWiki\Linter\SpecialLintErrors
@ -46,4 +52,111 @@ class SpecialLintErrorsTest extends \SpecialPageTestBase {
);
}
/**
* @return array
*/
private function createTitleAndPage() {
$titleText = 'TestPage';
$userName = 'LinterUser';
$baseText = 'wikitext test content';
$ns = $this->getDefaultWikitextNS();
$title = Title::newFromText( $titleText, $ns );
$user = User::newFromName( $userName );
if ( $user->getId() === 0 ) {
$user->addToDatabase();
}
$page = $this->getServiceContainer()->getWikiPageFactory()->newFromTitle( $title );
$content = ContentHandler::makeContent( $baseText, $title );
$page->doUserEditContent( $content, $user, "base text for test" );
return [
'title' => $title,
'pageID' => $page->getRevisionRecord()->getPageId(),
'revID' => $page->getRevisionRecord()->getID(),
'page' => $page,
'user' => $user
];
}
public function testContentModelChange() {
$error = [
'type' => 'obsolete-tag',
'location' => [ 0, 10 ],
'params' => [],
'dbid' => null,
];
$titleAndPage = $this->createTitleAndPage();
$job = new RecordLintJob( $titleAndPage['title'], [
'errors' => [ $error ],
'revision' => $titleAndPage['revID']
] );
$this->assertTrue( $job->run() );
$db = new Database( $titleAndPage['pageID'] );
/** @var LintError[] $errorsFromDb */
$errorsFromDb = array_values( $db->getForPage() );
$this->assertCount( 1, $errorsFromDb );
$cssText = 'css content model change test page content';
$content = ContentHandler::makeContent(
$cssText,
$titleAndPage['title'],
'css'
);
$page = $titleAndPage['page'];
$page->doUserEditContent(
$content,
$titleAndPage['user'],
"update with css content model to trigger onRevisionFromEditComplete hook"
);
$errorsFromDb = array_values( $db->getForPage() );
$this->assertCount( 0, $errorsFromDb );
}
public function testContentModelChangeWithBlankPage() {
$error = [
'type' => 'obsolete-tag',
'location' => [ 0, 10 ],
'params' => [],
'dbid' => null,
];
$titleAndPage = $this->createTitleAndPage();
$job = new RecordLintJob( $titleAndPage['title'], [
'errors' => [ $error ],
'revision' => $titleAndPage['revID']
] );
$this->assertTrue( $job->run() );
$db = new Database( $titleAndPage['pageID'] );
/** @var LintError[] $errorsFromDb */
$errorsFromDb = array_values( $db->getForPage() );
$this->assertCount( 1, $errorsFromDb );
// This test recreates the doUserEditContent bug mentioned in T280193 of not
// calling the onRevisionFromEditComplete hook with the "mw-contentmodelchange"
// tag set when the new content text is literally blank.
$blankText = '';
$content = ContentHandler::makeContent(
$blankText,
$titleAndPage['title'],
'text'
);
$page = $titleAndPage['page'];
$page->doUserEditContent(
$content,
$titleAndPage['user'],
"update with blank text content model to trigger onRevisionFromEditComplete hook"
);
$errorsFromDb = array_values( $db->getForPage() );
$this->assertCount( 1, $errorsFromDb );
// After fixing https://phabricator.wikimedia.org/T280193 this should pass
// when the above line is removed and the following line enabled.
// $this->assertCount( 0, $errorsFromDb );
}
}