feat: implement redis array on phpredis. Issue #195

shakaran · shakaran · commit 3b676a1bb2b9 · 2025-07-16T20:53:10.000+02:00
diff --git a/docs/README.md b/docs/README.md
@@ -295,6 +295,33 @@ framework:
                 provider: snc_redis.cache
 ```
 
+### RedisArray Support ###
+
+The bundle supports RedisArray for phpredis clients, allowing data distribution across multiple Redis instances using the same client class as single connections.
+
+Example configuration:
+
+```yaml
+snc_redis:
+    clients:
+        default:
+            type: phpredis
+            alias: default
+            dsns:
+                - redis://localhost:6379
+                - redis://localhost:6380
+            options:
+                connection_timeout: 5
+                retry_interval: 100
+                parameters:
+                    database: 0
+                    password: mypassword
+                redis_array: true
+```
+
+This configuration creates a RedisArray client for multiple Redis instances.
+
+
 ### Complete configuration example ###
 
 ``` yaml
diff --git a/src/DependencyInjection/Configuration/Configuration.php b/src/DependencyInjection/Configuration/Configuration.php
@@ -134,6 +134,7 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                         ->end()
                                     ->end()
                                     ->scalarNode('connection_timeout')->cannotBeEmpty()->defaultValue(5)->end()
+                                    ->scalarNode('scan')->defaultNull()->end()
                                     ->scalarNode('read_write_timeout')->defaultNull()->end()
                                     ->booleanNode('iterable_multibulk')->defaultFalse()->end()
                                     ->booleanNode('throw_errors')->defaultTrue()->end()
@@ -166,6 +167,7 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                             ->scalarNode('sentinel_username')->defaultNull()->end()
                                             ->scalarNode('sentinel_password')->defaultNull()->end()
                                             ->booleanNode('logging')->defaultValue($this->debug)->end()
+                                            ->booleanNode('redis_array')->defaultFalse()->end()
                                             ->variableNode('ssl_context')->defaultNull()->end()
                                         ->end()
                                     ->end()
