[DI] Deprecate autowiring-types in favor of aliases #21494

nicolas-grekas · 2017-02-01T14:29:42Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#21351, #19970, ~~#18040~~, ~~#17783~~
License	MIT
Doc PR	symfony/symfony-docs#7445

https://github.com/symfony/symfony/pull/21494/files?w=1
This PR deprecates autowiring-types and replaces them by plain aliases.
ping @dunglas @weaverryan

Eg instead of

<service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false">
    <autowiring-type>Doctrine\Common\Annotations\Reader</autowiring-type>
</service>

just do:

<service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false" />
<service id="Doctrine\Common\Annotations\Reader" alias="annotations.reader" public="false" />

weaverryan · 2017-02-01T15:46:56Z

@nicolas-grekas Haha... I really like this simplification... but I don't understand how it works! :) Is there some significance to the service id matching the autowired interface? Otherwise... I would still expect that if I had 10 services for an interface (e.g. LoggerInterface)... that now it would simply appear that I would have 11 services for that interface. Clearly, I'm missing something ;)

nicolas-grekas · 2017-02-01T15:50:06Z

It is very simple: if there is a service named "Foo\BarInterface", then that's the one, when looking to wire a "Foo\BarInterface" type hint.

ogizanagi · 2017-02-01T15:47:31Z

UPGRADE-3.3.md

@@ -14,6 +14,8 @@ Debug
 DependencyInjection
 -------------------

+ * Autoriwing-types have been deprecated, use aliases instead.


Shouldn't we add an example here?

indeed, the example from the pr desc fi

example added

stof · 2017-02-01T16:07:47Z

this is a very elegant solution to the problem, allowing to use third-party services to autowire a type (as your alias can point to any service), and forbidding to explicitly configure the same autowired type twice for different services (as service ids are unique).

So 👍 for me.

chalasr · 2017-02-01T17:03:29Z

Far simpler 👍

dunglas · 2017-02-01T17:04:55Z

Great! 👍

weaverryan · 2017-02-01T18:04:10Z

Ha, I missed the change to AutowirePass. Of course, it makes sense! We'll need a docs issue so we can update things.

👍

stof · 2017-02-01T18:11:17Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/TemplatingPass.php

-            $definition = $container->findDefinition('templating');
-            $definition->setAutowiringTypes(array(ComponentEngineInterface::class, FrameworkBundleEngineInterface::class));
+            $container->setAlias(ComponentEngineInterface::class, 'templating');
+            $container->setAlias(FrameworkBundleEngineInterface::class, 'templating');


this should be private aliases. We don't want to keep these service names in the compiled container

stof · 2017-02-01T18:11:42Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml

        </service>
+        <service id="Symfony\Component\EventDispatcher\EventDispatcherInterface" alias="event_dispatcher" />
+        <service id="Symfony\Component\EventDispatcher\EventDispatcher" alias="event_dispatcher" />


these should be private aliases

stof · 2017-02-01T18:12:27Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml

-            <autowiring-type>Symfony\Component\DependencyInjection\ContainerInterface</autowiring-type>
-            <autowiring-type>Symfony\Component\DependencyInjection\Container</autowiring-type>
-        </service>
+        <service id="service_container" synthetic="true" />


shouldn't this one be removed entirely ? The component already handles it

stof · 2017-02-01T18:12:40Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml

-        </service>
+        <service id="service_container" synthetic="true" />
+        <service id="Symfony\Component\DependencyInjection\ContainerInterface" alias="service_container" />
+        <service id="Symfony\Component\DependencyInjection\Container" alias="service_container" />


these aliases should be private

stof · 2017-02-01T18:14:35Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml

        </service>
+        <service id="Symfony\Component\Translation\TranslatorInterface" alias="translator.default" />


the alias should be translator IMO instead, so that autowiring injects the real translator when using decoration. Otherwise, we loose the profiler integration when using autowiring and someone decorates the main translator alias rather than the private service.

And this alias should also be private (as any alias created purely for autowiring purpose anyway)

stof · 2017-02-01T18:16:08Z

UPGRADE-3.3.md

