bug #37590 Allows RedisClusterProxy instance in Lock RedisStore (jderusse)

nicolas-grekas · nicolas-grekas · commit 0eae7a6578d9 · 2020-07-23T19:20:20.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- Allows RedisClusterProxy instance in Lock RedisStore | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #37476 | License | MIT | Doc PR | / This PR allow clients instance of RedisClusterProxy created by the StoreFactory in #28691 /cc @nicolas-grekas Commits ------- 8ef63cd Allows RedisClusterProxy instance in Lock RedisStore
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -84,7 +84,7 @@ private function init($redisClient, string $namespace, int $defaultLifetime, ?Ma
      *
      * @throws InvalidArgumentException when the DSN is invalid
      *
-     * @return \Redis|\RedisCluster|\Predis\ClientInterface According to the "class" option
+     * @return \Redis|\RedisCluster|RedisClusterProxy|RedisProxy|\Predis\ClientInterface According to the "class" option
      */
     public static function createConnection($dsn, array $options = [])
     {
diff --git a/src/Symfony/Component/Lock/Store/RedisStore.php b/src/Symfony/Component/Lock/Store/RedisStore.php
@@ -33,13 +33,13 @@ class RedisStore implements StoreInterface
     private $initialTtl;
 
     /**
-     * @param \Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface $redisClient
-     * @param float                                                    $initialTtl  the expiration delay of locks in seconds
+     * @param \Redis|\RedisArray|\RedisCluster|RedisProxy|RedisClusterProxy\Predis\ClientInterface $redisClient
+     * @param float                                                                                $initialTtl  the expiration delay of locks in seconds
      */
     public function __construct($redisClient, float $initialTtl = 300.0)
     {
-        if (!$redisClient instanceof \Redis && !$redisClient instanceof \RedisArray && !$redisClient instanceof \RedisCluster && !$redisClient instanceof \Predis\ClientInterface && !$redisClient instanceof RedisProxy) {
-            throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));
+        if (!$redisClient instanceof \Redis && !$redisClient instanceof \RedisArray && !$redisClient instanceof \RedisCluster && !$redisClient instanceof \Predis\ClientInterface && !$redisClient instanceof RedisProxy && !$redisClient instanceof RedisClusterProxy) {
+            throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster, RedisProxy, RedisClusterProxy or Predis\ClientInterface, "%s" given.', __METHOD__, \is_object($redisClient) ? \get_class($redisClient) : \gettype($redisClient)));
         }
 
         if ($initialTtl <= 0) {
diff --git a/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php b/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php
@@ -61,6 +61,9 @@ public function validConnections()
         }
         if (class_exists(\Redis::class) && class_exists(AbstractAdapter::class)) {
             yield ['redis://localhost', RedisStore::class];
+            yield ['redis://localhost?lazy=1', RedisStore::class];
+            yield ['redis://localhost?redis_cluster=1', RedisStore::class];
+            yield ['redis://localhost?redis_cluster=1&lazy=1', RedisStore::class];
         }
         if (class_exists(\PDO::class)) {
             yield ['sqlite:/tmp/sqlite.db', PdoStore::class];

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ private function init($redisClient, string $namespace, int $defaultLifetime, ?Ma`
`84`	`84`	`*`
`85`	`85`	`* @throws InvalidArgumentException when the DSN is invalid`
`86`	`86`	`*`
`87`		`- * @return \Redis\|\RedisCluster\|\Predis\ClientInterface According to the "class" option`
	`87`	`+ * @return \Redis\|\RedisCluster\|RedisClusterProxy\|RedisProxy\|\Predis\ClientInterface According to the "class" option`
`88`	`88`	`*/`
`89`	`89`	`public static function createConnection($dsn, array $options = [])`
`90`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ public function validConnections()`
`61`	`61`	`}`
`62`	`62`	`if (class_exists(\Redis::class) && class_exists(AbstractAdapter::class)) {`
`63`	`63`	`yield ['redis://localhost', RedisStore::class];`
	`64`	`+ yield ['redis://localhost?lazy=1', RedisStore::class];`
	`65`	`+ yield ['redis://localhost?redis_cluster=1', RedisStore::class];`
	`66`	`+ yield ['redis://localhost?redis_cluster=1&lazy=1', RedisStore::class];`
`64`	`67`	`}`
`65`	`68`	`if (class_exists(\PDO::class)) {`
`66`	`69`	`yield ['sqlite:/tmp/sqlite.db', PdoStore::class];`