chore: add response body content limit

Author: happyDemon

config/saloon-utils.php

@@ -7,6 +7,8 @@
         'enabled' => env('SALOON_REQUEST_LOGS', true),
         // Pruning
         'keep_for_days' => env('SALOON_REQUEST_PRUNE', 14),
+        // The bundled migration uses longtext, which allows for 4,294,967,295 characters
+        'response_max_length' => 4294967295,
         // Skip request logging
         'ignore' => [
             'connectors' => [],

src/Logger/LoggerRepository.php

@@ -78,7 +78,7 @@ public function logResponse(Response $response, mixed $log, Connector $connector
      */
     public function logFatalError(FatalRequestException $response, mixed $log, Connector $connector): mixed
     {
-        // Initial request was not logged
+        // The initial request was not logged
         if (empty($log)) {
             return null;
         }

src/Logger/SaloonRequest.php

@@ -4,12 +4,30 @@
 
 namespace HappyDemon\SaloonUtils\Logger;
 
+use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\MassPrunable;
 use Illuminate\Database\Eloquent\Model;
 
 /**
  * This model manages request logs
+ *
+ * @property int $id
+ * @property string $connector The fully qualified class name of the connector
+ * @property string $request The fully qualified class name of the request
+ * @property string $method The HTTP method used
+ * @property string $endpoint The endpoint that was called
+ * @property array $request_headers The headers sent with the request
+ * @property array $request_query The query parameters sent with the request
+ * @property array $request_body The body sent with the request
+ * @property array $response_headers The headers received in the response
+ * @property array $response_body The body received in the response
+ * @property int $status_code The HTTP status code received in the response
+ * @property Carbon $completed_at When the request was completed
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ *
+ * @mixin Builder
  */
 class SaloonRequest extends Model
 {
@@ -58,7 +76,7 @@ protected function casts(): array
      */
     public function prunable(): Builder
     {
-        return static::where(
+        return $this->newQuery()->where(
             'created_at',
             '<=',
             now()->startOfDay()->subDays(config('saloon-utils.logs.keep_for_days', 14))

src/Logger/Stores/ConvertsResponseBody.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Logger\Stores;
+
+use Saloon\Http\Response;
+
+trait ConvertsResponseBody
+{
+    public function convertResponseBody(Response $response): string
+    {
+        $contentType = $response->header('Content-Type') ?: $response->header('content-type');
+
+        if (in_array($contentType, [
+            'application/json',
+            'application/xml',
+            'application/soap+xml',
+            'text/xml',
+            'text/html',
+            'text/plain',
+            null,
+        ], true)) {
+            $body = $response->body();
+
+            return strlen($body) >= config('saloon-utils.logs.response_max_length') ? 'too large' : $body;
+        }
+
+        return 'unsupported body: '.$contentType;
+    }
+}

src/Logger/Stores/DatabaseLogger.php

@@ -13,6 +13,8 @@
 
 class DatabaseLogger implements Logger
 {
+    use ConvertsResponseBody;
+
     public function create(PendingRequest $request, Connector $connector): mixed
     {
         $log = SaloonRequest::create([
@@ -35,7 +37,7 @@ public function updateWithResponse(mixed $log, Response $response, Connector $co
     {
         $log->update([
             'response_headers' => $response->headers()->all(),
-            'response_body' => $response->body(),
+            'response_body' => $this->convertResponseBody($response),
             'status_code' => $response->status(),
             'completed_at' => now(),
         ]);

src/Logger/Stores/MemoryLogger.php

@@ -20,6 +20,8 @@
  */
 class MemoryLogger implements Logger
 {
+    use ConvertsResponseBody;
+
     protected Repository $store;
 
     public function __construct()
@@ -69,7 +71,7 @@ public function updateWithResponse(mixed $log, Response $response, Connector $co
     {
         $log = array_merge($log, [
             'response_headers' => $response->headers()->all(),
-            'response_body' => $response->body(),
+            'response_body' => $this->convertResponseBody($response),
             'status_code' => $response->status(),
             'completed_at' => now(),
         ]);

tests/Unit/Logger/DatabaseLoggerTest.php …it/Logger/Storage/DatabaseLoggerTest.phptests/Unit/Logger/DatabaseLoggerTest.php renamed to tests/Unit/Logger/Storage/DatabaseLoggerTest.php tests/Unit/Logger/DatabaseLoggerTest.php renamed to tests/Unit/Logger/Storage/DatabaseLoggerTest.php

@@ -2,42 +2,52 @@
 
 declare(strict_types=1);
 
-namespace HappyDemon\SaloonUtils\Tests\Unit\Logger;
+namespace HappyDemon\SaloonUtils\Tests\Unit\Logger\Storage;
 
 use HappyDemon\SaloonUtils\Logger\SaloonRequest;
 use HappyDemon\SaloonUtils\Tests\Saloon\Connectors\ConnectorFatal;
 use HappyDemon\SaloonUtils\Tests\Saloon\Connectors\ConnectorGeneric;
 use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRequest;
 use HappyDemon\SaloonUtils\Tests\TestCaseDatabase;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use Saloon\Config;
 use Saloon\Exceptions\Request\FatalRequestException;
 use Saloon\Exceptions\Request\RequestException;
 use Saloon\Http\Faking\MockClient;
 use Saloon\Http\Faking\MockResponse;
 
-class DatabaseLoggerTest extends TestCaseDatabase
+class DatabaseLoggerTest extends TestCaseDatabase implements StorageLoggerInterface
 {
     /**
      * @throws FatalRequestException
      * @throws RequestException
      */
-    #[Test]
-    public function logs_response(): void
+    protected function doSuccessfulRequest(?string $responseBody = null): void
     {
         $connector = app(ConnectorGeneric::class);
         $mockClient = new MockClient([
-            GoogleSearchRequest::class => MockResponse::make('', 200),
+            GoogleSearchRequest::class => MockResponse::make($responseBody ?: '', 200),
         ]);
         $connector->withMockClient($mockClient);
 
         // Send the request
         $connector->search('saloon');
+    }
+
+    /**
+     * @throws FatalRequestException
+     * @throws RequestException
+     */
+    #[Test]
+    public function logs_response(): void
+    {
+        $this->doSuccessfulRequest();
 
         $this->assertDatabaseCount((new SaloonRequest)->getTable(), 1);
 
         /** @var SaloonRequest $log */
-        $log = SaloonRequest::first();
+        $log = SaloonRequest::query()->first();
         $request = new GoogleSearchRequest('saloon');
 
         $this->assertEquals(200, $log->status_code);
@@ -53,7 +63,7 @@ public function logs_response(): void
      * @throws RequestException
      */
     #[Test]
-    public function logs_multiple(): void
+    public function logs_multiple_responses(): void
     {
         $connector = app(ConnectorGeneric::class);
         $mockClient = new MockClient([
@@ -70,14 +80,31 @@ public function logs_multiple(): void
 
             // verify the data matches
             $request = new GoogleSearchRequest($search);
-            $log = $model->get()[$i];
 
-            $this->assertEquals(200, $log->status_code, 'status code should be 200');
-            $this->assertEquals($request->query()->all(), $log->request_query, 'Query parameters should match');
-            $this->assertEquals($request->resolveEndpoint(), $log->endpoint, 'Endpoint should have set correctly');
+            /** @var SaloonRequest $log */
+            $log = $model->newQuery()->get()[$i];
+
+            $this->assertEquals(
+                200,
+                $log->status_code,
+                'status code should be 200'
+            );
+            $this->assertEquals(
+                $request->query()->all(),
+                $log->request_query,
+                'Query parameters should match'
+            );
+            $this->assertEquals(
+                $request->resolveEndpoint(),
+                $log->endpoint,
+                'Endpoint should have set correctly'
+            );
         }
     }
 
+    /**
+     * @throws RequestException
+     */
     #[Test]
     public function handles_fatal_error_correctly(): void
     {
@@ -92,12 +119,44 @@ public function handles_fatal_error_correctly(): void
         } catch (FatalRequestException $e) {
             $this->assertDatabaseCount((new SaloonRequest)->getTable(), 1);
 
-            $log = SaloonRequest::first();
+            /** @var SaloonRequest $log */
+            $log = SaloonRequest::query()->first();
             $request = new GoogleSearchRequest('saloon');
 
             $this->assertEquals(418, $log->status_code);
             $this->assertEquals($request->query()->all(), $log->request_query);
             $this->assertEquals($request->resolveEndpoint(), $log->endpoint);
         }
     }
+
+    public static function bodySizes(): array
+    {
+        return [
+            'exceeds limit' => [
+                'sent' => '123456789101112',
+                'stored' => 'too large',
+            ],
+            'within limits' => [
+                'sent' => 'data',
+                'stored' => 'data',
+            ],
+        ];
+    }
+
+    /**
+     * @throws FatalRequestException
+     * @throws RequestException
+     */
+    #[Test]
+    #[DataProvider('bodySizes')]
+    public function response_body_size_is_respected(string $sent, string $stored): void
+    {
+        config()->set('saloon-utils.logs.response_max_length', 10);
+        $this->doSuccessfulRequest($sent);
+
+        /** @var SaloonRequest $log */
+        $log = SaloonRequest::query()->first();
+
+        $this->assertEquals($stored, $log->response_body);
+    }
 }

tests/Unit/Logger/MemoryLoggerTest.php …Unit/Logger/Storage/MemoryLoggerTest.phptests/Unit/Logger/MemoryLoggerTest.php renamed to tests/Unit/Logger/Storage/MemoryLoggerTest.php tests/Unit/Logger/MemoryLoggerTest.php renamed to tests/Unit/Logger/Storage/MemoryLoggerTest.php

@@ -2,16 +2,17 @@
 
 declare(strict_types=1);
 
-namespace HappyDemon\SaloonUtils\Tests\Unit\Logger;
+namespace HappyDemon\SaloonUtils\Tests\Unit\Logger\Storage;
 
 use HappyDemon\SaloonUtils\Logger\LoggerRepository;
 use HappyDemon\SaloonUtils\Logger\Stores\MemoryLogger;
 use HappyDemon\SaloonUtils\Tests\Saloon\Connectors\ConnectorFatal;
 use HappyDemon\SaloonUtils\Tests\Saloon\Connectors\ConnectorProvidesLogger;
 use HappyDemon\SaloonUtils\Tests\Saloon\Logger;
 use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRequest;
-use HappyDemon\SaloonUtils\Tests\TestCaseDatabase;
+use HappyDemon\SaloonUtils\Tests\TestCase;
 use Illuminate\Cache\Repository;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use Psr\SimpleCache\InvalidArgumentException;
 use ReflectionClass;
@@ -21,7 +22,7 @@
 use Saloon\Http\Faking\MockClient;
 use Saloon\Http\Faking\MockResponse;
 
-class MemoryLoggerTest extends TestCaseDatabase
+class MemoryLoggerTest extends TestCase implements StorageLoggerInterface
 {
     protected function setUpFreshLoggerAndGetCache()
     {
@@ -34,6 +35,22 @@ protected function setUpFreshLoggerAndGetCache()
         return $storeProperty->getValue($logger);
     }
 
+    /**
+     * @throws FatalRequestException
+     * @throws RequestException
+     */
+    protected function doSuccessfulRequest(?string $body = null): void
+    {
+        $connector = app(ConnectorProvidesLogger::class);
+        $mockClient = new MockClient([
+            GoogleSearchRequest::class => MockResponse::make($body ?: '', 200),
+        ]);
+        $connector->withMockClient($mockClient);
+
+        // Send the request
+        $connector->search('saloon');
+    }
+
     /**
      * @throws \ReflectionException
      */
@@ -67,14 +84,7 @@ public function logger_inits_correctly(): void
     #[Test]
     public function logs_response(): void
     {
-        $connector = app(ConnectorProvidesLogger::class);
-        $mockClient = new MockClient([
-            GoogleSearchRequest::class => MockResponse::make('', 200),
-        ]);
-        $connector->withMockClient($mockClient);
-
-        // Send the request
-        $connector->search('saloon');
+        $this->doSuccessfulRequest();
 
         $logger = app(MemoryLogger::class);
         $this->assertCount(1, $logger->logs());
@@ -93,7 +103,7 @@ public function logs_response(): void
      * @throws InvalidArgumentException
      */
     #[Test]
-    public function logs_multiple(): void
+    public function logs_multiple_responses(): void
     {
         $connector = app(ConnectorProvidesLogger::class);
         $mockClient = new MockClient([
@@ -143,4 +153,35 @@ public function handles_fatal_error_correctly(): void
             $this->assertIsArray($log);
         }
     }
+
+    public static function bodySizes(): array
+    {
+        return [
+            'exceeds limit' => [
+                'sent' => '123456789101112',
+                'stored' => 'too large',
+            ],
+            'within limits' => [
+                'sent' => 'data',
+                'stored' => 'data',
+            ],
+        ];
+    }
+
+    /**
+     * @throws FatalRequestException
+     * @throws RequestException
+     * @throws InvalidArgumentException
+     */
+    #[Test]
+    #[DataProvider('bodySizes')]
+    public function response_body_size_is_respected(string $sent, string $stored): void
+    {
+        config()->set('saloon-utils.logs.response_max_length', 10);
+        $this->doSuccessfulRequest($sent);
+
+        $logs = (new MemoryLogger)->logs();
+
+        $this->assertEquals($stored, $logs[0]['response_body']);
+    }
 }