Configurable log messages

Author: WyriHaximus

composer.json

@@ -11,7 +11,8 @@
   "require": {
     "php": "^7.2",
     "api-clients/middleware": "^4.0",
-    "psr/log": "^1.0"
+    "psr/log": "^1.0",
+    "wyrihaximus/string-get-in": "^1.0"
   },
   "require-dev": {
     "api-clients/test-utilities": "^5.1.0",

composer.lock

@@ -12,12 +12,17 @@
 use Throwable;
 use function React\Promise\reject;
 use function React\Promise\resolve;
+use function WyriHaximus\getIn;
 
 class LoggerMiddleware implements MiddlewareInterface
 {
-    private const REQUEST  = 'request';
-    private const RESPONSE = 'response';
-    private const ERROR    = 'error';
+    private const REQUEST            = 'request';
+    private const RESPONSE           = 'response';
+    private const ERROR              = 'error';
+
+    private const MESSAGE_URL        = '[{{transaction_id}}] Requesting: {{request.uri}}';
+    private const MESSAGE_SUCCESSFUL = '[{{transaction_id}}] Request completed with {{response.status_code}}';
+    private const MESSAGE_ERROR      = '[{{transaction_id}}] {{error.message}}';
 
     /**
      * @var LoggerInterface
@@ -43,6 +48,10 @@ public function pre(
             return resolve($request);
         }
 
+        $this->context[$transactionId] = [
+            'transaction_id' => $transactionId,
+            self::REQUEST => [],
+        ];
         $this->context[$transactionId][self::REQUEST]['method'] = $request->getMethod();
         $this->context[$transactionId][self::REQUEST]['uri'] = (string)$this->stripQueryItems(
             $request->getUri(),
@@ -61,7 +70,7 @@ public function pre(
             return resolve($request);
         }
 
-        $message = 'Requesting: ' . $this->context[$transactionId][self::REQUEST]['uri'];
+        $message = $this->renderTemplate(self::MESSAGE_URL, $this->context[$transactionId]);
         $this->logger->log($options[self::class][Options::URL_LEVEL], $message, $this->context[$transactionId]);
 
         return resolve($request);
@@ -88,10 +97,8 @@ public function post(
             return resolve($response);
         }
 
-        $message = 'Request ' . $transactionId . ' completed.';
-
         $context = $this->addResponseToContext($context, $response, $options);
-
+        $message = $this->renderTemplate(self::MESSAGE_SUCCESSFUL, $context);
         $this->logger->log($options[self::class][Options::LEVEL], $message, $context);
 
         return resolve($response);
@@ -116,8 +123,6 @@ public function error(
             return reject($throwable);
         }
 
-        $message = $throwable->getMessage();
-
         $response = null;
         if (method_exists($throwable, 'getResponse')) {
             $response = $throwable->getResponse();
@@ -126,6 +131,7 @@ public function error(
             $context = $this->addResponseToContext($context, $response, $options);
         }
 
+        $context[self::ERROR]['message']  = $throwable->getMessage();
         $context[self::ERROR]['code']  = $throwable->getCode();
         $context[self::ERROR]['file']  = $throwable->getFile();
         $context[self::ERROR]['line']  = $throwable->getLine();
@@ -135,6 +141,7 @@ public function error(
             $context[self::ERROR]['context'] = $throwable->getContext();
         }
 
+        $message = $this->renderTemplate(self::MESSAGE_ERROR, $context);
         $this->logger->log($options[self::class][Options::ERROR_LEVEL], $message, $context);
 
         return reject($throwable);
@@ -185,4 +192,16 @@ private function stripQueryItems(UriInterface $uri, array $options): UriInterfac
 
         return $uri->withQuery(http_build_query($query));
     }
+
+    private function renderTemplate(string $template, array $context): string
+    {
+        $keyValues = [];
+        preg_match_all("|\{\{(.*)\}\}|U", $template, $out, PREG_PATTERN_ORDER);
+        foreach (array_unique(array_values($out[1])) as $placeHolder) {
+            $keyValues['{{' . $placeHolder . '}}'] = getIn($context, $placeHolder, '');
+        }
+        $template = str_replace(array_keys($keyValues), array_values($keyValues), $template);
+
+        return $template;
+    }
 }

src/LoggerMiddleware.php

@@ -9,4 +9,7 @@ final class Options
     public const LEVEL                  = 'level';
     public const ERROR_LEVEL            = 'error_level';
     public const URL_LEVEL              = 'url_level';
+    public const MESSAGE_PRE            = 'message_pre';
+    public const MESSAGE_POST           = 'message_post';
+    public const MESSAGE_ERROR          = 'message_error';
 }

src/Options.php

@@ -75,15 +75,13 @@ public function testLog()
                 'X-Ignore-Response' => 'nope',
             ]
         );
-        $exception = new Exception(
-            'New Exception'
-        );
 
         $logger = $this->prophesize(LoggerInterface::class);
         $logger->log(
             LogLevel::DEBUG,
-            'Requesting: https://example.com/?dont_strip_this_item=1',
+            '[abc] Requesting: https://example.com/?dont_strip_this_item=1',
             [
+                'transaction_id' => 'abc',
                 'request' => [
                     'method' => 'GET',
                     'uri' => 'https://example.com/?dont_strip_this_item=1',
@@ -97,8 +95,9 @@ public function testLog()
         )->shouldBeCalled();
         $logger->log(
             LogLevel::DEBUG,
-            'Request abc completed.',
+            '[abc] Request completed with 200',
             [
+                'transaction_id' => 'abc',
                 'request' => [
                     'method' => 'GET',
                     'uri' => 'https://example.com/?dont_strip_this_item=1',
@@ -160,8 +159,9 @@ public function getResponse()
         $logger = $this->prophesize(LoggerInterface::class);
         $logger->log(
             LogLevel::ERROR,
-            $exception->getMessage(),
+            '[abc] ' . $exception->getMessage(),
             [
+                'transaction_id' => 'abc',
                 'request' => [
                     'method'           => 'GET',
                     'uri'              => 'https://example.com/',
@@ -180,10 +180,11 @@ public function getResponse()
                     ],
                 ],
                 'error' => [
-                    'code'  => $exception->getCode(),
-                    'file'  => $exception->getFile(),
-                    'line'  => $exception->getLine(),
-                    'trace' => $exception->getTraceAsString(),
+                    'message' => $exception->getMessage(),
+                    'code'    => $exception->getCode(),
+                    'file'    => $exception->getFile(),
+                    'line'    => $exception->getLine(),
+                    'trace'   => $exception->getTraceAsString(),
                 ],
             ]
         )->shouldBeCalled();
@@ -218,8 +219,9 @@ public function testLogErrorNoResponse()
         $logger = $this->prophesize(LoggerInterface::class);
         $logger->log(
             LogLevel::ERROR,
-            $exception->getMessage(),
+            '[abc] ' . $exception->getMessage(),
             [
+                'transaction_id' => 'abc',
                 'request' => [
                     'method'           => 'GET',
                     'uri'              => 'https://example.com/',
@@ -230,10 +232,11 @@ public function testLogErrorNoResponse()
                     ],
                 ],
                 'error' => [
-                    'code'  => $exception->getCode(),
-                    'file'  => $exception->getFile(),
-                    'line'  => $exception->getLine(),
-                    'trace' => $exception->getTraceAsString(),
+                    'message' => $exception->getMessage(),
+                    'code'    => $exception->getCode(),
+                    'file'    => $exception->getFile(),
+                    'line'    => $exception->getLine(),
+                    'trace'   => $exception->getTraceAsString(),
                 ],
             ]
         )->shouldBeCalled();