[DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage #42238

kbond · 2021-07-23T12:53:34Z

Q	A
Branch?	5.4
Bug fix?	yes
New feature?	yes
Deprecations?	yes
Tickets	Fix #42217
License	MIT
Doc PR	TODO

This is a fix for #42217 using what I proposed there (adding SubscribedService attribute). The current usage is deprecated in 5.4 only when using PHP 8+. I suggest removing the current usage entirely in Symfony 6.0 - this will fully fix the bug.

Deprecation Layer:

Symfony 5.4 with PHP < 8, everything works as it does currently (no deprecation warnings).
Symfony 5.4 with PHP > 8 and using the trait on a class w/o any methods marked with the SubscribedService attribute, works as it does currently but a deprecation warning is triggered.
Symfony 5.4 with PHP > 8 and using the trait on a class with at least one method marked with the SubscribedService attribute, you've opted-into the new functionality (methods w/o the attribute are ignored).

weaverryan

I like this approach - we have decided not to use ServiceSubscriberTrait in our site because, when trying to introduce it, one dev spent a long time trying to figure out a sudden autowiring error (it was because it was trying to wire a model class due to an unrelated method on the service that we did not want to be considered for the locator).

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

stof · 2021-07-23T13:02:26Z

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

+
+                if (!$returnType instanceof \ReflectionNamedType) {
+                    // todo, what exception to throw?
+                    throw new \RuntimeException(sprintf('Cannot use "%s" on methods with a union return type in "%s::%s()".', SubscribedService::class, $method->name, self::class));


Why ? the previous loop does not have this restriction.

I treated this as a bug. If the return type is Service1|Service2, what should be used for the service locator?

@kbond Does #43479 help to answer that question?

Yes :). Is there an example of using union/intersection types with ServiceSubscriberInterface?

The example from the PR was an intersection of two serializer interfaces that would yield the serializer service, e.g. NormalizerInterface&DenormalizerInterface, so let's explore that:

class MyService implements ServiceSubscriberInterface { use ServiceSubscriberTrait; private function getSerializer(): NormalizerInterface&DenormalizerInterface { return $this->container->get(__METHOD__); } }

Yep, I'll try to make that work. I'm looking for what the array returned from ServiceSubscriberInterface::getSubscribedServices() looks like when using union/intersection.

I see. We need to come up with a new convention for that, I guess.

stof · 2021-07-23T13:03:56Z

To make the trait usable in 5.4 without WTF, we would need a way to opt-in for the new behavior (here, there is nothing that will stop registering other private methods, with no way to avoid the deprecation warning if they are not meant to be subscribed)

nicolas-grekas · 2021-07-23T13:11:32Z

What about deprecating the trait instead?

kbond · 2021-07-23T13:12:32Z

To make the trait usable in 5.4 without WTF, we would need a way to opt-in for the new behavior

What about, if using the attribute on any method, you've opted into the new way and methods without the attribute are ignored?

kbond · 2021-07-23T13:13:01Z

What about deprecating the trait instead?

And creating a new trait entirely? Suggestions on a new name? SubscribedServiceTrait?

stof · 2021-07-23T13:13:02Z

Well, providing an easy implemention of the getSubscribedServices method to provide better DX might make sense.
but maybe it should be a new trait entirely instead (and deprecating the existing one)

nicolas-grekas · 2021-07-23T13:17:19Z

I was considering deprecating the trait and not replacing it, but if you think we should keep it, no need to create a new one if we can make a nice deprecation layer.

kbond · 2021-07-23T13:25:36Z

I was considering deprecating the trait and not replacing it, but if you think we should keep it...

I personally like this feature so I think we should keep it but I understand it's a bit... controversial (and could be easily abused).

If you're ok keeping it, I'll add the nice deprecation layer and finish this PR. Alternatively, if you want to deprecate/remove, I can easily maintain this feature in a 3rd party package.

nicolas-grekas · 2021-07-23T13:28:53Z

I'm fine keeping it now that we have it.

kbond · 2021-07-23T15:14:43Z

I've updated/added tests and improved the deprecation layer:

Symfony 5.4 with PHP < 8, everything works as it does currently (no deprecation warnings).
Symfony 5.4 with PHP > 8 and using the trait on a class w/o any methods marked with the SubscribedService attribute, works as it does currently but a deprecation warning is triggered.
Symfony 5.4 with PHP > 8 and using the trait on a class with at least one method marked with the SubscribedService attribute, you've opted-into the new functionality (methods w/o the attribute are ignored).

kbond · 2021-07-23T15:37:13Z

I could use some direction on fixing the remaining CI errors.

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

kbond · 2021-10-20T13:37:55Z

Assuming this is still wanted for 5.4, once merged, I'll work on a PR to drop the deprecation layer in 6.0.

Still need a bit of direction for fixing the tests. I believe it's a dependency issue, symfony/dependency-injection is requiring the wrong version of symfony/service-contracts.

nicolas-grekas

ideally tests on DI should work on all versions of contracts, or be skipped on non-supported ones

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

src/Symfony/Contracts/Service/Attribute/SubscribedService.php

kbond · 2021-10-20T15:31:05Z

I believe all related tests are now passing. I fixed some pslam issues but don't understand the remaining ones.

nicolas-grekas

one last non-trivial note :)

