[Routing] Fixed priority getting lost when defining prefix array

pritasil · pritasil · commit 5a1519e4a3a9 · 2023-12-06T12:21:18.000+01:00
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/Traits/PrefixTrait.php b/src/Symfony/Component/Routing/Loader/Configurator/Traits/PrefixTrait.php
@@ -29,20 +29,21 @@ final protected function addPrefix(RouteCollection $routes, string|array $prefix
             }
             foreach ($routes->all() as $name => $route) {
                 if (null === $locale = $route->getDefault('_locale')) {
+                    $priority = $routes->getPriority($name) ?? 0;
                     $routes->remove($name);
                     foreach ($prefix as $locale => $localePrefix) {
                         $localizedRoute = clone $route;
                         $localizedRoute->setDefault('_locale', $locale);
                         $localizedRoute->setRequirement('_locale', preg_quote($locale));
                         $localizedRoute->setDefault('_canonical_route', $name);
                         $localizedRoute->setPath($localePrefix.(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
-                        $routes->add($name.'.'.$locale, $localizedRoute);
+                        $routes->add($name.'.'.$locale, $localizedRoute, $priority);
                     }
                 } elseif (!isset($prefix[$locale])) {
                     throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $name, $locale));
                 } else {
                     $route->setPath($prefix[$locale].(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
-                    $routes->add($name, $route);
+                    $routes->add($name, $route, $routes->getPriority($name) ?? 0);
                 }
             }
 
diff --git a/src/Symfony/Component/Routing/RouteCollection.php b/src/Symfony/Component/Routing/RouteCollection.php
@@ -407,4 +407,9 @@ public function getAlias(string $name): ?Alias
     {
         return $this->aliases[$name] ?? null;
     }
+
+    public function getPriority(string $name): ?int
+    {
+        return $this->priorities[$name] ?? null;
+    }
 }
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/RouteWithPriorityController.php b/src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/RouteWithPriorityController.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures;
+
+use Symfony\Component\Routing\Attribute\Route;
+
+class RouteWithPriorityController
+{
+    #[Route(path: '/important', priority: 2)]
+    public function important()
+    {
+
+    }
+
+    #[Route(path: '/also-important', defaults: ['_locale' => 'cs'], priority: 1)]
+    public function alsoImportant()
+    {
+
+    }
+}
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/localized/localized-prefix.yml b/src/Symfony/Component/Routing/Tests/Fixtures/localized/localized-prefix.yml
@@ -0,0 +1,6 @@
+important_controllers:
+  resource: Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\RouteWithPriorityController
+  type: attribute
+  prefix:
+    cs: /cs
+    en: /en
diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -509,4 +509,24 @@ protected function configureRoute(Route $route, \ReflectionClass $class, \Reflec
         $this->assertSame('/my-prefix/my/route', $route->getPath());
         $this->assertSame(MyController::class.'::__invoke', $route->getDefault('_controller'));
     }
+
+    public function testPriorityWithPrefix()
+    {
+        new LoaderResolver([
+            $loader = new YamlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures/localized')),
+            new class() extends AttributeClassLoader {
+                protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, object $annot): void
+                {
+                    $route->setDefault('_controller', $class->getName().'::'.$method->getName());
+                }
+            },
+        ]);
+
+        $routes = $loader->load('localized-prefix.yml');
+
+        $r = new \ReflectionClass($routes);
+        $p = $r->getProperty('priorities');
+        $p->setAccessible(true);
+        $this->assertEquals([2, 2, 1], array_values($p->getValue($routes)));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -29,20 +29,21 @@ final protected function addPrefix(RouteCollection $routes, string\|array $prefix`
`29`	`29`	`}`
`30`	`30`	`foreach ($routes->all() as $name => $route) {`
`31`	`31`	`if (null === $locale = $route->getDefault('_locale')) {`
	`32`	`+ $priority = $routes->getPriority($name) ?? 0;`
`32`	`33`	`$routes->remove($name);`
`33`	`34`	`foreach ($prefix as $locale => $localePrefix) {`
`34`	`35`	`$localizedRoute = clone $route;`
`35`	`36`	`$localizedRoute->setDefault('_locale', $locale);`
`36`	`37`	`$localizedRoute->setRequirement('_locale', preg_quote($locale));`
`37`	`38`	`$localizedRoute->setDefault('_canonical_route', $name);`
`38`	`39`	`$localizedRoute->setPath($localePrefix.(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));`
`39`		`- $routes->add($name.'.'.$locale, $localizedRoute);`
	`40`	`+ $routes->add($name.'.'.$locale, $localizedRoute, $priority);`
`40`	`41`	`}`
`41`	`42`	`} elseif (!isset($prefix[$locale])) {`
`42`	`43`	`throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $name, $locale));`
`43`	`44`	`} else {`
`44`	`45`	`$route->setPath($prefix[$locale].(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));`
`45`		`- $routes->add($name, $route);`
	`46`	`+ $routes->add($name, $route, $routes->getPriority($name) ?? 0);`
`46`	`47`	`}`
`47`	`48`	`}`
`48`	`49`
Original file line number	Diff line number	Diff line change
`@@ -407,4 +407,9 @@ public function getAlias(string $name): ?Alias`
`407`	`407`	`{`
`408`	`408`	`return $this->aliases[$name] ?? null;`
`409`	`409`	`}`
	`410`	`+`
	`411`	`+ public function getPriority(string $name): ?int`
	`412`	`+ {`
	`413`	`+ return $this->priorities[$name] ?? null;`
	`414`	`+ }`
`410`	`415`	`}`