[Search] Fix content Indices documents error on paginate (#219471)

saarikabhasi · saarikabhasi · commit 8fb543c7dea5 · 2025-04-29T15:12:43.000-04:00
Initially added fix in `8.17` branch in [PR](#219411), but need this change in `main`, `8.18`, `8.19` & `9.0.0` and the file's paths are different in all versions(main, 8.18/8.19, 8.17, 9.0.0). Created this new PR, adding fix in `main` & will try to backport to other versions. ## Summary When `track_total_hits` is not provided to `fetchSearchResults`, the value is set to `false`. As a result, the `search` api does not include total hit count in its response. Thus, the total count of hit is 0 and onPaginate results in error. This PR sets `track_total_hits` as an optional argument in `fetchSearchResults` **Note** One other option would be to set `track_total_hits` to true but, based on this [documentation](https://www.elastic.co/docs/solutions/search/the-search-api#track-total-hits) setting `track_total_hits` to true would affect query performance. ``` Setting track_total_hits to true will cause Elasticsearch to return exact hit counts, which could hurt query performance because it disables the [Max WAND](https://www.elastic.co/blog/faster-retrieval-of-top-hits-in-elasticsearch-with-block-max-wand) optimization. ```` https://github.com/user-attachments/assets/4284e88f-2614-4fbe-a0eb-1980355f5bff ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios (cherry picked from commit 69d7124)
diff --git a/packages/kbn-search-index-documents/lib/fetch_search_results.test.ts b/packages/kbn-search-index-documents/lib/fetch_search_results.test.ts
@@ -88,7 +88,7 @@ describe('fetchSearchResults lib function', () => {
       index: indexName,
       q: query,
       size: DEFAULT_DOCS_PER_PAGE,
-      track_total_hits: false,
+      track_total_hits: undefined,
     });
   });
 
@@ -110,7 +110,7 @@ describe('fetchSearchResults lib function', () => {
       index: indexName,
       q: '\\"yellow banana\\"',
       size: DEFAULT_DOCS_PER_PAGE,
-      track_total_hits: false,
+      track_total_hits: undefined,
     });
   });
 
@@ -125,7 +125,7 @@ describe('fetchSearchResults lib function', () => {
       from: DEFAULT_FROM_VALUE,
       index: indexName,
       size: DEFAULT_DOCS_PER_PAGE,
-      track_total_hits: false,
+      track_total_hits: undefined,
     });
   });
 
@@ -153,7 +153,7 @@ describe('fetchSearchResults lib function', () => {
       index: indexName,
       q: query,
       size: DEFAULT_DOCS_PER_PAGE,
-      track_total_hits: false,
+      track_total_hits: undefined,
     });
   });
 
diff --git a/packages/kbn-search-index-documents/lib/fetch_search_results.ts b/packages/kbn-search-index-documents/lib/fetch_search_results.ts
@@ -19,7 +19,7 @@ export const fetchSearchResults = async (
   query?: string,
   from: number = 0,
   size: number = DEFAULT_DOCS_PER_PAGE,
-  trackTotalHits: boolean = false
+  trackTotalHits?: boolean
 ): Promise<Paginate<SearchHit>> => {
   const result = await fetchWithPagination(
     async () =>
