[DependencyInjection] Add `#[AutowireIterator]` attribute and improve `#[AutowireLocator]` #51832

nicolas-grekas · 2023-10-03T20:22:11Z

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	-
License	MIT

This PR is building on #51392 to add an #[AutowireIterator] attribute and improve #[AutowireLocator].

The new #[AutowireIterator] attribute can be used to describe what #[AutowireLocator] can do, except that we get an iterator instead of a container.

And #[AutowireLocator] can now be used instead of #[TaggedLocator]: #[AutowireLocator('foo')] and done.

In order to describe that you want a list of services, we cannot use named arguments anymore so we have to pass an array now: #[AutowireLocator(['foo' => 'F', 'bar' => 'B'])] should be used instead of #[AutowireLocator(foo: 'F', bar: 'B')].

Last but not least, this adds support for nesting SubscribedService objects in the list of described services. This provides feature-parity with what we can do when implementing ServiceSubscriberInterface.

I didn't deprecate TaggedIterator nor TaggedLocator. We could, but maybe we should wait for 7.1?

TODO:

add tests - thanks @kbond!

PS: while writing this, I realize that we may merge both tags in one, and let AutowirePass decide if it should build a locator or an iterator based on the type of the argument that has the attribute. We'd "just" need to find a name that'd work for that.

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php

nicolas-grekas · 2023-10-04T15:23:08Z

PR updated and ready. Big Hurray to @kbond for the tests 🙏 🤗

KerianMM · 2023-10-05T05:48:47Z

TaggedIterator and TaggedLocator attributes are they still use full?

nicolas-grekas · 2023-10-05T13:09:18Z

@KerianMM that's an open question. I see no hurry in deprecating them, I'd be fine waiting for 7.1.

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

stof · 2023-10-05T14:14:41Z

Why not improving the existing attributes instead of adding new ones ?

src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

nicolas-grekas · 2023-10-05T14:29:21Z

Why not improving the existing attributes instead of adding new ones ?

Because I think it's important to push the Autowire* convention. It helps discovering/remembering those autowiring-related attributes.

chalasr · 2023-10-05T15:07:11Z

I didn't deprecate TaggedIterator nor TaggedLocator. We could, but maybe we should wait for 7.1?

👍 to do it on 7.1 and give time to people having them since 5.3. The docs should probably recommend the new ones asap though

OskarStark · 2023-10-06T06:16:39Z

I updated the syntax for #[AutowireLocator]:

[DependencyInjection] Update syntax for #[AutowireLocator] and add #[AutowireIterator] symfony-docs#18993

OskarStark · 2023-10-06T06:18:47Z

Last but not least, this adds support for nesting SubscribedService objects in the list of described services. This provides feature-parity with what we can do when implementing ServiceSubscriberInterface.

Can you add a code example please? Thanks

nicolas-grekas · 2023-10-06T06:57:03Z

What's in ServiceSubscriberInterface:

symfony/src/Symfony/Contracts/Service/ServiceSubscriberInterface.php

Lines 53 to 57 in d27190a

    
                * additionally, an array of {@see SubscribedService}'s can be returned: 
        
                * 
        
                *  * [new SubscribedService('logger', Psr\Log\LoggerInterface::class)] 
        
                *  * [new SubscribedService(type: Psr\Log\LoggerInterface::class, nullable: true)] 
        
                *  * [new SubscribedService('http_client', HttpClientInterface::class, attributes: new Target('githubApi'))]

OskarStark · 2023-10-06T08:23:18Z

Updated

… `#[AutowireLocator]`

nicolas-grekas · 2023-10-06T09:41:53Z

Thank you @kbond.

…ator]` and add `#[AutowireIterator]` (OskarStark) This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [DependencyInjection] Update syntax for `#[AutowireLocator]` and add `#[AutowireIterator]` cc `@kbond` Waiting code merge * symfony/symfony#51832 Fixes #18997 Commits ------- 528cbda [DependencyInjection] Update syntax for `#[AutowireLocator]` and add `#[AutowireIterator]`

bendavies · 2023-10-11T10:52:13Z

src/Symfony/Component/HttpKernel/composer.json

@@ -63,6 +63,7 @@
        "symfony/http-client-contracts": "<2.5",
        "symfony/mailer": "<5.4",
        "symfony/messenger": "<5.4",
+        "symfony/service-contracts": "<3.2",


@kbond why was this added? is there a way to remove this conflict?

this makes it not possible for us to upgrade to symfony 6.4 because this forces a requirement for psr/container ^2.0, and we are still on v1 because the latest version of laminas/laminas-servicemanager requires v1:
https://github.com/laminas/laminas-servicemanager/blob/3.23.x/composer.json#L26

this is sort of the same issue as api-platform/core#5811

/cc @nicolas-grekas

Sorry @kbond, tagged you as it looked like your commit.

This is needed because the test case uses the $type argument of SubscribedService, which exists since 3.2.
PR welcome to change the test case and relax this.

bendavies · 2023-10-12T09:06:01Z

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

