Merge pull request #7 from apacheborys/introduce-simple-logging

Introduce simple logging

Author: apacheborys

composer.json

@@ -10,7 +10,8 @@
         }
     ],
     "require": {
-        "php": "^7.4||^8.0"
+        "php": "^7.4||^8.0",
+        "psr/log": "^1.1"
     },
     "require-dev": {
         "phpunit/phpunit": "9.5.21",

composer.lock

@@ -6,16 +6,26 @@
 use ApacheBorys\Retry\Entity\Config;
 use ApacheBorys\Retry\HandlerExceptionDeclarator\StandardHandlerExceptionDeclarator;
 use ApacheBorys\Retry\Interfaces\HandlerExceptionDeclaratorInterface;
+use ApacheBorys\Retry\Traits\LogWrapper;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
 
 abstract class AbstractHandler
 {
+    public const LOG_PREFIX = 'Retry lib: ';
+
+    use LogWrapper;
+
     /** @var Config[] */
     protected array $config;
 
+    protected ?LoggerInterface $logger;
+
     protected HandlerExceptionDeclaratorInterface $declarator;
 
-    public function __construct(array $config = [])
+    public function __construct(array $config = [], LoggerInterface $logger = null)
     {
+        $this->logger = $logger;
         $this->config = $this->initConfig($config);
     }
 
@@ -29,8 +39,10 @@ private function initConfig(array $config): array
     {
         $result = [];
 
-        $definerClass = $config['handlerExceptionDeclarator']['class'] ?? StandardHandlerExceptionDeclarator::class;
-        $this->declarator = new $definerClass(...$config['handlerExceptionDeclarator']['arguments'] ?? []);
+        $declaratorClass = $config['handlerExceptionDeclarator']['class'] ?? StandardHandlerExceptionDeclarator::class;
+        $this->declarator = new $declaratorClass(...$config['handlerExceptionDeclarator']['arguments'] ?? []);
+
+        $this->sendLogRecordInitDeclarator($declaratorClass);
 
         foreach ($config['items'] as $retryName => $configNode) {
             $result[$retryName] = new Config(
@@ -43,6 +55,21 @@ private function initConfig(array $config): array
             );
         }
 
+        $this->sendLogRecordInitConfigs(count($result));
+
         return $result;
     }
+
+    private function sendLogRecordInitDeclarator(string $declaratorClass): void
+    {
+        $this->sendLogRecord(
+            LogLevel::INFO,
+            sprintf('Init for %s with handler exception declarator %s', get_class($this), $declaratorClass)
+        );
+    }
+
+    private function sendLogRecordInitConfigs(int $qty): void
+    {
+        $this->sendLogRecord(LogLevel::INFO, sprintf('Init for %s configs. Quantity: %d', get_class($this), $qty));
+    }
 }

src/AbstractHandler.php

@@ -7,6 +7,7 @@
 use ApacheBorys\Retry\Entity\{Config, FormulaItem, Message};
 use ApacheBorys\Retry\Exceptions\WrongArgument;
 use ApacheBorys\Retry\ValueObject\{ArgumentType, FormulaArgument};
+use Psr\Log\LogLevel;
 
 class ExceptionHandler extends AbstractHandler
 {
@@ -34,19 +35,23 @@ private function getHandling($config): callable
                 if (get_class($exception) === $retryConfig->getHandledException()) {
                     $tryNumber = $this->getTryNumber($exception, $retryConfig);
 
+                    $this->sendLogRecordCatchException($retryConfig, $tryNumber);
+
                     if ($tryNumber < $retryConfig->getMaxRetries()) {
-                        $retryConfig->getTransport()->send(
-                            new Message(
-                                $retryConfig->getTransport()->getNextId($exception, $retryConfig),
-                                $retryConfig->getName(),
-                                $retryConfig->getExecutor()->getCorrelationId($exception, $retryConfig),
-                                $this->compilePayload($exception, $retryConfig),
-                                $tryNumber,
-                                false,
-                                $this->calculateNextTimeForTry($exception, $retryConfig),
-                                get_class($retryConfig->getExecutor())
-                            )
+                        $message = new Message(
+                            $retryConfig->getTransport()->getNextId($exception, $retryConfig),
+                            $retryConfig->getName(),
+                            $retryConfig->getExecutor()->getCorrelationId($exception, $retryConfig),
+                            $this->compilePayload($exception, $retryConfig),
+                            $tryNumber,
+                            false,
+                            $this->calculateNextTimeForTry($exception, $retryConfig),
+                            get_class($retryConfig->getExecutor())
                         );
+
+                        $result = $retryConfig->getTransport()->send($message);
+
+                        $this->sendLogRecordAboutSentMessage($message, $result);
                     }
 
                     throw $exception;
@@ -105,4 +110,17 @@ private function compileArgument(FormulaItem $item, \Throwable $exception, Confi
                 );
         }
     }
+
+    private function sendLogRecordCatchException(Config $retryConfig, int $tryNumber): void
+    {
+        $this->sendLogRecord(
+            LogLevel::DEBUG,
+            sprintf('Catch exception case for %s, try number is %d', $retryConfig->getHandledException(), $tryNumber)
+        );
+    }
+
+    private function sendLogRecordAboutSentMessage(Message $message, bool $result): void
+    {
+        $this->sendLogRecord(LogLevel::DEBUG, sprintf('Send new message id %s. Result is %s', $message->getId(), (string) $result));
+    }
 }

src/ExceptionHandler.php

@@ -3,7 +3,10 @@
 
 namespace ApacheBorys\Retry;
 
+use ApacheBorys\Retry\Entity\Config;
+use ApacheBorys\Retry\Entity\Message;
 use ApacheBorys\Retry\Exceptions\{MessageCantMarkAsProcessed, MessageHandlerFailed};
+use Psr\Log\LogLevel;
 
 class MessageHandler extends AbstractHandler
 {
@@ -17,14 +20,34 @@ public function processRetries(array $processExceptionsOnly = [], int $maxMessag
             $messages = $config->getTransport()->fetchUnprocessedMessages($maxMessagesPerException);
 
             foreach ($messages ?? [] as $message) {
+                $this->sendLogRecordAboutNewMessage($message, $config);
+
                 if (!$config->getExecutor()->handle($message)) {
                     throw new MessageHandlerFailed();
                 }
 
                 if (!$config->getTransport()->markMessageAsProcessed($message)) {
                     throw new MessageCantMarkAsProcessed();
                 }
+
+                $this->sendLogRecordAboutProcessedMessage($message);
             }
         }
     }
+
+    private function sendLogRecordAboutNewMessage(Message $message, Config $config): void
+    {
+        $this->sendLogRecord(
+            LogLevel::DEBUG,
+            sprintf('Received new message %s for exception %s', $message->getId(), $config->getHandledException())
+        );
+    }
+
+    private function sendLogRecordAboutProcessedMessage(Message $message): void
+    {
+        $this->sendLogRecord(
+            LogLevel::DEBUG,
+            sprintf('Received message %s was processed and marked as processed successfully', $message->getId())
+        );
+    }
 }

src/MessageHandler.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace ApacheBorys\Retry\Traits;
+
+use Psr\Log\LoggerInterface;
+
+trait LogWrapper
+{
+    protected function sendLogRecord(string $level, string $string): void
+    {
+        if ($this->logger instanceof LoggerInterface) {
+            $this->logger->{$level}(self::LOG_PREFIX . $string);
+        }
+    }
+}