[Search] Add response status helpers

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iscompleteresponse.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [isCompleteResponse](./kibana-plugin-plugins-data-public.iscompleteresponse.md)
+
+## isCompleteResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isCompleteResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iserrorresponse.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [isErrorResponse](./kibana-plugin-plugins-data-public.iserrorresponse.md)
+
+## isErrorResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isErrorResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ispartialresponse.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [isPartialResponse](./kibana-plugin-plugins-data-public.ispartialresponse.md)
+
+## isPartialResponse variable
+
+<b>Signature:</b>
+
+```typescript
+isPartialResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined
+```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md

@@ -57,7 +57,6 @@
 |  [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) |  |
 |  [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) |  |
 |  [FieldMappingSpec](./kibana-plugin-plugins-data-public.fieldmappingspec.md) |  |
-|  [Filter](./kibana-plugin-plugins-data-public.filter.md) |  |
 |  [IDataPluginServices](./kibana-plugin-plugins-data-public.idatapluginservices.md) |  |
 |  [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) |  |
 |  [IEsSearchResponse](./kibana-plugin-plugins-data-public.iessearchresponse.md) |  |
@@ -75,7 +74,6 @@
 |  [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) | high level search service |
 |  [KueryNode](./kibana-plugin-plugins-data-public.kuerynode.md) |  |
 |  [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) |  |
