Merge pull request #731 from ljbw/improve-url-handling

Improve URL handling with support for trailing slashes

Author: pascalbaljet

src/Response.php

@@ -109,7 +109,7 @@ public function toResponse($request)
             [
                 'component' => $this->component,
                 'props' => $props,
-                'url' => Str::start(Str::after($request->fullUrl(), $request->getSchemeAndHttpHost()), '/'),
+                'url' => $this->getUrl($request),
                 'version' => $this->version,
                 'clearHistory' => $this->clearHistory,
                 'encryptHistory' => $this->encryptHistory,
@@ -359,4 +359,29 @@ public function isPartial(Request $request): bool
     {
         return $request->header(Header::PARTIAL_COMPONENT) === $this->component;
     }
+
+    /**
+     * Get the URL from the request (without the scheme and host) while preserving the trailing slash if it exists.
+     */
+    protected function getUrl(Request $request): string
+    {
+        $url = Str::start(Str::after($request->fullUrl(), $request->getSchemeAndHttpHost()), '/');
+
+        $rawUri = Str::before($request->getRequestUri(), '?');
+
+        return Str::endsWith($rawUri, '/') ? $this->finishUrlWithTrailingSlash($url) : $url;
+    }
+
+    /**
+     * Ensure the URL has a trailing slash before the query string (if it exists).
+     */
+    protected function finishUrlWithTrailingSlash(string $url): string
+    {
+        // Make sure the relative URL ends with a trailing slash and re-append the query string if it exists.
+        $urlWithoutQueryWithTrailingSlash = Str::finish(Str::before($url, '?'), '/');
+
+        return str_contains($url, '?')
+            ? $urlWithoutQueryWithTrailingSlash.'?'.Str::after($url, '?')
+            : $urlWithoutQueryWithTrailingSlash;
+    }
 }

tests/ResponseTest.php

@@ -827,4 +827,52 @@ public function test_the_page_url_doesnt_double_up(): void
 
         $this->assertSame('/subpath/product/123', $page->url);
     }
+
+    public function test_trailing_slashes_in_a_url_are_preserved(): void
+    {
+        $request = Request::create('/users/', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+
+        $response = new Response('User/Index', []);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertSame('/users/', $page->url);
+    }
+
+    public function test_trailing_slashes_in_a_url_with_query_parameters_are_preserved(): void
+    {
+        $request = Request::create('/users/?page=1&sort=name', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+
+        $response = new Response('User/Index', []);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertSame('/users/?page=1&sort=name', $page->url);
+    }
+
+    public function test_a_url_without_trailing_slash_is_resolved_correctly(): void
+    {
+        $request = Request::create('/users', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+
+        $response = new Response('User/Index', []);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertSame('/users', $page->url);
+    }
+
+    public function test_a_url_without_trailing_slash_and_query_parameters_is_resolved_correctly(): void
+    {
+        $request = Request::create('/users?page=1&sort=name', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+
+        $response = new Response('User/Index', []);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertSame('/users?page=1&sort=name', $page->url);
+    }
 }