bug #46401 [Cache] Throw when "redis_sentinel" is used with a non-Predis "class" option (buffcode)

nicolas-grekas · nicolas-grekas · commit 3a47e5f74045 · 2022-05-21T11:27:16.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Cache] Throw when "redis_sentinel" is used with a non-Predis "class" option | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT Enforce usage of `\Predis\Client` when the `redis_sentinel` option is enabled. Otherwise it is possible to give the option `class: Redis`, which will setup the connection without any error but fail to work, because the Redis commands will be issued against the Sentinel instances instead of the Redis instances. Commits ------- cdc9414 [Cache] Throw when "redis_sentinel" is used with a non-Predis "class" option
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\SkippedTestSuiteError;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
+use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
 
 /**
@@ -43,4 +44,12 @@ public function testInvalidDSNHasBothClusterAndSentinel()
         $dsn = 'redis:?host[redis1]&host[redis2]&host[redis3]&redis_cluster=1&redis_sentinel=mymaster';
         RedisAdapter::createConnection($dsn);
     }
+
+    public function testSentinelRequiresPredis()
+    {
+        $this->expectException(CacheException::class);
+        $this->expectExceptionMessage('Cannot use Redis Sentinel: class "Redis" does not extend "Predis\Client":');
+        $dsn = 'redis:?host[redis1]&host[redis2]&host[redis3]&redis_cluster=1&redis_sentinel=mymaster';
+        RedisAdapter::createConnection($dsn, ['class' => \Redis::class]);
+    }
 }
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -178,6 +178,10 @@ public static function createConnection($dsn, array $options = [])
             $class = $params['redis_cluster'] ? \RedisCluster::class : (1 < \count($hosts) ? \RedisArray::class : \Redis::class);
         } else {
             $class = $params['class'] ?? \Predis\Client::class;
+
+            if (isset($params['redis_sentinel']) && !is_a($class, \Predis\Client::class, true)) {
+                throw new CacheException(sprintf('Cannot use Redis Sentinel: class "%s" does not extend "Predis\Client": "%s".', $class, $dsn));
+            }
         }
 
         if (is_a($class, \Redis::class, true)) {
