Data plugin: Suggested enhance pattern (#74505) (#74936)

* improve test stability * Enhance pattern * fix tests * fix test * Rename enhance to __enhance * Deleted unnecessary attribute * ISearchInterceptor interface * docs * Clean up internal docs * jest Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
elastic · Aug 13, 2020 · fe82150 · fe82150
1 parent c2a1008
commit fe82150
Show file tree

Hide file tree

Showing 29 changed files with 194 additions and 213 deletions.
diff --git a/...a/public/kibana-plugin-plugins-data-public.searchinterceptor.abortcontroller.md b/...a/public/kibana-plugin-plugins-data-public.searchinterceptor.abortcontroller.md
diff --git a/.../public/kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md b/.../public/kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md
@@ -2,12 +2,16 @@
 
 [Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [getPendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md)
 
-## SearchInterceptor.getPendingCount$ property
+## SearchInterceptor.getPendingCount$() method
 
 Returns an `Observable` over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses.
 
 <b>Signature:</b>
 
 ```typescript
-getPendingCount$: () => Observable<number>;
+getPendingCount$(): Observable<number>;
 ```
+<b>Returns:</b>
+
+`Observable<number>`
+
diff --git a/...ns/data/public/kibana-plugin-plugins-data-public.searchinterceptor.hidetoast.md b/...ns/data/public/kibana-plugin-plugins-data-public.searchinterceptor.hidetoast.md
diff --git a/.../public/kibana-plugin-plugins-data-public.searchinterceptor.longrunningtoast.md b/.../public/kibana-plugin-plugins-data-public.searchinterceptor.longrunningtoast.md
diff --git a/...ment/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md b/...ment/plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.md
@@ -20,22 +20,15 @@ export declare class SearchInterceptor
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [abortController](./kibana-plugin-plugins-data-public.searchinterceptor.abortcontroller.md) |  | <code>AbortController</code> | <code>abortController</code> used to signal all searches to abort. |
 |  [deps](./kibana-plugin-plugins-data-public.searchinterceptor.deps.md) |  | <code>SearchInterceptorDeps</code> |  |
-|  [getPendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) |  | <code>() =&gt; Observable&lt;number&gt;</code> | Returns an <code>Observable</code> over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
-|  [hideToast](./kibana-plugin-plugins-data-public.searchinterceptor.hidetoast.md) |  | <code>() =&gt; void</code> |  |
-|  [longRunningToast](./kibana-plugin-plugins-data-public.searchinterceptor.longrunningtoast.md) |  | <code>Toast</code> | The current long-running toast (if there is one). |
-|  [pendingCount](./kibana-plugin-plugins-data-public.searchinterceptor.pendingcount.md) |  | <code>number</code> | The number of pending search requests. |
-|  [pendingCount$](./kibana-plugin-plugins-data-public.searchinterceptor.pendingcount_.md) |  | <code>BehaviorSubject&lt;number&gt;</code> | Observable that emits when the number of pending requests changes. |
 |  [requestTimeout](./kibana-plugin-plugins-data-public.searchinterceptor.requesttimeout.md) |  | <code>number &#124; undefined</code> |  |
-|  [showToast](./kibana-plugin-plugins-data-public.searchinterceptor.showtoast.md) |  | <code>() =&gt; void</code> |  |
-|  [timeoutSubscriptions](./kibana-plugin-plugins-data-public.searchinterceptor.timeoutsubscriptions.md) |  | <code>Subscription</code> | The subscriptions from scheduling the automatic timeout for each request. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
+|  [getPendingCount$()](./kibana-plugin-plugins-data-public.searchinterceptor.getpendingcount_.md) |  | Returns an <code>Observable</code> over the current number of pending searches. This could mean that one of the search requests is still in flight, or that it has only received partial responses. |
 |  [runSearch(request, signal, strategy)](./kibana-plugin-plugins-data-public.searchinterceptor.runsearch.md) |  |  |
-|  [search(request, options)](./kibana-plugin-plugins-data-public.searchinterceptor.search.md) |  | Searches using the given <code>search</code> method. Overrides the <code>AbortSignal</code> with one that will abort either when <code>cancelPending</code> is called, when the request times out, or when the original <code>AbortSignal</code> is aborted. Updates the <code>pendingCount</code> when the request is started/finalized. |
+|  [search(request, options)](./kibana-plugin-plugins-data-public.searchinterceptor.search.md) |  | Searches using the given <code>search</code> method. Overrides the <code>AbortSignal</code> with one that will abort either when <code>cancelPending</code> is called, when the request times out, or when the original <code>AbortSignal</code> is aborted. Updates <code>pendingCount$</code> when the request is started/finalized. |
 |  [setupTimers(options)](./kibana-plugin-plugins-data-public.searchinterceptor.setuptimers.md) |  |  |
 
diff --git a/...data/public/kibana-plugin-plugins-data-public.searchinterceptor.pendingcount.md b/...data/public/kibana-plugin-plugins-data-public.searchinterceptor.pendingcount.md
diff --git a/...ata/public/kibana-plugin-plugins-data-public.searchinterceptor.pendingcount_.md b/...ata/public/kibana-plugin-plugins-data-public.searchinterceptor.pendingcount_.md
diff --git a/...ugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.search.md b/...ugins/data/public/kibana-plugin-plugins-data-public.searchinterceptor.search.md
@@ -4,7 +4,7 @@
 
 ## SearchInterceptor.search() method
 
-Searches using the given `search` method. Overrides the `AbortSignal` with one that will abort either when `cancelPending` is called, when the request times out, or when the original `AbortSignal` is aborted. Updates the `pendingCount` when the request is started/finalized.
+Searches using the given `search` method. Overrides the `AbortSignal` with one that will abort either when `cancelPending` is called, when the request times out, or when the original `AbortSignal` is aborted. Updates `pendingCount$` when the request is started/finalized.
 
 <b>Signature:</b>
 

diff --git a/...ns/data/public/kibana-plugin-plugins-data-public.searchinterceptor.showtoast.md b/...ns/data/public/kibana-plugin-plugins-data-public.searchinterceptor.showtoast.md
diff --git a/...lic/kibana-plugin-plugins-data-public.searchinterceptor.timeoutsubscriptions.md b/...lic/kibana-plugin-plugins-data-public.searchinterceptor.timeoutsubscriptions.md
diff --git a/...ins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.http.md b/...ins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.http.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-http: CoreStart['http'];
+http: CoreSetup['http'];
 ```
diff --git a/.../plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.md b/.../plugins/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.md
@@ -14,9 +14,9 @@ export interface SearchInterceptorDeps
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [application](./kibana-plugin-plugins-data-public.searchinterceptordeps.application.md) | <code>ApplicationStart</code> |  |
-|  [http](./kibana-plugin-plugins-data-public.searchinterceptordeps.http.md) | <code>CoreStart['http']</code> |  |
-|  [toasts](./kibana-plugin-plugins-data-public.searchinterceptordeps.toasts.md) | <code>ToastsStart</code> |  |
-|  [uiSettings](./kibana-plugin-plugins-data-public.searchinterceptordeps.uisettings.md) | <code>CoreStart['uiSettings']</code> |  |
+|  [http](./kibana-plugin-plugins-data-public.searchinterceptordeps.http.md) | <code>CoreSetup['http']</code> |  |
+|  [startServices](./kibana-plugin-plugins-data-public.searchinterceptordeps.startservices.md) | <code>Promise&lt;[CoreStart, any, unknown]&gt;</code> |  |
+|  [toasts](./kibana-plugin-plugins-data-public.searchinterceptordeps.toasts.md) | <code>ToastsSetup</code> |  |
+|  [uiSettings](./kibana-plugin-plugins-data-public.searchinterceptordeps.uisettings.md) | <code>CoreSetup['uiSettings']</code> |  |
 |  [usageCollector](./kibana-plugin-plugins-data-public.searchinterceptordeps.usagecollector.md) | <code>SearchUsageCollector</code> |  |
 
diff --git a/...blic.searchinterceptordeps.application.md → ...ic.searchinterceptordeps.startservices.md b/...blic.searchinterceptordeps.application.md → ...ic.searchinterceptordeps.startservices.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; [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) &gt; [application](./kibana-plugin-plugins-data-public.searchinterceptordeps.application.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchInterceptorDeps](./kibana-plugin-plugins-data-public.searchinterceptordeps.md) &gt; [startServices](./kibana-plugin-plugins-data-public.searchinterceptordeps.startservices.md)
 
-## SearchInterceptorDeps.application property
+## SearchInterceptorDeps.startServices property
 
 <b>Signature:</b>
 
 ```typescript
-application: ApplicationStart;
+startServices: Promise<[CoreStart, any, unknown]>;
 ```
diff --git a/...s/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.toasts.md b/...s/data/public/kibana-plugin-plugins-data-public.searchinterceptordeps.toasts.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-toasts: ToastsStart;
+toasts: ToastsSetup;
 ```
diff --git a/...ta/public/kibana-plugin-plugins-data-public.searchinterceptordeps.uisettings.md b/...ta/public/kibana-plugin-plugins-data-public.searchinterceptordeps.uisettings.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-uiSettings: CoreStart['uiSettings'];
+uiSettings: CoreSetup['uiSettings'];
 ```
diff --git a/src/plugins/data/public/mocks.ts b/src/plugins/data/public/mocks.ts
@@ -44,6 +44,7 @@ const createSetupContract = (): Setup => {
     search: searchServiceMock.createSetupContract(),
     fieldFormats: fieldFormatsServiceMock.createSetupContract(),
     query: querySetupMock,
+    __enhance: jest.fn(),
   };
 };
 

diff --git a/src/plugins/data/public/plugin.ts b/src/plugins/data/public/plugin.ts
@@ -34,6 +34,7 @@ import {
   DataSetupDependencies,
   DataStartDependencies,
   InternalStartServices,
+  DataPublicPluginEnhancements,
 } from './types';
 import { AutocompleteService } from './autocomplete';
 import { SearchService } from './search/search_service';
@@ -157,16 +158,21 @@ export class DataPublicPlugin
       }))
     );
 
+    const searchService = this.searchService.setup(core, {
+      expressions,
+      usageCollection,
+      getInternalStartServices,
+      packageInfo: this.packageInfo,
+    });
+
     return {
       autocomplete: this.autocomplete.setup(core),
-      search: this.searchService.setup(core, {
-        expressions,
-        usageCollection,
-        getInternalStartServices,
-        packageInfo: this.packageInfo,
-      }),
+      search: searchService,
       fieldFormats: this.fieldFormatsService.setup(core),
       query: queryService,
+      __enhance: (enhancements: DataPublicPluginEnhancements) => {
+        searchService.__enhance(enhancements.search);
+      },
     };
   }
 

diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -8,12 +8,12 @@ import { $Values } from '@kbn/utility-types';
 import _ from 'lodash';
 import { Action } from 'history';
 import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
-import { ApplicationStart } from 'kibana/public';
 import { Assign } from '@kbn/utility-types';
 import { BehaviorSubject } from 'rxjs';
 import Boom from 'boom';
 import { Component } from 'react';
 import { CoreSetup } from 'src/core/public';
+import { CoreSetup as CoreSetup_2 } from 'kibana/public';
 import { CoreStart } from 'kibana/public';
 import { CoreStart as CoreStart_2 } from 'src/core/public';
 import { Ensure } from '@kbn/utility-types';
@@ -65,7 +65,7 @@ import { SerializedFieldFormat as SerializedFieldFormat_2 } from 'src/plugins/ex
 import { Subscription } from 'rxjs';
 import { Toast } from 'kibana/public';
 import { ToastInputFields } from 'src/core/public/notifications';
-import { ToastsStart } from 'kibana/public';
+import { ToastsSetup } from 'kibana/public';
 import { TransportRequestOptions } from '@elastic/elasticsearch/lib/Transport';
 import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
 import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
@@ -222,6 +222,10 @@ export type CustomFilter = Filter & {
 //
 // @public (undocumented)
 export interface DataPublicPluginSetup {
+    // Warning: (ae-forgotten-export) The symbol "DataPublicPluginEnhancements" needs to be exported by the entry point index.d.ts
+    //
+    // @internal (undocumented)
+    __enhance: (enhancements: DataPublicPluginEnhancements) => void;
     // Warning: (ae-forgotten-export) The symbol "AutocompleteSetup" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -1724,15 +1728,19 @@ export interface SearchError {
 // @public (undocumented)
 export class SearchInterceptor {
     constructor(deps: SearchInterceptorDeps, requestTimeout?: number | undefined);
+    // @internal
     protected abortController: AbortController;
+    // @internal (undocumented)
+    protected application: CoreStart['application'];
     // (undocumented)
     protected readonly deps: SearchInterceptorDeps;
-    getPendingCount$: () => Observable<number>;
-    // (undocumented)
+    getPendingCount$(): Observable<number>;
+    // @internal (undocumented)
     protected hideToast: () => void;
+    // @internal
     protected longRunningToast?: Toast;
+    // @internal
     protected pendingCount$: BehaviorSubject<number>;
-    protected pendingCount: number;
     // (undocumented)
     protected readonly requestTimeout?: number | undefined;
     // (undocumented)
@@ -1743,8 +1751,9 @@ export class SearchInterceptor {
         combinedSignal: AbortSignal;
         cleanup: () => void;
     };
-    // (undocumented)
+    // @internal (undocumented)
     protected showToast: () => void;
+    // @internal
     protected timeoutSubscriptions: Subscription;
 }
 
@@ -1753,13 +1762,13 @@ export class SearchInterceptor {
 // @public (undocumented)
 export interface SearchInterceptorDeps {
     // (undocumented)
-    application: ApplicationStart;
+    http: CoreSetup_2['http'];
     // (undocumented)
-    http: CoreStart['http'];
+    startServices: Promise<[CoreStart, any, unknown]>;
     // (undocumented)
-    toasts: ToastsStart;
+    toasts: ToastsSetup;
     // (undocumented)
-    uiSettings: CoreStart['uiSettings'];
+    uiSettings: CoreSetup_2['uiSettings'];
     // Warning: (ae-forgotten-export) The symbol "SearchUsageCollector" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -1990,9 +1999,9 @@ export const UI_SETTINGS: {
 // src/plugins/data/public/index.ts:393:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/index.ts:396: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:54:5 - (ae-forgotten-export) The symbol "createFiltersFromValueClickAction" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/types.ts:55:5 - (ae-forgotten-export) The symbol "createFiltersFromRangeSelectAction" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/types.ts:63:5 - (ae-forgotten-export) The symbol "IndexPatternSelectProps" 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/types.ts:71:5 - (ae-forgotten-export) The symbol "IndexPatternSelectProps" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

diff --git a/src/plugins/data/public/search/index.ts b/src/plugins/data/public/search/index.ts
@@ -21,7 +21,14 @@ export * from './aggs';
 export * from './expressions';
 export * from './tabify';
 
-export { ISearch, ISearchOptions, ISearchGeneric, ISearchSetup, ISearchStart } from './types';
+export {
+  ISearch,
+  ISearchOptions,
+  ISearchGeneric,
+  ISearchSetup,
+  ISearchStart,
+  SearchEnhancements,
+} from './types';
 
 export { IEsSearchResponse, IEsSearchRequest, ES_SEARCH_STRATEGY } from '../../common/search';
 

diff --git a/src/plugins/data/public/search/mocks.ts b/src/plugins/data/public/search/mocks.ts
@@ -26,13 +26,13 @@ export * from './search_source/mocks';
 function createSetupContract(): jest.Mocked<ISearchSetup> {
   return {
     aggs: searchAggsSetupMock(),
+    __enhance: jest.fn(),
   };
 }
 
 function createStartContract(): jest.Mocked<ISearchStart> {
   return {
     aggs: searchAggsStartMock(),
-    setInterceptor: jest.fn(),
     search: jest.fn(),
     searchSource: searchSourceMock,
     __LEGACY: {