feat(router): introduce response processors (#1084)

Co-authored-by: Brent Roose <[email protected]>

Author: innocenzi

phpstan.neon.dist

@@ -20,9 +20,6 @@ parameters:
 	ignoreErrors:
 		-
 			identifier: argument.named
-		-
-			message: '#.*#'
-			path: src/Tempest/Router/src/Exceptions/exception.php
 		-
 		    message: '#.*exec*#'
 		    path: src/Tempest/Console/src/Terminal/Terminal.php

rector.php

@@ -58,8 +58,6 @@
         EncapsedStringsToSprintfRector::class,
         AddArrowFunctionReturnTypeRector::class,
     ])
-    ->withSkipPath(__DIR__ . '/src/Tempest/Router/src/Exceptions/HttpProductionErrorHandler.php')
-    ->withSkipPath(__DIR__ . '/src/Tempest/Router/src/Exceptions/exception.php')
     ->withParallel(300, 10, 10)
     ->withPreparedSets(
         codeQuality: false,

src/Tempest/Core/src/FrameworkKernel.php

@@ -14,7 +14,6 @@
 use Tempest\Core\Kernel\LoadDiscoveryLocations;
 use Tempest\Core\ShellExecutors\GenericShellExecutor;
 use Tempest\EventBus\EventBus;
-use Tempest\Router\Exceptions\HttpProductionErrorHandler;
 use Whoops\Handler\PrettyPageHandler;
 use Whoops\Run;
 
@@ -52,7 +51,7 @@ public static function boot(
             container: $container,
         )
             ->loadEnv()
-            ->registerKernelErrorHandler()
+            ->registerEmergencyErrorHandler()
             ->registerShutdownFunction()
             ->registerInternalStorage()
             ->registerKernel()
@@ -150,27 +149,6 @@ public function loadConfig(): self
         return $this;
     }
 
-    public function registerErrorHandler(): self
-    {
-        $appConfig = $this->container->get(AppConfig::class);
-
-        if ($appConfig->environment->isTesting()) {
-            return $this;
-        }
-
-        if (PHP_SAPI === 'cli') {
-            $handler = $this->container->get(ConsoleErrorHandler::class);
-            set_exception_handler($handler->handleException(...));
-            set_error_handler($handler->handleError(...)); // @phpstan-ignore-line
-        } elseif ($appConfig->environment->isProduction()) {
-            $handler = $this->container->get(HttpProductionErrorHandler::class);
-            set_exception_handler($handler->handleException(...));
-            set_error_handler($handler->handleError(...)); // @phpstan-ignore-line
-        }
-
-        return $this;
-    }
-
     public function registerInternalStorage(): self
     {
         $path = $this->root . '/vendor/.tempest';
@@ -200,24 +178,44 @@ public function event(object $event): self
         return $this;
     }
 
-    public function registerKernelErrorHandler(): self
+    public function registerEmergencyErrorHandler(): self
     {
         $environment = Environment::fromEnv();
 
+        // During tests, PHPUnit registers its own error handling.
         if ($environment->isTesting()) {
             return $this;
         }
 
-        if (PHP_SAPI !== 'cli' && $environment->isProduction()) {
-            $handler = new HttpProductionErrorHandler();
-            set_exception_handler($handler->handleException(...));
-            set_error_handler($handler->handleError(...)); // @phpstan-ignore-line
-        } elseif (PHP_SAPI !== 'cli') {
+        // In development, we want to register a developer-friendly error
+        // handler as soon as possible to catch any kind of exception.
+        if (PHP_SAPI !== 'cli' && ! $environment->isProduction()) {
             $whoops = new Run();
             $whoops->pushHandler(new PrettyPageHandler());
             $whoops->register();
         }
 
         return $this;
     }
+
+    public function registerErrorHandler(): self
+    {
+        $appConfig = $this->container->get(AppConfig::class);
+
+        // During tests, PHPUnit registers its own error handling.
+        if ($appConfig->environment->isTesting()) {
+            return $this;
+        }
+
+        // We already have a non-CLI error handler.
+        if (PHP_SAPI !== 'cli') {
+            return $this;
+        }
+
+        $handler = $this->container->get(ConsoleErrorHandler::class);
+        set_exception_handler($handler->handleException(...));
+        set_error_handler($handler->handleError(...)); // @phpstan-ignore-line
+
+        return $this;
+    }
 }

src/Tempest/Core/src/Kernel.php

@@ -4,19 +4,7 @@
 
 namespace Tempest\Core;
 
-use Dotenv\Dotenv;
-use Tempest\Console\Exceptions\ConsoleErrorHandler;
 use Tempest\Container\Container;
-use Tempest\Container\GenericContainer;
-use Tempest\Core\Kernel\FinishDeferredTasks;
-use Tempest\Core\Kernel\LoadConfig;
-use Tempest\Core\Kernel\LoadDiscoveryClasses;
-use Tempest\Core\Kernel\LoadDiscoveryLocations;
-use Tempest\Core\ShellExecutors\GenericShellExecutor;
-use Tempest\EventBus\EventBus;
-use Tempest\Router\Exceptions\HttpProductionErrorHandler;
-use Whoops\Handler\PrettyPageHandler;
-use Whoops\Run;
 
 interface Kernel
 {

src/Tempest/Router/src/ErrorResponses/ErrorResponseProcessor.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Tempest\Router\ErrorResponses;
+
+use Tempest\Http\Status;
+use Tempest\Router\Response;
+use Tempest\Router\ResponseProcessor;
+use Tempest\View\GenericView;
+use Tempest\View\View;
+
+final class ErrorResponseProcessor implements ResponseProcessor
+{
+    public function process(Response $response): Response
+    {
+        if ($response->status->isClientError() || $response->status->isServerError()) {
+            $response->setBody($this->renderErrorView($response->status));
+        }
+
+        return $response;
+    }
+
+    private function renderErrorView(Status $status): View
+    {
+        return new GenericView(__DIR__ . '/error.view.php', [
+            'css' => $this->getCss(),
+            'status' => $status->value,
+            'title' => $status->description(),
+            'message' => match ($status) {
+                Status::INTERNAL_SERVER_ERROR => 'An unexpected server error occurred',
+                Status::NOT_FOUND => 'This page could not be found on the server',
+                Status::FORBIDDEN => 'You do not have permission to access this page',
+                Status::UNAUTHORIZED => 'You must be authenticated in to access this page',
+                default => null,
+            },
+        ]);
+    }
+
+    private function getCss(): string
+    {
+        return file_get_contents(__DIR__ . '/style.css');
+    }
+}

src/Tempest/Router/src/ErrorResponses/error.view.php

@@ -0,0 +1,17 @@
+<html lang="en">
+<head>
+  <title>{{ $title }}</title>
+  <style>{!! $css !!}</style>
+</head>
+<body>
+  <div class="flex flex-col justify-center items-center bg-[#061324] min-w-screen min-h-screen text-[#a8caf7] antialiased">
+    <div class="px-8 container">
+      <h1 class="font-thin text-8xl flex gap-x-1">
+				<span class="text-[#4c6586]">HTTP</span>
+				<span>{{ $status }}</span>
+			</h1>
+      <p :if="$message" class="text-xl uppercase text-[#4c6586]">{{ \Tempest\Support\Str\ensure_ends_with($message, '.') }}</p>
+    </div>
+  </div>
+</body>
+</html>