Introduce EnvironmentAwareMigrationInterface

Migration/EnvironmentAwareMigrationInterface.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\Migration;
+
+interface EnvironmentAwareMigrationInterface
+{
+    public function setEnvironment(string $env): void;
+}

Migration/EnvironmentAwareMigrationTrait.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\Migration;
+
+trait EnvironmentAwareMigrationTrait
+{
+    /** @var string */
+    private $environment;
+
+    public function setEnvironment(string $env): void
+    {
+        $this->environment = $env;
+    }
+}

MigrationsFactory/EnvironmentAwareMigrationFactory.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\MigrationsFactory;
+
+use Doctrine\Bundle\MigrationsBundle\Migration\EnvironmentAwareMigrationInterface;
+use Doctrine\Migrations\AbstractMigration;
+use Doctrine\Migrations\Version\MigrationFactory;
+
+class EnvironmentAwareMigrationFactory implements MigrationFactory
+{
+    /**
+     * @var string
+     */
+    private $environment;
+
+    /**
+     * @var MigrationFactory
+     */
+    private $migrationFactory;
+
+    public function __construct(MigrationFactory $migrationFactory, string $environment)
+    {
+        $this->environment = $environment;
+        $this->migrationFactory = $migrationFactory;
+    }
+
+    public function createVersion(string $migrationClassName): AbstractMigration
+    {
+        $migration = $this->migrationFactory->createVersion($migrationClassName);
+
+        if ($migration instanceof EnvironmentAwareMigrationInterface) {
+            $migration->setEnvironment($this->environment);
+        }
+
+        return $migration;
+    }
+}

Resources/config/services.xml

@@ -50,6 +50,14 @@
             <argument id="service_container" type="service"/>
         </service>
 
+        <service id="doctrine.migrations.environment_aware_migrations_factory"
+                 class="Doctrine\Bundle\MigrationsBundle\MigrationsFactory\EnvironmentAwareMigrationFactory"
+                 decorates="doctrine.migrations.migrations_factory"
+        >
+            <argument id="doctrine.migrations.environment_aware_migrations_factory.inner" type="service"/>
+            <argument>%kernel.environment%</argument>
+        </service>
+
         <service id="doctrine_migrations.diff_command" class="Doctrine\Migrations\Tools\Console\Command\DiffCommand">
 
             <argument type="service" id="doctrine.migrations.dependency_factory"/>

Tests/DependencyInjection/DoctrineMigrationsExtensionTest.php

@@ -10,6 +10,7 @@
 use Doctrine\Bundle\MigrationsBundle\DependencyInjection\DoctrineMigrationsExtension;
 use Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle;
 use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\Migrations\ContainerAwareMigration;
+use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\Migrations\EnvironmentAwareMigration;
 use Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\TestBundle\TestBundle;
 use Doctrine\Migrations\Configuration\Configuration;
 use Doctrine\Migrations\DependencyFactory;
@@ -200,6 +201,53 @@ public function testContainerAwareMigrations(): void
         self::assertSame($container, $migration->getContainer());
     }
 
+    /** @group legacy */
+    public function testEnvironmentAwareMigrations(): void
+    {
+        if (! interface_exists(ContainerAwareInterface::class)) {
+            self::markTestSkipped('This test requires Symfony < 7');
+        }
+
+        $config    = [
+            'migrations_paths' => ['DoctrineMigrationsTest' => 'a'],
+        ];
+        $container = $this->getContainer($config);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+        self::assertInstanceOf(DependencyFactory::class, $di);
+
+        $this->expectDeprecation('The "" service relies on the deprecated "Doctrine\Bundle\MigrationsBundle\MigrationsFactory\ContainerAwareMigrationFactory" class. It should either be deprecated or its implementation upgraded.');
+
+        $migration = $di->getMigrationFactory()->createVersion(EnvironmentAwareMigration::class);
+
+        self::assertInstanceOf(EnvironmentAwareMigration::class, $migration);
+        self::assertSame('test', $migration->getEnvironment());
+    }
+
+    public function testEnvironmentAwareMigrationsWithSymfony7(): void
+    {
+        if (interface_exists(ContainerAwareInterface::class)) {
+            self::markTestSkipped('This test requires Symfony > 7');
+        }
+
+        $config    = [
+            'migrations_paths' => ['DoctrineMigrationsTest' => 'a'],
+        ];
+        $container = $this->getContainer($config);
+
+        $container->compile();
+
+        $di = $container->get('doctrine.migrations.dependency_factory');
+        self::assertInstanceOf(DependencyFactory::class, $di);
+
+        $migration = $di->getMigrationFactory()->createVersion(EnvironmentAwareMigration::class);
+
+        self::assertInstanceOf(EnvironmentAwareMigration::class, $migration);
+        self::assertSame('test', $migration->getEnvironment());
+    }
+
     public function testServicesAreLazy(): void
     {
         $config    = [

Tests/Fixtures/Migrations/EnvironmentAwareMigration.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Bundle\MigrationsBundle\Tests\Fixtures\Migrations;
+
+use Doctrine\Bundle\MigrationsBundle\Migration\EnvironmentAwareMigrationInterface;
+use Doctrine\Bundle\MigrationsBundle\Migration\EnvironmentAwareMigrationTrait;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+class EnvironmentAwareMigration extends AbstractMigration implements EnvironmentAwareMigrationInterface
+{
+    use EnvironmentAwareMigrationTrait;
+
+    public function up(Schema $schema): void
+    {
+    }
+
+    public function getEnvironment(): string
+    {
+        return $this->environment;
+    }
+}