[Cache] handle prefixed redis connections when clearing pools

nicolas-grekas · nicolas-grekas · commit 79e5ccb3a604 · 2021-06-23T19:19:48.000+02:00
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/AbstractRedisAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/AbstractRedisAdapterTest.php
@@ -24,7 +24,7 @@ abstract class AbstractRedisAdapterTest extends AdapterTestCase
 
     protected static $redis;
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
         return new RedisAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
     }
@@ -45,4 +45,18 @@ public static function tearDownAfterClass(): void
     {
         self::$redis = null;
     }
+
+    /**
+     * @runInSeparateProcess
+     */
+    public function testClearWithPrefix()
+    {
+        $cache = $this->createCachePool(0, __FUNCTION__);
+
+        $cache->save($cache->getItem('foo')->set('bar'));
+        $this->assertTrue($cache->hasItem('foo'));
+
+        $cache->clear();
+        $this->assertFalse($cache->hasItem('foo'));
+    }
 }
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PredisAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PredisAdapterTest.php
@@ -22,7 +22,7 @@ class PredisAdapterTest extends AbstractRedisAdapterTest
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
-        self::$redis = new \Predis\Client(['host' => getenv('REDIS_HOST')]);
+        self::$redis = new \Predis\Client(['host' => getenv('REDIS_HOST')], ['prefix' => 'prefix_']);
     }
 
     public function testCreateConnection()
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PredisClusterAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PredisClusterAdapterTest.php
@@ -19,7 +19,7 @@ class PredisClusterAdapterTest extends AbstractRedisAdapterTest
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
-        self::$redis = new \Predis\Client([['host' => getenv('REDIS_HOST')]]);
+        self::$redis = new \Predis\Client([['host' => getenv('REDIS_HOST')]], ['prefix' => 'prefix_']);
     }
 
     public static function tearDownAfterClass(): void
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PredisRedisClusterAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PredisRedisClusterAdapterTest.php
@@ -24,7 +24,7 @@ public static function setUpBeforeClass(): void
             self::markTestSkipped('REDIS_CLUSTER_HOSTS env var is not defined.');
         }
 
-        self::$redis = RedisAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['class' => \Predis\Client::class, 'redis_cluster' => true]);
+        self::$redis = RedisAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['class' => \Predis\Client::class, 'redis_cluster' => true, 'prefix' => 'prefix_']);
     }
 
     public static function tearDownAfterClass(): void
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PredisTagAwareAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PredisTagAwareAdapterTest.php
@@ -27,7 +27,7 @@ protected function setUp(): void
         $this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
         $this->assertInstanceOf(\Predis\Client::class, self::$redis);
         $adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PredisTagAwareClusterAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PredisTagAwareClusterAdapterTest.php
@@ -27,7 +27,7 @@ protected function setUp(): void
         $this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
         $this->assertInstanceOf(\Predis\Client::class, self::$redis);
         $adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterSentinelTest.php
@@ -32,7 +32,7 @@ public static function setUpBeforeClass(): void
             self::markTestSkipped('REDIS_SENTINEL_SERVICE env var is not defined.');
         }
 
-        self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => $service]);
+        self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => $service, 'prefix' => 'prefix_']);
     }
 
     public function testInvalidDSNHasBothClusterAndSentinel()
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisAdapterTest.php
@@ -28,9 +28,13 @@ public static function setUpBeforeClass(): void
         self::$redis = AbstractAdapter::createConnection('redis://'.getenv('REDIS_HOST'), ['lazy' => true]);
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
-        $adapter = parent::createCachePool($defaultLifetime);
+        if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {
+            self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);
+        }
+
+        $adapter = parent::createCachePool($defaultLifetime, $testMethod);
         $this->assertInstanceOf(RedisProxy::class, self::$redis);
 
         return $adapter;
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisArrayAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisArrayAdapterTest.php
@@ -23,5 +23,6 @@ public static function setUpBeforeClass(): void
             self::markTestSkipped('The RedisArray class is required.');
         }
         self::$redis = new \RedisArray([getenv('REDIS_HOST')], ['lazy_connect' => true]);
+        self::$redis->setOption(\Redis::OPT_PREFIX, 'prefix_');
     }
 }
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisClusterAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisClusterAdapterTest.php
@@ -32,10 +32,15 @@ public static function setUpBeforeClass(): void
         }
 
         self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['lazy' => true, 'redis_cluster' => true]);
