Merge pull request #100 from ensi-platform/v7-ecs-1350

V7. Post Filter, Ranges Aggregation, Between Filter

Author: DimionX

src/Aggregating/Metrics/RangesAggregation.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Aggregating\Metrics;
+
+use Ensi\LaravelElasticQuery\Aggregating\Range;
+use Ensi\LaravelElasticQuery\Aggregating\Result;
+use Ensi\LaravelElasticQuery\Contracts\Aggregation;
+use Webmozart\Assert\Assert;
+
+class RangesAggregation implements Aggregation
+{
+    /**
+     * @param string $name
+     * @param string $field
+     * @param Range[] $ranges
+     */
+    public function __construct(protected string $name, protected string $field, protected array $ranges)
+    {
+        Assert::stringNotEmpty(trim($name));
+        Assert::stringNotEmpty(trim($field));
+        Assert::allIsInstanceOf($ranges, Range::class);
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function add(Range $range): self
+    {
+        $this->ranges[] = $range;
+
+        return $this;
+    }
+
+    public function toDSL(): array
+    {
+        if (empty($this->ranges)) {
+            return [];
+        }
+
+        return [
+            $this->name => [
+                "range" => [
+                    "field" => $this->field,
+                    "ranges" => array_map(fn (Range $range) => $range->toDSL(), $this->ranges),
+                ],
+            ],
+        ];
+    }
+
+    public function parseResults(array $response): array
+    {
+        return array_map(
+            callback: fn (array $bucket) => Result::parseBucket($bucket),
+            array: $response[$this->name]['buckets'] ?? []
+        );
+    }
+}

src/Aggregating/Range.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Aggregating;
+
+class Range
+{
+    public function __construct(
+        public int|float|null $from = null,
+        public int|float|null $to = null,
+        public ?string $key = null
+    ) {
+    }
+
+    public function toDSL(): array
+    {
+        return array_filter(["from" => $this->from, "to" => $this->to, "key" => $this->key]);
+    }
+}

src/Concerns/ConstructsAggregations.php

@@ -14,6 +14,7 @@
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MaxAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinMaxAggregation;
+use Ensi\LaravelElasticQuery\Aggregating\Metrics\RangesAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\ValueCountAggregation;
 use Ensi\LaravelElasticQuery\Contracts\Aggregation;
 use Ensi\LaravelElasticQuery\Contracts\Criteria;
@@ -87,6 +88,13 @@ public function count(string $name, string $field): static
         return $this;
     }
 