+
+            if ($type instanceof SubscribedService) {
+                $key = $type->key ?? $key;
+                $attributes = $type->attributes;


symfony/dependency-injection requires "symfony/service-contracts": "^2.5|^3.0, but attributes, nullable and type are not defined on SubscribedService in until 3.2.
is this a mistake?

…d `#[TaggedLocator]` (GromNaN) This PR was merged into the 7.1 branch. Discussion ---------- [DependencyInjection] Deprecate `#[TaggedIterator]` and `#[TaggedLocator]` | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | yes | Issues | Planned in #51832 | License | MIT `#[TaggedIterator]` and `#[TaggedLocator]` attributes are replaced by `#[AutowireIterator]` and `#[AutowireLocator]`, for naming consistency with all `#[Autowire*]` attributes. Commits ------- 4bc6bed Deprecate #[TaggedIterator] and #[TaggedLocator]

…#[TaggedLocator]` attributes (GromNaN) This PR was merged into the 8.0 branch. Discussion ---------- [DependencyInjection] Remove `#[TaggedIterator]` and `#[TaggedLocator]` attributes | Q | A | ------------- | --- | Branch? | 8.0 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT The new attributes `#[AutowireLocator]` and `#[AutowireIterator]` were introduced in Symfony 6.4 by #51392 and #51832. These replace the previous attributes `#[TaggedIterator]` and `#[TaggedLocator]` which were introduced in Symfony 5.4 by #40406 and subsequently deprecated in 7.1 by #54371 Commits ------- c096714 Remove TaggedIterator and TaggedLocator attributes

nicolas-grekas requested a review from dunglas as a code owner October 3, 2023 20:22

carsonbot added Status: Needs Review DependencyInjection Feature labels Oct 3, 2023

carsonbot added this to the 6.4 milestone Oct 3, 2023

nicolas-grekas added the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Oct 3, 2023

nicolas-grekas force-pushed the di-autowire-tagged branch from 8b9073c to ed3efda Compare October 3, 2023 20:53

kbond reviewed Oct 3, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Show resolved Hide resolved

kbond reviewed Oct 3, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php Outdated Show resolved Hide resolved

nicolas-grekas force-pushed the di-autowire-tagged branch 2 times, most recently from 17a9a15 to 8ed9318 Compare October 4, 2023 15:22

kbond approved these changes Oct 4, 2023

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 4, 2023

nicolas-grekas force-pushed the di-autowire-tagged branch 2 times, most recently from 7bb9a9e to 38c48ef Compare October 5, 2023 13:34

weaverryan approved these changes Oct 5, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Show resolved Hide resolved

GromNaN reviewed Oct 5, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Outdated Show resolved Hide resolved

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Show resolved Hide resolved

stof reviewed Oct 5, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php Outdated Show resolved Hide resolved

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Show resolved Hide resolved

chalasr reviewed Oct 5, 2023

View reviewed changes

src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php Show resolved Hide resolved

nicolas-grekas force-pushed the di-autowire-tagged branch from 38c48ef to c262b32 Compare October 5, 2023 14:26

chalasr approved these changes Oct 5, 2023

View reviewed changes

OskarStark mentioned this pull request Oct 6, 2023

[DependencyInjection] Update syntax for #[AutowireLocator] and add #[AutowireIterator] symfony/symfony-docs#18993

Merged

nicolas-grekas force-pushed the di-autowire-tagged branch from c262b32 to fe8d9dc Compare October 6, 2023 08:32

nicolas-grekas and others added 2 commits October 6, 2023 10:49

[DependencyInjection] Add #[AutowireIterator] attribute and improve…

78018de

… `#[AutowireLocator]`

[DependencyInjection] Add tests for AutowireLocator/AutowireIterator

a87f2e0

nicolas-grekas force-pushed the di-autowire-tagged branch from fe8d9dc to a87f2e0 Compare October 6, 2023 08:50

nicolas-grekas merged commit 95fa158 into symfony:6.4 Oct 6, 2023

nicolas-grekas mentioned this pull request Oct 6, 2023

[DependencyInjection] Add #[AutowireIterator] attribute and improve `… symfony/symfony-docs#18997

Closed

nicolas-grekas deleted the di-autowire-tagged branch October 6, 2023 09:42

bendavies reviewed Oct 11, 2023

View reviewed changes

bendavies reviewed Oct 12, 2023

View reviewed changes

xabbuh mentioned this pull request Oct 13, 2023

[DependencyInjection] increase lower bound of symfony/service-contracts #52042

Closed

This was referenced Oct 21, 2023

Release v6.4.0-BETA1 #52220

Merged

Release v7.0.0-BETA1 #52224

Merged

bendavies mentioned this pull request Dec 19, 2023

[Contracts] Allow psr/container 1.1 again #53150

Merged

GromNaN mentioned this pull request Mar 21, 2024

[DependencyInjection] Deprecate #[TaggedIterator] and #[TaggedLocator] #54371

Merged

GromNaN mentioned this pull request Jun 20, 2025

[DependencyInjection] Remove #[TaggedIterator] and #[TaggedLocator] attributes #60845

Merged

Uh oh!

[DependencyInjection] Add #[AutowireIterator] attribute and improve #[AutowireLocator] #51832

[DependencyInjection] Add #[AutowireIterator] attribute and improve #[AutowireLocator] #51832

Uh oh!

Conversation

nicolas-grekas commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Oct 4, 2023

Uh oh!

KerianMM commented Oct 5, 2023

Uh oh!

nicolas-grekas commented Oct 5, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stof commented Oct 5, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolas-grekas commented Oct 5, 2023

Uh oh!

chalasr commented Oct 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OskarStark commented Oct 6, 2023

Uh oh!

OskarStark commented Oct 6, 2023

Uh oh!

nicolas-grekas commented Oct 6, 2023

Uh oh!

OskarStark commented Oct 6, 2023

Uh oh!

nicolas-grekas commented Oct 6, 2023

Uh oh!

bendavies Oct 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kbond Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

bendavies Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

bendavies Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

bendavies Oct 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

[DependencyInjection] Add `#[AutowireIterator]` attribute and improve `#[AutowireLocator]` #51832

[DependencyInjection] Add `#[AutowireIterator]` attribute and improve `#[AutowireLocator]` #51832

nicolas-grekas commented Oct 3, 2023 •

edited

Loading

chalasr commented Oct 5, 2023 •

edited

Loading

bendavies Oct 11, 2023 •

edited

Loading

bendavies Oct 12, 2023 •

edited

Loading