RedisConnectionPool.php

Go to the documentation of this file.

<?php
namespace Wikimedia\ObjectCache;
 
use Exception;
use InvalidArgumentException;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Redis;
use RedisException;
use RuntimeException;
 
class RedisConnectionPool implements LoggerAwareInterface {
    protected $connectTimeout;
    protected $readTimeout;
    protected $password;
    protected $prefix;
    protected $persistent;
    protected $serializer;
    protected $id;
 
    protected $idlePoolSize = 0;
 
    protected $connections = [];
    protected $downServers = [];
 
    protected static $instances = [];
 
    private const SERVER_DOWN_TTL = 30;
 
    protected $logger;
 
    protected function __construct( array $options, $id ) {
        if ( !class_exists( Redis::class ) ) {
            throw new RuntimeException(
                __CLASS__ . ' requires a Redis client library. ' .
                'See https://www.mediawiki.org/wiki/Redis#Setup' );
        }
        $this->logger = $options['logger'] ?? new NullLogger();
        $this->connectTimeout = $options['connectTimeout'];
        $this->readTimeout = $options['readTimeout'];
        $this->persistent = $options['persistent'];
        $this->password = $options['password'];
        $this->prefix = $options['prefix'];
        if ( !isset( $options['serializer'] ) || $options['serializer'] === 'php' ) {
            $this->serializer = Redis::SERIALIZER_PHP;
        } elseif ( $options['serializer'] === 'igbinary' ) {
            if ( !defined( 'Redis::SERIALIZER_IGBINARY' ) ) {
                throw new InvalidArgumentException(
                    __CLASS__ . ': configured serializer "igbinary" not available' );
            }
            $this->serializer = Redis::SERIALIZER_IGBINARY;
        } elseif ( $options['serializer'] === 'none' ) {
            $this->serializer = Redis::SERIALIZER_NONE;
        } else {
            throw new InvalidArgumentException( "Invalid serializer specified." );
        }
        $this->id = $id;
    }
 
    public function setLogger( LoggerInterface $logger ): void {
        $this->logger = $logger;
    }
 
    protected static function applyDefaultConfig( array $options ) {
        if ( !isset( $options['connectTimeout'] ) ) {
            $options['connectTimeout'] = 1;
        }
        if ( !isset( $options['readTimeout'] ) ) {
            $options['readTimeout'] = 1;
        }
        if ( !isset( $options['persistent'] ) ) {
            $options['persistent'] = false;
        }
        if ( !isset( $options['password'] ) ) {
            $options['password'] = null;
        }
        if ( !isset( $options['prefix'] ) ) {
            $options['prefix'] = null;
        }
 
        return $options;
    }
 
    public static function singleton( array $options ) {
        $options = self::applyDefaultConfig( $options );
        // Map the options to a unique hash...
        ksort( $options ); // normalize to avoid pool fragmentation
        $id = sha1( serialize( $options ) );
        // Initialize the object at the hash as needed...
        if ( !isset( self::$instances[$id] ) ) {
            self::$instances[$id] = new self( $options, $id );
        }
 
        return self::$instances[$id];
    }
 
    public static function destroySingletons() {
        self::$instances = [];
    }
 
