NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

[DependencyInjection] Fix TaggedLocator attribute without indexAttribute argument#42019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

nicolas-grekas merged 1 commit intosymfony:5.3fromlbae:tagged-locator-indexes-fix

Jul 10, 2021

Merged

[DependencyInjection] Fix TaggedLocator attribute without indexAttribute argument#42019

nicolas-grekas merged 1 commit intosymfony:5.3fromlbae:tagged-locator-indexes-fix

Jul 10, 2021

Conversation

Copy link

Contributor

lbae commentedJul 7, 2021

Q	A
Branch?	5.3
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets
License	MIT
Doc PR

The new TaggedLocator attribute does not index services correctly without theindexAttribute argument

Example

publicfunction__construct(    #[TaggedLocator('app.tag')]ServiceLocator$serviceLocator) {// ...}

Expected

$serviceLocator->getProvidedServices();// [//    "App\Service1" => "..."//    "App\Service2" => "..."// ]$serviceLocator->has(App\Service1::class);// true$serviceLocator->get(App\Service1::class);// Instance of App\Service1

Actual

$services =$serviceLocator->getProvidedServices();// [//    0 => [...]//    1 => [...]// ]$serviceLocator->has(App\Service1::class);// false$serviceLocator->get(App\Service1::class);// Exception

Same issue with ContainerInterface instead of ServiceLocator

Proposed solution

This fix allows services to be indexed by their fully qualified name instead of a numeric index ifindexAttribute argument is not provided.

The solution is oriented towards the implemenation in the YamlFileLoader (Symfony\Component\DependencyInjection\Loader\YamlFileLoader). The YamlFileLoader fulfills the expected behaviour above:

// Symfony\Component\DependencyInjection\Loader\YamlFileLoader// Line 850$forLocator ='tagged_locator' ===$value->getTag();// ...// Line 857$argument =newTaggedIteratorArgument($argument['tag'],$argument['index_by'] ??null,$argument['default_index_method'] ??null,$forLocator,$argument['default_priority_method'] ??null);

[DependencyInjection] Fix TaggedLocator attribute without index argument

0499fff

With this fix, services in service locators are indexed by their fully qualified name instead of a numeric index if `indexAttribute` argument is not provided

lbae requested a review fromdunglas as acode owner

July 7, 2021 15:43

carsonbot added Status: Needs Review Bug DependencyInjection labels

Jul 7, 2021

carsonbot added this to the5.3 milestone

Jul 7, 2021

Copy link

carsonbot commentedJul 7, 2021

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has acontribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (seehttps://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (seehttps://symfony.com/releases)
Features and deprecations must be submitted against the 5.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot