bug #50585 [Cache] Fix RedisTrait::createConnection for cluster (darkanakin41)

nicolas-grekas · nicolas-grekas · commit ca9a8c115d3b · 2023-06-08T23:03:54.000+02:00
This PR was submitted for the 6.3 branch but it was squashed and merged into the 5.4 branch instead. Discussion ---------- [Cache] Fix RedisTrait::createConnection for cluster | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | No | Deprecations? | No | Tickets | Fix #50509 | License | MIT | Doc PR | N/A When the dsn contains `redis_cluster=1` or `redis_cluster=true` the value was not properly parsed, and the class generated was not the expected RedisCluster. The reason is that the PHP core function `match` make a `===` check. So, as the dsn is a string, the `$params['redis_cluster']` needs to be force to a bool Commits ------- ca8e328 [Cache] Fix RedisTrait::createConnection for cluster
diff --git a/src/Symfony/Component/Cache/Tests/Traits/RedisTraitTest.php b/src/Symfony/Component/Cache/Tests/Traits/RedisTraitTest.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Tests\Traits;
+
+use PHPUnit\Framework\SkippedTestSuiteError;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\Traits\RedisTrait;
+
+class RedisTraitTest extends TestCase
+{
+    public static function setUpBeforeClass(): void
+    {
+        if (!getenv('REDIS_CLUSTER_HOSTS')) {
+            throw new SkippedTestSuiteError('REDIS_CLUSTER_HOSTS env var is not defined.');
+        }
+    }
+
+    /**
+     * @dataProvider provideCreateConnection
+     */
+    public function testCreateConnection(string $dsn, string $expectedClass)
+    {
+        if (!class_exists($expectedClass)) {
+            throw new SkippedTestSuiteError(sprintf('The "%s" class is required.', $expectedClass));
+        }
+        if (!getenv('REDIS_CLUSTER_HOSTS')) {
+            throw new SkippedTestSuiteError('REDIS_CLUSTER_HOSTS env var is not defined.');
+        }
+
+        $mock = self::getObjectForTrait(RedisTrait::class);
+        $connection = $mock::createConnection($dsn);
+
+        self::assertInstanceOf($expectedClass, $connection);
+    }
+
+    public static function provideCreateConnection(): array
+    {
+        $hosts = array_map(function ($host) { return sprintf('host[%s]', $host); }, explode(' ', getenv('REDIS_CLUSTER_HOSTS')));
+
+        return [
+            [
+                sprintf('redis:?%s&redis_cluster=1', $hosts[0]),
+                'RedisCluster',
+            ],
+            [
+                sprintf('redis:?%s&redis_cluster=true', $hosts[0]),
+                'RedisCluster',
+            ],
+            [
+                sprintf('redis:?%s', $hosts[0]),
+                'Redis',
+            ],
+            [
+                'dsn' => sprintf('redis:?%s', implode('&', \array_slice($hosts, 0, 2))),
+                'RedisArray',
+            ],
+        ];
+    }
+}
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -174,6 +174,11 @@ public static function createConnection(string $dsn, array $options = [])
             throw new CacheException(sprintf('Redis Sentinel support requires the "predis/predis" package or the "redis" extension v5.2 or higher: "%s".', $dsn));
         }
 
+        if (isset($params['lazy'])) {
+            $params['lazy'] = filter_var($params['lazy'], \FILTER_VALIDATE_BOOLEAN);
+        }
+        $params['redis_cluster'] = filter_var($params['redis_cluster'], \FILTER_VALIDATE_BOOLEAN);
+
         if ($params['redis_cluster'] && isset($params['redis_sentinel'])) {
             throw new InvalidArgumentException(sprintf('Cannot use both "redis_cluster" and "redis_sentinel" at the same time: "%s".', $dsn));
         }

Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,11 @@ public static function createConnection(string $dsn, array $options = [])`
`174`	`174`	`throw new CacheException(sprintf('Redis Sentinel support requires the "predis/predis" package or the "redis" extension v5.2 or higher: "%s".', $dsn));`
`175`	`175`	`}`
`176`	`176`
	`177`	`+ if (isset($params['lazy'])) {`
	`178`	`+ $params['lazy'] = filter_var($params['lazy'], \FILTER_VALIDATE_BOOLEAN);`
	`179`	`+ }`
	`180`	`+ $params['redis_cluster'] = filter_var($params['redis_cluster'], \FILTER_VALIDATE_BOOLEAN);`
	`181`	`+`
`177`	`182`	`if ($params['redis_cluster'] && isset($params['redis_sentinel'])) {`
`178`	`183`	`throw new InvalidArgumentException(sprintf('Cannot use both "redis_cluster" and "redis_sentinel" at the same time: "%s".', $dsn));`
`179`	`184`	`}`