feat: implement option redis OPT_SCAN for phpredis. Issue #608

Author: shakaran

docs/README.md

@@ -295,6 +295,21 @@ framework:
                 provider: snc_redis.cache
 ```
 
+### PhpRedis Scan Option ###
+
+To enable the `SCAN_PREFIX` feature for PhpRedis clients, add the `scan` option:
+
+```yaml
+snc_redis:
+    clients:
+        default:
+            type: phpredis
+            alias: default
+            dsn: redis://localhost
+            options:
+                scan: prefix
+```
+
 ### Complete configuration example ###
 
 ``` yaml
@@ -323,6 +338,7 @@ snc_redis:
                 connection_timeout: 10
                 connection_persistent: true
                 read_write_timeout: 30
+                scan: prefix
                 iterable_multibulk: false
                 throw_errors: true
                 cluster: predis

src/DependencyInjection/SncRedisExtension.php

@@ -31,6 +31,7 @@
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
+use Redis;
 
 use function array_map;
 use function assert;
@@ -160,6 +161,10 @@ private function loadPredisClient(array $client, ContainerBuilder $container): v
         // fix ssl configuration key name
         $client['options']['ssl'] = $client['options']['parameters']['ssl_context'] ?? [];
 
+        if (isset($client['options']['scan']) && $client['options']['scan'] === 'prefix') {
+            $client['options']['scan'] = Redis::SCAN_PREFIX;
+        }
+
         unset($client['options']['connection_async']);
         unset($client['options']['connection_timeout']);
         unset($client['options']['connection_persistent']);

src/Factory/PhpredisClientFactory.php

@@ -301,6 +301,10 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array
             $client->setOption($class::OPT_PREFIX, $options['prefix']);
         }
 
+        if (isset($options['scan']) && $options['scan'] === 'prefix') {
+            $client->setOption($class::OPT_SCAN, $class::SCAN_PREFIX);
+        }
+
         if (isset($options['read_write_timeout'])) {
             $client->setOption($class::OPT_READ_TIMEOUT, (float) $options['read_write_timeout']);
         }

tests/Factory/PhpredisClientFactoryTest.php

@@ -468,4 +468,19 @@ public function testCreateWithConnectionPersistentFalse(): void
         $this->assertInstanceOf(Redis::class, $client);
         $this->assertNull($client->getPersistentID());
     }
+
+    public function testScanOption()
+    {
+        $factory = new PhpredisClientFactory(new RedisCallInterceptor($this->redisLogger));
+        $options = [
+            'connection_timeout' => 0.0,
+            'connection_persistent' => false,
+            'scan' => 'prefix'
+        ];
+
+        $client = $factory->create(Redis::class, ['redis://localhost:6379'], $options, 'default', false);
+
+        $this->assertInstanceOf(Redis::class, $client);
+        $this->assertEquals(Redis::SCAN_PREFIX, $client->getOption(Redis::OPT_SCAN));
+    }
 }