Merge new param with connection_persistent

Author: Seldaek

docs/README.md

@@ -173,7 +173,12 @@ It also works for the Phpredis Cluster mode.
 
 ### Persistent Connections ###
 
-When using persistent connections, you may need to provide a unique identifier to ensure that different clients don't share the same socket connection. This is especially important when operating multiple clients within the same application that communicate with the same Redis server.
+When using persistent connections, you can provide a unique identifier to ensure that different clients don't share the same socket connection. This is especially important when operating multiple clients within the same application that communicate with the same Redis server.
+
+The `connection_persistent` option accepts either a boolean or string value:
+- `true`: Enable persistent connections using the client alias as the connection ID
+- `false`: Disable persistent connections (default)
+- `string`: Enable persistent connections using the provided string as the connection ID
 
 ``` yaml
 snc_redis:
@@ -183,22 +188,26 @@ snc_redis:
             alias: app_cache
             dsn: redis://localhost/0
             options:
-                connection_persistent: true
-                connection_persistent_id: "app_cache_connection"
+                connection_persistent: "app_cache_connection"  # Custom persistent ID
         session_store:
             type: predis  # or phpredis
             alias: session_store
             dsn: redis://localhost/1
             options:
-                connection_persistent: true
-                connection_persistent_id: "session_store_connection"
+                connection_persistent: true  # Uses alias as persistent ID
+        simple_cache:
+            type: phpredis
+            alias: simple_cache
+            dsn: redis://localhost/2
+            options:
+                connection_persistent: false  # No persistent connection
 ```
 
-**Why this matters:** Without `connection_persistent_id`, two clients connecting to different databases on the same Redis server would share the same persistent socket, leading to unexpected behavior where commands from one client could affect the database context of another.
+**Why this matters:** Without a unique persistent connection ID, two clients connecting to different databases on the same Redis server would share the same persistent socket, leading to unexpected behavior where commands from one client could affect the database context of another.
 
-**For phpredis clients:** The `connection_persistent_id` is passed directly to the `pconnect()` function as the persistent ID parameter.
+**For phpredis clients:** The persistent ID is passed directly to the `pconnect()` function as the persistent ID parameter.
 
-**For predis clients:** The `connection_persistent_id` is mapped to the `conn_uid` connection option (requires predis/predis version 2.4.0 or higher). This ensures each client creates its own socket so the connection context won't be shared across clients.
+**For predis clients:** The persistent ID is mapped to the `conn_uid` connection option (requires predis/predis version 2.4.0 or higher). This ensures each client creates its own socket so the connection context won't be shared across clients.
 
 ### Sessions ###
 

src/DependencyInjection/Configuration/Configuration.php

@@ -29,7 +29,9 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 use function class_exists;
+use function is_bool;
 use function is_iterable;
+use function is_string;
 use function trigger_deprecation;
 
 class Configuration implements ConfigurationInterface
@@ -124,8 +126,13 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                         ->scalarPrototype()->end()
                                     ->end()
                                     ->booleanNode('connection_async')->defaultFalse()->end()
-                                    ->booleanNode('connection_persistent')->defaultFalse()->end()
-                                    ->scalarNode('connection_persistent_id')->defaultNull()->end()
+                                    ->variableNode('connection_persistent')
+                                        ->defaultFalse()
+                                        ->validate()
+                                            ->ifTrue(static fn ($v) => !(is_bool($v) || (is_string($v) && $v !== '')))
+                                            ->thenInvalid('connection_persistent must be a boolean or string')
+                                        ->end()
+                                    ->end()
                                     ->scalarNode('connection_timeout')->cannotBeEmpty()->defaultValue(5)->end()
                                     ->scalarNode('read_write_timeout')->defaultNull()->end()
                                     ->booleanNode('iterable_multibulk')->defaultFalse()->end()

src/DependencyInjection/SncRedisExtension.php

@@ -36,6 +36,7 @@
 use function assert;
 use function class_exists;
 use function count;
+use function is_string;
 use function sprintf;
 use function version_compare;
 
