mediawiki-extensions-Discus.../tests/phpunit/unit/CommentUtilsTest.php
Bartosz Dziewoński 0ecc8a4c05 Improve detecting already signed comments
Previously, we required a signature at the end of the comment.
This was a pretty rough heuristic that did not correctly handle
many comments that we would consider entirely properly signed
in CommentParser (e.g. comments wrapped in formatting like
<small>…</small>, comments with a post-scriptum or in parentheses,
or comments generated by various templates).

Now we process the user input using the same code that adds reply
links, and only add a signature when we detect that there really
isn't a signature (including template-generated), or if the signature
is in the wrong place and would result in the reply link showing up
in the wrong place as well (not at the end of the comment).

Bug: T278442
Bug: T268558
Bug: T278355
Bug: T291421
Bug: T282983
Change-Id: I46b6110af328ebdf93b7dfc2bd941e04391a1599
2022-02-21 21:21:26 +00:00

57 lines
1.8 KiB
PHP

<?php
namespace MediaWiki\Extension\DiscussionTools\Tests\Unit;
use MediaWiki\Extension\DiscussionTools\CommentUtils;
use MediaWiki\Extension\DiscussionTools\Tests\TestUtils;
use MediaWikiUnitTestCase;
use Wikimedia\Parsoid\Utils\DOMCompat;
/**
* @coversDefaultClass \MediaWiki\Extension\DiscussionTools\CommentUtils
*
* @group DiscussionTools
*/
class CommentUtilsTest extends MediaWikiUnitTestCase {
use TestUtils;
/**
* @dataProvider provideLinearWalk
* @covers ::linearWalk
*/
public function testLinearWalk( string $name, string $htmlPath, string $expectedPath ) {
$html = self::getHtml( $htmlPath );
// Slightly awkward to get the same output as in the JS version
$fragment = ( DOMCompat::newDocument( true ) )->createDocumentFragment();
$fragment->appendXML( trim( $html ) );
$expected = self::getJson( $expectedPath );
$actual = [];
CommentUtils::linearWalk( $fragment, static function ( $event, $node ) use ( &$actual ) {
$actual[] = "$event {$node->nodeName}({$node->nodeType})";
} );
$actualBackwards = [];
CommentUtils::linearWalkBackwards( $fragment, static function ( $event, $node ) use ( &$actualBackwards ) {
$actualBackwards[] = "$event {$node->nodeName}({$node->nodeType})";
} );
// Optionally write updated content to the JSON files
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
self::overwriteJsonFile( $expectedPath, $actual );
}
self::assertEquals( $expected, $actual, $name );
$expectedBackwards = array_map( static function ( $a ) {
return ( substr( $a, 0, 5 ) === 'enter' ? 'leave' : 'enter' ) . substr( $a, 5 );
}, array_reverse( $expected ) );
self::assertEquals( $expectedBackwards, $actualBackwards, $name . ' (backwards)' );
}
public function provideLinearWalk(): array {
return self::getJson( '../cases/linearWalk.json' );
}
}