Merge pull request #8 from ensi-platform/task-96329-2

#96329 Match and multi match filters options

Author: zix2

README.md

@@ -135,6 +135,8 @@ AllowedFilter::greater('name', 'field');        // The field value must be great
 AllowedFilter::greaterOrEqual('name', 'field'); // The field value must be greater than or equal to the specified one.
 AllowedFilter::less('name', 'field');           // The field value must be less than the specified one.
 AllowedFilter::lessOrEqual('name', 'field');    // The field value must be less than or equal to the specified one.
+AllowedFilter::match('name', 'field');          // Full text search in the field
+AllowedFilter::multiMatch('name', ['field1^3', 'field2']);    // Full text search in the fields
 ```
 
 The sorts available to the client are added by the `allowedSorts` method. The sorting direction is set in its name.

composer.lock

@@ -3,6 +3,8 @@
 namespace Ensi\LaravelElasticQuerySpecification\Filtering;
 
 use Ensi\LaravelElasticQuery\Contracts\BoolQuery;
+use Ensi\LaravelElasticQuery\Contracts\MatchOptions;
+use Ensi\LaravelElasticQuery\Contracts\MultiMatchOptions;
 use Ensi\LaravelElasticQuerySpecification\Contracts\Constraint;
 use Ensi\LaravelElasticQuerySpecification\Contracts\FilterAction;
 use Webmozart\Assert\Assert;
@@ -117,9 +119,18 @@ public static function lessOrEqual(string $name, ?string $field = null): self
         return new static($name, new RangeFilterAction('<='), $field);
     }
 
-    public static function match(string $name, ?string $field): self
+    public static function match(string $name, ?string $field, ?MatchOptions $options = null): self
     {
-        return new static($name, new MatchFilterAction(), $field);
+        return new static($name, new MatchFilterAction($options ?? new MatchOptions()), $field);
+    }
+
+    public static function multiMatch(string $name, ?array $fields = null, ?MultiMatchOptions $options = null): self
+    {
+        return new static(
+            $name,
+            new MultiMatchFilterAction($options ?? new MultiMatchOptions()),
+            MultiMatchFilterAction::encodeFields($fields)
+        );
     }
 
     private function refineValue(mixed $value): mixed

src/Filtering/AllowedFilter.php

@@ -3,15 +3,20 @@
 namespace Ensi\LaravelElasticQuerySpecification\Filtering;
 
 use Ensi\LaravelElasticQuery\Contracts\BoolQuery;
+use Ensi\LaravelElasticQuery\Contracts\MatchOptions;
 use Ensi\LaravelElasticQuerySpecification\Contracts\FilterAction;
 use Ensi\LaravelElasticQuerySpecification\Exceptions\InvalidQueryException;
 
 class MatchFilterAction implements FilterAction
 {
+    public function __construct(private MatchOptions $options)
+    {
+    }
+
     public function __invoke(BoolQuery $query, mixed $value, string $field): void
     {
         FilterValue::make($value)
-            ->whenSingle(fn (mixed $value) => $query->whereMatch($field, (string)$value))
+            ->whenSingle(fn (mixed $value) => $query->whereMatch($field, (string)$value, $this->options))
             ->whenMultiple(fn () => throw InvalidQueryException::notSupportMultipleValues($field));
     }
 }

src/Filtering/MatchFilterAction.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Ensi\LaravelElasticQuerySpecification\Filtering;
+
+use Ensi\LaravelElasticQuery\Contracts\BoolQuery;
+use Ensi\LaravelElasticQuery\Contracts\MultiMatchOptions;
+use Ensi\LaravelElasticQuerySpecification\Contracts\FilterAction;
+use Ensi\LaravelElasticQuerySpecification\Exceptions\InvalidQueryException;
+
+class MultiMatchFilterAction implements FilterAction
+{
+    public function __construct(private MultiMatchOptions $options)
+    {
+    }
+
+    public function __invoke(BoolQuery $query, mixed $value, string $field): void
+    {
+        $fields = explode(',', $field);
+
+        FilterValue::make($value)
+            ->whenSingle(fn (mixed $value) => $query->whereMultiMatch($fields, (string)$value, $this->options))
+            ->whenMultiple(fn () => throw InvalidQueryException::notSupportMultipleValues($field));
+    }
+
+    public static function encodeFields(?array $fields): string
+    {
+        return implode(',', $fields ?: ['*']);
+    }
+}

src/Filtering/MultiMatchFilterAction.php

@@ -81,7 +81,7 @@
     "name": "Gloves VITTOVAR",
     "code": "perchatki-s-zashchitoy",
     "rating": 3,
-    "description": "VITTOVAR description",
+    "description": "VITTOVAR leather description",
     "tags": ["clothes", "gloves"],
     "offers": [
     ]

tests/Data/fixtures/products.json

@@ -1,5 +1,7 @@
 <?php
 
+use Ensi\LaravelElasticQuery\Contracts\MatchOptions;
+use Ensi\LaravelElasticQuery\Contracts\MultiMatchOptions;
 use Ensi\LaravelElasticQuerySpecification\Exceptions\InvalidQueryException;
 use Ensi\LaravelElasticQuerySpecification\Filtering\AllowedFilter;
 use Ensi\LaravelElasticQuerySpecification\Specification\CompositeSpecification;
@@ -79,14 +81,46 @@
     'between' => [['rating__lte' => 7, 'rating__gte' => 5], [1, 328]],
 ]);
 
-test('match filter', function (string $query, array $expectedIds) {
+test('match filter', function (string $query, ?MatchOptions $options, array $expectedIds) {
     $spec = CompositeSpecification::new()
         ->allowedFilters([
-            AllowedFilter::match('name', 'search_name'),
+            AllowedFilter::match('name', 'search_name', $options),
         ]);
 
     searchQuery($spec, ['filter' => ['name' => $query]])->assertDocumentIds($expectedIds);
 })->with([
-    'single' => ['water', [150]],
-    'multiple' => ['gloves', [319, 471]],
+    'single result' => ['water', null, [150]],
+    'multiple results' => ['gloves', null, [319, 471]],
+    'with options' => ['woter', MatchOptions::make(fuzziness: 'AUTO'), [150]],
 ]);
+
+test('multi match filter', function (string $query, ?MultiMatchOptions $options, array $expectedIds) {
+    $spec = CompositeSpecification::new()
+        ->allowedFilters([
+            AllowedFilter::multiMatch('name', ['search_name', 'description'], $options),
+        ]);
+
+    searchQuery($spec, ['filter' => ['name' => $query]])->assertDocumentIds($expectedIds);
+})->with([
+    'single result' => ['water', null, [150]],
+    'multiple results' => ['gloves', null, [319, 471]],
+    'with options' => ['woter', MultiMatchOptions::make(fuzziness: 'AUTO'), [150]],
+]);
+
+test('multi match filter priority', function () {
+    $spec = CompositeSpecification::new()
+        ->allowedFilters([
+            AllowedFilter::multiMatch('name', ['search_name^3', 'description']),
+        ]);
+
+    searchQuery($spec, ['filter' => ['name' => 'leather']])->assertDocumentOrder([319, 471]);
+});
+
+test('multi match filter without fields', function () {
+    $spec = CompositeSpecification::new()
+        ->allowedFilters([
+            AllowedFilter::multiMatch('name'),
+        ]);
+
+    searchQuery($spec, ['filter' => ['name' => 'leather']])->assertDocumentOrder([319, 471]);
+});