    public function getConnection( $server, ?LoggerInterface $logger = null ) {
        // The above @return also documents 'Redis' for convenience with IDEs.
        // RedisConnRef uses PHP magic methods, which wouldn't be recognised.
 
        $logger = $logger ?: $this->logger;
        // Check the listing "dead" servers which have had a connection errors.
        // Servers are marked dead for a limited period of time, to
        // avoid excessive overhead from repeated connection timeouts.
        if ( isset( $this->downServers[$server] ) ) {
            $now = time();
            if ( $now > $this->downServers[$server] ) {
                // Dead time expired
                unset( $this->downServers[$server] );
            } else {
                // Server is dead
                $logger->debug(
                    'Server "{redis_server}" is marked down for another ' .
                    ( $this->downServers[$server] - $now ) . ' seconds',
                    [ 'redis_server' => $server ]
                );
 
                return false;
            }
        }
 
        // Check if a connection is already free for use
        if ( isset( $this->connections[$server] ) ) {
            foreach ( $this->connections[$server] as &$connection ) {
                if ( $connection['free'] ) {
                    $connection['free'] = false;
                    --$this->idlePoolSize;
 
                    return new RedisConnRef(
                        $this, $server, $connection['conn'], $logger
                    );
                }
            }
        }
 
        if ( !$server ) {
            throw new InvalidArgumentException(
                __CLASS__ . ": invalid configured server \"$server\"" );
        } elseif ( str_starts_with( $server, '/' ) ) {
            // UNIX domain socket
            // These are required by the redis extension to start with a slash, but
            // we still need to set the port to a special value to make it work.
            $host = $server;
            $port = 0;
        } else {
            // TCP connection
            if ( preg_match( '/^\[(.+)\]:(\d+)$/', $server, $m ) ) {
                // (ip, port)
                [ $host, $port ] = [ $m[1], (int)$m[2] ];
            } elseif ( preg_match( '/^((?:[\w]+\:\/\/)?[^:]+):(\d+)$/', $server, $m ) ) {
                // (ip, uri or path, port)
                [ $host, $port ] = [ $m[1], (int)$m[2] ];
                if (
                    str_starts_with( $host, 'tls://' )
                    && version_compare( phpversion( 'redis' ), '5.0.0' ) < 0
                ) {
                    throw new RuntimeException(
                        'A newer version of the Redis client library is required to use TLS. ' .
                        'See https://www.mediawiki.org/wiki/Redis#Setup' );
                }
            } else {
                // (ip or path, port)
                [ $host, $port ] = [ $server, 6379 ];
            }
        }
 
        $conn = new Redis();
        try {
            if ( $this->persistent ) {
                $result = $conn->pconnect( $host, $port, $this->connectTimeout, $this->id );
            } else {
                $result = $conn->connect( $host, $port, $this->connectTimeout );
            }
            if ( !$result ) {
                $logger->error(
                    'Could not connect to server "{redis_server}"',
                    [ 'redis_server' => $server ]
                );
                // Mark server down for some time to avoid further timeouts
                $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
 
                return false;
            }
            if ( ( $this->password !== null ) && !$conn->auth( $this->password ) ) {
                $logger->error(
                    'Authentication error connecting to "{redis_server}"',
                    [ 'redis_server' => $server ]
                );
            }
        } catch ( RedisException $e ) {
            $this->downServers[$server] = time() + self::SERVER_DOWN_TTL;
            $logger->error(
                'Redis exception connecting to "{redis_server}"',
                [
                    'redis_server' => $server,
                    'exception' => $e,
                ]
            );
 
            return false;
        }
 
        if ( $this->prefix !== null ) {
            $conn->setOption( Redis::OPT_PREFIX, $this->prefix );
        }
 
        $conn->setOption( Redis::OPT_READ_TIMEOUT, $this->readTimeout );
        $conn->setOption( Redis::OPT_SERIALIZER, $this->serializer );
        $this->connections[$server][] = [ 'conn' => $conn, 'free' => false ];
 
        return new RedisConnRef( $this, $server, $conn, $logger );
    }
 
    public function freeConnection( $server, Redis $conn ) {
        $found = false;
 
        foreach ( $this->connections[$server] as &$connection ) {
            if ( $connection['conn'] === $conn && !$connection['free'] ) {
                $connection['free'] = true;
                ++$this->idlePoolSize;
                break;
            }
        }
 
        $this->closeExcessIdleConections();
 
        return $found;
    }
 
    protected function closeExcessIdleConections() {
        if ( $this->idlePoolSize <= count( $this->connections ) ) {
            return; // nothing to do (no more connections than servers)
        }
 
        foreach ( $this->connections as &$serverConnections ) {
            foreach ( $serverConnections as $key => &$connection ) {
                if ( $connection['free'] ) {
                    unset( $serverConnections[$key] );
                    if ( --$this->idlePoolSize <= count( $this->connections ) ) {
                        return; // done (no more connections than servers)
                    }
                }
            }
        }
    }
 
    public function handleError( RedisConnRef $cref, RedisException $e ) {
        $server = $cref->getServer();
        $this->logger->error(
            'Redis exception on server "{redis_server}"',
            [
                'redis_server' => $server,
                'exception' => $e,
            ]
        );
        foreach ( $this->connections[$server] as $key => $connection ) {
            if ( $cref->isConnIdentical( $connection['conn'] ) ) {
                $this->idlePoolSize -= $connection['free'] ? 1 : 0;
                unset( $this->connections[$server][$key] );
                break;
            }
        }
    }
 
    public function reauthenticateConnection( $server, Redis $conn ) {
        if ( $this->password !== null && !$conn->auth( $this->password ) ) {
            $this->logger->error(
                'Authentication error connecting to "{redis_server}"',
                [ 'redis_server' => $server ]
            );
 
            return false;
        }
 
        return true;
    }
 
    public function resetTimeout( Redis $conn, $timeout = null ) {
        $conn->setOption( Redis::OPT_READ_TIMEOUT, $timeout ?: $this->readTimeout );
    }
 
    public function __destruct() {
        foreach ( $this->connections as &$serverConnections ) {
            foreach ( $serverConnections as &$connection ) {
                try {
                    $conn = $connection['conn'];
                    $conn->close();
                } catch ( RedisException ) {
                    // The destructor can be called on shutdown when random parts of the system
                    // have been destructed already, causing weird errors. Ignore them.
                }
            }
        }
    }
}
 
class_alias( RedisConnectionPool::class, 'RedisConnectionPool' );