Capture request body on unhandled exception

Author: jessarcher

config/nightwatch.php

@@ -6,6 +6,8 @@
     'deployment' => env('NIGHTWATCH_DEPLOY'),
     'server' => env('NIGHTWATCH_SERVER', (string) gethostname()),
     'capture_exception_source_code' => env('NIGHTWATCH_CAPTURE_EXCEPTION_SOURCE_CODE', true),
+    'capture_request_body' => env('NIGHTWATCH_CAPTURE_REQUEST_BODY', false),
+    'redact_keys' => explode(',', env('NIGHTWATCH_REDACT_KEYS', 'password,password_confirmation')),
 
     'sampling' => [
         'requests' => env('NIGHTWATCH_REQUEST_SAMPLE_RATE', 1.0),

src/NightwatchServiceProvider.php

@@ -120,6 +120,8 @@ final class NightwatchServiceProvider extends ServiceProvider
      *     server?: string,
      *     ingest?: array{ uri?: string, timeout?: float|int, connection_timeout?: float|int, event_buffer?: int },
      *     capture_exception_source_code?: bool,
+     *     capture_request_body?: bool,
+     *     redact_keys?: string[],
      *  }
      */
     private array $nightwatchConfig;
@@ -250,6 +252,8 @@ private function buildAndRegisterCore(): void
                     publicPath: $this->app->publicPath(),
                 ),
                 captureExceptionSourceCode: (bool) ($this->nightwatchConfig['capture_exception_source_code'] ?? true),
+                captureRequestBody: (bool) ($this->nightwatchConfig['capture_request_body'] ?? false),
+                redactKeys: $this->nightwatchConfig['redact_keys'] ?? ['password', 'password_confirmation'],
                 config: $this->config,
             ),
             executionState: $executionState,

src/Records/Request.php

@@ -2,6 +2,9 @@
 
 namespace Laravel\Nightwatch\Records;
 
+use Symfony\Component\HttpFoundation\FileBag;
+use Symfony\Component\HttpFoundation\InputBag;
+
 final class Request
 {
     /**
@@ -20,6 +23,8 @@ public function __construct(
         public readonly int $statusCode,
         public readonly int $requestSize,
         public readonly int $responseSize,
+        public InputBag $post,
+        public FileBag $files,
     ) {
         //
     }

src/SensorManager.php

@@ -127,11 +127,16 @@ final class SensorManager
      */
     public $commandSensor;
 
+    /**
+     * @param  list<string>  $redactKeys
+     */
     public function __construct(
         private RequestState|CommandState $executionState,
         private Clock $clock,
         public Location $location,
         private bool $captureExceptionSourceCode,
+        private bool $captureRequestBody,
+        private array $redactKeys,
         private Repository $config,
     ) {
         //
@@ -154,6 +159,8 @@ public function request(Request $request, Response $response): array
     {
         $sensor = $this->requestSensor ??= new RequestSensor(
             requestState: $this->executionState, // @phpstan-ignore argument.type
+            captureBody: $this->captureRequestBody,
+            redactKeys: $this->redactKeys,
         );
 
         return $sensor($request, $response);

src/Sensors/RequestSensor.php

@@ -3,7 +3,9 @@
 namespace Laravel\Nightwatch\Sensors;
 
 use Illuminate\Http\Request;
+use Illuminate\Http\UploadedFile;
 use Illuminate\Routing\Route;
+use Illuminate\Support\Arr;
 use Laravel\Nightwatch\Concerns\RecordsContext;
 use Laravel\Nightwatch\ExecutionStage;
 use Laravel\Nightwatch\Records\Request as RequestRecord;
@@ -13,12 +15,16 @@
 use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 
+use function array_map;
 use function array_sum;
 use function hash;
 use function implode;
+use function in_array;
+use function is_array;
 use function is_int;
 use function is_numeric;
 use function is_string;
+use function json_encode;
 use function sort;
 use function strlen;
 
@@ -29,8 +35,13 @@ final class RequestSensor
 {
     use RecordsContext;
 
+    /**
+     * @param  list<string>  $redactKeys
+     */
     public function __construct(
         private RequestState $requestState,
+        private bool $captureBody,
+        private array $redactKeys,
     ) {
         //
     }
@@ -78,6 +89,8 @@ public function __invoke(Request $request, Response $response): array
                 statusCode: $response->getStatusCode(),
                 requestSize: strlen($request->getContent()),
                 responseSize: $this->parseResponseSize($response),
+                post: clone $request->request,
+                files: clone $request->files,
             ),
             function () use ($record) {
                 return [
@@ -125,6 +138,18 @@ function () use ($record) {
                     'peak_memory_usage' => $this->requestState->peakMemory(),
                     'exception_preview' => Str::tinyText($this->requestState->exceptionPreview),
                     'context' => $this->serializedContext(),
+                    'body' => $this->captureBody && $record->statusCode === 500
+                        ? Str::text(json_encode([
+                            'post' => $this->redactRecursively($record->post->all()),
+                            'files' => array_map(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))
+                        : '',
                 ];
             },
         ];
@@ -155,4 +180,19 @@ private function parseResponseSize(Response $response): int
         // streamed response, e.g., echo Nightwatch::streaming($content);
         return 0;
     }
+
+    /**
+     * @param  array<mixed>  $array
+     * @return array<mixed>
+     */
+    private function redactRecursively(array $array): array
+    {
+        return Arr::map($array, function ($value, $key) {
+            if (is_array($value)) {
+                return $this->redactRecursively($value);
+            }
+
+            return ! in_array($key, $this->redactKeys, true) || ! is_string($value) ? $value : '['.strlen($value).' bytes redacted]';
+        });
+    }
 }

tests/Feature/Sensors/RequestSensorTest.php

@@ -13,6 +13,7 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Foundation\Http\Events\RequestHandled;
 use Illuminate\Http\Request;
+use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Context;
@@ -23,8 +24,10 @@
 use Laravel\Nightwatch\ExecutionStage;
 use Laravel\Nightwatch\SensorManager;
 use Livewire\Livewire;
+use Orchestra\Testbench\Attributes\WithEnv;
 use Tests\TestCase;
 
+use function array_keys;
 use function fseek;
 use function fwrite;
 use function hash;
@@ -110,6 +113,7 @@ public function test_it_can_ingest_requests(): void
                 'peak_memory_usage' => 1234,
                 'exception_preview' => '',
                 'context' => Compatibility::$contextExists ? '{}' : '',
+                'body' => '',
             ],
         ]);
     }
@@ -815,6 +819,52 @@ public function test_it_captures_context(): void
         });
     }
 
+    #[WithEnv('NIGHTWATCH_CAPTURE_REQUEST_BODY', 'true')]
+    public function test_it_captures_the_body_on_unhandled_exceptions(): void
+    {
+        $ingest = $this->fakeIngest();
+        Route::patch('/register', function () {
+            throw new Exception('Whoops!');
+        });
+
+        $response = $this
+            ->patch('/register?redirect=1', [
+                'user' => [
+                    'username' => 'taylor',
+                    'password' => '$f4c4d3',
+                ],
+                'avatar' => UploadedFile::fake()->image('avatar.jpg'),
+            ]);
+
+        $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['post']);
+            $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(695, $body['files']['avatar']['size']);
+            $this->assertFileExists($body['files']['avatar']['path']);
+
+            return true;
+        });
+    }
+
     public function test_livewire_2(): void
     {
         $this->markTestSkippedWhen(version_compare(InstalledVersions::getVersion('livewire/livewire'), '3.0.0', '>='), 'Requires Livewire 2');