Merge pull request #364 from doctrine/manager-loader

Add manager loader support introduced in migrations 3.1 (dev)

Author: goetas

DependencyInjection/CompilerPass/ConfigureDependencyFactoryPass.php

@@ -17,27 +17,41 @@ class ConfigureDependencyFactoryPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
-        $preferredEm  = $container->getParameter('doctrine.migrations.preferred_em');
         $diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
 
+        $preferredEm = $container->getParameter('doctrine.migrations.preferred_em');
+        if ($container->has('doctrine')) {
+            $loaderDefinition = $container->getDefinition('doctrine.migrations.registry_loader');
+            $loaderDefinition->setArgument(0, new Reference('doctrine'));
+            if ($preferredEm !== null) {
+                $loaderDefinition->setArgument(1, $preferredEm);
+            }
+
+            $diDefinition->setFactory([DependencyFactory::class, 'fromEntityManager']);
+            $diDefinition->setArgument(1, new Reference('doctrine.migrations.registry_loader'));
+
+            return;
+        }
+
         assert(is_string($preferredEm) || $preferredEm === null);
         $emID = sprintf('doctrine.orm.%s_entity_manager', $preferredEm ?? 'default');
-
         if ($container->has($emID)) {
             $container->getDefinition('doctrine.migrations.em_loader')
                 ->setArgument(0, new Reference($emID));
 
             $diDefinition->setFactory([DependencyFactory::class, 'fromEntityManager']);
             $diDefinition->setArgument(1, new Reference('doctrine.migrations.em_loader'));
-        } else {
-            $preferredConnection = $container->getParameter('doctrine.migrations.preferred_connection');
+
+            return;
+        }
+
+        $preferredConnection = $container->getParameter('doctrine.migrations.preferred_connection');
             assert(is_string($preferredConnection) || $preferredConnection === null);
             $connectionId = sprintf('doctrine.dbal.%s_connection', $preferredConnection ?? 'default');
-            $container->getDefinition('doctrine.migrations.connection_loader')
-                ->setArgument(0, new Reference($connectionId));
+        $container->getDefinition('doctrine.migrations.connection_loader')
+            ->setArgument(0, new Reference($connectionId));
 
-            $diDefinition->setFactory([DependencyFactory::class, 'fromConnection']);
-            $diDefinition->setArgument(1, new Reference('doctrine.migrations.connection_loader'));
-        }
+        $diDefinition->setFactory([DependencyFactory::class, 'fromConnection']);
+        $diDefinition->setArgument(1, new Reference('doctrine.migrations.connection_loader'));
     }
 }

Resources/config/services.xml

@@ -25,6 +25,11 @@
 
         </service>
 
+        <service id="doctrine.migrations.registry_loader" class="Doctrine\Migrations\Configuration\EntityManager\ManagerRegistryEntityManager" public="false">
+            <factory class="Doctrine\Migrations\Configuration\EntityManager\ManagerRegistryEntityManager" method="withSimpleDefault"/>
+            <argument type="service" id="doctrine"/>
+        </service>
+
         <service id="doctrine.migrations.configuration" class="Doctrine\Migrations\Configuration\Configuration" public="false">
         </service>
 

Tests/DependencyInjection/DoctrineMigrationsExtensionTest.php

@@ -17,6 +17,7 @@
 use Doctrine\Migrations\Version\Comparator;
 use Doctrine\Migrations\Version\Version;
 use Doctrine\ORM\EntityManager;
+use Doctrine\Persistence\ManagerRegistry;
 use Exception;
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
@@ -300,6 +301,68 @@ public function testPrefersEntityManagerOverConnection(): void
         self::assertSame($em, $di->getEntityManager());
     }
 
+    /**
+     * @return array<array{string|null}>
+     */
+    public function getEmNames(): array
+    {
+        return [
+            [null],
+            ['custom'],
+        ];
+    }
+
+    /**
+     * @dataProvider getEmNames
+     */
+    public function testPrefersManagerRegistry(?string $emName): void
+    {
+        $config    = ['em' => $emName];
+        $container = $this->getContainer($config);
+
+        $em           = $this->createMock(EntityManager::class);
+        $registryMock = $this->createMock(ManagerRegistry::class);
+
+        $registryMock->expects(self::once())
+            ->method('getManager')
+            ->with($emName)
+            ->willReturn($em);
+
+        $container->set('doctrine', $registryMock);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+
+        self::assertInstanceOf(DependencyFactory::class, $di);
+        self::assertSame($em, $di->getEntityManager());
+    }
+
+    public function testManagerRegistryThrowsExceptionOnUnknownEm(): void
+    {
+        $config    = ['em' => 'foo'];
+        $container = $this->getContainer($config);
+
+        $em           = $this->createMock(EntityManager::class);
+        $registryMock = $this->createMock(ManagerRegistry::class);
+
+        $registryMock->expects(self::once())
+            ->method('getManager')
+            ->with('foo')
+            ->willThrowException(new InvalidArgumentException());
+
+        $container->set('doctrine', $registryMock);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+
+        self::assertInstanceOf(DependencyFactory::class, $di);
+
+        $this->expectException(InvalidArgumentException::class);
+        self::assertSame($em, $di->getEntityManager());
+    }
+
     public function testCustomEntityManager(): void
     {
         $config    = [

composer.json

@@ -23,7 +23,7 @@
         "php": "^7.2|^8.0",
         "symfony/framework-bundle": "~3.4|~4.0|~5.0",
         "doctrine/doctrine-bundle": "~1.0|~2.0",
-        "doctrine/migrations": "^3.0.3"
+        "doctrine/migrations": "^3.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.0|^8.0|^9.0",
@@ -32,7 +32,8 @@
         "phpstan/phpstan-deprecation-rules": "^0.12",
         "phpstan/phpstan-phpunit": "^0.12",
         "phpstan/phpstan-strict-rules": "^0.12",
-        "doctrine/orm": "^2.6"
+        "doctrine/orm": "^2.6",
+        "doctrine/persistence": "^1.3||^2.0"
     },
     "autoload": {
         "psr-4": { "Doctrine\\Bundle\\MigrationsBundle\\": "" },