Skip to content

[DependencyInjection] Fix autowiring collisions detection #21665

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 19, 2017

Conversation

GuilhemN
Copy link
Contributor

@GuilhemN GuilhemN commented Feb 18, 2017

Q A
Branch? 2.8
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets -
License MIT
Doc PR

Fixes #21658 by implementing the second proposal of #21658 (comment):

Another idea: store the types used previously and check that new services registered don't implement them.

@nicolas-grekas
Copy link
Member

The benefit here is simplicity, the drawback is that this won't work with setter autowiring, where instead of throwing, we skip. Can you try something on master also see if you can make this approach fit there or if we need v1?

@GuilhemN
Copy link
Contributor Author

GuilhemN commented Feb 18, 2017

@nicolas-grekas you're talking about the fact that an exception could be throw when using a setter, right? Imo this is a very weird case and I don't think we should take position here, I think it's better to throw an exception and let the user manually fix the issue. For example, should a service created for a constructor win against a setter?

@nicolas-grekas
Copy link
Member

My bad: on conflicts, an exception is always thrown even for setters, so should be good.
But the check should be done outside of the autowiring loop - any ambiguous type must throw - setter or not.

$classOrInterface = class_exists($type) ? 'class' : 'interface';
$matchingServices = implode(', ', $this->types[$type]);

throw new RuntimeException(sprintf('Unable to autowire argument of type "%s" for the service "%s". Multiple services exist for this %s (%s).', $type, $id, $classOrInterface, $matchingServices));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only the last service in which the type is used will be shown, would you prefer a list of all of them?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the last is enough to me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, let's keep it as is :)

@@ -44,6 +45,15 @@ public function process(ContainerBuilder $container)
$this->completeDefinition($id, $definition);
}
}

foreach ($this->usedTypes as $type => $id) {
if (isset($this->usedTypes[$type]) && isset($this->notGuessableTypes[$type])) {
Copy link
Member

@nicolas-grekas nicolas-grekas Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

&& !isset($this->definedTypes[$type])?

Copy link
Contributor Author

@GuilhemN GuilhemN Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was legit actually, that made me catch a bug (see #21670).

Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@fabpot
Copy link
Member

fabpot commented Feb 19, 2017

Thank you @GuilhemN.

@fabpot fabpot merged commit bb70472 into symfony:2.8 Feb 19, 2017
fabpot added a commit that referenced this pull request Feb 19, 2017
…(nicolas-grekas, GuilhemN)

This PR was merged into the 2.8 branch.

Discussion
----------

[DependencyInjection] Fix autowiring collisions detection

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        |

Fixes #21658 by implementing the second proposal of #21658 (comment):
> Another idea: store the types used previously and check that new services registered don't implement them.

Commits
-------

bb70472 [DependencyInjection] Fix autowiring collisions detection
6f578ee [DI] Bug in autowiring collisions detection
@GuilhemN GuilhemN deleted the AUTOWIRING branch February 19, 2017 16:11
@GuilhemN
Copy link
Contributor Author

Tell me if you need help to merge this in higher branches, it needs to be adapted (notGuessableTypes -> ambiguousServiceTypes, add getters autowiring support).

@fabpot
Copy link
Member

fabpot commented Feb 19, 2017

@GuilhemN Indeed, if you can submit a PR for higher branches, that would help. Thanks.

This was referenced Mar 6, 2017
fabpot added a commit that referenced this pull request Apr 3, 2017
…andidates (nicolas-grekas)

This PR was merged into the 2.8 branch.

Discussion
----------

[DI] Don't use auto-registered services to populate type-candidates

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no (every bug fix is a bc break, isn't it?)
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #22162, ~~#21658~~
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!--highly recommended for new features-->

Alternative to #22170 and ~~#21665~~.

The core issue fixed here is that auto-registered services should *not* be used as type-candidates.
The culprit is this line:
`$this->populateAvailableType($argumentId, $argumentDefinition);`

Doing so creates a series of wtf-issues (the linked ones), with no simple fixes (the linked PRs are just dealing with the simplest cases, but the real fix would require a reboot of autowiring for every newly discovered types.)

The other changes accommodate for the removal of the population of the `types` property, and fix a few other issues found along the way:
- variadic constructors
- empty strings injection
- tail args removal when they match the existing defaults

Commits
-------

992c677 [DI] Don't use auto-registered services to populate type-candidates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants