Add error bag support

Author: claudiodekker

src/ServiceProvider.php

@@ -4,6 +4,8 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Routing\Router;
+use Illuminate\Support\MessageBag;
+use Illuminate\Support\ViewErrorBag;
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Support\Facades\Blade;
 use Illuminate\Support\Facades\Session;
@@ -60,9 +62,27 @@ protected function shareValidationErrors()
         }
 
         Inertia::share('errors', function () {
-            return (object) array_map(function ($error) {
-                return $error[0];
-            }, Session::has('errors') ? Session::get('errors')->messages() : []);
+            $errors = Session::get('errors', new ViewErrorBag());
+
+            if (is_array($errors) && count($errors) > 0) {
+                $errors = (new ViewErrorBag())->put('default', new MessageBag($errors));
+            } elseif ($errors instanceof MessageBag && $errors->any()) {
+                $errors = (new ViewErrorBag())->put('default', $errors);
+            } elseif (! $errors instanceof ViewErrorBag) {
+                return (object) [];
+            }
+
+            $formatted = collect($errors->getBags())->map(function (MessageBag $bag) {
+                return collect($bag->messages())->map(function ($errors) {
+                    return $errors[0];
+                });
+            });
+
+            if ($formatted->count() === 1 && $formatted->has('default')) {
+                return (object) $formatted->toArray()['default'];
+            }
+
+            return (object) $formatted->toArray();
         });
     }
 }

tests/ServiceProviderTest.php

@@ -8,6 +8,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\MessageBag;
 use Illuminate\Support\Facades\App;
+use Illuminate\Support\ViewErrorBag;
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Support\Facades\Blade;
 use Illuminate\Support\Facades\Route;
@@ -56,7 +57,15 @@ public function test_middleware_is_registered()
 
     public function test_validation_errors_are_registered()
     {
-        $this->assertTrue(Inertia::getShared('errors') instanceof Closure);
+        $this->assertInstanceOf(Closure::class, Inertia::getShared('errors'));
+    }
+
+    public function test_validation_errors_can_be_empty()
+    {
+        $errors = Inertia::getShared('errors')();
+
+        $this->assertIsObject($errors);
+        $this->assertEmpty(get_object_vars($errors));
     }
 
     public function test_validation_errors_are_not_registered_when_already_registered()
@@ -66,17 +75,68 @@ public function test_validation_errors_are_not_registered_when_already_registere
         $this->assertSame('This is a validation error', Inertia::getShared('errors'));
     }
 
-    public function test_validation_errors_are_returned_in_the_correct_format()
+    public function test_validation_errors_can_be_an_array()
+    {
+        Session::put('errors', [
+            'name' => 'The name field is required.',
+            'email' => 'The email must be a valid email address.',
+        ]);
+
+        $errors = Inertia::getShared('errors')();
+
+        $this->assertIsObject($errors);
+        $this->assertSame('The name field is required.', $errors->name);
+        $this->assertSame('The email must be a valid email address.', $errors->email);
+    }
+
+    public function test_validation_exceptions_can_be_a_message_bag()
     {
         Session::put('errors', new MessageBag([
             'name' => 'The name field is required.',
-            'email' => 'Not a valid email address',
+            'email' => 'The email must be a valid email address.',
         ]));
 
         $errors = Inertia::getShared('errors')();
 
         $this->assertIsObject($errors);
         $this->assertSame('The name field is required.', $errors->name);
-        $this->assertSame('Not a valid email address', $errors->email);
+        $this->assertSame('The email must be a valid email address.', $errors->email);
+    }
+
+    public function test_validation_exceptions_can_be_an_error_bag()
+    {
+        Session::put('errors', (new ViewErrorBag())->put('default', new MessageBag([
+            'name' => 'The name field is required.',
+            'email' => 'The email must be a valid email address.',
+        ])));
+
+        $errors = Inertia::getShared('errors')();
+
+        $this->assertIsObject($errors);
+        $this->assertSame('The name field is required.', $errors->name);
+        $this->assertSame('The email must be a valid email address.', $errors->email);
+    }
+
+    public function test_validation_exceptions_can_be_multiple_error_bags()
+    {
+        Session::put('errors', tap(new ViewErrorBag(), function ($errorBags) {
+            $errorBags->put('default', new MessageBag(['name' => 'The name field is required.']));
+            $errorBags->put('example', new MessageBag(['email' => 'The email must be a valid email address.']));
+        }));
+
+        $errors = Inertia::getShared('errors')();
+
+        $this->assertIsObject($errors);
+        $this->assertSame('The name field is required.', $errors->default['name']);
+        $this->assertSame('The email must be a valid email address.', $errors->example['email']);
+    }
+
+    public function test_validation_exceptions_will_be_empty_when_an_invalid_value_was_set_to_the_session()
+    {
+        Session::put('errors', new Request());
+        $errors = Inertia::getShared('errors')();
+
+        $this->assertIsObject($errors);
+        $this->assertEmpty(get_object_vars($errors));
     }
 }