Merge pull request #101 from QwertyRomanRus/idbpr-3454-v8

idbpr-3454 add sort by script in aggregation

Author: MsNatali

src/Aggregating/Metrics/ScriptAggregation.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Aggregating\Metrics;
+
+use Ensi\LaravelElasticQuery\Aggregating\Result;
+use Ensi\LaravelElasticQuery\Contracts\Aggregation;
+use Ensi\LaravelElasticQuery\Contracts\ScriptLang;
+use Webmozart\Assert\Assert;
+
+class ScriptAggregation implements Aggregation
+{
+    public function __construct(
+        private readonly string $name,
+        private readonly string $aggregationType,
+        private readonly string $source,
+        private readonly array  $params = [],
+        private readonly string $lang = ScriptLang::PAINLESS,
+    ) {
+        Assert::stringNotEmpty(trim($name));
+        Assert::stringNotEmpty(trim($aggregationType));
+        Assert::stringNotEmpty(trim($source));
+        Assert::oneOf($lang, ScriptLang::cases());
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function parseResults(array $response): array
+    {
+        return [$this->name => Result::parseValue($response[$this->name]) ?? 0];
+    }
+
+    public function toDSL(): array
+    {
+        $script = [
+            'source' => $this->source,
+            'lang' => $this->lang,
+        ];
+
+        if (!empty($this->params)) {
+            $script['params'] = $this->params;
+        }
+
+        return [
+            $this->name => [
+                $this->aggregationType => [
+                    'script' => $script,
+                ],
+            ],
+        ];
+    }
+}

src/Concerns/ConstructsAggregations.php

@@ -15,9 +15,11 @@
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinMaxAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\RangesAggregation;
+use Ensi\LaravelElasticQuery\Aggregating\Metrics\ScriptAggregation;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\ValueCountAggregation;
 use Ensi\LaravelElasticQuery\Contracts\Aggregation;
 use Ensi\LaravelElasticQuery\Contracts\Criteria;
+use Ensi\LaravelElasticQuery\Contracts\ScriptLang;
 use Ensi\LaravelElasticQuery\Filtering\BoolQueryBuilder;
 use Ensi\LaravelElasticQuery\Search\Sorting\Sort;
 use Ensi\LaravelElasticQuery\Search\Sorting\SortCollection;
@@ -81,6 +83,18 @@ public function max(string $name, string $field, mixed $missing = null): static
         return $this;
     }
 
+    public function script(
+        string $name,
+        string $aggregationType,
+        string $source,
+        array $params = [],
+        string $lang = ScriptLang::PAINLESS
+    ): static {
+        $this->aggregations->add(new ScriptAggregation($name, $aggregationType, $source, $params, $lang));
+
+        return $this;
+    }
+
     public function count(string $name, string $field): static
     {
         $this->aggregations->add(new ValueCountAggregation($name, $this->absolutePath($field)));

src/Contracts/AggregationsBuilder.php

@@ -25,5 +25,7 @@ public function max(string $name, string $field, mixed $missing = null): static;
 
     public function count(string $path, string $field): static;
 
+    public function script(string $name, string $aggregationType, string $source, array $params = [], string $lang = ScriptLang::PAINLESS): static;
+
     public function nested(string $path, Closure $callback): static;
 }

tests/IntegrationTests/AggregationQueryIntegrationTest.php

@@ -1,15 +1,18 @@
 <?php
 
+use Ensi\LaravelElasticQuery\Aggregating\AggregationCollection;
 use Ensi\LaravelElasticQuery\Aggregating\Bucket;
 use Ensi\LaravelElasticQuery\Aggregating\FiltersCollection;
 use Ensi\LaravelElasticQuery\Aggregating\Metrics\MinMaxScoreAggregation;
+use Ensi\LaravelElasticQuery\Aggregating\Metrics\ScriptAggregation;
 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;
 use Ensi\LaravelElasticQuery\Search\Sorting\Sort;
+use Ensi\LaravelElasticQuery\Search\Sorting\SortCollection;
 use Ensi\LaravelElasticQuery\Tests\Data\Models\ProductsIndex;
 use Ensi\LaravelElasticQuery\Tests\IntegrationTestCase;
 
@@ -210,3 +213,52 @@
         );
     }
 })->with([null, 'default_bucket']);
+
+test('aggregation query by script', function () {
+    /** @var IntegrationTestCase $this */
+    $fieldName = 'max_tag_by_script';
+
+    $sort = new SortCollection();
+    $sort->add(new Sort($fieldName));
+
+    $termAggregation = new AggregationCollection();
+    $termAggregation->add(new ScriptAggregation(
+        name: $fieldName,
+        aggregationType: 'max',
+        params: ['tag' => 'video'],
+        source: '
+          if (doc.containsKey("tags") 
+            && doc["tags"].size() > 0
+            && doc["tags"].contains(params.tag)
+            ) {
+                return 0;
+            }
+          return 1;
+        ',
+    ));
+
+    $results = ProductsIndex::aggregate()
+        ->terms(
+            name: 'group_by',
+            field: 'product_id',
+            size: 3,
+            sort: $sort,
+            composite: $termAggregation
+        )
+        ->get()
+        ->get('group_by');
+
+    $scores = $results->map(
+        fn (Bucket $bucket) => $bucket->getCompositeValue($fieldName)
+    )->toArray();
+
+    assertEqualsCanonicalizing(
+        [1, 328, 150],
+        $results->pluck('key')->toArray(),
+    );
+
+    assertEqualsCanonicalizing(
+        [0.0, 0.0, 1.0],
+        $scores,
+    );
+});