[FrameworkBundle] Add service and alias deprecation message to debug:container <name> output

Author: 94noni

CHANGELOG.md

@@ -10,6 +10,7 @@ CHANGELOG
    `Symfony\Component\Serializer\Normalizer\PropertyNormalizer` autowiring aliases, type-hint against
    `Symfony\Component\Serializer\Normalizer\NormalizerInterface` or implement `NormalizerAwareInterface` instead
  * Add service usages list to the `debug:container` command output
+ * Add service and alias deprecation message to `debug:container [<name>]` output
 
 6.1
 ---

Command/ContainerDebugCommand.php

@@ -166,6 +166,21 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         try {
             $helper->describe($io, $object, $options);
 
+            if ('txt' === $options['format'] && isset($options['id'])) {
+                if ($object->hasDefinition($options['id'])) {
+                    $definition = $object->getDefinition($options['id']);
+                    if ($definition->isDeprecated()) {
+                        $errorIo->warning($definition->getDeprecation($options['id'])['message'] ?? sprintf('The "%s" service is deprecated.', $options['id']));
+                    }
+                }
+                if ($object->hasAlias($options['id'])) {
+                    $alias = $object->getAlias($options['id']);
+                    if ($alias->isDeprecated()) {
+                        $errorIo->warning($alias->getDeprecation($options['id'])['message'] ?? sprintf('The "%s" alias is deprecated.', $options['id']));
+                    }
+                }
+            }
+
             if (isset($options['id']) && isset($kernel->getContainer()->getRemovedIds()[$options['id']])) {
                 $errorIo->note(sprintf('The "%s" service or alias has been removed or inlined when the container was compiled.', $options['id']));
             }

Console/Descriptor/JsonDescriptor.php

@@ -230,6 +230,13 @@ private function getContainerDefinitionData(Definition $definition, bool $omitTa
             'autoconfigure' => $definition->isAutoconfigured(),
         ];
 
+        if ($definition->isDeprecated()) {
+            $data['deprecated'] = true;
+            $data['deprecation_message'] = $definition->getDeprecation($id)['message'];
+        } else {
+            $data['deprecated'] = false;
+        }
+
         if ('' !== $classDescription = $this->getClassDescription((string) $definition->getClass())) {
             $data['description'] = $classDescription;
         }

Console/Descriptor/MarkdownDescriptor.php

@@ -211,6 +211,13 @@ protected function describeContainerDefinition(Definition $definition, array $op
             ."\n".'- Autoconfigured: '.($definition->isAutoconfigured() ? 'yes' : 'no')
         ;
 
+        if ($definition->isDeprecated()) {
+            $output .= "\n".'- Deprecated: yes';
+            $output .= "\n".'- Deprecation message: '.$definition->getDeprecation($options['id'])['message'];
+        } else {
+            $output .= "\n".'- Deprecated: no';
+        }
+
         if (isset($options['show_arguments']) && $options['show_arguments']) {
             $output .= "\n".'- Arguments: '.($definition->getArguments() ? 'yes' : 'no');
         }

Console/Descriptor/XmlDescriptor.php

@@ -341,6 +341,12 @@ private function getContainerDefinitionDocument(Definition $definition, string $
         $serviceXML->setAttribute('abstract', $definition->isAbstract() ? 'true' : 'false');
         $serviceXML->setAttribute('autowired', $definition->isAutowired() ? 'true' : 'false');
         $serviceXML->setAttribute('autoconfigured', $definition->isAutoconfigured() ? 'true' : 'false');
+        if ($definition->isDeprecated()) {
+            $serviceXML->setAttribute('deprecated', 'true');
+            $serviceXML->setAttribute('deprecation_message', $definition->getDeprecation($id)['message']);
+        } else {
+            $serviceXML->setAttribute('deprecated', 'false');
+        }
         $serviceXML->setAttribute('file', $definition->getFile() ?? '');
 
         $calls = $definition->getMethodCalls();

Tests/Fixtures/DeprecatedClass.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures;
+
+/**
+ * @deprecated
+ */
+class DeprecatedClass
+{
+}

Tests/Fixtures/Descriptor/alias_with_definition_1.json

@@ -12,6 +12,7 @@
         "abstract": true,
         "autowire": false,
         "autoconfigure": false,
+        "deprecated": false,
         "file": null,
         "factory_class": "Full\\Qualified\\FactoryClass",
         "factory_method": "get",

Tests/Fixtures/Descriptor/alias_with_definition_1.md

@@ -13,6 +13,7 @@
 - Abstract: yes
 - Autowired: no
 - Autoconfigured: no
+- Deprecated: no
 - Factory Class: `Full\Qualified\FactoryClass`
 - Factory Method: `get`
 - Usages: alias_1

Tests/Fixtures/Descriptor/alias_with_definition_1.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <alias id="alias_1" service="service_1" public="true"/>
-<definition id="service_1" class="Full\Qualified\Class1" public="true" synthetic="false" lazy="true" shared="true" abstract="true" autowired="false" autoconfigured="false" file="">
+<definition id="service_1" class="Full\Qualified\Class1" public="true" synthetic="false" lazy="true" shared="true" abstract="true" autowired="false" autoconfigured="false" deprecated="false" file="">
   <factory class="Full\Qualified\FactoryClass" method="get"/>
   <usages>
     <usage>alias_1</usage>

Tests/Fixtures/Descriptor/alias_with_definition_2.json

@@ -12,6 +12,7 @@
         "abstract": false,
         "autowire": false,
         "autoconfigure": false,
+        "deprecated": false,
         "file": "\/path\/to\/file",
         "factory_service": "factory.service",
         "factory_method": "get",