Merge pull request #688 from inertiajs/lazy-properties-fix

Don't evaluate lazy properties when not specified by partial reload

Author: joetannenbaum

src/Response.php

@@ -133,27 +133,41 @@ public function toResponse($request)
      */
     public function resolveProperties(Request $request, array $props): array
     {
-        $isPartial = $this->isPartial($request);
+        $props = $this->resolvePartialProperties($props, $request);
+        $props = $this->resolveArrayableProperties($props, $request);
+        $props = $this->resolveAlways($props);
+        $props = $this->resolvePropertyInstances($props, $request);
+
+        return $props;
+    }
 
-        if (! $isPartial) {
-            $props = array_filter($this->props, static function ($prop) {
+    /**
+     * Resolve the `only` and `except` partial request props.
+     */
+    public function resolvePartialProperties(array $props, Request $request): array
+    {
+        if (! $this->isPartial($request)) {
+            return array_filter($this->props, static function ($prop) {
                 return ! ($prop instanceof IgnoreFirstLoad);
             });
         }
 
-        $props = $this->resolveArrayableProperties($props, $request);
+        $only = array_filter(explode(',', $request->header(Header::PARTIAL_ONLY, '')));
+        $except = array_filter(explode(',', $request->header(Header::PARTIAL_EXCEPT, '')));
 
-        if ($isPartial && $request->hasHeader(Header::PARTIAL_ONLY)) {
-            $props = $this->resolveOnly($request, $props);
-        }
+        if (count($only)) {
+            $newProps = [];
 
-        if ($isPartial && $request->hasHeader(Header::PARTIAL_EXCEPT)) {
-            $props = $this->resolveExcept($request, $props);
-        }
+            foreach ($only as $key) {
+                Arr::set($newProps, $key, Arr::get($props, $key));
+            }
 
-        $props = $this->resolveAlways($props);
+            $props = $newProps;
+        }
 
-        $props = $this->resolvePropertyInstances($props, $request);
+        if ($except) {
+            Arr::forget($props, $except);
+        }
 
         return $props;
     }
@@ -173,7 +187,7 @@ public function resolveArrayableProperties(array $props, Request $request, bool
             }
 
             if ($value instanceof Closure) {
-                $value = $value();
+                $value = App::call($value);
             }
 
             if ($unpackDotProps && str_contains($key, '.')) {

tests/DirectiveTest.php

@@ -32,7 +32,7 @@ class DirectiveTest extends TestCase
      */
     protected const EXAMPLE_PAGE_OBJECT = ['component' => 'Foo/Bar', 'props' => ['foo' => 'bar'], 'url' => '/test', 'version' => '', 'encryptHistory' => false, 'clearHistory' => false];
 
-    public function setUp(): void
+    protected function setUp(): void
     {
         parent::setUp();
 

tests/ResponseFactoryTest.php

@@ -176,6 +176,27 @@ public function test_dot_props_are_merged_from_shared(): void
         ]);
     }
 
+    public function test_shared_data_can_resolve_closure_arguments(): void
+    {
+        Inertia::share('query', fn (HttpRequest $request) => $request->query());
+
+        Route::middleware([StartSession::class, ExampleMiddleware::class])->get('/', function () {
+            return Inertia::render('User/Edit');
+        });
+
+        $response = $this->withoutExceptionHandling()->get('/?foo=bar', ['X-Inertia' => 'true']);
+
+        $response->assertSuccessful();
+        $response->assertJson([
+            'component' => 'User/Edit',
+            'props' => [
+                'query' => [
+                    'foo' => 'bar',
+                ],
+            ],
+        ]);
+    }
+
     public function test_dot_props_with_callbacks_are_merged_from_shared(): void
     {
         Route::middleware([StartSession::class, ExampleMiddleware::class])->get('/', function () {

tests/ResponseTest.php

@@ -240,6 +240,54 @@ public function test_resource_response(): void
         $this->assertSame('123', $page->version);
     }
 
+    public function test_lazy_callable_resource_response(): void
+    {
+        $request = Request::create('/users', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+
+        $response = new Response('User/Index', [
+            'users' => fn () => [['name' => 'Jonathan']],
+            'organizations' => fn () => [['name' => 'Inertia']],
+        ], 'app', '123');
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertInstanceOf(JsonResponse::class, $response);
+        $this->assertSame('User/Index', $page->component);
+        $this->assertSame('/users', $page->url);
+        $this->assertSame('123', $page->version);
+        tap($page->props->users, function ($users) {
+            $this->assertSame(json_encode([['name' => 'Jonathan']]), json_encode($users));
+        });
+        tap($page->props->organizations, function ($organizations) {
+            $this->assertSame(json_encode([['name' => 'Inertia']]), json_encode($organizations));
+        });
+    }
+
+    public function test_lazy_callable_resource_partial_response(): void
+    {
+        $request = Request::create('/users', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+        $request->headers->add(['X-Inertia-Partial-Data' => 'users']);
+        $request->headers->add(['X-Inertia-Partial-Component' => 'User/Index']);
+
+        $response = new Response('User/Index', [
+            'users' => fn () => [['name' => 'Jonathan']],
+            'organizations' => fn () => [['name' => 'Inertia']],
+        ], 'app', '123');
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertInstanceOf(JsonResponse::class, $response);
+        $this->assertSame('User/Index', $page->component);
+        $this->assertSame('/users', $page->url);
+        $this->assertSame('123', $page->version);
+        $this->assertFalse(property_exists($page->props, 'organizations'));
+        tap($page->props->users, function ($users) {
+            $this->assertSame(json_encode([['name' => 'Jonathan']]), json_encode($users));
+        });
+    }
+
     public function test_lazy_resource_response(): void
     {
         $request = Request::create('/users', 'GET', ['page' => 1]);

tests/TestCase.php

@@ -19,7 +19,7 @@ protected function getPackageProviders($app): array
         ];
     }
 
-    public function setUp(): void
+    protected function setUp(): void
     {
         parent::setUp();