e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
83 lines
2.3 KiB
PHP
83 lines
2.3 KiB
PHP
<?php
|
|
|
|
use MediaWiki\CommentFormatter\CommentItem;
|
|
use MediaWiki\Title\Title;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/../includes/Benchmarker.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
class BenchmarkCommentFormatter extends Benchmarker {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Benchmark CommentFormatter::format()' );
|
|
$this->addOption( 'file', 'A JSON API result from list=recentchanges',
|
|
false, true );
|
|
}
|
|
|
|
public function execute() {
|
|
$file = $this->getOption( 'file',
|
|
__DIR__ . '/data/CommentFormatter/rc100-2021-07-29.json' );
|
|
$json = file_get_contents( $file );
|
|
if ( !$json ) {
|
|
$this->fatalError( "Unable to read input file \"$file\"" );
|
|
}
|
|
$result = json_decode( $json, true );
|
|
if ( !isset( $result['query']['recentchanges'] ) ) {
|
|
$this->fatalError( "Invalid JSON data" );
|
|
}
|
|
$entries = $result['query']['recentchanges'];
|
|
$inputs = [];
|
|
$comments = [];
|
|
foreach ( $entries as $entry ) {
|
|
$inputs[] = [
|
|
'comment' => $entry['comment'],
|
|
'title' => Title::newFromText( $entry['title'] )
|
|
];
|
|
$comments[] = $entry['comment'];
|
|
}
|
|
$this->bench( [
|
|
'CommentFormatter::format' => [
|
|
'function' => function () use ( $inputs ) {
|
|
Title::clearCaches();
|
|
$formatter = $this->getServiceContainer()->getCommentFormatter();
|
|
foreach ( $inputs as $input ) {
|
|
$formatter->format(
|
|
$input['comment'],
|
|
$input['title']
|
|
);
|
|
}
|
|
},
|
|
],
|
|
|
|
'CommentFormatter::createBatch' => [
|
|
'function' => function () use ( $inputs ) {
|
|
Title::clearCaches();
|
|
$formatter = $this->getServiceContainer()->getCommentFormatter();
|
|
$comments = [];
|
|
foreach ( $inputs as $input ) {
|
|
$comments[] = ( new CommentItem( $input['comment'] ) )
|
|
->selfLinkTarget( $input['title'] );
|
|
}
|
|
$formatter->createBatch()
|
|
->comments( $comments )
|
|
->execute();
|
|
}
|
|
],
|
|
|
|
'CommentFormatter::formatStrings' => [
|
|
'function' => function () use ( $comments ) {
|
|
Title::clearCaches();
|
|
$formatter = $this->getServiceContainer()->getCommentFormatter();
|
|
$formatter->formatStrings( $comments );
|
|
}
|
|
],
|
|
|
|
] );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = BenchmarkCommentFormatter::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|