mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-13 06:49:42 +00:00
7da2df9724
We want to be able to measure how backend performance changes when we switch from RESTbase to calling Parsoid directly. We expect to see a performance boost, in particular for html/to/wikitext, since we avoid the network overhead. Since we will make the switch by wiki, we need to be able to compare the metric before vs. after for a single wiki. So, this adds the wiki ID as a prefix to all existing metrics. Once fully rolled out, we should get rid of the wiki prefix. We will need to update the dashboard found at this url: https://grafana.wikimedia.org/d/000000249/edit-stash?orgId=1 Change-Id: Iac9070b27f4b0d25b0e31c9fad38abc08c433a28
210 lines
6.2 KiB
PHP
210 lines
6.2 KiB
PHP
<?php
|
|
/**
|
|
* Helper functions for contacting Parsoid/RESTBase from the action API.
|
|
*
|
|
* @file
|
|
* @ingroup Extensions
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license MIT
|
|
*/
|
|
|
|
namespace MediaWiki\Extension\VisualEditor;
|
|
|
|
use Language;
|
|
use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use Message;
|
|
use NullStatsdDataFactory;
|
|
use PrefixingStatsdDataFactoryProxy;
|
|
use Psr\Log\LoggerInterface;
|
|
use Psr\Log\NullLogger;
|
|
use Title;
|
|
use WebRequest;
|
|
use WikiMap;
|
|
|
|
trait ApiParsoidTrait {
|
|
|
|
/**
|
|
* @var LoggerInterface
|
|
*/
|
|
private $logger = null;
|
|
|
|
/**
|
|
* @var StatsdDataFactoryInterface
|
|
*/
|
|
private $stats = null;
|
|
|
|
/**
|
|
* @return LoggerInterface
|
|
*/
|
|
protected function getLogger(): LoggerInterface {
|
|
return $this->logger ?: new NullLogger();
|
|
}
|
|
|
|
/**
|
|
* @param LoggerInterface $logger
|
|
*/
|
|
protected function setLogger( LoggerInterface $logger ) {
|
|
$this->logger = $logger;
|
|
}
|
|
|
|
/**
|
|
* @return StatsdDataFactoryInterface
|
|
*/
|
|
protected function getStats(): StatsdDataFactoryInterface {
|
|
return $this->stats ?: new NullStatsdDataFactory();
|
|
}
|
|
|
|
/**
|
|
* @param StatsdDataFactoryInterface $stats
|
|
*/
|
|
protected function setStats( StatsdDataFactoryInterface $stats ) {
|
|
$this->stats = new PrefixingStatsdDataFactoryProxy( $stats, WikiMap::getCurrentWikiId() );
|
|
}
|
|
|
|
/**
|
|
* @return float Return a start time for use with statsRecordTiming()
|
|
*/
|
|
private function statsGetStartTime(): float {
|
|
return microtime( true );
|
|
}
|
|
|
|
/**
|
|
* @param string $key
|
|
* @param float $startTime from statsGetStartTime()
|
|
*/
|
|
private function statsRecordTiming( string $key, float $startTime ) {
|
|
$duration = ( microtime( true ) - $startTime ) * 1000;
|
|
$this->getStats()->timing( $key, $duration );
|
|
}
|
|
|
|
/**
|
|
* @param array $response
|
|
*/
|
|
private function forwardErrorsAndCacheHeaders( array $response ) {
|
|
if ( !empty( $response['error'] ) ) {
|
|
$this->dieWithError( $response['error'] );
|
|
}
|
|
|
|
// If response was received directly from Varnish, use the response
|
|
// (RP) header to declare the cache hit and pass the data to the client.
|
|
$headers = $response['headers'] ?? [];
|
|
if ( isset( $headers['x-cache'] ) && strpos( $headers['x-cache'], 'hit' ) !== false ) {
|
|
$this->getRequest()->response()->header( 'X-Cache: cached-response=true' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Request page HTML from RESTBase
|
|
*
|
|
* @param RevisionRecord $revision Page revision
|
|
* @return array The RESTBase server's response
|
|
*/
|
|
protected function requestRestbasePageHtml( RevisionRecord $revision ): array {
|
|
$title = Title::newFromLinkTarget( $revision->getPageAsLinkTarget() );
|
|
$lang = self::getPageLanguage( $title );
|
|
|
|
$startTime = $this->statsGetStartTime();
|
|
$response = $this->getParsoidClient()->getPageHtml( $revision, $lang );
|
|
$this->statsRecordTiming( 'ApiVisualEditor.ParsoidClient.getPageHtml', $startTime );
|
|
|
|
$this->forwardErrorsAndCacheHeaders( $response );
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Transform HTML to wikitext via Parsoid through RESTbase. Wrapper for ::postData().
|
|
*
|
|
* @param Title $title The title of the page
|
|
* @param string $html The HTML of the page to be transformed
|
|
* @param int|null $oldid What oldid revision, if any, to base the request from (default: `null`)
|
|
* @param string|null $etag The ETag to set in the HTTP request header
|
|
* @return array The RESTbase server's response, 'code', 'reason', 'headers' and 'body'
|
|
*/
|
|
protected function transformHTML(
|
|
Title $title, string $html, int $oldid = null, string $etag = null
|
|
): array {
|
|
$lang = self::getPageLanguage( $title );
|
|
|
|
$startTime = $this->statsGetStartTime();
|
|
$response = $this->getParsoidClient()->transformHTML( $title, $lang, $html, $oldid, $etag );
|
|
$this->statsRecordTiming( 'ApiVisualEditor.ParsoidClient.transformHTML', $startTime );
|
|
|
|
$this->forwardErrorsAndCacheHeaders( $response );
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Transform wikitext to HTML via Parsoid through RESTbase. Wrapper for ::postData().
|
|
*
|
|
* @param Title $title The title of the page to use as the parsing context
|
|
* @param string $wikitext The wikitext fragment to parse
|
|
* @param bool $bodyOnly Whether to provide only the contents of the `<body>` tag
|
|
* @param int|null $oldid What oldid revision, if any, to base the request from (default: `null`)
|
|
* @param bool $stash Whether to stash the result in the server-side cache (default: `false`)
|
|
* @return array The RESTbase server's response, 'code', 'reason', 'headers' and 'body'
|
|
*/
|
|
protected function transformWikitext(
|
|
Title $title, string $wikitext, bool $bodyOnly, int $oldid = null, bool $stash = false
|
|
): array {
|
|
$lang = self::getPageLanguage( $title );
|
|
|
|
$startTime = $this->statsGetStartTime();
|
|
$response = $this->getParsoidClient()->transformWikitext(
|
|
$title,
|
|
$lang,
|
|
$wikitext,
|
|
$bodyOnly,
|
|
$oldid,
|
|
$stash
|
|
);
|
|
$this->statsRecordTiming( 'ApiVisualEditor.ParsoidClient.transformWikitext', $startTime );
|
|
|
|
$this->forwardErrorsAndCacheHeaders( $response );
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Get the page language from a title, using the content language as fallback on special pages
|
|
*
|
|
* @param Title $title
|
|
* @return Language Content language
|
|
*/
|
|
public static function getPageLanguage( Title $title ): Language {
|
|
if ( $title->isSpecial( 'CollabPad' ) ) {
|
|
// Use the site language for CollabPad, as getPageLanguage just
|
|
// returns the interface language for special pages.
|
|
// TODO: Let the user change the document language on multi-lingual sites.
|
|
return MediaWikiServices::getInstance()->getContentLanguage();
|
|
} else {
|
|
return $title->getPageLanguage();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see VisualEditorParsoidClientFactory
|
|
* @return ParsoidClient
|
|
*/
|
|
abstract protected function getParsoidClient(): ParsoidClient;
|
|
|
|
/**
|
|
* @see ApiBase
|
|
* @param string|array|Message $msg See ApiErrorFormatter::addError()
|
|
* @param string|null $code See ApiErrorFormatter::addError()
|
|
* @param array|null $data See ApiErrorFormatter::addError()
|
|
* @param int|null $httpCode HTTP error code to use
|
|
* @return never
|
|
*/
|
|
abstract public function dieWithError( $msg, $code = null, $data = null, $httpCode = null );
|
|
|
|
/**
|
|
* @see ContextSource
|
|
* @return WebRequest
|
|
*/
|
|
abstract public function getRequest();
|
|
}
|