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/lock/extend.php

@@ -11,16 +11,16 @@ use Flarum\Api\Serializer\BasicDiscussionSerializer;
 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\Lock\Access;
 use Flarum\Lock\Event\DiscussionWasLocked;
 use Flarum\Lock\Event\DiscussionWasUnlocked;
+use Flarum\Lock\Filter\LockedFilter;
 use Flarum\Lock\Listener;
 use Flarum\Lock\Notification\DiscussionLockedBlueprint;
 use Flarum\Lock\Post\DiscussionLockedPost;
-use Flarum\Lock\Query\LockedFilterGambit;
+use Flarum\Search\Database\DatabaseSearchDriver;
 
 return [
     (new Extend\Frontend('forum'))
@@ -57,9 +57,6 @@ return [
     (new Extend\Policy())
         ->modelPolicy(Discussion::class, Access\DiscussionPolicy::class),
 
-    (new Extend\Filter(DiscussionFilterer::class))
-        ->addFilter(LockedFilterGambit::class),
-
-    (new Extend\SimpleFlarumSearch(DiscussionSearcher::class))
-        ->addGambit(LockedFilterGambit::class),
+    (new Extend\SearchDriver(DatabaseSearchDriver::class))
+        ->addFilter(DiscussionSearcher::class, LockedFilter::class),
 ];

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

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

extensions/lock/js/src/admin/index.js

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

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

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

extensions/lock/js/src/common/query/discussions/LockedGambit.ts

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

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

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

extensions/lock/src/Filter/LockedFilter.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\Lock\Filter;
+
+use Flarum\Search\Database\DatabaseSearchState;
+use Flarum\Search\Filter\FilterInterface;
+use Flarum\Search\SearchState;
+use Illuminate\Database\Query\Builder;
+
+/**
+ * @implements FilterInterface<DatabaseSearchState>
+ */
+class LockedFilter implements FilterInterface
+{
+    public function getFilterKey(): string
+    {
+        return 'locked';
+    }
+
+    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_locked', ! $negate);
+    }
+}

extensions/lock/src/Query/LockedFilterGambit.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\Lock\Query;
-
-use Flarum\Filter\FilterInterface;
-use Flarum\Filter\FilterState;
-use Flarum\Search\AbstractRegexGambit;
-use Flarum\Search\SearchState;
-use Illuminate\Database\Query\Builder;
-
-class LockedFilterGambit extends AbstractRegexGambit implements FilterInterface
-{
-    protected function getGambitPattern(): string
-    {
-        return 'is:locked';
-    }
-
-    protected function conditions(SearchState $search, array $matches, bool $negate): void
-    {
-        $this->constrain($search->getQuery(), $negate);
-    }
-
-    public function getFilterKey(): string
-    {
-        return 'locked';
-    }
-
-    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_locked', ! $negate);
-    }
-}