feature: send debug header

closes #222
PhpGt · Oct 13, 2024 · 4e9be59 · 4e9be59
1 parent 8e25985
commit 4e9be59
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 1 deletion.
diff --git a/src/Response.php b/src/Response.php
@@ -29,6 +29,8 @@ class Response implements ResponseInterface {
 	use Message;
 	use MagicProp;
 
+	const DEBUG_LOCATION_HEADER = "X-Location-Sent-From";
+
 	/** @var null|callable */
 	private $exitCallback;
 	private Deferred $deferred;
@@ -99,7 +101,7 @@ public function setExitCallback(callable $callback):void {
 	}
 
 	public function reload():void {
-		$this->redirect($this->request?->getUri() ?? new Uri());
+		$this->redirect($this->request?->getUri() ?? new Uri("./"));
 	}
 
 	public function reloadWithoutQuery():void {
@@ -112,8 +114,22 @@ public function redirect(
 		string|UriInterface $uri,
 		int $statusCode = 303
 	):void {
+		$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+		$thisFile = __FILE__;
+		do {
+			$previousBacktrace = array_shift($backtrace);
+			$found = $previousBacktrace["file"] !== $thisFile;
+		}
+		while(!$found);
+
+		$cwd = getcwd();
+		$debugLocation = $previousBacktrace["file"];
+		$debugLocation = str_replace($cwd, "", $debugLocation);
+		$debugLocation = trim($debugLocation, "/");
+		$debugLocation .= ":$previousBacktrace[line]";
 		$this->statusCode = $statusCode;
 		$this->headers->set("Location", (string)$uri);
+		$this->headers->set(self::DEBUG_LOCATION_HEADER, $debugLocation);
 		if(isset($this->exitCallback)) {
 			call_user_func($this->exitCallback);
 		}

diff --git a/test/phpunit/ResponseTest.php b/test/phpunit/ResponseTest.php
@@ -154,4 +154,35 @@ public function testAwaitText():void {
 		$actualText = $sut->awaitText();
 		self::assertSame($responseText, $actualText);
 	}
+
+	public function testRedirect_sendsFileLineDebug():void {
+		$sut = (new Response());
+		$sut->redirect("/somewhere");
+		$expectedLine = __LINE__ - 1;
+		$expectedFile = __FILE__;
+		$expectedFile = str_replace(getcwd(), "", $expectedFile);
+		$expectedFile = trim($expectedFile, "/");
+
+		$actualLocation = $sut->getHeaderLine("Location");
+		$actualDebugLocation = $sut->getHeaderLine(Response::DEBUG_LOCATION_HEADER);
+
+		self::assertSame("/somewhere", $actualLocation);
+		self::assertStringContainsString($expectedFile, $actualDebugLocation);
+		self::assertStringEndsWith($expectedLine, $actualDebugLocation);
+	}
+
+	public function testReload_sendsFileLineDebug():void {
+		$sut = (new Response());
+		$sut->reload();
+		$expectedLine = __LINE__ - 1;
+		$expectedFile = __FILE__;
+		$expectedFile = str_replace(getcwd(), "", $expectedFile);
+		$expectedFile = trim($expectedFile, "/");
+
+		$actualLocation = $sut->getHeaderLine("Location");
+		$actualDebugLocation = $sut->getHeaderLine(Response::DEBUG_LOCATION_HEADER);
+
+		self::assertSame("./", $actualLocation);
+		self::assertSame("$expectedFile:$expectedLine", $actualDebugLocation);
+	}
 }