MediaWiki  master
RedisConnRef.php
Go to the documentation of this file.
1 <?php
20 use Psr\Log\LoggerAwareInterface;
21 use Psr\Log\LoggerInterface;
22 
31 class RedisConnRef implements LoggerAwareInterface {
33  protected $pool;
35  protected $conn;
37  protected $server;
39  protected $lastError;
40 
44  protected $logger;
45 
49  private const AUTH_NO_ERROR = 200;
50 
54  private const AUTH_ERROR_TEMPORARY = 201;
55 
59  private const AUTH_ERROR_PERMANENT = 202;
60 
67  public function __construct(
68  RedisConnectionPool $pool, $server, Redis $conn, LoggerInterface $logger
69  ) {
70  $this->pool = $pool;
71  $this->server = $server;
72  $this->conn = $conn;
73  $this->logger = $logger;
74  }
75 
76  public function setLogger( LoggerInterface $logger ) {
77  $this->logger = $logger;
78  }
79 
84  public function getServer() {
85  return $this->server;
86  }
87 
88  public function getLastError() {
89  return $this->lastError;
90  }
91 
92  public function clearLastError() {
93  $this->lastError = null;
94  }
95 
104  public function __call( $name, $arguments ) {
105  // Work around https://github.com/nicolasff/phpredis/issues/70
106  $lname = strtolower( $name );
107  if (
108  ( $lname === 'blpop' || $lname === 'brpop' || $lname === 'brpoplpush' )
109  && count( $arguments ) > 1
110  ) {
111  // Get timeout off the end since it is always required and argument length can vary
112  $timeout = end( $arguments );
113  // Only give the additional one second buffer if not requesting an infinite timeout
114  $this->pool->resetTimeout( $this->conn, ( $timeout > 0 ? $timeout + 1 : $timeout ) );
115  }
116 
117  return $this->tryCall( $name, $arguments );
118  }
119 
128  private function tryCall( $method, $arguments ) {
129  $this->conn->clearLastError();
130  try {
131  $res = $this->conn->$method( ...$arguments );
132  $authError = $this->checkAuthentication();
133  if ( $authError === self::AUTH_ERROR_TEMPORARY ) {
134  $res = $this->conn->$method( ...$arguments );
135  }
136  if ( $authError === self::AUTH_ERROR_PERMANENT ) {
137  throw new RedisException( "Failure reauthenticating to Redis." );
138  }
139  return $res;
140  } finally {
141  $this->postCallCleanup();
142  }
143  }
144 
155  public function scan( &$iterator, $pattern = null, $count = null ) {
156  return $this->tryCall( 'scan', [ &$iterator, $pattern, $count ] );
157  }
158 
170  public function sScan( $key, &$iterator, $pattern = null, $count = null ) {
171  return $this->tryCall( 'sScan', [ $key, &$iterator, $pattern, $count ] );
172  }
173 
185  public function hScan( $key, &$iterator, $pattern = null, $count = null ) {
186  return $this->tryCall( 'hScan', [ $key, &$iterator, $pattern, $count ] );
187  }
188 
200  public function zScan( $key, &$iterator, $pattern = null, $count = null ) {
201  return $this->tryCall( 'zScan', [ $key, &$iterator, $pattern, $count ] );
202  }
203 
209  private function checkAuthentication() {
210  if ( preg_match( '/^ERR operation not permitted\b/', $this->conn->getLastError() ) ) {
211  if ( !$this->pool->reauthenticateConnection( $this->server, $this->conn ) ) {
213  }
214  $this->conn->clearLastError();
215  $this->logger->info(
216  "Used automatic re-authentication for Redis.",
217  [ 'redis_server' => $this->server ]
218  );
220  }
221  return self::AUTH_NO_ERROR;
222  }
223 
229  private function postCallCleanup() {
230  $this->lastError = $this->conn->getLastError() ?: $this->lastError;
231 
232  // Restore original timeout in the case of blocking calls.
233  $this->pool->resetTimeout( $this->conn );
234  }
235 
243  public function luaEval( $script, array $params, $numKeys ) {
244  $sha1 = sha1( $script ); // 40 char hex
245  $conn = $this->conn; // convenience
246  $server = $this->server; // convenience
247 
248  // Try to run the server-side cached copy of the script
249  $conn->clearLastError();
250  $res = $conn->evalSha( $sha1, $params, $numKeys );
251  // If we got a permission error reply that means that (a) we are not in
252  // multi()/pipeline() and (b) some connection problem likely occurred. If
253  // the password the client gave was just wrong, an exception should have
254  // been thrown back in getConnection() previously.
255  if ( preg_match( '/^ERR operation not permitted\b/', $conn->getLastError() ) ) {
256  $this->pool->reauthenticateConnection( $server, $conn );
257  $conn->clearLastError();
258  $res = $conn->eval( $script, $params, $numKeys );
259  $this->logger->info(
260  "Used automatic re-authentication for Lua script '$sha1'.",
261  [ 'redis_server' => $server ]
262  );
263  }
264  // If the script is not in cache, use eval() to retry and cache it
265  if ( preg_match( '/^NOSCRIPT/', $conn->getLastError() ) ) {
266  $conn->clearLastError();
267  $res = $conn->eval( $script, $params, $numKeys );
268  $this->logger->info(
269  "Used eval() for Lua script '$sha1'.",
270  [ 'redis_server' => $server ]
271  );
272  }
273 
274  if ( $conn->getLastError() ) { // script bug?
275  $this->logger->error(
276  'Lua script error on server "{redis_server}": {lua_error}',
277  [
278  'redis_server' => $server,
279  'lua_error' => $conn->getLastError()
280  ]
281  );
282  }
283 
284  $this->lastError = $conn->getLastError() ?: $this->lastError;
285 
286  return $res;
287  }
288 
293  public function isConnIdentical( Redis $conn ) {
294  return $this->conn === $conn;
295  }
296 
297  public function __destruct() {
298  $this->pool->freeConnection( $this->server, $this->conn );
299  }
300 }
RedisConnRef\tryCall
tryCall( $method, $arguments)
Do the method call in the common try catch handler.
Definition: RedisConnRef.php:128
RedisConnRef\hScan
hScan( $key, &$iterator, $pattern=null, $count=null)
Hash Scan Handle this explicity due to needing the iterator passed by reference.
Definition: RedisConnRef.php:185
RedisConnRef\__destruct
__destruct()
Definition: RedisConnRef.php:297
RedisConnRef\$logger
LoggerInterface $logger
Definition: RedisConnRef.php:44
RedisConnRef\scan
scan(&$iterator, $pattern=null, $count=null)
Key Scan Handle this explicity due to needing the iterator passed by reference.
Definition: RedisConnRef.php:155
RedisConnRef\zScan
zScan( $key, &$iterator, $pattern=null, $count=null)
Sorted Set Scan Handle this explicity due to needing the iterator passed by reference.
Definition: RedisConnRef.php:200
$res
$res
Definition: testCompression.php:57
RedisConnRef\__call
__call( $name, $arguments)
Magic __call handler for most Redis functions.
Definition: RedisConnRef.php:104
RedisConnRef\isConnIdentical
isConnIdentical(Redis $conn)
Definition: RedisConnRef.php:293
RedisConnRef\$server
string $server
Definition: RedisConnRef.php:37
RedisConnRef\$conn
Redis $conn
Definition: RedisConnRef.php:35
RedisConnRef\AUTH_NO_ERROR
const AUTH_NO_ERROR
No authentication errors.
Definition: RedisConnRef.php:49
RedisConnRef\getLastError
getLastError()
Definition: RedisConnRef.php:88
RedisConnRef\postCallCleanup
postCallCleanup()
Post Redis call cleanup.
Definition: RedisConnRef.php:229
RedisConnRef\checkAuthentication
checkAuthentication()
Handle authentication errors and automatically reauthenticate.
Definition: RedisConnRef.php:209
RedisConnRef\$pool
RedisConnectionPool $pool
Definition: RedisConnRef.php:33
RedisConnectionPool
Helper class to manage Redis connections.
Definition: RedisConnectionPool.php:41
RedisConnRef\luaEval
luaEval( $script, array $params, $numKeys)
Definition: RedisConnRef.php:243
RedisConnRef\$lastError
string null $lastError
Definition: RedisConnRef.php:39
RedisConnRef\clearLastError
clearLastError()
Definition: RedisConnRef.php:92
RedisConnRef
Helper class to handle automatically marking connectons as reusable (via RAII pattern)
Definition: RedisConnRef.php:31
RedisConnRef\setLogger
setLogger(LoggerInterface $logger)
Definition: RedisConnRef.php:76
RedisConnRef\__construct
__construct(RedisConnectionPool $pool, $server, Redis $conn, LoggerInterface $logger)
Definition: RedisConnRef.php:67
RedisConnRef\getServer
getServer()
Definition: RedisConnRef.php:84
RedisConnRef\AUTH_ERROR_TEMPORARY
const AUTH_ERROR_TEMPORARY
Temporary authentication error; recovered by reauthenticating.
Definition: RedisConnRef.php:54
RedisConnRef\AUTH_ERROR_PERMANENT
const AUTH_ERROR_PERMANENT
Authentication error was permanent and could not be recovered.
Definition: RedisConnRef.php:59
RedisConnRef\sScan
sScan( $key, &$iterator, $pattern=null, $count=null)
Set Scan Handle this explicity due to needing the iterator passed by reference.
Definition: RedisConnRef.php:170