CommentFormatterTest.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

CommentFormatterTest.php
View Options

	<?php

	namespace MediaWiki\Extension\DiscussionTools\Tests;

	use ExtMobileFrontend;
	use MediaWiki\Cache\GenderCache;
	use MediaWiki\Context\IContextSource;
	use MediaWiki\Extension\DiscussionTools\BatchModifyElements;
	use MediaWiki\Json\FormatJson;
	use MediaWiki\Language\RawMessage;
	use MediaWiki\MainConfigNames;
	use MediaWiki\Output\OutputPage;
	use MediaWiki\Parser\ParserOutput;
	use MediaWiki\Skin\Skin;
	use MediaWiki\Title\Title;
	use MediaWiki\User\User;
	use Wikimedia\TestingAccessWrapper;

	/**
	* @covers \MediaWiki\Extension\DiscussionTools\CommentFormatter
	* @covers \MediaWiki\Extension\DiscussionTools\CommentUtils
	*/
	class CommentFormatterTest extends IntegrationTestCase {

	/**
	* @dataProvider provideIsLanguageRequiringReplyIcon
	*/
	public function testIsLanguageRequiringReplyIcon(
	string $langCode, bool $expected, ?array $config = null
	): void {
	$lang = $this->getServiceContainer()->getLanguageFactory()->getLanguage( $langCode );
	if ( $config ) {
	$this->overrideConfigValues( [
	'DiscussionTools_visualenhancements_reply_icon_languages' => $config
	] );
	}
	$actual = MockCommentFormatter::isLanguageRequiringReplyIcon( $lang );
	static::assertEquals( $expected, $actual, $langCode );
	}

	public static function provideIsLanguageRequiringReplyIcon(): array {
	return [
	[ 'zh', true ],
	[ 'zh-hant', true ],
	[ 'ar', true ],
	[ 'arz', true ],
	[ 'arz', false, [ 'ar' => true, 'arz' => false ] ],
	[ 'en', false ],
	[ 'he', false ],
	];
	}

	/**
	* @dataProvider provideAddDiscussionToolsInternal
	*/
	public function testAddDiscussionToolsInternal(
	string $name, string $titleText, string $dom, string $expected, string $config, string $data,
	bool $isMobile, bool $useButtons
	): void {
	if ( $isMobile ) {
	$this->markTestSkippedIfExtensionNotLoaded( 'MobileFrontend' );
	}

	$this->setService( 'GenderCache', $this->createNoOpMock( GenderCache::class ) );

	$dom = static::getHtml( $dom );
	$expectedPath = $expected;
	$expected = static::getText( $expectedPath );
	$config = static::getJson( $config );
	$data = static::getJson( $data );

	$this->overrideConfigValues( [
	// Consistent defaults for generating canonical URLs
	MainConfigNames::Server => 'https://example.org',
	MainConfigNames::CanonicalServer => 'https://example.org',
	MainConfigNames::ArticlePath => '/wiki/$1',
	MainConfigNames::ScriptPath => '/w',
	MainConfigNames::Script => '/w/index.php',
	] );

	$title = Title::newFromText( $titleText );
	$wrappedTitle = TestingAccessWrapper::newFromObject( $title );
	// Mock values which would otherwise trigger a DB lookup
	$wrappedTitle->mContentModel = CONTENT_MODEL_WIKITEXT;
	$wrappedTitle->mLatestID = 1;

	$subscriptionStore = new MockSubscriptionStore();
	$user = $this->createMock( User::class );
	$qqxLang = $this->getServiceContainer()->getLanguageFactory()->getLanguage( 'qqx' );
	$skin = $this->createMock( Skin::class );
	$skin->method( 'getSkinName' )->willReturn( 'minerva' );
	$outputPage = $this->createMock( IContextSource::class );
	$outputPage->method( 'getTitle' )->willReturn( $title );
	$outputPage->method( 'getUser' )->willReturn( $user );
	$outputPage->method( 'getLanguage' )->willReturn( $qqxLang );
	$outputPage->method( 'getSkin' )->willReturn( $skin );
	$outputPage->method( 'msg' )->willReturn( new RawMessage( 'a label' ) );

	MockCommentFormatter::$parser = $this->createParser( $config, $data );
	$commentFormatter = TestingAccessWrapper::newFromClass( MockCommentFormatter::class );

	$pout = new ParserOutput();
	$preprocessed = $commentFormatter->addDiscussionToolsInternal( $dom, $pout, $title );
	$preprocessed .= "\n<pre>\n" .
	"newestComment: " . FormatJson::encode(
	$pout->getExtensionData( 'DiscussionTools-newestComment' ), "\t", FormatJson::ALL_OK ) . "\n" .
	( $pout->getExtensionData( 'DiscussionTools-hasLedeContent' ) ?
	"hasLedeContent\n" : '' ) .
	( $pout->getExtensionData( 'DiscussionTools-hasCommentsInLedeContent' ) ?
	"hasCommentsInLedeContent\n" : '' ) .
	( $pout->getExtensionData( 'DiscussionTools-isEmptyTalkPage' ) ?
	"isEmptyTalkPage\n" : '' ) .
	FormatJson::encode( $pout->getJsConfigVars(), "\t", FormatJson::ALL_OK ) .
	"\n</pre>";

	if ( $isMobile ) {
	$preprocessed = ExtMobileFrontend::domParseMobile( $outputPage, $preprocessed );
	// MobileFormatter render time is non-deterministic, so strip from test output
	$preprocessed = preg_replace( '/<!-- MobileFormatter took [^-]*-->/', '', $preprocessed );
	}

	OutputPage::setupOOUI();

	$batchModifyElements = new BatchModifyElements();

	MockCommentFormatter::postprocessTimestampLinks(
	$preprocessed, $batchModifyElements, $outputPage
	);

	MockCommentFormatter::postprocessTopicSubscription(
	$preprocessed, $batchModifyElements, $outputPage, $subscriptionStore, $isMobile, $useButtons
	);

	MockCommentFormatter::postprocessVisualEnhancements(
	$preprocessed, $batchModifyElements, $outputPage, $isMobile
	);

	MockCommentFormatter::postprocessReplyTool(
	$preprocessed, $batchModifyElements, $outputPage, $isMobile, $useButtons
	);

	$actual = $batchModifyElements->apply( $preprocessed );

	// OOUI ID's are non-deterministic, so strip them from test output
	$actual = preg_replace( '/ id=[\'"]ooui-php-[0-9]+[\'"]/', '', $actual );

	// Optionally write updated content to the "reply HTML" files
	if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
	static::overwriteTextFile( $expectedPath, $actual );
	}

	static::assertEquals( $expected, $actual, $name );
	}

	/**
	* @return iterable<array>
	*/
	public static function provideAddDiscussionToolsInternal() {
	foreach ( static::getJson( '../cases/formatted.json' ) as $case ) {
	// Run each test case twice, for desktop and mobile output
	yield array_merge( $case,
	[ 'expected' => $case['expected']['desktop'], 'isMobile' => false, 'useButtons' => true ] );
	yield array_merge( $case,
	[ 'expected' => $case['expected']['mobile'], 'isMobile' => true, 'useButtons' => true ] );

	// Test the legacy output without visual enhancements (only available on desktop)
	yield array_merge( $case,
	[ 'expected' => $case['expected']['legacy'], 'isMobile' => false, 'useButtons' => false ] );
	}
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Aug 18 2026, 11:07 (5 w, 4 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: b8/30/1cc4a500fd8b1fb610e1859fa013
Default Alt Text: CommentFormatterTest.php (6 KB)

CommentFormatterTest.phpNo OneTemporaryActions

CommentFormatterTest.phpView Options

File Metadata

Event Timeline

CommentFormatterTest.php
No OneTemporary
Actions

CommentFormatterTest.php
View Options