Phase 1 of search services

src/dev/jest/config.js

@@ -39,6 +39,8 @@ export default {
     '<rootDir>/test/functional/services/remote',
   ],
   collectCoverageFrom: [
+    'src/plugins/**/*.{ts,tsx}',
+    '!src/plugins/**/*.d.ts',
     'packages/kbn-ui-framework/src/components/**/*.js',
     '!packages/kbn-ui-framework/src/components/index.js',
     '!packages/kbn-ui-framework/src/components/**/*/index.js',

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

@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+
+export { IEsSearchRequest, IEsSearchResponse, ES_SEARCH_STRATEGY } from './types';

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

@@ -0,0 +1,30 @@
+/*
+ * 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 { SearchParams, SearchResponse } from 'elasticsearch';
+import { IKibanaSearchRequest, IKibanaSearchResponse } from '../types';
+
+export const ES_SEARCH_STRATEGY = 'es';
+
+export interface IEsSearchRequest extends IKibanaSearchRequest {
+  params: SearchParams;
+}
+
+export interface IEsSearchResponse<Hits = unknown> extends IKibanaSearchResponse {
+  rawResponse: SearchResponse<Hits>;
+}

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

@@ -0,0 +1,26 @@
+/*
+ * 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 { ES_SEARCH_STRATEGY } from './es_search';
+
+export { IKibanaSearchResponse, IKibanaSearchRequest } from './types';
+
+export const DEFAULT_SEARCH_STRATEGY = ES_SEARCH_STRATEGY;
+
+export { IEsSearchRequest, IEsSearchResponse, ES_SEARCH_STRATEGY } from './es_search';

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

@@ -0,0 +1,55 @@
+/*
+ * 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.
+ */
+
+export interface IKibanaSearchResponse {
+  /**
+   * Some responses may contain a unique id to identify the request this response came from.
+   */
+  id?: string;
+
+  /**
+   * If relevant to the search strategy, return a percentage
+   * that represents how progress is indicated.
+   */
+  percentComplete?: number;
+
+  /**
+   * If relevant to the search strategy, return a total number
+   * that represents how progress is indicated.
+   */
+  total?: number;
+
+  /**
+   * If relevant to the search strategy, return a loaded number
+   * that represents how progress is indicated.
+   */
+  loaded?: number;
+}
+
+export interface IKibanaSearchRequest {
+  /**
+   * An id can be used to uniquely identify this request.
+   */
+  id?: string;
+
+  /**
+   * Optionally tell search strategies to output debug information.
+   */
+  debug?: boolean;
+}

src/plugins/data/public/index.ts

@@ -31,3 +31,6 @@ export * from '../common';
 export * from './autocomplete_provider';
 
 export * from './types';
+
+export { IRequestTypesMap, IResponseTypesMap } from './search';
+export * from './search';

src/plugins/data/public/mocks.ts

@@ -17,6 +17,7 @@
  * under the License.
  */
 import { Plugin } from '.';
+import { searchSetupMock } from './search/mocks';
 
 export type Setup = jest.Mocked<ReturnType<Plugin['setup']>>;
 export type Start = jest.Mocked<ReturnType<Plugin['start']>>;
@@ -30,6 +31,7 @@ const autocompleteMock: any = {
 const createSetupContract = (): Setup => {
   const setupContract: Setup = {
     autocomplete: autocompleteMock as Setup['autocomplete'],
+    search: searchSetupMock,
   };
 
   return setupContract;
@@ -39,6 +41,7 @@ const createStartContract = (): Start => {
   const startContract: Start = {
     autocomplete: autocompleteMock as Start['autocomplete'],
     getSuggestions: jest.fn(),
+    search: { search: jest.fn() },
   };
   return startContract;
 };

src/plugins/data/public/plugin.ts

@@ -20,23 +20,29 @@
 import { PluginInitializerContext, CoreSetup, CoreStart, Plugin } from '../../../core/public';
 import { AutocompleteProviderRegister } from './autocomplete_provider';
 import { DataPublicPluginSetup, DataPublicPluginStart } from './types';
+import { SearchService } from './search/search_service';
 import { getSuggestionsProvider } from './suggestions_provider';
 
 export class DataPublicPlugin implements Plugin<DataPublicPluginSetup, DataPublicPluginStart> {
   private readonly autocomplete = new AutocompleteProviderRegister();
+  private readonly searchService: SearchService;
 
-  constructor(initializerContext: PluginInitializerContext) {}
+  constructor(initializerContext: PluginInitializerContext) {
+    this.searchService = new SearchService(initializerContext);
+  }
 
   public setup(core: CoreSetup): DataPublicPluginSetup {
     return {
       autocomplete: this.autocomplete,
+      search: this.searchService.setup(core),
     };
   }
 
   public start(core: CoreStart): DataPublicPluginStart {
     return {
       autocomplete: this.autocomplete,
       getSuggestions: getSuggestionsProvider(core.uiSettings, core.http),
+      search: this.searchService.start(core),
     };
   }
 

src/plugins/data/public/search/README.md

@@ -0,0 +1,13 @@
+# search
+
+The `search` plugin provides the ability to register search strategies that take in a request
+object, and return a response object, of a given shape.
+
+Both client side search strategies can be registered, as well as server side search strategies.
+
+The `search` plugin includes two one concrete client side implementations - 
+ `SYNC_SEARCH_STRATEGY` and `ES_SEARCH_STRATEGY` which uses `SYNC_SEARCH_STRATEGY`.  There is also one
+ default server side search strategy, `ES_SEARCH_STRATEGY`.
+
+ Includes the `esSearch` plugin in order to search for data from Elasticsearch using Elasticsearch
+DSL.

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

@@ -0,0 +1,69 @@
+/*
+ * 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 { createAppMountSearchContext } from './create_app_mount_context_search';
+import { from } from 'rxjs';
+
+describe('Create app mount search context', () => {
+  it('Returns search fn when there are no strategies', () => {
+    const context = createAppMountSearchContext({});
+    expect(context.search).toBeDefined();
+  });
+
+  it(`Search throws an error when the strategy doesn't exist`, () => {
+    const context = createAppMountSearchContext({});
+    expect(() => context.search({}, {}, 'noexist').toPromise()).toThrowErrorMatchingInlineSnapshot(
+      `"Strategy with name noexist does not exist"`
+    );
+  });
+
+  it(`Search fn is called on appropriate strategy name`, done => {
+    const context = createAppMountSearchContext({
+      mysearch: search =>
+        Promise.resolve({
+          search: () => from(Promise.resolve({ percentComplete: 98 })),
+        }),
+      anothersearch: search =>
+        Promise.resolve({
+          search: () => from(Promise.resolve({ percentComplete: 0 })),
+        }),
+    });
+
+    context.search({}, {}, 'mysearch').subscribe(response => {
+      expect(response).toEqual({ percentComplete: 98 });
+      done();
+    });
+  });
+
+  it(`Search fn is called with the passed in request object`, done => {
+    const context = createAppMountSearchContext({
+      mysearch: search => {
+        return Promise.resolve({
+          search: request => {
+            expect(request).toEqual({ greeting: 'hi' });
+            return from(Promise.resolve({}));
+          },
+        });
+      },
+    });
+    context
+      .search({ greeting: 'hi' } as any, {}, 'mysearch')
+      .subscribe(response => {}, () => {}, done);
+  });
+});

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

@@ -0,0 +1,57 @@
+/*
+ * 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 { mergeMap } from 'rxjs/operators';
+import { from } from 'rxjs';
+import { ISearchAppMountContext } from './i_search_app_mount_context';
+import { ISearchGeneric } from './i_search';
+import {
+  TSearchStrategiesMap,
+  ISearchStrategy,
+  TSearchStrategyProviderEnhanced,
+} from './i_search_strategy';
+import { TStrategyTypes } from './strategy_types';
+import { DEFAULT_SEARCH_STRATEGY } from '../../common/search';
+
+export const createAppMountSearchContext = (
+  searchStrategies: TSearchStrategiesMap
+): ISearchAppMountContext => {
+  const getSearchStrategy = <K extends TStrategyTypes = typeof DEFAULT_SEARCH_STRATEGY>(
+    strategyName?: K
+  ): Promise<ISearchStrategy<K>> => {
+    const strategyProvider = searchStrategies[
+      strategyName ? strategyName : DEFAULT_SEARCH_STRATEGY
+    ] as TSearchStrategyProviderEnhanced<K> | undefined;
+    if (!strategyProvider) {
+      throw new Error(`Strategy with name ${strategyName} does not exist`);
+    }
+    return strategyProvider(search);
+  };
+
+  const search: ISearchGeneric = (request, options, strategyName) => {
+    const strategyPromise = getSearchStrategy(strategyName);
+    return from(strategyPromise).pipe(
+      mergeMap(strategy => {
+        return strategy.search(request, options);
+      })
+    );
+  };
+
+  return { search };
+};

src/plugins/data/public/search/es_search/es_search_service.test.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { coreMock } from '../../../../../core/public/mocks';
+import { EsSearchService } from './es_search_service';
+import { CoreSetup } from '../../../../../core/public';
+import { searchSetupMock } from '../mocks';
+
+describe('ES search strategy service', () => {
+  let service: EsSearchService;
+  let mockCoreSetup: MockedKeys<CoreSetup>;
+  const opaqueId = Symbol();
+
+  beforeEach(() => {
+    service = new EsSearchService({ opaqueId });
+    mockCoreSetup = coreMock.createSetup();
+  });
+
+  describe('setup()', () => {
+    it('registers the ES search strategy', async () => {
+      service.setup(mockCoreSetup, {
+        search: searchSetupMock,
+      });
+      expect(searchSetupMock.registerSearchStrategyProvider).toBeCalled();
+    });
+  });
+});