Merge pull request #312 from daniellienert/task/adapt-to-flow-6.0

!!! TASK: Refactor and simplify logging for compatibility with Flow 6.0

Author: daniellienert

.travis.yml

@@ -13,7 +13,7 @@ matrix:
       env: ES=5
 
 before_install:
-  - export NEOS_TARGET_VERSION=4.0
+  - export NEOS_TARGET_VERSION=4.3
   - cd ..
   - if [ "$ES" = 5 ]; then wget --no-check-certificate https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.15.zip && unzip elasticsearch-5.6.15.zip && mv elasticsearch-5.6.15 elasticsearch; fi
   - cd elasticsearch

Classes/Command/NodeIndexCommandController.php

@@ -18,7 +18,6 @@
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Indexer\Error\ErrorInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\NodeTypeMappingBuilderInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Indexer\NodeIndexer;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\ErrorHandlingService;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\IndexWorkspaceTrait;
 use Flowpack\ElasticSearch\Domain\Model\Mapping;
@@ -33,9 +32,11 @@
 use Neos\Flow\Cli\CommandController;
 use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
+use Neos\Flow\Log\Utility\LogEnvironment;
 use Neos\Flow\Mvc\Exception\StopActionException;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Neos\Controller\CreateContentContextTrait;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Yaml\Yaml;
 
 /**
@@ -246,18 +247,18 @@ public function indexNodeCommand(string $identifier, string $workspace = null):
     public function buildCommand(int $limit = null, bool $update = false, string $workspace = null, string $postfix = ''): void
     {
         if ($workspace !== null && $this->workspaceRepository->findByIdentifier($workspace) === null) {
-            $this->logger->log('The given workspace (' . $workspace . ') does not exist.', LOG_ERR);
+            $this->logger->error('The given workspace (' . $workspace . ') does not exist.', LogEnvironment::fromMethodName(__METHOD__));
             $this->quit(1);
         }
 
         if ($update === true) {
-            $this->logger->log('!!! Update Mode (Development) active!');
+            $this->logger->warning('!!! Update Mode (Development) active!', LogEnvironment::fromMethodName(__METHOD__));
         } else {
             $this->createNewIndex($postfix);
         }
         $this->applyMapping();
 
-        $this->logger->log(sprintf('Indexing %snodes ... ', ($limit !== null ? 'the first ' . $limit . ' ' : '')));
+        $this->logger->info(sprintf('Indexing %snodes ... ', ($limit !== null ? 'the first ' . $limit . ' ' : '')), LogEnvironment::fromMethodName(__METHOD__));
 
         $count = 0;
 
@@ -291,7 +292,7 @@ public function buildCommand(int $limit = null, bool $update = false, string $wo
             $this->outputLine();
             $this->outputLine('<error>Check your logs for more information</error>');
         } else {
-            $this->logger->log('Done. (indexed ' . $count . ' nodes)', LOG_INFO);
+            $this->logger->info('Done. (indexed ' . $count . ' nodes)', LogEnvironment::fromMethodName(__METHOD__));
         }
         $this->nodeIndexer->getIndex()->refresh();
 
@@ -313,17 +314,17 @@ public function cleanupCommand(): void
             $indicesToBeRemoved = $this->nodeIndexer->removeOldIndices();
             if (count($indicesToBeRemoved) > 0) {
                 foreach ($indicesToBeRemoved as $indexToBeRemoved) {
-                    $this->logger->log('Removing old index ' . $indexToBeRemoved);
+                    $this->logger->info('Removing old index ' . $indexToBeRemoved, LogEnvironment::fromMethodName(__METHOD__));
                 }
             } else {
-                $this->logger->log('Nothing to remove.');
+                $this->logger->info('Nothing to remove.', LogEnvironment::fromMethodName(__METHOD__));
             }
         } catch (ApiException $exception) {
             $response = json_decode($exception->getResponse());
             if ($response->error instanceof \stdClass) {
-                $this->logger->log(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s: %s"', $response->status, $response->error->type, $response->error->reason));
+                $this->logger->info(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s: %s"', $response->status, $response->error->type, $response->error->reason), LogEnvironment::fromMethodName(__METHOD__));
             } else {
-                $this->logger->log(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s"', $response->status, $response->error));
+                $this->logger->info(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s"', $response->status, $response->error), LogEnvironment::fromMethodName(__METHOD__));
             }
         }
     }
@@ -339,11 +340,11 @@ protected function createNewIndex(string $postfix): void
     {
         $this->nodeIndexer->setIndexNamePostfix($postfix ?: (string)time());
         if ($this->nodeIndexer->getIndex()->exists() === true) {
-            $this->logger->log(sprintf('Deleted index with the same postfix (%s)!', $postfix), LOG_WARNING);
+            $this->logger->warning(sprintf('Deleted index with the same postfix (%s)!', $postfix), LogEnvironment::fromMethodName(__METHOD__));
             $this->nodeIndexer->getIndex()->delete();
         }
         $this->nodeIndexer->getIndex()->create();
-        $this->logger->log('Created index ' . $this->nodeIndexer->getIndexName());
+        $this->logger->info('Created index ' . $this->nodeIndexer->getIndexName(), LogEnvironment::fromMethodName(__METHOD__));
     }
 
     /**
@@ -359,6 +360,6 @@ protected function applyMapping(): void
             /** @var Mapping $mapping */
             $mapping->apply();
         }
