Merge pull request #318 from daniellienert/feature/showindexablenodetypes

FEATURE: Add show indexable command

Author: daniellienert

Classes/Command/NodeTypeCommandController.php

@@ -13,6 +13,7 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\NodeTypeIndexingConfiguration;
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\ContentRepository\Exception\NodeTypeNotFoundException;
@@ -35,6 +36,12 @@ class NodeTypeCommandController extends CommandController
      */
     protected $nodeTypeManager;
 
+    /**
+     * @Flow\Inject
+     * @var NodeTypeIndexingConfiguration
+     */
+    protected $nodeTypeIndexingConfiguration;
+
     /**
      * Show node type configuration after applying all supertypes etc
      *
@@ -58,4 +65,20 @@ public function showCommand(string $nodeType = null): void
         }
         $this->output(Yaml::dump($configuration, 5, 2));
     }
+
+    /**
+     * Shows a list of NodeTypes and if they are configured to be indexable or not
+     *
+     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     */
+    public function showIndexableConfigurationCommand(): void
+    {
+        $indexableConfiguration = $this->nodeTypeIndexingConfiguration->getIndexableConfiguration();
+        $indexTable = [];
+        foreach ($indexableConfiguration as $nodeTypeName => $value) {
+            $indexTable[] = [$nodeTypeName, $value ? '<success>true</success>' : '<error>false</error>'];
+        }
+
+        $this->output->outputTable($indexTable, ['NodeType', 'indexable']);
+    }
 }

Classes/Service/NodeTypeIndexingConfiguration.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service;
 
 /*
@@ -13,6 +15,7 @@
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use Neos\ContentRepository\Domain\Model\NodeType;
+use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -26,12 +29,18 @@ final class NodeTypeIndexingConfiguration
      */
     protected $settings;
 
+    /**
+     * @Flow\Inject
+     * @var NodeTypeManager
+     */
+    protected $nodeTypeManager;
+
     /**
      * @param NodeType $nodeType
      * @return bool
      * @throws Exception
      */
-    public function isIndexable(NodeType $nodeType)
+    public function isIndexable(NodeType $nodeType): bool
     {
         if ($this->settings === null || !is_array($this->settings)) {
             return true;
@@ -52,4 +61,19 @@ public function isIndexable(NodeType $nodeType)
 
         return false;
     }
+
+    /**
+     * @return array
+     * @throws Exception
+     */
+    public function getIndexableConfiguration(): array
+    {
+        $nodeConfigurations = [];
+        /** @var NodeType $nodeType */
+        foreach ($this->nodeTypeManager->getNodeTypes(false) as $nodeType) {
+            $nodeConfigurations[$nodeType->getName()] = $this->isIndexable($nodeType);
+        }
+
+        return $nodeConfigurations;
+    }
 }

Configuration/Testing/Settings.yaml

@@ -11,8 +11,15 @@ Neos:
       realtimeIndexing:
         enabled: false
 
+      defaultConfigurationPerNodeType:
+        '*':
+          indexed: true
+        'Flowpack.ElasticSearch.ContentRepositoryAdaptor:Type1':
+          indexed: false
+
 Flowpack:
   ElasticSearch:
     ContentRepositoryAdaptor:
       command:
         useSubProcesses: false
+

README.md

@@ -78,7 +78,6 @@ if during development, you only want to index a few nodes, you can use "limit"
 
 	./flow nodeindex:build --limit 20
 
-
 ### Cleanup old indices
 
  In order to remove old, non-used indices, you should use this command from time to time:
@@ -91,18 +90,22 @@ The following commands are meant to be used for debugging while configuring and
 
 	./flow nodeindexmapping:indices
 
-Shows the mapping between the projects dimensions presets and the resultig index name.
+Shows the mapping between the projects dimensions presets and the resulting index name.
 
 	./flow nodeindexmapping:mapping
 
 Shows the mapping created for the NodeTypes.
 
+	./flow nodetype: showIndexableConfiguration
+
+Shows a list of NodeTypes and if they are configured to be indexable
+
 	./flow search:viewnode <nodeIdentifier>
-	
+
 Shows all contents that are indexed fo a given node.
 
 	./flow search:fulltext
-	
+
 Performs a fulltext search and displays the results.
 
 

Tests/Functional/Service/NodeTypeIndexingConfigurationTest.php

@@ -0,0 +1,81 @@
+<?php
+declare(strict_types=1);
+
+namespace Flowpack\ElasticSearch\ContentRepositoryAdaptor\Tests\Functional\Service;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch.ContentRepositoryAdaptor package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\NodeTypeIndexingConfiguration;
+use Neos\ContentRepository\Domain\Service\NodeTypeManager;
+use Neos\Flow\Tests\FunctionalTestCase;
+
+class NodeTypeIndexingConfigurationTest extends FunctionalTestCase
+{
+
+    /**
+     * @var NodeTypeManager
+     */
+    protected $nodeTypeManager;
+
+    /**
+     * @var NodeTypeIndexingConfiguration
+     */
+    protected $nodeTypeIndexingConfiguration;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->nodeTypeManager = $this->objectManager->get(NodeTypeManager::class);
+        $this->nodeTypeIndexingConfiguration = $this->objectManager->get(NodeTypeIndexingConfiguration::class);
+    }
+
+    public function nodeTypeDataProvider(): array
+    {
+        return [
+            'notIndexable' => [
+                'nodeTypeName' => 'Flowpack.ElasticSearch.ContentRepositoryAdaptor:Type1',
+                'expected' => false,
+            ],
+            'indexable' => [
+                'nodeTypeName' => 'Flowpack.ElasticSearch.ContentRepositoryAdaptor:Type2',
+                'expected' => true,
+            ],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider nodeTypeDataProvider
+     *
+     * @param string $nodeTypeName
+     * @param bool $expected
+     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     * @throws \Neos\ContentRepository\Exception\NodeTypeNotFoundException
+     */
+    public function isIndexable(string $nodeTypeName, bool $expected): void
+    {
+        self::assertEquals($expected, $this->nodeTypeIndexingConfiguration->isIndexable($this->nodeTypeManager->getNodeType($nodeTypeName)));
+    }
+
+    /**
+     * @test
+     * @dataProvider nodeTypeDataProvider
+     *
+     * @param string $nodeTypeName
+     * @param bool $expected
+     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     */
+    public function getIndexableConfiguration(string $nodeTypeName, bool $expected): void
+    {
+        $indexableConfiguration = $this->nodeTypeIndexingConfiguration->getIndexableConfiguration();
+        self::assertEquals($indexableConfiguration[$nodeTypeName], $expected);
+    }
+}