move threshold check below content-type check, as it might be more resource intensive (getBody())

whitelist empty response Content-Type by default

Author: onlime

config/http-client-global-logger.php

@@ -114,14 +114,17 @@
     |--------------------------------------------------------------------------
     |
     | Trim response body to a certain length. This is useful when you are logging
-    | large responses and you don't want to fill up your log files.
+    | large responses, and you don't want to fill up your log files.
+    |
+    | 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).
     */
     'trim_response_body' => [
         'enabled' => env('HTTP_CLIENT_GLOBAL_LOGGER_TRIM_RESPONSE_BODY_ENABLED', false),
         'treshold' => env('HTTP_CLIENT_GLOBAL_LOGGER_TRIM_RESPONSE_BODY_TRESHOLD', 200),
         'content_type_whitelist' => explode(',', env(
             'HTTP_CLIENT_GLOBAL_LOGGER_TRIM_RESPONSE_BODY_CONTENT_TYPE_WHITELIST',
-            'application/json'
+            ',application/json'
         )),
     ],
 ];

src/Listeners/LogResponseReceived.php

@@ -9,6 +9,7 @@
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 use Onlime\LaravelHttpClientGlobalLogger\EventHelper;
+use Psr\Http\Message\MessageInterface;
 use Saloon\Laravel\Events\SentSaloonRequest;
 
 class LogResponseReceived
@@ -32,20 +33,13 @@ public function handle(ResponseReceived|SentSaloonRequest $event): void
     /**
      * Trim the response body when it's too long.
      */
-    private function trimBody(Response $psrResponse): Response
+    private function trimBody(Response $psrResponse): Response|MessageInterface
     {
         // Check if trimming is enabled
         if (! config('http-client-global-logger.trim_response_body.enabled')) {
             return $psrResponse;
         }
 
-        $treshold = config('http-client-global-logger.trim_response_body.treshold');
-
-        // Check if the body size exceeds the treshold
-        if ($psrResponse->getBody()->getSize() <= $treshold) {
-            return $psrResponse;
-        }
-
         // E.g.: application/json; charset=utf-8 => application/json
         $contentTypeHeader = Str::of($psrResponse->getHeaderLine('Content-Type'))
             ->before(';')
@@ -63,8 +57,13 @@ private function trimBody(Response $psrResponse): Response
             return $psrResponse;
         }
 
-        return $psrResponse->withBody(Utils::streamFor(
-            Str::limit($psrResponse->getBody(), $treshold)
-        ));
+        $treshold = config('http-client-global-logger.trim_response_body.treshold');
+
+        // Check if the body size exceeds the treshold
+        return ($psrResponse->getBody()->getSize() <= $treshold)
+            ? $psrResponse
+            : $psrResponse->withBody(Utils::streamFor(
+                Str::limit($psrResponse->getBody(), $treshold)
+            ));
     }
 }

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, bool $shouldTrim, bool $addCharsetToContentType) {
+it('can trim the body response', function (array $config, string $contentType, bool $shouldTrim, bool $addCharsetToContentType) {
     config(['http-client-global-logger.trim_response_body' => $config]);
 
     $logger = setupLogger();
@@ -61,7 +61,7 @@ function setupLogger(): MockInterface
 
     Http::fake([
         '*' => Http::response('verylongbody', 200, [
-            'content-type' => 'application/octet-stream'.($addCharsetToContentType ? '; charset=UTF-8' : ''),
+            'Content-Type' => $contentType.($addCharsetToContentType ? '; charset=UTF-8' : ''),
         ]),
     ])->get('https://example.com');
 })->with(
@@ -72,6 +72,7 @@ function setupLogger(): MockInterface
                 'treshold' => 10,
                 'content_type_whitelist' => ['application/json'],
             ],
+            'contentType' => 'application/octet-stream',
             'shouldTrim' => false,
         ],
         'below_treshold' => [
@@ -80,6 +81,7 @@ function setupLogger(): MockInterface
                 'treshold' => 20,
                 'content_type_whitelist' => ['application/json'],
             ],
+            'contentType' => 'application/octet-stream',
             'shouldTrim' => false,
         ],
         'content_type_whitelisted' => [
@@ -88,6 +90,7 @@ function setupLogger(): MockInterface
                 'treshold' => 10,
                 'content_type_whitelist' => ['application/octet-stream'],
             ],
+            'contentType' => 'application/octet-stream',
             'shouldTrim' => false,
         ],
         'trim' => [
@@ -96,8 +99,27 @@ function setupLogger(): MockInterface
                 'treshold' => 10,
                 'content_type_whitelist' => ['application/json'],
             ],
+            'contentType' => 'application/octet-stream',
             'shouldTrim' => true,
         ],
+        'no_content_type_trim' => [
+            'config' => [
+                'enabled' => true,
+                'treshold' => 10,
+                'content_type_whitelist' => ['application/octet-stream'],
+            ],
+            'contentType' => '',
+            'shouldTrim' => true,
+        ],
+        'no_content_type_whitelisted' => [
+            'config' => [
+                'enabled' => true,
+                'treshold' => 10,
+                'content_type_whitelist' => ['', 'application/octet-stream'],
+            ],
+            'contentType' => '',
+            'shouldTrim' => false,
+        ],
     ],
     [true, false]
 );