@@ -14,6 +14,23 @@ Debug
 DependencyInjection
 -------------------

+ * Autoriwing-types have been deprecated, use aliases instead.


stof · 2017-02-01T18:16:14Z

UPGRADE-4.0.md

@@ -24,6 +24,23 @@ Debug
 DependencyInjection
 -------------------

+ * Autoriwing-types have been removed, use aliases instead.


nicolas-grekas · 2017-02-01T18:43:50Z

@stof comments addressed, thanks

stof · 2017-02-01T18:47:35Z

btw, my comment about using private aliases for this is also true for the documentation when writing it

weaverryan · 2017-02-01T20:02:34Z

Docs issue created - I added a note on there about your (Stof) "private aliases" comment.

fabpot · 2017-02-01T20:54:27Z

Thank you @nicolas-grekas.

@dunglas

…icolas-grekas) This PR was merged into the 3.3-dev branch. Discussion ---------- [DI] Deprecate autowiring-types in favor of aliases | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #21351, #19970, ~~#18040~~, ~~#17783~~ | License | MIT | Doc PR | symfony/symfony-docs#7445 https://github.com/symfony/symfony/pull/21494/files?w=1 This PR deprecates autowiring-types and replaces them by plain aliases. ping @dunglas @weaverryan Eg instead of ```xml <service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false"> <autowiring-type>Doctrine\Common\Annotations\Reader</autowiring-type> </service> ``` just do: ```xml <service id="annotations.reader" class="Doctrine\Common\Annotations\AnnotationReader" public="false" /> <service id="Doctrine\Common\Annotations\Reader" alias="annotations.reader" public="false" /> ``` Commits ------- b11d391 [DI] Deprecate autowiring-types in favor of aliases

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

@nicolas-grekas shouldn't this be back-ported to 2.8? Autowiring has been introduced there and IIRC there is autowiring-types there as well. It would allow people to never use autowiring-types in the first place and it could be considered as a bug rather than a feature.

chalasr · 2017-02-01T21:15:53Z

@theofidry from semver:

Minor version Y (x.Y.z | x > 0)
It MUST be incremented if any public API functionality is marked as deprecated

dunglas · 2017-02-01T21:17:52Z

@theofidry I don't think so. People using 2.8 LTS should not be annoyed with a deprecation in a patch version. It works well as is. This improvement is really a new feature.

theofidry · 2017-02-01T21:20:00Z

fair enough

sstok · 2017-02-21T13:06:18Z


```
Using the attribute "class" is deprecated for the service "2_d44d409a6f8ec9217d33bfd752130a5a50dfdd4314933b690caf9278e3ece37c" which is defined as an alias in "/[..]/rollerworks/search-bundle/src/DependencyInjection/../Resources/config/search_processor.xml". Allowed attributes for service aliases are "alias", "id" and "public". The XmlFileLoader will raise an exception in Symfony 4.0, instead of silently ignoring unsupported attributes: 1x
    1x in SearchProcessorTest::testEmptySearchCodeIsValid from Rollerworks\Bundle\SearchBundle\Tests\Functional
```

Never mind 🙈 class !== id 😅

chalasr · 2017-02-21T13:11:01Z

@sstok Using public aliases works fine on my side. The exception message make me think it's unrelated. Maybe open an issue showing the failing service definition (from search_processor.xml)?

sstok · 2017-02-21T13:12:01Z

I used class instead of id for the class 🙂

<service class="Rollerworks\Bundle\SearchBundle\Processor\SearchProcessor" alias="rollerworks_search.http_foundation_search_processor" public="false" />

Should be

<service id="Rollerworks\Bundle\SearchBundle\Processor\SearchProcessor" alias="rollerworks_search.http_foundation_search_processor" public="false" />

nicolas-grekas added this to the 3.3 milestone Feb 1, 2017

carsonbot added Status: Needs Review DependencyInjection Feature Deprecation labels Feb 1, 2017

nicolas-grekas added this to In Progress in Lower entry bar Feb 1, 2017

nicolas-grekas moved this from In Progress to In Review in Lower entry bar Feb 1, 2017

