[data.search] Expose SearchSource on the server. (#78383)

Author: lukeelmers

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md

@@ -17,4 +17,5 @@ export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest
 |  [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md) | <code>AggsStart</code> |  |
 |  [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name: string) =&gt; ISearchStrategy&lt;SearchStrategyRequest, SearchStrategyResponse&gt;</code> | Get other registered search strategies. For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that. |
 |  [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>(context: RequestHandlerContext, request: SearchStrategyRequest, options: ISearchOptions) =&gt; Promise&lt;SearchStrategyResponse&gt;</code> |  |
+|  [searchSource](./kibana-plugin-plugins-data-server.isearchstart.searchsource.md) | <code>{</code><br/><code>        asScoped: (request: KibanaRequest) =&gt; Promise&lt;ISearchStartSearchSource&gt;;</code><br/><code>    }</code> |  |
 

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.searchsource.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchStart](./kibana-plugin-plugins-data-server.isearchstart.md) &gt; [searchSource](./kibana-plugin-plugins-data-server.isearchstart.searchsource.md)
+
+## ISearchStart.searchSource property
+
+<b>Signature:</b>
+
+```typescript
+searchSource: {
+        asScoped: (request: KibanaRequest) => Promise<ISearchStartSearchSource>;
+    };
+```

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.plugin.start.md

@@ -8,13 +8,13 @@
 
 ```typescript
 start(core: CoreStart): {
-        search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
         fieldFormats: {
             fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise<import("../common").FieldFormatsRegistry>;
         };
         indexPatterns: {
             indexPatternsServiceFactory: (kibanaRequest: import("../../../core/server").KibanaRequest<unknown, unknown, unknown, any>) => Promise<import("../public").IndexPatternsService>;
         };
+        search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
     };
 ```
 
@@ -27,12 +27,12 @@ start(core: CoreStart): {
 <b>Returns:</b>
 
 `{
-        search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
         fieldFormats: {
             fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise<import("../common").FieldFormatsRegistry>;
         };
         indexPatterns: {
             indexPatternsServiceFactory: (kibanaRequest: import("../../../core/server").KibanaRequest<unknown, unknown, unknown, any>) => Promise<import("../public").IndexPatternsService>;
         };
+        search: ISearchStart<import("./search").IEsSearchRequest, import("./search").IEsSearchResponse<any>>;
     }`
 

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

@@ -17,11 +17,12 @@
  * under the License.
  */
 
-export { SearchSource, ISearchSource, SearchSourceDependencies } from './search_source';
 export { createSearchSource } from './create_search_source';
-export { SortDirection, EsQuerySortValue, SearchSourceFields } from './types';
 export { injectReferences } from './inject_references';
 export { extractReferences } from './extract_references';
 export { parseSearchSourceJSON } from './parse_json';
 export * from './fetch';
 export * from './legacy';
+export * from './search_source';
+export * from './search_source_service';
+export * from './types';

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

@@ -0,0 +1,120 @@
+/*
+ * 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 { SavedObjectReference } from 'src/core/types';
+import { SearchSourceFields } from './types';
+
+import { injectReferences } from './inject_references';
+
+describe('injectSearchSourceReferences', () => {
+  let searchSourceJSON: SearchSourceFields & { indexRefName: string };
+  let references: SavedObjectReference[];
+
+  beforeEach(() => {
+    searchSourceJSON = {
+      highlightAll: true,
+      version: true,
+      query: {
+        query: 'play_name:"Henry IV"',
+        language: 'kuery',
+      },
+      indexRefName: 'kibanaSavedObjectMeta.searchSourceJSON.index',
+    };
+    references = [
+      {
+        name: 'kibanaSavedObjectMeta.searchSourceJSON.index',
+        type: 'index-pattern',
+        id: '033af690-fde7-11ea-91f3-fb9e73f9bbe9',
+      },
+    ];
+  });
+
+  test('injects references', () => {
+    const actual = injectReferences(searchSourceJSON, references);
+    expect(actual).toMatchInlineSnapshot(`
+      Object {
+        "highlightAll": true,
+        "index": "033af690-fde7-11ea-91f3-fb9e73f9bbe9",
+        "query": Object {
+          "language": "kuery",
+          "query": "play_name:\\"Henry IV\\"",
+        },
+        "version": true,
+      }
+    `);
+  });
+
+  test('skips injecting references if none exists', () => {
+    // @ts-expect-error
+    delete searchSourceJSON.indexRefName;
+    references = [];
+    const actual = injectReferences(searchSourceJSON, references);
+    expect(actual).toMatchInlineSnapshot(`
+      Object {
+        "highlightAll": true,
+        "query": Object {
+          "language": "kuery",
+          "query": "play_name:\\"Henry IV\\"",
+        },
+        "version": true,
+      }
+    `);
+  });
+
+  test('throws an error if there is a broken reference', () => {
+    searchSourceJSON.indexRefName = 'oops';
+    expect(() => injectReferences(searchSourceJSON, references)).toThrowErrorMatchingInlineSnapshot(
+      `"Could not find reference for oops"`
+    );
+  });
+
+  test('handles filters', () => {
+    searchSourceJSON.filter = [
+      // @ts-expect-error
+      { meta: { indexRefName: 'kibanaSavedObjectMeta.searchSourceJSON.index' } },
+    ];
+    const actual = injectReferences(searchSourceJSON, references);
+    expect(actual).toMatchInlineSnapshot(`
+      Object {
+        "filter": Array [
+          Object {
+            "meta": Object {
+              "index": "033af690-fde7-11ea-91f3-fb9e73f9bbe9",
+            },
+          },
+        ],
+        "highlightAll": true,
+        "index": "033af690-fde7-11ea-91f3-fb9e73f9bbe9",
+        "query": Object {
+          "language": "kuery",
+          "query": "play_name:\\"Henry IV\\"",
+        },
+        "version": true,
+      }
+    `);
+  });
+
+  test('throws an error if there is a broken filter reference', () => {
+    // @ts-expect-error
+    searchSourceJSON.filter = [{ meta: { indexRefName: 'oops' } }];
+    expect(() => injectReferences(searchSourceJSON, references)).toThrowErrorMatchingInlineSnapshot(
+      `"Could not find reference for oops"`
+    );
+  });
+});

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

@@ -18,15 +18,36 @@
  */
 
 import { BehaviorSubject } from 'rxjs';
+import { ApiResponse } from '@elastic/elasticsearch';
 import { SearchResponse } from 'elasticsearch';
 import { FetchHandlers, SearchRequest } from '../fetch';
 
+interface MsearchHeaders {
+  index: string;
+  preference?: number | string;
+}
+
+interface MsearchRequest {
+  header: MsearchHeaders;
+  body: any;
+}
+
+// @internal
+export interface MsearchRequestBody {
+  searches: MsearchRequest[];
+}
+
+// @internal
+export interface MsearchResponse {
+  body: ApiResponse<{ responses: Array<SearchResponse<any>> }>;
+}
+
 // @internal
 export interface LegacyFetchHandlers {
   callMsearch: (params: {
-    body: SearchRequest;
+    body: MsearchRequestBody;
     signal: AbortSignal;
-  }) => Promise<Array<SearchResponse<any>>>;
+  }) => Promise<MsearchResponse>;
   loadingCount$: BehaviorSubject<number>;
 }
 

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

