Add connection_persistent_id parameter

Fixes #738

Author: Seldaek

docs/README.md

@@ -171,6 +171,35 @@ snc_redis:
 
 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.
+
+``` yaml
+snc_redis:
+    clients:
+        app_cache:
+            type: predis  # or phpredis
+            alias: app_cache
+            dsn: redis://localhost/0
+            options:
+                connection_persistent: true
+                connection_persistent_id: "app_cache_connection"
+        session_store:
+            type: predis  # or phpredis
+            alias: session_store
+            dsn: redis://localhost/1
+            options:
+                connection_persistent: true
+                connection_persistent_id: "session_store_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.
+
+**For phpredis clients:** The `connection_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.
+
 ### Sessions ###
 
 Use Redis sessions by utilizing Symfony built-in Redis session handler like so:
@@ -284,6 +313,7 @@ snc_redis:
                 prefix: foo
                 connection_timeout: 10
                 connection_persistent: true
+                connection_persistent_id: "cluster_connection"
                 read_write_timeout: 30
                 iterable_multibulk: false
                 throw_errors: true

src/DependencyInjection/Configuration/Configuration.php

@@ -125,6 +125,7 @@ private function addClientsSection(ArrayNodeDefinition $rootNode): void
                                     ->end()
                                     ->booleanNode('connection_async')->defaultFalse()->end()
                                     ->booleanNode('connection_persistent')->defaultFalse()->end()
+                                    ->scalarNode('connection_persistent_id')->defaultNull()->end()
                                     ->scalarNode('connection_timeout')->cannotBeEmpty()->defaultValue(5)->end()
                                     ->scalarNode('read_write_timeout')->defaultNull()->end()
                                     ->booleanNode('iterable_multibulk')->defaultFalse()->end()

src/DependencyInjection/SncRedisExtension.php

@@ -139,9 +139,25 @@ private function loadPredisClient(array $client, ContainerBuilder $container): v
         $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'])) {
+            if (class_exists('Predis\Client')) {
+                if (version_compare(\Predis\Client::VERSION, '2.4.0', '>=')) {
+                    $client['options']['conn_uid'] = $client['options']['connection_persistent_id'];
+                } else {
+                    throw new InvalidConfigurationException(
+                        'The connection_persistent_id parameter for Predis requires predis/predis version 2.4.0 or higher. ' .
+                        sprintf('Current version: %s', \Predis\Client::VERSION)
+                    );
+                }
+            }
+        }
+        
         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

