enable ad-hoc configuration for message accessor and swapping out message accessor class; add e2e tests

Author: flexponsive

src/HttpLogger.php

@@ -38,13 +38,18 @@ public function log(
         $this->sec = $sec;
         $this->context = $context;
 
-        // ad-hoc config is not supported for message accessor settings: replace_json, replace_query, replace_headers, replace_values.
-        if (Arr::hasAny($config, ['replace_json', 'replace_query', 'replace_headers', 'replace_values'])) {
-            throw new \InvalidArgumentException('Ad-hoc config does not support replace_json, replace_query, replace_headers, replace_values.');
-        }
-
         $this->config = array_merge(config('http-client-logger'), $config);
 
+        // set up custom message accessor based on current config
+        $messageAccessorClass = $this->config['message_accessor_class'] ?? MessageAccessor::class;
+        $messageAccessor = new $messageAccessorClass(
+            $this->config['replace_json'] ?? [],
+            $this->config['replace_query'] ?? [],
+            $this->config['replace_headers'] ?? [],
+            $this->config['replace_values'] ?? [],
+        );
+        $this->psrMessageStringConverter->setMessageAccessor($messageAccessor);
+
         if (Arr::get($this->config, 'channel')) {
             $this->logToChannel(($channel = Arr::get($this->config, 'channel')) == 'default' ? config('logging.default') : $channel);
         }

src/PsrMessageToStringConverter.php

@@ -16,6 +16,11 @@ public function __construct(MessageAccessor $messageAccessor)
         $this->messageAccessor = $messageAccessor;
     }
 
+    public function setMessageAccessor(MessageAccessor $messageAccessor): void
+    {
+        $this->messageAccessor = $messageAccessor;
+    }
+
     public function toString(MessageInterface $message, array $replace): string
     {
         $filteredMessage = $message instanceof Request ? $this->messageAccessor->filterRequest($message) : $this->messageAccessor->filterMessage($message);

tests/HttpLoggerE2eTest.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace Bilfeldt\LaravelHttpClientLogger\Tests;
+
+use Bilfeldt\LaravelHttpClientLogger\HttpLogger;
+use Bilfeldt\LaravelHttpClientLogger\MessageAccessor;
+use Bilfeldt\LaravelHttpClientLogger\PsrMessageToStringConverter;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Str;
+use Psr\Http\Message\MessageInterface;
+use TiMacDonald\Log\LogEntry;
+use TiMacDonald\Log\LogFake;
+
+class HttpLoggerE2eTest extends TestCase
+{
+    protected HttpLogger $logger;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        Http::preventStrayRequests();
+        Http::fake([
+            'https://api.example.com/login?username=SECRET_USER&pass=SECRET_PASSWORD' => Http::response(['authentication_token' => 'SECRET_TOKEN'], 200),
+            'https://api.example.com/documents' => function ($request) {
+                $authorizationHeader = $request->header('Authorization');
+
+                if (($authorizationHeader[0] ?? '') === 'Bearer SECRET_TOKEN') {
+                    return Http::response([
+                        ['id' => '1', 'title' => 'Document Title 1', 'author' => 'Author Name 1'],
+                        ['id' => '2', 'title' => 'Document Title 2', 'author' => 'Author Name 2']
+                    ], 200);
+                } else {
+                    return Http::response(['error' => 'Unauthorized'], 401);
+                }
+            },
+            '*' => Http::response(['error' => 'Not Found'], 404),
+        ]);
+    }
+
+    public function test_accessor_adhoc_config()
+    {
+        LogFake::bind();
+
+        $pendingRequest = Http::log(
+            [],
+            [ 'replace_json' => [ 'authentication_token'],
+              'replace_headers' => ['Authorization'],
+              'replace_query' => ['username', 'pass']
+            ]
+        );
+
+        $responses = [
+            $pendingRequest->get('https://api.example.com/login?username=SECRET_USER&pass=SECRET_PASSWORD'),
+            $pendingRequest->withToken("SECRET_TOKEN")->get('https://api.example.com/documents')
+        ];
+
+        Log::assertLogged(fn (LogEntry $log) => !Str::contains($log->message, 'SECRET_'));
+
+    }
+
+    public function test_accessor_custom_class()
+    {
+        LogFake::bind();
+
+        Http::log([], [
+            'message_accessor_class' => MockMessageAccessor::class,
+        ])->get('https://api.example.com/login?username=SECRET_USER&pass=SECRET_PASSWORD');
+
+        Log::assertLogged(fn (LogEntry $log) => Str::contains($log->message, 'TOP SECRET'));
+    }
+}
+
+class MockMessageAccessor extends MessageAccessor
+{
+    public function getContent(MessageInterface $message) : string
+    {
+        return "TOP SECRET";
+    }
+}