fix(router): require hard-coded uris to start with a slash in Router::toUri (#1205)

Author: wryk

packages/router/src/GenericRouter.php

@@ -131,27 +131,20 @@ private function getCallable(MatchedRoute $matchedRoute): HttpMiddlewareCallable
 
     public function toUri(array|string $action, ...$params): string
     {
-        try {
-            if (is_array($action)) {
-                $controllerClass = $action[0];
-                $reflection = new ClassReflector($controllerClass);
-                $controllerMethod = $reflection->getMethod($action[1]);
-            } else {
-                $controllerClass = $action;
-                $reflection = new ClassReflector($controllerClass);
-                $controllerMethod = $reflection->getMethod('__invoke');
-            }
+        if (is_string($action) && str_starts_with($action, '/')) {
+            $uri = $action;
+        } else {
+            [$controllerClass, $controllerMethod] = is_array($action) ? $action : [$action, '__invoke'];
 
-            /** @var Route|null $routeAttribute */
-            $routeAttribute = $controllerMethod->getAttribute(Route::class);
+            $routeAttribute = new ClassReflector($controllerClass)
+                ->getMethod($controllerMethod)
+                ->getAttribute(Route::class);
 
-            $uri = $routeAttribute->uri;
-        } catch (ReflectionException) {
-            if (is_array($action)) {
-                throw new InvalidRouteException($action[0], $action[1]);
+            if ($routeAttribute === null) {
+                throw new InvalidRouteException($controllerClass, $controllerMethod);
             }
 
-            $uri = $action;
+            $uri = $routeAttribute->uri;
         }
 
         $uri = str($uri);

packages/router/src/Router.php

@@ -14,11 +14,25 @@ public function dispatch(Request|PsrRequest $request): Response;
 
     /**
      * Creates a valid URI to the given `$action`.
+     *
+     * `$action` is one of :
+     * - Controller FQCN and its method as a tuple
+     * - Invokable controller FQCN
+     * - URI string starting with `/`
+     *
+     * @param array{class-string, string}|class-string|string $action
      */
     public function toUri(array|string $action, ...$params): string;
 
     /**
      * Checks if the URI to the given `$action` would match the current route.
+     *
+     * `$action` is one of :
+     * - Controller FQCN and its method as a tuple
+     * - Invokable controller FQCN
+     * - URI string starting with `/`
+     *
+     * @param array{class-string, string}|class-string|string $action
      */
     public function isCurrentUri(array|string $action, ...$params): bool;
 }

tests/Integration/Route/RouterTest.php

@@ -7,6 +7,7 @@
 use Laminas\Diactoros\ServerRequest;
 use Laminas\Diactoros\Stream;
 use Laminas\Diactoros\Uri;
+use ReflectionException;
 use Tempest\Core\AppConfig;
 use Tempest\Core\Environment;
 use Tempest\Database\Migrations\CreateMigrationsTable;
@@ -101,6 +102,14 @@ public function test_generate_uri(): void
         $this->assertEquals('https://test.com/test/1/a/b/c/d', $router->toUri([TestController::class, 'withCustomRegexParams'], id: 1, name: 'a/b/c/d'));
     }
 
+    public function test_uri_generation_with_invalid_fqcn(): void
+    {
+        $router = $this->container->get(GenericRouter::class);
+
+        $this->expectException(ReflectionException::class);
+        $router->toUri(TestController::class . 'Invalid');
+    }
+
     public function test_uri_generation_with_query_param(): void
     {
         $router = $this->container->get(GenericRouter::class);