[data.search] Simplify poll logic and improve types

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

@@ -18,8 +18,3 @@
  */
 
 export * from './types';
-export * from './utils';
-export * from './es_search_rxjs_utils';
-export * from './shim_abort_signal';
-export * from './to_snake_case';
-export * from './get_total_loaded';

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

@@ -30,10 +30,4 @@ export interface IEsSearchRequest extends IKibanaSearchRequest<ISearchRequestPar
   indexType?: string;
 }
 
-export interface IEsRawSearchResponse<Source = any> extends SearchResponse<Source> {
-  id?: string;
-  is_partial?: boolean;
-  is_running?: boolean;
-}
-
 export type IEsSearchResponse<Source = any> = IKibanaSearchResponse<SearchResponse<Source>>;

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

@@ -24,3 +24,4 @@ export * from './search_source';
 export * from './tabify';
 export * from './types';
 export * from './session';
+export * from './utils';

src/plugins/data/common/search/es_search/to_snake_case.ts → src/plugins/data/common/search/utils.test.ts

@@ -17,8 +17,12 @@
  * under the License.
  */
 
-import { mapKeys, snakeCase } from 'lodash';
+import { isErrorResponse, isCompleteResponse, isPartialResponse } from './utils';
 
-export function toSnakeCase(obj: Record<string, any>): Record<string, any> {
-  return mapKeys(obj, (value, key) => snakeCase(key));
-}
+describe('utils', () => {
+  describe('isErrorResponse', () => {});
+
+  describe('isCompleteResponse', () => {});
+
+  describe('isPartialResponse', () => {});
+});

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

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import type { IKibanaSearchResponse } from '../types';
+import type { IKibanaSearchResponse } from './types';
 
 /**
  * @returns true if response had an error while executing in ES

src/plugins/data/public/search/errors/painless_error.tsx

@@ -25,11 +25,10 @@ import { ApplicationStart } from 'kibana/public';
 import { IEsError, isEsError } from './types';
 import { EsError } from './es_error';
 import { getRootCause } from './utils';
-import { IKibanaSearchRequest } from '..';
 
 export class PainlessError extends EsError {
   painlessStack?: string;
-  constructor(err: IEsError, request: IKibanaSearchRequest) {
+  constructor(err: IEsError) {
     super(err);
   }
 

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

@@ -94,12 +94,7 @@ export class SearchInterceptor {
    * @returns `Error` a search service specific error or the original error, if a specific error can't be recognized.
    * @internal
    */
-  protected handleSearchError(
-    e: any,
-    request: IKibanaSearchRequest,
-    timeoutSignal: AbortSignal,
-    options?: ISearchOptions
-  ): Error {
+  protected handleSearchError(e: any, timeoutSignal: AbortSignal, options?: ISearchOptions): Error {
     if (timeoutSignal.aborted || get(e, 'body.message') === 'Request timed out') {
       // Handle a client or a server side timeout
       const err = new SearchTimeoutError(e, this.getTimeoutMode());
@@ -113,7 +108,7 @@ export class SearchInterceptor {
       return e;
     } else if (isEsError(e)) {
       if (isPainlessError(e)) {
-        return new PainlessError(e, request);
+        return new PainlessError(e);
       } else {
         return new EsError(e);
       }
@@ -126,13 +121,12 @@ export class SearchInterceptor {
    * @internal
    */
   protected runSearch(
-    request: IKibanaSearchRequest,
+    { id, ...request }: IKibanaSearchRequest,
     signal: AbortSignal,
     strategy?: string
   ): Promise<IKibanaSearchResponse> {
-    const { id, ...searchRequest } = request;
     const path = trimEnd(`/internal/search/${strategy || ES_SEARCH_STRATEGY}/${id || ''}`, '/');
-    const body = JSON.stringify(searchRequest);
+    const body = JSON.stringify(request);
 
     return this.deps.http.fetch({
       method: 'POST',
@@ -236,7 +230,7 @@ export class SearchInterceptor {
       this.pendingCount$.next(this.pendingCount$.getValue() + 1);
       return from(this.runSearch(request, combinedSignal, options?.strategy)).pipe(
         catchError((e: Error) => {
-          return throwError(this.handleSearchError(e, request, timeoutSignal, options));
+          return throwError(this.handleSearchError(e, timeoutSignal, options));
         }),
         finalize(() => {
           this.pendingCount$.next(this.pendingCount$.getValue() - 1);

src/plugins/data/server/index.ts

@@ -224,27 +224,19 @@ export {
   SearchStrategyDependencies,
   getDefaultSearchParams,
   getShardTimeout,
+  getTotalLoaded,
+  toKibanaSearchResponse,
   shimHitsTotal,
   usageProvider,
+  searchUsageObserver,
+  shimAbortSignal,
   SearchUsage,
 } from './search';
 
 import { trackSearchStatus } from './search';
 
 // Search namespace
 export const search = {
-  esSearch: {
-    utils: {
-      doSearch,
-      shimAbortSignal,
-      trackSearchStatus,
-      includeTotalLoaded,
-      toKibanaSearchResponse,
-      // utils:
-      getTotalLoaded,
-      toSnakeCase,
-    },
-  },
   aggs: {
     CidrMask,
     dateHistogramInterval,

src/plugins/data/server/search/collectors/index.ts

@@ -17,4 +17,5 @@
  * under the License.
  */
 
-export { usageProvider, SearchUsage } from './usage';
+export type { SearchUsage } from './usage';
+export { usageProvider, searchUsageObserver } from './usage';

src/plugins/data/server/search/collectors/usage.ts

@@ -17,8 +17,9 @@
  * under the License.
  */
 
-import { CoreSetup } from 'kibana/server';
-import { Usage } from './register';
+import type { CoreSetup, Logger } from 'kibana/server';
+import type { IEsSearchResponse } from '../../../common';
+import type { Usage } from './register';
 
 const SAVED_OBJECT_ID = 'search-telemetry';
 
@@ -74,3 +75,19 @@ export function usageProvider(core: CoreSetup): SearchUsage {
     trackSuccess: getTracker('successCount'),
   };
 }
+
+/**
+ * Rxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain.
+ */
+export function searchUsageObserver(logger: Logger, usage?: SearchUsage) {
+  return {
+    next(response: IEsSearchResponse) {
+      logger.debug(`trackSearchStatus:next  ${response.rawResponse.took}`);
+      usage?.trackSuccess(response.rawResponse.took);
+    },
+    error() {
+      logger.debug(`trackSearchStatus:error`);
+      usage?.trackError();
+    },
+  };
+}