-        $this->logger->log('Updated Mapping.');
+        $this->logger->info('Updated Mapping.', LogEnvironment::fromMethodName(__METHOD__));
     }
 }

Classes/Driver/AbstractDriver.php

@@ -15,7 +15,7 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
+use Psr\Log\LoggerInterface;
 use Neos\Flow\Annotations as Flow;
 
 /**

Classes/Driver/AbstractIndexerDriver.php

@@ -16,6 +16,7 @@
 
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Log\Utility\LogEnvironment;
 
 /**
  * Abstract Fulltext Indexer Driver
@@ -58,7 +59,7 @@ protected function findClosestFulltextRoot(NodeInterface $node)
             if ($closestFulltextNode === null) {
                 // root of hierarchy, no fulltext root found anymore, abort silently...
                 if ($node->getPath() !== '/' && $node->getPath() !== '/sites') {
-                    $this->logger->log(sprintf('NodeIndexer: No fulltext root found for node %s (%s)', $node->getIdentifier(), $node->getContextPath()), LOG_WARNING, null, 'ElasticSearch (CR)');
+                    $this->logger->warning(sprintf('NodeIndexer: No fulltext root found for node %s (%s)', $node->getIdentifier(), $node->getContextPath()), LogEnvironment::fromMethodName(__METHOD__));
                 }
 
                 return null;

Classes/Driver/Version5/DocumentDriver.php

@@ -21,6 +21,7 @@
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Log\Utility\LogEnvironment;
 
 /**
  * Document driver for Elasticsearch version 5.x
@@ -90,7 +91,7 @@ public function deleteDuplicateDocumentNotMatchingType(Index $index, string $doc
             $result = $index->request('GET', '/_search/scroll?scroll=1m', [], $scrollId, false);
             $treatedContent = $result->getTreatedContent();
         }
-        $this->logger->log(sprintf('NodeIndexer: Check duplicate nodes for %s (%s), found %d document(s)', $documentIdentifier, $nodeType->getName(), count($bulkRequest)), LOG_DEBUG, null, 'ElasticSearch (CR)');
+        $this->logger->debug(sprintf('NodeIndexer: Check duplicate nodes for %s (%s), found %d document(s)', $documentIdentifier, $nodeType->getName(), count($bulkRequest)), LogEnvironment::fromMethodName(__METHOD__));
         if ($bulkRequest !== []) {
             $index->request('POST', '/_bulk', [], implode("\n", $bulkRequest) . "\n");
         }

Classes/Driver/Version5/IndexerDriver.php

@@ -19,6 +19,7 @@
 use Flowpack\ElasticSearch\Domain\Model\Document as ElasticSearchDocument;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Log\Utility\LogEnvironment;
 
 /**
  * Indexer driver for Elasticsearch version 5.x
@@ -96,12 +97,12 @@ public function fulltext(NodeInterface $node, array $fulltextIndexOfNode, string
 
         if ($closestFulltextNode->isRemoved()) {
             // fulltext root is removed, abort silently...
-            $this->logger->log(sprintf('NodeIndexer (%s): Fulltext root found for %s (%s) not updated, it is removed', $closestFulltextNodeDocumentIdentifier, $node->getPath(), $node->getIdentifier()), LOG_DEBUG, null, 'ElasticSearch (CR)');
+            $this->logger->debug(sprintf('NodeIndexer (%s): Fulltext root found for %s (%s) not updated, it is removed', $closestFulltextNodeDocumentIdentifier, $node->getPath(), $node->getIdentifier()), LogEnvironment::fromMethodName(__METHOD__));
 
             return [];
         }
 
-        $this->logger->log(sprintf('NodeIndexer (%s): Updated fulltext index for %s (%s)', $closestFulltextNodeDocumentIdentifier, $closestFulltextNodeContextPath, $closestFulltextNode->getIdentifier()), LOG_DEBUG, null, 'ElasticSearch (CR)');
+        $this->logger->debug(sprintf('NodeIndexer (%s): Updated fulltext index for %s (%s)', $closestFulltextNodeDocumentIdentifier, $closestFulltextNodeContextPath, $closestFulltextNode->getIdentifier()), LogEnvironment::fromMethodName(__METHOD__));
 
         $upsertFulltextParts = [];
         if (!empty($fulltextIndexOfNode)) {

Classes/Driver/Version5/RequestDriver.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\Version5;
@@ -29,6 +28,7 @@ class RequestDriver extends AbstractDriver implements RequestDriverInterface
     /**
      * {@inheritdoc}
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     public function bulk(Index $index, $request): array
     {
@@ -39,7 +39,7 @@ public function bulk(Index $index, $request): array
         // Bulk request MUST end with line return
         $request = trim($request) . "\n";
 
-        $response = $index->request('POST', '/_bulk', [], $request)->getOriginalResponse()->getContent();
+        $response = $index->request('POST', '/_bulk', [], $request)->getOriginalResponse()->getBody()->getContents();
 
         return array_map('json_decode', explode("\n", $response));
     }

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Eel;
@@ -19,7 +18,9 @@
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\ElasticSearchClient;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
+use Neos\Flow\Log\ThrowableStorageInterface;
+use Neos\Flow\Log\Utility\LogEnvironment;
+use Psr\Log\LoggerInterface;
 use Flowpack\ElasticSearch\Transfer\Exception\ApiException;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Search\Search\QueryBuilderInterface;
@@ -59,6 +60,12 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
      */
     protected $logger;
 