src/Symfony/Contracts/Service/Attribute/SubscribedService.php

nicolas-grekas · 2021-10-20T15:35:02Z

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

+                    throw new \LogicException(sprintf('Cannot use "%s" on methods without a return type in "%s::%s()".', SubscribedService::class, $method->name, self::class));
+                }
+
+                $services[$attribute->newInstance()->key ?? self::class.'::'.$method->name] = '?'.$returnType->getName();


this should likely do $returnType instanceof \ReflectionNamedType ? ->getName() : (string) for the last part.

also, when the attribute is used, I'm not sure about the ? prefix. Shouldn't we add it only when the type is nullable? (and remove |null from the string representation of the union)

this should likely do $returnType instanceof \ReflectionNamedType ? ->getName() : (string) for the last part.

Like this?

$services[$attribute->newInstance()->key ?? self::class.'::'.$method->name] = '?'.($returnType instanceof \ReflectionNamedType ? $returnType->getName() : $returnType);

I just realized ReflectionType::__toString is deprecated.. Should we be relying on this?

also, when the attribute is used, I'm not sure about the ? prefix. Shouldn't we add it only when the type is nullable? (and remove |null from the string representation of the union)

Good call, I'll make this change. Should I leave the BC layer as is?

I've made these changes (let me know if you'd like me to backport this to the BC layer).

I'm not sure how to handle union/intersection types. See #42238 (comment).

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

nicolas-grekas

(with minor comments)

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php

…rrent `ServiceSubscriberTrait` usage

nicolas-grekas · 2021-10-27T13:22:58Z

Thank you @kbond.

kbond · 2021-10-27T13:30:29Z

Great, once this makes its way into the 6.0 branch, I'll remove the deprecation layer.

nicolas-grekas · 2021-10-27T13:34:23Z

now merged up to 6.0

…precation layer (kbond) This PR was merged into the 6.0 branch. Discussion ---------- [DependencyInjection] remove `ServiceSubscriberTrait` deprecation layer | Q | A | ------------- | --- | Branch? | 6.0 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | Followup to #42238 | License | MIT | Doc PR | TODO This removes the deprecation layer we added in #42238. Commits ------- 4a6226d [DependencyInjection] remove ServiceSubscriberTrait deprecation layer

carsonbot added Status: Needs Review Bug DependencyInjection Deprecation Feature RFC RFC = Request For Comments (proposals about features that you want to be discussed) labels Jul 23, 2021

