Use compiler pass to deprecate class parameters

doctrine · Dec 15, 2023 · 5fa3808 · 5fa3808
1 parent b98e3bf
commit 5fa3808
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 34 deletions.
diff --git a/DependencyInjection/Compiler/DeprecateChangesClassParametersPass.php b/DependencyInjection/Compiler/DeprecateChangesClassParametersPass.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler;
+
+use Doctrine\Bundle\MongoDBBundle\CacheWarmer\HydratorCacheWarmer;
+use Doctrine\Bundle\MongoDBBundle\CacheWarmer\PersistentCollectionCacheWarmer;
+use Doctrine\Bundle\MongoDBBundle\CacheWarmer\ProxyCacheWarmer;
+use Doctrine\Bundle\MongoDBBundle\ManagerConfigurator;
+use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
+use Doctrine\ODM\MongoDB\Configuration;
+use Doctrine\ODM\MongoDB\DocumentManager;
+use MongoDB\Client;
+use Symfony\Bridge\Doctrine\ContainerAwareEventManager;
+use Symfony\Bridge\Doctrine\Security\User\EntityUserProvider;
+use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntityValidator;
+use Symfony\Bridge\Doctrine\Validator\DoctrineInitializer;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+use function trigger_deprecation;
+
+/** @internal */
+final class DeprecateChangesClassParametersPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        foreach (
+            [
+                'doctrine_mongodb.odm.connection.class' => Client::class,
+                'doctrine_mongodb.odm.configuration.class' => Configuration::class,
+                'doctrine_mongodb.odm.document_manager.class' => DocumentManager::class,
+                'doctrine_mongodb.odm.manager_configurator.class' => ManagerConfigurator::class,
+                'doctrine_mongodb.odm.event_manager.class' => ContainerAwareEventManager::class,
+                'doctrine_odm.mongodb.validator_initializer.class' => DoctrineInitializer::class,
+                'doctrine_odm.mongodb.validator.unique.class' => UniqueEntityValidator::class,
+                'doctrine_mongodb.odm.class' => ManagerRegistry::class,
+                'doctrine_mongodb.odm.security.user.provider.class' => EntityUserProvider::class,
+                'doctrine_mongodb.odm.proxy_cache_warmer.class' => ProxyCacheWarmer::class,
+                'doctrine_mongodb.odm.hydrator_cache_warmer.class' => HydratorCacheWarmer::class,
+                'doctrine_mongodb.odm.persistent_collection_cache_warmer.class' => PersistentCollectionCacheWarmer::class,
+            ] as $parameter => $class
+        ) {
+            if (! $container->hasParameter($parameter) || $container->getParameter($parameter) === $class) {
+                continue;
+            }
+
+            trigger_deprecation(
+                'doctrine/mongodb-odm-bundle',
+                '4.7',
+                '"%s" parameter is deprecated, use a compiler pass to update the service instead.',
+                $parameter,
+            );
+        }
+    }
+}
diff --git a/DependencyInjection/DoctrineMongoDBExtension.php b/DependencyInjection/DoctrineMongoDBExtension.php
@@ -55,7 +55,6 @@
 use function in_array;
 use function interface_exists;
 use function is_dir;
-use function method_exists;
 use function reset;
 use function sprintf;
 
@@ -159,8 +158,6 @@ public function load(array $configs, ContainerBuilder $container)
         $this->loadMessengerServices($container);
 
         $this->loadEntityValueResolverServices($container, $loader, $config);
-
-        $this->deprecateClassParameters($container);
     }
 
     /**
@@ -675,35 +672,4 @@ private static function getODMVersion(): string
 
         return self::$odmVersion;
     }
-
-    private function deprecateClassParameters(ContainerBuilder $container): void
-    {
-        if (! method_exists($container, 'deprecateParameter')) {
-            return;
-        }
-
-        foreach (
-            [
-                'doctrine_mongodb.odm.connection.class' => Client::class,
-                'doctrine_mongodb.odm.configuration.class' => MongoDBConfiguration::class,
-                'doctrine_mongodb.odm.document_manager.class' => DocumentManager::class,
-                'doctrine_mongodb.odm.manager_configurator.class' => ManagerConfigurator::class,
-                'doctrine_mongodb.odm.event_manager.class' => ContainerAwareEventManager::class,
-                'doctrine_odm.mongodb.validator_initializer.class' => DoctrineInitializer::class,
-                'doctrine_odm.mongodb.validator.unique.class' => UniqueEntityValidator::class,
-                'doctrine_mongodb.odm.class' => ManagerRegistry::class,
-                'doctrine_mongodb.odm.security.user.provider.class' => EntityUserProvider::class,
-                'doctrine_mongodb.odm.proxy_cache_warmer.class' => ProxyCacheWarmer::class,
-                'doctrine_mongodb.odm.hydrator_cache_warmer.class' => HydratorCacheWarmer::class,
-                'doctrine_mongodb.odm.persistent_collection_cache_warmer.class' => PersistentCollectionCacheWarmer::class,
-            ] as $parameter => $class
-        ) {
-            $container->deprecateParameter(
-                $parameter,
-                'doctrine/mongodb-odm-bundle',
-                '4.7',
-                '"%s" parameter is deprecated, you should use a compiler pass to update the service instead.',
-            );
-        }
-    }
 }
diff --git a/DoctrineMongoDBBundle.php b/DoctrineMongoDBBundle.php
@@ -7,6 +7,7 @@
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\CacheCompatibilityPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\CreateHydratorDirectoryPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\CreateProxyDirectoryPass;
+use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DeprecateChangesClassParametersPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\FixturesCompilerPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\ServiceRepositoryCompilerPass;
 use Doctrine\Bundle\MongoDBBundle\DependencyInjection\DoctrineMongoDBExtension;
@@ -43,6 +44,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new DoctrineValidationPass('mongodb'));
         $container->addCompilerPass(new ServiceRepositoryCompilerPass());
         $container->addCompilerPass(new FixturesCompilerPass());
+        $container->addCompilerPass(new DeprecateChangesClassParametersPass());
 
         if (! $container->hasExtension('security')) {
             return;

diff --git a/Tests/DependencyInjection/Compiler/DeprecateChangesClassParametersPassTest.php b/Tests/DependencyInjection/Compiler/DeprecateChangesClassParametersPassTest.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MongoDBBundle\Tests\DependencyInjection\Compiler;
+
+use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DeprecateChangesClassParametersPass;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+final class DeprecateChangesClassParametersPassTest extends TestCase
+{
+    use ExpectDeprecationTrait;
+
+    /** @group legacy */
+    public function testChangeParameterClass(): void
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('doctrine_mongodb.odm.connection.class', stdClass::class);
+
+        $container->addCompilerPass(new DeprecateChangesClassParametersPass());
+
+        $this->expectDeprecation('Since doctrine/mongodb-odm-bundle 4.7: "doctrine_mongodb.odm.connection.class" parameter is deprecated, use a compiler pass to update the service instead.');
+
+        $container->compile();
+    }
+}