Merge pull request #17 from pottink/add-data-formatter

Add RemoveSensitiveQueryStringFormatter

Author: veewee

grumphp.yml

@@ -6,6 +6,7 @@ grumphp:
         psalm:
             config: psalm.xml
             show_info: true
+            no_cache: true
         phpunit: ~
         composer:
             metadata:

src/Formatter/RemoveSensitiveQueryStringsFormatter.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\HttpTools\Formatter;
+
+use Http\Message\Formatter as HttpFormatter;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+final class RemoveSensitiveQueryStringsFormatter implements HttpFormatter
+{
+    private HttpFormatter $formatter;
+
+    /**
+     * @var non-empty-list<string>
+     */
+    private array $sensitiveKeys;
+
+    /**
+     * @param non-empty-list<string> $sensitiveKeys
+     */
+    public function __construct(
+        HttpFormatter $formatter,
+        array $sensitiveKeys
+    ) {
+        $this->formatter = $formatter;
+        $this->sensitiveKeys = $sensitiveKeys;
+    }
+
+    public function formatRequest(RequestInterface $request): string
+    {
+        return $this->removeQueryStrings($request);
+    }
+
+    public function formatResponse(ResponseInterface $response): string
+    {
+        return $this->formatter->formatResponse($response);
+    }
+
+    private function removeQueryStrings(RequestInterface $request): string
+    {
+        $uri = $request->getUri();
+        $query = $uri->getQuery();
+
+        $result = [];
+        parse_str($query, $result);
+
+        foreach ($this->sensitiveKeys as $key) {
+            if (!array_key_exists($key, $result)) {
+                continue;
+            }
+
+            $result[$key] = 'xxxx';
+        }
+
+        return $this->formatter->formatRequest(
+            $request->withUri(
+                $uri->withQuery(http_build_query($result))
+            )
+        );
+    }
+}

tests/Helper/Formatter/CallbackFormatter.php

@@ -5,6 +5,7 @@
 namespace Phpro\HttpTools\Tests\Helper\Formatter;
 
 use Http\Message\Formatter as HttpFormatter;
+use Psr\Http\Message\MessageInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 

tests/Unit/Formatter/RemoveSensitiveHeaderKeysFormatterTest.php

@@ -33,9 +33,11 @@ protected function setUp(): void
     public function it_can_remove_sensitive_keys_from_request(array $headers, array $expected): void
     {
         $request = $this->createRequest('GET', 'something');
+
         foreach ($headers as $name => $value) {
             $request = $request->withAddedHeader($name, $value);
         }
+
         $formatted = $this->formatter->formatRequest($request);
 
         self::assertSame($this->formatHeaders($expected), $formatted);
@@ -48,15 +50,17 @@ public function it_can_remove_sensitive_keys_from_request(array $headers, array
     public function it_can_remove_sensitive_keys_from_response(array $headers, array $expected): void
     {
         $response = $this->createResponse(200);
+
         foreach ($headers as $name => $value) {
             $response = $response->withAddedHeader($name, $value);
         }
+
         $formatted = $this->formatter->formatResponse($response);
 
         self::assertSame($this->formatHeaders($expected), $formatted);
     }
 
-    public function provideJsonExpectations()
+    public function provideJsonExpectations(): iterable
     {
         yield 'sample1' => [
             [

tests/Unit/Formatter/RemoveSensitiveQueryStringsFormatterTest.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phpro\HttpTools\Tests\Unit\Formatter;
+
+use Http\Message\Formatter\SimpleFormatter;
+use Phpro\HttpTools\Formatter\RemoveSensitiveQueryStringsFormatter;
+use Phpro\HttpTools\Test\UseHttpFactories;
+use PHPUnit\Framework\TestCase;
+
+final class RemoveSensitiveQueryStringsFormatterTest extends TestCase
+{
+    use UseHttpFactories;
+
+    private RemoveSensitiveQueryStringsFormatter $formatter;
+
+    protected function setUp(): void
+    {
+        $this->formatter = new RemoveSensitiveQueryStringsFormatter(
+            new SimpleFormatter(),
+            ['apiKey', 'token']
+        );
+    }
+
+    /**
+     * @test
+     * @dataProvider provideJsonExpectations
+     */
+    public function it_can_remove_sensitive_query_strings_from_request(
+        string $actual,
+        string $expected
+    ): void {
+        $request = $this->createRequest('GET', $actual);
+        $formatted = $this->formatter->formatRequest($request);
+
+        self::assertStringContainsString(
+            $expected,
+            $formatted
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it_can_format_a_response(): void
+    {
+        $response = $this->createResponse();
+
+        self::assertIsString(
+            $this->formatter->formatResponse($response)
+        );
+    }
+
+    public function provideJsonExpectations(): iterable
+    {
+        yield 'regular' => [
+            'https://testapi.com/api/v1/products?query=string',
+            'https://testapi.com/api/v1/products?query=string',
+        ];
+        yield 'apiKey' => [
+            'https://testapi.com/api/v1/products?apiKey=ABCDEFGH123',
+            'https://testapi.com/api/v1/products?apiKey=xxxx',
+        ];
+        yield 'apiKeyAndToken' => [
+            'https://testapi.com/api/v1/products?apiKey=ABCDEFGH123&token=eyJzdWIiOiIxMjM0NTY3ODkwIiwibm',
+            'https://testapi.com/api/v1/products?apiKey=xxxx&token=xxxx',
+        ];
+    }
+}