[DependencyInjection] Deprecate ContainerAwareInterface, ContainerAwareTrait and ContainerAwareLoader

alexandre-daubois · alexandre-daubois · commit f4ef751ffaec · 2023-06-12T14:48:11.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -1,12 +1,47 @@
 UPGRADE FROM 6.3 to 6.4
 =======================
 
+DependencyInjection
+-------------------
+
+ * Deprecate `ContainerAwareInterface` and `ContainerAwareTrait`, use dependency injection instead
+
+   Before:
+   ```php
+   class MyService implements ContainerAwareInterface
+   {
+       use ContainerAwareTrait;
+
+       // ...
+   }
+   ```
+
+   After:
+   ```php
+   class MyService
+   {
+       // Inject the container through the constructor...
+       public function __construct(private ContainerInterface $container)
+       {
+           $this->container = $container;
+       }
+
+       // ... or by using the #[Required] attribute
+       #[Required]
+       public function setContainer(ContainerInterface $container): void
+       {
+            $this->container = $container;
+       }
+   }
+   ```
+
 DoctrineBridge
 --------------
 
  * Deprecate `DbalLogger`, use a middleware instead
  * Deprecate not constructing `DoctrineDataCollector` with an instance of `DebugDataHolder`
  * Deprecate `DoctrineDataCollector::addLogger()`, use a `DebugDataHolder` instead
+ * Deprecate `ContainerAwareLoader`, use dependency injection in your fixtures instead
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Deprecate `DbalLogger`, use a middleware instead
  * Deprecate not constructing `DoctrineDataCollector` with an instance of `DebugDataHolder`
  * Deprecate `DoctrineDataCollector::addLogger()`, use a `DebugDataHolder` instead
+ * Deprecate `ContainerAwareLoader`, use dependency injection in your fixtures instead
 
 6.3
 ---