@@ -137,29 +138,31 @@ private function loadPredisClient(array $client, ContainerBuilder $container): v
         // predis connection parameters have been renamed in v0.8
         $client['options']['async_connect'] = $client['options']['connection_async'];
         $client['options']['timeout']       = $client['options']['connection_timeout'];
-        $client['options']['persistent']    = $client['options']['connection_persistent'];
-        $client['options']['exceptions']    = $client['options']['throw_errors'];
-        // fix ssl configuration key name
-        $client['options']['ssl'] = $client['options']['parameters']['ssl_context'] ?? [];
-
-        // Handle connection_persistent_id for predis conn_uid (requires predis >= 2.4.0)
-        if (isset($client['options']['connection_persistent_id'])) {
+        // Handle connection_persistent as bool|string
+        if (is_string($client['options']['connection_persistent'])) {
+            $client['options']['persistent'] = true;
+            // For predis, use the string value as conn_uid (requires predis >= 2.4.0)
             if (class_exists('Predis\Client')) {
                 if (!version_compare(Client::VERSION, '2.4.0', '>=')) {
                     throw new InvalidConfigurationException(
-                        'The connection_persistent_id parameter for Predis requires predis/predis version 2.4.0 or higher. ' .
+                        'Using connection_persistent as string for Predis requires predis/predis version 2.4.0 or higher. ' .
                         sprintf('Current version: %s', Client::VERSION),
                     );
                 }
 
-                $client['options']['conn_uid'] = $client['options']['connection_persistent_id'];
+                $client['options']['conn_uid'] = $client['options']['connection_persistent'];
             }
+        } else {
+            $client['options']['persistent'] = $client['options']['connection_persistent'];
         }
 
+        $client['options']['exceptions'] = $client['options']['throw_errors'];
+        // fix ssl configuration key name
+        $client['options']['ssl'] = $client['options']['parameters']['ssl_context'] ?? [];
+
         unset($client['options']['connection_async']);
         unset($client['options']['connection_timeout']);
         unset($client['options']['connection_persistent']);
-        unset($client['options']['connection_persistent_id']);
         unset($client['options']['throw_errors']);
         unset($client['options']['parameters']['ssl_context']);
 

src/Factory/PhpredisClientFactory.php

@@ -32,6 +32,7 @@
 use function in_array;
 use function is_a;
 use function is_array;
+use function is_string;
 use function phpversion;
 use function spl_autoload_register;
 use function sprintf;
@@ -111,9 +112,9 @@ public function create(string $class, array $dsns, array $options, string $alias
     }
 
     /**
-     * @param class-string                                                                                                                                                                                                                $class
-     * @param list<RedisDsn>                                                                                                                                                                                                              $dsns
-     * @param array{service: ?string, connection_persistent: ?bool, connection_persistent_id: ?string, connection_timeout: ?string, read_write_timeout: ?string, parameters: array{sentinel_username: string, sentinel_password: string}} $options
+     * @param class-string                                                                                                                                                                                              $class
+     * @param list<RedisDsn>                                                                                                                                                                                            $dsns
+     * @param array{service: ?string, connection_persistent: ?bool|non-empty-string, connection_timeout: ?string, read_write_timeout: ?string, parameters: array{sentinel_username: string, sentinel_password: string}} $options
      *
      * @return Redis|Relay
      */
@@ -125,7 +126,9 @@ private function createClientFromSentinel(string $class, array $dsns, string $al
         $connectionTimeout    = $options['connection_timeout'] ?? 0;
         $connectionPersistent = null;
         if ($options['connection_persistent']) {
-            $connectionPersistent = $options['connection_persistent_id'] ?? $masterName;
+            $connectionPersistent = is_string($options['connection_persistent'])
+                ? $options['connection_persistent']
+                : $masterName;
         }
 
         $readTimeout = $options['read_write_timeout'] ?? 0;
@@ -260,7 +263,9 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array
 
         $persistentId = null;
         if (!empty($options['connection_persistent'])) {
-            $persistentId = $options['connection_persistent_id'] ?? $dsn->getPersistentId();
+            $persistentId = is_string($options['connection_persistent'])
+                ? $options['connection_persistent']
+                : $alias;
         }
 
         $connectParameters = [

tests/DependencyInjection/SncRedisExtensionEnvTest.php

@@ -96,7 +96,6 @@ public function testPhpredisDefaultParameterConfig(string $config, string $class
             [
                 'connection_async' => false,
                 'connection_persistent' => false,
-                'connection_persistent_id' => null,
                 'connection_timeout' => 5,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
@@ -140,7 +139,6 @@ public function testPhpredisFullConfig(): void
                     'logging' => false,
                 ],
                 'connection_async' => false,
-                'connection_persistent_id' => null,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -168,7 +166,6 @@ public function testPhpredisWithAclConfig(): void
                 'cluster' => null,
                 'connection_async' => false,
                 'connection_persistent' => true,
-                'connection_persistent_id' => null,
                 'connection_timeout' => 10,
                 'iterable_multibulk' => false,
                 'parameters' => [
@@ -222,7 +219,6 @@ public function testPhpRedisClusterOption(): void
                 'cluster' => true,
                 'connection_async' => false,
                 'connection_persistent' => false,
-                'connection_persistent_id' => null,
                 'connection_timeout' => 5,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
@@ -252,7 +248,6 @@ public function testPhpRedisSentinelOption(): void
                 'service' => 'mymaster',
                 'connection_async' => false,
                 'connection_persistent' => false,
-                'connection_persistent_id' => null,
                 'connection_timeout' => 5,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
@@ -284,7 +279,6 @@ public function testPhpRedisClusterOptionMultipleDsn(): void
                 'connection_timeout' => 1.5,
                 'connection_persistent' => true,
                 'connection_async' => false,
-                'connection_persistent_id' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
                 'serialization' => 'default',

tests/DependencyInjection/SncRedisExtensionTest.php

@@ -761,26 +761,47 @@ private function getPhpRedisWithInvalidACLYamlMinimalConfig(): string
 YAML;
     }
 
-    public function testPredisWithConnectionPersistentId(): void
+    public function testPredisWithConnectionPersistentBool(): void
     {
         if (!class_exists('Predis\Client')) {
             $this->markTestSkipped('Predis not available');
         }
 
         if (version_compare(Client::VERSION, '2.4.0', '<')) {
-            $this->markTestSkipped('Predis version 2.4.0 or higher required for connection_persistent_id');
+            $this->markTestSkipped('Predis version 2.4.0 or higher required for connection_persistent');
         }
 
         $extension = new SncRedisExtension();
-        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentIdYamlConfig());
+        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentBoolYamlConfig());
         $extension->load([$config], $container = $this->getContainer());
 
         $this->assertTrue($container->hasDefinition('snc_redis.default'));
         $definition = $container->getDefinition('snc_redis.connection.default_parameters.default');
+        $this->assertTrue($definition->getArgument(0)['persistent']);
+        $this->assertNull($definition->getArgument(0)['conn_uid']);
+    }
+
+    public function testPredisWithConnectionPersistentString(): void
+    {
+        if (!class_exists('Predis\Client')) {
+            $this->markTestSkipped('Predis not available');
+        }
+
+        if (version_compare(Client::VERSION, '2.4.0', '<')) {
+            $this->markTestSkipped('Predis version 2.4.0 or higher required for connection_persistent');
+        }
+
+        $extension = new SncRedisExtension();
+        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentStringYamlConfig());
+        $extension->load([$config], $container = $this->getContainer());
+
+        $this->assertTrue($container->hasDefinition('snc_redis.default'));
+        $definition = $container->getDefinition('snc_redis.connection.default_parameters.default');
+        $this->assertTrue($definition->getArgument(0)['persistent']);
         $this->assertSame('my_custom_conn_uid', $definition->getArgument(0)['conn_uid']);
     }
 
-    public function testPredisWithConnectionPersistentIdVersionTooOld(): void
+    public function testPredisWithConnectionPersistentVersionTooOld(): void
     {
         if (!class_exists('Predis\Client')) {
             $this->markTestSkipped('Predis not available');
@@ -791,14 +812,14 @@ public function testPredisWithConnectionPersistentIdVersionTooOld(): void
         }
 
         $this->expectException(InvalidConfigurationException::class);
-        $this->expectExceptionMessage('The connection_persistent_id parameter for Predis requires predis/predis version 2.4.0 or higher');
+        $this->expectExceptionMessage('The connection_persistent parameter for Predis requires predis/predis version 2.4.0 or higher');
 
         $extension = new SncRedisExtension();
-        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentIdYamlConfig());
+        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentStringYamlConfig());
         $extension->load([$config], $container = $this->getContainer());
     }
 
