ad7e5d5047
Previously, if you tried to configure $wgProfiler to use Tideways or XHProf, but did not actually have it (correctly) installed as a PHP extension, then the exception shown to the developer was "Exception: Profiling is already enabled.", whereas they should be shown "Exception: Neither xhprof nor tideways are installed". Here is how that happened: * LocalSettings has $wgProfiler enabled. * MediaWiki initialises Profiler::singleton() at some point. This calls Profiler -> ProfilerXhprof -> Xhprof::enable. * Xhprof::enable() sets $enabled=true and then tries to do the actual enabling via callAny(). * Xhprof::callAny() finds that the user has no driver installed, so it throws the (correct) Exception. * The uncaught exception is handled by MWExceptionHandler and results in an error page being prepared. At some point, we hit a service constructor that will need a Profiler, which given it threw earlier, does not yet have a singleton to re-use, so it tries again. This calls Profiler -> ProfilerXhprof -> Xhprof::enable. * Xhprof::enable (hello again), now throws because its $enabled member was already set to true! To fix this, simply move the assignment two lines down. Change-Id: I89e31fe58a1c77ee2542628bec4d7bc97621ef4f
105 lines
2.5 KiB
PHP
105 lines
2.5 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
|
|
*/
|
|
|
|
/**
|
|
* Convenience class for working with XHProf
|
|
* <https://github.com/phacility/xhprof>. XHProf can be installed via PECL.
|
|
*
|
|
* This also supports using the Tideways profiler
|
|
* <https://github.com/tideways/php-xhprof-extension>.
|
|
*
|
|
* @since 1.28
|
|
*/
|
|
class Xhprof {
|
|
/**
|
|
* @var bool Whether XHProf is currently running.
|
|
*/
|
|
protected static $enabled;
|
|
|
|
/**
|
|
* Start xhprof profiler
|
|
* @return bool
|
|
*/
|
|
public static function isEnabled() {
|
|
return self::$enabled;
|
|
}
|
|
|
|
/**
|
|
* Start xhprof profiler
|
|
* @param int $flags
|
|
* @param array $options
|
|
* @throws Exception
|
|
*/
|
|
public static function enable( $flags = 0, $options = [] ) {
|
|
if ( self::isEnabled() ) {
|
|
throw new Exception( 'Profiling is already enabled.' );
|
|
}
|
|
|
|
$args = [ $flags ];
|
|
if ( $options ) {
|
|
$args[] = $options;
|
|
}
|
|
|
|
self::callAny(
|
|
[
|
|
'xhprof_enable',
|
|
'tideways_enable',
|
|
'tideways_xhprof_enable'
|
|
],
|
|
$args
|
|
);
|
|
self::$enabled = true;
|
|
}
|
|
|
|
/**
|
|
* Stop xhprof profiler
|
|
*
|
|
* @return array|null xhprof data from the run, or null if xhprof was not running.
|
|
*/
|
|
public static function disable() {
|
|
if ( self::isEnabled() ) {
|
|
self::$enabled = false;
|
|
return self::callAny( [
|
|
'xhprof_disable',
|
|
'tideways_disable',
|
|
'tideways_xhprof_disable'
|
|
] );
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Call the first available function from $functions.
|
|
* @param array $functions
|
|
* @param array $args
|
|
* @return mixed
|
|
* @throws Exception
|
|
*/
|
|
protected static function callAny( array $functions, array $args = [] ) {
|
|
foreach ( $functions as $func ) {
|
|
if ( function_exists( $func ) ) {
|
|
return $func( ...$args );
|
|
}
|
|
}
|
|
|
|
throw new Exception( "Neither xhprof nor tideways are installed" );
|
|
}
|
|
}
|