+    /**
+     * @Flow\Inject
+     * @var ThrowableStorageInterface
+     */
+    protected $throwableStorage;
+
     /**
      * @var boolean
      */
@@ -189,6 +196,7 @@ public function sort($configuration): ElasticSearchQueryBuilder
      *
      * @param integer $limit
      * @return ElasticSearchQueryBuilder
+     * @throws \Neos\Flow\Persistence\Exception\IllegalObjectTypeException
      * @api
      */
     public function limit($limit)
@@ -570,7 +578,9 @@ public function getFullElasticSearchHitForNode(NodeInterface $node): array
      * This method is rather internal; just to be called from the ElasticSearchQueryResult. For the public API, please use execute()
      *
      * @return array<\Neos\ContentRepository\Domain\Model\NodeInterface>
+     * @throws Exception
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     public function fetch(): array
     {
@@ -586,13 +596,13 @@ public function fetch(): array
 
             $this->result['nodes'] = [];
 
-            $this->logThisQuery && $this->logger->log(sprintf('Query Log (%s): %s -- execution time: %s ms -- Limit: %s -- Number of results returned: %s -- Total Results: %s', $this->logMessage, $request, (($timeAfterwards - $timeBefore) * 1000), $this->limit, count($searchResult->getHits()), $searchResult->getTotal()), LOG_DEBUG);
+            $this->logThisQuery && $this->logger->debug(sprintf('Query Log (%s): %s -- execution time: %s ms -- Limit: %s -- Number of results returned: %s -- Total Results: %s', $this->logMessage, $request, (($timeAfterwards - $timeBefore) * 1000), $this->limit, count($searchResult->getHits()), $searchResult->getTotal()), LogEnvironment::fromMethodName(__METHOD__));
 
             if (count($searchResult->getHits()) > 0) {
                 $this->result['nodes'] = $this->convertHitsToNodes($searchResult->getHits());
             }
         } catch (ApiException $exception) {
-            $this->logger->logException($exception);
+            $this->throwableStorage->logThrowable($exception);
             $this->result['nodes'] = [];
         }
 
@@ -639,7 +649,9 @@ public function executeUncached(): ElasticSearchQueryResult
      * Return the total number of hits for the query.
      *
      * @return integer
+     * @throws Exception
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      * @api
      */
     public function count()