@@ -20,8 +20,8 @@
 import { BehaviorSubject } from 'rxjs';
 import { uiSettingsServiceMock } from '../../../../../core/public/mocks';
 
-import { ISearchSource, SearchSource } from './search_source';
-import { SearchSourceFields } from './types';
+import { SearchSource } from './search_source';
+import { ISearchStartSearchSource, ISearchSource, SearchSourceFields } from './types';
 
 export const searchSourceInstanceMock: MockedKeys<ISearchSource> = {
   setPreferredSearchStrategyId: jest.fn(),
@@ -45,7 +45,7 @@ export const searchSourceInstanceMock: MockedKeys<ISearchSource> = {
   serialize: jest.fn(),
 };
 
-export const searchSourceMock = {
+export const searchSourceCommonMock: jest.Mocked<ISearchStartSearchSource> = {
   create: jest.fn().mockReturnValue(searchSourceInstanceMock),
   createEmpty: jest.fn().mockReturnValue(searchSourceInstanceMock),
 };

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

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { Observable, BehaviorSubject } from 'rxjs';
+import { BehaviorSubject } from 'rxjs';
 import { IndexPattern } from '../../index_patterns';
 import { GetConfigFn } from '../../types';
 import { fetchSoon } from './legacy';
@@ -53,16 +53,7 @@ describe('SearchSource', () => {
   let searchSourceDependencies: SearchSourceDependencies;
 
   beforeEach(() => {
-    mockSearchMethod = jest.fn(() => {
-      return new Observable((subscriber) => {
-        setTimeout(() => {
-          subscriber.next({
-            rawResponse: '',
-          });
-          subscriber.complete();
-        }, 100);
-      });
-    });
+    mockSearchMethod = jest.fn().mockResolvedValue({ rawResponse: '' });
 
     searchSourceDependencies = {
       getConfig: jest.fn(),

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

@@ -71,22 +71,15 @@
 
 import { setWith } from '@elastic/safer-lodash-set';
 import { uniqueId, uniq, extend, pick, difference, omit, isObject, keys, isFunction } from 'lodash';
-import { map } from 'rxjs/operators';
 import { normalizeSortRequest } from './normalize_sort_request';
 import { filterDocvalueFields } from './filter_docvalue_fields';
 import { fieldWildcardFilter } from '../../../../kibana_utils/common';
 import { IIndexPattern } from '../../index_patterns';
-import { ISearchGeneric } from '../..';
-import { SearchSourceOptions, SearchSourceFields } from './types';
+import { IEsSearchRequest, IEsSearchResponse, ISearchOptions } from '../..';
+import { ISearchSource, SearchSourceOptions, SearchSourceFields } from './types';
 import { FetchHandlers, RequestFailure, getSearchParamsFromRequest, SearchRequest } from './fetch';
 
-import {
-  getEsQueryConfig,
-  buildEsQuery,
-  Filter,
-  UI_SETTINGS,
-  ISearchOptions,
-} from '../../../common';
+import { getEsQueryConfig, buildEsQuery, Filter, UI_SETTINGS } from '../../../common';
 import { getHighlightRequest } from '../../../common/field_formats';
 import { fetchSoon } from './legacy';
 import { extractReferences } from './extract_references';
@@ -108,7 +101,7 @@ export const searchSourceRequiredUiSettings = [
 ];
 
 export interface SearchSourceDependencies extends FetchHandlers {
-  search: ISearchGeneric;
+  search: (request: IEsSearchRequest, options: ISearchOptions) => Promise<IEsSearchResponse>;
 }
 
 /** @public **/
@@ -264,7 +257,7 @@ export class SearchSource {
     if (getConfig(UI_SETTINGS.COURIER_BATCH_SEARCHES)) {
       response = await this.legacyFetch(searchRequest, options);
     } else {
-      response = await this.fetch$(searchRequest, options).toPromise();
+      response = await this.fetchSearch(searchRequest, options);
     }
 
     // TODO: Remove casting when https://github.com/elastic/elasticsearch-js/issues/1287 is resolved
@@ -308,17 +301,17 @@ export class SearchSource {
 
   /**
    * Run a search using the search service
-   * @return {Observable<SearchResponse<unknown>>}
+   * @return {Promise<SearchResponse<unknown>>}
    */
-  private fetch$(searchRequest: SearchRequest, options: ISearchOptions) {
+  private fetchSearch(searchRequest: SearchRequest, options: ISearchOptions) {
     const { search, getConfig, onResponse } = this.dependencies;
 
     const params = getSearchParamsFromRequest(searchRequest, {
       getConfig,
     });
 
-    return search({ params, indexType: searchRequest.indexType }, options).pipe(
-      map(({ rawResponse }) => onResponse(searchRequest, rawResponse))
+    return search({ params, indexType: searchRequest.indexType }, options).then(({ rawResponse }) =>
+      onResponse(searchRequest, rawResponse)
     );
   }
 
@@ -558,9 +551,3 @@ export class SearchSource {
     return [filterField];
   }
 }
-
-/**
- * search source interface
- * @public
- */
-export type ISearchSource = Pick<SearchSource, keyof SearchSource>;

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

@@ -0,0 +1,50 @@
+/*
+ * 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 { BehaviorSubject } from 'rxjs';
+import { IndexPatternsContract } from '../../index_patterns/index_patterns';
+import { SearchSourceService, SearchSourceDependencies } from './';
+
+describe('SearchSource service', () => {
+  let dependencies: jest.Mocked<SearchSourceDependencies>;
+
+  beforeEach(() => {
+    jest.resetModules();
+    dependencies = {
+      getConfig: jest.fn(),
+      search: jest.fn(),
+      onResponse: jest.fn(),
+      legacy: {
+        callMsearch: jest.fn(),
+        loadingCount$: new BehaviorSubject(0),
+      },
+    };
+  });
+
+  describe('start()', () => {
+    test('exposes proper contract', () => {
+      const start = new SearchSourceService().start(
+        (jest.fn() as unknown) as jest.Mocked<IndexPatternsContract>,
+        dependencies
+      );
+
+      expect(Object.keys(start)).toEqual(['create', 'createEmpty']);
+    });
+  });
+});