Merge pull request #5 from php-api-clients/log-url

Log the URL we send a request to

Author: WyriHaximus

src/LoggerMiddleware.php

@@ -6,6 +6,7 @@
 use ApiClients\Foundation\Middleware\MiddlewareInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\UriInterface;
 use Psr\Log\LoggerInterface;
 use React\Promise\CancellablePromiseInterface;
 use Throwable;
@@ -14,9 +15,9 @@
 
 class LoggerMiddleware implements MiddlewareInterface
 {
-    const REQUEST  = 'request';
-    const RESPONSE = 'response';
-    const ERROR    = 'error';
+    private const REQUEST  = 'request';
+    private const RESPONSE = 'response';
+    private const ERROR    = 'error';
 
     /**
      * @var LoggerInterface
@@ -43,7 +44,10 @@ public function pre(
         }
 
         $this->context[$transactionId][self::REQUEST]['method'] = $request->getMethod();
-        $this->context[$transactionId][self::REQUEST]['uri'] = (string)$request->getUri();
+        $this->context[$transactionId][self::REQUEST]['uri'] = (string)$this->stripQueryItems(
+            $request->getUri(),
+            $options
+        );
         $this->context[$transactionId][self::REQUEST]['protocol_version'] = (string)$request->getProtocolVersion();
         $ignoreHeaders = $options[self::class][Options::IGNORE_HEADERS] ?? [];
         $this->context[$transactionId] = $this->iterateHeaders(
@@ -53,6 +57,13 @@ public function pre(
             $ignoreHeaders
         );
 
+        if (!isset($options[self::class][Options::URL_LEVEL])) {
+            return resolve($request);
+        }
+
+        $message = 'Requesting: ' . $this->context[$transactionId][self::REQUEST]['uri'];
+        $this->logger->log($options[self::class][Options::URL_LEVEL], $message, $this->context[$transactionId]);
+
         return resolve($request);
     }
 
@@ -164,4 +175,14 @@ private function addResponseToContext(
 
         return $context;
     }
+
+    private function stripQueryItems(UriInterface $uri, array $options): UriInterface
+    {
+        parse_str($uri->getQuery(), $query);
+        foreach ($options[self::class][Options::IGNORE_URI_QUERY_ITEMS] ?? [] as $item) {
+            unset($query[$item], $query[$item . '[]']);
+        }
+
+        return $uri->withQuery(http_build_query($query));
+    }
 }

src/Options.php

@@ -4,7 +4,9 @@
 
 final class Options
 {
-    const IGNORE_HEADERS = 'ignore_headers';
-    const LEVEL          = 'level';
-    const ERROR_LEVEL    = 'error_level';
+    public const IGNORE_HEADERS         = 'ignore_headers';
+    public const IGNORE_URI_QUERY_ITEMS = 'ignoreuri_query_items';
+    public const LEVEL                  = 'level';
+    public const ERROR_LEVEL            = 'error_level';
+    public const URL_LEVEL              = 'url_level';
 }

tests/LoggerMiddlewareTest.php

@@ -50,15 +50,19 @@ public function testLog()
             LoggerMiddleware::class => [
                 Options::LEVEL          => LogLevel::DEBUG,
                 Options::ERROR_LEVEL    => LogLevel::ERROR,
+                Options::URL_LEVEL      => LogLevel::DEBUG,
                 Options::IGNORE_HEADERS => [
                     'X-Ignore-Request',
                     'X-Ignore-Response',
                 ],
+                Options::IGNORE_URI_QUERY_ITEMS => [
+                    'strip_this_item',
+                ],
             ],
         ];
         $request = new Request(
             'GET',
-            'https://example.com/',
+            'https://example.com/?strip_this_item=0&dont_strip_this_item=1',
             [
                 'X-Foo' => 'bar',
                 'X-Ignore-Request' => 'nope',
@@ -76,13 +80,28 @@ public function testLog()
         );
 
         $logger = $this->prophesize(LoggerInterface::class);
+        $logger->log(
+            LogLevel::DEBUG,
+            'Requesting: https://example.com/?dont_strip_this_item=1',
+            [
+                'request' => [
+                    'method' => 'GET',
+                    'uri' => 'https://example.com/?dont_strip_this_item=1',
+                    'protocol_version' => '1.1',
+                    'headers' => [
+                        'Host' => ['example.com'],
+                        'X-Foo' => ['bar'],
+                    ],
+                ],
+            ]
+        )->shouldBeCalled();
         $logger->log(
             LogLevel::DEBUG,
             'Request abc completed.',
             [
                 'request' => [
                     'method' => 'GET',
-                    'uri' => 'https://example.com/',
+                    'uri' => 'https://example.com/?dont_strip_this_item=1',
                     'protocol_version' => '1.1',
                     'headers' => [
                         'Host' => ['example.com'],