@@ -653,7 +665,7 @@ public function count()
         $treatedContent = $response->getTreatedContent();
         $count = $treatedContent['count'];
 
-        $this->logThisQuery && $this->logger->log('Count Query Log (' . $this->logMessage . '): ' . $request . ' -- execution time: ' . (($timeAfterwards - $timeBefore) * 1000) . ' ms -- Total Results: ' . $count, LOG_DEBUG);
+        $this->logThisQuery && $this->logger->debug('Count Query Log (' . $this->logMessage . '): ' . $request . ' -- execution time: ' . (($timeAfterwards - $timeBefore) * 1000) . ' ms -- Total Results: ' . $count, LogEnvironment::fromMethodName(__METHOD__));
 
         return $count;
     }
@@ -712,7 +724,7 @@ public function moreLikeThis(array $like, array $fields = [], array $options = [
             $respondedDocuments = Arrays::getValueByPath($response, 'hits.hits');
 
             if (count($respondedDocuments) === 0) {
-                $this->logger->log(sprintf('The node with identifier %s was not found in the elasticsearch index.', $node->getIdentifier()), LOG_INFO);
+                $this->logger->info(sprintf('The node with identifier %s was not found in the elasticsearch index.', $node->getIdentifier()), LogEnvironment::fromMethodName(__METHOD__));
                 return [];
             }
 
@@ -852,7 +864,7 @@ protected function convertHitsToNodes(array $hits): array
             }
         }
 
-        $this->logThisQuery && $this->logger->log('Returned nodes (' . $this->logMessage . '): ' . count($nodes), LOG_DEBUG);
+        $this->logThisQuery && $this->logger->debug('Returned nodes (' . $this->logMessage . '): ' . count($nodes));
 
         $this->elasticSearchHitsIndexedByNodeFromLastRequest = $elasticSearchHitPerNode;
 
@@ -865,8 +877,10 @@ protected function convertHitsToNodes(array $hits): array
      * hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the result.
      *
      * @return int
+     * @throws Exception
      * @throws QueryBuildingException
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     public function cacheLifetime(): int
     {
@@ -889,8 +903,10 @@ public function cacheLifetime(): int
     /**
      * @param string $dateField
      * @return int
+     * @throws Exception
      * @throws QueryBuildingException
      * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
      */
     protected function getNearestFutureDate(string $dateField): int
     {

Classes/Factory/AbstractDriverSpecificObjectFactory.php

@@ -15,7 +15,7 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\DriverConfigurationException;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
+use Psr\Log\LoggerInterface;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -57,8 +57,6 @@ protected function resolve(string $type)
 
         $className = trim($this->mapping[$version][$type]['className']);
 
-        $this->logger->log(sprintf('Load %s implementation for Elastic %s (%s)', $type, $version, $className), LOG_DEBUG);
-
         if (!isset($this->mapping[$version][$type]['arguments'])) {
             return new $className();
         }

Classes/Indexer/Error/BulkIndexingError.php

@@ -14,7 +14,8 @@
  * source code.
  */
 
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
+use Neos\Flow\Log\Utility\LogEnvironment;
+use Psr\Log\LoggerInterface;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -76,9 +77,9 @@ public function log(): void
     {
         if (file_exists(FLOW_PATH_DATA . 'Logs/Elasticsearch') && is_dir(FLOW_PATH_DATA . 'Logs/Elasticsearch') && is_writable(FLOW_PATH_DATA . 'Logs/Elasticsearch')) {
             file_put_contents($this->filename, $this->renderErrors());
-            $this->logger->log($this->message, LOG_ERR, [], 'Flowpack.ElasticSearch.ContentRepositoryAdaptor', __CLASS__, __FUNCTION__);
+            $this->logger->error($this->message, LogEnvironment::fromMethodName(__METHOD__));
         } else {
-            $this->logger->log(sprintf('Could not write indexing errors backtrace into %s because the directory could not be created or is not writable.', FLOW_PATH_DATA . 'Logs/Elasticsearch/'), LOG_WARNING, [], 'Flowpack.ElasticSearch.ContentRepositoryAdaptor', __CLASS__, __FUNCTION__);
+            $this->logger->warning(sprintf('Could not write indexing errors backtrace into %s because the directory could not be created or is not writable.', FLOW_PATH_DATA . 'Logs/Elasticsearch/'), LogEnvironment::fromMethodName(__METHOD__));
         }
     }