[DependencyInjection] Detect case mismatch in autowiring #25155

sroze · 2017-11-25T14:20:13Z

Q	A
Branch?	4.0
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#25122
License	MIT
Doc PR	ø

If there is a case-sensitive typo in the service injection, this will suggest the non-typoed version.

…g miss matching class.

sroze · 2017-11-25T14:23:07Z

Fabbot is complaining but is not correct here.

nicolas-grekas · 2017-11-26T11:03:47Z

src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php

@@ -343,6 +343,8 @@ private function createTypeAlternatives(TypedReference $reference)
            $message = sprintf('the existing "%s" service', $this->types[$type]);
        } elseif ($reference->getRequiringClass() && !$reference->canBeAutoregistered()) {
            return ' It cannot be auto-registered because it is from a different root namespace.';
+        } elseif (is_array($this->types) && (false !== $key = array_search(strtolower($type), array_map('strtolower', $this->types)))) {


I think the logic should be improved: this check should come first in the method, and should account for aliases.
It should also not rely on $this->types, but on the ids+aliases found in the container.

Why not types ? What's the difference? :)

autowiring is based on the id of services, not on their type. So if there is a case mismatch, it's at the id level, not at the type one.

Moving the check to the first of this if and using the $this->container->getServiceIds() instead of $this->types fails with the following example:

Symfony\Component\DependencyInjection\Tests\Compiler\AutowirePassTest::testDontUseAbstractServices
Cannot autowire service "bar": argument "$foo" of method "Symfony\Component\DependencyInjection\Tests\Compiler\Bar::__construct()" references class "Symfony\Component\DependencyInjection\Tests\Compiler\Foo" but this service is abstract. Do you mean "Symfony\Component\DependencyInjection\Tests\Compiler\Foo" ?

I guess we should add a "!$container->has()" check in the "if"

Simperfit · 2017-11-26T11:59:02Z

You are a test writer @sroze thanks for writing the test ;).

sroze · 2017-11-26T12:07:08Z

src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php

