fix(router): use route registry to generate uris

Author: innocenzi

packages/router/src/Exceptions/ControllerActionDoesNotExist.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Router\Exceptions;
+
+use Exception;
+
+final class ControllerActionDoesNotExist extends Exception implements RouterException
+{
+    public static function controllerNotFound(string $controller): self
+    {
+        return new self("The controller class `{$controller}` does not exist.");
+    }
+
+    public static function actionNotFound(string $controller, string $method): self
+    {
+        return new self("The method `{$method}()` does not exist in controller class `{$controller}`.");
+    }
+}

packages/router/src/Exceptions/ControllerMethodHadNoRoute.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Router\Exceptions;
+
+use Exception;
+
+final class ControllerMethodHadNoRoute extends Exception implements RouterException
+{
+    public function __construct(string $controllerClass, string $controllerMethod)
+    {
+        parent::__construct("No route found for `{$controllerClass}::{$controllerMethod}()`. Did you forget to add a `Route` attribute?");
+    }
+}

packages/router/src/Exceptions/ControllerMethodHadNoRouteAttribute.php

@@ -18,6 +18,9 @@ public function __construct(
         /** @var array<string,\Tempest\Router\Routing\Matching\MatchingRegex> */
         public array $matchingRegexes = [],
 
+        /** @var array<string,string> */
+        public array $handlerIndex = [],
+
         /** @var class-string<\Tempest\Router\ResponseProcessor>[] */
         public array $responseProcessors = [],
 
@@ -37,6 +40,7 @@ public function apply(RouteConfig $newConfig): void
         $this->staticRoutes = $newConfig->staticRoutes;
         $this->dynamicRoutes = $newConfig->dynamicRoutes;
         $this->matchingRegexes = $newConfig->matchingRegexes;
+        $this->handlerIndex = $newConfig->handlerIndex;
     }
 
     public function addResponseProcessor(string $responseProcessor): void

packages/router/src/RouteConfig.php

@@ -22,6 +22,9 @@ final class RouteConfigurator
     /** @var array<string,array<string,\Tempest\Router\Routing\Construction\DiscoveredRoute>> */
     private array $dynamicRoutes = [];
 
+    /** @var array<string,string[]> */
+    private array $handlerIndex = [];
+
     private bool $isDirty = false;
 
     private RoutingTree $routingTree;
@@ -34,6 +37,7 @@ public function __construct()
     public function addRoute(DiscoveredRoute $route): void
     {
         $this->isDirty = true;
+        $this->handlerIndex[$route->handler->getDeclaringClass()->getName() . '::' . $route->handler->getName()] = $route->uri;
 
         if ($route->isDynamic) {
             $this->addDynamicRoute($route);
@@ -76,6 +80,7 @@ public function toRouteConfig(): RouteConfig
             $this->staticRoutes,
             $this->dynamicRoutes,
             $this->routingTree->toMatchingRegexes(),
+            $this->handlerIndex,
         );
     }
 

packages/router/src/Routing/Construction/RouteConfigurator.php

@@ -13,7 +13,8 @@
 use Tempest\Http\Request;
 use Tempest\Reflection\ClassReflector;
 use Tempest\Reflection\MethodReflector;
-use Tempest\Router\Exceptions\ControllerMethodHadNoRouteAttribute;
+use Tempest\Router\Exceptions\ControllerActionDoesNotExist;
+use Tempest\Router\Exceptions\ControllerMethodHadNoRoute;
 use Tempest\Router\Routing\Construction\DiscoveredRoute;
 use Tempest\Support\Arr;
 use Tempest\Support\Regex;
