bug symfony#52913 [Routing] Fixed priority getting lost when setting localized prefix (pritasil)

This PR was merged into the 5.4 branch.

Discussion
----------

[Routing] Fixed priority getting lost when setting localized prefix

| Q             | A
| ------------- | ---
| Branch?       |  5.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        | Fix symfony#52912
| License       | MIT

When a route prefix is an array, the original route is removed from the collection and then re-added with a new name and path. During this process, the route's priority is lost as it's not preserved during the removal and re-addition.

Current state of `PrefixTrait.php`
```php
 $routes->remove($name);
 ...
  $routes->add($name.'.'.$locale, $localizedRoute);
 ```

To resolve this issue, I implemented a change where the priority of the route is stored before removal. This stored priority is then reassigned to the route when it's added back to the collection.

Commits
-------

ba41175 [Routing] Fixed priority getting lost when defining prefix array

Author: nicolas-grekas

src/Symfony/Component/Routing/Loader/Configurator/Traits/PrefixTrait.php

@@ -29,20 +29,21 @@ final protected function addPrefix(RouteCollection $routes, $prefix, bool $trail
             }
             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);
                 }
             }
 

src/Symfony/Component/Routing/RouteCollection.php

@@ -395,4 +395,9 @@ public function getAlias(string $name): ?Alias
     {
         return $this->aliases[$name] ?? null;
     }
+
+    public function getPriority(string $name): ?int
+    {
+        return $this->priorities[$name] ?? null;
+    }
 }

src/Symfony/Component/Routing/Tests/Fixtures/AttributeFixtures/RouteWithPriorityController.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures;
+
+use Symfony\Component\Routing\Annotation\Route;
+
+class RouteWithPriorityController
+{
+    /**
+     * @Route("/important", name="important", priority=2)
+     */
+    public function important()
+    {
+    }
+
+    /**
+     * @Route("/also-important", name="also_important", priority=1, defaults={"_locale": "cs"})
+     */
+    public function alsoImportant()
+    {
+    }
+}

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: annotation
+  prefix:
+    cs: /cs
+    en: /en

src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php

@@ -11,9 +11,12 @@
 
 namespace Symfony\Component\Routing\Tests\Loader;
 
+use Doctrine\Common\Annotations\AnnotationReader;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Loader\LoaderResolver;
 use Symfony\Component\Config\Resource\FileResource;
+use Symfony\Component\Routing\Loader\AnnotationClassLoader;
 use Symfony\Component\Routing\Loader\YamlFileLoader;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
@@ -458,4 +461,27 @@ public function testImportingAliases()
 
         $this->assertEquals($expectedRoutes('yaml'), $routes);
     }
+
+    public function testPriorityWithPrefix()
+    {
+        new LoaderResolver([
+            $loader = new YamlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures/localized')),
+            new class(new AnnotationReader(), null) extends AnnotationClassLoader {
+                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');
+
+        $this->assertSame(2, $routes->getPriority('important.cs'));
+        $this->assertSame(2, $routes->getPriority('important.en'));
+        $this->assertSame(1, $routes->getPriority('also_important'));
+    }
 }