TASK: Extract logic to index workspace from the controller to a trait

Author: dfeyer

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Command/NodeIndexCommandController.php

@@ -11,11 +11,10 @@
  * The TYPO3 project - inspiring people to share!                                                   *
  *                                                                                                  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\IndexWorkspaceTrait;
 use TYPO3\Flow\Annotations as Flow;
 use TYPO3\Flow\Cli\CommandController;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Mapping\NodeTypeMappingBuilder;
-use TYPO3\TYPO3CR\Domain\Service\ContentDimensionCombinator;
-use TYPO3\TYPO3CR\Search\Indexer\NodeIndexingManager;
 
 /**
  * Provides CLI features for index handling
@@ -24,18 +23,14 @@
  */
 class NodeIndexCommandController extends CommandController
 {
+    use IndexWorkspaceTrait;
+
     /**
      * @Flow\Inject
      * @var \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Indexer\NodeIndexer
      */
     protected $nodeIndexer;
 
-    /**
-     * @Flow\Inject
-     * @var NodeIndexingManager
-     */
-    protected $nodeIndexingManager;
-
     /**
      * @Flow\Inject
      * @var \TYPO3\TYPO3CR\Domain\Repository\WorkspaceRepository
@@ -54,12 +49,6 @@ class NodeIndexCommandController extends CommandController
      */
     protected $nodeFactory;
 
-    /**
-     * @Flow\Inject
-     * @var \TYPO3\TYPO3CR\Domain\Service\ContextFactory
-     */
-    protected $contextFactory;
-
     /**
      * @Flow\Inject
      * @var \TYPO3\Neos\Domain\Service\ContentDimensionPresetSourceInterface
@@ -72,21 +61,6 @@ class NodeIndexCommandController extends CommandController
      */
     protected $nodeTypeMappingBuilder;
 
-    /**
-     * @var integer
-     */
-    protected $indexedNodes;
-
-    /**
-     * @var integer
-     */
-    protected $countedIndexedNodes;
-
-    /**
-     * @var integer
-     */
-    protected $limit;
-
     /**
      * @Flow\Inject
      * @var \Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface
@@ -99,12 +73,6 @@ class NodeIndexCommandController extends CommandController
      */
     protected $configurationManager;
 
-    /**
-     * @Flow\Inject
-     * @var ContentDimensionCombinator
-     */
-    protected $contentDimensionCombinator;
-
     /**
      * @var array
      */
@@ -192,23 +160,24 @@ public function buildCommand($limit = null, $update = false, $workspace = null,
         $this->logger->log(sprintf('Indexing %snodes ... ', ($limit !== null ? 'the first ' . $limit . ' ' : '')), LOG_INFO);
 
         $count = 0;
-        $this->limit = $limit;
-        $this->indexedNodes = 0;
-        $this->countedIndexedNodes = 0;
 
         if ($workspace === null && $this->settings['indexAllWorkspaces'] === false) {
             $workspace = 'live';
         }
 
+        $callback = function ($workspaceName, $indexedNodes, $dimensions) {
+            if ($dimensions === array()) {
+                $this->outputLine('Workspace "' . $workspaceName . '" without dimensions done. (Indexed ' . $indexedNodes . ' nodes)');
+            } else {
+                $this->outputLine('Workspace "' . $workspaceName . '" and dimensions "' . json_encode($dimensions) . '" done. (Indexed ' . $indexedNodes . ' nodes)');
+            }
+        };
         if ($workspace === null) {
             foreach ($this->workspaceRepository->findAll() as $workspace) {
-                $this->indexWorkspace($workspace->getName());
-
-                $count = $count + $this->countedIndexedNodes;
+                $count += $this->indexWorkspace($workspace->getName(), $limit, $callback);
             }
         } else {
-            $this->indexWorkspace($workspace);
-            $count = $count + $this->countedIndexedNodes;
+            $count += $this->indexWorkspace($workspace, $limit, $callback);
         }
 
         $this->nodeIndexingManager->flushQueues();
@@ -243,60 +212,4 @@ public function cleanupCommand()
             $this->logger->log(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s"', $response->status, $response->error));
         }
     }
-
-    /**
-     * @param string $workspaceName
-     * @return void
-     */
-    protected function indexWorkspace($workspaceName)
-    {
-        $combinations = $this->contentDimensionCombinator->getAllAllowedCombinations();
-        if ($combinations === array()) {
-            $this->indexWorkspaceWithDimensions($workspaceName);
-        } else {
-            foreach ($combinations as $combination) {
-                $this->indexWorkspaceWithDimensions($workspaceName, $combination);
-            }
-        }
-    }
-
-    /**
-     * @param string $workspaceName
-     * @param array $dimensions
-     * @return void
-     */
-    protected function indexWorkspaceWithDimensions($workspaceName, array $dimensions = array())
-    {
-        $context = $this->contextFactory->create(array('workspaceName' => $workspaceName, 'dimensions' => $dimensions));
-        $rootNode = $context->getRootNode();
-
-        $this->traverseNodes($rootNode);
-
-        if ($dimensions === array()) {
-            $this->outputLine('Workspace "' . $workspaceName . '" without dimensions done. (Indexed ' . $this->indexedNodes . ' nodes)');
-        } else {
-            $this->outputLine('Workspace "' . $workspaceName . '" and dimensions "' . json_encode($dimensions) . '" done. (Indexed ' . $this->indexedNodes . ' nodes)');
-        }
-
-        $this->countedIndexedNodes = $this->countedIndexedNodes + $this->indexedNodes;
-        $this->indexedNodes = 0;
-    }
-
-    /**
-     * @param \TYPO3\TYPO3CR\Domain\Model\NodeInterface $currentNode
-     * @return void
-     */
-    protected function traverseNodes(\TYPO3\TYPO3CR\Domain\Model\NodeInterface $currentNode)
-    {
-        if ($this->limit !== null && $this->indexedNodes > $this->limit) {
-            return;
-        }
-
-        $this->nodeIndexingManager->indexNode($currentNode);
-        $this->indexedNodes++;
-
-        foreach ($currentNode->getChildNodes() as $childNode) {
-            $this->traverseNodes($childNode);
-        }
-    }
 }

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Service/IndexWorkspaceTrait.php