carsonbot changed the title ~~[RFC][DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage~~ [DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage Jul 23, 2021

kbond force-pushed the service-subscriber-fix branch from 796f455 to 9baa209 Compare July 23, 2021 12:54

weaverryan reviewed Jul 23, 2021

View reviewed changes

stof reviewed Jul 23, 2021

View reviewed changes

kbond force-pushed the service-subscriber-fix branch 2 times, most recently from 07877ad to fee84f7 Compare July 23, 2021 15:04

kbond force-pushed the service-subscriber-fix branch from fee84f7 to 4306aaa Compare July 23, 2021 15:27

chalasr removed Bug RFC RFC = Request For Comments (proposals about features that you want to be discussed) labels Jul 26, 2021

OskarStark changed the title ~~[DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage~~ [DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage Aug 1, 2021

OskarStark reviewed Aug 1, 2021

View reviewed changes

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php Outdated Show resolved Hide resolved

chalasr added this to the 5.4 milestone Aug 6, 2021

kbond force-pushed the service-subscriber-fix branch 2 times, most recently from 54535f1 to 1cbc600 Compare September 8, 2021 12:37

nicolas-grekas reviewed Oct 20, 2021

View reviewed changes

kbond force-pushed the service-subscriber-fix branch 3 times, most recently from 7afa27c to 716b275 Compare October 20, 2021 15:14

nicolas-grekas reviewed Oct 20, 2021

View reviewed changes

src/Symfony/Contracts/Service/Attribute/SubscribedService.php Outdated Show resolved Hide resolved

kbond force-pushed the service-subscriber-fix branch from 716b275 to a5bb886 Compare October 20, 2021 15:30

nicolas-grekas reviewed Oct 20, 2021

View reviewed changes

kbond force-pushed the service-subscriber-fix branch from a5bb886 to 2fa213f Compare October 20, 2021 15:53

nicolas-grekas approved these changes Oct 27, 2021

View reviewed changes

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php Outdated Show resolved Hide resolved

src/Symfony/Contracts/Service/ServiceSubscriberTrait.php Show resolved Hide resolved

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 27, 2021

kbond force-pushed the service-subscriber-fix branch from f045e22 to 3cef7b7 Compare October 27, 2021 12:48

[DependencyInjection] Add SubscribedService attribute, deprecate cu…

4a7aa8e

…rrent `ServiceSubscriberTrait` usage

nicolas-grekas force-pushed the service-subscriber-fix branch from 3cef7b7 to 4a7aa8e Compare October 27, 2021 13:22

nicolas-grekas merged commit 2771d6e into symfony:5.4 Oct 27, 2021

nicolas-grekas mentioned this pull request Oct 27, 2021

[DependencyInjection] Add SubscribedService attribute, deprecate curr… symfony/symfony-docs#16013

Closed

kbond deleted the service-subscriber-fix branch October 27, 2021 13:28

kbond mentioned this pull request Oct 27, 2021

[DependencyInjection] remove ServiceSubscriberTrait deprecation layer #43783

Merged

This was referenced Nov 3, 2021

ServiceSubscriberTrait doesn't fully support PHP8 union types #43913

Closed

[DependencyInjection] only allow ReflectionNamedType for ServiceSubscriberTrait #43922

Merged

This was referenced Nov 5, 2021

Release v5.4.0-BETA1 #43937

Merged

Release v6.0.0-BETA1 #43939

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage #42238

[DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage #42238

kbond commented Jul 23, 2021 •

edited

Loading

weaverryan left a comment

stof Jul 23, 2021

kbond Jul 23, 2021

derrabus Oct 20, 2021

kbond Oct 20, 2021

derrabus Oct 20, 2021

kbond Oct 20, 2021 •

edited

Loading

derrabus Oct 20, 2021

stof commented Jul 23, 2021

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Jul 23, 2021 •

edited

Loading

stof commented Jul 23, 2021

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021 •

edited

Loading

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Oct 20, 2021

nicolas-grekas left a comment

kbond commented Oct 20, 2021

nicolas-grekas left a comment

nicolas-grekas Oct 20, 2021

kbond Oct 20, 2021

kbond Oct 20, 2021

nicolas-grekas left a comment

nicolas-grekas commented Oct 27, 2021

kbond commented Oct 27, 2021

nicolas-grekas commented Oct 27, 2021

[DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage #42238

[DependencyInjection] Add SubscribedService attribute, deprecate current ServiceSubscriberTrait usage #42238

Conversation

kbond commented Jul 23, 2021 • edited Loading

weaverryan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbond Oct 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Jul 23, 2021

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Jul 23, 2021 • edited Loading

stof commented Jul 23, 2021

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021 • edited Loading

nicolas-grekas commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Jul 23, 2021

kbond commented Oct 20, 2021

nicolas-grekas left a comment

Choose a reason for hiding this comment

kbond commented Oct 20, 2021

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Oct 27, 2021

kbond commented Oct 27, 2021

nicolas-grekas commented Oct 27, 2021

[DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage #42238

[DependencyInjection] Add `SubscribedService` attribute, deprecate current `ServiceSubscriberTrait` usage #42238

kbond commented Jul 23, 2021 •

edited

Loading

kbond Oct 20, 2021 •

edited

Loading

kbond commented Jul 23, 2021 •

edited

Loading

kbond commented Jul 23, 2021 •

edited

Loading