[Autowiring] Add interface FQCN as a valid service name to avoid collisions #21132

theofidry · 2017-01-02T13:47:59Z

Q	A
Branch?	master? (not sure)
Bug fix?	yes/no (not sure)
New feature?	yes
BC breaks?	possibly
Deprecations?	no
Tests pass?	yes
Fixed tickets	none
License	MIT
Doc PR	TODO

As of now, if you have:

interface CollisionInterface {}

class A implements CollisionInterface {}

class UseCollision
{
  function __construct(CollisionInterface $collision) {}
}

services:
  app.a:
    class: A
    autowire: true

  app.b:
    class: A

  CollisionInterface: '@app.b'

  app.use_collision:
    class: UseCollision
    autowire: true

It would fail, because you have app.a and app.b which are both implementing CollisionInterface. However as you can see, in this scenario this is a bit stupid, as if you bother doing CollisionInterface: '@app.b', this is equivalent to (or rather should be IMO) have:

services:
  #...

  app.b:
    class: A
    autowired_types: [ CollisionInterface ]

You might wonder what's the diff and why bother yourself with that, the diff IMO is the location of your service definitions. For example I may try to follow a more DDD oriented architecture, e.g. the hexagonal architecture, where I have:

config/
  domain.yml # service definitions related to the domain layer
  infrastructure.yml # service definitions related to the infrastructure layer

src/
  Domain/
    CollisionInterface.php
  Infrastructure/
    A.php
    UseCollision.php

and try to have something like:

# config/domain.yml
services:
  App\Domain\CollisionInterface: '@app.b'

# config/infrastructure.yml
  app.a:
    class: A
    autowire: true

  app.b:
    class: A

  app.use_collision:
    class: UseCollision
    autowire: true

I am not sure if this can be caused any BC and if this should be considered as a feature or a bugfix.

/cc @dunglas

GuilhemN · 2017-01-02T17:21:08Z

Sounds hard to support without having a dedicated system in ContainerBuilder. For example we can't support the following using the current autowiring types system as the service is not yet defined:

services:
  CollisionInterface: '@app.b'

  app.a:
    class: A
    autowire: true

  app.b:
    class: A

  app.use_collision:
    class: UseCollision
    autowire: true

dunglas · 2017-01-03T08:01:09Z

Shouldn't we deprecate the autowiring_types key to only use the `CollisionInterface: '@app.b' syntax now?

dunglas · 2017-01-03T08:03:19Z

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

