add logging to data tasks

marvin255 · marvin255 · commit fb76bafab781 · 2019-09-23T10:24:26.000+02:00
diff --git a/src/Pipeline/Pipe/ArrayPipe.php b/src/Pipeline/Pipe/ArrayPipe.php
@@ -6,6 +6,7 @@
 
 use Exception;
 use Liquetsoft\Fias\Component\Pipeline\State\State;
+use Liquetsoft\Fias\Component\Pipeline\Task\LoggableTask;
 use Liquetsoft\Fias\Component\Pipeline\Task\Task;
 use Liquetsoft\Fias\Component\Exception\PipeException;
 use InvalidArgumentException;
@@ -101,12 +102,13 @@ protected function proceedStart(State $state): void
      */
     protected function proceedTask(State $state, Task $task): void
     {
-        $taskName = get_class($task);
+        $taskName = $this->getTaskId($task);
         $this->log(
             LogLevel::INFO,
             "Start '{$taskName}' task.",
             ['task' => $taskName]
         );
+        $this->injectLoggerToTask($task);
         $task->run($state);
         $this->log(
             LogLevel::INFO,
@@ -126,7 +128,7 @@ protected function proceedTask(State $state, Task $task): void
      */
     protected function proceedException(State $state, Task $task, Throwable $e): void
     {
-        $taskName = get_class($task);
+        $taskName = $this->getTaskId($task);
         $message = "Error while running {$taskName} task: {$e->getMessage()}";
 
         $this->log(LogLevel::ERROR, $message, [
@@ -177,12 +179,43 @@ protected function proceedComplete(State $state): void
     protected function log(string $level, string $message, array $context = []): void
     {
         if ($this->logger) {
-            $context['pipeline'] = get_class($this);
-            $context['pipeline_id'] = $this->id;
-            $this->logger->log($level, "Pipeline {$this->id}. {$message}", $context);
+            $context = $this->createLoggerContext($context);
+            $this->logger->log($level, $message, $context);
         }
     }
 
+    /**
+     * Добавляет логгер в операцию, если операция поддерживает логгирование.
+     *
+     * @param Task $task
+     */
+    protected function injectLoggerToTask(Task $task): void
+    {
+        if ($task instanceof LoggableTask && $this->logger) {
+            $task->injectLogger(
+                $this->logger,
+                $this->createLoggerContext(['task' => $this->getTaskId($task)])
+            );
+        }
+    }
+
+    /**
+     * Возвращает дефолтный контекст логгирования.
+     *
+     * @param array $currentContext
+     *
+     * @return array
+     */
+    protected function createLoggerContext(array $currentContext = []): array
+    {
+        $defaultContext = [
+            'pipeline_class' => get_class($this),
+            'pipeline_id' => $this->id,
+        ];
+
+        return array_merge($defaultContext, $currentContext);
+    }
+
     /**
      * Проверяет все объекты массива, чтобы они были валидными задачами и возвращает его.
      *
@@ -207,4 +240,16 @@ protected function checkAndReturnTaskArray(iterable $tasks): array
 
         return $return;
     }
+
+    /**
+     * Возвращает идентификатор операции.
+     *
+     * @param Task $task
+     *
+     * @return string
+     */
+    protected function getTaskId(Task $task): string
+    {
+        return get_class($task);
+    }
 }
diff --git a/src/Pipeline/Task/DataAbstractTask.php b/src/Pipeline/Task/DataAbstractTask.php
@@ -12,6 +12,7 @@
 use Liquetsoft\Fias\Component\Pipeline\State\State;
 use Liquetsoft\Fias\Component\EntityDescriptor\EntityDescriptor;
 use Liquetsoft\Fias\Component\Exception\TaskException;
+use Psr\Log\LogLevel;
 use Symfony\Component\Serializer\SerializerInterface;
 use SplFileInfo;
 use RecursiveDirectoryIterator;
@@ -20,8 +21,10 @@
 /**
  * Абстрактная задача, которая переносит данные из xml в хранилище данных.
  */
-abstract class DataAbstractTask implements Task
+abstract class DataAbstractTask implements Task, LoggableTask
 {
+    use LoggableTaskTrait;
+
     /**
      * @var EntityManager
      */
@@ -129,17 +132,36 @@ protected function processFile(SplFileInfo $fileInfo): void
      */
     protected function processDataFromFile(SplFileInfo $fileInfo, string $xpath, string $entityClass): void
     {
+        $this->log(
+            LogLevel::INFO,
+            "Start processing '{$fileInfo->getRealPath()}' file for '{$entityClass}' entity.",
+            [
+                'entity' => $entityClass,
+                'path' => $fileInfo->getRealPath(),
+            ]
+        );
+
+        $total = 0;
         $this->xmlReader->open($fileInfo, $xpath);
         $this->storage->start();
-
         try {
             foreach ($this->xmlReader as $xml) {
                 $this->processItem($this->deserializeXmlStringToObject($xml, $entityClass));
+                ++$total;
             }
         } finally {
             $this->storage->stop();
             $this->xmlReader->close();
         }
+
+        $this->log(
+            LogLevel::INFO,
+            "Complete processing '{$fileInfo->getRealPath()}' file for '{$entityClass}' entity. {$total} items processed.",
+            [
+                'entity' => $entityClass,
+                'path' => $fileInfo->getRealPath(),
+            ]
+        );
     }
 
     /**
diff --git a/src/Pipeline/Task/LoggableTask.php b/src/Pipeline/Task/LoggableTask.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Liquetsoft\Fias\Component\Pipeline\Task;
+
+use Psr\Log\LoggerInterface;
+
+/**
+ * Интерфейс для объекта операции, которая может логгировать свой действия.
+ */
+interface LoggableTask
+{
+    /**
+     * Добавляет ссылку на объект логгера в объект операции.
+     *
+     * @param LoggerInterface $logger
+     * @param array           $defaultContext
+     */
+    public function injectLogger(LoggerInterface $logger, array $defaultContext = []): void;
+}
diff --git a/src/Pipeline/Task/LoggableTaskTrait.php b/src/Pipeline/Task/LoggableTaskTrait.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Liquetsoft\Fias\Component\Pipeline\Task;
+
+use Psr\Log\LoggerInterface;
+
+/**
+ * Трейт в пару к LoggableTask интерфейсу.
+ */
+trait LoggableTaskTrait
+{
+    /**
+     * @var LoggerInterface|null
+     */
+    protected $logger;
+
+    /**
+     * @var array
+     */
+    protected $defaultContext = [];
+
+    /**
+     * Добавляет ссылку на объект логгера в объект операции.
+     *
+     * @param LoggerInterface $logger
+     * @param array           $defaultContext
+     */
+    public function injectLogger(LoggerInterface $logger, array $defaultContext = []): void
+    {
+        $this->logger = $logger;
+        $this->defaultContext = $defaultContext;
+    }
+
+    /**
+     * Логгирует сообщение.
+     *
+     * @param string $logLevel
+     * @param string $message
+     * @param array  $context
+     */
+    public function log(string $logLevel, string $message, array $context = []): void
+    {
+        if ($this->logger) {
+            $context = array_merge($this->defaultContext, $context);
+            $this->logger->log($logLevel, $message, $context);
+        }
+    }
+}
diff --git a/tests/src/Pipeline/Pipe/ArrayPipeTest.php b/tests/src/Pipeline/Pipe/ArrayPipeTest.php
@@ -6,6 +6,7 @@
 
 use Liquetsoft\Fias\Component\Pipeline\Pipe\ArrayPipe;
 use Liquetsoft\Fias\Component\Pipeline\State\State;
+use Liquetsoft\Fias\Component\Pipeline\Task\LoggableTask;
 use Liquetsoft\Fias\Component\Pipeline\Task\Task;
 use Liquetsoft\Fias\Component\Tests\BaseCase;
 use Liquetsoft\Fias\Component\Exception\PipeException;
@@ -124,12 +125,45 @@ public function testRunException()
     public function testLogger()
     {
         $state = $this->getMockBuilder(State::class)->getMock();
-        $state->expects($this->once())->method('complete');
-
         $task = $this->getMockBuilder(Task::class)->getMock();
 
         $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
-        $logger->expects($this->atLeastOnce())->method('log');
+        $logger->expects($this->atLeastOnce())
+            ->method('log')
+            ->with(
+                $this->anything(),
+                $this->anything(),
+                $this->logicalAnd(
+                    $this->arrayHasKey('pipeline_class'),
+                    $this->arrayHasKey('pipeline_id')
+                )
+            )
+        ;
+
+        $pipe = new ArrayPipe([$task], null, $logger);
+        $pipe->run($state);
+    }
+
+    /**
+     * Проверяет, что очередь передаст объект лога в задачу, если требуется.
+     */
+    public function testLoggableTaskLoggerInjected()
+    {
+        $state = $this->getMockBuilder(State::class)->getMock();
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+
+        $task = $this->getMockBuilder([Task::class, LoggableTask::class])->getMock();
+        $task->expects($this->once())
+            ->method('injectLogger')
+            ->with(
+                $this->identicalTo($logger),
+                $this->logicalAnd(
+                    $this->arrayHasKey('pipeline_class'),
+                    $this->arrayHasKey('pipeline_id'),
+                    $this->arrayHasKey('task')
+                )
+            )
+        ;
 
         $pipe = new ArrayPipe([$task], null, $logger);
         $pipe->run($state);
