Use SearchSuggestions when editing event rules

Author: BastianLedererIcinga

application/controllers/EventRuleController.php

@@ -18,9 +18,9 @@
 use Icinga\Module\Notifications\Hook\V2\SourceHook;
 use Icinga\Module\Notifications\Model\Rule;
 use Icinga\Module\Notifications\Model\Source;
-use Icinga\Module\Notifications\Web\Control\SearchEditor\RuleFilterSuggestions;
 use Icinga\Module\Notifications\Util\RuleSerializer;
 use Icinga\Module\Notifications\Web\Control\SearchBar\ExtraTagSuggestions;
+use Icinga\Module\Notifications\Web\Control\SearchEditor\RuleFilterSuggestions;
 use Icinga\Web\Notification;
 use Icinga\Web\Session;
 use ipl\Html\Contract\Form;
@@ -254,8 +254,7 @@ function (Condition $condition) use ($hook) {
     public function suggestAction(): void
     {
         $hook = $this->resolveSourceHook((int) $this->params->getRequired('id'));
-        $suggestions = new RuleFilterSuggestions($hook);
-        $suggestions->forRequest($this->getServerRequest());
+        $suggestions = (new RuleFilterSuggestions($hook))->forRequest($this->getServerRequest());
         $this->getDocument()->addHtml($suggestions);
     }
 

library/Notifications/Hook/V2/SourceHook.php

@@ -79,13 +79,4 @@ public function getValueSuggestions(string $column, string $searchTerm, Chain $s
      * @return Traversable Columns to be suggested as `search` => `label`
      */
     public function getColumnSuggestions(string $searchTerm): Traversable;
-
-    /**
-     * Get whether a relation label should be added to the suggestion
-     *
-     * @param string $column
-     *
-     * @return bool
-     */
-    public function shouldShowRelationFor(string $column): bool;
 }

library/Notifications/Web/Control/SearchEditor/RuleFilterSuggestions.php

@@ -6,54 +6,75 @@
 namespace Icinga\Module\Notifications\Web\Control\SearchEditor;
 
 use Icinga\Module\Notifications\Hook\V2\SourceHook;
-use ipl\Html\HtmlElement;
 use ipl\Stdlib\Filter;
-use ipl\Web\Control\SearchBar\Suggestions;
-use Traversable;
+use ipl\Web\Control\SearchEditor;
+use ipl\Web\Filter\QueryString;
+use ipl\Web\FormElement\SearchSuggestions;
+use Psr\Http\Message\ServerRequestInterface;
 
 /**
  * Suggestions for the SearchEditor used to modify rule-filters
  */
-class RuleFilterSuggestions extends Suggestions
+class RuleFilterSuggestions extends SearchSuggestions
 {
     protected SourceHook $hook;
 
+    protected ?string $type = null;
+
+    protected ?string $column = null;
+
+    protected Filter\Chain $searchFilter;
+
     public function __construct(SourceHook $hook)
     {
         $this->hook = $hook;
-    }
+        $this->searchFilter = Filter::all();
 
-    /**
-     * These suggestions aren't used by any searchbar, so this function is never called
-     */
-    protected function createQuickSearchFilter($searchTerm)
-    {
-    }
+        parent::__construct(
+            (function () {
+                if ($this->type === 'column') {
+                    $provider = $this->hook->getColumnSuggestions($this->getSearchTerm() ?? '');
+                    $this->setGroupingCallback(fn($x) => $x['group']);
+                } else {
+                    $provider = $this->hook->getValueSuggestions(
+                        $this->column,
+                        $this->getSearchTerm() ?? '',
+                        $this->searchFilter
+                    );
+                }
 
-    protected function fetchValueSuggestions($column, $searchTerm, Filter\Chain $searchFilter): Traversable
-    {
-        yield from $this->hook->getValueSuggestions($column, $searchTerm, $searchFilter);
+                yield from $provider;
+            })()
+        );
     }
 
-    protected function shouldShowRelationFor(string $column): bool
+    public function forRequest(ServerRequestInterface $request): static
     {
-        return $this->hook->shouldShowRelationFor($column);
-    }
+        if ($request->getMethod() !== 'POST') {
+            return $this;
+        }
 
-    protected function fetchColumnSuggestions($searchTerm): Traversable
-    {
-        $currentGroup = null;
-        foreach ($this->hook->getColumnSuggestions($searchTerm) as $item) {
-            if (isset($item['group']) && $item['group'] !== $currentGroup) {
-                $currentGroup = $item['group'];
-                $this->addHtml(HtmlElement::create(
-                    'li',
-                    ['class' => static::SUGGESTION_TITLE_CLASS],
-                    $currentGroup
-                ));
-            }
-
-            yield $item['search'] => $item['label'];
+        $requestData = json_decode($request->getBody()->read(8192), true);
+        if (empty($requestData)) {
+            return $this;
+        }
+
+        $this->setSearchTerm($requestData['term']['label']);
+        $this->setOriginalSearchValue($requestData['term']['search']);
+        $this->setExcludeTerms($requestData['exclude'] ?? []);
+
+        $this->type = $requestData['term']['type'] ?? null;
+
+        $column = $requestData['column'] ?? null;
+        if ($column !== null && $column !== SearchEditor::FAKE_COLUMN) {
+            $this->column = $column;
         }
+
+        $searchFilter = QueryString::parse($requestData['searchFilter'] ?? '');
+        $this->searchFilter = $searchFilter instanceof Filter\Chain
+            ? $searchFilter
+            : Filter::all($searchFilter);
+
+        return $this;
     }
 }