Support dot notation in partial requests (#620)

lepikhinb · taylorotwell · web-flow · commit de6b0058e430 · 2024-05-13T11:56:54.000-05:00
* add dot notation support for `only`

* add tests

* add more thorough tests

* fix setting partial props

* extract headers into `Header` enum

* refactor logic

* add comments

* extra test steps

* Update Response.php

* formatting

---------

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
diff --git a/src/Middleware.php b/src/Middleware.php
@@ -5,6 +5,7 @@
 use Closure;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Redirect;
+use Inertia\Support\Header;
 use Symfony\Component\HttpFoundation\Response;
 
 class Middleware
@@ -85,13 +86,13 @@ public function handle(Request $request, Closure $next)
         Inertia::setRootView($this->rootView($request));
 
         $response = $next($request);
-        $response->headers->set('Vary', 'X-Inertia');
+        $response->headers->set('Vary', Header::INERTIA);
 
-        if (! $request->header('X-Inertia')) {
+        if (! $request->header(Header::INERTIA)) {
             return $response;
         }
 
-        if ($request->method() === 'GET' && $request->header('X-Inertia-Version', '') !== Inertia::getVersion()) {
+        if ($request->method() === 'GET' && $request->header(Header::VERSION, '') !== Inertia::getVersion()) {
             $response = $this->onVersionChange($request, $response);
         }
 
@@ -145,8 +146,8 @@ public function resolveValidationErrors(Request $request)
                 return $errors[0];
             })->toArray();
         })->pipe(function ($bags) use ($request) {
-            if ($bags->has('default') && $request->header('x-inertia-error-bag')) {
-                return [$request->header('x-inertia-error-bag') => $bags->get('default')];
+            if ($bags->has('default') && $request->header(Header::ERROR_BAG)) {
+                return [$request->header(Header::ERROR_BAG) => $bags->get('default')];
             }
 
             if ($bags->has('default')) {
diff --git a/src/Response.php b/src/Response.php
@@ -3,7 +3,6 @@
 namespace Inertia;
 
 use Closure;
-use Illuminate\Support\Arr;
 use Illuminate\Http\Request;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\App;
@@ -14,7 +13,9 @@
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Http\Resources\Json\ResourceResponse;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Response as ResponseFactory;
+use Inertia\Support\Header;
 
 class Response implements Responsable
 {
@@ -87,15 +88,7 @@ public function rootView(string $rootView): self
      */
     public function toResponse($request)
     {
-        $only = array_filter(explode(',', $request->header('X-Inertia-Partial-Data', '')));
-
-        $props = ($only && $request->header('X-Inertia-Partial-Component') === $this->component)
-            ? Arr::only($this->props, $only)
-            : array_filter($this->props, static function ($prop) {
-                return ! ($prop instanceof LazyProp);
-            });
-
-        $props = $this->resolvePropertyInstances($props, $request);
+        $props = $this->resolveProperties($request, $this->props);
 
         $page = [
             'component' => $this->component,
@@ -104,17 +97,82 @@ public function toResponse($request)
             'version' => $this->version,
         ];
 
-        if ($request->header('X-Inertia')) {
-            return new JsonResponse($page, 200, ['X-Inertia' => 'true']);
+        if ($request->header(Header::INERTIA)) {
+            return new JsonResponse($page, 200, [Header::INERTIA => 'true']);
         }
 
         return ResponseFactory::view($this->rootView, $this->viewData + ['page' => $page]);
     }
 
+    /**
+     * Resolve the properites for the response.
+     */
+    public function resolveProperties(Request $request, array $props): array
+    {
+        $isPartial = $request->header(Header::PARTIAL_COMPONENT) === $this->component;
+
+        if(!$isPartial) {
+            $props = array_filter($this->props, static function ($prop) {
+                return ! ($prop instanceof LazyProp);
+            });
+        }
+
+        $props = $this->resolveArrayableProperties($props, $request);
+
+        if($isPartial && $request->hasHeader(Header::PARTIAL_ONLY)) {
+            $props = $this->resolveOnly($request, $props);
+        }
+
+        $props = $this->resolvePropertyInstances($props, $request);
+
+        return $props;
+    }
+
+    /**
+     * Resolve all arrayables properties into an array.
+     */
+    public function resolveArrayableProperties(array $props, Request $request, bool $unpackDotProps = true): array
+    {
+        foreach ($props as $key => $value) {
+            if ($value instanceof Arrayable) {
+                $value = $value->toArray();
+            }
+
+            if (is_array($value)) {
+                $value = $this->resolveArrayableProperties($value, $request, false);
+            }
+
+            if ($unpackDotProps && str_contains($key, '.')) {
+                Arr::set($props, $key, $value);
+                unset($props[$key]);
+            } else {
+                $props[$key] = $value;
+            }
+        }
+
+        return $props;
+    }
+
+    /**
+     * Resolve the `only` partial request props.
+     */
+    public function resolveOnly(Request $request, array $props): array
+    {
+        $only = array_filter(explode(',', $request->header(Header::PARTIAL_ONLY, '')));
+
+        $value = [];
+
+        foreach($only as $key) {
+            Arr::set($value, $key, data_get($props, $key));
+        }
+
+        return $value;
+    }
+
     /**
      * Resolve all necessary class instances in the given props.
      */
-    public function resolvePropertyInstances(array $props, Request $request, bool $unpackDotProps = true): array
+    public function resolvePropertyInstances(array $props, Request $request): array
     {
         foreach ($props as $key => $value) {
             if ($value instanceof Closure) {
@@ -133,20 +191,11 @@ public function resolvePropertyInstances(array $props, Request $request, bool $u
                 $value = $value->toResponse($request)->getData(true);
             }
 
-            if ($value instanceof Arrayable) {
-                $value = $value->toArray();
-            }
-
             if (is_array($value)) {
-                $value = $this->resolvePropertyInstances($value, $request, false);
+                $value = $this->resolvePropertyInstances($value, $request);
             }
 
-            if ($unpackDotProps && str_contains($key, '.')) {
-                Arr::set($props, $key, $value);
-                unset($props[$key]);
-            } else {
-                $props[$key] = $value;
-            }
+            $props[$key] = $value;
         }
 
         return $props;
diff --git a/src/ResponseFactory.php b/src/ResponseFactory.php
@@ -10,6 +10,7 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\Redirect;
 use Illuminate\Support\Facades\Response as BaseResponse;
+use Inertia\Support\Header;
 use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
 use Symfony\Component\HttpFoundation\RedirectResponse as SymfonyRedirect;
 
@@ -110,7 +111,7 @@ public function render(string $component, $props = []): Response
     public function location($url): SymfonyResponse
     {
         if (Request::inertia()) {
-            return BaseResponse::make('', 409, ['X-Inertia-Location' => $url instanceof SymfonyRedirect ? $url->getTargetUrl() : $url]);
+            return BaseResponse::make('', 409, [Header::LOCATION => $url instanceof SymfonyRedirect ? $url->getTargetUrl() : $url]);
         }
 
         return $url instanceof SymfonyRedirect ? $url : Redirect::away($url);
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -13,6 +13,7 @@
 use Inertia\Testing\TestResponseMacros;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 use Illuminate\Foundation\Testing\TestResponse as LegacyTestResponse;
+use Inertia\Support\Header;
 
 class ServiceProvider extends BaseServiceProvider
 {
@@ -73,7 +74,7 @@ protected function registerConsoleCommands(): void
     protected function registerRequestMacro(): void
     {
         Request::macro('inertia', function () {
-            return (bool) $this->header('X-Inertia');
+            return (bool) $this->header(Header::INERTIA);
         });
     }
 
diff --git a/src/Support/Header.php b/src/Support/Header.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Inertia\Support;
+
+class Header
+{
+    public const INERTIA = 'X-Inertia';
+    public const ERROR_BAG = 'X-Inertia-Error-Bag';
+    public const LOCATION = 'X-Inertia-Location';
+    public const VERSION = 'X-Inertia-Version';
+    public const PARTIAL_COMPONENT = 'X-Inertia-Partial-Component';
+    public const PARTIAL_ONLY = 'X-Inertia-Partial-Data';
+}
diff --git a/tests/ResponseTest.php b/tests/ResponseTest.php
@@ -2,6 +2,7 @@
 
 namespace Inertia\Tests;
 
+use Exception;
 use Mockery;
 use Inertia\LazyProp;
 use Inertia\Response;
@@ -255,6 +256,40 @@ public function test_xhr_partial_response(): void
         $this->assertSame('123', $page->version);
     }
 
+    public function test_nested_partial_props(): void
+    {
+        $request = Request::create('/user/123', 'GET');
+        $request->headers->add(['X-Inertia' => 'true']);
+        $request->headers->add(['X-Inertia-Partial-Component' => 'User/Edit']);
+        $request->headers->add(['X-Inertia-Partial-Data' => 'auth.user,auth.refresh_token']);
+
+        $props = [
+            'auth' => [
+                'user' => new LazyProp(function () {
+                    return [
+                        'name' => 'Jonathan Reinink',
+                        'email' => 'jonathan@example.com',
+                    ];
+                }),
+                'refresh_token' => 'value',
+                'token' => 'value',
+            ],
+            'shared' => [
+                'flash' => 'Value',
+            ]
+        ];
+
+        $response = new Response('User/Edit', $props);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertFalse(isset($page->props->shared));
+        $this->assertFalse(isset($page->props->auth->token));
+        $this->assertSame('Jonathan Reinink', $page->props->auth->user->name);
+        $this->assertSame('jonathan@example.com', $page->props->auth->user->email);
+        $this->assertSame('value', $page->props->auth->refresh_token);
+    }
+
     public function test_lazy_props_are_not_included_by_default(): void
     {
         $request = Request::create('/users', 'GET');

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`use Illuminate\Contracts\Support\Arrayable;`
`11`	`11`	`use Illuminate\Support\Facades\Redirect;`
`12`	`12`	`use Illuminate\Support\Facades\Response as BaseResponse;`
	`13`	`+use Inertia\Support\Header;`
`13`	`14`	`use Symfony\Component\HttpFoundation\Response as SymfonyResponse;`
`14`	`15`	`use Symfony\Component\HttpFoundation\RedirectResponse as SymfonyRedirect;`
`15`	`16`
`@@ -110,7 +111,7 @@ public function render(string $component, $props = []): Response`
`110`	`111`	`public function location($url): SymfonyResponse`
`111`	`112`	`{`
`112`	`113`	`if (Request::inertia()) {`
`113`		`- return BaseResponse::make('', 409, ['X-Inertia-Location' => $url instanceof SymfonyRedirect ? $url->getTargetUrl() : $url]);`
	`114`	`+ return BaseResponse::make('', 409, [Header::LOCATION => $url instanceof SymfonyRedirect ? $url->getTargetUrl() : $url]);`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`return $url instanceof SymfonyRedirect ? $url : Redirect::away($url);`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`use Inertia\Testing\TestResponseMacros;`
`14`	`14`	`use Illuminate\Support\ServiceProvider as BaseServiceProvider;`
`15`	`15`	`use Illuminate\Foundation\Testing\TestResponse as LegacyTestResponse;`
	`16`	`+use Inertia\Support\Header;`
`16`	`17`
`17`	`18`	`class ServiceProvider extends BaseServiceProvider`
`18`	`19`	`{`
`@@ -73,7 +74,7 @@ protected function registerConsoleCommands(): void`
`73`	`74`	`protected function registerRequestMacro(): void`
`74`	`75`	`{`
`75`	`76`	`Request::macro('inertia', function () {`
`76`		`- return (bool) $this->header('X-Inertia');`
	`77`	`+ return (bool) $this->header(Header::INERTIA);`
`77`	`78`	`});`
`78`	`79`	`}`
`79`	`80`