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

[DI] [DX] Suggest what to do when container fails to autowire an inteface#22148

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

Closed

sustmi wants to merge1 commit intosymfony:masterfromsustmi:clarify-service-not-found-message-in-autowire-pass

Closed

[DI] [DX] Suggest what to do when container fails to autowire an inteface#22148

sustmi wants to merge1 commit intosymfony:masterfromsustmi:clarify-service-not-found-message-in-autowire-pass

Conversation

Copy link

Contributor

sustmi commentedMar 24, 2017•
edited
Loading

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

Lets consider this example files:

class Service1 {publicfunction__construct(MyInterface$my) {}}

class Service2implements MyInterface {}

If you have the serviceService2 defined beforeService1 in yourservices.yml file then everything is OK.
But if you haveService1 first andService2 second you will get the following exception:

[Symfony\Component\DependencyInjection\Exception\RuntimeException]Cannot autowire argument $my of method AppBundle\Model\Service1::__construct() for service "my_service1": No services were found matching the "AppBundle\Model\MyInterface" interface and it cannot be auto-registered.

Another example: The same happens if you do not haveService2 in yourservices.yml and you want to autowire this:

class Service3 {// Note that the interface is to be autowired before the service implementing the interfacepublicfunction__construct(MyInterface$my1,Service2$my2)}

After this PR the exception message changes to:

[Symfony\Component\DependencyInjection\Exception\RuntimeException]Cannot autowire argument $my1 of method AppBundle\Model\Service3::__construct() for service "my_service3": No services were found matching the "AppBundle\Model\MyInterface" interface and it cannot be auto-registered. Make sure that a service implementing "AppBundle\Model\MyInterface" interface is registered in the container before registering service "my_service3".

Notice the last sentence. It suggests the developer what is the common case for this mistake and what can be the solution.

UPDATE: The first described example actually does not cause any problem. Seehttps://github.com/sustmi/symfony-standard/tree/autowiring-order-dependent for another example that presents the problem.

carsonbot added Status: Needs Review DependencyInjection DXDX = Developer eXperience (anything that improves the experience of using Symfony) labels

Mar 24, 2017

sustmi force-pushed theclarify-service-not-found-message-in-autowire-pass branch from530541b to7052cc3Compare

March 24, 2017 13:34

Copy link

ContributorAuthor

sustmi commentedMar 24, 2017•
edited
Loading

(Sorry for the push-force. There were some typos. Now it should be OK.)

Copy link

Contributor

theofidry commentedMar 24, 2017

Isn't the autowiring pass ran much later to avoid those issues?

Copy link

Member

stof commentedMar 24, 2017

the order of service definition should not matter, as this code runs in a compiler pass, so after the whole file is loaded

Copy link

ContributorAuthor

sustmi commentedMar 24, 2017•
edited
Loading

In Symfony 3.2.6 the order of service definition matters. I tested it. You can try it on the examples I posted in PR.

Copy link

Contributor

theofidry commentedMar 24, 2017

@sustmi I'm using 3.2.6 and I don't have this issue. Could you try to reproduce it in a fork of the Standard Edition?

Copy link

Member

nicolas-grekas commentedMar 24, 2017

Can you please try#22135?
Does it fix your issue?

nicolas-grekas added this to the3.3 milestone

Mar 24, 2017

Copy link

ContributorAuthor

sustmi commentedMar 24, 2017•
edited
Loading

@theofidry: I am sorry, the example in the PR is probably a bad one.
However here is a branch with an evidence that autowiring does depend on order of definitions:https://github.com/sustmi/symfony-standard/tree/autowiring-order-dependent

Try running php bin/console server:run. It will fail to compile the container.
Then swap services in services.yml and try it again (str_trans before str_trans2). It will work.

Copy link

ContributorAuthor

sustmi commentedMar 24, 2017•
edited
Loading

@nicolas-grekas: When I run the new example (https://github.com/sustmi/symfony-standard/tree/autowiring-order-dependent) on Symfony 3.2.6 the error message is:

Unable to autowire argument of type "AppBundle\Model\RepositoryInterface" for the service "str_trans2". No services were found matching this interface and it cannot be auto-registered.

while when I update Symfony to your PR (d7557cf) the message is following:

Cannot autowire service "str_trans2": no services were found matching the "AppBundle\Model\RepositoryInterface" interface and it cannot be auto-registered for argument $myRepository of method AppBundle\Model\String\StringTransformer2::__construct().

Both does not tell anything that would make developer think about the order of definitions.
But I guess by the other comments that the dependency on order is more a bug than an undocumented feature.
Can anyone confirm that?

[DI] [DX] Suggest what to do when container fails to autowire an inte…

749d14e

…rfaceLets consider this example (two php files):---class Service1 {    public function __construct(MyInterface $my) ...}class Service2 implements MyInterface {}---If you have the service Service2 defined before Service1 in your services.yml file then everything is OK.But if you have Service1 first and Service2 second you will get the following exception:---[Symfony\Component\DependencyInjection\Exception\RuntimeException]Cannot autowire argument $my of method AppBundle\Model\Service1::__construct() for service "my_service1": No services were found matching the "AppBundle\Model\MyInterface" interface and it cannot be auto-registered.---The same happens if you do not have Service2 in your services.yml and you want to autowire this:---class Service3 {    // Note that the interface is to be autowired before the service implementing the interface    public function __construct(MyInterface $my1, Service2 $my2)}---After this commit the exception message changes to:---[Symfony\Component\DependencyInjection\Exception\RuntimeException]Cannot autowire argument $my1 of method AppBundle\Model\Service3::__construct() for service "my_service3": No services were found matching the "AppBundle\Model\MyInterface" interface and it cannot be auto-registered. Make sure that a service implementing "AppBundle\Model\MyInterface" interface is registered in the container before registering service "my_service3".---Notice the last sentence. It suggests the developer what is the common case for this mistake and what can be the solution.

sustmi force-pushed theclarify-service-not-found-message-in-autowire-pass branch from7052cc3 to749d14eCompare

March 24, 2017 23:40

Copy link

ContributorAuthor

sustmi commentedMar 24, 2017

Meanwhile I updated the PR for the current master.

Copy link

ContributorAuthor

sustmi commentedMar 25, 2017•
edited
Loading

To clarify the issue the problem with wrong order happens when DIC has to auto-register a class and not when all services are registered explicitly inservices.yml.

The working example (StringTransformer beforeStringTransformer2) has following flow:

AutowirePass processesStringTransformer
It finds that it has one dependency -MyRepository
It looks into definitions found inservices.yml and does not see this class
It auto-registersMyRepository and then resolves the dependency forStringTransformer
ThenAutowirePass processesStringTransformer2
It finds that it has one dependency -RepositoryInterface
It sees that there is an implementation of this interface already registered so it resolves the dependency

Thenot working example (StringTransformer2 beforeStringTransformer) has following flow:

AutowirePass processesStringTransformer2
It finds that it has one dependency -RepositoryInterface
It looks into definitions found inservices.yml and sees nothing that implementsRepositoryInterface so it fails (MyRepository was not auto-registered yet because no service depending on this class was processed yet).