Merge pull request #53 from daniellienert/task/refactor-suggestions

!!! TASK: Refactor suggestions

Author: daniellienert

Classes/Controller/SuggestController.php

@@ -47,6 +47,12 @@ class SuggestController extends ActionController
         'json' => JsonView::class
     ];
 
+    /**
+     * @Flow\InjectConfiguration("searchAsYouType")
+     * @var array
+     */
+    protected $searchAsYouTypeSettings = [];
+
     public function initializeObject()
     {
         if ($this->objectManager->isRegistered(ElasticSearchClient::class)) {
@@ -96,10 +102,11 @@ public function indexAction($term, $contextNodeIdentifier, $dimensionCombination
      * @param string $term
      * @param string $contextNodeIdentifier
      * @param string $dimensionCombination
-     * @return ElasticSearchQueryBuilder
+     * @return string
      * @throws QueryBuildingException
+     * @throws \Neos\Flow\Persistence\Exception\IllegalObjectTypeException
      */
-    protected function buildRequestForTerm($term, $contextNodeIdentifier, $dimensionCombination = null)
+    protected function buildRequestForTerm($term, $contextNodeIdentifier, $dimensionCombination = null): string
     {
         $cacheKey = $contextNodeIdentifier . '-' . md5($dimensionCombination);
         $termPlaceholder = '---term-soh2gufuNi---';
@@ -113,39 +120,44 @@ protected function buildRequestForTerm($term, $contextNodeIdentifier, $dimension
             $contentContext = $this->createContentContext('live', $dimensionCombination ? json_decode($dimensionCombination, true) : []);
             $contextNode = $contentContext->getNodeByIdentifier($contextNodeIdentifier);
 
+            $sourceFields = $this->searchAsYouTypeSettings['suggestions']['sourceFields'] ?? ['__path'];
+
             /** @var ElasticSearchQueryBuilder $query */
-            $query = $this->elasticSearchQueryBuilder->query($contextNode);
-            $query
+            $query = $this->elasticSearchQueryBuilder
+                ->query($contextNode)
                 ->queryFilter('prefix', [
                     '__completion' => $termPlaceholder
                 ])
-                ->limit(1)
+                ->limit(0)
                 ->aggregation('autocomplete', [
                     'terms' => [
                         'field' => '__completion',
                         'order' => [
                             '_count' => 'desc'
                         ],
-                        'include' => [
-                            'pattern' => $termPlaceholder . '.*'
-                        ]
+                        'include' => $termPlaceholder . '.*',
+                        'size' => $this->searchAsYouTypeSettings['autocomplete']['size'] ?? 10
                     ]
                 ])
                 ->suggestions('suggestions', [
                     'prefix' => $termPlaceholder,
                     'completion' => [
                         'field' => '__suggestions',
                         'fuzzy' => true,
-                        'size' => 10,
-                        'context' => [
+                        'size' => $this->searchAsYouTypeSettings['suggestions']['size'] ?? 10,
+                        'contexts' => [
                             'parentPath' => $contextNode->getPath(),
                             'workspace' => 'live',
                             'dimensionCombinationHash' => md5(json_encode($contextNode->getContext()->getDimensions())),
                         ]
                     ]
                 ]);
 
-            $requestTemplate = $query->getRequest()->getRequestAsJson();
+            $request = $query->getRequest()->toArray();
+
+            $request['_source'] = $sourceFields;
+
+            $requestTemplate = json_encode($request);
 
             $this->elasticSearchQueryTemplateCache->set($contextNodeIdentifier, $requestTemplate);
         } else {
@@ -163,26 +175,29 @@ protected function buildRequestForTerm($term, $contextNodeIdentifier, $dimension
      */
     protected function extractCompletions($response)
     {
-        $aggregations = isset($response['aggregations']) ? $response['aggregations'] : [];
+        $aggregations = $response['aggregations'] ?? [];
 
-        return array_map(function ($option) {
+        return array_map(static function ($option) {
             return $option['key'];
         }, $aggregations['autocomplete']['buckets']);
     }
 
     /**
      * Extract suggestion options
      *
-     * @param $response
+     * @param array $response
      * @return array
      */
-    protected function extractSuggestions($response)
+    protected function extractSuggestions(array $response): array
     {
-        $suggestionOptions = isset($response['suggest']) ? $response['suggest'] : [];
+        $suggestionOptions = $response['suggest']['suggestions'][0]['options'] ?? [];
 
-        if (count($suggestionOptions['suggestions'][0]['options']) > 0) {
-            return $suggestionOptions['suggestions'][0]['options'];
+        if (empty($suggestionOptions)) {
+            return [];
         }
-        return [];
+
+        return array_map(static function ($option) {
+            return $option['_source'];
+        }, $suggestionOptions);
     }
 }

Classes/EelHelper/SuggestionIndexHelper.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace Flowpack\SearchPlugin\EelHelper;
 
 /*
@@ -24,10 +26,9 @@ class SuggestionIndexHelper implements ProtectedContextAwareInterface
 {
     /**
      * @param string|array $input The input to store, this can be a an array of strings or just a string. This field is mandatory.
-     * @param string $output The result is de-duplicated if several documents have the same output, i.e. only one is returned as part of the suggest result.
-     * @param array $payload An arbitrary JSON object, which is simply returned in the suggest option.
      * @param int $weight A positive integer or a string containing a positive integer, which defines a weight and allows you to rank your suggestions.
      * @return array
+     * @throws Exception
      */
     public function build($input, $weight = 1)
     {
@@ -44,7 +45,7 @@ public function build($input, $weight = 1)
      */
     protected function prepareInput($input)
     {
-        $process = function ($input) {
+        $process = static function ($input) {
             if (!\is_string($input)) {
                 throw new Exception('Only string are supported as input', 1512733297);
             }

Configuration/NodeTypes.Mixin.Autocompletable.yaml

@@ -0,0 +1,10 @@
+'Flowpack.SearchPlugin:AutocompletableMixin':
+  abstract: true
+  properties:
+    '__completion':
+      search:
+        elasticSearchMapping:
+          type: text
+          analyzer: autocomplete
+          fielddata: true
+        indexing: "${String.stripTags(q(node).property('title'))}"

Configuration/NodeTypes.Mixins.yaml …uration/NodeTypes.Mixin.Suggestable.yamlConfiguration/NodeTypes.Mixins.yaml renamed to Configuration/NodeTypes.Mixin.Suggestable.yaml Configuration/NodeTypes.Mixins.yaml renamed to Configuration/NodeTypes.Mixin.Suggestable.yaml

@@ -19,14 +19,3 @@
               type: category
               path: '__dimensionCombinationHash'
         indexing: "${Flowpack.SearchPlugin.Suggestion.build(q(node).property('title') ? q(node).property('title') : '', 20)}"
-
-'Flowpack.SearchPlugin:AutocompletableMixin':
-  abstract: true
-  properties:
-    '__completion':
-      search:
-        elasticSearchMapping:
-          type: text
-          analyzer: autocomplete
-          fielddata: true
-        indexing: "${String.stripTags(q(node).property('title'))}"

Configuration/Settings.Neos.yaml

@@ -0,0 +1,17 @@
+Neos:
+  Flow:
+    mvc:
+      routes:
+        'Flowpack.SearchPlugin':
+          position: 'before Neos.Neos'
+  Fusion:
+    defaultContext:
+      Flowpack.SearchPlugin.Array: Flowpack\SearchPlugin\EelHelper\SearchArrayHelper
+  Neos:
+    fusion:
+      autoInclude:
+        Flowpack.SearchPlugin: true
+  ContentRepository:
+    Search:
+      defaultContext:
+        Flowpack.SearchPlugin.Suggestion: Flowpack\SearchPlugin\EelHelper\SuggestionIndexHelper

Configuration/Settings.yaml

@@ -1,17 +1,10 @@
-Neos:
-  Flow:
-    mvc:
-      routes:
-        'Flowpack.SearchPlugin':
-          position: 'before Neos.Neos'
-  Fusion:
-    defaultContext:
-      Flowpack.SearchPlugin.Array: Flowpack\SearchPlugin\EelHelper\SearchArrayHelper
-  Neos:
-    fusion:
-      autoInclude:
-        Flowpack.SearchPlugin: true
-  ContentRepository:
-    Search:
-      defaultContext:
-        Flowpack.SearchPlugin.Suggestion: Flowpack\SearchPlugin\EelHelper\SuggestionIndexHelper
+Flowpack:
+  SearchPlugin:
+    searchAsYouType:
+      autocomplete:
+        size: 10
+      suggestions:
+        size: 10
+        sourceFields:
+          - __path
+          - title