+        self::$redis->setOption(\Redis::OPT_PREFIX, 'prefix_');
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
+        if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {
+            self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);
+        }
+
         $this->assertInstanceOf(RedisClusterProxy::class, self::$redis);
         $adapter = new RedisAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
 
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareAdapterTest.php
@@ -28,8 +28,12 @@ protected function setUp(): void
         $this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
+        if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {
+            self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);
+        }
+
         $this->assertInstanceOf(RedisProxy::class, self::$redis);
         $adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
 
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareArrayAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareArrayAdapterTest.php
@@ -27,8 +27,12 @@ protected function setUp(): void
         $this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
+        if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {
+            self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);
+        }
+
         $this->assertInstanceOf(\RedisArray::class, self::$redis);
         $adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
 
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareClusterAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/RedisTagAwareClusterAdapterTest.php
@@ -28,8 +28,12 @@ protected function setUp(): void
         $this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';
     }
 
-    public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface
+    public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface
     {
+        if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {
+            self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);
+        }
+
         $this->assertInstanceOf(RedisClusterProxy::class, self::$redis);
         $adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);
 
diff --git a/src/Symfony/Component/Cache/Traits/RedisClusterNodeProxy.php b/src/Symfony/Component/Cache/Traits/RedisClusterNodeProxy.php
@@ -45,4 +45,9 @@ public function scan(&$iIterator, $strPattern = null, $iCount = null)
     {
         return $this->redis->scan($iIterator, $this->host, $strPattern, $iCount);
     }
+
+    public function getOption($name)
+    {
+        return $this->redis->getOption($name);
+    }
 }
diff --git a/src/Symfony/Component/Cache/Traits/RedisTrait.php b/src/Symfony/Component/Cache/Traits/RedisTrait.php
@@ -362,6 +362,11 @@ protected function doHave($id)
      */
     protected function doClear($namespace)
     {
+        if ($this->redis instanceof \Predis\ClientInterface) {
+            $prefix = $this->redis->getOptions()->prefix ? $this->redis->getOptions()->prefix->getPrefix() : '';
+            $prefixLen = \strlen($prefix);
+        }
+
         $cleared = true;
         $hosts = $this->getHosts();
         $host = reset($hosts);
@@ -379,7 +384,11 @@ protected function doClear($namespace)
             $info = $host->info('Server');
             $info = $info['Server'] ?? $info;
 
-            $pattern = $namespace.'*';
+            if (!$host instanceof \Predis\ClientInterface) {
+                $prefix = \defined('Redis::SCAN_PREFIX') && (\Redis::SCAN_PREFIX & $host->getOption(\Redis::OPT_SCAN)) ? '' : $host->getOption(\Redis::OPT_PREFIX);
+                $prefixLen = \strlen($host->getOption(\Redis::OPT_PREFIX) ?? '');
+            }
+            $pattern = $prefix.$namespace.'*';
 
             if (!version_compare($info['redis_version'], '2.8', '>=')) {
                 // As documented in Redis documentation (http://redis.io/commands/keys) using KEYS
@@ -398,6 +407,11 @@ protected function doClear($namespace)
                     $keys = $keys[1];
                 }
                 if ($keys) {
+                    if ($prefixLen) {
+                        foreach ($keys as $i => $key) {
+                            $keys[$i] = substr($key, $prefixLen);
+                        }
+                    }
                     $this->doDelete($keys);
                 }
             } while ($cursor = (int) $cursor);

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ abstract class AbstractRedisAdapterTest extends AdapterTestCase`
`24`	`24`
`25`	`25`	`protected static $redis;`
`26`	`26`
`27`		`- public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface`
	`27`	`+ public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface`
`28`	`28`	`{`
`29`	`29`	`return new RedisAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);`
`30`	`30`	`}`
`@@ -45,4 +45,18 @@ public static function tearDownAfterClass(): void`
`45`	`45`	`{`
`46`	`46`	`self::$redis = null;`
`47`	`47`	`}`
	`48`	`+`
	`49`	`+ /**`
	`50`	`+ * @runInSeparateProcess`
	`51`	`+ */`
	`52`	`+ public function testClearWithPrefix()`
	`53`	`+ {`
	`54`	`+ $cache = $this->createCachePool(0, __FUNCTION__);`
	`55`	`+`
	`56`	`+ $cache->save($cache->getItem('foo')->set('bar'));`
	`57`	`+ $this->assertTrue($cache->hasItem('foo'));`
	`58`	`+`
	`59`	`+ $cache->clear();`
	`60`	`+ $this->assertFalse($cache->hasItem('foo'));`
	`61`	`+ }`
`48`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class PredisAdapterTest extends AbstractRedisAdapterTest`
`22`	`22`	`public static function setUpBeforeClass(): void`
`23`	`23`	`{`
`24`	`24`	`parent::setUpBeforeClass();`
`25`		`- self::$redis = new \Predis\Client(['host' => getenv('REDIS_HOST')]);`
	`25`	`+ self::$redis = new \Predis\Client(['host' => getenv('REDIS_HOST')], ['prefix' => 'prefix_']);`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`public function testCreateConnection()`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class PredisClusterAdapterTest extends AbstractRedisAdapterTest`
`19`	`19`	`public static function setUpBeforeClass(): void`
`20`	`20`	`{`
`21`	`21`	`parent::setUpBeforeClass();`
`22`		`- self::$redis = new \Predis\Client([['host' => getenv('REDIS_HOST')]]);`
	`22`	`+ self::$redis = new \Predis\Client([['host' => getenv('REDIS_HOST')]], ['prefix' => 'prefix_']);`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public static function tearDownAfterClass(): void`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public static function setUpBeforeClass(): void`
`24`	`24`	`self::markTestSkipped('REDIS_CLUSTER_HOSTS env var is not defined.');`
`25`	`25`	`}`
`26`	`26`
`27`		`- self::$redis = RedisAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['class' => \Predis\Client::class, 'redis_cluster' => true]);`
	`27`	`+ self::$redis = RedisAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['class' => \Predis\Client::class, 'redis_cluster' => true, 'prefix' => 'prefix_']);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public static function tearDownAfterClass(): void`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ protected function setUp(): void`
