[Cache] Add ability to configure predis client.

jralph · jralph · commit 1ac9b3e3d76f · 2018-08-16T12:57:49.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
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Cache\Tests\Adapter;
 
+use Predis\Connection\Aggregate\RedisCluster;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
 use Symfony\Component\Cache\Traits\RedisProxy;
@@ -51,6 +52,11 @@ public function testCreateConnection()
 
         $redis = RedisAdapter::createConnection('redis://'.$redisHost, array('read_timeout' => 5));
         $this->assertEquals(5, $redis->getReadTimeout());
+
+        /** @var \Predis\Client $redis */
+        $redis = RedisAdapter::createConnection('redis://'.$redisHost.'?predis_options[cluster]=redis');
+        $this->assertInstanceOf(\Predis\Client::class, $redis);
+        $this->assertInstanceOf(RedisCluster::class, $redis->getOptions()->cluster);
     }
 
     /**
@@ -72,6 +78,23 @@ public function provideFailedCreateConnection()
         );
     }
 
+    /**
+     * @dataProvider provideInvalidDSNCreateConnection
+     * @expectedException \Symfony\Component\Cache\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Invalid connection option: "predis_options" provided but provided class "\SomeClass" is not an instance of \Predis\Client
+     */
+    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
@@ -119,7 +119,20 @@ public static function createConnection($dsn, array $options = array())
         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));
         }
-        $class = null === $params['class'] ? (\extension_loaded('redis') ? \Redis::class : \Predis\Client::class) : $params['class'];
+
+        if (isset($params['predis_options']) && !class_exists(\Predis\Client::class)) {
+            throw new InvalidArgumentException('Invalid connection option: "predis_options" provided but "predis/predis" is not installed.');
+        }
+
+        if (isset($params['predis_options']) && null !== $params['class'] && !is_a($params['class'], \Predis\Client::class, true)) {
+            throw new InvalidArgumentException(sprintf('Invalid connection option: "predis_options" provided but provided class "%s" is not an instance of \Predis\Client', $params['class']));
+        }
+
+        if (isset($params['predis_options'])) {
+            $class = $params['class'] ?? \Predis\Client::class;
+        } else {
+            $class = $params['class'] ?? (\extension_loaded('redis') ? \Redis::class : \Predis\Client::class);
+        }
 
         if (is_a($class, \Redis::class, true)) {
             $connect = $params['persistent'] || $params['persistent_id'] ? 'pconnect' : 'connect';
@@ -167,7 +180,14 @@ 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 = $params['predis_options'] ?? array();
+
+            if (!\is_array($predisOptions)) {
+                throw new InvalidArgumentException('Invalid connection option: "predis_options" provided but is not of the type "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 {
