[DependencyInjection] Added information about deprecated aliases in debug:autowiring

Anthony MARTIN · Anthony MARTIN · commit 4b17a3b6080c · 2019-02-04T17:36:08.000+01:00
| Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | n/a Fix and improves a bit PR #29968 and #29995
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
    PHP's native `serialize()` and `unserialize()` functions. To use the
    original serialization method, set the `framework.messenger.serializer.id`
    config option to `messenger.transport.symfony_serializer`.
+ * Added information about deprecated aliases in `debug:autowiring` 
 
 4.2.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutowiringCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutowiringCommand.php
@@ -104,7 +104,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $serviceLine = sprintf('<fg=yellow>%s</>', $serviceId);
             if ($builder->hasAlias($serviceId)) {
                 $hasAlias[$serviceId] = true;
-                $serviceLine .= ' <fg=cyan>('.$builder->getAlias($serviceId).')</>';
+                $serviceAlias = $builder->getAlias($serviceId);
+                $serviceLine .= ' <fg=cyan>('.$serviceAlias.')</>';
+
+                if ($serviceAlias->isDeprecated()) {
+                    $serviceLine .= ' - <fg=magenta>deprecated</>';
+                }
             } elseif (!$all) {
                 continue;
             }
diff --git a/src/Symfony/Component/DependencyInjection/Alias.php b/src/Symfony/Component/DependencyInjection/Alias.php
@@ -125,6 +125,11 @@ public function getDeprecationMessage(string $id): string
         return str_replace('%alias_id%', $id, $this->deprecationTemplate ?: self::$defaultDeprecationTemplate);
     }
 
+    public function getDeprecationTemplate(): ?string
+    {
+        return $this->deprecationTemplate;
+    }
+
     /**
      * Returns the Id of this alias.
      *
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added `%env(trim:...)%` processor to trim a string value
  * added `%env(default:...)%` processor to fallback to a default value
+ * added support for deprecated aliases
 
 4.2.0
 -----
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveReferencesToAliasesPass.php
@@ -34,7 +34,10 @@ public function process(ContainerBuilder $container)
             $this->currentId = $id;
 
             if ($aliasId !== $defId = $this->getDefinitionId($aliasId, $container)) {
-                $container->setAlias($id, $defId)->setPublic($alias->isPublic())->setPrivate($alias->isPrivate());
+                $container->setAlias($id, $defId)
+                    ->setPublic($alias->isPublic())
+                    ->setPrivate($alias->isPrivate())
+                    ->setDeprecated($alias->isDeprecated(), $alias->getDeprecationTemplate());
             }
         }
     }
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php
@@ -227,6 +227,16 @@ private function addServiceAlias($alias, Alias $id, \DOMElement $parent)
         if (!$id->isPrivate()) {
             $service->setAttribute('public', $id->isPublic() ? 'true' : 'false');
         }
+
+        if ($id->isDeprecated()) {
+            $deprecated = $this->document->createElement('deprecated');
+            if ($id->getDeprecationTemplate()) {
+                $deprecated->nodeValue = $id->getDeprecationTemplate();
+            }
+
+            $service->appendChild($deprecated);
+        }
+
         $parent->appendChild($service);
     }
 
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -155,11 +155,13 @@ private function addService(string $id, Definition $definition): string
 
     private function addServiceAlias(string $alias, Alias $id): string
     {
+        $deprecated = $id->isDeprecated() ? sprintf("        deprecated: %s\n", $id->getDeprecationTemplate() ?: '') : '';
+
         if ($id->isPrivate()) {
-            return sprintf("    %s: '@%s'\n", $alias, $id);
+            return sprintf("    %s: '@%s'\n%s", $alias, $id, $deprecated);
         }
 
-        return sprintf("    %s:\n        alias: %s\n        public: %s\n", $alias, $id, $id->isPublic() ? 'true' : 'false');
+        return sprintf("    %s:\n        alias: %s\n        public: %s\n%s", $alias, $id, $id->isPublic() ? 'true' : 'false', $deprecated);
     }
 
     private function addServices(): string
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -354,7 +354,7 @@ private function parseDefinition($id, $service, $file, array $defaults)
                 }
 
                 if ('deprecated' === $key) {
-                    $alias->setDeprecated(true, $value);
+                    $alias->setDeprecated(true, \is_bool($value) ? null : $value);
                 }
             }
 

Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,11 @@ public function getDeprecationMessage(string $id): string`
`125`	`125`	`return str_replace('%alias_id%', $id, $this->deprecationTemplate ?: self::$defaultDeprecationTemplate);`
`126`	`126`	`}`
`127`	`127`
	`128`	`+ public function getDeprecationTemplate(): ?string`
	`129`	`+ {`
	`130`	`+ return $this->deprecationTemplate;`
	`131`	`+ }`
	`132`	`+`
`128`	`133`	`/**`
`129`	`134`	`* Returns the Id of this alias.`
`130`	`135`	`*`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,10 @@ public function process(ContainerBuilder $container)`
`34`	`34`	`$this->currentId = $id;`
`35`	`35`
`36`	`36`	`if ($aliasId !== $defId = $this->getDefinitionId($aliasId, $container)) {`
`37`		`- $container->setAlias($id, $defId)->setPublic($alias->isPublic())->setPrivate($alias->isPrivate());`
	`37`	`+ $container->setAlias($id, $defId)`
	`38`	`+ ->setPublic($alias->isPublic())`
	`39`	`+ ->setPrivate($alias->isPrivate())`
	`40`	`+ ->setDeprecated($alias->isDeprecated(), $alias->getDeprecationTemplate());`
`38`	`41`	`}`
`39`	`42`	`}`
`40`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -155,11 +155,13 @@ private function addService(string $id, Definition $definition): string`
`155`	`155`
`156`	`156`	`private function addServiceAlias(string $alias, Alias $id): string`
`157`	`157`	`{`
	`158`	`+ $deprecated = $id->isDeprecated() ? sprintf(" deprecated: %s\n", $id->getDeprecationTemplate() ?: '') : '';`
	`159`	`+`
`158`	`160`	`if ($id->isPrivate()) {`
`159`		`- return sprintf(" %s: '@%s'\n", $alias, $id);`
	`161`	`+ return sprintf(" %s: '@%s'\n%s", $alias, $id, $deprecated);`
`160`	`162`	`}`
`161`	`163`
`162`		`- return sprintf(" %s:\n alias: %s\n public: %s\n", $alias, $id, $id->isPublic() ? 'true' : 'false');`
	`164`	`+ return sprintf(" %s:\n alias: %s\n public: %s\n%s", $alias, $id, $id->isPublic() ? 'true' : 'false', $deprecated);`
`163`	`165`	`}`
`164`	`166`
`165`	`167`	`private function addServices(): string`
Original file line number	Diff line number	Diff line change
`@@ -354,7 +354,7 @@ private function parseDefinition($id, $service, $file, array $defaults)`
`354`	`354`	`}`
`355`	`355`
`356`	`356`	`if ('deprecated' === $key) {`
`357`		`- $alias->setDeprecated(true, $value);`
	`357`	`+ $alias->setDeprecated(true, \is_bool($value) ? null : $value);`
`358`	`358`	`}`
`359`	`359`	`}`
`360`	`360`