Merge pull request #64 from dfeyer/task-dynamic-index-settings

FEATURE: Add support for dynamic index settings

Author: kdambekalns

Classes/Domain/Model/Index.php

@@ -12,8 +12,10 @@
  */
 
 use Flowpack\ElasticSearch\Exception as ElasticSearchException;
+use Flowpack\ElasticSearch\Service\DynamicIndexSettingService;
 use Flowpack\ElasticSearch\Transfer\Response;
 use Neos\Utility\Arrays;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Representation of an Index
@@ -60,6 +62,12 @@ class Index
         'index.warmer.enabled',
     ];
 
+    /**
+     * @var DynamicIndexSettingService
+     * @Flow\Inject
+     */
+    protected $dynamicIndexSettingService;
+
     /**
      * @var string
      */
@@ -177,12 +185,13 @@ public function create()
     protected function getSettings()
     {
         if ($this->client instanceof Client) {
-            $settings = Arrays::getValueByPath($this->settings, 'indexes.' . $this->client->getBundle() . '.' . $this->settingsKey) ?: Arrays::getValueByPath($this->settings, 'indexes.default' . '.' . $this->settingsKey);
+            $path = 'indexes.' . $this->client->getBundle() . '.' . $this->settingsKey;
         } else {
-            $settings = Arrays::getValueByPath($this->settings, 'indexes.default' . '.' . $this->settingsKey);
+            $path = 'indexes.default' . '.' . $this->settingsKey;
         }
+        $settings = Arrays::getValueByPath($this->settings, $path);
 
-        return $settings;
+        return $this->dynamicIndexSettingService->process($settings, $path, $this->getName());
     }
 
     /**

Classes/Service/DynamicIndexSettingService.php

@@ -0,0 +1,76 @@
+<?php
+namespace Flowpack\ElasticSearch\Service;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch package.
+ *
+ * (c) Contributors of the Flowpack Team - flowpack.org
+ *
+ * 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 Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Reflection\ReflectionService;
+use Neos\Utility\PositionalArraySorter;
+
+/**
+ * Transform indices settings dynamically
+ *
+ * @Flow\Scope("singleton")
+ */
+final class DynamicIndexSettingService
+{
+    /**
+     * @Flow\Inject
+     * @var ObjectManagerInterface
+     */
+    protected $objectManager;
+
+    /**
+     * @param array $settings
+     * @param string $path
+     * @param string $indexName
+     * @return array
+     */
+    public function process(array $settings, $path, $indexName)
+    {
+        foreach (static::getAllProcessors($this->objectManager) as $configuration) {
+            /** @var IndexSettingProcessorInterface $processor */
+            $processor = $this->objectManager->get($configuration['className']);
+            if ($processor->canProcess($settings, $path)) {
+                $settings = $processor->process($settings, $path, $indexName);
+            }
+        }
+
+        return $settings;
+    }
+
+    /**
+     * Returns all class names implementing the IndexSettingProcessorInterface.
+     *
+     * @Flow\CompileStatic
+     * @param ObjectManagerInterface $objectManager
+     * @return array
+     */
+    public static function getAllProcessors($objectManager)
+    {
+        /** @var ReflectionService $reflectionService */
+        $reflectionService = $objectManager->get(ReflectionService::class);
+        $processorClassNames = $reflectionService->getAllImplementationClassNamesForInterface(IndexSettingProcessorInterface::class);
+
+        $processors = [];
+        foreach ($processorClassNames as $processorClassName) {
+            $processors[$processorClassName] = [
+                'priority' => $processorClassName::getPriority(),
+                'className' => $processorClassName
+            ];
+        }
+
+        return array_reverse(
+            (new PositionalArraySorter($processors, 'priority'))->toArray()
+        );
+    }
+}

Classes/Service/IndexSettingProcessorInterface.php

@@ -0,0 +1,42 @@
+<?php
+namespace Flowpack\ElasticSearch\Service;
+
+/*
+ * This file is part of the Flowpack.ElasticSearch package.
+ *
+ * (c) Contributors of the Flowpack Team - flowpack.org
+ *
+ * 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.
+ */
+
+/**
+ * Index setting processor
+ */
+interface IndexSettingProcessorInterface
+{
+    /**
+     * @return int
+     */
+    public static function getPriority();
+
+    /**
+     * Check if the given setting can be processed
+     *
+     * @param array $settings
+     * @param string $path
+     * @return array the processed settings passed to the next processor
+     */
+    public function canProcess(array $settings, $path);
+
+    /**
+     * Process index settings
+     *
+     * @param array $settings
+     * @param string $path
+     * @param string $indexName
+     * @return array the processed settings passed to the next processor
+     */
+    public function process(array $settings, $path, $indexName);
+}