Introduce InitialProp class

Author: michaelnabil230

src/FirstLoad.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Inertia;
+
+interface FirstLoad
+{
+    //
+}

src/Inertia.php

@@ -14,7 +14,6 @@
  * @method static void version(\Closure|string|null $version)
  * @method static string getVersion()
  * @method static void resolveUrlUsing(\Closure|null $urlResolver = null)
- * @method static void resolveOncePropsUsing(\Closure|null $urlResolver = null)
  * @method static \Inertia\OptionalProp optional(callable $callback)
  * @method static \Inertia\LazyProp lazy(callable $callback)
  * @method static \Inertia\DeferProp defer(callable $callback, string $group = 'default')

src/InitialProp.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Inertia;
+
+use Illuminate\Support\Facades\App;
+
+class InitialProp implements FirstLoad
+{
+    protected $callback;
+
+    public function __construct(callable $callback)
+    {
+        $this->callback = $callback;
+    }
+
+    public function __invoke()
+    {
+        return App::call($this->callback);
+    }
+}

src/Middleware.php

@@ -79,16 +79,6 @@ public function urlResolver()
         return null;
     }
 
-    /**
-     * Defines the props that are shared for one time.
-     *
-     * @return Closure|null
-     */
-    public function oncePropsResolver()
-    {
-        return null;
-    }
-
     /**
      * Handle the incoming request.
      *
@@ -107,10 +97,6 @@ public function handle(Request $request, Closure $next)
             Inertia::resolveUrlUsing($urlResolver);
         }
 
-        if ($oncePropsResolver = $this->oncePropsResolver()) {
-            Inertia::resolveOncePropsUsing($oncePropsResolver);
-        }
-
         $response = $next($request);
         $response->headers->set('Vary', Header::INERTIA);
 

src/Response.php

@@ -38,8 +38,6 @@ class Response implements Responsable
 
     protected ?Closure $urlResolver = null;
 
-    protected ?Closure $oncePropsResolver = null;
-
     /**
      * @param  array|Arrayable  $props
      */
@@ -50,7 +48,6 @@ public function __construct(
         string $version = '',
         bool $encryptHistory = false,
         ?Closure $urlResolver = null,
-        ?Closure $oncePropsResolver = null,
     ) {
         $this->component = $component;
         $this->props = $props instanceof Arrayable ? $props->toArray() : $props;
@@ -59,7 +56,6 @@ public function __construct(
         $this->clearHistory = session()->pull('inertia.clear_history', false);
         $this->encryptHistory = $encryptHistory;
         $this->urlResolver = $urlResolver;
-        $this->oncePropsResolver = $oncePropsResolver;
     }
 
     /**
@@ -130,14 +126,13 @@ public function toResponse($request)
             $this->resolveMergeProps($request),
             $this->resolveDeferredProps($request),
             $this->resolveCacheDirections($request),
+            $this->resolveInitialProps($request),
         );
 
         if ($request->header(Header::INERTIA)) {
             return new JsonResponse($page, 200, [Header::INERTIA => 'true']);
         }
 
-        $page += $this->resolveOnceProps($request);
-
         return ResponseFactory::view($this->rootView, $this->viewData + ['page' => $page]);
     }
 
@@ -150,6 +145,7 @@ public function resolveProperties(Request $request, array $props): array
         $props = $this->resolveArrayableProperties($props, $request);
         $props = $this->resolveAlways($props);
         $props = $this->resolvePropertyInstances($props, $request);
+        $props = $this->removeInitialProperties($props);
 
         return $props;
     }
@@ -302,6 +298,14 @@ public function resolvePropertyInstances(array $props, Request $request): array
         return $props;
     }
 
+    /**
+     * Remove initial properties from the response.
+     */
+    public function removeInitialProperties(array $props): array
+    {
+        return array_filter($props, static fn ($prop) => ! $prop instanceof InitialProp);
+    }
+
     /**
      * Resolve the cache directions for the response.
      */
@@ -382,13 +386,17 @@ public function resolveDeferredProps(Request $request): array
         return $deferredProps->isNotEmpty() ? ['deferredProps' => $deferredProps->toArray()] : [];
     }
 
-    public function resolveOnceProps(Request $request): array
+    public function resolveInitialProps(Request $request): array
     {
-        $onceProps = $this->oncePropsResolver
-            ? App::call($this->oncePropsResolver, ['request' => $request])
-            : [];
+        if ($request->header(Header::INERTIA)) {
+            return [];
+        }
+
+        $initialProps = collect($this->props)
+            ->filter(fn ($prop) => $prop instanceof InitialProp)
+            ->mapWithKeys(fn ($value, $key) => [$key => App::call($value)]);
 
-        return empty($onceProps) ? [] : ['onceProps' => $onceProps];
+        return $initialProps->isNotEmpty() ? ['initialProps' => $initialProps->toArray()] : [];
     }
 
     /**

src/ResponseFactory.php

@@ -35,12 +35,8 @@ class ResponseFactory
     /** @var Closure|null */
     protected $urlResolver;
 
-    /** @var Closure|null */
-    protected $oncePropsResolver;
-
     /**
-     * @param string $name The name of the root view
-     * @return void
+     * @param  string  $name  The name of the root view
      */
     public function setRootView(string $name): void
     {
@@ -105,11 +101,6 @@ public function resolveUrlUsing(?Closure $urlResolver = null): void
         $this->urlResolver = $urlResolver;
     }
 
-    public function resolveOncePropsUsing(?Closure $oncePropsResolver = null): void
-    {
-        $this->oncePropsResolver = $oncePropsResolver;
-    }
-
     public function clearHistory(): void
     {
         session(['inertia.clear_history' => true]);
@@ -136,6 +127,11 @@ public function optional(callable $callback): OptionalProp
         return new OptionalProp($callback);
     }
 
