Fix ServiceSubscriberTrait usage with AbstractController

Evan Shaw · Evan Shaw · commit 8b7fcb2286f9 · 2023-02-19T12:42:43.000+13:00
The parent class's setContainer method should be called first, so that
if the parent method relies on the old container, it will still work
correctly.
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php b/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php
@@ -98,12 +98,12 @@ public static function getSubscribedServices(): array
      */
     public function setContainer(ContainerInterface $container)
     {
-        $this->container = $container;
-
         if (method_exists(get_parent_class(self::class) ?: '', __FUNCTION__)) {
-            return parent::setContainer($container);
+            $ret = parent::setContainer($container);
         }
 
-        return null;
+        $this->container = $container;
+
+        return $ret;
     }
 }
diff --git a/src/Symfony/Contracts/Tests/Service/ServiceSubscriberTraitTest.php b/src/Symfony/Contracts/Tests/Service/ServiceSubscriberTraitTest.php
@@ -81,6 +81,18 @@ public function testParentNotCalledIfNoParent()
         $this->assertSame([], $service::getSubscribedServices());
     }
 
+    public function testSetContainerCalledFirstOnParent()
+    {
+        $container1 = new class([]) implements ContainerInterface {
+            use ServiceLocatorTrait;
+        };
+        $container2 = clone $container1;
+
+        $testService = new TestService2();
+        $this->assertNull($testService->setContainer($container1));
+        $this->assertSame($container1, $testService->setContainer($container2));
+    }
+
     /**
      * @requires PHP 8
      *
@@ -161,3 +173,21 @@ public static function __callStatic($method, $args)
 class Service3
 {
 }
+
+class ParentTestService2
+{
+    /** @var ContainerInterface */
+    protected $container;
+
+    public function setContainer(ContainerInterface $container)
+    {
+        $previous = $this->container;
+        $this->container = $container;
+        return $previous;
+    }
+}
+
+class TestService2 extends ParentTestService2 implements ServiceSubscriberInterface
+{
+    use ServiceSubscriberTrait;
+}

Original file line number	Diff line number	Diff line change
`@@ -98,12 +98,12 @@ public static function getSubscribedServices(): array`
`98`	`98`	`*/`
`99`	`99`	`public function setContainer(ContainerInterface $container)`
`100`	`100`	`{`
`101`		`- $this->container = $container;`
`102`		`-`
`103`	`101`	`if (method_exists(get_parent_class(self::class) ?: '', __FUNCTION__)) {`
`104`		`- return parent::setContainer($container);`
	`102`	`+ $ret = parent::setContainer($container);`
`105`	`103`	`}`
`106`	`104`
`107`		`- return null;`
	`105`	`+ $this->container = $container;`
	`106`	`+`
	`107`	`+ return $ret;`
`108`	`108`	`}`
`109`	`109`	`}`