[DependencyInjection] Deprecate ContainerAwareInterface, ContainerAwareTrait and ContainerAwareLoader

Author: alexandre-daubois

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', '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());
         }
 

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', '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) {

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());
     }

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()]));

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');

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)
     {

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)
     {

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()
     {

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'

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 }