@@ -123,7 +123,10 @@ private function createClientFromSentinel(string $class, array $dsns, string $al
         $sentinelClass        = $isRelay ? Sentinel::class : RedisSentinel::class;
         $masterName           = $options['service'];
         $connectionTimeout    = $options['connection_timeout'] ?? 0;
-        $connectionPersistent = $options['connection_persistent'] ? $masterName : null;
+        $connectionPersistent = null;
+        if ($options['connection_persistent']) {
+            $connectionPersistent = $options['connection_persistent_id'] ?? $masterName;
+        }
         $readTimeout          = $options['read_write_timeout'] ?? 0;
         $parameters           = $options['parameters'];
 
@@ -254,11 +257,16 @@ private function createClient(RedisDsn $dsn, string $class, string $alias, array
             $context['stream'] = $options['parameters']['ssl_context'];
         }
 
+        $persistentId = null;
+        if (!empty($options['connection_persistent'])) {
+            $persistentId = $options['connection_persistent_id'] ?? $dsn->getPersistentId();
+        }
+
         $connectParameters = [
             $socket ?? ($dsn->getTls() ? 'tls://' : '') . $dsn->getHost(),
             $dsn->getPort(),
             $options['connection_timeout'],
-            empty($options['connection_persistent']) ? null : $dsn->getPersistentId(),
+            $persistentId,
             5, // retry interval
             5, // read timeout
             $context,

tests/DependencyInjection/SncRedisExtensionEnvTest.php

@@ -96,6 +96,7 @@ 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,
@@ -139,6 +140,7 @@ public function testPhpredisFullConfig(): void
                     'logging' => false,
                 ],
                 'connection_async' => false,
+                'connection_persistent_id' => null,
                 'read_write_timeout' => null,
                 'iterable_multibulk' => false,
                 'throw_errors' => true,
@@ -166,6 +168,7 @@ public function testPhpredisWithAclConfig(): void
                 'cluster' => null,
                 'connection_async' => false,
                 'connection_persistent' => true,
+                'connection_persistent_id' => null,
                 'connection_timeout' => 10,
                 'iterable_multibulk' => false,
                 'parameters' => [
@@ -219,6 +222,7 @@ 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,
@@ -248,6 +252,7 @@ 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,
@@ -279,6 +284,7 @@ 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

@@ -755,6 +755,58 @@ private function getPhpRedisWithInvalidACLYamlMinimalConfig(): string
                 username: user
                 password: password
 
+YAML;
+    }
+
+    public function testPredisWithConnectionPersistentId(): void
+    {
+        if (!class_exists('Predis\Client')) {
+            $this->markTestSkipped('Predis not available');
+        }
+
+        if (version_compare(\Predis\Client::VERSION, '2.4.0', '<')) {
+            $this->markTestSkipped('Predis version 2.4.0 or higher required for connection_persistent_id');
+        }
+
+        $extension = new SncRedisExtension();
+        $config = $this->parseYaml($this->getPredisWithConnectionPersistentIdYamlConfig());
+        $extension->load([$config], $container = $this->getContainer());
+
+        $this->assertTrue($container->hasDefinition('snc_redis.default'));
+        $definition = $container->getDefinition('snc_redis.connection.default_parameters.default');
+        $this->assertSame('my_custom_conn_uid', $definition->getArgument(0)['conn_uid']);
+    }
+
+    public function testPredisWithConnectionPersistentIdVersionTooOld(): void
+    {
+        if (!class_exists('Predis\Client')) {
+            $this->markTestSkipped('Predis not available');
+        }
+
+        if (version_compare(\Predis\Client::VERSION, '2.4.0', '>=')) {
+            $this->markTestSkipped('This test requires Predis version < 2.4.0');
+        }
+
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('The connection_persistent_id parameter for Predis requires predis/predis version 2.4.0 or higher');
+
+        $extension = new SncRedisExtension();
+        $config = $this->parseYaml($this->getPredisWithConnectionPersistentIdYamlConfig());
+        $extension->load([$config], $container = $this->getContainer());
+    }
+
+    private function getPredisWithConnectionPersistentIdYamlConfig(): string
+    {
+        return <<<'YAML'
+clients:
+    default:
+        type: predis
+        alias: default
+        dsn: redis://localhost:6379/0
+        options:
+            connection_persistent: true
+            connection_persistent_id: my_custom_conn_uid
+            
 YAML;
     }
 

tests/Factory/PhpredisClientFactoryTest.php

@@ -411,4 +411,24 @@ public function testMethodWithPassByRefArgument(): void
         /** @psalm-suppress TooFewArguments */
         $this->assertSame(['mykey'], $client->scan($iterator2));
     }
+
+    public function testCreateWithCustomPersistentId(): void
+    {
+        $factory = new PhpredisClientFactory(new RedisCallInterceptor($this->redisLogger));
+
+        $client = $factory->create(
+            Redis::class,
+            ['redis://localhost:6379'],
+            [
+                'connection_timeout' => 5,
+                'connection_persistent' => true,
+                'connection_persistent_id' => 'my_custom_persistent_id',
+            ],
+            'default',
+            false,
+        );
+
+        $this->assertInstanceOf(Redis::class, $client);
+        $this->assertSame('my_custom_persistent_id', $client->getPersistentID());
+    }
 }