minor #49788 [DependencyInjection] Add container.excluded tag on classes autodiscovered but excluded (Tiriel)

nicolas-grekas · nicolas-grekas · commit fdbd4c16b901 · 2023-03-28T14:36:16.000+02:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [DependencyInjection] Add container.excluded tag on classes autodiscovered but excluded Add container.excluded tag on classes autodiscovered but excluded by `#[Exclude]` or `#[When]` attributes | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #49764 | License | MIT | Doc PR | - As per ticket, adding `container.excluded` tag on classes autodiscovered but excluded by one of the two attributes. Commits ------- c1fa81d [DependencyInjection] Add container.excluded tag on classes autodiscovered but excluded
diff --git a/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php
@@ -126,6 +126,7 @@ public function registerClasses(Definition $prototype, string $namespace, string
             if (null === $errorMessage && $autoconfigureAttributes) {
                 $r = $this->container->getReflectionClass($class);
                 if ($r->getAttributes(Exclude::class)[0] ?? null) {
+                    $this->addContainerExcludedTag($class, $source);
                     continue;
                 }
                 if ($this->env) {
@@ -137,6 +138,7 @@ public function registerClasses(Definition $prototype, string $namespace, string
                         }
                     }
                     if (null !== $attribute) {
+                        $this->addContainerExcludedTag($class, $source);
                         continue;
                     }
                 }
@@ -291,18 +293,29 @@ private function findClasses(string $namespace, string $pattern, array $excludeP
         }
 
         if (null !== $prefixLen) {
-            $attributes = null !== $source ? ['source' => sprintf('in "%s/%s"', basename(\dirname($source)), basename($source))] : [];
-
             foreach ($excludePaths as $path => $_) {
                 $class = $namespace.ltrim(str_replace('/', '\\', substr($path, $prefixLen, str_ends_with($path, '.php') ? -4 : null)), '\\');
-                if (!$this->container->has($class)) {
-                    $this->container->register($class)
-                        ->setAbstract(true)
-                        ->addTag('container.excluded', $attributes);
-                }
+                $this->addContainerExcludedTag($class, $source);
             }
         }
 
         return $classes;
     }
+
+    private function addContainerExcludedTag(string $class, ?string $source): void
+    {
+        if ($this->container->has($class)) {
+            return;
+        }
+
+        static $attributes = [];
+
+        if (null !== $source && !isset($attributes[$source])) {
+            $attributes[$source] = ['source' => sprintf('in "%s/%s"', basename(\dirname($source)), basename($source))];
+        }
+
+        $this->container->register($class)
+            ->setAbstract(true)
+            ->addTag('container.excluded', null !== $source ? $attributes[$source] : []);
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/FileLoaderTest.php
@@ -161,7 +161,7 @@ public function testRegisterClassesWithExcludeAttribute(bool $autoconfigure)
             'Utils/*',
         );
 
-        $this->assertSame(!$autoconfigure, $container->hasDefinition(NotAService::class));
+        $this->assertSame($autoconfigure, $container->getDefinition(NotAService::class)->hasTag('container.excluded'));
     }
 
     public function testRegisterClassesWithExcludeAsArray()
@@ -284,10 +284,10 @@ public static function excludeTrailingSlashConsistencyProvider(): iterable
     }
 
     /**
-     * @testWith ["prod", true]
-     *           ["dev", true]
-     *           ["bar", false]
-     *           [null, true]
+     * @testWith ["prod", false]
+     *           ["dev", false]
+     *           ["bar", true]
+     *           [null, false]
      */
     public function testRegisterClassesWithWhenEnv(?string $env, bool $expected)
     {
@@ -299,7 +299,7 @@ public function testRegisterClassesWithWhenEnv(?string $env, bool $expected)
             'Prototype/{Foo.php}'
         );
 
-        $this->assertSame($expected, $container->has(Foo::class));
+        $this->assertSame($expected, $container->getDefinition(Foo::class)->hasTag('container.excluded'));
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,7 @@ public function registerClasses(Definition $prototype, string $namespace, string`
`126`	`126`	`if (null === $errorMessage && $autoconfigureAttributes) {`
`127`	`127`	`$r = $this->container->getReflectionClass($class);`
`128`	`128`	`if ($r->getAttributes(Exclude::class)[0] ?? null) {`
	`129`	`+ $this->addContainerExcludedTag($class, $source);`
`129`	`130`	`continue;`
`130`	`131`	`}`
`131`	`132`	`if ($this->env) {`
`@@ -137,6 +138,7 @@ public function registerClasses(Definition $prototype, string $namespace, string`
`137`	`138`	`}`
`138`	`139`	`}`
`139`	`140`	`if (null !== $attribute) {`
	`141`	`+ $this->addContainerExcludedTag($class, $source);`
`140`	`142`	`continue;`
`141`	`143`	`}`
`142`	`144`	`}`
`@@ -291,18 +293,29 @@ private function findClasses(string $namespace, string $pattern, array $excludeP`
`291`	`293`	`}`
`292`	`294`
`293`	`295`	`if (null !== $prefixLen) {`
`294`		`- $attributes = null !== $source ? ['source' => sprintf('in "%s/%s"', basename(\dirname($source)), basename($source))] : [];`
`295`		`-`
`296`	`296`	`foreach ($excludePaths as $path => $_) {`
`297`	`297`	`$class = $namespace.ltrim(str_replace('/', '\\', substr($path, $prefixLen, str_ends_with($path, '.php') ? -4 : null)), '\\');`
`298`		`- if (!$this->container->has($class)) {`
`299`		`- $this->container->register($class)`
`300`		`- ->setAbstract(true)`
`301`		`- ->addTag('container.excluded', $attributes);`
`302`		`- }`
	`298`	`+ $this->addContainerExcludedTag($class, $source);`
`303`	`299`	`}`
`304`	`300`	`}`
`305`	`301`
`306`	`302`	`return $classes;`
`307`	`303`	`}`
	`304`	`+`
	`305`	`+ private function addContainerExcludedTag(string $class, ?string $source): void`
	`306`	`+ {`
	`307`	`+ if ($this->container->has($class)) {`
	`308`	`+ return;`
	`309`	`+ }`
	`310`	`+`
	`311`	`+ static $attributes = [];`
	`312`	`+`
	`313`	`+ if (null !== $source && !isset($attributes[$source])) {`
	`314`	`+ $attributes[$source] = ['source' => sprintf('in "%s/%s"', basename(\dirname($source)), basename($source))];`
	`315`	`+ }`
	`316`	`+`
	`317`	`+ $this->container->register($class)`
	`318`	`+ ->setAbstract(true)`
	`319`	`+ ->addTag('container.excluded', null !== $source ? $attributes[$source] : []);`
	`320`	`+ }`
`308`	`321`	`}`