Add Inertia::deepMerge Method for Handling Complex Data Merges in Responses

src/Inertia.php

@@ -18,6 +18,7 @@
  * @method static \Inertia\DeferProp defer(callable $callback, string $group = 'default')
  * @method static \Inertia\AlwaysProp always(mixed $value)
  * @method static \Inertia\MergeProp merge(mixed $value)
+ * @method static \Inertia\MergeProp deepMerge(mixed $value)
  * @method static \Inertia\Response render(string $component, array|\Illuminate\Contracts\Support\Arrayable $props = [])
  * @method static \Symfony\Component\HttpFoundation\Response location(string|\Symfony\Component\HttpFoundation\RedirectResponse $url)
  * @method static void macro(string $name, object|callable $macro)

src/MergesProps.php

@@ -6,15 +6,29 @@ trait MergesProps
 {
     protected bool $merge = false;
 
+    protected bool $deepMerge = false;
+
     public function merge(): static
     {
         $this->merge = true;
 
         return $this;
     }
 
+    public function deepMerge(): static
+    {
+        $this->deepMerge = true;
+
+        return $this->merge();
+    }
+
     public function shouldMerge(): bool
     {
         return $this->merge;
     }
+
+    public function shouldDeepMerge(): bool
+    {
+        return $this->deepMerge;
+    }
 }

src/Response.php

@@ -305,18 +305,22 @@ public function resolveMergeProps(Request $request): array
     {
         $resetProps = collect(explode(',', $request->header(Header::RESET, '')));
         $mergeProps = collect($this->props)
-            ->filter(function ($prop) {
-                return $prop instanceof Mergeable;
-            })
-            ->filter(function ($prop) {
-                return $prop->shouldMerge();
-            })
-            ->filter(function ($prop, $key) use ($resetProps) {
-                return ! $resetProps->contains($key);
-            })
+            ->filter(fn ($prop) => $prop instanceof Mergeable)
+            ->filter(fn ($prop) => $prop->shouldMerge())
+            ->filter(fn ($_, $key) => ! $resetProps->contains($key));
+
+        $deepMergeProps = $mergeProps
+            ->filter(fn ($prop) => $prop->shouldDeepMerge())
+            ->keys();
+
+        $mergeProps = $mergeProps
+            ->filter(fn ($prop) => ! $prop->shouldDeepMerge())
             ->keys();
 
-        return $mergeProps->isNotEmpty() ? ['mergeProps' => $mergeProps->toArray()] : [];
+        return array_filter([
+            'mergeProps' => $mergeProps->toArray(),
+            'deepMergeProps' => $deepMergeProps->toArray(),
+        ], fn ($prop) => count($prop) > 0);
     }
 
     public function resolveDeferredProps(Request $request): array

src/ResponseFactory.php

@@ -122,6 +122,14 @@ public function merge($value): MergeProp
         return new MergeProp($value);
     }
 
+    /**
+     * @param  mixed  $value
+     */
+    public function deepMerge($value): MergeProp
+    {
+        return (new MergeProp($value))->deepMerge();
+    }
+
     /**
      * @param  mixed  $value
      */

tests/DeepMergePropTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Inertia\Tests;
+
+use Illuminate\Http\Request;
+use Inertia\MergeProp;
+
+class DeepMergePropTest extends TestCase
+{
+    public function test_can_invoke_with_a_callback(): void
+    {
+        $mergeProp = (new MergeProp(fn () => 'A merge prop value'))->deepMerge();
+
+        $this->assertSame('A merge prop value', $mergeProp());
+    }
+
+    public function test_can_invoke_with_a_non_callback(): void
+    {
+        $mergeProp = (new MergeProp(['key' => 'value']))->deepMerge();
+
+        $this->assertSame(['key' => 'value'], $mergeProp());
+    }
+
+    public function test_can_resolve_bindings_when_invoked(): void
+    {
+        $mergeProp = (new MergeProp(fn (Request $request) => $request))->deepMerge();
+
+        $this->assertInstanceOf(Request::class, $mergeProp());
+    }
+}

tests/ResponseFactoryTest.php

@@ -277,6 +277,16 @@ public function test_can_create_merged_prop(): void
         $this->assertInstanceOf(MergeProp::class, $mergedProp);
     }
 
+    public function test_can_create_deep_merged_prop(): void
+    {
+        $factory = new ResponseFactory;
+        $mergedProp = $factory->deepMerge(function () {
+            return 'A merged value';
+        });
+
+        $this->assertInstanceOf(MergeProp::class, $mergedProp);
+    }
+
     public function test_can_create_deferred_and_merged_prop(): void
     {
         $factory = new ResponseFactory;
@@ -287,6 +297,16 @@ public function test_can_create_deferred_and_merged_prop(): void
         $this->assertInstanceOf(DeferProp::class, $deferredProp);
     }
 
+    public function test_can_create_deferred_and_deep_merged_prop(): void
+    {
+        $factory = new ResponseFactory;
+        $deferredProp = $factory->defer(function () {
+            return 'A deferred + merged value';
+        })->deepMerge();
+
+        $this->assertInstanceOf(DeferProp::class, $deferredProp);
+    }
+
     public function test_can_create_optional_prop(): void
     {
         $factory = new ResponseFactory;

tests/ResponseTest.php

@@ -165,6 +165,41 @@ public function test_server_response_with_merge_props(): void
         $this->assertSame('<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;user&quot;:{&quot;name&quot;:&quot;Jonathan&quot;},&quot;foo&quot;:&quot;foo value&quot;,&quot;bar&quot;:&quot;bar value&quot;},&quot;url&quot;:&quot;\/user\/123&quot;,&quot;version&quot;:&quot;123&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;mergeProps&quot;:[&quot;foo&quot;,&quot;bar&quot;]}"></div>', $view->render());
     }
 
