[Cache] Deprecate support for Doctrine Cache

Signed-off-by: Alexander M. Turek <[email protected]>

Author: derrabus

CHANGELOG.md

@@ -9,6 +9,7 @@ CHANGELOG
  * Deprecate the public `profiler` service to private
  * Deprecate `get()`, `has()`, `getDoctrine()`, and `dispatchMessage()` in `AbstractController`, use method/constructor injection instead
  * Add `MicroKernelTrait::getBundlesPath` method to get bundles config path
+ * Deprecate the `cache.adapter.doctrine` service
 
 5.3
 ---

Resources/config/cache.php

@@ -93,8 +93,10 @@
             ->call('setLogger', [service('logger')->ignoreOnInvalid()])
             ->tag('cache.pool', ['clearer' => 'cache.default_clearer', 'reset' => 'reset'])
             ->tag('monolog.logger', ['channel' => 'cache'])
+        ;
 
-        ->set('cache.adapter.doctrine', DoctrineAdapter::class)
+    if (class_exists(DoctrineAdapter::class)) {
+        $container->services()->set('cache.adapter.doctrine', DoctrineAdapter::class)
             ->abstract()
             ->args([
                 abstract_arg('Doctrine provider service'),
@@ -108,7 +110,11 @@
                 'reset' => 'reset',
             ])
             ->tag('monolog.logger', ['channel' => 'cache'])
+            ->deprecate('symfony/framework-bundle', '5.4', 'The abstract service "%service_id%" is deprecated.')
+        ;
+    }
 
+    $container->services()
         ->set('cache.adapter.filesystem', FilesystemAdapter::class)
             ->abstract()
             ->args([

Tests/DependencyInjection/Fixtures/php/cache.php

@@ -7,11 +7,6 @@
                 'adapter' => 'cache.adapter.apcu',
                 'default_lifetime' => 30,
             ],
-            'cache.bar' => [
-                'adapter' => 'cache.adapter.doctrine',
-                'default_lifetime' => 5,
-                'provider' => 'app.doctrine_cache_provider',
-            ],
             'cache.baz' => [
                 'adapter' => 'cache.adapter.filesystem',
                 'default_lifetime' => 7,

Tests/DependencyInjection/Fixtures/php/doctrine_cache.php

@@ -0,0 +1,13 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'cache' => [
+        'pools' => [
+            'cache.bar' => [
+                'adapter' => 'cache.adapter.doctrine',
+                'default_lifetime' => 5,
+                'provider' => 'app.doctrine_cache_provider',
+            ],
+        ],
+    ],
+]);

Tests/DependencyInjection/Fixtures/xml/cache.xml

@@ -8,7 +8,6 @@
     <framework:config>
         <framework:cache>
             <framework:pool name="cache.foo" adapter="cache.adapter.apcu" default-lifetime="30" />
-            <framework:pool name="cache.bar" adapter="cache.adapter.doctrine" default-lifetime="5" provider="app.doctrine_cache_provider" />
             <framework:pool name="cache.baz" adapter="cache.adapter.filesystem" default-lifetime="7" />
             <framework:pool name="cache.foobar" adapter="cache.adapter.psr6" default-lifetime="10" provider="app.cache_pool" />
             <framework:pool name="cache.def" default-lifetime="PT11S" />

Tests/DependencyInjection/Fixtures/xml/doctrine_cache.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config>
+        <framework:cache>
+            <framework:pool name="cache.bar" adapter="cache.adapter.doctrine" default-lifetime="5" provider="app.doctrine_cache_provider" />
+        </framework:cache>
+    </framework:config>
+</container>

Tests/DependencyInjection/Fixtures/yml/cache.yml

@@ -4,10 +4,6 @@ framework:
             cache.foo:
                 adapter: cache.adapter.apcu
                 default_lifetime: 30
-            cache.bar:
-                adapter: cache.adapter.doctrine
-                default_lifetime: 5
-                provider: app.doctrine_cache_provider
             cache.baz:
                 adapter: cache.adapter.filesystem
                 default_lifetime: 7

Tests/DependencyInjection/Fixtures/yml/doctrine_cache.yml

@@ -0,0 +1,7 @@
+framework:
+    cache:
+        pools:
+            cache.bar:
+                adapter: cache.adapter.doctrine
+                default_lifetime: 5
+                provider: app.doctrine_cache_provider

Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -1519,7 +1519,6 @@ public function testCachePoolServices()
         $container->compile();
 
         $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.foo', 'cache.adapter.apcu', 30);
-        $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.bar', 'cache.adapter.doctrine', 5);
         $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.baz', 'cache.adapter.filesystem', 7);
         $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.foobar', 'cache.adapter.psr6', 10);
         $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.def', 'cache.app', 'PT11S');
@@ -1561,6 +1560,23 @@ public function testCachePoolServices()
         }
     }
 
+    /**
+     * @group legacy
+     */
+    public function testDoctrineCache()
+    {
+        if (!class_exists(DoctrineAdapter::class)) {
+            self::markTestSkipped('This test requires symfony/cache 5.4 or lower.');
+        }
+
+        $container = $this->createContainerFromFile('doctrine_cache', [], true, false);
+        $container->setParameter('cache.prefix.seed', 'test');
+        $container->addCompilerPass(new CachePoolPass());
+        $container->compile();
+
+        $this->assertCachePoolServiceDefinitionIsCreated($container, 'cache.bar', 'cache.adapter.doctrine', 5);
+    }
+
     public function testRedisTagAwareAdapter()
     {
         $container = $this->createContainerFromFile('cache', [], true);