diff --git a/src/Symfony/Bridge/Doctrine/DataFixtures/ContainerAwareLoader.php b/src/Symfony/Bridge/Doctrine/DataFixtures/ContainerAwareLoader.php
@@ -16,12 +16,16 @@
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+trigger_deprecation('symfony/dependency-injection', '6.4', '"%s" is deprecated, use dependency injection in your fixtures instead.', ContainerAwareLoader::class);
+
 /**
  * Doctrine data fixtures loader that injects the service container into
  * fixture objects that implement ContainerAwareInterface.
  *
  * Note: Use of this class requires the Doctrine data fixtures extension, which
  * is a suggested dependency for Symfony.
+ *
+ * @deprecated since Symfony 6.4, use dependency injection in your fixtures instead
  */
 class ContainerAwareLoader extends Loader
 {
diff --git a/src/Symfony/Bridge/Doctrine/Tests/DataFixtures/ContainerAwareLoaderTest.php b/src/Symfony/Bridge/Doctrine/Tests/DataFixtures/ContainerAwareLoaderTest.php
@@ -16,6 +16,9 @@
 use Symfony\Bridge\Doctrine\Tests\Fixtures\ContainerAwareFixture;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+/**
+ * @group legacy
+ */
 class ContainerAwareLoaderTest extends TestCase
 {
     public function testShouldSetContainerOnContainerAwareFixture()
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/ContainerAwareFixture.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/ContainerAwareFixture.php
@@ -16,6 +16,9 @@
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+/**
+ * @deprecated since Symfony 6.4, to be removed in 7.0
+ */
 class ContainerAwareFixture implements FixtureInterface, ContainerAwareInterface
 {
     public ?ContainerInterface $container = null;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Application.php b/src/Symfony/Bundle/FrameworkBundle/Console/Application.php
@@ -115,6 +115,7 @@ public function get(string $name): Command
         $command = parent::get($name);
 
         if ($command instanceof ContainerAwareInterface) {
+            trigger_deprecation('symfony/dependency-injection', '6.4', sprintf('Relying on "%s" to get the container in "%s" is deprecated, register the command as a service and use dependency injection instead.', ContainerAwareInterface::class, get_debug_type($command)));
             $command->setContainer($this->kernel->getContainer());
         }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php
@@ -26,6 +26,7 @@ protected function instantiateController(string $class): object
         $controller = parent::instantiateController($class);
 
         if ($controller instanceof ContainerAwareInterface) {
+            trigger_deprecation('symfony/dependency-injection', '6.4', sprintf('Relying on "%s" to get the container in "%s" is deprecated, register the controller as a service and use dependency injection instead.', ContainerAwareInterface::class, get_debug_type($controller)));
             $controller->setContainer($this->container);
         }
         if ($controller instanceof AbstractController) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php
@@ -13,6 +13,7 @@
 
 use Psr\Container\ContainerInterface as Psr11ContainerInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver;
 use Symfony\Component\DependencyInjection\Container;
@@ -23,31 +24,44 @@
 
 class ControllerResolverTest extends ContainerControllerResolverTest
 {
+    use ExpectDeprecationTrait;
+
+    /**
+     * @group legacy
+     */
     public function testGetControllerOnContainerAware()
     {
         $resolver = $this->createControllerResolver();
         $request = Request::create('/');
         $request->attributes->set('_controller', 'Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController::testAction');
 
+        $this->expectDeprecation('Since symfony/dependency-injection 6.4: Relying on "Symfony\Component\DependencyInjection\ContainerAwareInterface" to get the container in "Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController" is deprecated, register the controller as a service and use dependency injection instead.');
         $controller = $resolver->getController($request);
 
         $this->assertInstanceOf(ContainerAwareController::class, $controller[0]);
         $this->assertInstanceOf(ContainerInterface::class, $controller[0]->getContainer());
         $this->assertSame('testAction', $controller[1]);
     }
 
+    /**
+     * @group legacy
+     */
     public function testGetControllerOnContainerAwareInvokable()
     {
         $resolver = $this->createControllerResolver();
         $request = Request::create('/');
         $request->attributes->set('_controller', 'Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController');
 
+        $this->expectDeprecation('Since symfony/dependency-injection 6.4: Relying on "Symfony\Component\DependencyInjection\ContainerAwareInterface" to get the container in "Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController" is deprecated, register the controller as a service and use dependency injection instead.');
         $controller = $resolver->getController($request);
 
         $this->assertInstanceOf(ContainerAwareController::class, $controller);
         $this->assertInstanceOf(ContainerInterface::class, $controller->getContainer());
     }
 
+    /**
+     * @group legacy
+     */
     public function testContainerAwareControllerGetsContainerWhenNotSet()
     {
         class_exists(AbstractControllerTest::class);
@@ -62,6 +76,7 @@ class_exists(AbstractControllerTest::class);
         $request = Request::create('/');
         $request->attributes->set('_controller', TestAbstractController::class.'::testAction');
 
+        $this->expectDeprecation('Since symfony/dependency-injection 6.4: Relying on "Symfony\Component\DependencyInjection\ContainerAwareInterface" to get the container in "Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController" is deprecated, register the controller as a service and use dependency injection instead.');
         $this->assertSame([$controller, 'testAction'], $resolver->getController($request));
         $this->assertSame($container, $controller->getContainer());
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/FragmentController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/FragmentController.php
@@ -11,18 +11,14 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentUriGeneratorInterface;
 use Twig\Environment;
 
-class FragmentController implements ContainerAwareInterface
+class FragmentController
 {
-    use ContainerAwareTrait;
-
     public function indexAction(Environment $twig)
     {
         return new Response($twig->render('fragment.html.twig', ['bar' => new Bar()]));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/ProfilerController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/ProfilerController.php
@@ -11,14 +11,10 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\HttpFoundation\Response;
 
-class ProfilerController implements ContainerAwareInterface
+class ProfilerController
 {
-    use ContainerAwareTrait;
-
     public function indexAction()
     {
         return new Response('Hello');
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SessionController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SessionController.php
@@ -11,15 +11,16 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
-class SessionController implements ContainerAwareInterface
+class SessionController
 {
-    use ContainerAwareTrait;
+    public function __construct(protected ContainerInterface $container)
+    {
+    }
 
     public function welcomeAction(Request $request, $name = null)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SubRequestController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SubRequestController.php
@@ -11,15 +11,16 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 
-class SubRequestController implements ContainerAwareInterface
+class SubRequestController
 {
-    use ContainerAwareTrait;
+    public function __construct(private ContainerInterface $container)
+    {
+    }
 
     public function indexAction($handler)
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SubRequestServiceResolutionController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SubRequestServiceResolutionController.php
@@ -12,14 +12,15 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
 
 use Psr\Log\LoggerInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
-class SubRequestServiceResolutionController implements ContainerAwareInterface
+class SubRequestServiceResolutionController
 {
-    use ContainerAwareTrait;
+    public function __construct(private ContainerInterface $container)
+    {
+    }
 
     public function indexAction()
     {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ControllerServiceResolution/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ControllerServiceResolution/config.yml
@@ -5,6 +5,7 @@ services:
     Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\SubRequestServiceResolutionController:
         public: true
         tags: [controller.service_arguments]
+        arguments: ['@service_container']
 
     logger: { class: Psr\Log\NullLogger }
     Psr\Log\LoggerInterface: '@logger'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Session/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/Session/config.yml
@@ -2,6 +2,14 @@ imports:
     - { resource: ./../config/default.yml }
 
 services:
+    _defaults:
+        bind:
+            Symfony\Component\DependencyInjection\ContainerInterface $container: '@service_container'
+
+    Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\SessionController:
+        tags:
+            - { name: controller.service_arguments }
+
     Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\SubRequestController:
         tags:
             - { name: controller.service_arguments, action: indexAction, argument: handler, id: fragment.handler }
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -21,7 +21,7 @@
         "ext-xml": "*",
         "symfony/cache": "^5.4|^6.0|^7.0",
         "symfony/config": "^6.1|^7.0",
-        "symfony/dependency-injection": "^6.3|^7.0",
+        "symfony/dependency-injection": "^6.4|^7.0",
         "symfony/deprecation-contracts": "^2.5|^3",
         "symfony/error-handler": "^6.1|^7.0",
         "symfony/event-dispatcher": "^5.4|^6.0|^7.0",
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/SecuredPageBundle/Controller/AdminController.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/SecuredPageBundle/Controller/AdminController.php
@@ -11,14 +11,10 @@
 
 namespace Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\SecuredPageBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\HttpFoundation\Response;
 
-class AdminController implements ContainerAwareInterface
+class AdminController
 {
-    use ContainerAwareTrait;
-
     public function indexAction()
     {
         return new Response('admin');
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Deprecate `ContainerAwareInterface` and `ContainerAwareTrait`, use dependency injection instead
+
 6.3
 ---
 
diff --git a/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php b/src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php
@@ -15,6 +15,8 @@
  * ContainerAwareInterface should be implemented by classes that depends on a Container.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use dependency injection instead
  */
 interface ContainerAwareInterface
 {
diff --git a/src/Symfony/Component/DependencyInjection/ContainerAwareTrait.php b/src/Symfony/Component/DependencyInjection/ContainerAwareTrait.php
@@ -11,10 +11,14 @@
 
 namespace Symfony\Component\DependencyInjection;
 
+trigger_deprecation('symfony/dependency-injection', '6.4', '"%s" is deprecated, use dependency injection instead.', ContainerAwareTrait::class);
+
 /**
  * ContainerAware trait.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use dependency injection instead
  */
 trait ContainerAwareTrait
 {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerAwareTraitTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerAwareTraitTest.php
@@ -13,17 +13,16 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\ContainerAwareDummy;
 
+/**
+ * @group legacy
+ */
 class ContainerAwareTraitTest extends TestCase
 {
     use ExpectDeprecationTrait;
 
-    /**
-     * @group legacy
-     */
     public function testSetContainerLegacy()
     {
         $container = $this->createMock(ContainerInterface::class);
@@ -33,7 +32,7 @@ public function testSetContainerLegacy()
 
         self::assertSame($container, $dummy->getContainer());
 
-        $this->expectDeprecation('Since symfony/dependency-injection 6.2: Calling "Symfony\Component\DependencyInjection\Tests\ContainerAwareDummy::setContainer()" without any arguments is deprecated, pass null explicitly instead.');
+        $this->expectDeprecation('Since symfony/dependency-injection 6.2: Calling "Symfony\Component\DependencyInjection\Tests\Fixtures\ContainerAwareDummy::setContainer()" without any arguments is deprecated, pass null explicitly instead.');
 
         $dummy->setContainer();
         self::assertNull($dummy->getContainer());
@@ -52,13 +51,3 @@ public function testSetContainer()
         self::assertNull($dummy->getContainer());
     }
 }
-
-class ContainerAwareDummy implements ContainerAwareInterface
-{
-    use ContainerAwareTrait;
-
-    public function getContainer(): ?ContainerInterface
-    {
-        return $this->container;
-    }
-}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/ContainerAwareDummy.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/ContainerAwareDummy.php
diff --git a/src/Symfony/Component/HttpKernel/Bundle/Bundle.php b/src/Symfony/Component/HttpKernel/Bundle/Bundle.php
diff --git a/src/Symfony/Component/HttpKernel/Bundle/BundleInterface.php b/src/Symfony/Component/HttpKernel/Bundle/BundleInterface.php
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@`
`16`	`16`	`use Symfony\Bridge\Doctrine\Tests\Fixtures\ContainerAwareFixture;`
`17`	`17`	`use Symfony\Component\DependencyInjection\ContainerInterface;`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * @group legacy`
	`21`	`+ */`
`19`	`22`	`class ContainerAwareLoaderTest extends TestCase`
`20`	`23`	`{`
`21`	`24`	`public function testShouldSetContainerOnContainerAwareFixture()`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ public function get(string $name): Command`
`115`	`115`	`$command = parent::get($name);`
`116`	`116`
`117`	`117`	`if ($command instanceof ContainerAwareInterface) {`
	`118`	`+ trigger_deprecation('symfony/dependency-injection', '6.4', sprintf('Relying on "%s" to get the container in "%s" is deprecated, register the command as a service and use dependency injection instead.', ContainerAwareInterface::class, get_debug_type($command)));`
`118`	`119`	`$command->setContainer($this->kernel->getContainer());`
`119`	`120`	`}`
`120`	`121`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ protected function instantiateController(string $class): object`
`26`	`26`	`$controller = parent::instantiateController($class);`
`27`	`27`
`28`	`28`	`if ($controller instanceof ContainerAwareInterface) {`
	`29`	`+ trigger_deprecation('symfony/dependency-injection', '6.4', sprintf('Relying on "%s" to get the container in "%s" is deprecated, register the controller as a service and use dependency injection instead.', ContainerAwareInterface::class, get_debug_type($controller)));`
`29`	`30`	`$controller->setContainer($this->container);`
`30`	`31`	`}`
`31`	`32`	`if ($controller instanceof AbstractController) {`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,10 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;`
`13`	`13`
`14`		`-use Symfony\Component\DependencyInjection\ContainerAwareInterface;`
`15`		`-use Symfony\Component\DependencyInjection\ContainerAwareTrait;`
`16`	`14`	`use Symfony\Component\HttpFoundation\Response;`
`17`	`15`
`18`		`-class ProfilerController implements ContainerAwareInterface`
	`16`	`+class ProfilerController`
`19`	`17`	`{`
`20`		`- use ContainerAwareTrait;`
`21`		`-`
`22`	`18`	`public function indexAction()`
`23`	`19`	`{`
`24`	`20`	`return new Response('Hello');`