Fix bunch of things and rebase

ostrolucky · ostrolucky · commit bda25c641f62 · 2025-07-18T13:00:21.000+02:00
diff --git a/docs/README.md b/docs/README.md
@@ -295,21 +295,6 @@ 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
@@ -338,7 +323,7 @@ snc_redis:
                 connection_timeout: 10
                 connection_persistent: true
                 read_write_timeout: 30
-                scan: prefix
+                scan: !php/const REDIS::SCAN_PREFIX # OPT_SCAN option, phpredis only
                 iterable_multibulk: false
                 throw_errors: true
                 cluster: predis
diff --git a/src/DependencyInjection/Configuration/Configuration.php b/src/DependencyInjection/Configuration/Configuration.php
@@ -134,7 +134,9 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                         ->end()
                                     ->end()
                                     ->scalarNode('connection_timeout')->cannotBeEmpty()->defaultValue(5)->end()
-                                    ->scalarNode('scan')->defaultNull()->end()
+                                    ->integerNode('scan')
+                                        ->defaultValue(0) // Redis::SCAN_NORETRY
+                                    ->end()
                                     ->scalarNode('read_write_timeout')->defaultNull()->end()
                                     ->booleanNode('iterable_multibulk')->defaultFalse()->end()
                                     ->booleanNode('throw_errors')->defaultTrue()->end()
diff --git a/src/DependencyInjection/SncRedisExtension.php b/src/DependencyInjection/SncRedisExtension.php
@@ -16,7 +16,6 @@
 use InvalidArgumentException;
 use LogicException;
 use Predis\Client;
-use Redis;
 use RedisSentinel;
 use Relay\Sentinel;
 use Snc\RedisBundle\DependencyInjection\Configuration\Configuration;
@@ -161,10 +160,6 @@ 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']);
diff --git a/src/Factory/PhpredisClientFactory.php b/src/Factory/PhpredisClientFactory.php
@@ -301,9 +301,8 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array
             $client->setOption($class::OPT_PREFIX, $options['prefix']);
         }
 