+    public function ranges(string $name, string $field, array $ranges): static
+    {
+        $this->aggregations->add(new RangesAggregation($name, $this->absolutePath($field), $ranges));
+
+        return $this;
+    }
+
     public function cardinality(string $name, string $field): static
     {
         $this->aggregations->add(new CardinalityAggregation($name, $this->absolutePath($field)));

src/Concerns/DecoratesBoolQuery.php

@@ -154,6 +154,13 @@ public function whereMoreLikeThis(array $fields, MoreLikeThis $likeThis, ?MoreLi
         return $this;
     }
 
+    public function whereBetween(string $field, mixed $from, mixed $to): static
+    {
+        $this->forwardCallTo($this->boolQuery(), __FUNCTION__, func_get_args());
+
+        return $this;
+    }
+
     /**
      * @param array<FunctionScoreItem> $functions
      * @param ?DSLAware $query

src/Contracts/AggregationsBuilder.php

@@ -3,13 +3,22 @@
 namespace Ensi\LaravelElasticQuery\Contracts;
 
 use Closure;
+use Ensi\LaravelElasticQuery\Aggregating\Range;
 
 interface AggregationsBuilder extends BoolQuery
 {
     public function terms(string $name, string $field, ?int $size = null): static;
 
     public function minmax(string $name, string $field): static;
 
+    /**
+     * @param string $name
+     * @param string $field
+     * @param Range[] $ranges
+     * @return $this
+     */
+    public function ranges(string $name, string $field, array $ranges): static;
+
     public function min(string $name, string $field, mixed $missing = null): static;
 
     public function max(string $name, string $field, mixed $missing = null): static;

src/Contracts/BoolQuery.php

@@ -45,6 +45,8 @@ public function addMustBool(callable $fn): static;
 
     public function whereMoreLikeThis(array $fields, MoreLikeThis $likeThis, ?MoreLikeOptions $options = null): static;
 
+    public function whereBetween(string $field, mixed $from, mixed $to): static;
+
     /**
      * @param array<FunctionScoreItem> $functions
      * @param ?DSLAware $query

src/Filtering/BoolQueryBuilder.php

@@ -14,6 +14,7 @@
 use Ensi\LaravelElasticQuery\Contracts\MoreLikeThis;
 use Ensi\LaravelElasticQuery\Contracts\MultiMatchOptions;
 use Ensi\LaravelElasticQuery\Contracts\WildcardOptions;
+use Ensi\LaravelElasticQuery\Filtering\Criterias\Between;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Exists;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\FunctionScore;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\MoreLike;
@@ -259,6 +260,13 @@ public function whereMoreLikeThis(array $fields, MoreLikeThis $likeThis, ?MoreLi
         return $this;
     }
 
+    public function whereBetween(string $field, mixed $from, mixed $to): static
+    {
+        $this->filter->add(new Between($this->absolutePath($field), $from, $to));
+
+        return $this;
+    }
+
     /**
      * @param array<FunctionScoreItem> $functions
      * @param ?DSLAware $query

src/Filtering/Criterias/Between.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Filtering\Criterias;
+
+use Ensi\LaravelElasticQuery\Contracts\Criteria;
+use Webmozart\Assert\Assert;
+
+class Between implements Criteria
+{
+    public function __construct(private string $field, private mixed $from, private mixed $to)
+    {
+        Assert::stringNotEmpty(trim($field));
+    }
+
+    public function toDSL(): array
+    {
+        return ['range' => [$this->field => ['gte' => $this->from, 'lte' => $this->to]]];
+    }
+}

src/Search/SearchQuery.php

@@ -30,6 +30,7 @@ class SearchQuery implements SortableQuery, CollapsibleQuery, HighlightingQuery
     use ExtendsSort;
 
     protected BoolQueryBuilder $boolQuery;
+    protected ?BoolQueryBuilder $postFilter = null;
     protected SortCollection $sorts;
     protected ?Collapse $collapse = null;
     protected ?Highlight $highlight = null;
@@ -171,6 +172,10 @@ protected function execute(
             $dsl['highlight'] = $this->highlight->toDSL();
         }
 
+        if (!is_null($this->postFilter)) {
+            $dsl['post_filter'] = $this->postFilter->toDSL();
+        }
+
         if ($cursor !== null && !$cursor->isBOF()) {
             $dsl['search_after'] = $cursor->toDSL();
         }
@@ -235,6 +240,13 @@ public function highlight(Highlight $highlight): static
         return $this;
     }
 
+    public function setPostFilter(BoolQueryBuilder $boolQueryBuilder): static
+    {
+        $this->postFilter = $boolQueryBuilder;
+
+        return $this;
+    }
+
     public function addAggregations(Aggregation $aggregation): static
     {
         $this->aggregations ??= new AggregationCollection();

tests/IntegrationTests/AggregationQueryIntegrationTest.php

@@ -5,6 +5,7 @@
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinMaxScoreAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\TopHitsAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\MinMax;
+use Ensi\LaravelElasticQuery\Aggregating\Range;
 use Ensi\LaravelElasticQuery\Contracts\AggregationsBuilder;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\RangeBound;
 use Ensi\LaravelElasticQuery\Filtering\Criterias\Term;
@@ -103,6 +104,30 @@
     assertEquals(2, $results->get('cardinality'));
 });
 
+test('aggregation query ranges', function () {
+    /** @var IntegrationTestCase $this */
+
+    $rangeFromTo = new Range(from: 0, to: 5, key: 'from-0-to-5');
+    $rangeFrom = new Range(from: 7, key: 'from-7');
+    $rangeTo = new Range(to: 8, key: 'to-8');
+
+    $results = ProductsIndex::aggregate()
+        ->ranges('ranges', 'rating', [$rangeFromTo, $rangeFrom, $rangeTo])
+        ->get();
+
+    /** @var Bucket $result */
+    foreach ($results as $result) {
+        $expected = match ($result->key) {
+            'from-0-to-5' => 2,
+            'from-7' => 3,
+            'to-8' => 4,
+            default => null,
+        };
+
+        assertEquals($expected, $result->count);
+    }
+});
+
 test('aggregation query count all', function () {
     /** @var IntegrationTestCase $this */