Replace FetchOptions with ISearchOptions and update usage

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.signal.md → docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md

@@ -1,11 +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; [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) &gt; [signal](./kibana-plugin-plugins-data-public.isearchoptions.signal.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) &gt; [abortSignal](./kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md)
 
-## ISearchOptions.signal property
+## ISearchOptions.abortSignal property
 
 <b>Signature:</b>
 
 ```typescript
-signal?: AbortSignal;
+abortSignal?: AbortSignal;
 ```

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

@@ -14,6 +14,6 @@ export interface ISearchOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [signal](./kibana-plugin-plugins-data-public.isearchoptions.signal.md) | <code>AbortSignal</code> |  |
+|  [abortSignal](./kibana-plugin-plugins-data-public.isearchoptions.abortsignal.md) | <code>AbortSignal</code> |  |
 |  [strategy](./kibana-plugin-plugins-data-public.isearchoptions.strategy.md) | <code>string</code> |  |
 

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

@@ -51,7 +51,6 @@
 |  [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) |  |
 |  [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) |  |
 |  [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) |  |
-|  [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.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) |  |

src/plugins/data/common/search/aggs/agg_config.ts

@@ -21,7 +21,7 @@ import _ from 'lodash';
 import { i18n } from '@kbn/i18n';
 import { Assign, Ensure } from '@kbn/utility-types';
 