@@ -25,6 +26,7 @@ final class UriGenerator
 {
     public function __construct(
         private AppConfig $appConfig,
+        private RouteConfig $routeConfig,
         private Signer $signer,
         private Container $container,
     ) {}
@@ -178,7 +180,7 @@ public function isCurrentUri(array|string|MethodReflector $action, mixed ...$par
 
         $matchedRoute = $this->container->get(MatchedRoute::class);
         $candidateUri = $this->createUri($action, ...[...$matchedRoute->params, ...$params]);
-        $currentUri = $this->createUri([$matchedRoute->route->handler->getDeclaringClass(), $matchedRoute->route->handler->getName()]);
+        $currentUri = $this->createUri([$matchedRoute->route->handler->getDeclaringClass()->getName(), $matchedRoute->route->handler->getName()]);
 
         foreach ($matchedRoute->params as $key => $value) {
             if ($value instanceof BackedEnum) {
@@ -206,14 +208,20 @@ private function normalizeActionToUri(array|string|MethodReflector $action): str
 
         [$controllerClass, $controllerMethod] = is_array($action) ? $action : [$action, '__invoke'];
 
-        $routeAttribute = new ClassReflector($controllerClass)
-            ->getMethod($controllerMethod)
-            ->getAttribute(Route::class);
+        $uri = $this->routeConfig->handlerIndex[$controllerClass . '::' . $controllerMethod] ?? null;
 
-        if ($routeAttribute === null) {
-            throw new ControllerMethodHadNoRouteAttribute($controllerClass, $controllerMethod);
+        if (! $uri) {
+            if (! class_exists($controllerClass)) {
+                throw ControllerActionDoesNotExist::controllerNotFound($controllerClass, $controllerMethod);
+            }
+
+            if (! method_exists($controllerClass, $controllerMethod)) {
+                throw ControllerActionDoesNotExist::actionNotFound($controllerClass, $controllerMethod);
+            }
+
+            throw new ControllerMethodHadNoRoute($controllerClass, $controllerMethod);
         }
 
-        return Str\ensure_starts_with($routeAttribute->uri, '/');
+        return Str\ensure_starts_with($uri, '/');
     }
 }

packages/router/src/UriGenerator.php

@@ -4,15 +4,16 @@
 
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\TestWith;
-use ReflectionException;
 use Tempest\Core\AppConfig;
 use Tempest\Database\PrimaryKey;
 use Tempest\DateTime\Duration;
 use Tempest\Http\GenericRequest;
 use Tempest\Http\Method;
+use Tempest\Router\Exceptions\ControllerActionDoesNotExist;
 use Tempest\Router\UriGenerator;
 use Tests\Tempest\Fixtures\Controllers\ControllerWithEnumBinding;
 use Tests\Tempest\Fixtures\Controllers\EnumForController;
+use Tests\Tempest\Fixtures\Controllers\PrefixController;
 use Tests\Tempest\Fixtures\Controllers\TestController;
 use Tests\Tempest\Fixtures\Controllers\UriGeneratorController;
 use Tests\Tempest\Fixtures\Modules\Books\BookController;
@@ -56,11 +57,21 @@ public function uri_functions(): void
     #[Test]
     public function uri_generation_with_invalid_fqcn(): void
     {
-        $this->expectException(ReflectionException::class);
+        $this->expectException(ControllerActionDoesNotExist::class);
+        $this->expectExceptionMessage('The controller class `Tests\Tempest\Fixtures\Controllers\TestControllerInvalid` does not exist.');
 
         $this->generator->createUri(TestController::class . 'Invalid');
     }
 
+    #[Test]
+    public function uri_generation_with_invalid_method(): void
+    {
+        $this->expectException(ControllerActionDoesNotExist::class);
+        $this->expectExceptionMessage('The method `invalid()` does not exist in controller class `Tests\Tempest\Fixtures\Controllers\TestController`.');
+
+        $this->generator->createUri([TestController::class, 'invalid']);
+    }
+
     #[Test]
     public function uri_generation_with_query_param(): void
     {
@@ -249,4 +260,26 @@ public function cannot_add_custom_signature(): void
             signature: 'uwu',
         );
     }
+
+    #[Test]
+    public function generates_uri_with_prefix_decorator(): void
+    {
+        $this->assertSame(
+            '/prefix/endpoint',
+            $this->generator->createUri(PrefixController::class),
+        );
+
+        $this->assertSame(
+            '/prefix/endpoint',
+            uri(PrefixController::class),
+        );
+    }
+
+    #[Test]
+    public function is_current_uri_with_prefix_decorator(): void
+    {
+        $this->http->get('/prefix/endpoint')->assertOk();
+
+        $this->assertTrue($this->generator->isCurrentUri(PrefixController::class));
+    }
 }