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
125 lines
3.4 KiB
PHP
125 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* Benchmark for CDN purge.
|
|
*
|
|
* 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
|
|
* @ingroup Benchmark
|
|
*/
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/../includes/Benchmarker.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
use MediaWiki\Deferred\CdnCacheUpdate;
|
|
|
|
/**
|
|
* Maintenance script that benchmarks CDN purge.
|
|
*
|
|
* @ingroup Benchmark
|
|
*/
|
|
class BenchmarkPurge extends Benchmarker {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Benchmark the CDN purge functions.' );
|
|
}
|
|
|
|
public function execute() {
|
|
global $wgUseCdn, $wgCdnServers;
|
|
|
|
if ( !$wgUseCdn ) {
|
|
$this->error( "CDN purge benchmark doesn't do much without CDN support on." );
|
|
} else {
|
|
$this->output( "There are " . count( $wgCdnServers ) . " defined CDN servers:\n" );
|
|
if ( $this->hasOption( 'count' ) ) {
|
|
$lengths = [ intval( $this->getOption( 'count' ) ) ];
|
|
} else {
|
|
$lengths = [ 1, 10, 100 ];
|
|
}
|
|
foreach ( $lengths as $length ) {
|
|
$urls = $this->randomUrlList( $length );
|
|
$trial = $this->benchCdn( $urls );
|
|
$this->output( $trial . "\n" );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Run a bunch of URLs through CdnCacheUpdate::purge()
|
|
* to benchmark CDN response times.
|
|
* @param array $urls A bunch of URLs to purge
|
|
* @param int $trials How many times to run the test?
|
|
* @return string
|
|
*/
|
|
private function benchCdn( $urls, $trials = 1 ) {
|
|
$start = microtime( true );
|
|
for ( $i = 0; $i < $trials; $i++ ) {
|
|
CdnCacheUpdate::purge( $urls );
|
|
}
|
|
$delta = microtime( true ) - $start;
|
|
$pertrial = $delta / $trials;
|
|
$pertitle = $pertrial / count( $urls );
|
|
|
|
return sprintf( "%4d titles in %6.2fms (%6.2fms each)",
|
|
count( $urls ), $pertrial * 1000.0, $pertitle * 1000.0 );
|
|
}
|
|
|
|
/**
|
|
* Get an array of randomUrl()'s.
|
|
* @param int $length How many urls to add to the array
|
|
* @return array
|
|
*/
|
|
private function randomUrlList( $length ) {
|
|
$list = [];
|
|
for ( $i = 0; $i < $length; $i++ ) {
|
|
$list[] = $this->randomUrl();
|
|
}
|
|
|
|
return $list;
|
|
}
|
|
|
|
/**
|
|
* Return a random URL of the wiki. Not necessarily an actual title in the
|
|
* database, but at least a URL that looks like one.
|
|
* @return string
|
|
*/
|
|
private function randomUrl() {
|
|
global $wgServer, $wgArticlePath;
|
|
|
|
return $wgServer . str_replace( '$1', $this->randomTitle(), $wgArticlePath );
|
|
}
|
|
|
|
/**
|
|
* Create a random title string (not necessarily a Title object).
|
|
* For use with randomUrl().
|
|
* @return string
|
|
*/
|
|
private function randomTitle() {
|
|
$str = '';
|
|
$length = mt_rand( 1, 20 );
|
|
for ( $i = 0; $i < $length; $i++ ) {
|
|
$str .= chr( mt_rand( ord( 'a' ), ord( 'z' ) ) );
|
|
}
|
|
|
|
return ucfirst( $str );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = BenchmarkPurge::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|