Make clearHistory and encryptHistory optional in page object (#834)

Author: pascalbaljet

src/Response.php

@@ -183,10 +183,10 @@ public function toResponse($request)
                 'props' => $resolvedProps,
                 'url' => $this->getUrl($request),
                 'version' => $this->version,
-                'clearHistory' => $this->clearHistory,
-                'encryptHistory' => $this->encryptHistory,
             ],
             $resolvedMetadata,
+            $this->resolveClearHistory($request),
+            $this->resolveEncryptHistory($request),
             $this->resolveFlashData($request),
             $this->resolvePreserveFragment($request),
         );
@@ -198,6 +198,26 @@ public function toResponse($request)
         return ResponseFactory::view($this->rootView, $this->viewData + ['page' => $page]);
     }
 
+    /**
+     * Resolve the clear history flag.
+     *
+     * @return array<string, mixed>
+     */
+    protected function resolveClearHistory(Request $request): array
+    {
+        return $this->clearHistory ? ['clearHistory' => true] : [];
+    }
+
+    /**
+     * Resolve the encrypt history flag.
+     *
+     * @return array<string, mixed>
+     */
+    protected function resolveEncryptHistory(Request $request): array
+    {
+        return $this->encryptHistory ? ['encryptHistory' => true] : [];
+    }
+
     /**
      * Resolve flash data from the session.
      *

src/Testing/AssertableInertia.php

@@ -78,8 +78,6 @@ public static function fromTestResponse(TestResponse $response): self
             PHPUnit::assertArrayHasKey('props', $page);
             PHPUnit::assertArrayHasKey('url', $page);
             PHPUnit::assertArrayHasKey('version', $page);
-            PHPUnit::assertArrayHasKey('encryptHistory', $page);
-            PHPUnit::assertArrayHasKey('clearHistory', $page);
         } catch (AssertionFailedError $e) {
             PHPUnit::fail('Not a valid Inertia response.');
         }
@@ -88,8 +86,8 @@ public static function fromTestResponse(TestResponse $response): self
         $instance->component = $page['component'];
         $instance->url = $page['url'];
         $instance->version = $page['version'];
-        $instance->encryptHistory = $page['encryptHistory'];
-        $instance->clearHistory = $page['clearHistory'];
+        $instance->encryptHistory = isset($page['encryptHistory']);
+        $instance->clearHistory = isset($page['clearHistory']);
         $instance->deferredProps = $page['deferredProps'] ?? [];
         $instance->flash = $page['flash'] ?? [];
 
@@ -291,14 +289,16 @@ public static function assertFlashMissing(array $flash, string $key): void
      */
     public function toArray()
     {
-        return [
-            'component' => $this->component,
-            'props' => $this->prop(),
-            'url' => $this->url,
-            'version' => $this->version,
-            'encryptHistory' => $this->encryptHistory,
-            'clearHistory' => $this->clearHistory,
-            'flash' => $this->flash,
-        ];
+        return array_merge(
+            [
+                'component' => $this->component,
+                'props' => $this->prop(),
+                'url' => $this->url,
+                'version' => $this->version,
+                'flash' => $this->flash,
+            ],
+            $this->encryptHistory ? ['encryptHistory' => true] : [],
+            $this->clearHistory ? ['clearHistory' => true] : [],
+        );
     }
 }

tests/ControllerTest.php

@@ -28,8 +28,6 @@ public function test_controller_returns_an_inertia_response(): void
             ],
             'url' => '/',
             'version' => '',
-            'encryptHistory' => false,
-            'clearHistory' => false,
         ]);
     }
 }

tests/DirectiveTest.php

@@ -55,7 +55,7 @@ public function test_inertia_directive_renders_the_root_element(): void
     {
         Config::set(['inertia.ssr.enabled' => false]);
 
-        $html = '<script data-page="app" type="application/json">{"component":"Foo\/Bar","props":{"foo":"bar"},"url":"\/test","version":"","encryptHistory":false,"clearHistory":false}</script><div id="app"></div>';
+        $html = '<script data-page="app" type="application/json">{"component":"Foo\/Bar","props":{"foo":"bar"},"url":"\/test","version":""}</script><div id="app"></div>';
 
         $this->assertSame($html, $this->renderView('@inertia', ['page' => self::EXAMPLE_PAGE_OBJECT]));
         $this->assertSame($html, $this->renderView('@inertia()', ['page' => self::EXAMPLE_PAGE_OBJECT]));
@@ -77,7 +77,7 @@ public function test_inertia_directive_can_use_a_different_root_element_id(): vo
     {
         Config::set(['inertia.ssr.enabled' => false]);
 
-        $html = '<script data-page="foo" type="application/json">{"component":"Foo\/Bar","props":{"foo":"bar"},"url":"\/test","version":"","encryptHistory":false,"clearHistory":false}</script><div id="foo"></div>';
+        $html = '<script data-page="foo" type="application/json">{"component":"Foo\/Bar","props":{"foo":"bar"},"url":"\/test","version":""}</script><div id="foo"></div>';
 
         $this->assertSame($html, $this->renderView('@inertia(foo)', ['page' => self::EXAMPLE_PAGE_OBJECT]));
         $this->assertSame($html, $this->renderView("@inertia('foo')", ['page' => self::EXAMPLE_PAGE_OBJECT]));

tests/HistoryTest.php

@@ -22,11 +22,8 @@ public function test_the_history_is_not_encrypted_or_cleared_by_default(): void
         ]);
 
         $response->assertSuccessful();
-        $response->assertJson([
-            'component' => 'User/Edit',
-            'encryptHistory' => false,
-            'clearHistory' => false,
-        ]);
+        $response->assertJsonMissing(['encryptHistory' => true]);
+        $response->assertJsonMissing(['clearHistory' => true]);
     }
 
     public function test_the_history_can_be_encrypted(): void
@@ -116,10 +113,7 @@ public function test_the_history_can_be_encrypted_globally_and_overridden(): voi
         ]);
 
         $response->assertSuccessful();
-        $response->assertJson([
-            'component' => 'User/Edit',
-            'encryptHistory' => false,
-        ]);
+        $response->assertJsonMissing(['encryptHistory' => true]);
     }
 
     public function test_the_history_can_be_cleared(): void
@@ -160,7 +154,7 @@ public function test_the_history_can_be_cleared_when_redirecting(): void
         ]);
 
         $response->assertSuccessful();
-        $response->assertContent('<script data-page="app" type="application/json">{"component":"User\/Edit","props":{"errors":{}},"url":"\/users","version":"","clearHistory":true,"encryptHistory":false}</script><div id="app"></div>');
+        $response->assertContent('<script data-page="app" type="application/json">{"component":"User\/Edit","props":{"errors":{}},"url":"\/users","version":"","clearHistory":true}</script><div id="app"></div>');
     }
 
     public function test_the_fragment_is_not_preserved_by_default(): void