Update payload structure

Author: jessarcher

src/Records/Request.php

@@ -25,7 +25,7 @@ public function __construct(
         public readonly int $requestSize,
         public readonly int $responseSize,
         public HeaderBag $headers,
-        public ?InputBag $payload,
+        public InputBag $payload,
         public FileBag $files,
     ) {
         //

src/Sensors/RequestSensor.php

@@ -9,16 +9,17 @@
 use Laravel\Nightwatch\Concerns\RecordsContext;
 use Laravel\Nightwatch\Concerns\RedactsHeaders;
 use Laravel\Nightwatch\ExecutionStage;
+use Laravel\Nightwatch\Facades\Nightwatch;
 use Laravel\Nightwatch\Records\Request as RequestRecord;
 use Laravel\Nightwatch\State\RequestState;
 use Laravel\Nightwatch\Types\Str;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
-use Symfony\Component\HttpFoundation\InputBag;
 use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
 use function array_map;
 use function array_sum;
+use function assert;
 use function hash;
 use function implode;
 use function in_array;
@@ -101,7 +102,7 @@ public function __invoke(Request $request, Response $response): array
                     $headers->remove('php-auth-pw');
                     $headers->remove('php-auth-digest');
                 }),
-                payload: rescue(static fn () => $request->getPayload(), report: false),
+                payload: clone $request->request,
                 files: clone $request->files,
             ),
             function () use ($record) {
@@ -152,16 +153,18 @@ function () use ($record) {
                     'context' => $this->serializedContext(),
                     'headers' => Str::text(json_encode((object) $this->redactHeaders($record->headers, $this->redactHeaders)->all(), JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION)),
                     'body' => $this->captureBody && $record->statusCode === 500
-                        ? Str::text(json_encode([
-                            'payload' => $record->payload instanceof InputBag ? $this->redactRecursively($record->payload->all()) : null,
-                            'files' => array_map(static fn (UploadedFile $file) => [
-                                'client_name' => $file->getClientOriginalName(),
-                                'client_mime_type' => $file->getClientMimeType(),
-                                'mime_type' => $file->getMimeType(),
-                                'size' => $file->getSize(),
-                                'path' => $file->getPathname(),
-                            ], $record->files->all()),
-                        ], JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT))
+                        ? Str::text(rescue(
+                            fn () => json_encode([
+                                ...$this->redactRecursively($record->payload->all()),
+                                '_nightwatch_files' => $this->mapUploadedFilesRecursively($record->files->all()),
+                            ], JSON_THROW_ON_ERROR | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION),
+                            '{"_nightwatch_error":"Failed to serialize body"}',
+                            static function ($e) {
+                                Nightwatch::unrecoverableExceptionOccurred($e);
+
+                                return false;
+                            }
+                        ))
                         : '',
                 ];
             },
@@ -208,4 +211,27 @@ private function redactRecursively(array $array): array
             return ! in_array($key, $this->redactKeys, true) || ! is_string($value) ? $value : '['.strlen($value).' bytes redacted]';
         });
     }
+
+    /**
+     * @param  array<mixed>  $files
+     * @return array<mixed>
+     */
+    private function mapUploadedFilesRecursively(array $files): array
+    {
+        return array_map(function ($file) {
+            if (is_array($file)) {
+                return $this->mapUploadedFilesRecursively($file);
+            }
+
+            assert($file instanceof UploadedFile);
+
+            return [
+                'client_name' => $file->getClientOriginalName(),
+                'client_mime_type' => $file->getClientMimeType(),
+                'mime_type' => $file->getMimeType(),
+                'size' => $file->getSize(),
+                'path' => $file->getPathname(),
+            ];
+        }, $files);
+    }
 }

tests/Feature/Sensors/RequestSensorTest.php

@@ -27,7 +27,6 @@
 use Orchestra\Testbench\Attributes\WithEnv;
 use Tests\TestCase;
 
-use function array_keys;
 use function fseek;
 use function fwrite;
 use function hash;
@@ -948,34 +947,31 @@ public function test_it_captures_a_form_request_body_on_unhandled_exceptions():
                 'user' => [
                     'username' => 'taylor',
                     'password' => '$f4c4d3',
+                    'avatar' => UploadedFile::fake()->create('avatar.jpg', 1, 'image/jpeg'),
                 ],
-                'avatar' => UploadedFile::fake()->create('avatar.jpg', 1, 'image/jpeg'),
             ]);
 
         $response->assertInternalServerError();
         $ingest->assertWrittenTimes(1);
         $ingest->assertLatestWrite('request:0.body', function ($body) {
             $body = json_decode($body, true);
-            $this->assertNotNull($body);
             $this->assertSame([
                 'user' => [
                     'username' => 'taylor',
                     'password' => '[7 bytes redacted]',
                 ],
-            ], $body['payload']);
-            $this->assertCount(1, $body['files']);
-            $this->assertEqualsCanonicalizing([
-                'client_name',
-                'client_mime_type',
-                'mime_type',
-                'size',
-                'path',
-            ], array_keys($body['files']['avatar']));
-            $this->assertSame('avatar.jpg', $body['files']['avatar']['client_name']);
-            $this->assertSame('image/jpeg', $body['files']['avatar']['client_mime_type']);
-            $this->assertSame('image/jpeg', $body['files']['avatar']['mime_type']);
-            $this->assertSame(1024, $body['files']['avatar']['size']);
-            $this->assertFileExists($body['files']['avatar']['path']);
+                '_nightwatch_files' => [
+                    'user' => [
+                        'avatar' => [
+                            'client_name' => 'avatar.jpg',
+                            'client_mime_type' => 'image/jpeg',
+                            'mime_type' => 'image/jpeg',
+                            'size' => 1024,
+                            'path' => $body['_nightwatch_files']['user']['avatar']['path'],
+                        ],
+                    ],
+                ],
+            ], $body);
 
             return true;
         });
@@ -1001,14 +997,13 @@ public function test_it_captures_a_json_body_on_unhandled_exceptions(): void
         $ingest->assertWrittenTimes(1);
         $ingest->assertLatestWrite('request:0.body', function ($body) {
             $body = json_decode($body, true);
-            $this->assertNotNull($body);
             $this->assertSame([
                 'user' => [
                     'username' => 'taylor',
                     'password' => '[7 bytes redacted]',
                 ],
-            ], $body['payload']);
-            $this->assertCount(0, $body['files']);
+                '_nightwatch_files' => [],
+            ], $body);
 
             return true;
         });
@@ -1036,14 +1031,14 @@ public function test_the_redacted_keys_can_be_customized(): void
         $ingest->assertWrittenTimes(1);
         $ingest->assertLatestWrite('request:0.body', function ($body) {
             $body = json_decode($body, true);
-            $this->assertNotNull($body);
             $this->assertSame([
                 'user' => [
                     'username' => 'taylor',
                     'password' => '$f4c4d3',
                 ],
                 'foo' => '[3 bytes redacted]',
-            ], $body['payload']);
+                '_nightwatch_files' => [],
+            ], $body);
 
             return true;
         });