[Routing] Fix routing collection defaults when adding a new route to a collection

bram123 · nicolas-grekas · commit bfdd16ea5781 · 2023-09-20T18:05:51.000+02:00
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/CollectionConfigurator.php b/src/Symfony/Component/Routing/Loader/Configurator/CollectionConfigurator.php
@@ -114,4 +114,12 @@ final public function host(string|array $host): static
 
         return $this;
     }
+
+    /**
+     * This method overrides the one from LocalizedRouteTrait.
+     */
+    private function createRoute(string $path): Route
+    {
+        return (clone $this->route)->setPath($path);
+    }
 }
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/collection-defaults.php b/src/Symfony/Component/Routing/Tests/Fixtures/collection-defaults.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+return function (RoutingConfigurator $routes) {
+    $collection = $routes->collection();
+    $collection
+        ->methods(['GET'])
+        ->defaults(['attribute' => true])
+        ->stateless();
+
+    $collection->add('defaultsA', '/defaultsA')
+        ->locale('en')
+        ->format('html');
+
+    $collection->add('defaultsB', '/defaultsB')
+        ->methods(['POST'])
+        ->stateless(false)
+        ->locale('en')
+        ->format('html');
+};
diff --git a/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php
@@ -103,6 +103,31 @@ public function testLoadingRouteWithDefaults()
         $this->assertSame('html', $defaultsRoute->getDefault('_format'));
     }
 
+    public function testLoadingRouteWithCollectionDefaults()
+    {
+        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']));
+        $routes = $loader->load('collection-defaults.php');
+
+        $this->assertCount(2, $routes);
+
+        $defaultsRoute = $routes->get('defaultsA');
+        $this->assertSame(['GET'], $defaultsRoute->getMethods());
+        $this->assertArrayHasKey('attribute', $defaultsRoute->getDefaults());
+        $this->assertTrue($defaultsRoute->getDefault('_stateless'));
+        $this->assertSame('/defaultsA', $defaultsRoute->getPath());
+        $this->assertSame('en', $defaultsRoute->getDefault('_locale'));
+        $this->assertSame('html', $defaultsRoute->getDefault('_format'));
+
+        // The second route has a specific method and is not stateless, overwriting the collection settings
+        $defaultsRoute = $routes->get('defaultsB');
+        $this->assertSame(['POST'], $defaultsRoute->getMethods());
+        $this->assertArrayHasKey('attribute', $defaultsRoute->getDefaults());
+        $this->assertFalse($defaultsRoute->getDefault('_stateless'));
+        $this->assertSame('/defaultsB', $defaultsRoute->getPath());
+        $this->assertSame('en', $defaultsRoute->getDefault('_locale'));
+        $this->assertSame('html', $defaultsRoute->getDefault('_format'));
+    }
+
     public function testLoadingImportedRoutesWithDefaults()
     {
         $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']));

Original file line number	Diff line number	Diff line change
`@@ -114,4 +114,12 @@ final public function host(string\|array $host): static`
`114`	`114`
`115`	`115`	`return $this;`
`116`	`116`	`}`
	`117`	`+`
	`118`	`+ /**`
	`119`	`+ * This method overrides the one from LocalizedRouteTrait.`
	`120`	`+ */`
	`121`	`+ private function createRoute(string $path): Route`
	`122`	`+ {`
	`123`	`+ return (clone $this->route)->setPath($path);`
	`124`	`+ }`
`117`	`125`	`}`