`27`	`27`	`$this->skippedTests['testTagItemExpiry'] = 'Testing expiration slows down the test suite';`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface`
	`30`	`+ public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface`
`31`	`31`	`{`
`32`	`32`	`$this->assertInstanceOf(\Predis\Client::class, self::$redis);`
`33`	`33`	`$adapter = new RedisTagAwareAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public static function setUpBeforeClass(): void`
`32`	`32`	`self::markTestSkipped('REDIS_SENTINEL_SERVICE env var is not defined.');`
`33`	`33`	`}`
`34`	`34`
`35`		`- self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => $service]);`
	`35`	`+ self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['redis_sentinel' => $service, 'prefix' => 'prefix_']);`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public function testInvalidDSNHasBothClusterAndSentinel()`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,13 @@ public static function setUpBeforeClass(): void`
`28`	`28`	`self::$redis = AbstractAdapter::createConnection('redis://'.getenv('REDIS_HOST'), ['lazy' => true]);`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface`
	`31`	`+ public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface`
`32`	`32`	`{`
`33`		`- $adapter = parent::createCachePool($defaultLifetime);`
	`33`	`+ if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {`
	`34`	`+ self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ $adapter = parent::createCachePool($defaultLifetime, $testMethod);`
`34`	`38`	`$this->assertInstanceOf(RedisProxy::class, self::$redis);`
`35`	`39`
`36`	`40`	`return $adapter;`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,6 @@ public static function setUpBeforeClass(): void`
`23`	`23`	`self::markTestSkipped('The RedisArray class is required.');`
`24`	`24`	`}`
`25`	`25`	`self::$redis = new \RedisArray([getenv('REDIS_HOST')], ['lazy_connect' => true]);`
	`26`	`+ self::$redis->setOption(\Redis::OPT_PREFIX, 'prefix_');`
`26`	`27`	`}`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,15 @@ public static function setUpBeforeClass(): void`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`self::$redis = AbstractAdapter::createConnection('redis:?host['.str_replace(' ', ']&host[', $hosts).']', ['lazy' => true, 'redis_cluster' => true]);`
	`35`	`+ self::$redis->setOption(\Redis::OPT_PREFIX, 'prefix_');`
`35`	`36`	`}`
`36`	`37`
`37`		`- public function createCachePool(int $defaultLifetime = 0): CacheItemPoolInterface`
	`38`	`+ public function createCachePool(int $defaultLifetime = 0, string $testMethod = null): CacheItemPoolInterface`
`38`	`39`	`{`
	`40`	`+ if ('testClearWithPrefix' === $testMethod && \defined('Redis::SCAN_PREFIX')) {`
	`41`	`+ self::$redis->setOption(\Redis::OPT_SCAN, \Redis::SCAN_PREFIX);`
	`42`	`+ }`
	`43`	`+`
`39`	`44`	`$this->assertInstanceOf(RedisClusterProxy::class, self::$redis);`
`40`	`45`	`$adapter = new RedisAdapter(self::$redis, str_replace('\\', '.', __CLASS__), $defaultLifetime);`
`41`	`46`