nicolas-grekas force-pushed the di-autow-type-deprec branch from 4366566 to c3e73db Compare February 1, 2017 14:59

ogizanagi reviewed Feb 1, 2017

View reviewed changes

nicolas-grekas force-pushed the di-autow-type-deprec branch from c3e73db to 78c9141 Compare February 1, 2017 16:33

stof requested changes Feb 1, 2017

View reviewed changes

[DI] Deprecate autowiring-types in favor of aliases

b11d391

nicolas-grekas force-pushed the di-autow-type-deprec branch from 78c9141 to b11d391 Compare February 1, 2017 18:43

stof approved these changes Feb 1, 2017

View reviewed changes

weaverryan mentioned this pull request Feb 1, 2017

[DI] autowiring-types deprecated in place of aliases symfony/symfony-docs#7445

Closed

fabpot merged commit b11d391 into symfony:master Feb 1, 2017

nicolas-grekas mentioned this pull request Feb 1, 2017

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

Closed

nicolas-grekas moved this from In Review to Done in Lower entry bar Feb 1, 2017

nicolas-grekas deleted the di-autow-type-deprec branch February 1, 2017 23:23

nicolas-grekas mentioned this pull request Feb 2, 2017

[DI] Implement PSR-11 #21265

Merged

5 tasks

nicolas-grekas mentioned this pull request Feb 14, 2017

[FrameworkBundle] Support autowiring for RouterInterface #19972

Closed

theofidry mentioned this pull request Feb 27, 2017

[DI][Autowiring] autowiring-types & FQCN #21772

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

TomasVotruba mentioned this pull request Jul 24, 2022

[ConfigTransformer] Add suport for autowiring_types deprecated-packages/symplify#4249

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI] Deprecate autowiring-types in favor of aliases #21494

[DI] Deprecate autowiring-types in favor of aliases #21494

nicolas-grekas commented Feb 1, 2017 •

edited by weaverryan

weaverryan commented Feb 1, 2017

nicolas-grekas commented Feb 1, 2017 •

edited

ogizanagi Feb 1, 2017

fabpot Feb 1, 2017

nicolas-grekas Feb 1, 2017

stof commented Feb 1, 2017

chalasr commented Feb 1, 2017

dunglas commented Feb 1, 2017

weaverryan commented Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

stof Feb 1, 2017

nicolas-grekas commented Feb 1, 2017

stof commented Feb 1, 2017

weaverryan commented Feb 1, 2017

fabpot commented Feb 1, 2017

theofidry commented Feb 1, 2017

chalasr commented Feb 1, 2017

dunglas commented Feb 1, 2017 •

edited

theofidry commented Feb 1, 2017

sstok commented Feb 21, 2017 •

edited

chalasr commented Feb 21, 2017

sstok commented Feb 21, 2017 •

edited

		</service>
		<service id="Symfony\Component\Translation\TranslatorInterface" alias="translator.default" />

[DI] Deprecate autowiring-types in favor of aliases #21494

[DI] Deprecate autowiring-types in favor of aliases #21494

Conversation

nicolas-grekas commented Feb 1, 2017 • edited by weaverryan

weaverryan commented Feb 1, 2017

nicolas-grekas commented Feb 1, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Feb 1, 2017

chalasr commented Feb 1, 2017

dunglas commented Feb 1, 2017

weaverryan commented Feb 1, 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

nicolas-grekas commented Feb 1, 2017

stof commented Feb 1, 2017

weaverryan commented Feb 1, 2017

fabpot commented Feb 1, 2017

theofidry commented Feb 1, 2017

chalasr commented Feb 1, 2017

dunglas commented Feb 1, 2017 • edited

theofidry commented Feb 1, 2017

sstok commented Feb 21, 2017 • edited

chalasr commented Feb 21, 2017

sstok commented Feb 21, 2017 • edited

nicolas-grekas commented Feb 1, 2017 •

edited by weaverryan

nicolas-grekas commented Feb 1, 2017 •

edited

dunglas commented Feb 1, 2017 •

edited

sstok commented Feb 21, 2017 •

edited

sstok commented Feb 21, 2017 •

edited