test: redaction

Author: happyDemon

src/Logger/Stores/DatabaseLogger.php

@@ -23,7 +23,7 @@ public function create(PendingRequest $request, Connector $connector): mixed
             'method' => $request->getRequest()->getMethod(),
             'endpoint' => $request->getRequest()->resolveEndpoint(),
             'request_headers' => $this->convertsRequestHeaders($request->getRequest()->headers(), $request),
-            'request_query' => $this->convertsRequestHeaders($request->getRequest()->query(), $request),
+            'request_query' => $this->convertsRequestQueryParameters($request->getRequest()->query(), $request),
             'request_body' => $this->convertsRequestBody($request->body(), $request),
         ]);
 

src/Logger/Stores/MemoryLogger.php

@@ -53,7 +53,7 @@ public function create(PendingRequest $request, Connector $connector): mixed
             'method' => $request->getRequest()->getMethod(),
             'endpoint' => $request->getRequest()->resolveEndpoint(),
             'request_headers' => $this->convertsRequestHeaders($request->getRequest()->headers(), $request),
-            'request_query' => $this->convertsRequestHeaders($request->getRequest()->query(), $request),
+            'request_query' => $this->convertsRequestQueryParameters($request->getRequest()->query(), $request),
             'request_body' => $this->convertsRequestBody($request->body(), $request),
             'sent_at' => now(),
         ];

src/Logger/Stores/ParsesRequestData.php

@@ -95,11 +95,15 @@ protected function redact($data, Redactor $type, Request $request, Connector $co
     protected function redactDataFromPayload($payload, array $redactKeys): mixed
     {
         if (in_array('*', $redactKeys, true)) {
-            return null;
+            return 'redacted';
         }
 
         if (is_array($payload)) {
-            Arr::forget($payload, $redactKeys);
+            foreach ($redactKeys as $key) {
+                if (Arr::has($payload, $key)) {
+                    Arr::set($payload, $key, 'redacted');
+                }
+            }
         }
 
         return $payload;

tests/Saloon/Requests/GoogleSearchRedactRequest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests;
+
+use Saloon\Contracts\Body\HasBody;
+use Saloon\Enums\Method;
+use Saloon\Traits\Body\HasJsonBody;
+
+class GoogleSearchRedactRequest extends \Saloon\Http\Request implements HasBody
+{
+    use HasJsonBody;
+
+    protected Method $method = Method::GET;
+
+    public function __construct(protected string $search) {}
+
+    public function defaultQuery(): array
+    {
+        return [
+            'q' => $this->search,
+            'secret' => 'could be redacted',
+            'redact' => [
+                'id' => 'should be redacted',
+            ],
+        ];
+    }
+
+    public function defaultHeaders(): array
+    {
+        return [
+            'Authorization' => 'should be redacted',
+            'Custom' => 'possibly be redacted',
+            'Saloon' => 'possibly be redacted',
+        ];
+    }
+
+    public function resolveEndpoint(): string
+    {
+        return 'complete/search';
+    }
+
+    public function defaultBody(): array
+    {
+        return [
+            'auth' => [
+                'username' => 'should be logged',
+                'password' => 'should be redacted',
+            ],
+            'redact' => 'should be redacted',
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactBodyAllRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactBodyAllRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::BODY->value => ['*'],
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactBodyRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactBodyRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::BODY->value => ['redact', 'auth.password'],
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactHeadersAllRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactHeadersAllRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::HEADERS->value => ['*'],
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactHeadersRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactHeadersRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::HEADERS->value => ['Authorization', 'Saloon'],
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactQueryAllRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactQueryAllRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::QUERY->value => ['*'],
+        ];
+    }
+}

tests/Saloon/Requests/Redaction/RedactQueryRequest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HappyDemon\SaloonUtils\Tests\Saloon\Requests\Redaction;
+
+use HappyDemon\SaloonUtils\Logger\Contracts\RedactsRequests;
+use HappyDemon\SaloonUtils\Logger\Enums\Redactor;
+use HappyDemon\SaloonUtils\Tests\Saloon\Requests\GoogleSearchRedactRequest;
+
+class RedactQueryRequest extends GoogleSearchRedactRequest implements RedactsRequests
+{
+    public function shouldRedact(): array
+    {
+        return [
+            Redactor::QUERY->value => ['secret'],
+        ];
+    }
+}