LoggerFactory: Only check for Psr\Log\LoggerInterface once
authorBryan Davis <bd808@wikimedia.org>
Sat, 24 Oct 2015 22:05:21 +0000 (16:05 -0600)
committerBryan Davis <bd808@wikimedia.org>
Mon, 26 Oct 2015 18:57:28 +0000 (12:57 -0600)
LoggerFactory::getInstance() will be called many times during the course
of handling a typical MediaWiki request. The interface_exists() guard
condition it uses is an attempt to provide an informative error message
when Composer managed libraries are not installed. This check is only
needed on the first invocation of getInstance() to be effective. Using
an additional boolean to guard the interface_exists() call will allow
the PHP runtime to avoid a potentially expensive (at least compared to
a static boolean comparison) function call.

This is the sort of thing that smells of premature optimization, but its
addition is in fact informed by examination of performance reports from
the Wikimedia production environment.

Bug: T115729
Change-Id: I437bcb5326b06145081f2b86f6c4d0c8dc1a318c

includes/debug/logger/LoggerFactory.php

index f1b24e7..92fbb46 100644 (file)
@@ -94,18 +94,22 @@ class LoggerFactory {
         * @return \\Psr\\Log\\LoggerInterface
         */
        public static function getInstance( $channel ) {
-               if ( !interface_exists( '\Psr\Log\LoggerInterface' ) ) {
-                       $message = (
-                               'MediaWiki requires the <a href="https://github.com/php-fig/log">PSR-3 logging ' .
-                               "library</a> to be present. This library is not embedded directly in MediaWiki's " .
-                               "git repository and must be installed separately by the end user.\n\n" .
-                               'Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git' .
-                               '#Fetch_external_libraries">mediawiki.org</a> for help on installing ' .
-                               'the required components.'
-                       );
-                       echo $message;
-                       trigger_error( $message, E_USER_ERROR );
-                       die( 1 );
+               static $hasPSR3Interface = null;
+               if ( $hasPSR3Interface === null ) {
+                       $hasPSR3Interface = interface_exists( '\Psr\Log\LoggerInterface' );
+                       if ( !$hasPSR3Interface ) {
+                               $message = (
+                                       'MediaWiki requires the <a href="https://github.com/php-fig/log">PSR-3 logging ' .
+                                       "library</a> to be present. This library is not embedded directly in MediaWiki's " .
+                                       "git repository and must be installed separately by the end user.\n\n" .
+                                       'Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git' .
+                                       '#Fetch_external_libraries">mediawiki.org</a> for help on installing ' .
+                                       'the required components.'
+                               );
+                               echo $message;
+                               trigger_error( $message, E_USER_ERROR );
+                               die( 1 );
+                       }
                }
 
                return self::getProvider()->getLogger( $channel );