@@ -338,11 +338,15 @@ private function set($type, $id)
     */
    private function createAutowiredDefinition(\ReflectionClass $typeHint, $id)
    {
-        if (isset($this->ambiguousServiceTypes[$typeHint->name])) {
+        if (isset($this->ambiguousServiceTypes[$typeHintName = $typeHint->name])) {


Why is necessary to create the $typeHintName variable? It makes the code harder to read for no benefit over using the prop directly.

dunglas · 2017-01-03T08:05:19Z

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

+    {
+        $container = new ContainerBuilder();
+
+        $container->register('c1', __NAMESPACE__.'\CollisionA');


You can use CollisionA::class for Symfony 3+. Same of lines below.

theofidry · 2017-01-03T09:14:29Z

Shouldn't we deprecate the autowiring_types key to only use the `CollisionInterface: '@app.b' syntax now?

I'm for it, but should it be done here or another PR? Also should this be merged in master or an older branch?

theofidry · 2017-01-03T09:19:10Z

@GuilhemN I'm not sure to understand your concern, all services are registered being process that way so the order does not matter.

GuilhemN · 2017-01-03T17:44:45Z

@theofidry oops, I didn't realize it was a PR and I was thinking you'll try to implement it otherwise... 😐

LGTM 👍 I'm also for deprecating the autowiring_types key.

theofidry · 2017-01-06T09:56:32Z

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

            $classOrInterface = $typeHint->isInterface() ? 'interface' : 'class';
            $matchingServices = implode(', ', $this->ambiguousServiceTypes[$typeHint->name]);

-            throw new RuntimeException(sprintf('Unable to autowire argument of type "%s" for the service "%s". Multiple services exist for this %s (%s).', $typeHint->name, $id, $classOrInterface, $matchingServices), 1);
+            throw new RuntimeException(sprintf('Unable to autowire argument of type "%s" for the service "%s". Multiple services exist for this %s (%s).', $typeHint->name, $id, $classOrInterface, $matchingServices));


needs to be reverted

theofidry · 2017-01-06T10:09:17Z

@dunglas updated, but I'm still unsure on which branch we should merge this as if we want to deprecate autowiring_types, it would need to be merged on the oldest possible, as you cannot do without autowiring_types without this PR.

nicolas-grekas · 2017-01-06T10:10:49Z

the deprecation part is for master for sure
so you may need to split this PR in two if a bug needs to be fixed in a lower branch

theofidry · 2017-01-06T10:12:22Z

@nicolas-grekas I'm actually not sure if this should be considered a feature or a bug (hence my question of which branch to target). The PR doesn't need to be split, deprecating autowiring_types is not done yet and I plan to do it in another PR.

dunglas · 2017-01-06T10:37:33Z

👍

GuilhemN · 2017-01-09T08:33:58Z

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

@@ -339,6 +339,10 @@ private function set($type, $id)
    private function createAutowiredDefinition(\ReflectionClass $typeHint, $id)
    {
        if (isset($this->ambiguousServiceTypes[$typeHint->name])) {
+            if ($this->container->has($typeHint->name)) {


Can't this be moved here to avoid building the map when not necessary?

Good point, gonna try

nicolas-grekas · 2017-02-01T20:59:57Z

Closing, see ##21494.

theofidry · 2017-02-01T21:02:22Z

Thanks :)

Add interface FQCN as a valid service name to avoid collisions

93f181d

carsonbot added Status: Needs Review Bug Feature labels Jan 2, 2017

nicolas-grekas added this to the 3.x milestone Jan 2, 2017

dunglas requested changes Jan 3, 2017

View reviewed changes

Address comments

6a8306f

theofidry commented Jan 6, 2017

View reviewed changes

Revert the change to the exception

24d3ff4

GuilhemN reviewed Jan 9, 2017

View reviewed changes

nicolas-grekas closed this Feb 1, 2017

theofidry deleted the bugfix/autowire-interface branch February 1, 2017 21:02

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Autowiring] Add interface FQCN as a valid service name to avoid collisions #21132

[Autowiring] Add interface FQCN as a valid service name to avoid collisions #21132

theofidry commented Jan 2, 2017

GuilhemN commented Jan 2, 2017

dunglas commented Jan 3, 2017

dunglas Jan 3, 2017

dunglas Jan 3, 2017

theofidry commented Jan 3, 2017

theofidry commented Jan 3, 2017 •

edited

Loading

GuilhemN commented Jan 3, 2017 •

edited

Loading

theofidry Jan 6, 2017

theofidry commented Jan 6, 2017

nicolas-grekas commented Jan 6, 2017

theofidry commented Jan 6, 2017 •

edited

Loading

dunglas commented Jan 6, 2017

GuilhemN Jan 9, 2017

theofidry Jan 9, 2017

nicolas-grekas commented Feb 1, 2017

theofidry commented Feb 1, 2017

[Autowiring] Add interface FQCN as a valid service name to avoid collisions #21132

[Autowiring] Add interface FQCN as a valid service name to avoid collisions #21132

Conversation

theofidry commented Jan 2, 2017

GuilhemN commented Jan 2, 2017

dunglas commented Jan 3, 2017

dunglas Jan 3, 2017

Choose a reason for hiding this comment

dunglas Jan 3, 2017

Choose a reason for hiding this comment

theofidry commented Jan 3, 2017

theofidry commented Jan 3, 2017 • edited Loading

GuilhemN commented Jan 3, 2017 • edited Loading

theofidry Jan 6, 2017

Choose a reason for hiding this comment

theofidry commented Jan 6, 2017

nicolas-grekas commented Jan 6, 2017

theofidry commented Jan 6, 2017 • edited Loading

dunglas commented Jan 6, 2017

GuilhemN Jan 9, 2017

Choose a reason for hiding this comment

theofidry Jan 9, 2017

Choose a reason for hiding this comment

nicolas-grekas commented Feb 1, 2017

theofidry commented Feb 1, 2017

theofidry commented Jan 3, 2017 •

edited

Loading

GuilhemN commented Jan 3, 2017 •

edited

Loading

theofidry commented Jan 6, 2017 •

edited

Loading