Refactor Flash messages: remove pullMessages, replace with getFlashed, and transition to Inertia while cleaning up unused routes and middleware.

Author: allanmcarvalho

routes/web.php

@@ -6,20 +6,15 @@
 use Laraveltoolkit\Actions\Filepond\ProcessChunk;
 use Laraveltoolkit\Actions\Filepond\Restore;
 use Laraveltoolkit\Actions\Filepond\Revert;
-use Laraveltoolkit\Actions\Flash\GetMessages;
 use Laraveltoolkit\Actions\Sitemap\RenderSitemap;
 use Laraveltoolkit\Deploy\MaintenanceController;
 use Laraveltoolkit\Facades\SEO;
-use Laraveltoolkit\Flash\EnsureFlashClearedMiddleware;
 
 Route::middleware('web')
     ->domain(config('laraveltoolkit.deploy.domain'))
     ->get(config('laraveltoolkit.deploy.path'), MaintenanceController::class)
     ->name('maintenance');
 
-Route::middleware(['web', EnsureFlashClearedMiddleware::class])->get('/lt/flash-get-messages', GetMessages::class)
-    ->name('lt.flash.get_messages');
-
 Route::middleware('web')->prefix('lt/filepond')->group(function () {
     Route::post('process', Process::class)->name('lt.filepond.process');
     Route::patch('process-chunk', ProcessChunk::class)->name('lt.filepond.process_chunk');

src/Actions/Flash/GetMessages.php

@@ -8,8 +8,7 @@
 use Laraveltoolkit\Flash\Severity;
 
 /**
- * @method static void clear()
- * @method static Collection<int, Message> pullMessages()
+ * @method static Collection<string, Message> getFlashed()
  * @method static Message success(string $detail, string $summary = null)
  * @method static Message info(string $detail, string $summary = null)
  * @method static Message warn(string $detail, string $summary = null)

src/Facades/Flash.php

@@ -2,44 +2,27 @@
 
 namespace Laraveltoolkit\Flash;
 
-use Illuminate\Session\SessionManager;
 use Illuminate\Support\Collection;
+use Inertia\Inertia;
 
 class Flash
 {
     use FlashTests;
 
-    public const string SESSION_KEY = 'laraveltoolkit.flashes';
-
-    protected Collection $messages;
-
-    protected SessionManager $session;
-
-    public function __construct()
-    {
-        $this->messages = collect();
-        $this->session = app(SessionManager::class);
-    }
-
     protected function add(Message $message): Message
     {
-        $this->messages->push($message);
-        $this->session->push(self::SESSION_KEY, $message);
+        Inertia::flash($message->id, FlashResource::make($message));
 
         return $message;
     }
 
-    public function clear(): void
-    {
-        $this->session->forget(self::SESSION_KEY);
-        $this->messages = collect();
-    }
-
-    public function pullMessages(): Collection
+    /**
+     * @return Collection<string, Message>
+     */
+    public function getFlashed(): Collection
     {
-        return collect($this->session->pull(self::SESSION_KEY, []))
-            ->ensure(Message::class)
-            ->sortBy('createdAt');
+        return collect(Inertia::getFlashed())
+            ->map(fn (FlashResource $resource) => $resource->resource);
     }
 
     public function success(string $detail, ?string $summary = null): Message

src/Flash/Flash.php

@@ -8,7 +8,7 @@ trait FlashTests
 {
     public function assertFlashed(?Severity $severity = null, null|int|string $countOrMessage = null): void
     {
-        $messages = $this->messages;
+        $messages = $this->getFlashed();
         if ($severity) {
             $messages = $messages->filter(fn (Message $message) => $message->severity === $severity);
         }
@@ -40,7 +40,7 @@ public function assertFlashed(?Severity $severity = null, null|int|string $count
 
     public function assertNotFlashed(?Severity $severity = null): void
     {
-        $messages = $this->messages;
+        $messages = $this->getFlashed();
         if ($severity) {
             $messages = $messages->filter(fn (Message $message) => $message->severity === $severity);
         }

src/Flash/FlashTests.php

@@ -12,29 +12,20 @@
     Flash::error('ok');
     Flash::secondary('ok');
     Flash::contrast('ok');
-
-    expect(Flash::pullMessages())
+    expect(Flash::getFlashed())
         ->toHaveCount(6)
         ->toBeInstanceOf(Collection::class)
         ->each
         ->toBeInstanceOf(Message::class);
 });
 
-it('can clear messages', function () {
-    Flash::error('ok');
-    Flash::secondary('ok');
-    Flash::contrast('ok');
-    Flash::clear();
-    expect(Flash::pullMessages())
-        ->toBeEmpty();
-});
-
 it('test defaults', function () {
+
     config()->set('laraveltoolkit.flash.defaults.closable', true);
     config()->set('laraveltoolkit.flash.defaults.life', 1234);
     config()->set('laraveltoolkit.flash.defaults.group', 'abc');
     Flash::error('ok');
-    $message = Flash::pullMessages()->first();
+    $message = Flash::getFlashed()->first();
     expect($message->closable)
         ->toBeTrue()
         ->and($message->life)
@@ -44,51 +35,55 @@
 });
 
 it('can send messages with options', function () {
+
     Flash::error('ok')->withGroup('foo_bar');
-    $messages = Flash::pullMessages();
+    $messages = Flash::getFlashed();
     expect($messages->first()->group)
         ->toEqual('foo_bar');
+
+    $this->flushSession();
     Flash::error('ok')->closable();
     Flash::error('ok')->unclosable();
-    $messages = Flash::pullMessages();
+    $messages = Flash::getFlashed();
     expect($messages->first()->closable)
         ->toBeTrue()
         ->and($messages->last()->closable)
         ->toBeFalse();
+
+    $this->flushSession();
     Flash::error('ok')->withLife(4000);
-    $messages = Flash::pullMessages();
+    $messages = Flash::getFlashed();
     expect($messages->first()->life)
         ->toEqual(4000);
 });
 
 it('test test assert flashed', function () {
-    Flash::clear();
     expect(fn () => Flash::assertFlashed())
         ->toThrow('Was expected a flash of "any" severity but was not found');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     expect(fn () => Flash::assertFlashed())
         ->not
         ->toThrow('Was expected a flash of "any" severity but was not found');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     expect(fn () => Flash::assertFlashed(Severity::INFO))
         ->toThrow('Was expected a flash of "info" severity but was not found')
         ->and(fn () => Flash::assertFlashed(Severity::SUCCESS))
         ->not
         ->toThrow('Was expected a flash of "success" severity but was not found');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     expect(fn () => Flash::assertFlashed(countOrMessage: 'foo'))
         ->toThrow('Was expected a flash of "any" severity with detail of "foo" but was not found')
         ->and(fn () => Flash::assertFlashed(countOrMessage: 'ok'))
         ->not
         ->toThrow('Was expected a flash of "any" severity but was not found');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     Flash::success('ok');
     expect(fn () => Flash::assertFlashed(countOrMessage: 3))
@@ -98,18 +93,18 @@
         ->toThrow('Was expected 2 flashes from "any" severity but was found 2');
 });
 
-it('test test assert not flashed', function () {
-    Flash::clear();
+it('test assert not flashed', function () {
+    $this->flushSession();
     expect(fn () => Flash::assertNotFlashed())
         ->not
         ->toThrow('Was expected none flashes of "any" severity but was found 1');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     expect(fn () => Flash::assertNotFlashed())
         ->toThrow('Was expected none flashes of "any" severity but was found 1');
 
-    Flash::clear();
+    $this->flushSession();
     Flash::success('ok');
     Flash::success('ok');
     Flash::success('ok');

tests/Actions/FlashTest.php

@@ -18,14 +18,21 @@ protected function setUp(): void
         $this->app->maintenanceMode()->deactivate();
 
         Factory::guessFactoryNamesUsing(
-            fn (string $modelName) => 'Laraveltoolkit\\Database\\Factories\\'.class_basename($modelName).'Factory'
+            fn(string $modelName) => 'Laraveltoolkit\\Database\\Factories\\'.class_basename($modelName).'Factory'
         );
         $copyPath = dirname(__DIR__).'/routes/sitemap.php';
         $sitemapRoutesPath = base_path('routes/sitemap.php');
-        if (! file_exists($sitemapRoutesPath)) {
+        if (!file_exists($sitemapRoutesPath)) {
             copy($copyPath, $sitemapRoutesPath);
         }
         new User(['id' => 1, 'name' => 'Foo Bar', 'email' => 'foo@bar.com', 'password' => 'abc'])->saveOrFail();
+
+        if ($this->app['session']->isStarted()) {
+            $this->app['session']->flush();
+        } else {
+            $this->startSession();
+            request()->setLaravelSession(session()->driver());
+        }
     }
 
     protected function getPackageProviders($app): array