feature #22098 [*Bundle] Add autowiring aliases for common services (nicolas-grekas)

fabpot · fabpot · commit 5e9c7bb3f29b · 2017-03-21T14:56:35.000-07:00
This PR was merged into the 3.3-dev branch.

Discussion
----------

[*Bundle] Add autowiring aliases for common services

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

As spotted while working on #22060, we're missing many aliases to prevent any autowiring ambiguities.
I also removed the "Symfony\Component\EventDispatcher\EventDispatcher" and "Symfony\Component\DependencyInjection\Container" aliases: we'd better encourage using the corresponding interfaces instead.
On ControllerTrait, we need to type hint against SessionInterface, because otherwise, when session support is disabled, autowiring still auto-registers an "autowired.Session" service, which defeats the purpose of being able to enable/disable it.

Commits
-------

08c2ee32f1 [*Bundle] Add autowiring aliases for common services
diff --git a/Controller/ControllerTrait.php b/Controller/ControllerTrait.php
@@ -23,6 +23,7 @@
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\ResponseHeaderBag;
 use Symfony\Component\HttpFoundation\Session\Session;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
@@ -76,12 +77,9 @@ protected function getSerializer(): SerializerInterface
     }
 
     /**
-     * An instance of the Session implementation (and not the interface) is returned because getFlashBag is not part of
-     * the interface.
-     *
      * @required
      */
-    protected function getSession(): Session
+    protected function getSession(): SessionInterface
     {
     }
 