-        // Support for scan option since https://github.com/phpredis/phpredis/issues/548
-        if (isset($options['scan']) && $options['scan'] === 'prefix') {
-            $client->setOption($class::OPT_SCAN, $class::SCAN_PREFIX);
+        if (isset($options['scan'])) {
+            $client->setOption($class::OPT_SCAN, $options['scan']);
         }
 
         if (isset($options['read_write_timeout'])) {
diff --git a/src/Factory/PredisParametersFactory.php b/src/Factory/PredisParametersFactory.php
@@ -6,7 +6,6 @@
 
 use InvalidArgumentException;
 use Predis\Connection\ParametersInterface;
-use Redis;
 use Snc\RedisBundle\DependencyInjection\Configuration\RedisDsn;
 
 use function array_filter;
@@ -28,13 +27,8 @@ public static function create(array $options, string $class, string $dsn): Param
         }
 
         $defaultOptions = ['timeout' => null]; // Allow to be consistent with old version of Predis where default timeout was 5
-
-        if (isset($options['scan']) && $options['scan'] === 'prefix') {
-            $dsnOptions[Redis::OPT_SCAN] = Redis::SCAN_PREFIX;
-        }
-
-        $dsnOptions = static::parseDsn(new RedisDsn($dsn));
-        $dsnOptions = array_merge($defaultOptions, $options, $dsnOptions);
+        $dsnOptions     = static::parseDsn(new RedisDsn($dsn));
+        $dsnOptions     = array_merge($defaultOptions, $options, $dsnOptions);
 
         if (!empty($dsnOptions['persistent']) && !empty($dsnOptions['database'])) {
             $dsnOptions['persistent'] = (int) $dsnOptions['database'];
diff --git a/tests/DependencyInjection/Fixtures/config/yaml/env_phpredis_full.yaml b/tests/DependencyInjection/Fixtures/config/yaml/env_phpredis_full.yaml
@@ -12,6 +12,7 @@ snc_redis:
                 connection_timeout: 10
                 connection_persistent: true
                 prefix: totoprofix
+                scan: !php/const Redis::SCAN_PREFIX
                 serialization: php
                 parameters:
                     ssl_context: {'verify_peer': false, 'allow_self_signed': true, 'verify_peer_name': false}
diff --git a/tests/DependencyInjection/SncRedisExtensionEnvTest.php b/tests/DependencyInjection/SncRedisExtensionEnvTest.php
@@ -59,7 +59,7 @@ public function testPredisDefaultParameterConfig(): void
                     'logging' => false,
                 ],
                 'commands' => ['foo' => 'Foo\Bar\Baz'],
-                'scan' => null,
+                'scan' => 0,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'serialization' => 'default',
@@ -99,7 +99,7 @@ public function testPhpredisDefaultParameterConfig(string $config, string $class
                 'connection_async' => false,
                 'connection_persistent' => false,
                 'connection_timeout' => 5,
-                'scan' => null,
+                'scan' => 0,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -127,6 +127,7 @@ public function testPhpredisFullConfig(): void
                 'connection_timeout' => 10,
                 'connection_persistent' => true,
                 'prefix' => 'totoprofix',
+                'scan' => 2,
                 'serialization' => 'php',
                 'parameters' => [
                     'ssl_context' => [
@@ -142,7 +143,6 @@ public function testPhpredisFullConfig(): void
                     'logging' => false,
                 ],
                 'connection_async' => false,
-                'scan' => null,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -186,7 +186,7 @@ public function testPhpredisWithAclConfig(): void
                 'serialization' => 'php',
                 'service' => null,
                 'throw_errors' => true,
-                'scan' => null,
+                'scan' => 0,
             ],
             $clientDefinition->getArgument(2),
         );
@@ -225,7 +225,7 @@ public function testPhpRedisClusterOption(): void
                 'connection_async' => false,
                 'connection_persistent' => false,
                 'connection_timeout' => 5,
-                'scan' => null,
+                'scan' => 0,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -255,7 +255,7 @@ public function testPhpRedisSentinelOption(): void
                 'connection_async' => false,
                 'connection_persistent' => false,
                 'connection_timeout' => 5,
-                'scan' => null,
+                'scan' => 0,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -286,7 +286,7 @@ public function testPhpRedisClusterOptionMultipleDsn(): void
                 'connection_timeout' => 1.5,
                 'connection_persistent' => true,
                 'connection_async' => false,
-                'scan' => null,
+                'scan' => 0,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
                 'serialization' => 'default',
diff --git a/tests/Factory/PhpredisClientFactoryTest.php b/tests/Factory/PhpredisClientFactoryTest.php
@@ -191,6 +191,7 @@ public function testCreateFullConfig(): void
                 'connection_timeout' => 10,
                 'connection_persistent' => 'x',
                 'prefix' => 'toto',
+                'scan' => Redis::SCAN_PREFIX,
                 'serialization' => 'php',
                 'read_write_timeout' => 4,
                 'parameters' => [
@@ -210,6 +211,7 @@ public function testCreateFullConfig(): void
         $this->assertSame('sncredis', $client->getAuth());
         $this->assertNotNull($client->getPersistentID());
         $this->assertNotFalse($client->getPersistentID());
+        $this->assertEquals(Redis::SCAN_PREFIX, $client->getOption(Redis::OPT_SCAN));
     }
 
     public function testDsnConfig(): void
@@ -468,19 +470,4 @@ public function testCreateWithConnectionPersistentFalse(): void
         $this->assertInstanceOf(Redis::class, $client);
         $this->assertNull($client->getPersistentID());
     }
-
-    public function testScanOption(): void
-    {
-        $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));
-    }
 }
diff --git a/tests/Factory/PredisParametersFactoryTest.php b/tests/Factory/PredisParametersFactoryTest.php
@@ -128,7 +128,8 @@ public static function createDp(): array
             'everything in DSN' => [
                 'rediss://pw@localhost:6380/0?prefix=foo&alias=connection_alias',
                 [],
-                $allOptions = [
+                $allOptions =
+                [
                     'scheme' => 'tls',
                     'host' => 'localhost',
                     'port' => 6380,
@@ -138,7 +139,7 @@ public static function createDp(): array
                     'alias' => 'connection_alias',
                 ],
             ],
-            'everything in options' => ['rediss://localhost:6380', $allOptions, $allOptions]
+            'everything in options' => ['rediss://localhost:6380', $allOptions, $allOptions],
         ];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -301,9 +301,8 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array`
`301`	`301`	`$client->setOption($class::OPT_PREFIX, $options['prefix']);`
`302`	`302`	`}`
`303`	`303`
`304`		`- // Support for scan option since https://github.com/phpredis/phpredis/issues/548`
`305`		`- if (isset($options['scan']) && $options['scan'] === 'prefix') {`
`306`		`- $client->setOption($class::OPT_SCAN, $class::SCAN_PREFIX);`
	`304`	`+ if (isset($options['scan'])) {`
	`305`	`+ $client->setOption($class::OPT_SCAN, $options['scan']);`
`307`	`306`	`}`
`308`	`307`
`309`	`308`	`if (isset($options['read_write_timeout'])) {`