[Routing] Allow when@env inside new RoutesConfig() trees

Author: nicolas-grekas

Loader/Config/RoutesConfig.php

@@ -51,7 +51,7 @@
  *     alias: string,
  *     deprecated?: array{package:string, version:string, message?:string},
  * }
- * @psalm-type Routes = array<string, Route|Import|Alias>
+ * @psalm-type Routes = array<string, Route|Import|Alias|RoutesConfig|array<string, Route|Import|Alias>>
  */
 class RoutesConfig
 {

Loader/PhpFileLoader.php

@@ -109,7 +109,7 @@ private function loadRoutes(RouteCollection $collection, mixed $routes, string $
         }
 
         if ($routes instanceof RoutesConfig) {
-            $routes = [$routes];
+            $routes = $routes->routes;
         } elseif (!is_iterable($routes)) {
             throw new InvalidArgumentException(\sprintf('The return value in config file "%s" is invalid: "%s" given.', $path, get_debug_type($routes)));
         }
@@ -119,8 +119,7 @@ private function loadRoutes(RouteCollection $collection, mixed $routes, string $
 
         \Closure::bind(function () use ($collection, $routes, $path, $file) {
             foreach ($routes as $name => $config) {
-                $when = $name;
-                if (str_starts_with($name, 'when@')) {
+                if (str_starts_with($when = $name, 'when@')) {
                     if (!$this->env || 'when@'.$this->env !== $name) {
                         continue;
                     }
@@ -133,22 +132,11 @@ private function loadRoutes(RouteCollection $collection, mixed $routes, string $
 
                 if ($config instanceof RoutesConfig) {
                     $config = $config->routes;
-                } elseif (!is_iterable($config)) {
+                } elseif (!\is_array($config)) {
                     throw new InvalidArgumentException(\sprintf('The "%s" key should contain an array in "%s".', $name, $path));
                 }
 
-                foreach ($config as $name => $config) {
-                    if (str_starts_with($name, 'when@')) {
-                        throw new InvalidArgumentException(\sprintf('A route name cannot start with "when@" in "%s".', $path));
-                    }
-                    $this->validate($config, $when, $path);
-
-                    if (isset($config['resource'])) {
-                        $this->parseImport($collection, $config, $path, $file);
-                    } else {
-                        $this->parseRoute($collection, $name, $config, $path);
-                    }
-                }
+                $this->loadContent($collection, $config, $path, $file);
             }
         }, $loader, YamlFileLoader::class)();
     }

Loader/YamlFileLoader.php

@@ -74,33 +74,7 @@ public function load(mixed $file, ?string $type = null): RouteCollection
             throw new \InvalidArgumentException(\sprintf('The file "%s" must contain a YAML array.', $path));
         }
 
-        foreach ($parsedConfig as $name => $config) {
-            if (str_starts_with($name, 'when@')) {
-                if (!$this->env || 'when@'.$this->env !== $name) {
-                    continue;
-                }
-
-                foreach ($config as $name => $config) {
-                    $this->validate($config, $name.'" when "@'.$this->env, $path);
-
-                    if (isset($config['resource'])) {
-                        $this->parseImport($collection, $config, $path, $file);
-                    } else {
-                        $this->parseRoute($collection, $name, $config, $path);
-                    }
-                }
-
-                continue;
-            }
-
-            $this->validate($config, $name, $path);
-
-            if (isset($config['resource'])) {
-                $this->parseImport($collection, $config, $path, $file);
-            } else {
-                $this->parseRoute($collection, $name, $config, $path);
-            }
-        }
+        $this->loadContent($collection, $parsedConfig, $path, $file);
 
         return $collection;
     }
@@ -273,6 +247,29 @@ protected function validate(mixed $config, string $name, string $path): void
         }
     }
 
+    private function loadContent(RouteCollection $collection, array $config, string $path, string $file): void
+    {
+        foreach ($config as $name => $config) {
+            if (!str_starts_with($when = $name, 'when@')) {
+                $config = [$name => $config];
+            } elseif (!$this->env || 'when@'.$this->env !== $name) {
+                continue;
+            } else {
+                $when .= '" when "@'.$this->env;
+            }
+
+            foreach ($config as $name => $config) {
+                $this->validate($config, $when, $path);
+
+                if (isset($config['resource'])) {
+                    $this->parseImport($collection, $config, $path, $file);
+                } else {
+                    $this->parseRoute($collection, $name, $config, $path);
+                }
+            }
+        }
+    }
+
     /**
      * @throws \InvalidArgumentException If one of the provided config keys is not supported,
      *                                   something is missing or the combination is nonsense

Tests/Fixtures/routes_object.php

@@ -10,4 +10,14 @@
         'path' => '/b',
         'methods' => ['GET'],
     ],
+    'when@dev' => new RoutesConfig([
+        'c' => [
+            'path' => '/c',
+        ],
+    ]),
+    'when@test' => [
+        'd' => [
+            'path' => '/d',
+        ],
+    ],
 ]);

Tests/Loader/PhpFileLoaderTest.php

@@ -381,6 +381,20 @@ public function testLoadsObjectRoutes()
         $this->assertSame('/a', $routes->get('a')->getPath());
         $this->assertSame('/b', $routes->get('b')->getPath());
         $this->assertSame(['GET'], $routes->get('b')->getMethods());
+        $this->assertNull($routes->get('c'));
+        $this->assertNull($routes->get('d'));
+
+        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']), 'dev');
+        $routes = $loader->load('routes_object.php');
+        $this->assertSame('/a', $routes->get('a')->getPath());
+        $this->assertSame('/b', $routes->get('b')->getPath());
+        $this->assertSame('/c', $routes->get('c')->getPath());
+        $this->assertNull($routes->get('d'));
+
+        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']), 'test');
+        $routes = $loader->load('routes_object.php');
+        $this->assertNull($routes->get('c'));
+        $this->assertSame('/d', $routes->get('d')->getPath());
     }
 
     public function testWhenEnvWithArray()