[search source] remove is_partial check

examples/search_examples/public/search/app.tsx

@@ -29,7 +29,7 @@ import { IInspectorInfo } from '@kbn/data-plugin/common';
 import {
   DataPublicPluginStart,
   IKibanaSearchResponse,
-  isCompleteResponse,
+  isRunningResponse,
 } from '@kbn/data-plugin/public';
 import { SearchResponseWarning } from '@kbn/data-plugin/public/search/types';
 import type { DataView, DataViewField } from '@kbn/data-views-plugin/public';
@@ -209,7 +209,7 @@ export const SearchExamplesApp = ({
       })
       .subscribe({
         next: (res) => {
-          if (isCompleteResponse(res)) {
+          if (!isRunningResponse(res)) {
             setIsLoading(false);
             setResponse(res);
             const aggResult: number | undefined = res.rawResponse.aggregations
@@ -389,7 +389,7 @@ export const SearchExamplesApp = ({
       .subscribe({
         next: (res) => {
           setResponse(res);
-          if (isCompleteResponse(res)) {
+          if (!isRunningResponse(res)) {
             setIsLoading(false);
             notifications.toasts.addSuccess({
               title: 'Query result',

examples/search_examples/public/search_sessions/app.tsx

@@ -39,7 +39,7 @@ import {
   DataPublicPluginStart,
   IEsSearchRequest,
   IEsSearchResponse,
-  isCompleteResponse,
+  isRunningResponse,
   QueryState,
   SearchSessionState,
 } from '@kbn/data-plugin/public';
@@ -706,7 +706,7 @@ function doSearch(
   return lastValueFrom(
     data.search.search(req, { sessionId }).pipe(
       tap((res) => {
-        if (isCompleteResponse(res)) {
+        if (!isRunningResponse(res)) {
           const avgResult: number | undefined = res.rawResponse.aggregations
             ? // @ts-expect-error @elastic/elasticsearch no way to declare a type for aggregation in the search response
               res.rawResponse.aggregations[1]?.value ?? res.rawResponse.aggregations[2]?.value

examples/search_examples/public/sql_search/app.tsx

@@ -26,7 +26,7 @@ import { CoreStart } from '@kbn/core/public';
 import {
   DataPublicPluginStart,
   IKibanaSearchResponse,
-  isCompleteResponse,
+  isRunningResponse,
 } from '@kbn/data-plugin/public';
 import {
   SQL_SEARCH_STRATEGY,
@@ -66,7 +66,7 @@ export const SqlSearchExampleApp = ({ notifications, data }: SearchExamplesAppDe
       })
       .subscribe({
         next: (res) => {
-          if (isCompleteResponse(res)) {
+          if (!isRunningResponse(res)) {
             setIsLoading(false);
             setResponse(res);
           }

src/plugins/data/README.mdx

@@ -158,12 +158,12 @@ The `SearchSource` API is a convenient way to construct and run an Elasticsearch
 One benefit of using the low-level search API, is partial response support, allowing for a better and more responsive user experience.
 
 ```.ts
-    import { isCompleteResponse } from '../plugins/data/public';
+    import { isRunningResponse } from '../plugins/data/public';
 
     const search$ = data.search.search(request)
         .subscribe({
         next: (response) => {
-            if (isCompleteResponse(response)) {
+            if (!isRunningResponse(response)) {
                 // Final result
                 search$.unsubscribe();
             } else {

src/plugins/data/common/search/poll_search.test.ts

@@ -10,7 +10,7 @@ import { pollSearch } from './poll_search';
 import { AbortError } from '@kbn/kibana-utils-plugin/common';
 
 describe('pollSearch', () => {
-  function getMockedSearch$(resolveOnI = 1, finishWithError = false) {
+  function getMockedSearch$(resolveOnI = 1) {
     let counter = 0;
     return jest.fn().mockImplementation(() => {
       counter++;
@@ -19,7 +19,7 @@ describe('pollSearch', () => {
         if (lastCall) {
           resolve({
             isRunning: false,
-            isPartial: finishWithError,
+            isPartial: false,
             rawResponse: {},
           });
         } else {
@@ -57,15 +57,6 @@ describe('pollSearch', () => {
     expect(cancelFn).toBeCalledTimes(0);
   });
 
-  test('Throws Error on ES error response', async () => {
-    const searchFn = getMockedSearch$(2, true);
-    const cancelFn = jest.fn();
-    const poll = pollSearch(searchFn, cancelFn).toPromise();
-    await expect(poll).rejects.toThrow(Error);
-    expect(searchFn).toBeCalledTimes(2);
-    expect(cancelFn).toBeCalledTimes(0);
-  });
-
   test('Throws AbortError on empty response', async () => {
     const searchFn = jest.fn().mockResolvedValue(undefined);
     const cancelFn = jest.fn();

src/plugins/data/common/search/poll_search.ts

@@ -10,7 +10,7 @@ import { from, Observable, timer, defer, fromEvent, EMPTY } from 'rxjs';
 import { expand, map, switchMap, takeUntil, takeWhile, tap } from 'rxjs/operators';
 import { AbortError } from '@kbn/kibana-utils-plugin/common';
 import type { IAsyncSearchOptions, IKibanaSearchResponse } from '..';
-import { isErrorResponse, isPartialResponse } from '..';
+import { isAbortResponse, isRunningResponse } from '..';
 
 export const pollSearch = <Response extends IKibanaSearchResponse>(
   search: () => Promise<Response>,
@@ -57,11 +57,11 @@ export const pollSearch = <Response extends IKibanaSearchResponse>(
         return timer(getPollInterval(elapsedTime)).pipe(switchMap(search));
       }),
       tap((response) => {
-        if (isErrorResponse(response)) {
-          throw response ? new Error('Received partial response') : new AbortError();
+        if (isAbortResponse(response)) {
+          throw new AbortError();
         }
       }),
-      takeWhile<Response>(isPartialResponse, true),
+      takeWhile<Response>(isRunningResponse, true),
       takeUntil<Response>(aborted$)
     );
   });

src/plugins/data/common/search/search_source/search_source.ts

@@ -103,13 +103,7 @@ import { getSearchParamsFromRequest, RequestFailure } from './fetch';
 import type { FetchHandlers, SearchRequest } from './fetch';
 import { getRequestInspectorStats, getResponseInspectorStats } from './inspect';
 
-import {
-  getEsQueryConfig,
-  IKibanaSearchResponse,
-  isPartialResponse,
-  isCompleteResponse,
-  UI_SETTINGS,
-} from '../..';
+import { getEsQueryConfig, IKibanaSearchResponse, isRunningResponse, UI_SETTINGS } from '../..';
 import { AggsStart } from '../aggs';
 import { extractReferences } from './extract_references';
 import {
@@ -546,7 +540,7 @@ export class SearchSource {
         // For testing timeout messages in UI, uncomment the next line
         // response.rawResponse.timed_out = true;
         return new Observable<IKibanaSearchResponse<unknown>>((obs) => {
-          if (isPartialResponse(response)) {
+          if (isRunningResponse(response)) {
             obs.next(this.postFlightTransform(response));
           } else {
             if (!this.hasPostFlightRequests()) {
@@ -582,7 +576,7 @@ export class SearchSource {
         });
       }),
       map((response) => {
-        if (!isCompleteResponse(response)) {
+        if (isRunningResponse(response)) {
           return response;
         }
         return onResponse(searchRequest, response, options);

src/plugins/data/common/search/utils.test.ts

@@ -6,210 +6,42 @@
  * Side Public License, v 1.
  */
 
-import { isErrorResponse, isCompleteResponse, isPartialResponse } from './utils';
+import type { IKibanaSearchResponse } from './types';
+import { isAbortResponse, isRunningResponse } from './utils';
 
 describe('utils', () => {
-  describe('isErrorResponse', () => {
+  describe('isAbortResponse', () => {
     it('returns `true` if the response is undefined', () => {
-      const isError = isErrorResponse();
+      const isError = isAbortResponse();
       expect(isError).toBe(true);
     });
 
-    it('returns `true` if the response is not running and partial', () => {
-      const isError = isErrorResponse({
-        isPartial: true,
-        isRunning: false,
-        rawResponse: {},
-      });
-      expect(isError).toBe(true);
-    });
-
-    it('returns `false` if the response is not running and partial and contains failure details', () => {
-      const isError = isErrorResponse({
-        isPartial: true,
-        isRunning: false,
-        rawResponse: {
-          took: 7,
-          timed_out: false,
-          _shards: {
-            total: 2,
-            successful: 1,
-            skipped: 0,
-            failed: 1,
-            failures: [
-              {
-                shard: 0,
-                index: 'remote:tmp-00002',
-                node: '9SNgMgppT2-6UHJNXwio3g',
-                reason: {
-                  type: 'script_exception',
-                  reason: 'runtime error',
-                  script_stack: [
-                    '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.getFactoryForDoc(LeafDocLookup.java:148)',
-                    '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:191)',
-                    '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:32)',
-                    "doc['bar'].value < 10",
-                    '    ^---- HERE',
-                  ],
-                  script: "doc['bar'].value < 10",
-                  lang: 'painless',
-                  position: {
-                    offset: 4,
-                    start: 0,
-                    end: 21,
-                  },
-                  caused_by: {
-                    type: 'illegal_argument_exception',
-                    reason: 'No field found for [bar] in mapping',
-                  },
-                },
-              },
-            ],
-          },
-          _clusters: {
-            total: 1,
-            successful: 1,
-            skipped: 0,
-            details: {
-              remote: {
-                status: 'partial',
-                indices: 'tmp-*',
-                took: 3,
-                timed_out: false,
-                _shards: {
-                  total: 2,
-                  successful: 1,
-                  skipped: 0,
-                  failed: 1,
-                },
-                failures: [
-                  {
-                    shard: 0,
-                    index: 'remote:tmp-00002',
-                    node: '9SNgMgppT2-6UHJNXwio3g',
-                    reason: {
-                      type: 'script_exception',
-                      reason: 'runtime error',
-                      script_stack: [
-                        '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.getFactoryForDoc(LeafDocLookup.java:148)',
-                        '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:191)',
-                        '[email protected]/org.elasticsearch.search.lookup.LeafDocLookup.get(LeafDocLookup.java:32)',
-                        "doc['bar'].value < 10",
-                        '    ^---- HERE',
-                      ],
-                      script: "doc['bar'].value < 10",
-                      lang: 'painless',
-                      position: {
-                        offset: 4,
-                        start: 0,
-                        end: 21,
-                      },
-                      caused_by: {
-                        type: 'illegal_argument_exception',
-                        reason: 'No field found for [bar] in mapping',
-                      },
-                    },
-                  },
-                ],
-              },
-            },
-          },
-          hits: {
-            total: {
-              value: 1,
-              relation: 'eq',
-            },
-            max_score: 0,
-            hits: [
-              {
-                _index: 'remote:tmp-00001',
-                _id: 'd8JNlYoBFqAcOBVnvdqx',
-                _score: 0,
-                _source: {
-                  foo: 'bar',
-                  bar: 1,
-                },
-              },
-            ],
-          },
-        },
-      });
-      expect(isError).toBe(false);
-    });
-
-    it('returns `false` if the response is running and partial', () => {
-      const isError = isErrorResponse({
-        isPartial: true,
-        isRunning: true,
-        rawResponse: {},
-      });
-      expect(isError).toBe(false);
-    });
-
-    it('returns `false` if the response is complete', () => {
-      const isError = isErrorResponse({
-        isPartial: false,
-        isRunning: false,
-        rawResponse: {},
-      });
-      expect(isError).toBe(false);
-    });
-  });
-
-  describe('isCompleteResponse', () => {
-    it('returns `false` if the response is undefined', () => {
-      const isError = isCompleteResponse();
-      expect(isError).toBe(false);
-    });
-
-    it('returns `false` if the response is running and partial', () => {
-      const isError = isCompleteResponse({
-        isPartial: true,
-        isRunning: true,
-        rawResponse: {},
-      });
-      expect(isError).toBe(false);
-    });
-
-    it('returns `true` if the response is complete', () => {
-      const isError = isCompleteResponse({
-        isPartial: false,
-        isRunning: false,
-        rawResponse: {},
-      });
-      expect(isError).toBe(true);
-    });
-
-    it('returns `true` if the response does not indicate isRunning', () => {
-      const isError = isCompleteResponse({
-        rawResponse: {},
-      });
+    it('returns `true` if rawResponse is undefined', () => {
+      const isError = isAbortResponse({} as unknown as IKibanaSearchResponse);
       expect(isError).toBe(true);
     });
   });
 
-  describe('isPartialResponse', () => {
+  describe('isRunningResponse', () => {
     it('returns `false` if the response is undefined', () => {
-      const isError = isPartialResponse();
-      expect(isError).toBe(false);
+      const isRunning = isRunningResponse();
+      expect(isRunning).toBe(false);
     });
 
-    it('returns `true` if the response is running and partial', () => {
-      const isError = isPartialResponse({
-        isPartial: true,
+    it('returns `true` if the response is running', () => {
+      const isRunning = isRunningResponse({
         isRunning: true,
         rawResponse: {},
       });
-      expect(isError).toBe(true);
+      expect(isRunning).toBe(true);
     });
 
-    it('returns `false` if the response is complete', () => {
-      const isError = isPartialResponse({
-        isPartial: false,
+    it('returns `false` if the response is finished running', () => {
+      const isRunning = isRunningResponse({
         isRunning: false,
         rawResponse: {},
       });
-      expect(isError).toBe(false);
+      expect(isRunning).toBe(false);
     });
   });
 });