Improve Middleware compatibility (#144)

Co-authored-by: SuperDJ <[email protected]>

Author: pascalbaljet

demo-app/app/Http/Middleware/TestHttpResponseMiddleware.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class TestHttpResponseMiddleware
+{
+    public function handle(Request $request, Closure $next): Response
+    {
+        return $next($request);
+    }
+}

demo-app/resources/js/Pages/MiddlewareCompatibility/Form.jsx

@@ -0,0 +1,10 @@
+import { Modal } from '@inertiaui/modal-react';
+
+export default function Form() {
+  return (
+    <Modal>
+      <h1>This is my modal</h1>
+      <p>Custom middleware is compatible!</p>
+    </Modal>
+  );
+}

demo-app/resources/js/Pages/MiddlewareCompatibility/Form.vue

@@ -0,0 +1,10 @@
+<script setup>
+import { Modal } from '@inertiaui/modal-vue';
+</script>
+
+<template>
+  <Modal>
+    <h1>This is my modal</h1>
+    <p>Custom middleware is compatible!</p>
+  </Modal>
+</template>

demo-app/resources/js/Pages/MiddlewareCompatibility/Index.jsx

@@ -0,0 +1,12 @@
+import { ModalLink } from '@inertiaui/modal-react';
+
+export default function Index() {
+  return (
+    <div>
+      <h1>Middleware Compatibility Test</h1>
+      <p>This page tests that modals work correctly with custom middleware.</p>
+      <br/>
+      <ModalLink href="/middleware-compatibility/form" navigate>Open Modal</ModalLink>
+    </div>
+  );
+}

demo-app/resources/js/Pages/MiddlewareCompatibility/Index.vue

@@ -0,0 +1,12 @@
+<script setup>
+import { ModalLink } from '@inertiaui/modal-vue';
+</script>
+
+<template>
+  <div>
+    <h1>Middleware Compatibility Test</h1>
+    <p>This page tests that modals work correctly with custom middleware.</p>
+    <br/>
+    <ModalLink href="/middleware-compatibility/form" navigate>Open Modal</ModalLink>
+  </div>
+</template>

demo-app/routes/web.php

@@ -1,5 +1,6 @@
 <?php
 
+use App\Http\Middleware\TestHttpResponseMiddleware;
 use App\Models\Role;
 use App\Models\User;
 use Illuminate\Support\Facades\Auth;
@@ -115,6 +116,15 @@
     return back();
 })->name('roles.store');
 
+// Middleware compatibility test
+Route::middleware([TestHttpResponseMiddleware::class])->get('/middleware-compatibility', function () {
+    return Inertia::render('MiddlewareCompatibility/Index');
+})->name('middleware-compatibility.index');
+
+Route::middleware([TestHttpResponseMiddleware::class])->get('/middleware-compatibility/form', function () {
+    return Inertia::modal('MiddlewareCompatibility/Form')->baseRoute('middleware-compatibility.index');
+});
+
 // POST route that returns Modal
 Route::post('/data', function () {
     return inertia('Data', [

demo-app/tests/Browser/MiddlewareCompatibilityTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Tests\Browser;
+
+use PHPUnit\Framework\Attributes\Test;
+use Tests\DuskTestCase;
+
+class MiddlewareCompatibilityTest extends DuskTestCase
+{
+    #[Test]
+    public function it_can_open_modal_with_custom_middleware_that_expects_http_response()
+    {
+        $this->browse(function (Browser $browser) {
+            $browser->visit('/middleware-compatibility')
+                ->assertSee('Middleware Compatibility Test')
+                ->assertSee('This page tests that modals work correctly with custom middleware.')
+                ->click('a[href="/middleware-compatibility/form"]')
+                ->waitForModal()
+                ->assertSeeIn('.im-modal-content', 'This is my modal')
+                ->assertSeeIn('.im-modal-content', 'Custom middleware is compatible!')
+                ->clickModalCloseButton()
+                ->waitUntilMissingModal()
+                ->assertMissing('div[data-inertiaui-modal-id]');
+        });
+    }
+}

src/DispatchBaseUrlRequest.php

@@ -54,12 +54,14 @@ public function __invoke(Request $originalRequest, string $baseUrl): Response
             ->then(function ($requestForBaseUrl) use ($route) {
                 $this->bindRequest($requestForBaseUrl);
 
-                return $route->run();
-            });
+                $response = $route->run();
+
+                if ($response instanceof Responsable) {
+                    return $response->toResponse($requestForBaseUrl);
+                }
 
-        if ($response instanceof Responsable) {
-            $response = $response->toResponse($requestForBaseUrl);
-        }
+                return $response;
+            });
 
         return tap($response, fn () => $this->bindRequest($originalRequest));
     }