-    private function getPredisWithConnectionPersistentIdYamlConfig(): string
+    private function getPredisWithConnectionPersistentBoolYamlConfig(): string
     {
         return <<<'YAML'
 clients:
@@ -808,7 +829,102 @@ private function getPredisWithConnectionPersistentIdYamlConfig(): string
         dsn: redis://localhost:6379/0
         options:
             connection_persistent: true
-            connection_persistent_id: my_custom_conn_uid
+            
+YAML;
+    }
+
+    private function getPredisWithConnectionPersistentStringYamlConfig(): string
+    {
+        return <<<'YAML'
+clients:
+    default:
+        type: predis
+        alias: default
+        dsn: redis://localhost:6379/0
+        options:
+            connection_persistent: my_custom_conn_uid
+            
+YAML;
+    }
+
+    public function testPredisWithConnectionPersistentFalse(): void
+    {
+        if (!class_exists('Predis\Client')) {
+            $this->markTestSkipped('Predis not available');
+        }
+
+        if (version_compare(Client::VERSION, '2.4.0', '<')) {
+            $this->markTestSkipped('Predis version 2.4.0 or higher required for connection_persistent');
+        }
+
+        $extension = new SncRedisExtension();
+        $config    = $this->parseYaml($this->getPredisWithConnectionPersistentFalseYamlConfig());
+        $extension->load([$config], $container = $this->getContainer());
+
+        $this->assertTrue($container->hasDefinition('snc_redis.default'));
+        $definition = $container->getDefinition('snc_redis.connection.default_parameters.default');
+        $this->assertFalse($definition->getArgument(0)['persistent']);
+        $this->assertNull($definition->getArgument(0)['conn_uid']);
+    }
+
+    private function getPredisWithConnectionPersistentFalseYamlConfig(): string
+    {
+        return <<<'YAML'
+clients:
+    default:
+        type: predis
+        alias: default
+        dsn: redis://localhost:6379/0
+        options:
+            connection_persistent: false
+            
+YAML;
+    }
+
+    public function testInvalidConnectionPersistentValue(): void
+    {
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('connection_persistent must be a boolean or string');
+
+        $extension = new SncRedisExtension();
+        $config    = $this->parseYaml($this->getInvalidConnectionPersistentYamlConfig());
+        $extension->load([$config], $this->getContainer());
+    }
+
+    private function getInvalidConnectionPersistentYamlConfig(): string
+    {
+        return <<<'YAML'
+clients:
+    default:
+        type: predis
+        alias: default
+        dsn: redis://localhost:6379/0
+        options:
+            connection_persistent: []
+            
+YAML;
+    }
+
+    public function testEmptyStringConnectionPersistentValue(): void
+    {
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('connection_persistent must be a boolean or string');
+
+        $extension = new SncRedisExtension();
+        $config    = $this->parseYaml($this->getEmptyStringConnectionPersistentYamlConfig());
+        $extension->load([$config], $this->getContainer());
+    }
+
+    private function getEmptyStringConnectionPersistentYamlConfig(): string
+    {
+        return <<<'YAML'
+clients:
+    default:
+        type: predis
+        alias: default
+        dsn: redis://localhost:6379/0
+        options:
+            connection_persistent: ""
 
 YAML;
     }