diff --git a/src/DependencyInjection/SncRedisExtension.php b/src/DependencyInjection/SncRedisExtension.php
@@ -227,12 +227,13 @@ private function loadPredisConnectionParameters(string $clientAlias, array $opti
     /** @param mixed[] $options A client configuration */
     private function loadPhpredisClient(array $options, ContainerBuilder $container): void
     {
-        $connectionCount   = count($options['dsns']);
-        $hasClusterOption  = $options['options']['cluster'] !== null;
-        $hasSentinelOption = isset($options['options']['replication']);
+        $connectionCount     = count($options['dsns']);
+        $hasClusterOption    = $options['options']['cluster'] !== null;
+        $hasSentinelOption   = isset($options['options']['replication']);
+        $hasRedisArrayOption = $client['options']['redis_array'] ?? false;
 
-        if ($connectionCount > 1 && !$hasClusterOption && !$hasSentinelOption) {
-            throw new LogicException('Use options "cluster" or "sentinel" to enable support for multi DSN instances.');
+        if ($connectionCount > 1 && !$hasClusterOption && !$hasSentinelOption && !$hasRedisArrayOption) {
+            throw new LogicException('Use options "cluster", "replication", or "redis_array" to enable support for multi DSN instances.');
         }
 
         if ($hasClusterOption && $hasSentinelOption) {
diff --git a/src/Factory/PhpredisClientFactory.php b/src/Factory/PhpredisClientFactory.php
@@ -10,6 +10,7 @@
 use ProxyManager\Factory\AccessInterceptorValueHolderFactory;
 use ProxyManager\Proxy\AccessInterceptorInterface;
 use Redis;
+use RedisArray;
 use RedisCluster;
 use RedisException;
 use RedisSentinel;
@@ -75,7 +76,7 @@ public function __construct(callable $interceptor, ?Configuration $proxyConfigur
      * @param list<string|list<string>> $dsns    Multiple DSN string
      * @param mixed[]                   $options Options provided in bundle client config
      *
-     * @return Redis|RedisCluster|Relay
+     * @return Redis|RedisCluster|Relay|RedisArray
      *
      * @throws InvalidConfigurationException
      * @throws LogicException
@@ -96,6 +97,18 @@ public function create(string $class, array $dsns, array $options, string $alias
 
         $parsedDsns = array_map(static fn (string $dsn) => new RedisDsn($dsn), $dsns);
 
+        if ($options['redis_array'] ?? false) {
+            if ($isSentinel || $isCluster) {
+                throw new LogicException('The redis_array option is only supported for Redis or Relay classes.');
+            }
+
+            if ($options['cluster'] || $options['replication']) {
+                throw new LogicException('The redis_array option cannot be combined with cluster or replication options.');
+            }
+
+            return $this->createRedisArrayClient($parsedDsns, $class, $alias, $options, $loggingEnabled);
+        }
+
         if ($isRedis || $isRelay) {
             if (count($parsedDsns) > 1) {
                 throw new LogicException('Cannot have more than 1 dsn with \Redis and \RedisArray is not supported yet.');
@@ -111,6 +124,58 @@ public function create(string $class, array $dsns, array $options, string $alias
         return $this->createClusterClient($parsedDsns, $class, $alias, $options, $loggingEnabled);
     }
 
+    /**
+     * @param RedisDsn[] $dsns
+     * @param mixed[]    $options
+     */
+    private function createRedisArrayClient(array $dsns, string $class, string $alias, array $options, bool $loggingEnabled): RedisArray
+    {
+        if (count($dsns) < 2) {
+            throw new LogicException('The redis_array option requires at least two DSNs.');
+        }
+
+        $hosts = array_map(static fn (RedisDsn $dsn) => ($dsn->getTls() ? 'tls://' : '') . $dsn->getHost() . ':' . $dsn->getPort(), $dsns);
+
+        $redisArrayOptions = [
+            'connect_timeout' => (float) ($options['connection_timeout'] ?? 5),
+            'retry_interval' => (int) ($options['retry_interval'] ?? 100),
+        ];
+
+        $username = $options['parameters']['username'] ?? null;
+        $password = $options['parameters']['password'] ?? null;
+        if ($username !== null && $password !== null) {
+            $redisArrayOptions['auth'] = [$username, $password];
+        } elseif ($password !== null) {
+            $redisArrayOptions['auth'] = $password;
+        }
+
+        try {
+            $client = new RedisArray($hosts, $redisArrayOptions);
+        } catch (RedisException $e) {
+            throw new RedisException(sprintf('Failed to create RedisArray with hosts %s: %s', implode(', ', $hosts), $e->getMessage()), 0, $e);
+        }
+
+        $connectedHosts = $client->getHosts();
+        if (empty($connectedHosts)) {
+            throw new LogicException(sprintf('RedisArray failed to connect to any hosts: %s', implode(', ', $hosts)));
+        }
+
+        $db = $options['parameters']['database'] ?? null;
+        if ($db !== null && $db !== '') {
+            $client->select($db);
+        }
+
+        if (isset($options['prefix'])) {
+            $client->setOption(Redis::OPT_PREFIX, $options['prefix']);
+        }
+
+        if (isset($options['serialization'])) {
+            $client->setOption(Redis::OPT_SERIALIZER, $this->loadSerializationType($options['serialization']));
+        }
+
+        return $loggingEnabled ? $this->createLoggingProxy($client, $alias) : $client;
+    }
+
     /**
      * @param class-string                                                                                                                                                                                                  $class
      * @param list<RedisDsn>                                                                                                                                                                                                $dsns
diff --git a/tests/Factory/PhpredisClientFactoryTest.php b/tests/Factory/PhpredisClientFactoryTest.php
@@ -8,14 +8,18 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Redis;
+use RedisArray;
 use RedisCluster;
+use RedisSentinel;
 use Relay\Relay;
 use SEEC\PhpUnit\Helper\ConsecutiveParams;
+use Snc\RedisBundle\DependencyInjection\Configuration\RedisDsn;
 use Snc\RedisBundle\Factory\PhpredisClientFactory;
 use Snc\RedisBundle\Logger\RedisCallInterceptor;
 use Snc\RedisBundle\Logger\RedisLogger;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 
+use function array_map;
 use function class_exists;
 use function fsockopen;
 use function phpversion;
@@ -468,4 +472,93 @@ public function testCreateWithConnectionPersistentFalse(): void
         $this->assertInstanceOf(Redis::class, $client);
         $this->assertNull($client->getPersistentID());
     }
+
+    public function testCreateRedisArrayClient(): void
+    {
+        $dsns    = [
+            new RedisDsn('redis://localhost:6379'),
+            new RedisDsn('redis://localhost:6380'),
+        ];
+        $options = [
+            'redis_array' => true,
+            'connection_timeout' => 5,
+            'retry_interval' => 100,
+            'parameters' => ['database' => 0, 'password' => 'mypassword'],
+        ];
+        $factory = new PhpredisClientFactory(static function (): void {
+        }, null);
+        $client  = $factory->create(
+            Redis::class,
+            array_map('strval', $dsns),
+            $options,
+            'default',
+            false,
+        );
+
+        $this->assertInstanceOf(RedisArray::class, $client);
+        $this->assertEquals(['localhost:6379', 'localhost:6380'], $client->getHosts());
+    }
+
+    public function testThrowsExceptionForMultipleDsnsWithoutValidOption(): void
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Cannot have more than 1 dsn with \Redis and \RedisArray is not supported yet.');
+
+        $dsns    = [
+            new RedisDsn('redis://localhost:6379'),
+            new RedisDsn('redis://localhost:6380'),
+        ];
+        $options = [];
+        $factory = new PhpredisClientFactory(static function (): void {
+        }, null);
+        $factory->create(
+            Redis::class,
+            array_map('strval', $dsns),
+            $options,
+            'default',
+            false,
+        );
+    }
+
+    public function testThrowsExceptionForRedisArrayWithClusterOrReplication(): void
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('The redis_array option cannot be combined with cluster or replication options.');
+
+        $dsns    = [
+            new RedisDsn('redis://localhost:6379'),
+            new RedisDsn('redis://localhost:6380'),
+        ];
+        $options = ['redis_array' => true, 'cluster' => true];
+        $factory = new PhpredisClientFactory(static function (): void {
+        }, null);
+        $factory->create(
+            Redis::class,
+            array_map('strval', $dsns),
+            $options,
+            'default',
+            false,
+        );
+    }
+
+    public function testThrowsExceptionForRedisArrayWithSentinel(): void
+    {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('The redis_array option is only supported for Redis or Relay classes.');
+
+        $dsns    = [
+            new RedisDsn('redis://localhost:6379'),
+            new RedisDsn('redis://localhost:6380'),
+        ];
+        $options = ['redis_array' => true];
+        $factory = new PhpredisClientFactory(static function (): void {
+        }, null);
+        $factory->create(
+            RedisSentinel::class,
+            array_map('strval', $dsns),
+            $options,
+            'default',
+            false,
+        );
+    }
 }
diff --git a/tests/Functional/App/config.yaml b/tests/Functional/App/config.yaml
@@ -19,8 +19,12 @@ snc_redis:
         default:
             type: phpredis
             alias: default
-            dsn: redis://sncredis@localhost
+            dsns: 
+                - redis://sncredis@localhost/1?role=master
+                - redis://sncredis@localhost/2
             logging: '%kernel.debug%'
+            options:
+                redis_array: true
         cache:
             type: predis
             alias: cache
