9b260caeb5
Collect parse time statistics as a counter in order to determine both the number of opportunities for selective update as well as the proportion of cpu time spent on parses where selective update is feasible. Bug: T371713 Change-Id: I5b8c7ab48d5a1d6c1e311149fcac6abdc523aa13
139 lines
4 KiB
PHP
139 lines
4 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\PoolCounter;
|
|
|
|
use MediaWiki\Logger\Spi as LoggerSpi;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Page\ParserOutputAccess;
|
|
use MediaWiki\Parser\ParserOutput;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\Revision\RevisionRenderer;
|
|
use MediaWiki\Status\Status;
|
|
use ParserOptions;
|
|
|
|
/**
|
|
* PoolCounter protected work wrapping RenderedRevision->getRevisionParserOutput.
|
|
* Caching behavior may be defined by subclasses.
|
|
*
|
|
* @note No audience checks are applied.
|
|
*
|
|
* @internal
|
|
*/
|
|
class PoolWorkArticleView extends PoolCounterWork {
|
|
/** @var ParserOptions */
|
|
protected $parserOptions;
|
|
/** @var RevisionRecord */
|
|
protected $revision;
|
|
/** @var RevisionRenderer */
|
|
private $renderer;
|
|
/** @var LoggerSpi */
|
|
protected $loggerSpi;
|
|
|
|
/**
|
|
* @param string $workKey
|
|
* @param RevisionRecord $revision Revision to render
|
|
* @param ParserOptions $parserOptions ParserOptions to use for the parse
|
|
* @param RevisionRenderer $revisionRenderer
|
|
* @param LoggerSpi $loggerSpi
|
|
*/
|
|
public function __construct(
|
|
string $workKey,
|
|
RevisionRecord $revision,
|
|
ParserOptions $parserOptions,
|
|
RevisionRenderer $revisionRenderer,
|
|
LoggerSpi $loggerSpi
|
|
) {
|
|
parent::__construct( 'ArticleView', $workKey );
|
|
$this->revision = $revision;
|
|
$this->parserOptions = $parserOptions;
|
|
$this->renderer = $revisionRenderer;
|
|
$this->loggerSpi = $loggerSpi;
|
|
}
|
|
|
|
/**
|
|
* @return Status
|
|
*/
|
|
public function doWork() {
|
|
return $this->renderRevision();
|
|
}
|
|
|
|
/**
|
|
* Render the given revision.
|
|
*
|
|
* @see ParserOutputAccess::renderRevision
|
|
*
|
|
* @param ?ParserOutput $previousOutput previously-cached output for this
|
|
* page (used by Parsoid for selective updates)
|
|
* @param bool $doSample Whether to collect statistics on this render
|
|
* @param string $sourceLabel the source label to use on the statistics
|
|
* @return Status with the value being a ParserOutput or null
|
|
*/
|
|
public function renderRevision(
|
|
?ParserOutput $previousOutput = null,
|
|
bool $doSample = false,
|
|
string $sourceLabel = ''
|
|
): Status {
|
|
$renderedRevision = $this->renderer->getRenderedRevision(
|
|
$this->revision,
|
|
$this->parserOptions,
|
|
null,
|
|
[
|
|
'audience' => RevisionRecord::RAW,
|
|
'previous-output' => $previousOutput,
|
|
]
|
|
);
|
|
|
|
$parserOutput = $renderedRevision->getRevisionParserOutput();
|
|
|
|
if ( $doSample ) {
|
|
$stats = MediaWikiServices::getInstance()->getStatsFactory();
|
|
$labels = [
|
|
'source' => $sourceLabel,
|
|
'type' => $previousOutput === null ? 'full' : 'selective',
|
|
'reason' => $this->parserOptions->getRenderReason(),
|
|
'parser' => $this->parserOptions->getUseParsoid() ? 'parsoid' : 'legacy',
|
|
'opportunistic' => 'false',
|
|
];
|
|
$totalStat = $stats->getCounter( 'parsercache_selective_total' );
|
|
$timeStat = $stats->getCounter( 'parsercache_selective_cpu_seconds' );
|
|
foreach ( $labels as $key => $value ) {
|
|
$totalStat->setLabel( $key, $value );
|
|
$timeStat->setLabel( $key, $value );
|
|
}
|
|
$totalStat->increment();
|
|
$timeStat->incrementBy( $parserOutput->getTimeProfile( 'cpu' ) );
|
|
}
|
|
|
|
return Status::newGood( $parserOutput );
|
|
}
|
|
|
|
/**
|
|
* @param Status $status
|
|
* @return Status
|
|
*/
|
|
public function error( $status ) {
|
|
return $status;
|
|
}
|
|
|
|
}
|
|
|
|
/** @deprecated class alias since 1.42 */
|
|
class_alias( PoolWorkArticleView::class, 'PoolWorkArticleView' );
|