feature: handle errors with custom pages

Author: g105b

composer.json

@@ -29,7 +29,7 @@
 		"phpgt/domvalidation": "^1.0",
 		"phpgt/fetch": "^1.2",
 		"phpgt/filecache": "^1.2",
-		"phpgt/http": "^1.2",
+		"phpgt/http": "^1.3.5",
 		"phpgt/input": "^1.3",
 		"phpgt/logger": "^1.0",
 		"phpgt/promise": "^2.4",

composer.lock

@@ -1,5 +1,6 @@
 [app]
 namespace=App
+production=false
 class_dir=class
 service_loader=ServiceLoader
 slow_delta=0.25
@@ -12,6 +13,7 @@ globals_whitelist_post=
 globals_whitelist_files=
 globals_whitelist_cookies=
 force_trailing_slash=true
+error_page_dir=page/_error
 
 [router]
 router_file=router.php
@@ -24,6 +26,8 @@ component_directory=page/_component
 partial_directory=page/_partial
 
 [logger]
+log_all_requests=true
+debug_to_javascript=true
 type=stdout
 level=debug
 path=
@@ -35,7 +39,7 @@ newline=\n
 [session]
 handler=Gt\Session\FileHandler
 path=phpgt/session
-name=WebEngineSession
+name=GT
 
 [database]
 driver=sqlite

config.default.ini

@@ -7,7 +7,7 @@
  * lifecycle in the documentation:
  * https://github.com/PhpGt/WebEngine/wiki/From-request-to-response
  */
-use Gt\WebEngine\Application;
+use GT\WebEngine\Application;
 
 chdir(dirname($_SERVER["DOCUMENT_ROOT"]));
 ini_set("display_errors", "on");
@@ -67,5 +67,3 @@
 if(file_exists("teardown.php")) {
 	require("teardown.php");
 }
-
-die("go complete!");

go.php

@@ -1,5 +1,5 @@
 <?php
-namespace Gt\WebEngine;
+namespace GT\WebEngine;
 
 use Gt\Http\Request;
 use Gt\Routing\BaseRouter;
@@ -84,8 +84,15 @@ public function page(Request $request):void {
 			? -1
 			: 0);
 
+		if($this->errorStatus) {
+			$uriPath = "_error/$this->errorStatus";
+		}
+		else {
+			$uriPath = $request->getUri()->getPath();
+		}
+
 		$matchingLogics = $pathMatcher->findForUriPath(
-			$request->getUri()->getPath(),
+			$uriPath,
 			"page",
 			"php"
 		);
@@ -95,7 +102,7 @@ public function page(Request $request):void {
 		}
 
 		$matchingViews = $pathMatcher->findForUriPath(
-			$request->getUri()->getPath(),
+			$uriPath,
 			"page",
 			"html"
 		);

router.default.php

@@ -2,6 +2,9 @@
 namespace GT\WebEngine;
 
 use Closure;
+use Gt\Http\ResponseStatusException\ClientError\ClientErrorException;
+use Gt\Http\ResponseStatusException\ResponseStatusException;
+use Gt\Logger\Log;
 use Throwable;
 use ErrorException;
 use GT\WebEngine\Debug\OutputBuffer;