-import { FetchOptions, ISearchSource } from 'src/plugins/data/public';
+import { ISearchOptions, ISearchSource } from 'src/plugins/data/public';
 import {
   ExpressionAstFunction,
   ExpressionAstArgument,
@@ -213,11 +213,11 @@ export class AggConfig {
 
   /**
    *  Hook for pre-flight logic, see AggType#onSearchRequestStart
-   *  @param {Courier.SearchSource} searchSource
-   *  @param {Courier.FetchOptions} options
+   *  @param {SearchSource} searchSource
+   *  @param {ISearchOptions} options
    *  @return {Promise<undefined>}
    */
-  onSearchRequestStart(searchSource: ISearchSource, options?: FetchOptions) {
+  onSearchRequestStart(searchSource: ISearchSource, options?: ISearchOptions) {
     if (!this.type) {
       return Promise.resolve();
     }

src/plugins/data/common/search/aggs/agg_configs.ts

@@ -20,7 +20,7 @@
 import _ from 'lodash';
 import { Assign } from '@kbn/utility-types';
 
-import { FetchOptions, ISearchSource } from 'src/plugins/data/public';
+import { ISearchOptions, ISearchSource } from 'src/plugins/data/public';
 import { AggConfig, AggConfigSerialized, IAggConfig } from './agg_config';
 import { IAggType } from './agg_type';
 import { AggTypesRegistryStart } from './agg_types_registry';
@@ -300,7 +300,7 @@ export class AggConfigs {
     return _.find(reqAgg.getResponseAggs(), { id });
   }
 
-  onSearchRequestStart(searchSource: ISearchSource, options?: FetchOptions) {
+  onSearchRequestStart(searchSource: ISearchSource, options?: ISearchOptions) {
     return Promise.all(
       // @ts-ignore
       this.getRequestAggs().map((agg: AggConfig) => agg.onSearchRequestStart(searchSource, options))

src/plugins/data/common/search/aggs/param_types/base.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { FetchOptions, ISearchSource } from 'src/plugins/data/public';
+import { ISearchOptions, ISearchSource } from 'src/plugins/data/public';
 import { ExpressionAstFunction } from 'src/plugins/expressions/common';
 import { IAggConfigs } from '../agg_configs';
 import { IAggConfig } from '../agg_config';
@@ -56,7 +56,7 @@ export class BaseParamType<TAggConfig extends IAggConfig = IAggConfig> {
   modifyAggConfigOnSearchRequestStart: (
     aggConfig: TAggConfig,
     searchSource?: ISearchSource,
-    options?: FetchOptions
+    options?: ISearchOptions
   ) => void;
 
   constructor(config: Record<string, any>) {

src/plugins/data/public/index.ts

@@ -342,7 +342,6 @@ export {
   ES_SEARCH_STRATEGY,
   EsQuerySortValue,
   extractSearchSourceReferences,
-  FetchOptions,
   getEsPreference,
   getSearchParamsFromRequest,
   IEsSearchRequest,

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

@@ -26,11 +26,11 @@ import { EuiGlobalToastListToast } from '@elastic/eui';
 import { ExclusiveUnion } from '@elastic/eui';
 import { ExpressionAstFunction } from 'src/plugins/expressions/common';
 import { ExpressionsSetup } from 'src/plugins/expressions/public';
-import { FetchOptions as FetchOptions_2 } from 'src/plugins/data/public';
 import { History } from 'history';
 import { Href } from 'history';
 import { IconType } from '@elastic/eui';
 import { InjectedIntl } from '@kbn/i18n/react';
+import { ISearchOptions as ISearchOptions_2 } from 'src/plugins/data/public';
 import { ISearchSource as ISearchSource_2 } from 'src/plugins/data/public';
 import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { IUiSettingsClient } from 'src/core/public';
@@ -486,16 +486,6 @@ export const extractSearchSourceReferences: (state: SearchSourceFields) => [Sear
     indexRefName?: string;
 }, SavedObjectReference[]];
 
-// Warning: (ae-missing-release-tag) "FetchOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export interface FetchOptions {
-    // (undocumented)
-    abortSignal?: AbortSignal;
-    // (undocumented)
-    searchStrategyId?: string;
-}
-
 // Warning: (ae-missing-release-tag) "FieldFormat" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -1266,7 +1256,7 @@ export type ISearchGeneric = <SearchStrategyRequest extends IEsSearchRequest = I
 // @public (undocumented)
 export interface ISearchOptions {
     // (undocumented)
-    signal?: AbortSignal;
+    abortSignal?: AbortSignal;
     // (undocumented)
     strategy?: string;
 }
@@ -2003,21 +1993,21 @@ export const UI_SETTINGS: {
 // src/plugins/data/public/index.ts:234:27 - (ae-forgotten-export) The symbol "getFromSavedObject" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/index.ts:234:27 - (ae-forgotten-export) The symbol "flattenHitWrapper" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/index.ts:234:27 - (ae-forgotten-export) The symbol "formatHitProvider" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:371:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:371:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:371:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:371:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:373:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:374:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:383:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:384:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:385:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:386:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:390:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:391:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:394:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:395:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/index.ts:398:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:370:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:370:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:370:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:370:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:372:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:373:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:382:1 - (ae-forgotten-export) The symbol "InvalidEsCalendarIntervalError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:383:1 - (ae-forgotten-export) The symbol "InvalidEsIntervalFormatError" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:384:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:385:1 - (ae-forgotten-export) The symbol "isDateHistogramBucketAggConfig" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:389:1 - (ae-forgotten-export) The symbol "isValidEsInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:390:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:393:1 - (ae-forgotten-export) The symbol "parseInterval" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:394:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/index.ts:397:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/query/state_sync/connect_to_query_state.ts:45:5 - (ae-forgotten-export) The symbol "FilterStateStore" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/types.ts:62:5 - (ae-forgotten-export) The symbol "createFiltersFromValueClickAction" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/types.ts:63:5 - (ae-forgotten-export) The symbol "createFiltersFromRangeSelectAction" needs to be exported by the entry point index.d.ts

src/plugins/data/public/search/expressions/esdsl.ts

@@ -140,7 +140,7 @@ export const esdsl = (): EsdslExpressionFunctionDefinition => ({
               body: dsl,
             },
           },
-          { signal: abortSignal }
+          { abortSignal }
         )
         .toPromise();
 

src/plugins/data/public/search/fetch/types.ts

@@ -29,11 +29,6 @@ import { ISearchStartLegacy } from '../types';
  */
 export type SearchRequest = Record<string, any>;
 
-export interface FetchOptions {
-  abortSignal?: AbortSignal;
-  searchStrategyId?: string;
-}
-
 export interface FetchHandlers {
   legacySearchService: ISearchStartLegacy;
   config: { get: GetConfigFn };

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

@@ -34,7 +34,7 @@ export { getEsPreference } from './es_search';
 
 export { IKibanaSearchResponse, IKibanaSearchRequest } from '../../common/search';
 
-export { SearchError, FetchOptions, getSearchParamsFromRequest, SearchRequest } from './fetch';
+export { SearchError, getSearchParamsFromRequest, SearchRequest } from './fetch';
 
 export {
   ISearchSource,

src/plugins/data/public/search/legacy/call_client.ts

@@ -18,21 +18,21 @@
  */
 
 import { SearchResponse } from 'elasticsearch';
-import { FetchOptions, FetchHandlers, handleResponse } from '../fetch';
+import { FetchHandlers, handleResponse } from '../fetch';
 import { defaultSearchStrategy } from './default_search_strategy';
-import { SearchRequest } from '../index';
+import { SearchRequest, ISearchOptions } from '../index';
 
 export function callClient(
   searchRequests: SearchRequest[],
-  requestsOptions: FetchOptions[] = [],
+  requestsOptions: ISearchOptions[] = [],
   fetchHandlers: FetchHandlers
 ) {
   // Correlate the options with the request that they're associated with
   const requestOptionEntries: Array<[
     SearchRequest,
-    FetchOptions
+    ISearchOptions
   ]> = searchRequests.map((request, i) => [request, requestsOptions[i]]);
-  const requestOptionsMap = new Map<SearchRequest, FetchOptions>(requestOptionEntries);
+  const requestOptionsMap = new Map<SearchRequest, ISearchOptions>(requestOptionEntries);
   const requestResponseMap = new Map<SearchRequest, Promise<SearchResponse<any>>>();
 
   const { searching, abort } = defaultSearchStrategy.search({

src/plugins/data/public/search/legacy/fetch_soon.test.ts

@@ -19,7 +19,7 @@
 
 import { fetchSoon } from './fetch_soon';
 import { callClient } from './call_client';
-import { FetchHandlers, FetchOptions } from '../fetch/types';
+import { FetchHandlers } from '../fetch/types';
 import { SearchRequest } from '../index';
 import { SearchResponse } from 'elasticsearch';
 import { GetConfigFn, UI_SETTINGS } from '../../../common';

src/plugins/data/public/search/legacy/fetch_soon.ts

@@ -19,8 +19,8 @@
 
 import { SearchResponse } from 'elasticsearch';
 import { callClient } from './call_client';
-import { FetchHandlers, FetchOptions } from '../fetch/types';
-import { SearchRequest } from '../index';
+import { FetchHandlers } from '../fetch/types';
+import { SearchRequest, ISearchOptions } from '../index';
 import { UI_SETTINGS } from '../../../common';
 
 /**
@@ -29,7 +29,7 @@ import { UI_SETTINGS } from '../../../common';
  */
 export async function fetchSoon(
   request: SearchRequest,
-  options: FetchOptions,
+  options: ISearchOptions,
   fetchHandlers: FetchHandlers
 ) {
   const msToDelay = fetchHandlers.config.get(UI_SETTINGS.COURIER_BATCH_SEARCHES) ? 50 : 0;
@@ -51,7 +51,7 @@ function delay<T>(fn: (...args: any) => T, ms: number): Promise<T> {
 
 // The current batch/queue of requests to fetch
 let requestsToFetch: SearchRequest[] = [];
-let requestOptions: FetchOptions[] = [];
+let requestOptions: ISearchOptions[] = [];
 
 // The in-progress fetch (if there is one)
 let fetchInProgress: any = null;
@@ -65,7 +65,7 @@ let fetchInProgress: any = null;
  */
 async function delayedFetch(
   request: SearchRequest,
-  options: FetchOptions,
+  options: ISearchOptions,
   fetchHandlers: FetchHandlers,
   ms: number
 ): Promise<SearchResponse<any>> {

src/plugins/data/public/search/search_interceptor.test.ts

@@ -112,7 +112,9 @@ describe('SearchInterceptor', () => {
       const mockRequest: IEsSearchRequest = {
         params: {},
       };
-      const response = searchInterceptor.search(mockRequest, { signal: abortController.signal });
+      const response = searchInterceptor.search(mockRequest, {
+        abortSignal: abortController.signal,
+      });
 
       const next = jest.fn();
       const error = (e: any) => {
@@ -131,7 +133,7 @@ describe('SearchInterceptor', () => {
       const mockRequest: IEsSearchRequest = {
         params: {},
       };
-      const response = searchInterceptor.search(mockRequest, { signal: abort.signal });
+      const response = searchInterceptor.search(mockRequest, { abortSignal: abort.signal });
       abort.abort();
 
       const error = (e: any) => {

src/plugins/data/public/search/search_interceptor.ts

@@ -128,7 +128,7 @@ export class SearchInterceptor {
   ): Observable<IEsSearchResponse> {
     // Defer the following logic until `subscribe` is actually called
     return defer(() => {
-      if (options?.signal?.aborted) {
+      if (options?.abortSignal?.aborted) {
         return throwError(new AbortError());
       }
 
@@ -164,7 +164,7 @@ export class SearchInterceptor {
     const signals = [
       this.abortController.signal,
       timeoutSignal,
-      ...(options?.signal ? [options.signal] : []),
+      ...(options?.abortSignal ? [options.abortSignal] : []),
     ];
 
     const combinedSignal = getCombinedSignal(signals);