FEATURE: Separate RouteConfiguration from Router

Neos.Flow/Classes/Mvc/Routing/ConfigurationRoutesProvider.php

@@ -10,9 +10,13 @@
  */
 final class ConfigurationRoutesProvider implements RoutesProviderInterface
 {
+    private ConfigurationManager $configurationManager;
+
     public function __construct(
-        private readonly ConfigurationManager $configurationManager
-    ) {}
+        ConfigurationManager $configurationManager
+    ) {
+        $this->configurationManager = $configurationManager;
+    }
 
     public function getRoutes(): Routes
     {

Neos.Flow/Classes/Mvc/Routing/Route.php

@@ -172,8 +172,9 @@ class Route
      */
     protected $persistenceManager;
 
-    public static function fromConfiguration(array $configuration): self
+    public static function fromConfiguration(array $configuration): static
     {
+        /** @phpstan-ignore-next-line */
         $route = new static();
         if (isset($configuration['name'])) {
             $route->setName($configuration['name']);
@@ -192,6 +193,14 @@ public static function fromConfiguration(array $configuration): self
         if (isset($configuration['appendExceedingArguments'])) {
             $route->setAppendExceedingArguments($configuration['appendExceedingArguments']);
         }
+        if (isset($configuration['cache'])) {
+            if (isset($configuration['cache']['lifetime']) && !is_null($configuration['cache']['lifetime'])) {
+                $route->setCacheLifetime(RouteLifetime::fromInt($configuration['cache']['lifetime']));
+            }
+            if (isset($configuration['cache']['tags']) && !empty($configuration['cache']['lifetime'])) {
+                $route->setCacheTags(RouteTags::createFromArray($configuration['cache']['tags']));
+            }
+        }
 
         return $route;
     }

Neos.Flow/Classes/Mvc/Routing/Router.php

@@ -20,8 +20,6 @@
 use Neos\Flow\Mvc\Exception\NoMatchingRouteException;
 use Neos\Flow\Mvc\Routing\Dto\ResolveContext;
 use Neos\Flow\Mvc\Routing\Dto\RouteContext;
-use Neos\Flow\Mvc\Routing\Dto\RouteLifetime;
-use Neos\Flow\Mvc\Routing\Dto\RouteTags;
 use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
 

Neos.Flow/Classes/Mvc/Routing/Routes.php

@@ -3,29 +3,29 @@
 namespace Neos\Flow\Mvc\Routing;
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Mvc\Exception\InvalidRouteSetupException;
 use Traversable;
 
 /**
  * @Flow\Proxy(false)
+ * @implements \IteratorAggregate<int, Route>
  */
 final class Routes implements \IteratorAggregate
 {
     /**
      * @var array<int, Route>
      */
-    private readonly array $routes;
+    private array $routes;
 
-    private function __construct(
+    public function __construct(
         Route ...$routes
     ) {
         $this->routes = $routes;
     }
 
     public static function fromConfiguration(array $configuration): self
     {
-        $routes = self::empty();
+        $routes = [];
         $routesWithHttpMethodConstraints = [];
         foreach ($configuration as $routeConfiguration) {
             $route = Route::fromConfiguration($routeConfiguration);
@@ -44,23 +44,27 @@ public static function fromConfiguration(array $configuration): self
                 }
                 $routesWithHttpMethodConstraints[$uriPattern] = false;
             }
-            $routes = $routes->append($route);
+            $routes[] = $route;
         }
+        return new self(...$routes);
     }
 
     public static function empty(): self
     {
         return new self();
     }
-    public function prepend(Route $route): self
+    public function withPrependedRoute(Route $route): self
     {
-        return new self($route, ...$this->routes);
+        return new self(...[$route, ...$this->routes]);
     }
-    public function append(Route $route): self
+    public function withAppendedRoute(Route $route): self
     {
-        return new self(...$this->routes, $route);
+        return new self(...[...$this->routes, $route]);
     }
 
+    /**
+     * @return \ArrayIterator<int, Route>
+     */
     public function getIterator(): Traversable
     {
         return new \ArrayIterator($this->routes);

Neos.Flow/Tests/Functional/Http/Client/InternalRequestEngineTest.php

@@ -11,7 +11,6 @@
  * source code.
  */
 
-use Neos\Flow\Mvc\Routing\Route;
 use Neos\Flow\Tests\FunctionalTestCase;
 
 /**
@@ -31,17 +30,17 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $route = new Route();
-        $route->setName('Functional Test - Http::Client::InternalRequestEngine');
-        $route->setUriPattern('test/security/restricted');
-        $route->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Security\Fixtures',
-            '@controller' => 'Restricted',
-            '@action' => 'admin',
-            '@format' => 'html'
-        ]);
-        $this->router->addRoute($route);
+        $this->registerRoute(
+            'Functional Test - Http::Client::InternalRequestEngine',
+            'test/security/restricted',
+            [
+                '@package' => 'Neos.Flow',
+                '@subpackage' => 'Tests\Functional\Security\Fixtures',
+                '@controller' => 'Restricted',
+                '@action' => 'admin',
+                '@format' => 'html'
+            ]
+        );
     }
 
     /**

Neos.Flow/Tests/Functional/Http/RequestHandlerTest.php

@@ -32,9 +32,11 @@ class RequestHandlerTest extends FunctionalTestCase
     public function httpRequestIsConvertedToAnActionRequestAndDispatchedToTheRespectiveController(): void
     {
         $foundRoute = false;
-        foreach ($this->router->getRoutes() as $route) {
-            if ($route->getName() === 'Neos.Flow :: Functional Test: HTTP - FooController') {
-                $foundRoute = true;
+        if ($this->routes !== null) {
+            foreach ($this->routes as $route) {
+                if ($route->getName() === 'Neos.Flow :: Functional Test: HTTP - FooController') {
+                    $foundRoute = true;
+                }
             }
         }
         if (!$foundRoute) {

Neos.Flow/Tests/Functional/Mvc/AbstractControllerTest.php

@@ -11,7 +11,6 @@
  * source code.
  */
 
-use Neos\Flow\Mvc\Routing\Route;
 use Neos\Flow\Tests\FunctionalTestCase;
 
 class AbstractControllerTest extends FunctionalTestCase
@@ -27,18 +26,17 @@ class AbstractControllerTest extends FunctionalTestCase
     protected function setUp(): void
     {
         parent::setUp();
-
-        $route = new Route();
-        $route->setName('AbstractControllerTest Route 1');
-        $route->setUriPattern('test/mvc/abstractcontrollertesta/{@action}');
-        $route->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Mvc\Fixtures',
-            '@controller' => 'AbstractControllerTestA',
-            '@format' =>'html'
-        ]);
-        $route->setAppendExceedingArguments(true);
-        $this->router->addRoute($route);
+        $this->registerRoute(
+            'AbstractControllerTest Route 1',
+            'test/mvc/abstractcontrollertesta/{@action}',
+            [
+                '@package' => 'Neos.Flow',
+                '@subpackage' => 'Tests\Functional\Mvc\Fixtures',
+                '@controller' => 'AbstractControllerTestA',
+                '@format' =>'html'
+            ],
+            true
+        );
     }
 
     /**

Neos.Flow/Tests/Functional/Mvc/RoutingTest.php

@@ -48,10 +48,12 @@ protected function setUp(): void
 
         $foundRoute = false;
         /** @var $route Route */
-        foreach ($this->router->getRoutes() as $route) {
-            if ($route->getName() === 'Neos.Flow :: Functional Test: HTTP - FooController') {
-                $foundRoute = true;
-                break;
+        if ($this->routes !== null) {
+            foreach ($this->routes as $route) {
+                if ($route->getName() === 'Neos.Flow :: Functional Test: HTTP - FooController') {
+                    $foundRoute = true;
+                    break;
+                }
             }
         }
 
@@ -382,37 +384,4 @@ public function uriPathPrefixIsRespectedInRoute()
 
         self::assertSame('/index.php/neos/flow/test/http/foo', (string)$actualResult);
     }
-
-    /**
-     * @test
-     */
-    public function explicitlySpecifiedRoutesOverruleConfiguredRoutes()
-    {
-        $routeValues = [
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Http\Fixtures',
-            '@controller' => 'Foo',
-            '@action' => 'index',
-            '@format' => 'html'
-        ];
-        $routesConfiguration = [
-            [
-                'uriPattern' => 'custom/uri/pattern',
-                'defaults' => [
-                    '@package' => 'Neos.Flow',
-                    '@subpackage' => 'Tests\Functional\Http\Fixtures',
-                    '@controller' => 'Foo',
-                    '@action' => 'index',
-                    '@format' => 'html'
-                ],
-            ]
-        ];
-        $this->router->setRoutesConfiguration($routesConfiguration);
-        $baseUri = new Uri('http://localhost');
-        $actualResult = $this->router->resolve(new ResolveContext($baseUri, $routeValues, false, '', RouteParameters::createEmpty()));
-        self::assertSame('/custom/uri/pattern', (string)$actualResult);
-
-        // reset router configuration for following tests
-        $this->router->setRoutesConfiguration(null);
-    }
 }

Neos.Flow/Tests/Functional/Mvc/UriBuilderTest.php

@@ -126,7 +126,7 @@ public function whenLinkingToSameHostTheUrlIsAsExpectedNotContainingDoubleSlashe
      */
     public function whenLinkingToRootOfSameHostTheUrlContainsASingleSlash()
     {
-        // NOTE: the route part handler here does not really match; as we link to the the route
+        // NOTE: the route part handler here does not really match; as we link to the route
         // registered in "registerAbsoluteRoute()".
         $this->registerSingleRoute(UriBuilderSetDomainRoutePartHandler::class);
         // NOTE: the registered route is PREPENDED to the existing list; so we need to register the absolute route LAST as it should match FIRST.

Neos.Flow/Tests/Functional/Security/AuthenticationTest.php

@@ -12,7 +12,6 @@
  */
 
 use GuzzleHttp\Psr7\Uri;
-use Neos\Flow\Mvc\Routing\Route;
 use Neos\Flow\Security\AccountFactory;
 use Neos\Flow\Security\AccountRepository;
 use Neos\Flow\Tests\FunctionalTestCase;
@@ -56,57 +55,57 @@ protected function setUp(): void
         $accountRepository->add($account3);
         $this->persistenceManager->persistAll();
 
-        $route = new Route();
-        $route->setName('Functional Test - Security::Restricted');
-        $route->setUriPattern('test/security/restricted(/{@action})');
-        $route->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Security\Fixtures',
-            '@controller' => 'Restricted',
-            '@action' => 'public',
-            '@format' =>'html'
-        ]);
-        $route->setAppendExceedingArguments(true);
-        $this->router->addRoute($route);
-
-        $route2 = new Route();
-        $route2->setName('Functional Test - Security::Authentication');
-        $route2->setUriPattern('test/security/authentication(/{@action})');
-        $route2->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Security\Fixtures',
-            '@controller' => 'Authentication',
-            '@action' => 'authenticate',
-            '@format' => 'html'
-        ]);
-        $route2->setAppendExceedingArguments(true);
-        $this->router->addRoute($route2);
-
-        $route3 = new Route();
-        $route3->setName('Functional Test - Security::HttpBasicAuthentication');
-        $route3->setUriPattern('test/security/authentication/httpbasic(/{@action})');
-        $route3->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Security\Fixtures',
-            '@controller' => 'HttpBasicTest',
-            '@action' => 'authenticate',
-            '@format' => 'html'
-        ]);
-        $route3->setAppendExceedingArguments(true);
-        $this->router->addRoute($route3);
-
-        $route4 = new Route();
-        $route4->setName('Functional Test - Security::UsernamePasswordAuthentication');
-        $route4->setUriPattern('test/security/authentication/usernamepassword(/{@action})');
-        $route4->setDefaults([
-            '@package' => 'Neos.Flow',
-            '@subpackage' => 'Tests\Functional\Security\Fixtures',
-            '@controller' => 'UsernamePasswordTest',
-            '@action' => 'authenticate',
-            '@format' => 'html'
-        ]);
-        $route4->setAppendExceedingArguments(true);
-        $this->router->addRoute($route4);
+        $this->registerRoute(
+            'Functional Test - Security::Restricted',
+            'test/security/restricted(/{@action})',
+            [
+                '@package' => 'Neos.Flow',
+                '@subpackage' => 'Tests\Functional\Security\Fixtures',
+                '@controller' => 'Restricted',
+                '@action' => 'public',
+                '@format' =>'html'
+            ],
+            true
+        );
+
+        $this->registerRoute(
+            'Functional Test - Security::Authentication',
+            'test/security/authentication(/{@action})',
+            [
+                '@package' => 'Neos.Flow',
+                '@subpackage' => 'Tests\Functional\Security\Fixtures',
+                '@controller' => 'Authentication',
+                '@action' => 'authenticate',
+                '@format' => 'html'
+            ],
+            true
+        );
+
+        $this->registerRoute(
+            'Functional Test - Security::HttpBasicAuthentication',
+            'test/security/authentication/httpbasic(/{@action})',
+            [
+                 '@package' => 'Neos.Flow',
+                 '@subpackage' => 'Tests\Functional\Security\Fixtures',
+                 '@controller' => 'HttpBasicTest',
+                 '@action' => 'authenticate',
+                 '@format' => 'html'
+             ],
+            true
+        );
+
+        $this->registerRoute(
+            'Functional Test - Security::UsernamePasswordAuthentication',
+            'test/security/authentication/usernamepassword(/{@action})',
+            [
+                '@package' => 'Neos.Flow',
+                '@subpackage' => 'Tests\Functional\Security\Fixtures',
+                '@controller' => 'UsernamePasswordTest',
+                '@action' => 'authenticate',
+                '@format' => 'html'
+            ],
+            true
+        );
 
         $this->serverRequestFactory = $this->objectManager->get(ServerRequestFactoryInterface::class);
     }