+    public function test_server_response_with_deep_merge_props(): void
+    {
+        $request = Request::create('/user/123', 'GET');
+
+        $user = ['name' => 'Jonathan'];
+        $response = new Response(
+            'User/Edit',
+            [
+                'user' => $user,
+                'foo' => (new MergeProp('foo value'))->deepMerge(),
+                'bar' => (new MergeProp('bar value'))->deepMerge(),
+            ],
+            'app',
+            '123'
+        );
+        $response = $response->toResponse($request);
+        $view = $response->getOriginalContent();
+        $page = $view->getData()['page'];
+
+        $this->assertInstanceOf(BaseResponse::class, $response);
+        $this->assertInstanceOf(View::class, $view);
+
+        $this->assertSame('User/Edit', $page['component']);
+        $this->assertSame('Jonathan', $page['props']['user']['name']);
+        $this->assertSame('/user/123', $page['url']);
+        $this->assertSame('123', $page['version']);
+        $this->assertSame([
+            'foo',
+            'bar',
+        ], $page['deepMergeProps']);
+        $this->assertFalse($page['clearHistory']);
+        $this->assertFalse($page['encryptHistory']);
+        $this->assertSame('<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;user&quot;:{&quot;name&quot;:&quot;Jonathan&quot;},&quot;foo&quot;:&quot;foo value&quot;,&quot;bar&quot;:&quot;bar value&quot;},&quot;url&quot;:&quot;\/user\/123&quot;,&quot;version&quot;:&quot;123&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;deepMergeProps&quot;:[&quot;foo&quot;,&quot;bar&quot;]}"></div>', $view->render());
+    }
+
     public function test_server_response_with_defer_and_merge_props(): void
     {
         $request = Request::create('/user/123', 'GET');
@@ -205,6 +240,46 @@ public function test_server_response_with_defer_and_merge_props(): void
         $this->assertSame('<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;user&quot;:{&quot;name&quot;:&quot;Jonathan&quot;},&quot;bar&quot;:&quot;bar value&quot;},&quot;url&quot;:&quot;\/user\/123&quot;,&quot;version&quot;:&quot;123&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;mergeProps&quot;:[&quot;foo&quot;,&quot;bar&quot;],&quot;deferredProps&quot;:{&quot;default&quot;:[&quot;foo&quot;]}}"></div>', $view->render());
     }
 
+    public function test_server_response_with_defer_and_deep_merge_props(): void
+    {
+        $request = Request::create('/user/123', 'GET');
+
+        $user = ['name' => 'Jonathan'];
+        $response = new Response(
+            'User/Edit',
+            [
+                'user' => $user,
+                'foo' => (new DeferProp(function () {
+                    return 'foo value';
+                }, 'default'))->deepMerge(),
+                'bar' => (new MergeProp('bar value'))->deepMerge(),
+            ],
+            'app',
+            '123'
+        );
+        $response = $response->toResponse($request);
+        $view = $response->getOriginalContent();
+        $page = $view->getData()['page'];
+
+        $this->assertInstanceOf(BaseResponse::class, $response);
+        $this->assertInstanceOf(View::class, $view);
+
+        $this->assertSame('User/Edit', $page['component']);
+        $this->assertSame('Jonathan', $page['props']['user']['name']);
+        $this->assertSame('/user/123', $page['url']);
+        $this->assertSame('123', $page['version']);
+        $this->assertSame([
+            'default' => ['foo'],
+        ], $page['deferredProps']);
+        $this->assertSame([
+            'foo',
+            'bar',
+        ], $page['deepMergeProps']);
+        $this->assertFalse($page['clearHistory']);
+        $this->assertFalse($page['encryptHistory']);
+        $this->assertSame('<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;user&quot;:{&quot;name&quot;:&quot;Jonathan&quot;},&quot;bar&quot;:&quot;bar value&quot;},&quot;url&quot;:&quot;\/user\/123&quot;,&quot;version&quot;:&quot;123&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;deepMergeProps&quot;:[&quot;foo&quot;,&quot;bar&quot;],&quot;deferredProps&quot;:{&quot;default&quot;:[&quot;foo&quot;]}}"></div>', $view->render());
+    }
+
     public function test_xhr_response(): void
     {
         $request = Request::create('/user/123', 'GET');

tests/ServiceProviderTest.php

@@ -30,10 +30,13 @@ public function test_route_macro_is_registered(): void
         $routes = Route::getRoutes();
 
         $this->assertNotEmpty($routes->getRoutes());
-        $this->assertEquals($route, $routes->getRoutes()[0]);
-        $this->assertEquals(['GET', 'HEAD'], $route->methods);
-        $this->assertEquals('/', $route->uri);
-        $this->assertEquals(['uses' => '\Inertia\Controller@__invoke', 'controller' => '\Inertia\Controller'], $route->action);
-        $this->assertEquals(['component' => 'User/Edit', 'props' => ['user' => ['name' => 'Jonathan']]], $route->defaults);
+
+        $inertiaRoute = collect($routes->getRoutes())->first(fn ($route) => $route->uri === '/');
+
+        $this->assertEquals($route, $inertiaRoute);
+        $this->assertEquals(['GET', 'HEAD'], $inertiaRoute->methods);
+        $this->assertEquals('/', $inertiaRoute->uri);
+        $this->assertEquals(['uses' => '\Inertia\Controller@__invoke', 'controller' => '\Inertia\Controller'], $inertiaRoute->action);
+        $this->assertEquals(['component' => 'User/Edit', 'props' => ['user' => ['name' => 'Jonathan']]], $inertiaRoute->defaults);
     }
 }