+    public function initial(callable $callback): InitialProp
+    {
+        return new InitialProp($callback);
+    }
+
     public function defer(callable $callback, string $group = 'default'): DeferProp
     {
         return new DeferProp($callback, $group);
@@ -197,7 +193,6 @@ public function render(string $component, $props = []): Response
             $this->getVersion(),
             $this->encryptHistory ?? config('inertia.history.encrypt', false),
             $this->urlResolver,
-            $this->oncePropsResolver,
         );
     }
 

stubs/middleware.stub

@@ -40,16 +40,4 @@ class {{ class }} extends Middleware
             //
         ];
     }
-
-    /**
-     * Defines the props that are shared for one time.
-     *
-     * @return Closure
-     */
-    public function oncePropsResolver()
-    {
-        return function (Request $request): array {
-            return [];
-        };
-    }
 }

tests/InitialPropTest.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Inertia\Tests;
+
+use Illuminate\Http\Request;
+use Illuminate\Session\Middleware\StartSession;
+use Illuminate\Support\Facades\Route;
+use Inertia\Inertia;
+use Inertia\InitialProp;
+use Inertia\Tests\Stubs\ExampleMiddleware;
+
+class InitialPropTest extends TestCase
+{
+    public function test_initial_props_accessibility()
+    {
+        Inertia::share([
+            'initial' => Inertia::initial(fn () => true),
+            'appName' => Inertia::initial(fn () => 'test'),
+        ]);
+
+        $this->prepareMockEndpoint();
+
+        $response = $this->withoutExceptionHandling()->get('/');
+
+        $response->assertSuccessful();
+        $this->assertSame(
+            '<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;errors&quot;:{}},&quot;url&quot;:&quot;\/&quot;,&quot;version&quot;:&quot;&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;initialProps&quot;:{&quot;initial&quot;:true,&quot;appName&quot;:&quot;test&quot;}}"></div>',
+            $response->content(),
+        );
+    }
+
+    public function test_initial_props_are_not_accessible()
+    {
+        Inertia::share([
+            'initial' => Inertia::initial(fn () => true),
+            'appName' => Inertia::initial(fn () => 'test'),
+        ]);
+
+        $this->prepareMockEndpoint();
+
+        $response = $this->withoutExceptionHandling()->get('/', [
+            'X-Inertia' => 'true',
+        ]);
+
+        $response->assertSuccessful();
+        $response->assertJsonMissingPath('initialProps');
+    }
+
+    public function test_can_invoke(): void
+    {
+        $initialProp = new InitialProp(function () {
+            return 'A initial value';
+        });
+
+        $this->assertSame('A initial value', $initialProp());
+    }
+
+    public function test_can_resolve_bindings_when_invoked(): void
+    {
+        $initialProp = new InitialProp(function (Request $request) {
+            return $request;
+        });
+
+        $this->assertInstanceOf(Request::class, $initialProp());
+    }
+
+    private function prepareMockEndpoint(): \Illuminate\Routing\Route
+    {
+        return Route::middleware([StartSession::class, ExampleMiddleware::class])->get('/', function () {
+            return Inertia::render('User/Edit');
+        });
+    }
+}

tests/MiddlewareTest.php

@@ -12,7 +12,6 @@
 use Inertia\AlwaysProp;
 use Inertia\Inertia;
 use Inertia\Middleware;
-use Inertia\Tests\Stubs\CustomOncePropsResolverMiddleware;
 use Inertia\Tests\Stubs\CustomUrlResolverMiddleware;
 use Inertia\Tests\Stubs\ExampleMiddleware;
 use LogicException;
@@ -147,19 +146,6 @@ public function test_the_url_can_be_resolved_with_a_custom_resolver()
         ]);
     }
 
-    public function test_the_once_props_can_be_resolved_with_a_custom_resolver()
-    {
-        $this->prepareMockEndpoint(middleware: new CustomOncePropsResolverMiddleware);
-
-        $response = $this->withoutExceptionHandling()->get('/');
-
-        $response->assertSuccessful();
-        $this->assertSame(
-            '<div id="app" data-page="{&quot;component&quot;:&quot;User\/Edit&quot;,&quot;props&quot;:{&quot;errors&quot;:{},&quot;user&quot;:{&quot;name&quot;:&quot;Jonathan&quot;}},&quot;url&quot;:&quot;\/&quot;,&quot;version&quot;:&quot;&quot;,&quot;clearHistory&quot;:false,&quot;encryptHistory&quot;:false,&quot;onceProps&quot;:{&quot;once&quot;:true,&quot;appName&quot;:&quot;test&quot;}}"></div>',
-            $response->content(),
-        );
-    }
-
     public function test_validation_errors_are_registered_as_of_default(): void
     {
         Route::middleware([StartSession::class, ExampleMiddleware::class])->get('/', function () {

tests/ResponseFactoryTest.php

@@ -15,6 +15,7 @@
 use Inertia\ComponentNotFoundException;
 use Inertia\DeferProp;
 use Inertia\Inertia;
+use Inertia\InitialProp;
 use Inertia\LazyProp;
 use Inertia\MergeProp;
 use Inertia\OptionalProp;
@@ -342,6 +343,16 @@ public function test_can_create_optional_prop(): void
         $this->assertInstanceOf(OptionalProp::class, $optionalProp);
     }
 
+    public function test_can_create_initial_prop(): void
+    {
+        $factory = new ResponseFactory;
+        $initialProp = $factory->initial(function () {
+            return 'An initial value';
+        });
+
+        $this->assertInstanceOf(InitialProp::class, $initialProp);
+    }
+
     public function test_can_create_always_prop(): void
     {
         $factory = new ResponseFactory;