[Cache] Add ability to configure predis client.

jralph · jralph · commit 2fe2f531e63e · 2018-08-15T12:01:40.000+01:00
When the predis driver is created, there is no current way to
configure the predis client options (such as setting the cluster
mode to redis). This merge allows you to add a predis_options
parameter to the dsn to allow configuration of options.
diff --git a/src/Symfony/Component/Cache/CHANGELOG.md b/src/Symfony/Component/Cache/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * added sub-second expiry accuracy for backends that support it
  * added support for phpredis 4 `compression` and `tcp_keepalive` options
  * added automatic table creation when using Doctrine DBAL with PDO-based backends
+ * added support for a `predis_options` query parameter array in the redis dsn.
  * throw `LogicException` when `CacheItem::tag()` is called on an item coming from a non tag-aware pool
  * deprecated `CacheItem::getPreviousTags()`, use `CacheItem::getMetadata()` instead
  * deprecated the `AbstractAdapter::createSystemCache()` method
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterTest.php
@@ -51,6 +51,9 @@ public function testCreateConnection()
 
         $redis = RedisAdapter::createConnection('redis://'.$redisHost, array('read_timeout' => 5));
         $this->assertEquals(5, $redis->getReadTimeout());
+
+        $redis = RedisAdapter::createConnection('redis://'.$redisHost.'?predis_options["cluster"]=redis');
+        $this->assertInstanceOf(\Predis\Client::class, $redis);
     }
 
     /**
@@ -72,6 +75,23 @@ public function provideFailedCreateConnection()
         );
     }
 
+    /**
+     * @dataProvider provideInvalidDSNCreateConnection
+     * @expectedException \Symfony\Component\Cache\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Cannot find the "redis" extension and expected an instance of Predis\Client, instead got: \SomeClass
+     */
+    public function testInvalidDSNFailedConnection($dsn)
+    {
+        RedisAdapter::createConnection($dsn);
+    }
+
+    public function provideInvalidDSNCreateConnection()
+    {
+        return array(
+            array('redis://localhost?predis_options[cluster]=redis&class=\SomeClass'),
+        );
+    }
+
     /**
      * @dataProvider provideInvalidCreateConnection
      * @expectedException \Symfony\Component\Cache\Exception\InvalidArgumentException
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -118,8 +118,17 @@ public static function createConnection($dsn, array $options = array())
         $params += $options + self::$defaultConnectionOptions;
         if (null === $params['class'] && !\extension_loaded('redis') && !class_exists(\Predis\Client::class)) {
             throw new CacheException(sprintf('Cannot find the "redis" extension, and "predis/predis" is not installed: %s', $dsn));
+        } elseif (isset($params['predis_options']) && !class_exists(\Predis\Client::class)) {
+            throw new CacheException(sprintf('DSN contains "predis_options" and "predis/predis" is not installed: %s', $dsn));
+        } elseif (isset($params['predis_options']) || !\extension_loaded('redis')) {
+            if (null !== $params['class'] && !is_a($params['class'], \Predis\Client::class, true)) {
+                throw new InvalidArgumentException(sprintf('Cannot find the "redis" extension and expected an instance of %s, instead got: %s', \Predis\Client::class, $params['class']));
+            }
+
+            $class = null === $params['class'] ? \Predis\Client::class : $params['class'];
+        } else {
+            $class = null === $params['class'] ? \Redis::class : $params['class'];
         }
-        $class = null === $params['class'] ? (\extension_loaded('redis') ? \Redis::class : \Predis\Client::class) : $params['class'];
 
         if (is_a($class, \Redis::class, true)) {
             $connect = $params['persistent'] || $params['persistent_id'] ? 'pconnect' : 'connect';
@@ -167,7 +176,10 @@ public static function createConnection($dsn, array $options = array())
             $params['scheme'] = $scheme;
             $params['database'] = $params['dbindex'] ?: null;
             $params['password'] = $auth;
-            $redis = new $class((new Factory())->create($params));
+
+            $predisOptions = false !== isset($params['predis_options']) && true === \is_array($params['predis_options']) ? $params['predis_options'] : array();
+
+            $redis = new $class((new Factory())->create($params), $predisOptions);
         } elseif (class_exists($class, false)) {
             throw new InvalidArgumentException(sprintf('"%s" is not a subclass of "Redis" or "Predis\Client"', $class));
         } else {
