Merge pull request #368 from doctrine/container-aware-migration-factory

Provide container aware migration factory as default

Author: goetas

.github/workflows/continuous-integration.yml

@@ -25,13 +25,12 @@ jobs:
           - "7.2"
           - "7.3"
           - "7.4"
+          - "8.0"
         deps:
           - "normal"
         include:
           - deps: "low"
             php-version: "7.2"
-          - deps: "dev"
-            php-version: "8.0"
 
     steps:
       - name: "Checkout"

DependencyInjection/CompilerPass/ConfigureDependencyFactoryPass.php

@@ -9,6 +9,8 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
+use function assert;
+use function is_string;
 use function sprintf;
 
 class ConfigureDependencyFactoryPass implements CompilerPassInterface
@@ -18,6 +20,7 @@ public function process(ContainerBuilder $container): void
         $preferredEm  = $container->getParameter('doctrine.migrations.preferred_em');
         $diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
 
+        assert(is_string($preferredEm) || $preferredEm === null);
         $emID = sprintf('doctrine.orm.%s_entity_manager', $preferredEm ?? 'default');
 
         if ($container->has($emID)) {
@@ -28,7 +31,8 @@ public function process(ContainerBuilder $container): void
             $diDefinition->setArgument(1, new Reference('doctrine.migrations.em_loader'));
         } else {
             $preferredConnection = $container->getParameter('doctrine.migrations.preferred_connection');
-            $connectionId        = sprintf('doctrine.dbal.%s_connection', $preferredConnection ?? 'default');
+            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));
 

DependencyInjection/Configuration.php

@@ -59,10 +59,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->useAttributeAsKey('service')
                     ->defaultValue([])
                     ->validate()
-                        ->ifTrue(static function ($v) {
+                        ->ifTrue(static function ($v): bool {
                             return count(array_filter(array_keys($v), static function (string $doctrineService): bool {
                                 return strpos($doctrineService, 'Doctrine\Migrations\\') !== 0;
-                            }));
+                            })) !== 0;
                         })
                         ->thenInvalid('Valid services for the DoctrineMigrationsBundle must be in the "Doctrine\Migrations" namespace.')
                     ->end()
@@ -74,10 +74,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->useAttributeAsKey('factory')
                     ->defaultValue([])
                     ->validate()
-                        ->ifTrue(static function ($v) {
+                        ->ifTrue(static function ($v): bool {
                             return count(array_filter(array_keys($v), static function (string $doctrineService): bool {
                                 return strpos($doctrineService, 'Doctrine\Migrations\\') !== 0;
-                            }));
+                            })) !== 0;
                         })
                         ->thenInvalid('Valid callables for the DoctrineMigrationsBundle must be in the "Doctrine\Migrations" namespace.')
                     ->end()

DependencyInjection/DoctrineMigrationsExtension.php

@@ -6,6 +6,7 @@
 
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
+use Doctrine\Migrations\Version\MigrationFactory;
 use InvalidArgumentException;
 use RuntimeException;
 use Symfony\Component\Config\FileLocator;
@@ -17,8 +18,10 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 use function array_keys;
+use function assert;
 use function explode;
 use function implode;
+use function is_array;
 use function sprintf;
 use function strlen;
 use function substr;
@@ -70,6 +73,10 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
 
+        if (! isset($config['services'][MigrationFactory::class])) {
+            $config['services'][MigrationFactory::class] = 'doctrine.migrations.migrations_factory';
+        }
+
         foreach ($config['services'] as $doctrineId => $symfonyId) {
             $diDefinition->addMethodCall('setDefinition', [$doctrineId, new ServiceClosureArgument(new Reference($symfonyId))]);
         }
