feature #54496 [Contracts] Rename ServiceSubscriberTrait to ServiceMethodsSubscriberTrait (nicolas-grekas)

fabpot · fabpot · commit bb3488d41837 · 2024-04-05T13:36:06.000+02:00
This PR was merged into the 7.1 branch.

Discussion
----------

[Contracts] Rename ServiceSubscriberTrait to ServiceMethodsSubscriberTrait

| Q             | A
| ------------- | ---
| Branch?       | 7.1
| Bug fix?      | no
| New feature?  | no
| Deprecations? | yes
| Issues        | Fix #54490
| License       | MIT

As described in the linked PR, AbstractController is incompatible with ServiceSubscriberTrait because of the added type to the AbstractController::$container property, while ServiceSubscriberTrait's $container property cannot have a type without a BC break.

There are two parts to this PR:
- Deprecate ServiceSubscriberTrait in favor if ServiceMethodsSubscriberTrait, which declares the type of the $container property. The new name better conveys its purpose as a bonus.
- Fix the incompatibility with AbstractController by removing the property declaration on ServiceSubscriberTrait. This means the
 trait will create a dynamic property. Those are deprecated, but since the trait is also deprecated, the upgrade path is clear.

I also tried to improve the description of the trait in the meantime.

/cc `@kbond`

Commits
-------

8f47ced9dd [Contracts] Rename ServiceSubscriberTrait to ServiceMethodsSubscriberTrait
diff --git a/Tests/Compiler/RegisterServiceSubscribersPassTest.php b/Tests/Compiler/RegisterServiceSubscribersPassTest.php
@@ -43,8 +43,8 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\TestServiceSubscriberUnionWithTrait;
 use Symfony\Component\DependencyInjection\TypedReference;
 use Symfony\Contracts\Service\Attribute\SubscribedService;
+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
-use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 require_once __DIR__.'/../Fixtures/includes/classes.php';
 
@@ -221,7 +221,7 @@ public function testExtraServiceSubscriber()
         $container->compile();
     }
 
-    public function testServiceSubscriberTraitWithSubscribedServiceAttribute()
+    public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttribute()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
@@ -251,14 +251,14 @@ public function testServiceSubscriberTraitWithSubscribedServiceAttribute()
         $this->assertEquals($expected, $container->getDefinition((string) $locator->getFactory()[0])->getArgument(0));
     }
 
-    public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnStaticMethod()
+    public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnStaticMethod()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
         }
 
         $subscriber = new class() implements ServiceSubscriberInterface {
-            use ServiceSubscriberTrait;
+            use ServiceMethodsSubscriberTrait;
 
             #[SubscribedService]
             public static function method(): TestDefinition1
@@ -271,14 +271,14 @@ public static function method(): TestDefinition1
         $subscriber::getSubscribedServices();
     }
 
-    public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnMethodWithRequiredParameters()
+    public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnMethodWithRequiredParameters()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
         }
 
         $subscriber = new class() implements ServiceSubscriberInterface {
-            use ServiceSubscriberTrait;
+            use ServiceMethodsSubscriberTrait;
 
             #[SubscribedService]
             public function method($param1, $param2 = null): TestDefinition1
@@ -291,14 +291,14 @@ public function method($param1, $param2 = null): TestDefinition1
         $subscriber::getSubscribedServices();
     }
 
-    public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnMethodMissingReturnType()
+    public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnMethodMissingReturnType()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
         }
 
         $subscriber = new class() implements ServiceSubscriberInterface {
-            use ServiceSubscriberTrait;
+            use ServiceMethodsSubscriberTrait;
 
             #[SubscribedService]
             public function method()
@@ -311,7 +311,7 @@ public function method()
         $subscriber::getSubscribedServices();
     }
 
-    public function testServiceSubscriberTraitWithUnionReturnType()
+    public function testServiceMethodsSubscriberTraitWithUnionReturnType()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
@@ -338,7 +338,7 @@ public function testServiceSubscriberTraitWithUnionReturnType()
         $this->assertEquals($expected, $container->getDefinition((string) $locator->getFactory()[0])->getArgument(0));
     }
 
