Use RedisTagAwareAdapter when tags is true and adapter is Redis

l-vo · l-vo · commit 1a831ec3753b · 2020-04-27T10:57:10.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -18,6 +18,7 @@ CHANGELOG
  * Made `BrowserKitAssertionsTrait` report the original error message in case of a failure
  * Added ability for `config:dump-reference` and `debug:config` to dump and debug kernel container extension configuration.
  * Deprecated `session.attribute_bag` service and `session.flash_bag` service.
+ * Wire `RedisTagAwareAdapter` for pools usings tags and Redis adapter
 
 5.0.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -30,6 +30,7 @@
 use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Cache\Adapter\ChainAdapter;
+use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
 use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
 use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
@@ -1853,15 +1854,26 @@ private function registerCacheConfiguration(array $config, ContainerBuilder $con
                 if (true !== $pool['tags'] && ($config['pools'][$pool['tags']]['tags'] ?? false)) {
                     $pool['tags'] = '.'.$pool['tags'].'.inner';
                 }
-                $container->register($name, TagAwareAdapter::class)
-                    ->addArgument(new Reference('.'.$name.'.inner'))
-                    ->addArgument(true !== $pool['tags'] ? new Reference($pool['tags']) : null)
-                    ->setPublic($pool['public'])
-                ;
+
+                $isRedis = $definition instanceof ChildDefinition && 'cache.adapter.redis' === $definition->getParent();
+                if (true === $pool['tags'] && $isRedis) {
+                    $definition = new Definition(RedisTagAwareAdapter::class, [null, null, 0, null]);
+                    if (!isset($pool['provider']) || !$pool['provider']) {
+                        $pool['provider'] = 'cache.default_redis_provider';
+                    }
+                    $underlyingAdapterName = $name;
+                } else {
+                    $container->register($name, TagAwareAdapter::class)
+                        ->addArgument(new Reference('.'.$name.'.inner'))
+                        ->addArgument(true !== $pool['tags'] ? new Reference($pool['tags']) : null)
+                        ->setPublic($pool['public'])
+                    ;
+                    $underlyingAdapterName = '.'.$name.'.inner';
+                }
 
                 $pool['name'] = $name;
                 $pool['public'] = false;
-                $name = '.'.$name.'.inner';
+                $name = $underlyingAdapterName;
 
                 if (!\in_array($pool['name'], ['cache.app', 'cache.system'], true)) {
                     $container->registerAliasForArgument($pool['name'], TagAwareCacheInterface::class);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/cache.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/cache.php
@@ -32,6 +32,21 @@
                     'redis://foo' => 'cache.adapter.redis',
                 ],
             ],
+            'cache.tag' => [
+                'tags' => true,
+                'adapter' => 'cache.adapter.apcu',
+            ],
+            'cache.redis.foo' => [
+                'adapter' => 'cache.adapter.redis',
+            ],
+            'cache.redis.bar' => [
+                'tags' => true,
+                'adapter' => 'cache.adapter.redis',
+            ],
+            'cache.redis.baz' => [
+                'tags' => 'cache.adapter.redis',
+                'adapter' => 'cache.adapter.redis',
+            ],
         ],
     ],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/cache.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/cache.xml
@@ -17,6 +17,18 @@
                 <framework:adapter name="cache.adapter.filesystem" />
                 <framework:adapter name="cache.adapter.redis" provider="redis://foo" />
             </framework:pool>
+            <framework:pool name="cache.tag" tags="true">
+                <framework:adapter name="cache.adapter.apcu" />
+            </framework:pool>
+            <framework:pool name="cache.redis.foo">
+                <framework:adapter name="cache.adapter.redis" />
+            </framework:pool>
+            <framework:pool name="cache.redis.bar" tags="true">
+                <framework:adapter name="cache.adapter.redis" />
+            </framework:pool>
+            <framework:pool name="cache.redis.baz" tags="cache.adapter.redis">
+                <framework:adapter name="cache.adapter.redis" />
+            </framework:pool>
         </framework:cache>
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/cache.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/cache.yml
@@ -23,3 +23,14 @@ framework:
                     - cache.adapter.array
                     - cache.adapter.filesystem
                     - {name: cache.adapter.redis, provider: 'redis://foo'}
+            cache.tag:
+                tags: true
+                adapter: cache.adapter.apcu
+            cache.redis.foo:
+                adapter: cache.adapter.redis
+            cache.redis.bar:
+                tags: true
+                adapter: cache.adapter.redis
+            cache.redis.baz:
+                tags: cache.adapter.redis
+                adapter: cache.adapter.redis
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -26,6 +26,8 @@
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\Cache\Adapter\ProxyAdapter;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
+use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Symfony\Component\Cache\DependencyInjection\CachePoolPass;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -54,6 +56,7 @@
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
 use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
 use Symfony\Component\Workflow;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 abstract class FrameworkExtensionTest extends TestCase
 {
@@ -1282,6 +1285,28 @@ public function testCachePoolServices()
         $this->assertEquals($expected, $chain->getArguments());
     }
 
+    public function testCacheTagAwareAdapters(): void
+    {
+        $container = $this->createContainerFromFile('cache', [], true);
+
+        $data = [
+            'cacheFoo' => TagAwareAdapter::class,
+            'cacheTag' => TagAwareAdapter::class,
+            'cacheChain' => TagAwareAdapter::class,
+            'cacheRedisFoo' => TagAwareAdapter::class,
+            'cacheRedisBar' => RedisTagAwareAdapter::class,
+            'cacheRedisBaz' => TagAwareAdapter::class,
+        ];
+
+        foreach ($data as $varName => $expectedAdapter) {
+            $aliasForArgument = $container->getAlias(sprintf('%s $%s', TagAwareCacheInterface::class, $varName));
+            $this->assertNotNull($aliasForArgument);
+            $taggableDef = $container->getDefinition((string)$aliasForArgument);
+            $this->assertNotNull($taggableDef);
+            $this->assertSame($expectedAdapter, $taggableDef->getClass());
+        }
+    }
+
     public function testRemovesResourceCheckerConfigCacheFactoryArgumentOnlyIfNoDebug()
     {
         $container = $this->createContainer(['kernel.debug' => true]);