@@ -343,6 +343,8 @@ private function createTypeAlternatives(TypedReference $reference)
            $message = sprintf('the existing "%s" service', $this->types[$type]);
        } elseif ($reference->getRequiringClass() && !$reference->canBeAutoregistered()) {
            return ' It cannot be auto-registered because it is from a different root namespace.';
+        } elseif (is_array($this->types) && (false !== $key = array_search(strtolower($type), array_map('strtolower', $this->types)))) {
+            return sprintf(' Do you mean "%s" ?', $this->types[$key], $type);


What about: Maybe the typehint has a typo and should refer to "%s" instead? ?

Based on @nicolas-grekas' comment above... we can't change this to mention the typehint as it would also work for named services actually.

sroze · 2017-11-26T22:13:32Z

@nicolas-grekas updated 👍 (and fabbot is wrong)

nicolas-grekas · 2017-11-26T22:24:57Z

src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php

-        if (isset($this->ambiguousServiceTypes[$type])) {
+        $servicesAndAliases = $this->container->getServiceIds();
+        if (!$this->container->has($type) && false !== $key = array_search(strtolower($type), array_map('strtolower', $servicesAndAliases))) {
+            return sprintf(' Do you mean "%s" ?', $servicesAndAliases[$key], $type);


Space before "?" Should be removed. Also, what about using preg_grep?

Happy without the space for sure. preg_grep would be too much and we'd have find about all the escapes :/

chalasr · 2017-11-27T01:13:16Z

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

@@ -685,6 +685,24 @@ public function provideNotWireableCalls()
        );
    }

+    /**
+     * @expectedException \Symfony\Component\DependencyInjection\Exception\AutowiringFailedException
+     * @expectedExceptionMessage Cannot autowire service "foo": argument "$sam" of method "Symfony\Component\DependencyInjection\Tests\Compiler\NotWireable::setNotAutowireableBecauseOfATypo()" references class "Symfony\Component\DependencyInjection\Tests\Compiler\lesTilleuls" but no such service exists. Do you mean "Symfony\Component\DependencyInjection\Tests\Compiler\LesTilleuls" ?


extra space before question mark

hehe good point... updated 👍

xabbuh · 2017-11-27T13:51:26Z

src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php

-        if (isset($this->ambiguousServiceTypes[$type])) {
+        $servicesAndAliases = $this->container->getServiceIds();
+        if (!$this->container->has($type) && false !== $key = array_search(strtolower($type), array_map('strtolower', $servicesAndAliases))) {
+            return sprintf(' Did you mean "%s"?', $servicesAndAliases[$key], $type);


Once placeholder but two arguments for sprintf()?

@sroze could you please remove $type ?
After that I think the PR is mergeable ;).

Oh, good point, well spotted 👍

nicolas-grekas · 2017-11-30T14:33:17Z

Thank you @sroze.

…Simperfit, sroze) This PR was merged into the 4.0 branch. Discussion ---------- [DependencyInjection] Detect case mismatch in autowiring | Q | A | ------------- | --- | Branch? | 4.0 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #25122 | License | MIT | Doc PR | ø If there is a case-sensitive typo in the service injection, this will suggest the non-typoed version. Commits ------- 407f132 Test the suggestion of already registered services decaf23 [DependencyInjection] Add more information to the message when passing miss matching class.

[DependencyInjection] Add more information to the message when passin…

decaf23

…g miss matching class.

carsonbot added Status: Needs Review DependencyInjection Bug labels Nov 25, 2017

sroze force-pushed the detect-case-mismatch-in-auto-wiring branch 2 times, most recently from 45fbea5 to cdc3c9f Compare November 25, 2017 14:22

This was referenced Nov 25, 2017

[DependencyInjection][WIP] Add more information to the message when passin… #25136

Closed

[DIC][DX] Detect case mismatch in autowired service names #25122

Closed

nicolas-grekas added this to the 4.0 milestone Nov 26, 2017

nicolas-grekas reviewed Nov 26, 2017

View reviewed changes

sroze commented Nov 26, 2017

View reviewed changes

sroze force-pushed the detect-case-mismatch-in-auto-wiring branch from cdc3c9f to 55ef192 Compare November 26, 2017 22:12

nicolas-grekas reviewed Nov 26, 2017

View reviewed changes

sroze force-pushed the detect-case-mismatch-in-auto-wiring branch from 55ef192 to b57ad07 Compare November 26, 2017 22:30

carsonbot added Status: Reviewed and removed Status: Needs Review labels Nov 26, 2017

nicolas-grekas approved these changes Nov 26, 2017

View reviewed changes

chalasr reviewed Nov 27, 2017

View reviewed changes

sroze force-pushed the detect-case-mismatch-in-auto-wiring branch 2 times, most recently from 55eea2b to a6fa404 Compare November 27, 2017 09:52

nicolas-grekas approved these changes Nov 27, 2017

View reviewed changes

chalasr approved these changes Nov 27, 2017

View reviewed changes

Simperfit approved these changes Nov 27, 2017

View reviewed changes

xabbuh reviewed Nov 27, 2017

View reviewed changes

Test the suggestion of already registered services

407f132

sroze force-pushed the detect-case-mismatch-in-auto-wiring branch from a6fa404 to 407f132 Compare November 30, 2017 11:00

xabbuh approved these changes Nov 30, 2017

View reviewed changes

stof approved these changes Nov 30, 2017

View reviewed changes

nicolas-grekas approved these changes Nov 30, 2017

View reviewed changes

nicolas-grekas merged commit 407f132 into symfony:4.0 Nov 30, 2017

fabpot mentioned this pull request Nov 30, 2017

Release v4.0.0 #25224

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DependencyInjection] Detect case mismatch in autowiring #25155

[DependencyInjection] Detect case mismatch in autowiring #25155

sroze commented Nov 25, 2017 •

edited by nicolas-grekas

Loading

sroze commented Nov 25, 2017

nicolas-grekas Nov 26, 2017

sroze Nov 26, 2017

nicolas-grekas Nov 26, 2017

sroze Nov 26, 2017

nicolas-grekas Nov 26, 2017

Simperfit commented Nov 26, 2017

sroze Nov 26, 2017

sroze Nov 26, 2017

sroze commented Nov 26, 2017

nicolas-grekas Nov 26, 2017

sroze Nov 26, 2017

chalasr Nov 27, 2017

sroze Nov 27, 2017

xabbuh Nov 27, 2017

Simperfit Nov 30, 2017

sroze Nov 30, 2017

sroze Nov 30, 2017

nicolas-grekas commented Nov 30, 2017

[DependencyInjection] Detect case mismatch in autowiring #25155

[DependencyInjection] Detect case mismatch in autowiring #25155

Conversation

sroze commented Nov 25, 2017 • edited by nicolas-grekas Loading

sroze commented Nov 25, 2017

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

Simperfit commented Nov 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze commented Nov 26, 2017

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Nov 30, 2017

sroze commented Nov 25, 2017 •

edited by nicolas-grekas

Loading