@@ -0,0 +1,92 @@
+<?php
+namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service;
+
+/*                                                                                                  *
+ * This script belongs to the TYPO3 Flow package "Flowpack.ElasticSearch.ContentRepositoryAdaptor". *
+ *                                                                                                  *
+ * It is free software; you can redistribute it and/or modify it under                              *
+ * the terms of the GNU Lesser General Public License, either version 3                             *
+ *  of the License, or (at your option) any later version.                                          *
+ *                                                                                                  *
+ * The TYPO3 project - inspiring people to share!                                                   *
+ *                                                                                                  */
+
+use TYPO3\Flow\Annotations as Flow;
+use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
+
+/**
+ * Index Workspace Trait
+ */
+trait IndexWorkspaceTrait
+{
+    /**
+     * @Flow\Inject
+     * @var \TYPO3\TYPO3CR\Domain\Service\ContextFactory
+     */
+    protected $contextFactory;
+
+    /**
+     * @Flow\Inject
+     * @var \TYPO3\TYPO3CR\Domain\Service\ContentDimensionCombinator
+     */
+    protected $contentDimensionCombinator;
+
+    /**
+     * @Flow\Inject
+     * @var \TYPO3\TYPO3CR\Search\Indexer\NodeIndexingManager
+     */
+    protected $nodeIndexingManager;
+
+    /**
+     * @param string $workspaceName
+     * @param integer $limit
+     * @param callable $callback
+     * @return integer
+     */
+    protected function indexWorkspace($workspaceName, $limit = null, callable $callback = null)
+    {
+        $count = 0;
+        $combinations = $this->contentDimensionCombinator->getAllAllowedCombinations();
+        if ($combinations === []) {
+            $count += $this->indexWorkspaceWithDimensions($workspaceName, [], $limit, $callback);
+        } else {
+            foreach ($combinations as $combination) {
+                $count += $this->indexWorkspaceWithDimensions($workspaceName, $combination, $limit, $callback);
+            }
+        }
+        return $count;
+    }
+
+    /**
+     * @param string $workspaceName
+     * @param array $dimensions
+     * @param integer $limit
+     * @param callable $callback
+     * @return integer
+     */
+    protected function indexWorkspaceWithDimensions($workspaceName, array $dimensions = [], $limit = null, callable $callback = null)
+    {
+        $context = $this->contextFactory->create(['workspaceName' => $workspaceName, 'dimensions' => $dimensions]);
+        $rootNode = $context->getRootNode();
+        $indexedNodes = 0;
+
+        $traverseNodes = function (NodeInterface $currentNode, &$indexedNodes) use ($limit, &$indexedNodes, &$traverseNodes) {
+            if ($limit !== null && $indexedNodes > $limit) {
+                return;
+            }
+            $this->nodeIndexingManager->indexNode($currentNode);
+            $indexedNodes++;
+            array_map(function(NodeInterface $childNode) use ($traverseNodes, &$indexedNodes) {
+                $traverseNodes($childNode, $indexedNodes);
+            }, $currentNode->getChildNodes());
+        };
+
+        $traverseNodes($rootNode, $indexedNodes);
+
+        if ($callback !== null) {
+            $callback($workspaceName, $indexedNodes, $dimensions);
+        }
+
+        return $indexedNodes;
+    }
+}