Added option to enforce trimming of response body by setting a X-Global-Logger-Trim-Always request header

Author: onlime

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ## [v1.2.0 (2024-10-15)](https://github.com/onlime/laravel-http-client-global-logger/compare/v1.1.3...v1.2.0)
 
+- Feature | You can now enforce trimming of response body by setting a `X-Global-Logger-Trim-Always` request header, which will ignore the Content-Type whitelisting.
 - Drop PHP 8.1 support
 - Upgrade pestphp/pest to v3
 

README.md

@@ -49,8 +49,9 @@ Using the logger will log both the request and response of an external HTTP requ
 - Multi-line log records that contain full request/response information (including all headers and body)
 - Logging into separate logfile `http-client.log`. You're free to override this and use your own logging channel or just log to a different logfile.
 - Full support of [Guzzle MessageFormatter](https://github.com/guzzle/guzzle/blob/master/src/MessageFormatter.php) variable substitutions for highly customized log messages.
-- Basic obfuscation of credentials in HTTP Client requests
-- Trimming of response body content to a certain length with support for Content-Type whitelisting
+- Basic obfuscation of credentials in HTTP Client requests (both by header or body keys)
+- Trimming of response body content to a certain length with support for `Content-Type` whitelisting
+- Enforce trimming of response body content by setting a `X-Global-Logger-Trim-Always` request header, which will ignore the whitelisting.
 - **Variant 1: Global logging** (default)
   - Zero-configuration: Global logging is enabled by default in this package.
   - Simple and performant implementation using `RequestSending` / `ResponseReceived` event listeners

config/http-client-global-logger.php

@@ -118,6 +118,9 @@
     |
     | NOTE the leading comma in trim_response_body.content_type_whitelist default value:
     | it's there to whitelist empty content types (e.g. when no Content-Type header is set).
+    |
+    | The content type whitelisting can be ignored by setting the following header in the
+    | request: X-Global-Logger-Trim-Always (set it to any value, e.g. 'true').
     */
     'trim_response_body' => [
         'enabled' => env('HTTP_CLIENT_GLOBAL_LOGGER_TRIM_RESPONSE_BODY_ENABLED', false),

src/EventHelper.php

@@ -31,7 +31,7 @@ public static function getPsrRequest(object $event): RequestInterface
         return match (true) {
             $event instanceof RequestSending || $event instanceof ResponseReceived => $event->request->toPsrRequest(),
             $event instanceof SendingSaloonRequest || $event instanceof SentSaloonRequest =>  $event->pendingRequest->createPsrRequest(),
-            default => throw new Exception('Can not get PSR Request from Event: '.get_class($event)),
+            default => throw new Exception('Cannot get PSR Request from Event: '.get_class($event)),
         };
     }
 
@@ -40,7 +40,7 @@ public static function getPsrResponse(object $event): ResponseInterface
         return match (true) {
             $event instanceof ResponseReceived => $event->response->toPsrResponse(),
             $event instanceof SentSaloonRequest => $event->response->getPsrResponse(),
-            default => throw new Exception('Can not get PSR Response from Event: '.get_class($event)),
+            default => throw new Exception('Cannot get PSR Response from Event: '.get_class($event)),
         };
     }
 }

src/Listeners/LogResponseReceived.php

@@ -24,37 +24,43 @@ public function handle(ResponseReceived|SentSaloonRequest $event): void
         }
 
         $formatter = new MessageFormatter(config('http-client-global-logger.format.response'));
+        $psrRequest = EventHelper::getPsrRequest($event);
         Log::channel(config('http-client-global-logger.channel'))->info($formatter->format(
-            EventHelper::getPsrRequest($event),
-            $this->trimBody(EventHelper::getPsrResponse($event))
+            $psrRequest,
+            $this->trimBody(
+                EventHelper::getPsrResponse($event),
+                $psrRequest->hasHeader('X-Global-Logger-Trim-Always')
+            )
         ));
     }
 
     /**
      * Trim the response body when it's too long.
      */
-    private function trimBody(Response $psrResponse): Response|MessageInterface
+    private function trimBody(Response $psrResponse, bool $trimAlways = false): Response|MessageInterface
     {
         // Check if trimming is enabled
         if (! config('http-client-global-logger.trim_response_body.enabled')) {
             return $psrResponse;
         }
 
-        // E.g.: application/json; charset=utf-8 => application/json
-        $contentTypeHeader = Str::of($psrResponse->getHeaderLine('Content-Type'))
-            ->before(';')
-            ->trim()
-            ->lower()
-            ->value();
+        if (! $trimAlways) {
+            // E.g.: application/json; charset=utf-8 => application/json
+            $contentTypeHeader = Str::of($psrResponse->getHeaderLine('Content-Type'))
+                ->before(';')
+                ->trim()
+                ->lower()
+                ->value();
 
-        $whiteListedContentTypes = array_map(
-            fn (string $type) => trim(strtolower($type)),
-            config('http-client-global-logger.trim_response_body.content_type_whitelist')
-        );
+            $whiteListedContentTypes = array_map(
+                fn (string $type) => trim(strtolower($type)),
+                config('http-client-global-logger.trim_response_body.content_type_whitelist')
+            );
 
-        // Check if the content type is whitelisted
-        if (in_array($contentTypeHeader, $whiteListedContentTypes)) {
-            return $psrResponse;
+            // Check if the content type is whitelisted
+            if (in_array($contentTypeHeader, $whiteListedContentTypes)) {
+                return $psrResponse;
+            }
         }
 
         $limit = config('http-client-global-logger.trim_response_body.limit');

tests/HttpClientLoggerTest.php

@@ -44,7 +44,7 @@ function setupLogger(): MockInterface
     Http::fake()->get('https://example.com');
 });
 
-it('can trim the body response', function (array $config, string $contentType, bool $shouldTrim, bool $addCharsetToContentType) {
+it('can trim the response body', function (array $config, string $contentType, bool $shouldTrim, bool $addCharsetToContentType) {
     config(['http-client-global-logger.trim_response_body' => $config]);
 
     $logger = setupLogger();
@@ -126,3 +126,30 @@ function setupLogger(): MockInterface
         'without-charset' => ['addCharsetToContentType' => false],
     ]
 );
+
+it('always trims the response body when special header is set on request', function (bool $withHeader) {
+    config(['http-client-global-logger.trim_response_body' => [
+        'enabled' => true,
+        'limit' => 10,
+        'content_type_whitelist' => ['application/json'],
+    ]]);
+
+    $logger = setupLogger();
+
+    $logger->shouldReceive('info')->withArgs(function ($message) {
+        expect($message)->toContain('REQUEST: GET https://example.com');
+        return true;
+    })->once();
+
+    $logger->shouldReceive('info')->withArgs(function ($message) use ($withHeader) {
+        expect($message)->toContain($withHeader ? 'verylongbo...' : 'verylongbody');
+        return true;
+    })->once();
+
+    Http::fake([
+        '*' => Http::response('verylongbody', 200, [
+            'Content-Type' => 'application/json',
+        ]),
+    ])->withHeader($withHeader ? 'X-Global-Logger-Trim-Always' : 'X-Dummy', 'true')
+        ->get('https://example.com');
+})->with([true, false]);