Merge branch '5.x' into pr/79

Author: pdphilip

src/Connection.php

@@ -123,6 +123,7 @@ private function sanitizeConfig(): void
                     'cert_password' => null,
                 ],
                 'options' => [
+                    'track_total_hits' => null, // null -> skips - max 10k by default; true -> full values; false -> no hit tracking, returns -1; int -> max hit tracking val, ex 20000
                     'bypass_map_validation' => false, // This skips the safety checks for Elastic Specific queries.
                     'logging' => false,
                     'ssl_verification' => true,
@@ -162,6 +163,8 @@ public function setOptions(): void
     {
         $this->allowIdSort = $this->config['options']['allow_id_sort'] ?? false;
 
+        $this->options()->add('track_total_hits', $this->config['options']['track_total_hits'] ?? null);
+
         $this->options()->add('bypass_map_validation', $this->config['options']['bypass_map_validation'] ?? null);
 
         if (isset($this->config['options']['ssl_verification'])) {

src/Query/Builder.php

@@ -13,6 +13,8 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Database\Query\Builder as BaseBuilder;
 use Illuminate\Database\Query\Expression;
+use Illuminate\Database\Query\Grammars\Grammar;
+use Illuminate\Database\Query\Processors\Processor;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
@@ -108,6 +110,12 @@ class Builder extends BaseBuilder
 
     protected ?MetaDTO $metaTransfer = null;
 
+    public function __construct(...$args)
+    {
+        parent::__construct(...$args);
+        $this->applyConnectionOptions();
+    }
+
     public function __call($method, $parameters)
     {
         if (Str::startsWith($method, 'filterWhere')) {
@@ -117,7 +125,7 @@ public function __call($method, $parameters)
         return parent::__call($method, $parameters);
     }
 
-    public function toDsl(): array
+    public function toDsl(): array|string
     {
         $this->applyBeforeQueryCallbacks();
 
@@ -129,6 +137,14 @@ public function toSql(): array|string
         return $this->toDsl();
     }
 
+    private function applyConnectionOptions()
+    {
+        $trackTotalHits = $this->connection->options()->get('track_total_hits');
+        if ($trackTotalHits !== null) {
+            $this->bodyParameters['track_total_hits'] = $trackTotalHits;
+        }
+    }
+
     // ======================================================================
     // Inherited Methods
     // ======================================================================
@@ -2414,6 +2430,23 @@ public function withAnalyzer(string $analyzer): self
         return $this;
     }
 
+    public function withTrackTotalHits(bool|int|null $val = true): self
+    {
+        if ($val === null) {
+            return $this->withoutTrackTotalHits();
+        }
+        $this->bodyParameters['track_total_hits'] = $val;
+
+        return $this;
+    }
+
+    public function withoutTrackTotalHits(): self
+    {
+        unset($this->bodyParameters['track_total_hits']);
+
+        return $this;
+    }
+
     // ----------------------------------------------------------------------
     // Internal Operations
     // ----------------------------------------------------------------------

tests/LargeRecordsTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+use PDPhilip\Elasticsearch\Tests\Models\Product;
+
+beforeEach(function () {
+    Product::executeSchema();
+
+});
+
+it('tests track total hits', function () {
+
+    Product::buildRecords(11_000);
+
+    class ProductWithDefaultTrackTotalHits extends Product
+    {
+        protected $connection = 'elasticsearch_with_default_track_total_hits';
+    }
+
+    $products = Product::limit(1)->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(10000);
+
+    $products = Product::limit(1)->withTrackTotalHits()->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(11000);
+
+    $products = Product::limit(1)->withTrackTotalHits(false)->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(-1);
+
+    $products = Product::limit(1)->withTrackTotalHits(300)->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(300);
+
+    $products = ProductWithDefaultTrackTotalHits::limit(1)->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(11000);
+
+    $products = ProductWithDefaultTrackTotalHits::limit(1)->withoutTrackTotalHits()->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(10000);
+
+    $products = ProductWithDefaultTrackTotalHits::limit(1)->withTrackTotalHits(300)->get();
+    expect($products->getQueryMeta()->getTotalHits())->toBe(300);
+
+});

tests/Models/Product.php

@@ -29,4 +29,17 @@ public static function executeSchema()
             $table->date('updated_at');
         });
     }
+
+    public static function buildRecords($limit = 100)
+    {
+        $records = [];
+        while ($limit) {
+            $records[] = [
+                'state' => rand(1, 100),
+            ];
+            $limit--;
+        }
+        Product::insert($records);
+        //        Product::withoutRefresh()->insert($records);
+    }
 }

tests/TestCase.php

@@ -56,5 +56,15 @@ protected function getEnvironmentSetUp($app): void
                 'logging' => true,
             ],
         ]);
+
+        $app['config']->set('database.connections.elasticsearch_with_default_track_total_hits', [
+            'driver' => 'elasticsearch',
+            'auth_type' => 'http',
+            'hosts' => ['http://localhost:9200'],
+            'options' => [
+                'track_total_hits' => true,
+                'logging' => true,
+            ],
+        ]);
     }
 }