Merge pull request #35 from ensi-platform/task-111039_v7

#111039 add collapse search results

Author: MsNatali

src/Contracts/CollapsibleQuery.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Contracts;
+
+interface CollapsibleQuery extends BoolQuery
+{
+    public function collapse(string $field): static;
+}

src/Search/Collapsing/Collapse.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Search\Collapsing;
+
+use Ensi\LaravelElasticQuery\Contracts\DSLAware;
+use Webmozart\Assert\Assert;
+
+class Collapse implements DSLAware
+{
+    public function __construct(private string $field)
+    {
+        Assert::stringNotEmpty(trim($field));
+    }
+
+    public function field(): string
+    {
+        return $this->field;
+    }
+
+    public function toDSL(): array
+    {
+        return ['field' => $this->field];
+    }
+}

src/Search/SearchQuery.php

@@ -5,23 +5,26 @@
 use Closure;
 use Ensi\LaravelElasticQuery\Concerns\DecoratesBoolQuery;
 use Ensi\LaravelElasticQuery\Concerns\ExtendsSort;
+use Ensi\LaravelElasticQuery\Contracts\CollapsibleQuery;
 use Ensi\LaravelElasticQuery\Contracts\SearchIndex;
 use Ensi\LaravelElasticQuery\Contracts\SortableQuery;
 use Ensi\LaravelElasticQuery\Contracts\SortOrder;
 use Ensi\LaravelElasticQuery\Filtering\BoolQueryBuilder;
+use Ensi\LaravelElasticQuery\Search\Collapsing\Collapse;
 use Ensi\LaravelElasticQuery\Search\Sorting\SortBuilder;
 use Ensi\LaravelElasticQuery\Search\Sorting\SortCollection;
 use Illuminate\Support\Collection;
 use InvalidArgumentException;
 use Webmozart\Assert\Assert;
 
-class SearchQuery implements SortableQuery
+class SearchQuery implements SortableQuery, CollapsibleQuery
 {
     use DecoratesBoolQuery;
     use ExtendsSort;
 
     protected BoolQueryBuilder $boolQuery;
     protected SortCollection $sorts;
+    protected ?Collapse $collapse = null;
     protected ?int $size = null;
     protected ?int $from = null;
     protected array $fields = [];
@@ -126,6 +129,10 @@ protected function execute(
             $dsl['sort'] = $sorts->toDSL();
         }
 
+        if (!is_null($this->collapse)) {
+            $dsl['collapse'] = $this->collapse->toDSL();
+        }
+
         if ($cursor !== null && !$cursor->isBOF()) {
             $dsl['search_after'] = $cursor->toDSL();
         }
@@ -156,6 +163,13 @@ public function sortByNested(string $field, Closure $callback): static
         return $this;
     }
 
+    public function collapse(string $field): static
+    {
+        $this->collapse = new Collapse($field);
+
+        return $this;
+    }
+
     public function take(int $count): static
     {
         Assert::greaterThanEq($count, 0);

tests/Functional/Search/SearchQueryTest.php

@@ -68,4 +68,14 @@ public function testSortByNested(): void
     }
 
     //endregion
+
+    //region Collapsing
+    public function testCollapse(): void
+    {
+        $results = $this->testing->collapse('vat')->get();
+
+        $this->assertCount(2, $results);
+    }
+
+    //endregion
 }

tests/Seeds/ProductIndexSeeder.php

@@ -48,6 +48,7 @@ class ProductIndexSeeder extends IndexSeeder
             'tags' => ['type' => 'keyword'],
             'rating' => ['type' => 'integer'],
             'package' => ['type' => 'keyword'],
+            'vat' => ['type' => 'integer'],
 
             'offers' => [
                 'type' => 'nested',

tests/Seeds/fixtures/products_default.json

@@ -8,6 +8,7 @@
     "package": null,
     "description": "TV station description",
     "tags": ["video"],
+    "vat": 18,
     "offers": [
       {"seller_id": 10, "active": true, "price": 20000.0},
       {"seller_id": 15, "active": true, "price": 21000.0},
@@ -23,6 +24,7 @@
     "package": "bottle",
     "description": "TASSAY description water",
     "tags": ["drinks", "watter"],
+    "vat": 20,
     "offers": [
       {"seller_id": 10, "active": false, "price": 168.0},
       {"seller_id": 15, "active": true, "price": 210.0},
@@ -37,6 +39,7 @@
     "rating": 0,
     "description": "L gloves descriptions",
     "tags": ["clothes", "gloves"],
+    "vat": 20,
     "offers": [
       {"seller_id": 10, "active": false, "price": 980.0},
       {"seller_id": 15, "active": false, "price": 980.0},
@@ -52,6 +55,7 @@
     "package": null,
     "description": "Nice tv",
     "tags": ["video"],
+    "vat": 18,
     "offers": [
       {"seller_id": 90, "active": true, "price": 41999.0},
       {"seller_id": 20, "active": true, "price": 28990.0}
@@ -66,6 +70,7 @@
     "package": "bottle",
     "description": "S.Pellegrino from Dolomites. Pure water.",
     "tags": ["drinks", "water"],
+    "vat": 20,
     "offers": [
       {"seller_id": 10, "active": false, "price": 611.0},
       {"seller_id": 15, "active": false, "price": 620.0}
@@ -79,6 +84,7 @@
     "rating": 3,
     "description": "VITTOVAR description",
     "tags": ["clothes", "gloves"],
+    "vat": 18,
     "offers": [
     ]
   }

tests/Unit/Search/Collapsing/CollapseTest.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Tests\Unit\Search\Sorting;
+
+use Ensi\LaravelElasticQuery\Search\Collapsing\Collapse;
+use Ensi\LaravelElasticQuery\Tests\Unit\UnitTestCase;
+
+class CollapseTest extends UnitTestCase
+{
+    public function testFieldOnly(): void
+    {
+        $this->assertEquals(['field' => 'product_id'], (new Collapse('product_id'))->toDSL());
+    }
+}