Merge pull request #321 from daniellienert/feature/prefix-query

FEATURE: Prefix query operation

Author: daniellienert

Classes/Command/NodeIndexCommandController.php

@@ -215,6 +215,7 @@ public function indexNodeCommand(string $identifier, string $workspace = null, s
      * @return void
      * @throws StopCommandException
      * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     * @throws ConfigurationException
      */
     public function buildCommand(int $limit = null, bool $update = false, string $workspace = null, string $postfix = null): void
     {

Classes/Eel/ElasticSearchQueryBuilder.php

@@ -429,8 +429,8 @@ public function fieldBasedAggregation(string $name, string $field, string $type
      *
      * Example Usage to create a terms aggregation for a property color:
      *
-     * aggregationDefinition = Neos.Fusion:RawArray {
-     *   terms = Neos.Fusion:RawArray {
+     * aggregationDefinition = Neos.Fusion:DataStructure {
+     *   terms {
      *     field = "color"
      *   }
      * }
@@ -562,7 +562,7 @@ public function getFrom(): int
      * @param NodeInterface $node
      * @return array the Elasticsearch hit for the node as array, or NULL if it does not exist.
      */
-    public function getFullElasticSearchHitForNode(NodeInterface $node): array
+    public function getFullElasticSearchHitForNode(NodeInterface $node): ?array
     {
         return $this->elasticSearchHitsIndexedByNodeFromLastRequest[$node->getIdentifier()] ?? null;
     }
@@ -596,7 +596,8 @@ public function fetch(): array
                 $this->result['nodes'] = $this->convertHitsToNodes($searchResult->getHits());
             }
         } catch (ApiException $exception) {
-            $this->throwableStorage->logThrowable($exception);
+            $message = $this->throwableStorage->logThrowable($exception);
+            $this->logger->error(sprintf('Request failed with %s', $message), LogEnvironment::fromMethodName(__METHOD__));
             $this->result['nodes'] = [];
         }
 
@@ -668,7 +669,7 @@ public function count()
      * Match the searchword against the fulltext index
      *
      * @param string $searchWord
-     * @param array $options Options to configure the query_string, see https://www.elastic.co/guide/en/elasticsearch/reference/5.6/query-dsl-query-string-query.html
+     * @param array $options Options to configure the query_string, see https://www.elastic.co/guide/en/elasticsearch/reference/7.6/query-dsl-query-string-query.html
      * @return QueryBuilderInterface
      * @api
      */
@@ -681,6 +682,22 @@ public function fulltext(string $searchWord, array $options = []): QueryBuilderI
         return $this;
     }
 
+    /**
+     * Adds a prefix filter to the query
+     * See: https://www.elastic.co/guide/en/elasticsearch/reference/7.6/query-dsl-prefix-query.html
+     *
+     * @param string $propertyName
+     * @param string $prefix
+     * @return $this|QueryBuilderInterface
+     * @throws QueryBuildingException
+     */
+    public function prefix(string $propertyName, string $prefix): QueryBuilderInterface
+    {
+        $this->request->queryFilter('prefix', [$propertyName => $prefix]);
+
+        return $this;
+    }
+
     /**
      * Configure Result Highlighting. Only makes sense in combination with fulltext(). By default, highlighting is enabled.
      * It can be disabled by calling "highlight(FALSE)".

Classes/Indexer/NodeIndexer.php

@@ -558,7 +558,7 @@ public function updateIndexAlias(): void
      * @throws Exception
      * @throws Exception\ConfigurationException
      */
-    public function updateMainAlias()
+    public function updateMainAlias(): void
     {
         $aliasActions = [];
         $aliasNamePrefix = $this->searchClient->getIndexNamePrefix(); // The alias name is the unprefixed index name

Configuration/Settings.Neos.ContentRepository.Search.yaml

@@ -23,6 +23,10 @@ Neos:
           elasticSearchMapping:
             type: boolean
 
+        array:
+          elasticSearchMapping:
+            type: keyword
+
         integer:
           elasticSearchMapping:
             type: integer

README.md

@@ -143,9 +143,10 @@ Flowpack:
     indexes:
       default: # Configuration bundle name
         neoscontentrepository: # The index prefix name, must be the same as in the Neos.ContentRepository.Search.elasticSearch.indexName setting
-          index:
-            number_of_shards: 1
-            number_of_replicas: 0
+          settings:
+            index:
+              number_of_shards: 1
+              number_of_replicas: 0
 ```
 
 ### Configure per dimension
@@ -159,22 +160,23 @@ Flowpack:
   ElasticSearch:
     indexes:
       default: 
-        'neoscontentrepository-0359ed5c416567b8bc2e5ade0f277b36': # The hash specifies the dimension combination 
-          index:
-            number_of_shards: 1
-            number_of_replicas: 0
-          analysis:
-            filter:
-              elision:
-                type: 'elision'
-                articles: [ 'l', 'm', 't', 'qu', 'n', 's', 'j', 'd' ]
-            analyzer:
-              custom_french_analyzer:
-                tokenizer: 'letter'
-                filter: [ 'asciifolding', 'lowercase', 'french_stem', 'elision', 'stop' ]
-              tag_analyzer:
-                tokenizer: 'keyword'
-                filter: [ 'asciifolding', 'lowercase' ]
+        'neoscontentrepository-0359ed5c416567b8bc2e5ade0f277b36': # The hash specifies the dimension combination
+          settings: 
+            index:
+              number_of_shards: 1
+              number_of_replicas: 0
+            analysis:
+              filter:
+                elision:
+                  type: 'elision'
+                  articles: [ 'l', 'm', 't', 'qu', 'n', 's', 'j', 'd' ]
+              analyzer:
+                custom_french_analyzer:
+                  tokenizer: 'letter'
+                  filter: [ 'asciifolding', 'lowercase', 'french_stem', 'elision', 'stop' ]
+                tag_analyzer:
+                  tokenizer: 'keyword'
+                  filter: [ 'asciifolding', 'lowercase' ]
 ```
 
 Which dimension combinations are available in your system and which hashes they are identified with can be shown with the CLI command: 
@@ -406,18 +408,20 @@ Furthermore, the following operators are supported:
 
 As **value**, the following methods accept a simple type, a node object or a DateTime object.
 
-* `nodeType('Your.Node:Type')`
-* `exactMatch('propertyName', value)` -- supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`
-* `exclude('propertyName', value)` -- excludes results by property - the negation of exactMatch.
-* `greaterThan('propertyName', value, [clauseType])` -- range filter with property values greater than the given value
-* `greaterThanOrEqual('propertyName', value, [clauseType])` -- range filter with property values greater than or equal to the given value
-* `lessThan('propertyName', value, [clauseType])` -- range filter with property values less than the given value
-* `lessThanOrEqual('propertyName', value, [clauseType])` -- range filter with property values less than or equal to the given value
-* `sortAsc('propertyName')` and `sortDesc('propertyName')` -- can also be used multiple times, e.g. `sortAsc('tag').sortDesc(`date')`
-   will first sort by tag ascending, and then by date descending.
-* `limit(5)` -- only return five results. If not specified, the default limit by Elasticsearch applies (which is at 10 by default)
-* `from(5)` -- return the results starting from the 6th one
-* `fulltext('searchWord', options)` -- do a query_string query on the Fulltext index using the searchword and additional [options](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/query-dsl-query-string-query.html) to the query_string
+| Query Operator | Description |
+|----------------|-------------|
+|`nodeType('Your.Node:Type')`                          |Filters on the given NodeType|
+|`exactMatch('propertyName', value)`                   |Supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`|
+|`exclude('propertyName', value)`                      |Excludes results by property - the negation of exactMatch.
+|`greaterThan('propertyName', value, [clauseType])`    |Range filter with property values greater than the given value|
+|`greaterThanOrEqual('propertyName', value, [clauseType])`|Range filter with property values greater than or equal to the given value|
+|`lessThan('propertyName', value, [clauseType])`       |Range filter with property values less than the given value|
+|`lessThanOrEqual('propertyName', value, [clauseType])`|Range filter with property values less than or equal to the given value|
+|`sortAsc('propertyName')` / `sortDesc('propertyName')`|Can also be used multiple times, e.g. `sortAsc('tag').sortDesc(`date')` will first sort by tag ascending, and then by date descending.|
+|`limit(5)`                                            |Only return five results. If not specified, the default limit by Elasticsearch applies (which is at 10 by default)|
+|`from(5)`                                             |Return the results starting from the 6th one|
+|`prefix('propertyName', 'prefix')`                    |Does a prefix on the given field with the given prefix|
+|`fulltext('searchWord', options)`                     |Does a query_string query on the Fulltext index using the searchword and additional [options](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/query-dsl-query-string-query.html) to the query_string|
 
 ## moreLikeThis(like, fields, options)
 
@@ -539,8 +543,8 @@ fieldBasedAggregation("anotherAggregation", "field", "avg", "colors.avgprice")
 To add a custom aggregation you can use the `aggregation()` method. All you have to do is to provide an array with your
 aggregation definition. This example would do the same as the fieldBasedAggregation would do for you:
 ```
-aggregationDefinition = Neos.Fusion:RawArray {
-    terms = Neos.Fusion:RawArray {
+aggregationDefinition = Neos.Fusion:DataStructure {
+    terms = Neos.Fusion:DataStructure {
         field = "color"
     }
 }
@@ -558,7 +562,7 @@ prototype(Vendor.Name:FilteredProductList) < prototype(Neos.Neos:Content)
 prototype(Vendor.Name:FilteredProductList) {
 
     // Create SearchFilter for products
-    searchFilter = Neos.Fusion:RawArray {
+    searchFilter = Neos.Fusion:DataStructure {
         sku = ${String.split(q(node).property("products"), ",")}
     }
 
@@ -607,9 +611,6 @@ for all your filterable properties, or else filtering won't work on them properl
           type: keyword
 ```
 
-**Note:** When using Elasticsearch 5.x the mapping needs to be adjusted in a different way.
-More information on the [mapping in ElasticSearch 5.x](Documentation/ElasticMapping-5.x.md).
-
 ## Sorting
 
 This package adapts Elasticsearchs sorting capabilities. You can add multiple sort operations to your query.
@@ -631,9 +632,9 @@ nodes = ${q(Search.query(site).....sortAsc("title").sortDesc("name").execute())}
 
 # Custom sort operation
 
-geoSorting = Neos.Fusion:RawArray {
-    _geo_distance = Neos.Fusion:RawArray {
-        latlng = Neos.Fusion:RawArray {
+geoSorting = Neos.Fusion:DataStructure {
+    _geo_distance = Neos.Fusion:DataStructure {
+        latlng = Neos.Fusion:DataStructure {
             lat = 51.512711
             lon = 7.453084
         }
@@ -666,9 +667,9 @@ First of all you have to define a property in your NodeTypes.yaml for your node
 
 Query your nodes in your Fusion:
 ```
-geoSorting = Neos.Fusion:RawArray {
-    _geo_distance = Neos.Fusion:RawArray {
-        latlng = Neos.Fusion:RawArray {
+geoSorting = Neos.Fusion:DataStructure {
+    _geo_distance = Neos.Fusion:DataStructure {
+        latlng = Neos.Fusion:DataStructure {
             lat = 51.512711
             lon = 7.453084
         }
@@ -757,10 +758,10 @@ You can access your suggestions inside your fluid template with
 Phrase query that returns query suggestions
 
 ```
-suggestionsQueryDefinition = Neos.Fusion:RawArray {
+suggestionsQueryDefinition = Neos.Fusion:DataStructure {
     text = 'some Text'
-    simple_phrase = Neos.Fusion:RawArray {
-        phrase = Neos.Fusion:RawArray {
+    simple_phrase = Neos.Fusion:DataStructure {
+        phrase = Neos.Fusion:DataStructure {
             analyzer = 'body'
             field = 'bigram'
             size = 1

Tests/Functional/Eel/ElasticSearchQueryTest.php

@@ -191,6 +191,23 @@ public function filterNodeByProperty(): void
         static::assertEquals(1, $resultCount);
     }
 
+    /**
+     * @test
+     *
+     * @throws QueryBuildingException
+     * @throws \Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception
+     * @throws \Flowpack\ElasticSearch\Exception
+     * @throws \Neos\Flow\Http\Exception
+     */
+    public function prefixFilter(): void
+    {
+        $resultCount = $this->getQueryBuilder()
+            ->log($this->getLogMessagePrefix(__METHOD__))
+            ->prefix('title', 'chi')
+            ->count();
+        static::assertEquals(2, $resultCount);
+    }
+
     /**
      * @test
      */