-|  [Query](./kibana-plugin-plugins-data-public.query.md) |  |
 |  [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
 |  [QueryStateChange](./kibana-plugin-plugins-data-public.querystatechange.md) |  |
 |  [QuerySuggestionBasic](./kibana-plugin-plugins-data-public.querysuggestionbasic.md) | \* |
@@ -90,7 +88,6 @@
 |  [SearchSourceFields](./kibana-plugin-plugins-data-public.searchsourcefields.md) | search source fields |
 |  [TabbedAggColumn](./kibana-plugin-plugins-data-public.tabbedaggcolumn.md) | \* |
 |  [TabbedTable](./kibana-plugin-plugins-data-public.tabbedtable.md) | \* |
-|  [TimeRange](./kibana-plugin-plugins-data-public.timerange.md) |  |
 
 ## Variables
 
@@ -115,8 +112,11 @@
 |  [getKbnTypeNames](./kibana-plugin-plugins-data-public.getkbntypenames.md) | Get the esTypes known by all kbnFieldTypes {<!-- -->Array<string>} |
 |  [indexPatterns](./kibana-plugin-plugins-data-public.indexpatterns.md) |  |
 |  [injectSearchSourceReferences](./kibana-plugin-plugins-data-public.injectsearchsourcereferences.md) |  |
+|  [isCompleteResponse](./kibana-plugin-plugins-data-public.iscompleteresponse.md) |  |
+|  [isErrorResponse](./kibana-plugin-plugins-data-public.iserrorresponse.md) |  |
 |  [isFilter](./kibana-plugin-plugins-data-public.isfilter.md) |  |
 |  [isFilters](./kibana-plugin-plugins-data-public.isfilters.md) |  |
+|  [isPartialResponse](./kibana-plugin-plugins-data-public.ispartialresponse.md) |  |
 |  [isQuery](./kibana-plugin-plugins-data-public.isquery.md) |  |
 |  [isTimeRange](./kibana-plugin-plugins-data-public.istimerange.md) |  |
 |  [parseSearchSourceJSON](./kibana-plugin-plugins-data-public.parsesearchsourcejson.md) |  |
@@ -145,6 +145,7 @@
 |  [FieldFormatsContentType](./kibana-plugin-plugins-data-public.fieldformatscontenttype.md) | \* |
 |  [FieldFormatsGetConfigFn](./kibana-plugin-plugins-data-public.fieldformatsgetconfigfn.md) |  |
 |  [FieldFormatsStart](./kibana-plugin-plugins-data-public.fieldformatsstart.md) |  |
+|  [Filter](./kibana-plugin-plugins-data-public.filter.md) |  |
 |  [IAggConfig](./kibana-plugin-plugins-data-public.iaggconfig.md) |  AggConfig This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app. |
 |  [IAggType](./kibana-plugin-plugins-data-public.iaggtype.md) |  |
 |  [IFieldFormat](./kibana-plugin-plugins-data-public.ifieldformat.md) |  |
@@ -162,6 +163,7 @@
 |  [ParsedInterval](./kibana-plugin-plugins-data-public.parsedinterval.md) |  |
 |  [PhraseFilter](./kibana-plugin-plugins-data-public.phrasefilter.md) |  |
 |  [PhrasesFilter](./kibana-plugin-plugins-data-public.phrasesfilter.md) |  |
+|  [Query](./kibana-plugin-plugins-data-public.query.md) |  |
 |  [QueryStart](./kibana-plugin-plugins-data-public.querystart.md) |  |
 |  [QuerySuggestion](./kibana-plugin-plugins-data-public.querysuggestion.md) | \* |
 |  [QuerySuggestionGetFn](./kibana-plugin-plugins-data-public.querysuggestiongetfn.md) |  |
@@ -173,4 +175,5 @@
 |  [TabbedAggRow](./kibana-plugin-plugins-data-public.tabbedaggrow.md) | \* |
 |  [TimefilterContract](./kibana-plugin-plugins-data-public.timefiltercontract.md) |  |
 |  [TimeHistoryContract](./kibana-plugin-plugins-data-public.timehistorycontract.md) |  |
+|  [TimeRange](./kibana-plugin-plugins-data-public.timerange.md) |  |
 

examples/search_examples/public/components/app.tsx

@@ -56,6 +56,8 @@ import {
   IndexPatternSelect,
   IndexPattern,
   IndexPatternField,
+  isCompleteResponse,
+  isErrorResponse,
 } from '../../../../src/plugins/data/public';
 
 interface SearchExamplesAppDeps {
@@ -144,7 +146,7 @@ export const SearchExamplesApp = ({
       })
       .subscribe({
         next: (response) => {
-          if (!response.isPartial && !response.isRunning) {
+          if (isCompleteResponse(response)) {
             setTimeTook(response.rawResponse.took);
             const avgResult: number | undefined = response.rawResponse.aggregations
               ? response.rawResponse.aggregations[1].value
@@ -162,7 +164,7 @@ export const SearchExamplesApp = ({
               text: mountReactNode(message),
             });
             searchSubscription$.unsubscribe();
-          } else if (response.isPartial && !response.isRunning) {
+          } else if (isErrorResponse(response)) {
             // TODO: Make response error status clearer
             notifications.toasts.addWarning('An error has occurred');
             searchSubscription$.unsubscribe();

src/plugins/data/common/search/es_search/index.ts

@@ -18,3 +18,4 @@
  */
 
 export * from './types';
+export * from './utils';

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

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { IEsSearchResponse } from './types';
+
+/**
+ * @returns true if response had an error while executing in ES
+ */
+export const isErrorResponse = (response?: IEsSearchResponse) => {
+  return !response || (!response.isRunning && response.isPartial);
+};
+
+/**
+ * @returns true if response is completed successfully
+ */
+export const isCompleteResponse = (response?: IEsSearchResponse) => {
+  return response && !response.isRunning && !response.isPartial;
+};
+
+/**
+ * @returns true if request is still running an/d response contains partial results
+ */
+export const isPartialResponse = (response?: IEsSearchResponse) => {
+  return response && response.isRunning && response.isPartial;
+};

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

@@ -23,3 +23,4 @@ export * from './expressions';
 export * from './search_source';
 export * from './tabify';
 export * from './types';
+export * from './es_search';

src/plugins/data/public/index.ts

@@ -374,7 +374,7 @@ export {
 
 export type { SearchSource } from './search';
 
-export { ISearchOptions } from '../common';
+export { ISearchOptions, isErrorResponse, isCompleteResponse, isPartialResponse } from '../common';
 
 // Search namespace
 export const search = {

src/plugins/data/public/public.api.md

@@ -1381,6 +1381,11 @@ export type InputTimeRange = TimeRange | {
     to: Moment;
 };
 
+// Warning: (ae-missing-release-tag) "isCompleteResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const isCompleteResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined;
+
 // Warning: (ae-missing-release-tag) "ISearch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1433,6 +1438,11 @@ export interface ISearchStartSearchSource {
     createEmpty: () => ISearchSource;
 }
 
+// Warning: (ae-missing-release-tag) "isErrorResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const isErrorResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined;
+
 // Warning: (ae-missing-release-tag) "isFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1443,6 +1453,11 @@ export const isFilter: (x: unknown) => x is Filter;
 // @public (undocumented)
 export const isFilters: (x: unknown) => x is Filter[];
 
+// Warning: (ae-missing-release-tag) "isPartialResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const isPartialResponse: (response?: IEsSearchResponse<any> | undefined) => boolean | undefined;
+
 // Warning: (ae-missing-release-tag) "isQuery" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

x-pack/plugins/data_enhanced/public/search/search_interceptor.ts

@@ -13,6 +13,7 @@ import {
   SearchInterceptorDeps,
   UI_SETTINGS,
 } from '../../../../../src/plugins/data/public';
+import { isErrorResponse, isCompleteResponse } from '../../../../../src/plugins/data/public';
 import { AbortError, toPromise } from '../../../../../src/plugins/data/common';
 import { IAsyncSearchOptions } from '.';
 import { IAsyncSearchRequest, ENHANCED_ES_SEARCH_STRATEGY } from '../../common';
@@ -66,12 +67,12 @@ export class EnhancedSearchInterceptor extends SearchInterceptor {
     return this.runSearch(request, combinedSignal, strategy).pipe(
       expand((response) => {
         // If the response indicates of an error, stop polling and complete the observable
-        if (!response || (!response.isRunning && response.isPartial)) {
+        if (isErrorResponse(response)) {
           return throwError(new AbortError());
         }
 
         // If the response indicates it is complete, stop polling and complete the observable
-        if (!response.isRunning) {
+        if (isCompleteResponse(response)) {
           return EMPTY;
         }
 

x-pack/plugins/data_enhanced/server/search/es_search_strategy.ts

@@ -19,7 +19,11 @@ import {
   shimHitsTotal,
 } from '../../../../../src/plugins/data/server';
 import { IEnhancedEsSearchRequest } from '../../common';
-import { ISearchOptions, IEsSearchResponse } from '../../../../../src/plugins/data/common/search';
+import {
+  ISearchOptions,
+  IEsSearchResponse,
+  isCompleteResponse,
+} from '../../../../../src/plugins/data/common/search';
 
 function isEnhancedEsSearchResponse(response: any): response is IEsSearchResponse {
   return response.hasOwnProperty('isPartial') && response.hasOwnProperty('isRunning');
@@ -48,8 +52,7 @@ export const enhancedEsSearchStrategyProvider = (
         usage &&
         isAsync &&
         isEnhancedEsSearchResponse(response) &&
-        !response.isRunning &&
-        !response.isPartial
+        isCompleteResponse(response)
       ) {
         usage.trackSuccess(response.rawResponse.took);
       }

x-pack/plugins/security_solution/public/common/containers/events/last_event_time/index.ts

@@ -18,7 +18,11 @@ import {
   LastTimeDetails,
   LastEventIndexKey,
 } from '../../../../../common/search_strategy/timeline';
-import { AbortError } from '../../../../../../../../src/plugins/data/common';
+import {
+  AbortError,
+  isCompleteResponse,
+  isErrorResponse,
+} from '../../../../../../../../src/plugins/data/common';
 import { useWithSource } from '../../source';
 import * as i18n from './translations';
 
@@ -80,7 +84,7 @@ export const useTimelineLastEventTime = ({
           })
           .subscribe({
             next: (response) => {
-              if (!response.isPartial && !response.isRunning) {
+              if (isCompleteResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                   setTimelineLastEventTimeResponse((prevResponse) => ({
@@ -91,7 +95,7 @@ export const useTimelineLastEventTime = ({
                   }));
                 }
                 searchSubscription$.unsubscribe();
-              } else if (response.isPartial && !response.isRunning) {
+              } else if (isErrorResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                 }

x-pack/plugins/security_solution/public/common/containers/matrix_histogram/index.ts

@@ -19,7 +19,11 @@ import {
   MatrixHistogramStrategyResponse,
   MatrixHistogramData,
 } from '../../../../common/search_strategy/security_solution';
-import { AbortError } from '../../../../../../../src/plugins/data/common';
+import {
+  AbortError,
+  isErrorResponse,
+  isCompleteResponse,
+} from '../../../../../../../src/plugins/data/common';
 import { getInspectResponse } from '../../../helpers';
 import { InspectResponse } from '../../../types';
 import * as i18n from './translations';
@@ -90,7 +94,7 @@ export const useMatrixHistogram = ({
           })
           .subscribe({
             next: (response) => {
-              if (!response.isPartial && !response.isRunning) {
+              if (isCompleteResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                   setMatrixHistogramResponse((prevResponse) => ({
@@ -102,7 +106,7 @@ export const useMatrixHistogram = ({
                   }));
                 }
                 searchSubscription$.unsubscribe();
-              } else if (response.isPartial && !response.isRunning) {
+              } else if (isErrorResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                 }

x-pack/plugins/security_solution/public/hosts/containers/authentications/index.tsx

@@ -9,7 +9,11 @@ import { useCallback, useEffect, useRef, useState } from 'react';
 import { shallowEqual, useSelector } from 'react-redux';
 import deepEqual from 'fast-deep-equal';
 
-import { AbortError } from '../../../../../../../src/plugins/data/common';
+import {
+  AbortError,
+  isCompleteResponse,
+  isErrorResponse,
+} from '../../../../../../../src/plugins/data/common';
 
 import { DEFAULT_INDEX_KEY } from '../../../../common/constants';
 import { HostsQueries } from '../../../../common/search_strategy/security_solution';
@@ -136,7 +140,7 @@ export const useAuthentications = ({
           })
           .subscribe({
             next: (response) => {
-              if (!response.isPartial && !response.isRunning) {
+              if (isCompleteResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                   setAuthenticationsResponse((prevResponse) => ({
@@ -149,7 +153,7 @@ export const useAuthentications = ({
                   }));
                 }
                 searchSubscription$.unsubscribe();
-              } else if (response.isPartial && !response.isRunning) {
+              } else if (isErrorResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                 }

x-pack/plugins/security_solution/public/hosts/containers/hosts/details/_index.tsx

@@ -21,7 +21,11 @@ import {
 } from '../../../../../common/search_strategy/security_solution/hosts';
 
 import * as i18n from './translations';
-import { AbortError } from '../../../../../../../../src/plugins/data/common';
+import {
+  AbortError,
+  isCompleteResponse,
+  isErrorResponse,
+} from '../../../../../../../../src/plugins/data/common';
 import { getInspectResponse } from '../../../../helpers';
 import { InspectResponse } from '../../../../types';
 
@@ -93,7 +97,7 @@ export const useHostDetails = ({
           })
           .subscribe({
             next: (response) => {
-              if (!response.isPartial && !response.isRunning) {
+              if (isCompleteResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                   setHostDetailsResponse((prevResponse) => ({
@@ -104,7 +108,7 @@ export const useHostDetails = ({
                   }));
                 }
                 searchSubscription$.unsubscribe();
-              } else if (response.isPartial && !response.isRunning) {
+              } else if (isErrorResponse(response)) {
                 if (!didCancel) {
                   setLoading(false);
                 }