Ignore definitions bearing the container.excluded tag

Myks92 · chalasr · commit 2c668ba8a2fe · 2023-05-29T04:12:48.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
@@ -106,6 +106,9 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
             if ($service instanceof Alias) {
                 $data['aliases'][$serviceId] = $this->getContainerAliasData($service);
             } elseif ($service instanceof Definition) {
+                if ($service->hasTag('container.excluded')) {
+                    continue;
+                }
                 $data['definitions'][$serviceId] = $this->getContainerDefinitionData($service, $omitTags, $showArguments, $builder, $serviceId);
             } else {
                 $data['services'][$serviceId] = $service::class;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
@@ -162,6 +162,9 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
             if ($service instanceof Alias) {
                 $services['aliases'][$serviceId] = $service;
             } elseif ($service instanceof Definition) {
+                if ($service->hasTag('container.excluded')) {
+                    continue;
+                }
                 $services['definitions'][$serviceId] = $service;
             } else {
                 $services['services'][$serviceId] = $service;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -198,6 +198,10 @@ protected function describeContainerServices(ContainerBuilder $builder, array $o
             }
 
             if ($definition instanceof Definition) {
+                if ($definition->hasTag('container.excluded')) {
+                    unset($serviceIds[$key]);
+                    continue;
+                }
                 if ($showTag) {
                     $tags = $definition->getTag($showTag);
                     foreach ($tags as $tag) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@@ -294,6 +294,12 @@ private function getContainerServicesDocument(ContainerBuilder $builder, string
                 continue;
             }
 
+            if ($service instanceof Definition) {
+                if ($service->hasTag('container.excluded')) {
+                    continue;
+                }
+            }
+
             $serviceXML = $this->getContainerServiceDocument($service, $serviceId, null, $showArguments);
             $containerXML->appendChild($containerXML->ownerDocument->importNode($serviceXML->childNodes->item(0), true));
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ContainerExcluded.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/ContainerExcluded.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures;
+
+/**
+ * @author Maksim Vorozhtsov <myks1992@mail.ru>
+ */
+class ContainerExcluded
+{
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php
@@ -13,6 +13,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\BackslashClass;
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ContainerExcluded;
 use Symfony\Component\Console\Tester\ApplicationTester;
 use Symfony\Component\Console\Tester\CommandCompletionTester;
 
@@ -85,6 +86,19 @@ public function testDeprecatedServiceAndAlias()
         $this->assertStringContainsString('[WARNING] The "deprecated_alias" alias is deprecated since foo/bar 1.9 and will be removed in 2.0', $tester->getDisplay());
     }
 
+    public function testExcludedService()
+    {
+        static::bootKernel(['test_case' => 'ContainerDebug', 'root_config' => 'config.yml']);
+
+        $application = new Application(static::$kernel);
+        $application->setAutoExit(false);
+
+        $tester = new ApplicationTester($application);
+
+        $tester->run(['command' => 'debug:container']);
+        $this->assertStringNotContainsString(ContainerExcluded::class, $tester->getDisplay());
+    }
+
     /**
      * @dataProvider provideIgnoreBackslashWhenFindingService
      */
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/ContainerDebug/config.yml
@@ -33,3 +33,5 @@ services:
             - '%env(REAL)%'
             - '%env(int:key:2:json:JSON)%'
             - '%env(float:key:2:json:JSON)%'
+    Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ContainerExcluded:
+        tags: ['container.excluded']

Original file line number	Diff line number	Diff line change
`@@ -294,6 +294,12 @@ private function getContainerServicesDocument(ContainerBuilder $builder, string`
`294`	`294`	`continue;`
`295`	`295`	`}`
`296`	`296`
	`297`	`+ if ($service instanceof Definition) {`
	`298`	`+ if ($service->hasTag('container.excluded')) {`
	`299`	`+ continue;`
	`300`	`+ }`
	`301`	`+ }`
	`302`	`+`
`297`	`303`	`$serviceXML = $this->getContainerServiceDocument($service, $serviceId, null, $showArguments);`
`298`	`304`	`$containerXML->appendChild($containerXML->ownerDocument->importNode($serviceXML->childNodes->item(0), true));`
`299`	`305`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,12 @@ @@
 +<?php
++
 +declare(strict_types=1);
++
 +namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures;
++
 +/**
 + * @author Maksim Vorozhtsov <[email protected]>
 + */
 +class ContainerExcluded
 +{
 +}