[1.x] Persistent properties (#621)

* add persistent properties

* persist properties in middleware

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: lepikhinb

src/Inertia.php

@@ -18,6 +18,9 @@
  * @method static void mixin(object $mixin, bool $replace = true)
  * @method static bool hasMacro(string $name)
  * @method static void flushMacros()
+ * @method static void persist(string|array|\Illuminate\Contracts\Support\Arrayable $props)
+ * @method static array getPersisted()
+ * @method static void flushPersisted()
  *
  * @see \Inertia\ResponseFactory
  */

src/Middleware.php

@@ -19,6 +19,13 @@ class Middleware
      */
     protected $rootView = 'app';
 
+    /**
+     * The properties that should always be included on Inertia responses, regardless of "only" or "except" requests.
+     *
+     * @var array
+     */
+    protected $persisted = [];
+
     /**
      * Determines the current asset version.
      *
@@ -83,6 +90,7 @@ public function handle(Request $request, Closure $next)
         });
 
         Inertia::share($this->share($request));
+        Inertia::persist($this->persisted);
         Inertia::setRootView($this->rootView($request));
 
         $response = $next($request);

src/Response.php

@@ -23,17 +23,19 @@ class Response implements Responsable
 
     protected $component;
     protected $props;
+    protected $persisted;
     protected $rootView;
     protected $version;
     protected $viewData = [];
 
     /**
      * @param array|Arrayable $props
      */
-    public function __construct(string $component, $props, string $rootView = 'app', string $version = '')
+    public function __construct(string $component, array $props, string $rootView = 'app', string $version = '', array $persisted = [])
     {
         $this->component = $component;
         $this->props = $props instanceof Arrayable ? $props->toArray() : $props;
+        $this->persisted = $persisted;
         $this->rootView = $rootView;
         $this->version = $version;
     }
@@ -158,7 +160,10 @@ public function resolveArrayableProperties(array $props, Request $request, bool
      */
     public function resolveOnly(Request $request, array $props): array
     {
-        $only = array_filter(explode(',', $request->header(Header::PARTIAL_ONLY, '')));
+        $only = array_merge(
+            array_filter(explode(',', $request->header(Header::PARTIAL_ONLY, ''))),
+            $this->persisted
+        );
 
         $value = [];
 

src/ResponseFactory.php

@@ -24,6 +24,9 @@ class ResponseFactory
     /** @var array */
     protected $sharedProps = [];
 
+    /** @var array */
+    protected $persisted = [];
+
     /** @var Closure|string|null */
     protected $version;
 
@@ -66,6 +69,30 @@ public function flushShared(): void
         $this->sharedProps = [];
     }
 
+    /**
+     * @param string|array|Arrayable $props
+     */
+    public function persist($props): void
+    {
+        if (is_array($props)) {
+            $this->persisted = array_merge($this->persisted, $props);
+        } elseif ($props instanceof Arrayable) {
+            $this->persisted = array_merge($this->persisted, $props->toArray());
+        } else {
+            $this->persisted[] = $props;
+        }
+    }
+
+    public function getPersisted(): array
+    {
+        return $this->persisted;
+    }
+
+    public function flushPersisted(): void
+    {
+        $this->persisted = [];
+    }
+
     /**
      * @param Closure|string|null $version
      */
@@ -101,7 +128,8 @@ public function render(string $component, $props = []): Response
             $component,
             array_merge($this->sharedProps, $props),
             $this->rootView,
-            $this->getVersion()
+            $this->getVersion(),
+            $this->persisted
         );
     }
 

tests/MiddlewareTest.php

@@ -239,10 +239,39 @@ public function rootView(Request $request): string
         $response->assertViewIs('welcome');
     }
 
-    private function prepareMockEndpoint($version = null, $shared = [], $middleware = null): \Illuminate\Routing\Route
+    public function test_middleware_can_set_persisted_properties(): void
+    {
+        $shared = [
+            'shared' => [
+                'flash' => 'The user has been updated.'
+            ]
+        ];
+
+        $this->prepareMockEndpoint(null, $shared, null, ['shared']);
+
+        $response = $this->get('/', [
+            'X-Inertia' => 'true',
+            'X-Inertia-Partial-Component' => 'User/Edit',
+            'X-Inertia-Partial-Data' => 'user'
+        ]);
+
+        $response->assertOk();
+        $response->assertJson([
+            'props' => [
+                'shared' => [
+                    'flash' => 'The user has been updated.'
+                ],
+                'user' => [
+                    'name' => 'Jonathan',
+                ]
+            ]
+        ]);
+    }
+
+    private function prepareMockEndpoint($version = null, $shared = [], $middleware = null, $persisted = []): \Illuminate\Routing\Route
     {
         if (is_null($middleware)) {
-            $middleware = new ExampleMiddleware($version, $shared);
+            $middleware = new ExampleMiddleware($version, $shared, $persisted);
         }
 
         return Route::middleware(StartSession::class)->get('/', function (Request $request) use ($middleware) {

tests/ResponseFactoryTest.php

@@ -150,6 +150,22 @@ public function test_can_flush_shared_data(): void
         $this->assertSame([], Inertia::getShared());
     }
 
+    public function test_can_persist_properties(): void
+    {
+        Inertia::persist('auth.user');
+        $this->assertSame(['auth.user'], Inertia::getPersisted());
+        Inertia::persist(['posts']);
+        $this->assertSame(['auth.user', 'posts'], Inertia::getPersisted());
+    }
+
+    public function test_can_flush_persisted_data(): void
+    {
+        Inertia::persist('auth.user');
+        $this->assertSame(['auth.user'], Inertia::getPersisted());
+        Inertia::flushPersisted();
+        $this->assertSame([], Inertia::getPersisted());
+    }
+
     public function test_can_create_lazy_prop(): void
     {
         $factory = new ResponseFactory();

tests/ResponseTest.php

@@ -326,6 +326,40 @@ public function test_lazy_props_are_included_in_partial_reload(): void
         $this->assertSame('A lazy value', $page->props->lazy);
     }
 
+    public function test_persist_props_on_partial_reload(): 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' => 'data']);
+
+        $props = [
+            'auth' => [
+                'user' => new LazyProp(function () {
+                    return [
+                        'name' => 'Jonathan Reinink',
+                        'email' => '[email protected]',
+                    ];
+                }),
+                'token' => 'value',
+            ],
+            'data' => [
+                'name' => 'Taylor Otwell',
+                'email' => '[email protected]',
+            ]
+        ];
+
+        $response = new Response('User/Edit', $props, 'app', '123', ['auth.user']);
+        $response = $response->toResponse($request);
+        $page = $response->getData();
+
+        $this->assertFalse(isset($page->props->auth->token));
+        $this->assertSame('Jonathan Reinink', $page->props->auth->user->name);
+        $this->assertSame('[email protected]', $page->props->auth->user->email);
+        $this->assertSame('Taylor Otwell', $page->props->data->name);
+        $this->assertSame('[email protected]', $page->props->data->email);
+    }
+
     public function test_top_level_dot_props_get_unpacked(): void
     {
         $props = [

tests/Stubs/ExampleMiddleware.php

@@ -19,10 +19,16 @@ class ExampleMiddleware extends Middleware
      */
     protected $shared = [];
 
-    public function __construct($version = null, $shared = [])
+    /**
+     * @var array
+     */
+    protected $persisted = [];
+
+    public function __construct($version = null, $shared = [], $persisted = [])
     {
         $this->version = $version;
         $this->shared = $shared;
+        $this->persisted = $persisted;
     }
 
     /**