Add terminate_after support

Author: babenkoivan

composer.json

@@ -39,7 +39,8 @@
     },
     "require": {
         "php": "^7.4 || ^8.0",
-        "babenkoivan/elastic-scout-driver": "^3.1"
+        "babenkoivan/elastic-scout-driver": "^3.1",
+        "babenkoivan/elastic-adapter": "^3.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

docs/available-methods.md

@@ -20,6 +20,7 @@
 * [sort](#sort)
 * [source](#source)
 * [suggest](#suggest)
+* [terminateAfter](#terminateafter)
 * [trackScores](#trackscores)
 * [trackTotalHits](#tracktotalhits)
 * [unless](#unless)
@@ -473,6 +474,16 @@ $models = $firstSuggestion->models();
 $raw = $firstSuggestion->raw();
 ```
 
+### terminateAfter
+
+This method allows you to set the maximum number of documents to collect for each shard:
+
+```php
+$searchResult = Book::searchQuery($query)
+    ->terminateAfter(10)
+    ->execute();
+```
+
 ### trackScores
 
 This method forces [scores to be computed and tracked](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_track_scores):

src/Builders/SearchParametersBuilder.php

@@ -59,6 +59,7 @@ class SearchParametersBuilder
     private ?array $searchAfter;
     private ?array $routing;
     private ?bool $explain;
+    private ?int $terminateAfter;
 
     public function __construct(Model $model)
     {
@@ -305,6 +306,12 @@ public function explain(bool $explain): self
         return $this;
     }
 
+    public function terminateAfter(int $terminateAfter): self
+    {
+        $this->terminateAfter = $terminateAfter;
+        return $this;
+    }
+
     public function buildSearchParameters(): SearchParameters
     {
         $searchParameters = new SearchParameters();
@@ -395,6 +402,10 @@ public function buildSearchParameters(): SearchParameters
             $searchParameters->explain($this->explain);
         }
 
+        if (isset($this->terminateAfter)) {
+            $searchParameters->terminateAfter($this->terminateAfter);
+        }
+
         return $searchParameters;
     }
 

tests/Integration/Builders/SearchParametersBuilderTest.php

@@ -622,4 +622,17 @@ public function test_search_parameters_with_explain_can_be_built(): void
 
         $this->assertEquals($expected, $actual);
     }
+
+    public function test_search_parameters_with_terminate_after_can_be_built(): void
+    {
+        $expected = (new SearchParameters())
+            ->indices([(new Book())->searchableAs()])
+            ->terminateAfter(10);
+
+        $actual = (new SearchParametersBuilder(new Book()))
+            ->terminateAfter(10)
+            ->buildSearchParameters();
+
+        $this->assertEquals($expected, $actual);
+    }
 }

tests/Integration/Queries/RawQueryTest.php

@@ -628,4 +628,15 @@ public function test_query_can_be_explained(): void
 
         $this->assertGreaterThan(0, $found->hits()->first()->explanation()->value());
     }
+
+    public function test_query_can_be_terminated(): void
+    {
+        factory(Book::class, 10)->create([
+            'author_id' => factory(Author::class)->create(),
+        ]);
+
+        $found = Book::searchQuery()->terminateAfter(1)->execute();
+
+        $this->assertCount(1, $found);
+    }
 }