Merge branch '2.x' into 337-rethink-index-queue-services-with-workers

mcop1 · web-flow · commit f0ca860721b8 · 2025-09-22T14:41:56.000+02:00
diff --git a/doc/01_Installation/02_Upgrade.md b/doc/01_Installation/02_Upgrade.md
@@ -4,6 +4,7 @@ Following steps are necessary during updating to newer versions.
 
 ## Upgrade to 2.2.0
 - [Indexing] Added `id` column as new primary key to `generic_data_index_queue`. Please make sure to execute migrations.
+- [Searching] Added `trackTotalHits` parameter to `DefaultSearchService` and `SearchExecutionService`. The default value is true,       which means that total hits will always be computed accurately, even if they exceed the search engines threshold for accurate hit calculation. Change this parameter to `null`, to use the default threshold, pass an integer value to set a specific one.
 
 ## Upgrade to 2.1.0
 - Added support for Symfony 7
diff --git a/src/Model/DefaultSearch/Query/DateFilter.php b/src/Model/DefaultSearch/Query/DateFilter.php
@@ -98,24 +98,19 @@ public function isEmpty(): bool
 
     public function getParams(): array
     {
-        $params = [
-            'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-        ];
+        $params = ['format' => "yyyy-MM-dd'T'HH:mm:ssz"];
+
         if ($this->onDate) {
             $params['gte'] = $this->getStartOfDay($this->onDate)->format(DateTimeInterface::ATOM);
             $params['lte'] =  $this->getEndOfDay($this->onDate)->format(DateTimeInterface::ATOM);
-        } else {
-            if ($this->startDate) {
-                $params['gte'] = $this->getStartOfDay($this->startDate)->format(DateTimeInterface::ATOM);
-            }
-            if ($this->endDate) {
-                $params['lte'] = $this->getEndOfDay($this->endDate)->format(DateTimeInterface::ATOM);
-            }
+
+            return [$this->field => $params];
         }
 
-        return [
-            $this->field => $params,
-        ];
+        $params = $this->addStartParams($params);
+        $params = $this->addEndParams($params);
+
+        return [$this->field => $params];
     }
 
     public function toArray(bool $withType = false): array
@@ -162,6 +157,40 @@ public function getOnDate(): Carbon
         return $this->onDate;
     }
 
