add log in content writer and notmodifiercontentfilter (#35)

* add log in content writer and notmodifiercontentfilter

* add changelog and readme

CHANGELOG.md

@@ -1,8 +1,15 @@
+# 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
-* added `NotModifiedContentFilter` and a bunch of `FieldComparator` classes
+
+* Added `NotModifiedContentFilter` and a bunch of `FieldComparator` classes
 
 # version 2.1.0
-* contentWriter return created content
+
+* ContentWriter return created content
 
 # version 2.0.1
 

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/Controller/JobController.php

@@ -55,6 +55,26 @@ class JobController extends Controller
         ]);
     }
 
+    /**
+     * @Route("/details/log/{id}", name="coderhapsodie.ezdataflow.job.log")
+     *
+     * @param int $id
+     *
+     * @return Response
+     */
+    public function displayLog(int $id): Response
+    {
+        $this->denyAccessUnlessGranted(new Attribute('ezdataflow', 'view'));
+        $item = $this->jobGateway->find($id);
+        $log = array_map(function ($line) {
+            return preg_replace('~#\d+~', "\n$0", $line);
+        }, $item->getExceptions());
+
+        return $this->render('@ezdesign/ezdataflow/Item/log.html.twig', [
+            'log' => $log,
+        ]);
+    }
+
     /**
      * @Route("/create", name="coderhapsodie.ezdataflow.job.create", methods={"POST"})
      *

src/Filter/NotModifiedContentFilter.php

@@ -7,18 +7,22 @@ namespace CodeRhapsodie\EzDataflowBundle\Filter;
 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 @@ class NotModifiedContentFilter
         }
 
         // 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/Resources/translations/messages.en.yaml

@@ -36,16 +36,18 @@ coderhapsodie.ezdataflow.history.details.request: 'Requested on'
 coderhapsodie.ezdataflow.history.details.status: Status
 coderhapsodie.ezdataflow.history.details.start: 'Started on'
 coderhapsodie.ezdataflow.history.details.end: 'Finished on'
-coderhapsodie.ezdataflow.history.details.count: 'Items count'
+coderhapsodie.ezdataflow.history.details.count: 'Items successfully processed'
 coderhapsodie.ezdataflow.history.details.options: 'Run options'
 coderhapsodie.ezdataflow.history.details.errors: Errors
 coderhapsodie.ezdataflow.history.details.type: 'Name of the dataflow executed'
+coderhapsodie.ezdataflow.history.details.log: 'View log'
 coderhapsodie.ezdataflow.workflow.repeating.new.title: 'Add a new repeating dataflow'
 coderhapsodie.ezdataflow.workflow.new.cancel: Cancel
 coderhapsodie.ezdataflow.workflow.new.submit: Create
 coderhapsodie.ezdataflow.history.list.empty: 'No execution yet.'
 coderhapsodie.ezdataflow.workflow.list.empty: 'No repeating workflow configured yet'
 coderhapsodie.ezdataflow.workflow.history.title: 'Execution history'
+coderhapsodie.ezdataflow.workflow.log.title: 'Execution log'
 coderhapsodie.ezdataflow.workflow.list.delete: Delete
 coderhapsodie.ezdataflow.workflow.delete: 'Are you sure you want to delete this dataflow schedule?'
 coderhapsodie.ezdataflow.workflow.create.success: 'Dataflow schedule successfully added.'

src/Resources/translations/messages.fr.yaml

@@ -40,12 +40,14 @@ coderhapsodie.ezdataflow.history.details.count: 'Nombre d''objets mis à jour'
 coderhapsodie.ezdataflow.history.details.options: 'Options de lancement'
 coderhapsodie.ezdataflow.history.details.errors: Erreurs
 coderhapsodie.ezdataflow.history.details.type: 'Nom du dataflow exécuté'
+coderhapsodie.ezdataflow.history.details.log: 'Voir le log'
 coderhapsodie.ezdataflow.workflow.repeating.new.title: 'Nouvel programmation d''un dataflow récurrent'
 coderhapsodie.ezdataflow.workflow.new.cancel: Annuler
 coderhapsodie.ezdataflow.workflow.new.submit: Créer
 coderhapsodie.ezdataflow.history.list.empty: 'Aucune exécution pour le moment.'
 coderhapsodie.ezdataflow.workflow.list.empty: 'Aucun dataflow n''a été programmé.'
 coderhapsodie.ezdataflow.workflow.history.title: 'Historique des exécutions'
+coderhapsodie.ezdataflow.workflow.log.title: 'Log de l''exécution'
 coderhapsodie.ezdataflow.workflow.list.delete: Supprimer
 coderhapsodie.ezdataflow.workflow.delete: 'Êtes-vous sûr de vouloir supprimer ce dataflow ?'
 coderhapsodie.ezdataflow.workflow.create.success: 'La programmation du dataflow a bien été ajoutée.'

src/Resources/views/themes/admin/ezdataflow/Dashboard/main.html.twig

@@ -42,6 +42,10 @@
                 $('.history-details-aware').delegate('.modal-history-details', 'click', function (e) {
                     e.preventDefault();
                     $('#modal_content-details').html('');
+                    $('#ez-modal--history-details h3').html("{{ 'coderhapsodie.ezdataflow.workflow.history.title'|trans }}");
+                    if ($(this).hasClass('modal-history-log')) {
+                        $('#ez-modal--history-details h3').html("{{ 'coderhapsodie.ezdataflow.workflow.log.title'|trans }}");
+                    }
                     $('#ez-modal--history-details').modal('show');
                     $.ajax(this.href, {
                         success: function (result) {

src/Resources/views/themes/admin/ezdataflow/Item/details.html.twig

@@ -1,8 +1,7 @@
 {% import '@ezdesign/ezdataflow/macros.twig' as macros %}
 
 {% block content %}
-
-    <div class="container ez-main-container">
+    <div class="container ez-main-container history-details-aware">
         {% if item is not null %}
         <h2>{{ 'coderhapsodie.ezdataflow.history.job.title'|trans }} n°{{ item.id }}</h2>
 

src/Resources/views/themes/admin/ezdataflow/Item/log.html.twig

@@ -0,0 +1,3 @@
+{% for line in log %}
+    <p>{{ line|nl2br }}</p>
+{% endfor %}

src/Resources/views/themes/admin/ezdataflow/parts/tab/job_list.html.twig

@@ -41,6 +41,14 @@
                                      xlink:href="/bundles/ezplatformadminui/img/ez-icons.svg#about-info"></use>
                             </svg>
                         </a>
+                        <a href="{{ path('coderhapsodie.ezdataflow.job.log', {id: job.id}) }}"
+                           class="btn btn-icon mx-2 modal-history-details modal-history-log"
+                           title="{{ 'coderhapsodie.ezdataflow.history.details.log'|trans }}">
+                            <svg class="ez-icon ez-icon--small-medium">
+                                <use xmlns:xlink="http://www.w3.org/1999/xlink"
+                                     xlink:href="/bundles/ezplatformadminui/img/ez-icons.svg#article"></use>
+                            </svg>
+                        </a>
                     </td>
                 </tr>
             {% endfor %}

src/Writer/ContentWriter.php

@@ -11,8 +11,12 @@ use CodeRhapsodie\EzDataflowBundle\Model\ContentCreateStructure;
 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 @@ class ContentWriter extends RepositoryWriter implements DelegateWriterInterface
     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 @@ class ContentWriter extends RepositoryWriter implements DelegateWriterInterface
     {
         return $item instanceof ContentStructure;
     }
+
+    private function log(string $level, string $message, array $context = [])
+    {
+        if ($this->logger === null) {
+            return;
+        }
+        $this->logger->log($level, $message, $context);
+    }
 }