Support for phpredis 6.x (#6209)

Co-authored-by: 李铭昕 <[email protected]>

Author: huangdijia

src/RedisConnection.php

@@ -22,7 +22,6 @@
 use Redis;
 use RedisCluster;
 use RedisException;
-use RedisSentinel;
 use Throwable;
 
 /**
@@ -230,36 +229,28 @@ protected function createRedisSentinel(): Redis
             $readTimeout = $this->config['sentinel']['read_timeout'] ?? 0;
             $masterName = $this->config['sentinel']['master_name'] ?? '';
             $auth = $this->config['sentinel']['auth'] ?? null;
-            // fixes bug for phpredis
-            // https://github.com/phpredis/phpredis/issues/2098
-            $extendConfig = [];
-            if (! empty($auth)) {
-                $extendConfig[] = $auth;
-            }
 
             shuffle($nodes);
 
             $host = null;
             $port = null;
             foreach ($nodes as $node) {
                 try {
-                    $nodeUrlArray = parse_url($node);
-                    $sentinelHost = $nodeUrlArray['host'] ?? null;
-                    $sentinelPort = $nodeUrlArray['port'] ?? null;
-                    if (! $sentinelHost || ! $sentinelPort) {
+                    $resolved = parse_url($node);
+                    if (! isset($resolved['host'], $resolved['port'])) {
                         $this->log(sprintf('The redis sentinel node [%s] is invalid.', $node), LogLevel::ERROR);
                         continue;
                     }
-
-                    $sentinel = new RedisSentinel(
-                        $sentinelHost,
-                        intval($sentinelPort),
-                        $timeout,
-                        $persistent,
-                        $retryInterval,
-                        $readTimeout,
-                        ...$extendConfig
-                    );
+                    $options = [
+                        'host' => $resolved['host'],
+                        'port' => (int) $resolved['port'],
+                        'connectTimeout' => $timeout,
+                        'persistent' => $persistent,
+                        'retryInterval' => $retryInterval,
+                        'readTimeout' => $readTimeout,
+                        ...($auth ? ['auth' => $auth] : []),
+                    ];
+                    $sentinel = $this->container->get(RedisSentinelFactory::class)->create($options);
                     $masterInfo = $sentinel->getMasterAddrByName($masterName);
                     if (is_array($masterInfo) && count($masterInfo) >= 2) {
                         [$host, $port] = $masterInfo;

src/RedisSentinelFactory.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  [email protected]
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace Hyperf\Redis;
+
+use RedisSentinel;
+
+class RedisSentinelFactory
+{
+    protected bool $isOlderThan6 = false;
+
+    public function __construct()
+    {
+        $this->isOlderThan6 = version_compare(phpversion('redis'), '6.0.0', '<');
+    }
+
+    public function create(array $options = []): RedisSentinel
+    {
+        if ($this->isOlderThan6) {
+            return new RedisSentinel(
+                $options['host'],
+                (int) $options['port'],
+                (float) $options['connectTimeout'],
+                $options['persistent'],
+                (int) $options['retryInterval'],
+                (float) $options['readTimeout'],
+                ...(isset($options['auth']) ? [$options['auth']] : []),
+            );
+        }
+
+        // https://github.com/phpredis/phpredis/blob/develop/sentinel.md#examples-for-version-60-or-later
+        return new RedisSentinel($options); /* @phpstan-ignore-line */
+    }
+}

tests/RedisTest.php

@@ -45,6 +45,13 @@
  */
 class RedisTest extends TestCase
 {
+    protected bool $isOlderThan6 = false;
+
+    protected function setUp(): void
+    {
+        $this->isOlderThan6 = version_compare(phpversion('redis'), '6.0.0', '<');
+    }
+
     protected function tearDown(): void
     {
         Mockery::close();
@@ -60,7 +67,11 @@ public function testRedisConnect()
         $this->assertSame('host', $host->getName());
         $this->assertSame('port', $port->getName());
         $this->assertSame('timeout', $timeout->getName());
-        $this->assertSame('retry_interval', $retryInterval->getName());
+        if ($this->isOlderThan6) {
+            $this->assertSame('retry_interval', $retryInterval->getName());
+        } else {
+            $this->assertSame('persistent_id', $retryInterval->getName());
+        }
 
         $this->assertTrue($redis->connect('127.0.0.1', 6379, 0.0, null, 0, 0));
     }
@@ -155,14 +166,16 @@ public function testRedisClusterConstructor()
         $ref = new ReflectionClass(RedisCluster::class);
         $method = $ref->getMethod('__construct');
         $names = [
-            'name', 'seeds', 'timeout', 'read_timeout', 'persistent', 'auth',
+            'name', 'seeds', 'timeout', 'read_timeout', 'persistent', 'auth', 'context',
         ];
         foreach ($method->getParameters() as $parameter) {
             $this->assertSame(array_shift($names), $parameter->getName());
             if ($parameter->getName() === 'seeds') {
                 $this->assertSame('array', $parameter->getType()->getName());
             } else {
-                $this->assertNull($parameter->getType());
+                if ($this->isOlderThan6) {
+                    $this->assertNull($parameter->getType());
+                }
             }
         }
     }
@@ -198,11 +211,15 @@ public function testRedisSentinelParams()
         $rel = new ReflectionClass(RedisSentinel::class);
         $method = $rel->getMethod('__construct');
         $count = count($method->getParameters());
-        if ($count === 6) {
-            $this->markTestIncomplete('RedisSentinel don\'t support auth.');
-        }
+        if ($this->isOlderThan6) {
+            if ($count === 6) {
+                $this->markTestIncomplete('RedisSentinel don\'t support auth.');
+            }
 
-        $this->assertSame(7, $count);
+            $this->assertSame(7, $count);
+        } else {
+            $this->assertSame(1, $count);
+        }
     }
 
     private function getRedis()