@@ -235,7 +233,11 @@ protected function file($file, string $fileName = null, string $disposition = Re
      */
     protected function addFlash(string $type, string $message)
     {
-        $this->getSession()->getFlashBag()->add($type, $message);
+        $session = $this->getSession();
+        if (!$session instanceof Session) {
+            throw new \LogicException(sprintf('You can not use the addFlash method: "%s" is not an instance of "%s".', get_class($session), Session::class));
+        }
+        $session->getFlashBag()->add($type, $message);
     }
 
     /**
@@ -245,8 +247,6 @@ protected function addFlash(string $type, string $message)
      * @param mixed $object     The object
      *
      * @return bool
-     *
-     * @throws \LogicException
      */
     protected function isGranted($attributes, $object = null): bool
     {
@@ -396,8 +396,6 @@ protected function createFormBuilder($data = null, array $options = array()): Fo
      *
      * @return mixed
      *
-     * @throws \LogicException If SecurityBundle is not available
-     *
      * @see TokenInterface::getUser()
      */
     protected function getUser()
diff --git a/Resources/config/assets.xml b/Resources/config/assets.xml
@@ -10,6 +10,7 @@
             <argument type="service" id="assets.empty_package" /> <!-- default package -->
             <argument type="collection" /> <!-- named packages -->
         </service>
+        <service id="Symfony\Component\Asset\Packages" alias="assets.packages" public="false" />
 
         <service id="assets.empty_package" class="Symfony\Component\Asset\Package" public="false">
             <argument type="service" id="assets.empty_version_strategy" />
diff --git a/Resources/config/debug_prod.xml b/Resources/config/debug_prod.xml
@@ -26,5 +26,6 @@
         <service id="debug.file_link_formatter" class="Symfony\Component\HttpKernel\Debug\FileLinkFormatter" public="false">
             <argument>%debug.file_link_format%</argument>
         </service>
+        <service id="Symfony\Component\HttpKernel\Debug\FileLinkFormatter" alias="debug.file_link_formatter" public="false" />
     </services>
 </container>
diff --git a/Resources/config/form.xml b/Resources/config/form.xml
@@ -7,6 +7,7 @@
     <services>
         <!-- ResolvedFormTypeFactory -->
         <service id="form.resolved_type_factory" class="Symfony\Component\Form\ResolvedFormTypeFactory" />
+        <service id="Symfony\Component\Form\ResolvedFormTypeFactoryInterface" alias="form.resolved_type_factory" public="false" />
 
         <!-- FormRegistry -->
         <service id="form.registry" class="Symfony\Component\Form\FormRegistry">
@@ -21,12 +22,14 @@
             </argument>
             <argument type="service" id="form.resolved_type_factory" />
         </service>
+        <service id="Symfony\Component\Form\FormRegistryInterface" alias="form.registry" public="false" />
 
         <!-- FormFactory -->
         <service id="form.factory" class="Symfony\Component\Form\FormFactory">
             <argument type="service" id="form.registry" />
             <argument type="service" id="form.resolved_type_factory" />
         </service>
+        <service id="Symfony\Component\Form\FormFactoryInterface" alias="form.factory" public="false" />
 
         <!-- DependencyInjectionExtension -->
         <service id="form.extension" class="Symfony\Component\Form\Extension\DependencyInjection\DependencyInjectionExtension" public="false">
diff --git a/Resources/config/identity_translator.xml b/Resources/config/identity_translator.xml
@@ -7,6 +7,7 @@
         <service id="translator" class="Symfony\Component\Translation\IdentityTranslator">
             <argument type="service" id="translator.selector" />
         </service>
+        <service id="Symfony\Component\Translation\TranslatorInterface" alias="translator" public="false" />
 
         <service id="translator.selector" class="Symfony\Component\Translation\MessageSelector" public="false" />
     </services>
diff --git a/Resources/config/property_access.xml b/Resources/config/property_access.xml
@@ -10,5 +10,6 @@
             <argument /> <!-- throwExceptionOnInvalidIndex, set by the extension -->
             <argument type="service" id="cache.property_access" on-invalid="ignore" />
         </service>
+        <service id="Symfony\Component\PropertyAccess\PropertyAccessorInterface" alias="property_accessor" public="false" />
     </services>
 </container>
diff --git a/Resources/config/property_info.xml b/Resources/config/property_info.xml
@@ -11,6 +11,7 @@
             <argument type="collection" />
             <argument type="collection" />
         </service>
+        <service id="Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface" alias="property_info" public="false" />
 
         <!-- Extractor -->
         <service id="property_info.reflection_extractor" class="Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor" public="false">
diff --git a/Resources/config/routing.xml b/Resources/config/routing.xml
@@ -80,6 +80,9 @@
         </service>
 
         <service id="router" alias="router.default" />
+        <service id="Symfony\Component\Routing\RouterInterface" alias="router" public="false" />
+        <service id="Symfony\Component\Routing\Generator\UrlGeneratorInterface" alias="router" public="false" />
+        <service id="Symfony\Component\Routing\Matcher\UrlMatcherInterface" alias="router" public="false" />
 
         <service id="router.request_context" class="Symfony\Component\Routing\RequestContext" public="false">
             <argument>%router.request_context.base_url%</argument>
@@ -89,6 +92,7 @@
             <argument>%request_listener.http_port%</argument>
             <argument>%request_listener.https_port%</argument>
         </service>
+        <service id="Symfony\Component\Routing\RequestContext" alias="router.request_context" public="false" />
 
         <service id="router.cache_warmer" class="Symfony\Bundle\FrameworkBundle\CacheWarmer\RouterCacheWarmer" public="false">
             <tag name="kernel.cache_warmer" />
diff --git a/Resources/config/security_csrf.xml b/Resources/config/security_csrf.xml
@@ -6,14 +6,17 @@
 
     <services>
         <service id="security.csrf.token_generator" class="Symfony\Component\Security\Csrf\TokenGenerator\UriSafeTokenGenerator" public="false" />
+        <service id="Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface" alias="security.csrf.token_generator" public="false" />
 
         <service id="security.csrf.token_storage" class="Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage" public="false">
             <argument type="service" id="session" />
         </service>
+        <service id="Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface" alias="security.csrf.token_storage" public="false" />
 
         <service id="security.csrf.token_manager" class="Symfony\Component\Security\Csrf\CsrfTokenManager">
             <argument type="service" id="security.csrf.token_generator" />
             <argument type="service" id="security.csrf.token_storage" />
         </service>
+        <service id="Symfony\Component\Security\Csrf\CsrfTokenManagerInterface" alias="security.csrf.token_manager" public="false" />
     </services>
 </container>
diff --git a/Resources/config/serializer.xml b/Resources/config/serializer.xml
@@ -14,6 +14,11 @@
             <argument type="collection" />
             <argument type="collection" />
         </service>
+        <service id="Symfony\Component\Serializer\SerializerInterface" alias="serializer" public="false" />
+        <service id="Symfony\Component\Serializer\NormalizerInterface" alias="serializer" public="false" />
+        <service id="Symfony\Component\Serializer\DenormalizerInterface" alias="serializer" public="false" />
+        <service id="Symfony\Component\Serializer\EncoderInterface" alias="serializer" public="false" />
+        <service id="Symfony\Component\Serializer\DecoderInterface" alias="serializer" public="false" />
 
         <service id="serializer.property_accessor" alias="property_accessor" public="false" />
 
@@ -27,6 +32,7 @@
             <!-- Run after all custom normalizers -->
             <tag name="serializer.normalizer" priority="-1000" />
         </service>
+        <service id="Symfony\Component\Serializer\Normalizer\ObjectNormalizer" alias="serializer.normalizer.object" public="false" />
 
         <service id="serializer.denormalizer.array" class="Symfony\Component\Serializer\Normalizer\ArrayDenormalizer" public="false">
             <!-- Run before the object normalizer -->
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -9,16 +9,17 @@
             <argument type="service" id="service_container" />
         </service>
         <service id="Symfony\Component\EventDispatcher\EventDispatcherInterface" alias="event_dispatcher" public="false" />
-        <service id="Symfony\Component\EventDispatcher\EventDispatcher" alias="event_dispatcher" public="false" />
 
         <service id="http_kernel" class="Symfony\Component\HttpKernel\HttpKernel">
             <argument type="service" id="event_dispatcher" />
             <argument type="service" id="controller_resolver" />
             <argument type="service" id="request_stack" />
             <argument type="service" id="argument_resolver" />
         </service>
+        <service id="Symfony\Component\HttpKernel\HttpKernelInterface" alias="http_kernel" public="false" />
 
         <service id="request_stack" class="Symfony\Component\HttpFoundation\RequestStack" />
+        <service id="Symfony\Component\HttpFoundation\RequestStack" alias="request_stack" public="false" />
 
         <service id="cache_warmer" class="Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate">
             <argument type="collection" />
@@ -41,8 +42,10 @@
         </service>
 
         <service id="kernel" synthetic="true" />
+        <service id="Symfony\Component\HttpKernel\KernelInterface" alias="kernel" public="false" />
 
         <service id="filesystem" class="Symfony\Component\Filesystem\Filesystem" />
+        <service id="Symfony\Component\Filesystem\Filesystem" alias="filesystem" public="false" />
 
         <service id="file_locator" class="Symfony\Component\HttpKernel\Config\FileLocator">
             <argument type="service" id="kernel" />
@@ -51,6 +54,7 @@
                 <argument>%kernel.root_dir%</argument>
             </argument>
         </service>
+        <service id="Symfony\Component\HttpKernel\Config\FileLocator" alias="file_locator" public="false" />
 
         <service id="uri_signer" class="Symfony\Component\HttpKernel\UriSigner">
             <argument>%kernel.secret%</argument>
diff --git a/Resources/config/session.xml b/Resources/config/session.xml
@@ -15,6 +15,10 @@
             <argument type="service" id="session.flash_bag" />
         </service>
 
+        <service id="Symfony\Component\HttpFoundation\Session\SessionInterface" alias="session" public="false" />
+        <service id="Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface" alias="session.storage" public="false" />
+        <service id="SessionHandlerInterface" alias="session.handler" public="false" />
+
         <service id="session.storage.metadata_bag" class="Symfony\Component\HttpFoundation\Session\Storage\MetadataBag" public="false">
             <argument>%session.metadata.storage_key%</argument>
             <argument>%session.metadata.update_threshold%</argument>
diff --git a/Resources/config/validator.xml b/Resources/config/validator.xml
@@ -13,6 +13,7 @@
         <service id="validator" class="Symfony\Component\Validator\Validator\ValidatorInterface">
             <factory service="validator.builder" method="getValidator" />
         </service>
+        <service id="Symfony\Component\Validator\Validator\ValidatorInterface" alias="validator" public="false" />
 
         <service id="validator.builder" class="Symfony\Component\Validator\ValidatorBuilderInterface">
             <factory class="Symfony\Component\Validator\Validation" method="createValidatorBuilder" />
diff --git a/Resources/config/workflow.xml b/Resources/config/workflow.xml
@@ -22,6 +22,7 @@
         <service id="workflow.marking_store.single_state" class="Symfony\Component\Workflow\MarkingStore\SingleStateMarkingStore" abstract="true" />
 
         <service id="workflow.registry" class="Symfony\Component\Workflow\Registry" />
+        <service id="Symfony\Component\Workflow\Registry" alias="workflow.registry" public="false" />
 
         <service id="workflow.twig_extension" class="Symfony\Bridge\Twig\Extension\WorkflowExtension">
             <argument type="service" id="workflow.registry" />

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`use Symfony\Component\HttpFoundation\RedirectResponse;`
`24`	`24`	`use Symfony\Component\HttpFoundation\ResponseHeaderBag;`
`25`	`25`	`use Symfony\Component\HttpFoundation\Session\Session;`
	`26`	`+use Symfony\Component\HttpFoundation\Session\SessionInterface;`
`26`	`27`	`use Symfony\Component\HttpFoundation\StreamedResponse;`
`27`	`28`	`use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;`
`28`	`29`	`use Symfony\Component\HttpKernel\HttpKernelInterface;`
`@@ -76,12 +77,9 @@ protected function getSerializer(): SerializerInterface`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`/**`
`79`		`- * An instance of the Session implementation (and not the interface) is returned because getFlashBag is not part of`
`80`		`- * the interface.`
`81`		`- *`
`82`	`80`	`* @required`
`83`	`81`	`*/`
`84`		`- protected function getSession(): Session`
	`82`	`+ protected function getSession(): SessionInterface`
`85`	`83`	`{`
`86`	`84`	`}`
`87`	`85`
`@@ -235,7 +233,11 @@ protected function file($file, string $fileName = null, string $disposition = Re`
`235`	`233`	`*/`
`236`	`234`	`protected function addFlash(string $type, string $message)`
`237`	`235`	`{`
`238`		`- $this->getSession()->getFlashBag()->add($type, $message);`
	`236`	`+ $session = $this->getSession();`
	`237`	`+ if (!$session instanceof Session) {`
	`238`	`+ throw new \LogicException(sprintf('You can not use the addFlash method: "%s" is not an instance of "%s".', get_class($session), Session::class));`
	`239`	`+ }`
	`240`	`+ $session->getFlashBag()->add($type, $message);`
`239`	`241`	`}`
`240`	`242`
`241`	`243`	`/**`
`@@ -245,8 +247,6 @@ protected function addFlash(string $type, string $message)`
`245`	`247`	`* @param mixed $object The object`
`246`	`248`	`*`
`247`	`249`	`* @return bool`
`248`		`- *`
`249`		`- * @throws \LogicException`
`250`	`250`	`*/`
`251`	`251`	`protected function isGranted($attributes, $object = null): bool`
`252`	`252`	`{`
`@@ -396,8 +396,6 @@ protected function createFormBuilder($data = null, array $options = array()): Fo`
`396`	`396`	`*`
`397`	`397`	`* @return mixed`
`398`	`398`	`*`
`399`		`- * @throws \LogicException If SecurityBundle is not available`
`400`		`- *`
`401`	`399`	`* @see TokenInterface::getUser()`
`402`	`400`	`*/`
`403`	`401`	`protected function getUser()`