FEATURE: allow modifying the Elasticsearch request in arbitrary ways by using request()

Author: skurfuerst

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

@@ -14,6 +14,7 @@
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException;
 use TYPO3\Eel\ProtectedContextAwareInterface;
 use TYPO3\Flow\Annotations as Flow;
+use TYPO3\Flow\Utility\Arrays;
 use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
 use TYPO3\TYPO3CR\Search\Search\QueryBuilderInterface;
 
@@ -792,6 +793,28 @@ public function query(NodeInterface $contextNode)
         return $this;
     }
 
+    /**
+     * Modify a part of the Elasticsearch Request denoted by $path, merging together
+     * the existing values and the passed-in values.
+     *
+     * @param string $path
+     * @param mixed $requestPart
+     * @return $this
+     */
+    public function request($path, $requestPart)
+    {
+        $valueAtPath = Arrays::getValueByPath($this->request, $path);
+        if (is_array($valueAtPath)) {
+            $result = Arrays::arrayMergeRecursiveOverrule($valueAtPath, $requestPart);
+        } else {
+            $result = $requestPart;
+        }
+
+        $this->request = Arrays::setValueByPath($this->request, $path, $result);
+
+        return $this;
+    }
+
     /**
      * All methods are considered safe
      *

README.md

@@ -224,6 +224,11 @@ Furthermore, there is a more low-level operator which can be used to add arbitra
 
 * `queryFilter("filterType", {option1: "value1"})`
 
+At lowest level, there is the `request` operator which allows to modify the request in arbitrary manner. Note that the existing request is merged with the passed-in type in case it is an array:
+
+* `request('query.filtered.query.bool.minimum_should_match', 1)`
+* `request('query.filtered.query.bool', {"minimum_should_match": 1})`
+
 In order to debug the query more easily, the following operation is helpful:
 
 * `log()` log the full query on execution into the Elasticsearch log (i.e. in `Data/Logs/ElasticSearch.log`)

Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php

@@ -328,6 +328,32 @@ public function aCustomAggregationDefinitionCanBeApplied()
         $this->assertInArray($expected, $actual);
     }
 
+    /**
+     * @test
+     */
+    public function requestCanBeExtendedByArbitraryProperties()
+    {
+        $this->queryBuilder->request('foo.bar', ['field' => 'x']);
+        $expected = [
+            'bar' => ['field' => 'x']
+        ];
+        $actual = $this->queryBuilder->getRequest();
+        $this->assertEquals($expected, $actual['foo']);
+    }
+
+    /**
+     * @test
+     */
+    public function existingRequestPropertiesCanBeOverridden()
+    {
+        $this->queryBuilder->limit(2);
+        $this->queryBuilder->request('limit', 10);
+        $expected = 10;
+        $actual = $this->queryBuilder->getRequest();
+        $this->assertEquals($expected, $actual['limit']);
+    }
+
+
     /**
      * Test helper
      *