mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-11-25 00:38:33 +00:00
346 lines
12 KiB
PHP
346 lines
12 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools\Tests;
|
|
|
|
use DateTimeImmutable;
|
|
use MediaWiki\Page\PageIdentityValue;
|
|
use MediaWiki\Revision\MutableRevisionRecord;
|
|
use MediaWiki\User\UserIdentityValue;
|
|
use RawMessage;
|
|
use Wikimedia\Parsoid\Utils\DOMCompat;
|
|
|
|
/**
|
|
* @coversDefaultClass \MediaWiki\Extension\DiscussionTools\Notifications\EventDispatcher
|
|
*
|
|
* @group DiscussionTools
|
|
*/
|
|
class EventDispatcherTest extends IntegrationTestCase {
|
|
|
|
/**
|
|
* @dataProvider provideGenerateCases
|
|
* @covers ::generateEventsFromParsers
|
|
*/
|
|
public function testGenerateEventsFromParsers(
|
|
string $rev1, string $rev2, string $authorUsername, string $other, string $expected
|
|
): void {
|
|
$wikitext1 = self::getText( $rev1 );
|
|
$wikitext2 = self::getText( $rev2 );
|
|
$expectedEvents = self::getJson( $expected, false );
|
|
$config = self::getJson( "../data/enwiki-config.json" );
|
|
$data = self::getJson( "../data/enwiki-data.json" );
|
|
|
|
$dom1 = ( new RawMessage( $wikitext1 ) )->parse();
|
|
$doc1 = self::createDocument( $dom1 );
|
|
$body1 = DOMCompat::getBody( $doc1 );
|
|
|
|
$dom2 = ( new RawMessage( $wikitext2 ) )->parse();
|
|
$doc2 = self::createDocument( $dom2 );
|
|
$body2 = DOMCompat::getBody( $doc2 );
|
|
|
|
$this->setupEnv( $config, $data );
|
|
$parser1 = self::createParser( $body1, $data );
|
|
$parser2 = self::createParser( $body2, $data );
|
|
|
|
$events = self::getJson( $other, true );
|
|
|
|
$fakeUser = new UserIdentityValue( 0, $authorUsername );
|
|
$fakeTitle = new PageIdentityValue( 0, NS_TALK, __CLASS__, PageIdentityValue::LOCAL );
|
|
$fakeRevRecord = new MutableRevisionRecord( $fakeTitle );
|
|
// All mock comments are posted between 00:00 and 00:10 on 2020-01-01
|
|
$fakeRevRecord->setTimestamp( ( new DateTimeImmutable( '2020-01-01T00:10' ) )->format( 'c' ) );
|
|
MockEventDispatcher::generateEventsFromParsers(
|
|
$events, $parser1, $parser2, $fakeRevRecord, $fakeTitle, $fakeUser
|
|
);
|
|
|
|
foreach ( $events as &$event ) {
|
|
$event = json_decode( json_encode( $event ), false );
|
|
}
|
|
|
|
// Optionally write updated content to the JSON files
|
|
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
|
|
self::overwriteJsonFile( $expected, $events );
|
|
}
|
|
|
|
self::assertEquals( $expectedEvents, $events );
|
|
|
|
// Assert that no events are generated for comments saved >10 minutes after their timestamps
|
|
$events = self::getJson( $other, true );
|
|
$fakeRevRecord->setTimestamp( ( new DateTimeImmutable( '2020-01-01T00:20' ) )->format( 'c' ) );
|
|
MockEventDispatcher::generateEventsFromParsers(
|
|
$events, $parser1, $parser2, $fakeRevRecord, $fakeTitle, $fakeUser
|
|
);
|
|
|
|
foreach ( $events as &$event ) {
|
|
$event = json_decode( json_encode( $event ), false );
|
|
}
|
|
|
|
// Other events (e.g. from Echo) are never removed
|
|
$events = array_filter( $events, static function ( $event ) {
|
|
return $event->type === 'dt-subscribed-new-comment';
|
|
} );
|
|
|
|
self::assertEquals( [], $events );
|
|
}
|
|
|
|
public function provideGenerateCases(): array {
|
|
return [
|
|
// Several simple edits adding replies by different users.
|
|
[
|
|
'cases/EventDispatcher/simple/rev1.txt',
|
|
'cases/EventDispatcher/simple/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/simple/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/simple/rev2.txt',
|
|
'cases/EventDispatcher/simple/rev3.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/simple/rev3.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/simple/rev3.txt',
|
|
'cases/EventDispatcher/simple/rev4.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/simple/rev4.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/simple/rev4.txt',
|
|
'cases/EventDispatcher/simple/rev5.txt',
|
|
'X',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/simple/rev5.json',
|
|
],
|
|
// Adding a new section with heading and a top-level comment.
|
|
[
|
|
'cases/EventDispatcher/newsection/rev1.txt',
|
|
'cases/EventDispatcher/newsection/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/newsection/rev2.json',
|
|
],
|
|
// Adding multiple replies in one edit.
|
|
[
|
|
'cases/EventDispatcher/multiple/rev1.txt',
|
|
'cases/EventDispatcher/multiple/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/multiple/rev2.json',
|
|
],
|
|
// Adding comments in section 0 (before first heading).
|
|
// These do not generate notifications, because the interface doesn't allow subscribing to it.
|
|
[
|
|
'cases/EventDispatcher/section0/rev1.txt',
|
|
'cases/EventDispatcher/section0/rev2.txt',
|
|
'X',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/section0/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/section0/rev2.txt',
|
|
'cases/EventDispatcher/section0/rev3.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/section0/rev3.json',
|
|
],
|
|
// Adding comments in section starting with a heading with level 1.
|
|
// These do not generate notifications, because the interface doesn't allow subscribing to it.
|
|
[
|
|
'cases/EventDispatcher/sectionlevel1/rev1.txt',
|
|
'cases/EventDispatcher/sectionlevel1/rev2.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sectionlevel1/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sectionlevel1/rev2.txt',
|
|
'cases/EventDispatcher/sectionlevel1/rev3.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sectionlevel1/rev3.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sectionlevel1/rev3.txt',
|
|
'cases/EventDispatcher/sectionlevel1/rev4.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sectionlevel1/rev4.json',
|
|
],
|
|
// Adding comments in section starting with a heading with level 3 (not following level 2 headings).
|
|
// These do not generate notifications, because the interface doesn't allow subscribing to it.
|
|
[
|
|
'cases/EventDispatcher/sectionlevel3/rev1.txt',
|
|
'cases/EventDispatcher/sectionlevel3/rev2.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sectionlevel3/rev2.json',
|
|
],
|
|
// Adding a comment in a previously empty section.
|
|
[
|
|
'cases/EventDispatcher/emptysection/rev1.txt',
|
|
'cases/EventDispatcher/emptysection/rev2.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/emptysection/rev2.json',
|
|
],
|
|
// Adding comments in sub-sections, where the parent section has no comments (except in
|
|
// sub-sections). These do not generate notifications because of the fix for T286736,
|
|
// but maybe they should?
|
|
[
|
|
'cases/EventDispatcher/subsection-empty/rev1.txt',
|
|
'cases/EventDispatcher/subsection-empty/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/subsection-empty/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/subsection-empty/rev2.txt',
|
|
'cases/EventDispatcher/subsection-empty/rev3.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/subsection-empty/rev3.json',
|
|
],
|
|
// Adding comments in sub-sections, where the parent section also has comments.
|
|
[
|
|
'cases/EventDispatcher/subsection/rev1.txt',
|
|
'cases/EventDispatcher/subsection/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/subsection/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/subsection/rev2.txt',
|
|
'cases/EventDispatcher/subsection/rev3.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/subsection/rev3.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/subsection/rev3.txt',
|
|
'cases/EventDispatcher/subsection/rev4.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/subsection/rev4.json',
|
|
],
|
|
// Edits that do not add comments, and do not generate notifications.
|
|
[
|
|
// Copying a discussion from another page (note the author of revision)
|
|
'cases/EventDispatcher/notcomments/rev1.txt',
|
|
'cases/EventDispatcher/notcomments/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/notcomments/rev2.json',
|
|
],
|
|
[
|
|
// Editing a comment
|
|
'cases/EventDispatcher/notcomments/rev2.txt',
|
|
'cases/EventDispatcher/notcomments/rev3.txt',
|
|
'X',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/notcomments/rev3.json',
|
|
],
|
|
[
|
|
// Editing page intro section
|
|
'cases/EventDispatcher/notcomments/rev3.txt',
|
|
'cases/EventDispatcher/notcomments/rev4.txt',
|
|
'X',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/notcomments/rev4.json',
|
|
],
|
|
// Multiple edits within a minute adding comments by the same user.
|
|
// See T285528#7177220 for more detail about each case.
|
|
[
|
|
'cases/EventDispatcher/sametime/rev1.txt',
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'cases/EventDispatcher/sametime/rev3-case1.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3-case1.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'cases/EventDispatcher/sametime/rev3-case2.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3-case2.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'cases/EventDispatcher/sametime/rev3-case3.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3-case3.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'cases/EventDispatcher/sametime/rev3-case4.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3-case4.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2.txt',
|
|
'cases/EventDispatcher/sametime/rev3-case5.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3-case5.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev1b.txt',
|
|
'cases/EventDispatcher/sametime/rev2b.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev2b.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2b.txt',
|
|
'cases/EventDispatcher/sametime/rev3b-case6.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3b-case6.json',
|
|
],
|
|
[
|
|
'cases/EventDispatcher/sametime/rev2b.txt',
|
|
'cases/EventDispatcher/sametime/rev3b-case7.txt',
|
|
'Z',
|
|
'../cases/EventDispatcher/no-other-events.json',
|
|
'../cases/EventDispatcher/sametime/rev3b-case7.json',
|
|
],
|
|
// Interactions with events generated by base Echo.
|
|
[
|
|
// User talk page edit
|
|
'cases/EventDispatcher/other-events/rev1.txt',
|
|
'cases/EventDispatcher/other-events/rev2a.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/other-events/rev2a-other.json',
|
|
'../cases/EventDispatcher/other-events/rev2a.json',
|
|
],
|
|
[
|
|
// Mention
|
|
'cases/EventDispatcher/other-events/rev1.txt',
|
|
'cases/EventDispatcher/other-events/rev2b.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/other-events/rev2b-other.json',
|
|
'../cases/EventDispatcher/other-events/rev2b.json',
|
|
],
|
|
[
|
|
// Mention in edit summary
|
|
'cases/EventDispatcher/other-events/rev1.txt',
|
|
'cases/EventDispatcher/other-events/rev2c.txt',
|
|
'Y',
|
|
'../cases/EventDispatcher/other-events/rev2c-other.json',
|
|
'../cases/EventDispatcher/other-events/rev2c.json',
|
|
],
|
|
];
|
|
}
|
|
|
|
}
|