bug #58842 [Routing] Fix: lost priority when defining hosts in configuration (BeBlood)

nicolas-grekas · nicolas-grekas · commit 16087db3dd34 · 2024-11-13T15:08:26.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Routing] Fix: lost priority when defining hosts in configuration | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | #58843 | License | MIT When host are configured in routing, the original route is removed from the collection and then re-added. During this process, the route's priority is lost as it's not preserved during the removal and re-addition. Bug has similarities with #52912 (resolved for prefix) Commits ------- 437e6ad [Routing] Fix: lost priority when defining hosts in configuration
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/Traits/HostTrait.php b/src/Symfony/Component/Routing/Loader/Configurator/Traits/HostTrait.php
@@ -28,21 +28,22 @@ final protected function addHost(RouteCollection $routes, $hosts)
 
         foreach ($routes->all() as $name => $route) {
             if (null === $locale = $route->getDefault('_locale')) {
+                $priority = $routes->getPriority($name) ?? 0;
                 $routes->remove($name);
                 foreach ($hosts as $locale => $host) {
                     $localizedRoute = clone $route;
                     $localizedRoute->setDefault('_locale', $locale);
                     $localizedRoute->setRequirement('_locale', preg_quote($locale));
                     $localizedRoute->setDefault('_canonical_route', $name);
                     $localizedRoute->setHost($host);
-                    $routes->add($name.'.'.$locale, $localizedRoute);
+                    $routes->add($name.'.'.$locale, $localizedRoute, $priority);
                 }
             } elseif (!isset($hosts[$locale])) {
                 throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding host in its parent collection.', $name, $locale));
             } else {
                 $route->setHost($hosts[$locale]);
                 $route->setRequirement('_locale', preg_quote($locale));
-                $routes->add($name, $route);
+                $routes->add($name, $route, $routes->getPriority($name) ?? 0);
             }
         }
     }
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/locale_and_host/priorized-host.yml b/src/Symfony/Component/Routing/Tests/Fixtures/locale_and_host/priorized-host.yml
@@ -0,0 +1,6 @@
+controllers:
+  resource: Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\RouteWithPriorityController
+  type: annotation
+  host:
+    cs: www.domain.cs
+    en: www.domain.com
diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -484,4 +484,27 @@ protected function configureRoute(
         $this->assertSame(2, $routes->getPriority('important.en'));
         $this->assertSame(1, $routes->getPriority('also_important'));
     }
+
+    public function testPriorityWithHost()
+    {
+        new LoaderResolver([
+            $loader = new YamlFileLoader(new FileLocator(\dirname(__DIR__).'/Fixtures/locale_and_host')),
+            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('priorized-host.yml');
+
+        $this->assertSame(2, $routes->getPriority('important.cs'));
+        $this->assertSame(2, $routes->getPriority('important.en'));
+        $this->assertSame(1, $routes->getPriority('also_important'));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -28,21 +28,22 @@ final protected function addHost(RouteCollection $routes, $hosts)`
`28`	`28`
`29`	`29`	`foreach ($routes->all() as $name => $route) {`
`30`	`30`	`if (null === $locale = $route->getDefault('_locale')) {`
	`31`	`+ $priority = $routes->getPriority($name) ?? 0;`
`31`	`32`	`$routes->remove($name);`
`32`	`33`	`foreach ($hosts as $locale => $host) {`
`33`	`34`	`$localizedRoute = clone $route;`
`34`	`35`	`$localizedRoute->setDefault('_locale', $locale);`
`35`	`36`	`$localizedRoute->setRequirement('_locale', preg_quote($locale));`
`36`	`37`	`$localizedRoute->setDefault('_canonical_route', $name);`
`37`	`38`	`$localizedRoute->setHost($host);`
`38`		`- $routes->add($name.'.'.$locale, $localizedRoute);`
	`39`	`+ $routes->add($name.'.'.$locale, $localizedRoute, $priority);`
`39`	`40`	`}`
`40`	`41`	`} elseif (!isset($hosts[$locale])) {`
`41`	`42`	`throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding host in its parent collection.', $name, $locale));`
`42`	`43`	`} else {`
`43`	`44`	`$route->setHost($hosts[$locale]);`
`44`	`45`	`$route->setRequirement('_locale', preg_quote($locale));`
`45`		`- $routes->add($name, $route);`
	`46`	`+ $routes->add($name, $route, $routes->getPriority($name) ?? 0);`
`46`	`47`	`}`
`47`	`48`	`}`
`48`	`49`	`}`