bug #52805 [Routing] Fix conflicting FQCN aliases with route name (fancyweb)

nicolas-grekas · nicolas-grekas · commit 83d0106bdda0 · 2023-11-29T16:52:52.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [Routing] Fix conflicting FQCN aliases with route name | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | #52801 | License | MIT When the route name === the FQCN alias we want to add, `addAlias()` throws. In this case, we can safely ignore the exception and move on. Commits ------- 18494c8 [Routing] Fix conflicting FQCN aliases with route name
diff --git a/src/Symfony/Component/Routing/Loader/AttributeClassLoader.php b/src/Symfony/Component/Routing/Loader/AttributeClassLoader.php
@@ -144,7 +144,9 @@ public function load(mixed $class, string $type = null): RouteCollection
 
                 if (1 === $collection->count() - \count($routeNamesBefore)) {
                     $newRouteName = current(array_diff(array_keys($collection->all()), $routeNamesBefore));
-                    $collection->addAlias(sprintf('%s::%s', $class->name, $method->name), $newRouteName);
+                    if ($newRouteName !== $aliasName = sprintf('%s::%s', $class->name, $method->name)) {
+                        $collection->addAlias($aliasName, $newRouteName);
+                    }
                 }
             }
             if (0 === $collection->count() && $class->hasMethod('__invoke')) {
@@ -155,8 +157,14 @@ public function load(mixed $class, string $type = null): RouteCollection
                 }
             }
             if ($fqcnAlias && 1 === $collection->count()) {
-                $collection->addAlias($class->name, $invokeRouteName = key($collection->all()));
-                $collection->addAlias(sprintf('%s::__invoke', $class->name), $invokeRouteName);
+                $invokeRouteName = key($collection->all());
+                if ($invokeRouteName !== $class->name) {
+                    $collection->addAlias($class->name, $invokeRouteName);
+                }
+
+                if ($invokeRouteName !== $aliasName = sprintf('%s::__invoke', $class->name)) {
+                    $collection->addAlias($aliasName, $invokeRouteName);
+                }
             }
 
             if ($this->hasDeprecatedAnnotations) {
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/AnnotationFixtures/InvokableFQCNAliasConflictController.php b/src/Symfony/Component/Routing/Tests/Fixtures/AnnotationFixtures/InvokableFQCNAliasConflictController.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AnnotationFixtures;
+
+use Symfony\Component\Routing\Attribute\Route;
+
+/**
+ * @Route("/foobarccc", name="Symfony\Component\Routing\Tests\Fixtures\AnnotationFixtures\InvokableFQCNAliasConflictController")
+ */
+class InvokableFQCNAliasConflictController
+{
+    public function __invoke()
+    {
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/InvokableFQCNAliasConflictController.php b/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/InvokableFQCNAliasConflictController.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures;
+
+use Symfony\Component\Routing\Attribute\Route;
+
+#[Route(path: '/foobarccc', name: self::class)]
+class InvokableFQCNAliasConflictController
+{
+    public function __invoke()
+    {
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Loader/AttributeClassLoaderTestCase.php b/src/Symfony/Component/Routing/Tests/Loader/AttributeClassLoaderTestCase.php
@@ -86,6 +86,15 @@ public function testInvokableControllerLoader()
         $this->assertEquals(new Alias('lol'), $routes->getAlias($this->getNamespace().'\InvokableController::__invoke'));
     }
 
+    public function testInvokableFQCNAliasConflictController()
+    {
+        $routes = $this->loader->load($this->getNamespace().'\InvokableFQCNAliasConflictController');
+        $this->assertCount(1, $routes);
+        $this->assertEquals('/foobarccc', $routes->get($this->getNamespace().'\InvokableFQCNAliasConflictController')->getPath());
+        $this->assertNull($routes->getAlias($this->getNamespace().'\InvokableFQCNAliasConflictController'));
+        $this->assertEquals(new Alias($this->getNamespace().'\InvokableFQCNAliasConflictController'), $routes->getAlias($this->getNamespace().'\InvokableFQCNAliasConflictController::__invoke'));
+    }
+
     public function testInvokableMethodControllerLoader()
     {
         $routes = $this->loader->load($this->getNamespace().'\InvokableMethodController');

Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,9 @@ public function load(mixed $class, string $type = null): RouteCollection`
`144`	`144`
`145`	`145`	`if (1 === $collection->count() - \count($routeNamesBefore)) {`
`146`	`146`	`$newRouteName = current(array_diff(array_keys($collection->all()), $routeNamesBefore));`
`147`		`- $collection->addAlias(sprintf('%s::%s', $class->name, $method->name), $newRouteName);`
	`147`	`+ if ($newRouteName !== $aliasName = sprintf('%s::%s', $class->name, $method->name)) {`
	`148`	`+ $collection->addAlias($aliasName, $newRouteName);`
	`149`	`+ }`
`148`	`150`	`}`
`149`	`151`	`}`
`150`	`152`	`if (0 === $collection->count() && $class->hasMethod('__invoke')) {`
`@@ -155,8 +157,14 @@ public function load(mixed $class, string $type = null): RouteCollection`
`155`	`157`	`}`
`156`	`158`	`}`
`157`	`159`	`if ($fqcnAlias && 1 === $collection->count()) {`
`158`		`- $collection->addAlias($class->name, $invokeRouteName = key($collection->all()));`
`159`		`- $collection->addAlias(sprintf('%s::__invoke', $class->name), $invokeRouteName);`
	`160`	`+ $invokeRouteName = key($collection->all());`
	`161`	`+ if ($invokeRouteName !== $class->name) {`
	`162`	`+ $collection->addAlias($class->name, $invokeRouteName);`
	`163`	`+ }`
	`164`	`+`
	`165`	`+ if ($invokeRouteName !== $aliasName = sprintf('%s::__invoke', $class->name)) {`
	`166`	`+ $collection->addAlias($aliasName, $invokeRouteName);`
	`167`	`+ }`
`160`	`168`	`}`
`161`	`169`
`162`	`170`	`if ($this->hasDeprecatedAnnotations) {`