@@ -32,6 +35,7 @@ class Application {
 	private Timer $timer;
 	private OutputBuffer $outputBuffer;
 	private RequestFactory $requestFactory;
+	private ServerRequest $request;
 	/** @var array<string, array<string, string|array<string, string>>> */
 	private array $globals;
 	private Protection $globalProtection;
@@ -62,7 +66,9 @@ public function __construct(
 			$this->config->getFloat("app.slow_delta"),
 			$this->config->getFloat("app.very_slow_delta"),
 		);
-		$this->outputBuffer = $outputBuffer ?? new OutputBuffer();
+		$this->outputBuffer = $outputBuffer ?? new OutputBuffer(
+			$this->config->getBool("logger.debug_to_javascript")
+		);
 		$this->requestFactory = $requestFactory ?? new RequestFactory();
 		$this->dispatcherFactory = $dispatcherFactory ?? new DispatcherFactory();
 		$this->globals = array_merge([
@@ -103,8 +109,7 @@ public function start():void {
 // $_GET contains query parameters from the URL, and $_POST contains form data.
 // These arrays are optional and will default to empty arrays if not provided,
 // ensuring the ServerRequest can always be constructed safely.
-		/** @var ServerRequest $request */
-		$request = $this->requestFactory->createServerRequestFromGlobalState(
+		$this->request = $this->requestFactory->createServerRequestFromGlobalState(
 			$this->globals["_SERVER"] ?? [],
 			$this->globals["_FILES"] ?? [],
 			$this->globals["_GET"] ?? [],
@@ -125,7 +130,7 @@ public function start():void {
 // the application's error templates and logging mechanisms.
 		$this->dispatcher = $this->dispatcherFactory->create(
 			$this->config,
-			$request,
+			$this->request,
 			$this->globals,
 			$this->finish(...),
 		);
@@ -134,10 +139,27 @@ public function start():void {
 			$response = $this->dispatcher->generateResponse();
 		}
 		catch(Throwable $throwable) {
-			var_dump($throwable);
-			die("ERRRRRRRRRRRRRRRRRRR");
 			$this->logError($throwable);
-			$response = $this->dispatcher->generateErrorResponse($throwable);
+			$errorStatus = 500;
+
+			if($throwable instanceof ResponseStatusException) {
+				$errorStatus = $throwable->getHttpCode();
+			}
+
+			$this->dispatcher = $this->dispatcherFactory->create(
+				$this->config,
+				$this->request,
+				$this->globals,
+				$this->finish(...),
+				$errorStatus,
+			);
+
+			try {
+				$response = $this->dispatcher->generateErrorResponse($throwable);
+			}
+			catch(Throwable $innerThrowable) {
+				$response = $this->dispatcher->generateBasicErrorResponse($throwable, $innerThrowable);
+			}
 		}
 
 		$this->finish($response);
@@ -156,12 +178,19 @@ private function finish(
 			$response->getHeaders(),
 		);
 
-// If there's any content in the output buffer, render it to the developer console/log instead of the page.
-		$this->outputBuffer->debugOutput();
+		if($this->config->getBool("logger.log_all_requests")) {
+			Log::info(
+				"HTTP " . $response->getStatusCode(),
+				$this->getLogContext(),
+			);
+		}
 
 		/** @var Stream $responseBody */
 		$responseBody = $response->getBody();
-		$this->outputResponseBody($responseBody);
+		$this->outputResponseBody(
+			$responseBody,
+			$this->outputBuffer->debugOutput(),
+		);
 
 		$this->timer->stop();
 		$this->timer->logDelta();
@@ -274,7 +303,32 @@ private function handleShutdown():void {
 	}
 
 	private function logError(Throwable $throwable):void {
-		// TODO: implement
+		if($throwable instanceof ClientErrorException) {
+			return;
+		}
+
+		Log::error($throwable);
+	}
+
+	/** @return array<string, string> */
+	private function getLogContext():array {
+		$uri = $this->request->getUri();
+		$uriPath = $uri->getPath();
+		$uriQuery = $this->request->getQueryParams();
+		$postBody = $this->request->getParsedBody();
+
+		$context = [
+			"id" => $this->request->getServerParams()["REMOTE_ADDR"] . ":" . substr(session_id(), 0, 4),
+			"uri" => $uriPath,
+		];
+		if($uriQuery) {
+			$context["query"] = $uriQuery;
+		}
+		if($postBody) {
+			$context["post"] = $postBody;
+		}
+
+		return $context;
 	}
 
 	/** @param array<string, array<string>> $headers */
@@ -301,13 +355,21 @@ private function outputHeaders(int $statusCode, array $headers):void {
 	 * `ob_*` functions are used here to ensure that the response body is
 	 * flushed and doesn't get rendered into another open buffer.
 	 */
-	private function outputResponseBody(Stream $responseBody):void {
+	private function outputResponseBody(Stream $responseBody, ?string $debugScript = null):void {
 		$length = $this->config->getInt("app.render_buffer_size");
 
 		$responseBody->rewind();
 		ob_start();
 		while(!$responseBody->eof()) {
-			echo $responseBody->read($length);
+			$content = $responseBody->read($length);
+			if($debugScript) {
+				$closingBody = strpos($content, "</body>");
+				if(false !== $closingBody) {
+					$content = substr_replace($content, $debugScript, $closingBody, 0);
+				}
+			}
+			echo $content;
+
 			ob_flush();
 			flush();
 		}