fix(router): support implicit HEAD requests (#1349)

Author: brendt

packages/http/src/IsRequest.php

@@ -135,4 +135,13 @@ public function hasQuery(string $key): bool
     {
         return has_key($this->query, $key);
     }
+
+    public function withMethod(Method $method): self
+    {
+        $clone = clone $this;
+
+        $clone->method = $method;
+
+        return $clone;
+    }
 }

packages/router/src/GenericResponseSender.php

@@ -5,8 +5,11 @@
 namespace Tempest\Router;
 
 use Generator;
+use Tempest\Container\Container;
 use Tempest\Http\ContentType;
 use Tempest\Http\Header;
+use Tempest\Http\Method;
+use Tempest\Http\Request;
 use Tempest\Http\Response;
 use Tempest\Http\Responses\Download;
 use Tempest\Http\Responses\EventStream;
@@ -19,15 +22,20 @@
 final readonly class GenericResponseSender implements ResponseSender
 {
     public function __construct(
+        private Container $container,
         private ViewRenderer $viewRenderer,
     ) {}
 
     public function send(Response $response): Response
     {
         ob_start();
         $this->sendHeaders($response);
-        ob_flush();
-        $this->sendContent($response);
+
+        if ($this->shouldSendContent()) {
+            ob_flush();
+            $this->sendContent($response);
+        }
+
         ob_end_flush();
 
         if (function_exists('fastcgi_finish_request')) {
@@ -67,6 +75,16 @@ private function resolveHeaders(Response $response): Generator
         }
     }
 
+    private function shouldSendContent(): bool
+    {
+        // The request is resolved dynamically from the container
+        // because it's only available via the container at a later point,
+        // after the response sender has been constructed (set by the router)
+        $request = $this->container->get(Request::class);
+
+        return $request->method !== Method::HEAD;
+    }
+
     private function sendContent(Response $response): void
     {
         if ($response instanceof EventStream) {

packages/router/src/HttpApplication.php

@@ -6,15 +6,13 @@
 
 use Tempest\Container\Container;
 use Tempest\Container\Singleton;
-use Tempest\Core\AppConfig;
 use Tempest\Core\Application;
 use Tempest\Core\Kernel;
 use Tempest\Core\Tempest;
 use Tempest\Http\RequestFactory;
 use Tempest\Http\Session\Session;
 use Tempest\Log\Channels\AppendLogChannel;
 use Tempest\Log\LogConfig;
-use Throwable;
 
 use function Tempest\env;
 use function Tempest\Support\path;

packages/router/src/MatchRouteMiddleware.php

@@ -6,6 +6,7 @@
 use Tempest\Core\Priority;
 use Tempest\Http\GenericRequest;
 use Tempest\Http\Mappers\RequestToObjectMapper;
+use Tempest\Http\Method;
 use Tempest\Http\Request;
 use Tempest\Http\Response;
 use Tempest\Http\Responses\NotFound;
@@ -25,6 +26,10 @@ public function __invoke(Request $request, HttpMiddlewareCallable $next): Respon
     {
         $matchedRoute = $this->routeMatcher->match($request);
 
+        if ($matchedRoute === null && $request->method === Method::HEAD && $request instanceof GenericRequest) {
+            $matchedRoute = $this->routeMatcher->match($request->withMethod(Method::GET));
+        }
+
         if ($matchedRoute === null) {
             return new NotFound();
         }

packages/router/src/ResponseSenderInitializer.php

@@ -4,7 +4,6 @@
 
 namespace Tempest\Router;
 
-use Tempest\Clock\Clock;
 use Tempest\Container\Container;
 use Tempest\Container\Initializer;
 use Tempest\Container\Singleton;
@@ -15,6 +14,9 @@ final class ResponseSenderInitializer implements Initializer
     #[Singleton]
     public function initialize(Container $container): ResponseSender
     {
-        return new GenericResponseSender($container->get(ViewRenderer::class));
+        return new GenericResponseSender(
+            $container,
+            $container->get(ViewRenderer::class),
+        );
     }
 }

tests/Integration/FrameworkIntegrationTestCase.php

@@ -6,20 +6,29 @@
 
 use Closure;
 use InvalidArgumentException;
+use Tempest\Cache\Testing\CacheTester;
 use Tempest\Console\ConsoleApplication;
 use Tempest\Console\Input\ConsoleArgumentBag;
 use Tempest\Console\Output\MemoryOutputBuffer;
 use Tempest\Console\Output\StdoutOutputBuffer;
 use Tempest\Console\OutputBuffer;
 use Tempest\Console\Testing\ConsoleTester;
+use Tempest\Container\GenericContainer;
+use Tempest\Core\AppConfig;
 use Tempest\Core\Application;
+use Tempest\Core\ExceptionTester;
+use Tempest\Core\Kernel;
 use Tempest\Core\ShellExecutor;
 use Tempest\Core\ShellExecutors\NullShellExecutor;
 use Tempest\Database\Connection\ConnectionInitializer;
 use Tempest\Database\DatabaseInitializer;
 use Tempest\Database\Migrations\MigrationManager;
 use Tempest\Discovery\DiscoveryLocation;
+use Tempest\EventBus\Testing\EventBusTester;
+use Tempest\Framework\Testing\Http\HttpRouterTester;
+use Tempest\Framework\Testing\InstallerTester;
 use Tempest\Framework\Testing\IntegrationTest;
+use Tempest\Framework\Testing\ViteTester;
 use Tempest\Reflection\MethodReflector;
 use Tempest\Router\HttpApplication;
 use Tempest\Router\Route;
@@ -28,6 +37,7 @@
 use Tempest\Router\Routing\Construction\RouteConfigurator;
 use Tempest\Router\Static\StaticPageConfig;
 use Tempest\Router\StaticPage;
+use Tempest\Storage\Testing\StorageTester;
 use Tempest\View\Components\AnonymousViewComponent;
 use Tempest\View\GenericView;
 use Tempest\View\View;
@@ -37,6 +47,20 @@
 
 use function Tempest\Support\Path\normalize;
 
+/**
+ * Added these properties because of an autocompletion bug in PhpStorm
+ * @property AppConfig $appConfig
+ * @property Kernel $kernel
+ * @property GenericContainer $container
+ * @property ConsoleTester $console
+ * @property HttpRouterTester $http
+ * @property InstallerTester $installer
+ * @property ViteTester $vite
+ * @property EventBusTester $eventBus
+ * @property StorageTester $storage
+ * @property CacheTester $cache
+ * @property ExceptionTester $exceptions
+ */
 abstract class FrameworkIntegrationTestCase extends IntegrationTest
 {
     protected function setUp(): void

tests/Integration/Http/GenericResponseSenderTest.php

@@ -4,14 +4,18 @@
 
 namespace Tests\Tempest\Integration\Http;
 
+use Tempest\Http\GenericRequest;
 use Tempest\Http\GenericResponse;
+use Tempest\Http\Method;
+use Tempest\Http\Request;
 use Tempest\Http\Responses\Download;
 use Tempest\Http\Responses\EventStream;
 use Tempest\Http\Responses\File;
 use Tempest\Http\Responses\Ok;
 use Tempest\Http\ServerSentEvent;
 use Tempest\Http\Status;
 use Tempest\Router\GenericResponseSender;
+use Tempest\View\ViewRenderer;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
 use function Tempest\view;
@@ -38,6 +42,35 @@ public function test_sending(): void
         ob_get_clean();
     }
 
+    public function test_sending_head_request(): void
+    {
+        $request = new GenericRequest(
+            method: Method::HEAD,
+            uri: '/test',
+        );
+
+        $this->container->singleton(Request::class, $request);
+
+        $responseSender = new GenericResponseSender(
+            $this->container,
+            $this->container->get(ViewRenderer::class),
+        );
+
+        $response = new GenericResponse(
+            status: Status::OK,
+            body: 'body',
+            headers: ['x-custom' => ['true']],
+        );
+
+        ob_start();
+
+        $responseSender->send($response);
+
+        $content = ob_get_clean();
+
+        $this->assertSame('', $content);
+    }
+
     public function test_file_response(): void
     {
         ob_start();

tests/Integration/Route/Fixtures/HeadController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Tests\Tempest\Integration\Route\Fixtures;
+
+use Tempest\Http\Response;
+use Tempest\Http\Responses\Ok;
+use Tempest\Router\Get;
+use Tempest\Router\Head;
+
+final class HeadController
+{
+    #[Get('/implicit-head')]
+    public function implicitHead(): Response
+    {
+        return new Ok('body')->addHeader('x-custom', 'true');
+    }
+
+    #[Head('/explicit-head')]
+    public function explicitHead(): Response
+    {
+        return new Ok()->addHeader('x-custom', 'true');
+    }
+}

tests/Integration/Route/RouterTest.php

@@ -28,6 +28,7 @@
 use Tests\Tempest\Fixtures\Modules\Books\Models\Author;
 use Tests\Tempest\Fixtures\Modules\Books\Models\Book;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+use Tests\Tempest\Integration\Route\Fixtures\HeadController;
 use Tests\Tempest\Integration\Route\Fixtures\Http500Controller;
 
 use function Tempest\uri;
@@ -334,4 +335,20 @@ public function test_converts_to_response(): void
             ->assertStatus(Status::FOUND)
             ->assertHeaderContains('Location', 'https://tempestphp.com');
     }
+
+    public function test_head_requests(): void
+    {
+        $this->registerRoute([HeadController::class, 'implicitHead']);
+        $this->registerRoute([HeadController::class, 'explicitHead']);
+
+        $this->http
+            ->head('/implicit-head')
+            ->assertOk()
+            ->assertHasHeader('x-custom');
+
+        $this->http
+            ->head('/explicit-head')
+            ->assertOk()
+            ->assertHasHeader('x-custom');
+    }
 }