feat: revamp search (#3893)

* refactor: move gambits to frontend (#3885)
* refactor: move gambits to frontend
* test: GambitManager
* refactor: merge filterer and searcher concepts (#3892)
* chore: drop remaining backend regex gambits
* refactor: merge filterer & searcher concept
* refactor: adapt extenders
* refactor: no longer need to push gambits to `q`
* refactor: filters to gambits
* refactor: drop shred `Query` namespace
* chore: cleanup
* chore: leftover gambit references on the backend (#3894)
* chore: leftover gambit references on the backend
* chore: namespace
* feat: search driver backend extension API (#3902)
* feat: first iteration of search drivers
* feat: indexer API & tweaks
* feat: changes after POC driver
* fix: properly fire custom observables
* chore: remove debugging code
* fix: phpstan
* fix: custom eloquent events
* chore: drop POC usage
* test: indexer extender API
* fix: extension searcher fails without filters
* fix: phpstan
* fix: frontend created gambit
* feat: advanced page and localized driver settings (#3905)
* feat: allow getting total search results and replacing filters (#3906)
* feat: allow accessing total search results
* feat: allow replacing filters
* chore: phpstan

extensions/sticky/extend.php

@@ -11,16 +11,16 @@ use Flarum\Api\Controller\ListDiscussionsController;
 use Flarum\Api\Serializer\DiscussionSerializer;
 use Flarum\Discussion\Discussion;
 use Flarum\Discussion\Event\Saving;
-use Flarum\Discussion\Filter\DiscussionFilterer;
 use Flarum\Discussion\Search\DiscussionSearcher;
 use Flarum\Extend;
+use Flarum\Search\Database\DatabaseSearchDriver;
 use Flarum\Sticky\Event\DiscussionWasStickied;
 use Flarum\Sticky\Event\DiscussionWasUnstickied;
 use Flarum\Sticky\Listener;
 use Flarum\Sticky\Listener\SaveStickyToDatabase;
 use Flarum\Sticky\PinStickiedDiscussionsToTop;
 use Flarum\Sticky\Post\DiscussionStickiedPost;
-use Flarum\Sticky\Query\StickyFilterGambit;
+use Flarum\Sticky\Query\StickyFilter;
 
 return [
     (new Extend\Frontend('forum'))
@@ -54,10 +54,7 @@ return [
         ->listen(DiscussionWasStickied::class, [Listener\CreatePostWhenDiscussionIsStickied::class, 'whenDiscussionWasStickied'])
         ->listen(DiscussionWasUnstickied::class, [Listener\CreatePostWhenDiscussionIsStickied::class, 'whenDiscussionWasUnstickied']),
 
-    (new Extend\Filter(DiscussionFilterer::class))
-        ->addFilter(StickyFilterGambit::class)
-        ->addFilterMutator(PinStickiedDiscussionsToTop::class),
-
-    (new Extend\SimpleFlarumSearch(DiscussionSearcher::class))
-        ->addGambit(StickyFilterGambit::class),
+    (new Extend\SearchDriver(DatabaseSearchDriver::class))
+        ->addFilter(DiscussionSearcher::class, StickyFilter::class)
+        ->addMutator(DiscussionSearcher::class, PinStickiedDiscussionsToTop::class),
 ];

extensions/sticky/js/src/admin/extend.ts

@@ -0,0 +1 @@
+export { default as default } from '../common/extend';

extensions/sticky/js/src/admin/index.js

@@ -1,5 +1,7 @@
 import app from 'flarum/admin/app';
 
+export { default as extend } from './extend';
+
 app.initializers.add('flarum-sticky', () => {
   app.extensionData.for('flarum-sticky').registerPermission(
     {

extensions/sticky/js/src/common/extend.ts

@@ -0,0 +1,7 @@
+import Extend from 'flarum/common/extenders';
+import StickyGambit from './query/discussions/StickyGambit';
+
+export default [
+  new Extend.Search() //
+    .gambit('discussions', StickyGambit),
+];

extensions/sticky/js/src/common/query/discussions/StickyGambit.ts

@@ -0,0 +1,23 @@
+import IGambit from 'flarum/common/query/IGambit';
+
+export default class StickyGambit implements IGambit {
+  pattern(): string {
+    return 'is:sticky';
+  }
+
+  toFilter(_matches: string[], negate: boolean): Record<string, any> {
+    const key = (negate ? '-' : '') + 'sticky';
+
+    return {
+      [key]: true,
+    };
+  }
+
+  filterKey(): string {
+    return 'sticky';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:sticky`;
+  }
+}

extensions/sticky/js/src/forum/extend.ts

@@ -2,7 +2,11 @@ import Extend from 'flarum/common/extenders';
 import Discussion from 'flarum/common/models/Discussion';
 import DiscussionStickiedPost from './components/DiscussionStickiedPost';
 
+import commonExtend from '../common/extend';
+
 export default [
+  ...commonExtend,
+
   new Extend.PostTypes() //
     .add('discussionStickied', DiscussionStickiedPost),
 

extensions/sticky/src/PinStickiedDiscussionsToTop.php

@@ -9,23 +9,23 @@
 
 namespace Flarum\Sticky;
 
-use Flarum\Filter\FilterState;
-use Flarum\Query\QueryCriteria;
-use Flarum\Tags\Query\TagFilterGambit;
+use Flarum\Search\Database\DatabaseSearchState;
+use Flarum\Search\SearchCriteria;
+use Flarum\Tags\Search\Filter\TagFilter;
 
 class PinStickiedDiscussionsToTop
 {
-    public function __invoke(FilterState $filterState, QueryCriteria $criteria): void
+    public function __invoke(DatabaseSearchState $state, SearchCriteria $criteria): void
     {
-        if ($criteria->sortIsDefault) {
-            $query = $filterState->getQuery();
+        if ($criteria->sortIsDefault && ! $state->isFulltextSearch()) {
+            $query = $state->getQuery();
 
             // If we are viewing a specific tag, then pin all stickied
             // discussions to the top no matter what.
-            $filters = $filterState->getActiveFilters();
+            $filters = $state->getActiveFilters();
 
             if ($count = count($filters)) {
-                if ($count === 1 && $filters[0] instanceof TagFilterGambit) {
+                if ($count === 1 && $filters[0] instanceof TagFilter) {
                     if (! is_array($query->orders)) {
                         $query->orders = [];
                     }
@@ -51,14 +51,14 @@ class PinStickiedDiscussionsToTop
                 ->selectRaw('1')
                 ->from('discussion_user as sticky')
                 ->whereColumn('sticky.discussion_id', 'id')
-                ->where('sticky.user_id', '=', $filterState->getActor()->id)
+                ->where('sticky.user_id', '=', $state->getActor()->id)
                 ->whereColumn('sticky.last_read_post_number', '>=', 'last_post_number');
 
             // Add the bindings manually (rather than as the second
             // argument in orderByRaw) for now due to a bug in Laravel which
             // would add the bindings in the wrong order.
             $query->orderByRaw('is_sticky and not exists ('.$read->toSql().') and last_posted_at > ? desc')
-                ->addBinding(array_merge($read->getBindings(), [$filterState->getActor()->marked_all_as_read_at ?: 0]), 'union');
+                ->addBinding(array_merge($read->getBindings(), [$state->getActor()->marked_all_as_read_at ?: 0]), 'union');
 
             $query->unionOrders = array_merge($query->unionOrders, $query->orders);
             $query->unionLimit = $query->limit;

extensions/sticky/src/Query/StickyFilter.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Sticky\Query;
+
+use Flarum\Search\Database\DatabaseSearchState;
+use Flarum\Search\Filter\FilterInterface;
+use Flarum\Search\SearchState;
+use Illuminate\Database\Query\Builder;
+
+/**
+ * @implements FilterInterface<DatabaseSearchState>
+ */
+class StickyFilter implements FilterInterface
+{
+    public function getFilterKey(): string
+    {
+        return 'sticky';
+    }
+
+    public function filter(SearchState $state, string|array $value, bool $negate): void
+    {
+        $this->constrain($state->getQuery(), $negate);
+    }
+
+    protected function constrain(Builder $query, bool $negate): void
+    {
+        $query->where('is_sticky', ! $negate);
+    }
+}

extensions/sticky/src/Query/StickyFilterGambit.php

@@ -1,44 +0,0 @@
-<?php
-
-/*
- * This file is part of Flarum.
- *
- * For detailed copyright and license information, please view the
- * LICENSE file that was distributed with this source code.
- */
-
-namespace Flarum\Sticky\Query;
-
-use Flarum\Filter\FilterInterface;
-use Flarum\Filter\FilterState;
-use Flarum\Search\AbstractRegexGambit;
-use Flarum\Search\SearchState;
-use Illuminate\Database\Query\Builder;
-
-class StickyFilterGambit extends AbstractRegexGambit implements FilterInterface
-{
-    protected function getGambitPattern(): string
-    {
-        return 'is:sticky';
-    }
-
-    protected function conditions(SearchState $search, array $matches, bool $negate): void
-    {
-        $this->constrain($search->getQuery(), $negate);
-    }
-
-    public function getFilterKey(): string
-    {
-        return 'sticky';
-    }
-
-    public function filter(FilterState $filterState, string|array $filterValue, bool $negate): void
-    {
-        $this->constrain($filterState->getQuery(), $negate);
-    }
-
-    protected function constrain(Builder $query, bool $negate): void
-    {
-        $query->where('is_sticky', ! $negate);
-    }
-}