+    private function addStartParams(array $params): array
+    {
+        if (!$this->startDate) {
+            return $params;
+        }
+
+        if ($this->endDate) {
+            $params['gte'] = $this->getStartOfDay($this->startDate)->format(DateTimeInterface::ATOM);
+
+            return $params;
+        }
+
+        $params['gte'] = $this->getEndOfDay($this->startDate)->format(DateTimeInterface::ATOM);
+
+        return $params;
+    }
+
+    private function addEndParams(array $params): array
+    {
+        if (!$this->endDate) {
+            return $params;
+        }
+
+        if ($this->startDate) {
+            $params['lte'] = $this->getEndOfDay($this->endDate)->format(DateTimeInterface::ATOM);
+
+            return $params;
+        }
+
+        $params['lte'] = $this->getStartOfDay($this->endDate)->format(DateTimeInterface::ATOM);
+
+        return $params;
+    }
+
     private function getStartOfDay(Carbon $date): Carbon
     {
         if (!$this->roundToDay) {
diff --git a/src/SearchIndexAdapter/DefaultSearch/DefaultSearchService.php b/src/SearchIndexAdapter/DefaultSearch/DefaultSearchService.php
@@ -244,9 +244,17 @@ public function createPaginatedSearch(
     /**
      * @throws SearchFailedException
      */
-    public function search(AdapterSearchInterface $search, string $indexName): SearchResult
-    {
-        return $this->searchExecutionService->executeSearch($search, $indexName);
+    public function search(
+        AdapterSearchInterface $search,
+        string $indexName,
+        int|bool|null $trackTotalHits = true
+    ): SearchResult {
+        return $this->searchExecutionService->executeSearch(
+            $search,
+            $indexName,
+            $trackTotalHits
+
+        );
     }
 
     /**
diff --git a/src/SearchIndexAdapter/DefaultSearch/Search/SearchExecutionService.php b/src/SearchIndexAdapter/DefaultSearch/Search/SearchExecutionService.php
@@ -42,21 +42,29 @@ public function __construct(
     /**
      * @throws SearchFailedException
      */
-    public function executeSearch(AdapterSearchInterface $search, string $indexName): SearchResult
-    {
+    public function executeSearch(
+        AdapterSearchInterface $search,
+        string $indexName,
+        int|bool|null $trackTotalHits = true
+    ): SearchResult {
         try {
             $stopWatch = new Stopwatch();
             $stopWatch->start('search');
 
+            $searchParams = [
+                'index' => $indexName,
+                'body' => $search->toArray(),
+            ];
+
+            if ($trackTotalHits !== null) {
+                $searchParams['body']['track_total_hits'] = $trackTotalHits;
+            }
+
             $defaultSearchResult = $this
                 ->client
-                ->search([
-                    'index' => $indexName,
-                    'body' => $search->toArray(),
-                ]);
+                ->search($searchParams);
 
             $executionTime = $stopWatch->stop('search')->getDuration();
-
         } catch (Exception $e) {
             $searchInformation = new SearchInformation(
                 $search,
diff --git a/src/SearchIndexAdapter/DefaultSearch/Search/SearchExecutionServiceInterface.php b/src/SearchIndexAdapter/DefaultSearch/Search/SearchExecutionServiceInterface.php
@@ -24,9 +24,16 @@
 interface SearchExecutionServiceInterface
 {
     /**
+     * Execute a search query.
+     * Set $trackTotalHits = true to enable accurate hit counts, an integer to set a maximum count or leave it at null to use the engines default value.
+     *
      * @throws SearchFailedException
      */
-    public function executeSearch(AdapterSearchInterface $search, string $indexName): SearchResult;
+    public function executeSearch(
+        AdapterSearchInterface $search,
+        string $indexName,
+        int|bool|null $trackTotalHits = true
+    ): SearchResult;
 
     /**
      * @return SearchInformation[]
diff --git a/src/SearchIndexAdapter/SearchIndexServiceInterface.php b/src/SearchIndexAdapter/SearchIndexServiceInterface.php
@@ -56,7 +56,15 @@ public function createPaginatedSearch(
         bool $aggregationsOnly = false
     ): DefaultSearchInterface;
 
-    public function search(AdapterSearchInterface $search, string $indexName): SearchResult;
+    /**
+     * Execute a search query.
+     * Set $trackTotalHits = true to enable accurate hit counts, an integer to set a maximum count or leave it at null to use the engines default value.
+     */
+    public function search(
+        AdapterSearchInterface $search,
+        string $indexName,
+        int|bool|null $trackTotalHits = true
+    ): SearchResult;
 
     public function getStats(string $indexName): array;
 
diff --git a/tests/Unit/Model/DefaultSearch/Query/DateFilterTest.php b/tests/Unit/Model/DefaultSearch/Query/DateFilterTest.php
@@ -55,7 +55,7 @@ public function testToArray(): void
             'range' => [
                 'datefield' => [
                     'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                    'gte' => '2000-01-01T00:00:00+00:00',
+                    'gte' => '2000-01-01T23:59:59+00:00',
                 ],
             ],
         ], $dateFilter->toArray(true));
@@ -66,7 +66,7 @@ public function testToArray(): void
             'range' => [
                 'datefield' => [
                     'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                    'lte' => '2000-01-01T23:59:59+00:00',
+                    'lte' => '2000-01-01T00:00:00+00:00',
                 ],
             ],
         ], $dateFilter->toArray(true));
@@ -108,7 +108,7 @@ public function testGetParams(): void
         self::assertSame([
             'datefield' => [
                 'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                'gte' => '2000-01-01T00:00:00+00:00',
+                'gte' => '2000-01-01T23:59:59+00:00',
             ],
         ], $dateFilter->getParams());
 
@@ -117,7 +117,7 @@ public function testGetParams(): void
         self::assertSame([
             'datefield' => [
                 'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                'lte' => '2000-01-01T23:59:59+00:00',
+                'lte' => '2000-01-01T00:00:00+00:00',
             ],
         ], $dateFilter->getParams());
 
diff --git a/tests/Unit/SearchIndexAdapter/Asset/FieldDefinitionAdapter/DateAdapterTest.php b/tests/Unit/SearchIndexAdapter/Asset/FieldDefinitionAdapter/DateAdapterTest.php
@@ -123,7 +123,7 @@ public function testApplySearchFilter()
                 'range' => [
                     'standard_fields.test.en' => [
                         'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                        'gte' => '2000-01-01T00:00:00+00:00',
+                        'gte' => '2000-01-01T23:59:59+00:00',
                     ],
                 ],
             ],
@@ -138,7 +138,7 @@ public function testApplySearchFilter()
                 'range' => [
                     'standard_fields.test.en' => [
                         'format' => "yyyy-MM-dd'T'HH:mm:ssz",
-                        'lte' => '2000-01-01T23:59:59+00:00',
+                        'lte' => '2000-01-01T00:00:00+00:00',
                     ],
                 ],
             ],
