add log in content writer and notmodifiercontentfilter (#35)

* add log in content writer and notmodifiercontentfilter

* add changelog and readme

Author: jbcr

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Version 2.3.0
 
 * Added a button to display exceptions / log in a modal
+* Add log in `CodeRhapsodie\EzDataflowBundle\Filter\NotModifiedContentFilter` and `CodeRhapsodie\EzDataflowBundle\Writer\ContentWriter`
 
 # Version 2.2.0
 

README.md

@@ -206,6 +206,8 @@ class MyDataflowType extends AbstractDataflowType
                     ContentStructureFactoryInterface::MODE_INSERT_OR_UPDATE //Optional value. Other choice : ContentStructureFactoryInterface::MODE_INSERT_ONLY or ContentStructureFactoryInterface::MODE_UPDATE_ONLY
                 );
         });
+        // If you want the writer log
+        $this->contentWriter->setLogger($this->logger);
         $builder->addWriter($this->contentWriter);
     }
 }
@@ -228,6 +230,8 @@ public function __construct(NotModifiedContentFilter $notModifiedContentFilter)
 protected function buildDataflow(DataflowBuilder $builder, array $options): void
 {
     //[...]
+    // If you want the filter log
+    $this->notModifiedContentFilter->setLogger($this->logger);
     $builder->addStep($this->notModifiedContentFilter);
     //[...]
 }

src/Filter/NotModifiedContentFilter.php

@@ -7,18 +7,22 @@
 use CodeRhapsodie\EzDataflowBundle\Core\FieldComparator\FieldComparatorInterface;
 use CodeRhapsodie\EzDataflowBundle\Model\ContentUpdateStructure;
 use eZ\Publish\API\Repository\ContentService;
+use Psr\Log\LoggerAwareTrait;
 
 /**
  * Filters ContentUpdateStructure that would not result in any actual changes in the content.
  */
 class NotModifiedContentFilter
 {
+    use LoggerAwareTrait;
+
     /** @var ContentService */
     private $contentService;
 
     /** @var FieldComparatorInterface */
     private $comparator;
 
+
     public function __construct(ContentService $contentService, FieldComparatorInterface $comparator)
     {
         $this->contentService = $contentService;
@@ -46,6 +50,15 @@ public function __invoke($data)
         }
 
         // All fields are identical, filter this item out.
+        $this->log('info', 'Not modified content skipped', ['id' => $data->getId(), 'remote_id' => $data->getRemoteId()]);
         return false;
     }
+
+    private function log(string $level, string $message, array $context = [])
+    {
+        if ($this->logger === null) {
+            return;
+        }
+        $this->logger->log($level, $message, $context);
+    }
 }

src/Writer/ContentWriter.php

@@ -11,8 +11,12 @@
 use CodeRhapsodie\EzDataflowBundle\Model\ContentStructure;
 use CodeRhapsodie\EzDataflowBundle\Model\ContentUpdateStructure;
 
+use Psr\Log\LoggerAwareTrait;
+
 class ContentWriter extends RepositoryWriter implements DelegateWriterInterface
 {
+    use LoggerAwareTrait;
+
     /** @var ContentCreatorInterface */
     private $creator;
 
@@ -31,14 +35,20 @@ public function __construct(ContentCreatorInterface $creator, ContentUpdaterInte
     public function write($item)
     {
         if (!$item instanceof ContentStructure) {
+            $this->log('warning', "Data is not a ContentStucture");
             return;
         }
 
         if ($item instanceof ContentCreateStructure) {
+            $this->log('info', 'Save content', [
+                'content_type' => $item->getContentTypeIdentifier(),
+                'content_location' => $item->getLocations()
+            ]);
             return $this->creator->createFromStructure($item);
         }
 
         if ($item instanceof ContentUpdateStructure) {
+            $this->log('info', 'Update content', ['id' => $item->getId(), 'remote_id' => $item->getRemoteId()]);
             return $this->updater->updateFromStructure($item);
         }
     }
@@ -50,4 +60,12 @@ public function supports($item): bool
     {
         return $item instanceof ContentStructure;
     }
+
+    private function log(string $level, string $message, array $context = [])
+    {
+        if ($this->logger === null) {
+            return;
+        }
+        $this->logger->log($level, $message, $context);
+    }
 }