[Routing] Assign attribute aliases to localized route if applicable

Author: alcohol

Generator/Dumper/CompiledUrlGeneratorDumper.php

@@ -73,10 +73,15 @@ public function getCompiledAliases(): array
             }
 
             $compiledTarget = $target->compile();
+            $defaults = $target->getDefaults();
+
+            if (isset($defaults['_locale']) && str_ends_with($name, '.'.$defaults['_locale'])) {
+                $defaults['_canonical_route'] = substr($name, 0, -\strlen($defaults['_locale']) - 1);
+            }
 
             $compiledAliases[$name] = [
                 $compiledTarget->getVariables(),
-                $target->getDefaults(),
+                $defaults,
                 $target->getRequirements(),
                 $compiledTarget->getTokens(),
                 $compiledTarget->getHostTokens(),

Generator/UrlGenerator.php

@@ -108,7 +108,8 @@ public function generate(string $name, array $parameters = [], int $referenceTyp
 
         if (null !== $locale) {
             do {
-                if (null !== ($route = $this->routes->get($name.'.'.$locale)) && $route->getDefault('_canonical_route') === $name) {
+                $route = $this->routes->get($name.'.'.$locale);
+                if ($route && ($route->getDefault('_canonical_route') === $name || $this->routes->getAlias($name.'.'.$locale))) {
                     break;
                 }
             } while (false !== $locale = strstr($locale, '_', true));

Loader/AttributeClassLoader.php

@@ -241,18 +241,22 @@ protected function addRoute(RouteCollection $collection, object $attr, array $gl
             } else {
                 $collection->add($name, $route, $priority);
             }
-            foreach ($attr->aliases as $aliasAttribute) {
+        }
+
+        foreach ($attr->aliases as $aliasAttribute) {
+            $aliasName = $aliasAttribute instanceof DeprecatedAlias ? $aliasAttribute->aliasName : $aliasAttribute;
+
+            foreach (array_keys($paths) as $locale) {
+                $suffix = 0 !== $locale ? '.'.$locale : '';
+                $alias = $collection->addAlias($aliasName.$suffix, $name.$suffix);
+
                 if ($aliasAttribute instanceof DeprecatedAlias) {
-                    $alias = $collection->addAlias($aliasAttribute->aliasName, $name);
                     $alias->setDeprecated(
                         $aliasAttribute->package,
                         $aliasAttribute->version,
                         $aliasAttribute->message
                     );
-                    continue;
                 }
-
-                $collection->addAlias($aliasAttribute, $name);
             }
         }
     }

Tests/Fixtures/AttributeFixtures/AliasLocalizedRouteController.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures;
+
+use Symfony\Component\Routing\Attribute\Route;
+
+class AliasLocalizedRouteController
+{
+    #[Route(['nl_NL' => '/nl/localized', 'fr_FR' => '/fr/localized'], name: 'localized_route', alias: ['localized_alias'])]
+    public function localized()
+    {
+    }
+}

Tests/Generator/Dumper/CompiledUrlGeneratorDumperTest.php

@@ -242,6 +242,25 @@ public function testDumpWithLocalizedRoutesPreserveTheGoodLocaleInTheUrl()
         $this->assertSame('/amusant', $compiledUrlGenerator->generate('fun.fr', ['_locale' => 'en']));
     }
 
+    public function testLocalizedAliasRouteGeneratesCorrectUrlPerLocale()
+    {
+        $this->routeCollection->add('foo.en', (new Route('/en/fork'))->setDefault('_locale', 'en')->setDefault('_canonical_route', 'foo')->setRequirement('_locale', 'en'));
+        $this->routeCollection->add('foo.fr', (new Route('/fr/fourchette'))->setDefault('_locale', 'fr')->setDefault('_canonical_route', 'foo')->setRequirement('_locale', 'fr'));
+        $this->routeCollection->addAlias('bar.en', 'foo.en');
+        $this->routeCollection->addAlias('bar.fr', 'foo.fr');
+
+        file_put_contents($this->testTmpFilepath, $this->generatorDumper->dump());
+
+        $requestContext = new RequestContext();
+        $requestContext->setParameter('_locale', 'fr');
+
+        $compiledUrlGenerator = new CompiledUrlGenerator(require $this->testTmpFilepath, $requestContext, null, null);
+
+        $this->assertSame('/fr/fourchette', $compiledUrlGenerator->generate('bar'));
+        $this->assertSame('/en/fork', $compiledUrlGenerator->generate('bar', ['_locale' => 'en']));
+        $this->assertSame('/fr/fourchette', $compiledUrlGenerator->generate('bar', ['_locale' => 'fr']));
+    }
+
     public function testAliases()
     {
         $subCollection = new RouteCollection();

Tests/Generator/UrlGeneratorTest.php

@@ -291,6 +291,23 @@ public function testDumpWithLocalizedRoutesPreserveTheGoodLocaleInTheUrl()
         $this->assertSame('/app.php/amusant', $urlGenerator->generate('fun.fr', ['_locale' => 'en']));
     }
 
+    public function testLocalizedAliasRouteGeneratesCorrectUrlPerLocale()
+    {
+        $routeCollection = new RouteCollection();
+
+        $routeCollection->add('foo.en', (new Route('/en/fork'))->setDefault('_locale', 'en')->setDefault('_canonical_route', 'foo')->setRequirement('_locale', 'en'));
+        $routeCollection->add('foo.fr', (new Route('/fr/fourchette'))->setDefault('_locale', 'fr')->setDefault('_canonical_route', 'foo')->setRequirement('_locale', 'fr'));
+        $routeCollection->addAlias('bar.en', 'foo.en');
+        $routeCollection->addAlias('bar.fr', 'foo.fr');
+
+        $urlGenerator = $this->getGenerator($routeCollection);
+        $urlGenerator->getContext()->setParameter('_locale', 'fr');
+
+        $this->assertSame('/app.php/fr/fourchette', $urlGenerator->generate('bar'));
+        $this->assertSame('/app.php/en/fork', $urlGenerator->generate('bar', ['_locale' => 'en']));
+        $this->assertSame('/app.php/fr/fourchette', $urlGenerator->generate('bar', ['_locale' => 'fr']));
+    }
+
     public function testGenerateWithoutRoutes()
     {
         $routes = $this->getRoutes('foo', new Route('/testing/{foo}'));

Tests/Loader/AttributeClassLoaderTest.php

@@ -19,6 +19,7 @@
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\ActionPathController;
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\AliasClassController;
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\AliasInvokableController;
+use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\AliasLocalizedRouteController;
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\AliasRouteController;
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\BazClass;
 use Symfony\Component\Routing\Tests\Fixtures\AttributeFixtures\DefaultValueController;
@@ -386,6 +387,22 @@ public function testAliasesOnMethod()
         $this->assertEquals(new Alias('action_with_alias'), $routes->getAlias('completely_different_name'));
     }
 
+    public function testLocalizedRouteWithAliases()
+    {
+        $routes = $this->loader->load(AliasLocalizedRouteController::class);
+        $this->assertCount(2, $routes);
+
+        $routeNl = $routes->get('localized_route.nl_NL');
+        $routeFr = $routes->get('localized_route.fr_FR');
+
+        $this->assertSame('/nl/localized', $routeNl->getPath());
+        $this->assertSame('/fr/localized', $routeFr->getPath());
+
+        $this->assertNull($routes->getAlias('localized_alias'));
+        $this->assertEquals(new Alias('localized_route.nl_NL'), $routes->getAlias('localized_alias.nl_NL'));
+        $this->assertEquals(new Alias('localized_route.fr_FR'), $routes->getAlias('localized_alias.fr_FR'));
+    }
+
     public function testThrowsWithAliasesOnClass()
     {
         $this->expectException(\InvalidArgumentException::class);