@@ -136,6 +143,8 @@ private function getBundlePath(string $bundleName, ContainerBuilder $container):
     {
         $bundleMetadata = $container->getParameter('kernel.bundles_metadata');
 
+        assert(is_array($bundleMetadata));
+
         if (! isset($bundleMetadata[$bundleName])) {
             throw new RuntimeException(sprintf(
                 'The bundle "%s" has not been registered, available bundles: %s',

MigrationsFactory/ContainerAwareMigrationFactory.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\MigrationsFactory;
+
+use Doctrine\Migrations\AbstractMigration;
+use Doctrine\Migrations\Version\MigrationFactory;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class ContainerAwareMigrationFactory implements MigrationFactory
+{
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    /**
+     * @var MigrationFactory
+     */
+    private $migrationFactory;
+
+    public function __construct(MigrationFactory $migrationFactory, ContainerInterface $container)
+    {
+        $this->container = $container;
+        $this->migrationFactory = $migrationFactory;
+    }
+
+    public function createVersion(string $migrationClassName): AbstractMigration
+    {
+        $migration = $this->migrationFactory->createVersion($migrationClassName);
+
+        if ($migration instanceof ContainerAwareInterface) {
+            $migration->setContainer($this->container);
+        }
+
+        return $migration;
+    }
+}

Resources/config/services.xml

@@ -28,6 +28,18 @@
         <service id="doctrine.migrations.configuration" class="Doctrine\Migrations\Configuration\Configuration" public="false">
         </service>
 
+        <service id="doctrine.migrations.migrations_factory" class="Doctrine\Migrations\Version\MigrationFactory">
+            <factory service="doctrine.migrations.dependency_factory" method="getMigrationFactory"/>
+        </service>
+
+        <service id="doctrine.migrations.container_aware_migrations_factory"
+                 class="Doctrine\Bundle\MigrationsBundle\MigrationsFactory\ContainerAwareMigrationFactory"
+                 decorates="doctrine.migrations.migrations_factory"
+        >
+            <argument id="doctrine.migrations.container_aware_migrations_factory.inner" type="service"/>
+            <argument id="service_container" type="service"/>
+        </service>
+
         <service id="doctrine_migrations.diff_command" class="Doctrine\Migrations\Tools\Console\Command\DiffCommand">
 
             <argument type="service" id="doctrine.migrations.dependency_factory"/>

Resources/doc/index.rst

@@ -290,6 +290,13 @@ Here is an example on how to inject the service container into your migrations:
     }
 
 
+.. tip::
+
+    If your migration class implements the interface ``Symfony\Component\DependencyInjection\ContainerAwareInterface``
+    this bundle will automatically inject the default symfony container into your migration class
+    (this because the ``MigrationFactoryDecorator`` shown in this example is the default migration factory used by this bundle).
+
+
 Generating Migrations Automatically
 -----------------------------------
 

Tests/DependencyInjection/DoctrineMigrationsExtensionTest.php

@@ -7,6 +7,7 @@
 use Doctrine\Bundle\MigrationsBundle\DependencyInjection\DoctrineMigrationsExtension;
 use Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle;
 use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\CustomEntityManager;
+use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\Migrations\Migration001;
 use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\TestBundle\TestBundle;
 use Doctrine\DBAL\Connection;
 use Doctrine\Migrations\Configuration\Configuration;
@@ -179,6 +180,27 @@ public function compare(Version $a, Version $b): int
         self::assertSame($sorter, $di->getVersionComparator());
     }
 
+    public function testContainerAwareMigrations(): void
+    {
+        $config    = [
+            'migrations_paths' => ['DoctrineMigrationsTest' => 'a'],
+        ];
+        $container = $this->getContainer($config);
+
+        $conn = $this->createMock(Connection::class);
+        $container->set('doctrine.dbal.default_connection', $conn);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+        self::assertInstanceOf(DependencyFactory::class, $di);
+
+        $migration = $di->getMigrationFactory()->createVersion(Migration001::class);
+
+        self::assertInstanceOf(Migration001::class, $migration);
+        self::assertSame($container, $migration->getContainer());
+    }
+
     public function testServicesAreLazy(): void
     {
         $config    = [

Tests/Fixtures/Migrations/Migration001.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class Migration001 extends AbstractMigration implements ContainerAwareInterface
+{
+    /** @var ContainerInterface */
+    private $container;
+
+    public function up(Schema $schema): void
+    {
+        // TODO: Implement up() method.
+    }
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        $this->container = $container;
+    }
+
+    public function getContainer(): ?ContainerInterface
+    {
+        return $this->container;
+    }
+}

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"
+        "doctrine/migrations": "^3.0.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.0|^8.0|^9.0",