Fix a deprecation message about PdoCacheAdapterDoctrineSchemaSubscriber

[javiereguiluz]

This tries to fix the following deprecation:

  1x: Since symfony/doctrine-bridge 5.4: The "Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber" class is deprecated, use "Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaSubscriber" instead.
    1x in AddUserCommandTest::testCreateUserNonInteractive from App\Tests\Command

which we found when upgrading Symfony Demo app to the upcoming Symfony 5.4. See symfony/demo#1268 (comment)

[ostrolucky]

Hmm according CI failing it looks like this needs more work

[javiereguiluz]

Yes. To be honest, I don't know what I'm doing here ... so I need help to solve this. Thanks!

[stof]

Well, what you need to do is replacing the doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber by a doctrine.orm.listeners.dbal_cache_adapter_doctrine_schema_subscriber service using the new class.

And then, if the new class exists, removing the doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber. Otherwise, remove the new service, and remove the old service if none of the class exist.

[jt2k]

I was looking to see if anyone was addressing this deprecation yet, and found this issue. @javiereguiluz, are you planning to continue working on this? If not, I'd be happy to work on a new PR.

[ostrolucky]

Yeah something like this needs to be done, but that's still incomplete, as CacheSchemaSubscriberPass needs to be updated too.

Index: Tests/CacheSchemaSubscriberTest.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/Tests/CacheSchemaSubscriberTest.php b/Tests/CacheSchemaSubscriberTest.php
--- a/Tests/CacheSchemaSubscriberTest.php	
+++ b/Tests/CacheSchemaSubscriberTest.php	
@@ -5,7 +5,7 @@
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\CacheSchemaSubscriberPass;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\DoctrineExtension;
 use Doctrine\ORM\EntityManagerInterface;
-use Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber;
+use Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaSubscriber;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\FrameworkExtension;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
@@ -21,8 +21,8 @@
 {
     public function testSchemaSubscriberWiring(): void
     {
-        if (! class_exists(PdoCacheAdapterDoctrineSchemaSubscriber::class)) {
-            $this->markTestSkipped('This test requires Symfony 5.1 or higher');
+        if (! class_exists(DoctrineDbalCacheAdapterSchemaSubscriber::class)) {
+            $this->markTestSkipped('This test requires Symfony 5.4 or higher');
         }
 
         if (! interface_exists(EntityManagerInterface::class)) {
@@ -51,7 +51,7 @@
             'framework' => [
                 'cache' => [
                     'pools' => [
-                        'my_cache_adapter' => ['adapter' => 'cache.adapter.pdo'],
+                        'my_cache_adapter' => ['adapter' => 'cache.adapter.dbal'],
                     ],
                 ],
             ],
Index: Resources/config/orm.xml
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/Resources/config/orm.xml b/Resources/config/orm.xml
--- a/Resources/config/orm.xml	
+++ b/Resources/config/orm.xml	
@@ -134,7 +134,7 @@
 
         <!-- listeners -->
         <service id="doctrine.orm.listeners.resolve_target_entity" class="%doctrine.orm.listeners.resolve_target_entity.class%" public="false" />
-        <service id="doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber" class="Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber">
+        <service id="doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber" class="Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaSubscriber">
             <argument type="collection" /> <!-- PdoAdapter instances -->
             <tag name="doctrine.event_subscriber" />
         </service>
Index: DependencyInjection/DoctrineExtension.php
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
--- a/DependencyInjection/DoctrineExtension.php	
+++ b/DependencyInjection/DoctrineExtension.php	
@@ -27,6 +27,7 @@
 use Symfony\Bridge\Doctrine\Messenger\DoctrineClearEntityManagerWorkerSubscriber;
 use Symfony\Bridge\Doctrine\Messenger\DoctrineTransactionMiddleware;
 use Symfony\Bridge\Doctrine\PropertyInfo\DoctrineExtractor;
+use Symfony\Bridge\Doctrine\SchemaListener\DoctrineDbalCacheAdapterSchemaSubscriber;
 use Symfony\Bridge\Doctrine\SchemaListener\MessengerTransportDoctrineSchemaSubscriber;
 use Symfony\Bridge\Doctrine\SchemaListener\PdoCacheAdapterDoctrineSchemaSubscriber;
 use Symfony\Bridge\Doctrine\SchemaListener\RememberMeTokenProviderDoctrineSchemaSubscriber;
@@ -435,9 +436,16 @@
             $container->getDefinition('form.type.entity')->addTag('kernel.reset', ['method' => 'reset']);
         }
 
-        // available in Symfony 5.1 and higher
-        if (! class_exists(PdoCacheAdapterDoctrineSchemaSubscriber::class)) {
-            $container->removeDefinition('doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber');
+
+        // available in Symfony 5.4 and higher
+        if (! class_exists(DoctrineDbalCacheAdapterSchemaSubscriber::class)) {
+            $schemaSubscriberId = 'doctrine.orm.listeners.pdo_cache_adapter_doctrine_schema_subscriber';
+            if (class_exists(PdoCacheAdapterDoctrineSchemaSubscriber::class)) {
+                // available in Symfony 5.1 and higher
+                $container->getDefinition($schemaSubscriberId)->setClass(PdoCacheAdapterDoctrineSchemaSubscriber::class);
+            } else {
+                $container->removeDefinition($schemaSubscriberId);
+            }
         }
 
         // available in Symfony 5.3 and higher

@jt2k would be great if you finished this!

[GromNaN]

Thank you @javiereguiluz spotting this issue. I missed a major part during the split between PdoAdapter and DoctrineDbalAdapter.
Here is an alternative to this PR: #1421

[jt2k]

@GromNaN Thanks you! I started in on this last weekend but got tripped up with the corresponding changes that needed to happen in the FrameworkBundle.

[javiereguiluz]

@GromNaN thanks for properly fixing this issue 🙏