feat(router): add redirect back response (#1050)

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

Author: thoresuenert

src/Tempest/Router/src/Responses/Back.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Router\Responses;
+
+use Tempest\Http\Status;
+use Tempest\Router\IsResponse;
+use Tempest\Router\Request;
+use Tempest\Router\Response;
+use Tempest\Router\Session\Session;
+
+use function Tempest\get;
+
+final class Back implements Response
+{
+    use IsResponse;
+
+    public function __construct(?string $fallback = null)
+    {
+        $this->status = Status::FOUND;
+        $request = get(Request::class);
+
+        $url = $request->headers['referer'] ?? $request->getSessionValue(Session::PREVIOUS_URL);
+
+        if ($url) {
+            $this->addHeader('Location', $url);
+            return;
+        }
+
+        if ($fallback) {
+            $this->addHeader('Location', $fallback);
+            return;
+        }
+
+        $this->addHeader('Location', '/');
+    }
+}

src/Tempest/Router/src/Responses/SetCurrentUrlMiddleware.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Router\Responses;
+
+use Tempest\Core\Priority;
+use Tempest\Http\Method;
+use Tempest\Router\HttpMiddleware;
+use Tempest\Router\HttpMiddlewareCallable;
+use Tempest\Router\Request;
+use Tempest\Router\Response;
+use Tempest\Router\Session\Session;
+
+#[Priority(Priority::FRAMEWORK)]
+final readonly class SetCurrentUrlMiddleware implements HttpMiddleware
+{
+    public function __construct(
+        private Session $session,
+    ) {}
+
+    public function __invoke(Request $request, HttpMiddlewareCallable $next): Response
+    {
+        if ($request->method === Method::GET) {
+            $this->session->setPreviousUrl($request->uri);
+        }
+
+        return $next($request);
+    }
+}

src/Tempest/Router/src/Session/Session.php

@@ -16,6 +16,8 @@ final class Session
 
     public const string ORIGINAL_VALUES = 'original_values';
 
+    public const string PREVIOUS_URL = '_previous_url';
+
     private array $expiredKeys = [];
 
     public function __construct(
@@ -47,6 +49,16 @@ public function get(string $key, mixed $default = null): mixed
         return $value;
     }
 
+    public function getPreviousUrl(): string
+    {
+        return $this->get(self::PREVIOUS_URL, '');
+    }
+
+    public function setPreviousUrl(string $url): void
+    {
+        $this->set(self::PREVIOUS_URL, $url);
+    }
+
     public function consume(string $key, mixed $default = null): mixed
     {
         $value = $this->get($key, $default);

tests/Fixtures/Controllers/RedirectBackTestController.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tests\Tempest\Fixtures\Controllers;
+
+use Tempest\Router\Get;
+use Tempest\Router\Request;
+use Tempest\Router\Response;
+use Tempest\Router\Responses\Back;
+
+final class RedirectBackTestController
+{
+    #[Get('/test-redirect-back-url')]
+    public function formAction(Request $request): Response
+    {
+        return new Back();
+    }
+}

tests/Integration/Http/FileSessionTest.php

@@ -94,6 +94,14 @@ public function test_destroy(): void
         $this->assertFileDoesNotExist($path);
     }
 
+    public function test_set_previous_url(): void
+    {
+        $session = $this->container->get(Session::class);
+        $session->setPreviousUrl('http://localhost/previous');
+
+        $this->assertEquals('http://localhost/previous', $session->getPreviousUrl());
+    }
+
     public function test_is_valid(): void
     {
         $clock = $this->clock('2023-01-01 00:00:00');

tests/Integration/Http/Responses/BackResponseTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Http\Responses;
+
+use Tempest\Http\Method;
+use Tempest\Http\Status;
+use Tempest\Router\GenericRequest;
+use Tempest\Router\Header;
+use Tempest\Router\Request;
+use Tempest\Router\Responses\Back;
+use Tempest\Router\Session\Session;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+final class BackResponseTest extends FrameworkIntegrationTestCase
+{
+    public function test_back_response(): void
+    {
+        $this->bindRequest();
+        $response = new Back();
+
+        $this->assertSame(Status::FOUND, $response->status);
+        $this->assertEquals(new Header('Location', ['/']), $response->headers['Location']);
+        $this->assertNotSame(Status::OK, $response->status);
+    }
+
+    public function test_back_response_with_referer(): void
+    {
+        $this->bindRequest(referer: $referer = '/referer-test');
+
+        $response = new Back();
+
+        $this->assertEquals(new Header('Location', [$referer]), $response->headers['Location']);
+    }
+
+    public function test_back_response_with_fallback(): void
+    {
+        $this->bindRequest();
+
+        $referer = '/test';
+        $response = new Back($referer);
+
+        $this->assertEquals(new Header('Location', [$referer]), $response->headers['Location']);
+    }
+
+    public function test_back_response_for_get_request(): void
+    {
+        $this->http
+            ->get('/test-redirect-back-url')
+            ->assertRedirect('/test-redirect-back-url');
+    }
+
+    public function bindRequest(?string $uri = '/', ?string $referer = null): void
+    {
+        $headers = $referer ? ['referer' => $referer] : [];
+
+        $this->container->singleton(Request::class, new GenericRequest(
+            method: Method::GET,
+            uri: $uri,
+            headers: $headers,
+        ));
+    }
+}