Merge branch '5.4' into 6.0

* 5.4:
  [DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage
  Use try/finally to restore error handlers
  Allow serializer default context configuration

Author: nicolas-grekas

Service/Attribute/SubscribedService.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Contracts\Service\Attribute;
+
+use Symfony\Contracts\Service\ServiceSubscriberTrait;
+
+/**
+ * Use with {@see ServiceSubscriberTrait} to mark a method's return type
+ * as a subscribed service.
+ *
+ * @author Kevin Bond <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class SubscribedService
+{
+    /**
+     * @param string|null $key The key to use for the service
+     *                         If null, use "ClassName::methodName"
+     */
+    public function __construct(
+        public ?string $key = null
+    ) {
+    }
+}

Service/ServiceSubscriberTrait.php

@@ -12,10 +12,11 @@
 namespace Symfony\Contracts\Service;
 
 use Psr\Container\ContainerInterface;
+use Symfony\Contracts\Service\Attribute\SubscribedService;
 
 /**
  * Implementation of ServiceSubscriberInterface that determines subscribed services from
- * private method return types. Service ids are available as "ClassName::methodName".
+ * method return types. Service ids are available as "ClassName::methodName".
  *
  * @author Kevin Bond <[email protected]>
  */
@@ -36,13 +37,59 @@ public static function getSubscribedServices(): array
         }
 
         $services = \is_callable(['parent', __FUNCTION__]) ? parent::getSubscribedServices() : [];
+        $attributeOptIn = false;
 
-        foreach ((new \ReflectionClass(self::class))->getMethods() as $method) {
-            if ($method->isStatic() || $method->isAbstract() || $method->isGenerator() || $method->isInternal() || $method->getNumberOfRequiredParameters()) {
-                continue;
+        if (\PHP_VERSION_ID >= 80000) {
+            foreach ((new \ReflectionClass(self::class))->getMethods() as $method) {
+                if (self::class !== $method->getDeclaringClass()->name) {
+                    continue;
+                }
+
+                if (!$attribute = $method->getAttributes(SubscribedService::class)[0] ?? null) {
+                    continue;
+                }
+
+                if ($method->isStatic() || $method->isAbstract() || $method->isGenerator() || $method->isInternal() || $method->getNumberOfRequiredParameters()) {
+                    throw new \LogicException(sprintf('Cannot use "%s" on method "%s::%s()" (can only be used on non-static, non-abstract methods with no parameters).', SubscribedService::class, self::class, $method->name));
+                }
+
+                if (!$returnType = $method->getReturnType()) {
+                    throw new \LogicException(sprintf('Cannot use "%s" on methods without a return type in "%s::%s()".', SubscribedService::class, $method->name, self::class));
+                }
+
+                $serviceId = $returnType instanceof \ReflectionNamedType ? $returnType->getName() : (string) $returnType;
+
+                if ($returnType->allowsNull()) {
+                    $serviceId = '?'.$serviceId;
+                }
+
+                $services[$attribute->newInstance()->key ?? self::class.'::'.$method->name] = $serviceId;
+                $attributeOptIn = true;
             }
+        }
+
+        if (!$attributeOptIn) {
+            foreach ((new \ReflectionClass(self::class))->getMethods() as $method) {
+                if ($method->isStatic() || $method->isAbstract() || $method->isGenerator() || $method->isInternal() || $method->getNumberOfRequiredParameters()) {
+                    continue;
+                }
+
+                if (self::class !== $method->getDeclaringClass()->name) {
+                    continue;
+                }
+
+                if (!$returnType = $method->getReturnType()) {
+                    continue;
+                }
+
+                if ($returnType->isBuiltin()) {
+                    continue;
+                }
+
+                if (\PHP_VERSION_ID >= 80000) {
+                    trigger_deprecation('symfony/service-contracts', '2.5', 'Using "%s" in "%s" without using the "%s" attribute on any method is deprecated.', ServiceSubscriberTrait::class, self::class, SubscribedService::class);
+                }
 
-            if (self::class === $method->getDeclaringClass()->name && ($returnType = $method->getReturnType()) && !$returnType->isBuiltin()) {
                 $services[self::class.'::'.$method->name] = '?'.($returnType instanceof \ReflectionNamedType ? $returnType->getName() : $returnType);
             }
         }

Tests/Service/ServiceSubscriberTraitTest.php

@@ -13,15 +13,34 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir\Component1\Dir1\Service1;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir\Component1\Dir2\Service2;
+use Symfony\Contracts\Service\Attribute\SubscribedService;
 use Symfony\Contracts\Service\ServiceLocatorTrait;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
 use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 class ServiceSubscriberTraitTest extends TestCase
 {
+    /**
+     * @group legacy
+     */
+    public function testLegacyMethodsOnParentsAndChildrenAreIgnoredInGetSubscribedServices()
+    {
+        $expected = [LegacyTestService::class.'::aService' => '?'.Service2::class];
+
+        $this->assertEquals($expected, LegacyChildTestService::getSubscribedServices());
+    }
+
+    /**
+     * @requires PHP 8
+     */
     public function testMethodsOnParentsAndChildrenAreIgnoredInGetSubscribedServices()
     {
-        $expected = [TestService::class.'::aService' => '?Symfony\Contracts\Tests\Service\Service2'];
+        $expected = [
+            TestService::class.'::aService' => Service2::class,
+            TestService::class.'::nullableService' => '?'.Service2::class,
+        ];
 
         $this->assertEquals($expected, ChildTestService::getSubscribedServices());
     }
@@ -48,18 +67,45 @@ public function setContainer(ContainerInterface $container)
     }
 }
 
+class LegacyTestService extends ParentTestService implements ServiceSubscriberInterface
+{
+    use ServiceSubscriberTrait;
+
+    public function aService(): Service2
+    {
+    }
+}
+
+class LegacyChildTestService extends LegacyTestService
+{
+    public function aChildService(): Service3
+    {
+    }
+}
+
 class TestService extends ParentTestService implements ServiceSubscriberInterface
 {
     use ServiceSubscriberTrait;
 
+    #[SubscribedService]
     public function aService(): Service2
     {
     }
+
+    #[SubscribedService]
+    public function nullableService(): ?Service2
+    {
+    }
 }
 
 class ChildTestService extends TestService
 {
+    #[SubscribedService]
     public function aChildService(): Service3
     {
     }
 }
+
+class Service3
+{
+}