-    public function testServiceSubscriberTraitWithIntersectionReturnType()
+    public function testServiceMethodsSubscriberTraitWithIntersectionReturnType()
     {
         if (!class_exists(SubscribedService::class)) {
             $this->markTestSkipped('SubscribedService attribute not available.');
diff --git a/Tests/Fixtures/TestServiceMethodsSubscriberTrait.php b/Tests/Fixtures/TestServiceMethodsSubscriberTrait.php
@@ -4,7 +4,7 @@
 
 use Symfony\Contracts\Service\Attribute\SubscribedService;
 
-trait TestServiceSubscriberTrait
+trait TestServiceMethodsSubscriberTrait
 {
     protected function protectedFunction1(): SomeClass
     {
diff --git a/Tests/Fixtures/TestServiceSubscriberChild.php b/Tests/Fixtures/TestServiceSubscriberChild.php
@@ -3,12 +3,12 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Symfony\Contracts\Service\Attribute\SubscribedService;
-use Symfony\Contracts\Service\ServiceSubscriberTrait;
+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;
 
 class TestServiceSubscriberChild extends TestServiceSubscriberParent
 {
-    use ServiceSubscriberTrait;
-    use TestServiceSubscriberTrait;
+    use ServiceMethodsSubscriberTrait;
+    use TestServiceMethodsSubscriberTrait;
 
     #[SubscribedService]
     private function testDefinition2(): ?TestDefinition2
diff --git a/Tests/Fixtures/TestServiceSubscriberIntersectionWithTrait.php b/Tests/Fixtures/TestServiceSubscriberIntersectionWithTrait.php
@@ -3,12 +3,12 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Symfony\Contracts\Service\Attribute\SubscribedService;
+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
-use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 class TestServiceSubscriberIntersectionWithTrait implements ServiceSubscriberInterface
 {
-    use ServiceSubscriberTrait;
+    use ServiceMethodsSubscriberTrait;
 
     #[SubscribedService]
     private function method1(): TestDefinition1&TestDefinition2
diff --git a/Tests/Fixtures/TestServiceSubscriberParent.php b/Tests/Fixtures/TestServiceSubscriberParent.php
@@ -3,12 +3,12 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Symfony\Contracts\Service\Attribute\SubscribedService;
+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
-use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 class TestServiceSubscriberParent implements ServiceSubscriberInterface
 {
-    use ServiceSubscriberTrait;
+    use ServiceMethodsSubscriberTrait;
 
     public function publicFunction1(): SomeClass
     {
diff --git a/Tests/Fixtures/TestServiceSubscriberUnionWithTrait.php b/Tests/Fixtures/TestServiceSubscriberUnionWithTrait.php
@@ -3,12 +3,12 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Symfony\Contracts\Service\Attribute\SubscribedService;
+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
-use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 class TestServiceSubscriberUnionWithTrait implements ServiceSubscriberInterface
 {
-    use ServiceSubscriberTrait;
+    use ServiceMethodsSubscriberTrait;
 
     #[SubscribedService]
     private function method1(): TestDefinition1|TestDefinition2|null

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,8 @@`
`43`	`43`	`use Symfony\Component\DependencyInjection\Tests\Fixtures\TestServiceSubscriberUnionWithTrait;`
`44`	`44`	`use Symfony\Component\DependencyInjection\TypedReference;`
`45`	`45`	`use Symfony\Contracts\Service\Attribute\SubscribedService;`
	`46`	`+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;`
`46`	`47`	`use Symfony\Contracts\Service\ServiceSubscriberInterface;`
`47`		`-use Symfony\Contracts\Service\ServiceSubscriberTrait;`
`48`	`48`
`49`	`49`	`require_once __DIR__.'/../Fixtures/includes/classes.php';`
`50`	`50`
`@@ -221,7 +221,7 @@ public function testExtraServiceSubscriber()`
`221`	`221`	`$container->compile();`
`222`	`222`	`}`
`223`	`223`
`224`		`- public function testServiceSubscriberTraitWithSubscribedServiceAttribute()`
	`224`	`+ public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttribute()`
`225`	`225`	`{`
`226`	`226`	`if (!class_exists(SubscribedService::class)) {`
`227`	`227`	`$this->markTestSkipped('SubscribedService attribute not available.');`
`@@ -251,14 +251,14 @@ public function testServiceSubscriberTraitWithSubscribedServiceAttribute()`
`251`	`251`	`$this->assertEquals($expected, $container->getDefinition((string) $locator->getFactory()[0])->getArgument(0));`
`252`	`252`	`}`
`253`	`253`
`254`		`- public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnStaticMethod()`
	`254`	`+ public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnStaticMethod()`
`255`	`255`	`{`
`256`	`256`	`if (!class_exists(SubscribedService::class)) {`
`257`	`257`	`$this->markTestSkipped('SubscribedService attribute not available.');`
`258`	`258`	`}`
`259`	`259`
`260`	`260`	`$subscriber = new class() implements ServiceSubscriberInterface {`
`261`		`- use ServiceSubscriberTrait;`
	`261`	`+ use ServiceMethodsSubscriberTrait;`
`262`	`262`
`263`	`263`	`#[SubscribedService]`
`264`	`264`	`public static function method(): TestDefinition1`
`@@ -271,14 +271,14 @@ public static function method(): TestDefinition1`
`271`	`271`	`$subscriber::getSubscribedServices();`
`272`	`272`	`}`
`273`	`273`
`274`		`- public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnMethodWithRequiredParameters()`
	`274`	`+ public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnMethodWithRequiredParameters()`
`275`	`275`	`{`
`276`	`276`	`if (!class_exists(SubscribedService::class)) {`
`277`	`277`	`$this->markTestSkipped('SubscribedService attribute not available.');`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`$subscriber = new class() implements ServiceSubscriberInterface {`
`281`		`- use ServiceSubscriberTrait;`
	`281`	`+ use ServiceMethodsSubscriberTrait;`
`282`	`282`
`283`	`283`	`#[SubscribedService]`
`284`	`284`	`public function method($param1, $param2 = null): TestDefinition1`
`@@ -291,14 +291,14 @@ public function method($param1, $param2 = null): TestDefinition1`
`291`	`291`	`$subscriber::getSubscribedServices();`
`292`	`292`	`}`
`293`	`293`
`294`		`- public function testServiceSubscriberTraitWithSubscribedServiceAttributeOnMethodMissingReturnType()`
	`294`	`+ public function testServiceMethodsSubscriberTraitWithSubscribedServiceAttributeOnMethodMissingReturnType()`
`295`	`295`	`{`
`296`	`296`	`if (!class_exists(SubscribedService::class)) {`
`297`	`297`	`$this->markTestSkipped('SubscribedService attribute not available.');`
`298`	`298`	`}`
`299`	`299`
`300`	`300`	`$subscriber = new class() implements ServiceSubscriberInterface {`
`301`		`- use ServiceSubscriberTrait;`
	`301`	`+ use ServiceMethodsSubscriberTrait;`
`302`	`302`
`303`	`303`	`#[SubscribedService]`
`304`	`304`	`public function method()`
`@@ -311,7 +311,7 @@ public function method()`
`311`	`311`	`$subscriber::getSubscribedServices();`
`312`	`312`	`}`
`313`	`313`
`314`		`- public function testServiceSubscriberTraitWithUnionReturnType()`
	`314`	`+ public function testServiceMethodsSubscriberTraitWithUnionReturnType()`
`315`	`315`	`{`
`316`	`316`	`if (!class_exists(SubscribedService::class)) {`
`317`	`317`	`$this->markTestSkipped('SubscribedService attribute not available.');`
`@@ -338,7 +338,7 @@ public function testServiceSubscriberTraitWithUnionReturnType()`
`338`	`338`	`$this->assertEquals($expected, $container->getDefinition((string) $locator->getFactory()[0])->getArgument(0));`
`339`	`339`	`}`
`340`	`340`
`341`		`- public function testServiceSubscriberTraitWithIntersectionReturnType()`
	`341`	`+ public function testServiceMethodsSubscriberTraitWithIntersectionReturnType()`
`342`	`342`	`{`
`343`	`343`	`if (!class_exists(SubscribedService::class)) {`
`344`	`344`	`$this->markTestSkipped('SubscribedService attribute not available.');`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Symfony\Contracts\Service\Attribute\SubscribedService;`
`6`	`6`
`7`		`-trait TestServiceSubscriberTrait`
	`7`	`+trait TestServiceMethodsSubscriberTrait`
`8`	`8`	`{`
`9`	`9`	`protected function protectedFunction1(): SomeClass`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,12 @@`
`3`	`3`	`namespace Symfony\Component\DependencyInjection\Tests\Fixtures;`
`4`	`4`
`5`	`5`	`use Symfony\Contracts\Service\Attribute\SubscribedService;`
	`6`	`+use Symfony\Contracts\Service\ServiceMethodsSubscriberTrait;`
`6`	`7`	`use Symfony\Contracts\Service\ServiceSubscriberInterface;`
`7`		`-use Symfony\Contracts\Service\ServiceSubscriberTrait;`
`8`	`8`
`9`	`9`	`class TestServiceSubscriberParent implements ServiceSubscriberInterface`
`10`	`10`	`{`
`11`		`- use ServiceSubscriberTrait;`
	`11`	`+ use ServiceMethodsSubscriberTrait;`
`12`	`12`
`13`	`13`	`public function publicFunction1(): SomeClass`
`14`	`14`	`{`