bug #60268 [Contracts] Fix ServiceSubscriberTrait for nullable service (StevenRenaux)

fabpot · fabpot · commit b59a25a5d79a · 2025-04-30T09:47:24.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Contracts] Fix `ServiceSubscriberTrait` for nullable service | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT Used in a bundle context. If you use the following example, you will get an exception: `ServiceNotFoundException: The service "twig" in the container provided to "App\Service\Dependency" has a dependency on a non-existent service "Twig\Environment".` The `nullable` argument of the `SubscribedService` attribute is ignored. ```php // src/Service/TwigAware.php namespace App\Service; use Twig\Environment; use Symfony\Contracts\Service\Attribute\SubscribedService; trait TwigAware { #[SubscribedService('twig', nullable: true)] private function twig(): Environment { if (!$this->container->has('twig') ) { throw new \LogicException(\sprintf('Twig is required to use "%s" method. Try to run "composer require symfony/twig-bundle".', __METHOD__)); } return $environment; } } // src/Service/MyService.php namespace App\Service; use Symfony\Contracts\Service\ServiceSubscriberInterface; use Symfony\Contracts\Service\ServiceSubscriberTrait; class MyService implements ServiceSubscriberInterface { use ServiceSubscriberTrait, TwigAware; public function doWithTwig(): void { // $this->twig() ... } } ``` Related to #60265 Commits ------- 95b0f9b Fix ServiceMethodsSubscriberTrait for nullable service
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php b/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php
@@ -51,7 +51,7 @@ public static function getSubscribedServices(): array
             $attribute = $attribute->newInstance();
             $attribute->key ??= self::class.'::'.$method->name;
             $attribute->type ??= $returnType instanceof \ReflectionNamedType ? $returnType->getName() : (string) $returnType;
-            $attribute->nullable = $returnType->allowsNull();
+            $attribute->nullable = $attribute->nullable ?: $returnType->allowsNull();
 
             if ($attribute->attributes) {
                 $services[] = $attribute;
diff --git a/src/Symfony/Contracts/Tests/Service/ServiceSubscriberTraitTest.php b/src/Symfony/Contracts/Tests/Service/ServiceSubscriberTraitTest.php
@@ -27,7 +27,8 @@ public function testMethodsOnParentsAndChildrenAreIgnoredInGetSubscribedServices
     {
         $expected = [
             TestService::class.'::aService' => Service2::class,
-            TestService::class.'::nullableService' => '?'.Service2::class,
+            TestService::class.'::nullableInAttribute' => '?'.Service2::class,
+            TestService::class.'::nullableReturnType' => '?'.Service2::class,
             new SubscribedService(TestService::class.'::withAttribute', Service2::class, true, new Required()),
         ];
 
@@ -103,8 +104,18 @@ public function aService(): Service2
     {
     }
 
+    #[SubscribedService(nullable: true)]
+    public function nullableInAttribute(): Service2
+    {
+        if (!$this->container->has(__METHOD__)) {
+            throw new \LogicException();
+        }
+
+        return $this->container->get(__METHOD__);
+    }
+
     #[SubscribedService]
-    public function nullableService(): ?Service2
+    public function nullableReturnType(): ?Service2
     {
     }
 

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,8 @@ public function testMethodsOnParentsAndChildrenAreIgnoredInGetSubscribedServices`
`27`	`27`	`{`
`28`	`28`	`$expected = [`
`29`	`29`	`TestService::class.'::aService' => Service2::class,`
`30`		`- TestService::class.'::nullableService' => '?'.Service2::class,`
	`30`	`+ TestService::class.'::nullableInAttribute' => '?'.Service2::class,`
	`31`	`+ TestService::class.'::nullableReturnType' => '?'.Service2::class,`
`31`	`32`	`new SubscribedService(TestService::class.'::withAttribute', Service2::class, true, new Required()),`
`32`	`33`	`];`
`33`	`34`
`@@ -103,8 +104,18 @@ public function aService(): Service2`
`103`	`104`	`{`
`104`	`105`	`}`
`105`	`106`
	`107`	`+ #[SubscribedService(nullable: true)]`
	`108`	`+ public function nullableInAttribute(): Service2`
	`109`	`+ {`
	`110`	`+ if (!$this->container->has(__METHOD__)) {`
	`111`	`+ throw new \LogicException();`
	`112`	`+ }`
	`113`	`+`
	`114`	`+ return $this->container->get(__METHOD__);`
	`115`	`+ }`
	`116`	`+`
`106`	`117`	`#[SubscribedService]`
`107`		`- public function nullableService(): ?Service2`
	`118`	`+ public function nullableReturnType(): ?Service2`
`108`	`119`	`{`
`109`	`120`	`}`
`110`	`121`