Index Patterns API - Remove legacy es client usage for field caps

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsfetcher._constructor_.md

@@ -9,12 +9,13 @@ Constructs a new instance of the `IndexPatternsFetcher` class
 <b>Signature:</b>
 
 ```typescript
-constructor(callDataCluster: LegacyAPICaller);
+constructor(elasticsearchClient: ElasticsearchClient, allowNoIndices?: boolean);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  callDataCluster | <code>LegacyAPICaller</code> |  |
+|  elasticsearchClient | <code>ElasticsearchClient</code> |  |
+|  allowNoIndices | <code>boolean</code> |  |
 

docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpatternsfetcher.getfieldsforwildcard.md

@@ -13,7 +13,7 @@ getFieldsForWildcard(options: {
         pattern: string | string[];
         metaFields?: string[];
         fieldCapsOptions?: {
-            allowNoIndices: boolean;
+            allow_no_indices: boolean;
         };
     }): Promise<FieldDescriptor[]>;
 ```
@@ -22,7 +22,7 @@ getFieldsForWildcard(options: {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | <code>{</code><br/><code>        pattern: string &#124; string[];</code><br/><code>        metaFields?: string[];</code><br/><code>        fieldCapsOptions?: {</code><br/><code>            allowNoIndices: boolean;</code><br/><code>        };</code><br/><code>    }</code> |  |
+|  options | <code>{</code><br/><code>        pattern: string &#124; string[];</code><br/><code>        metaFields?: string[];</code><br/><code>        fieldCapsOptions?: {</code><br/><code>            allow_no_indices: boolean;</code><br/><code>        };</code><br/><code>    }</code> |  |
 
 <b>Returns:</b>
 

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

@@ -14,7 +14,7 @@ export declare class IndexPatternsFetcher
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(callDataCluster)](./kibana-plugin-plugins-data-server.indexpatternsfetcher._constructor_.md) |  | Constructs a new instance of the <code>IndexPatternsFetcher</code> class |
+|  [(constructor)(elasticsearchClient, allowNoIndices)](./kibana-plugin-plugins-data-server.indexpatternsfetcher._constructor_.md) |  | Constructs a new instance of the <code>IndexPatternsFetcher</code> class |
 
 ## Methods
 

src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { LegacyAPICaller } from 'kibana/server';
+import { ElasticsearchClient } from 'kibana/server';
 
 import { getFieldCapabilities, resolveTimePattern, createNoMatchingIndicesError } from './lib';
 
@@ -37,10 +37,12 @@ interface FieldSubType {
 }
 
 export class IndexPatternsFetcher {
-  private _callDataCluster: LegacyAPICaller;
+  private elasticsearchClient: ElasticsearchClient;
+  private allowNoIndices: boolean;
 
-  constructor(callDataCluster: LegacyAPICaller) {
-    this._callDataCluster = callDataCluster;
+  constructor(elasticsearchClient: ElasticsearchClient, allowNoIndices: boolean = false) {
+    this.elasticsearchClient = elasticsearchClient;
+    this.allowNoIndices = allowNoIndices;
   }
 
   /**
@@ -55,10 +57,12 @@ export class IndexPatternsFetcher {
   async getFieldsForWildcard(options: {
     pattern: string | string[];
     metaFields?: string[];
-    fieldCapsOptions?: { allowNoIndices: boolean };
+    fieldCapsOptions?: { allow_no_indices: boolean };
   }): Promise<FieldDescriptor[]> {
     const { pattern, metaFields, fieldCapsOptions } = options;
-    return await getFieldCapabilities(this._callDataCluster, pattern, metaFields, fieldCapsOptions);
+    return await getFieldCapabilities(this.elasticsearchClient, pattern, metaFields, {
+      allow_no_indices: fieldCapsOptions ? fieldCapsOptions.allow_no_indices : this.allowNoIndices,
+    });
   }
 
   /**
@@ -78,11 +82,11 @@ export class IndexPatternsFetcher {
     interval: string;
   }) {
     const { pattern, lookBack, metaFields } = options;
-    const { matches } = await resolveTimePattern(this._callDataCluster, pattern);
+    const { matches } = await resolveTimePattern(this.elasticsearchClient, pattern);
     const indices = matches.slice(0, lookBack);
     if (indices.length === 0) {
       throw createNoMatchingIndicesError(pattern);
     }
-    return await getFieldCapabilities(this._callDataCluster, indices, metaFields);
+    return await getFieldCapabilities(this.elasticsearchClient, indices, metaFields);
   }
 }

src/plugins/data/server/index_patterns/fetcher/lib/es_api.test.js

@@ -32,36 +32,60 @@ describe('server/index_patterns/service/lib/es_api', () => {
     afterEach(() => sandbox.restore());
 
     it('calls indices.getAlias() via callCluster', async () => {
-      const callCluster = sinon.stub();
+      const getAlias = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias,
+        },
+        fieldCaps: sinon.stub(),
+      };
+
       await callIndexAliasApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
-      sinon.assert.calledWith(callCluster, 'indices.getAlias');
+      sinon.assert.calledOnce(getAlias);
     });
 
     it('passes indices directly to es api', async () => {
       const football = {};
-      const callCluster = sinon.stub();
+      const getAlias = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias,
+        },
+        fieldCaps: sinon.stub(),
+      };
       await callIndexAliasApi(callCluster, football);
-      sinon.assert.calledOnce(callCluster);
-      expect(callCluster.args[0][1].index).toBe(football);
+      sinon.assert.calledOnce(getAlias);
+      expect(getAlias.args[0][0].index).toBe(football);
     });
 
     it('returns the es response directly', async () => {
       const football = {};
-      const callCluster = sinon.stub().returns(football);
+      const getAlias = sinon.stub().returns(football);
+      const callCluster = {
+        indices: {
+          getAlias,
+        },
+        fieldCaps: sinon.stub(),
+      };
       const resp = await callIndexAliasApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
+      sinon.assert.calledOnce(getAlias);
       expect(resp).toBe(football);
     });
 
     it('sets ignoreUnavailable and allowNoIndices params', async () => {
-      const callCluster = sinon.stub();
+      const getAlias = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias,
+        },
+        fieldCaps: sinon.stub(),
+      };
       await callIndexAliasApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
+      sinon.assert.calledOnce(getAlias);
 
-      const passedOpts = callCluster.args[0][1];
-      expect(passedOpts).toHaveProperty('ignoreUnavailable', true);
-      expect(passedOpts).toHaveProperty('allowNoIndices', false);
+      const passedOpts = getAlias.args[0][0];
+      expect(passedOpts).toHaveProperty('ignore_unavailable', true);
+      expect(passedOpts).toHaveProperty('allow_no_indices', false);
     });
 
     it('handles errors with convertEsError()', async () => {
@@ -70,9 +94,15 @@ describe('server/index_patterns/service/lib/es_api', () => {
       const convertedError = new Error('convertedError');
 
       sandbox.stub(convertEsErrorNS, 'convertEsError').throws(convertedError);
-      const callCluster = sinon.spy(async () => {
+      const getAlias = sinon.stub(async () => {
         throw esError;
       });
+      const callCluster = {
+        indices: {
+          getAlias,
+        },
+        fieldCaps: sinon.stub(),
+      };
       try {
         await callIndexAliasApi(callCluster, indices);
         throw new Error('expected callIndexAliasApi() to throw');
@@ -91,37 +121,60 @@ describe('server/index_patterns/service/lib/es_api', () => {
     afterEach(() => sandbox.restore());
 
     it('calls fieldCaps() via callCluster', async () => {
-      const callCluster = sinon.stub();
+      const fieldCaps = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias: sinon.stub(),
+        },
+        fieldCaps,
+      };
       await callFieldCapsApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
-      sinon.assert.calledWith(callCluster, 'fieldCaps');
+      sinon.assert.calledOnce(fieldCaps);
     });
 
     it('passes indices directly to es api', async () => {
       const football = {};
-      const callCluster = sinon.stub();
+      const fieldCaps = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias: sinon.stub(),
+        },
+        fieldCaps,
+      };
       await callFieldCapsApi(callCluster, football);
-      sinon.assert.calledOnce(callCluster);
-      expect(callCluster.args[0][1].index).toBe(football);
+      sinon.assert.calledOnce(fieldCaps);
+      expect(fieldCaps.args[0][0].index).toBe(football);
     });
 
     it('returns the es response directly', async () => {
       const football = {};
-      const callCluster = sinon.stub().returns(football);
+      const fieldCaps = sinon.stub().returns(football);
+      const callCluster = {
+        indices: {
+          getAlias: sinon.stub(),
+        },
+        fieldCaps,
+      };
       const resp = await callFieldCapsApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
+      sinon.assert.calledOnce(fieldCaps);
       expect(resp).toBe(football);
     });
 
     it('sets ignoreUnavailable, allowNoIndices, and fields params', async () => {
-      const callCluster = sinon.stub();
+      const fieldCaps = sinon.stub();
+      const callCluster = {
+        indices: {
+          getAlias: sinon.stub(),
+        },
+        fieldCaps,
+      };
       await callFieldCapsApi(callCluster);
-      sinon.assert.calledOnce(callCluster);
+      sinon.assert.calledOnce(fieldCaps);
 
-      const passedOpts = callCluster.args[0][1];
+      const passedOpts = fieldCaps.args[0][0];
       expect(passedOpts).toHaveProperty('fields', '*');
-      expect(passedOpts).toHaveProperty('ignoreUnavailable', true);
-      expect(passedOpts).toHaveProperty('allowNoIndices', false);
+      expect(passedOpts).toHaveProperty('ignore_unavailable', true);
+      expect(passedOpts).toHaveProperty('allow_no_indices', false);
     });
 
     it('handles errors with convertEsError()', async () => {
@@ -130,9 +183,15 @@ describe('server/index_patterns/service/lib/es_api', () => {
       const convertedError = new Error('convertedError');
 
       sandbox.stub(convertEsErrorNS, 'convertEsError').throws(convertedError);
-      const callCluster = sinon.spy(async () => {
+      const fieldCaps = sinon.spy(async () => {
         throw esError;
       });
+      const callCluster = {
+        indices: {
+          getAlias: sinon.stub(),
+        },
+        fieldCaps,
+      };
       try {
         await callFieldCapsApi(callCluster, indices);
         throw new Error('expected callFieldCapsApi() to throw');

src/plugins/data/server/index_patterns/fetcher/lib/es_api.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { LegacyAPICaller } from 'kibana/server';
+import { ElasticsearchClient } from 'kibana/server';
 import { convertEsError } from './errors';
 import { FieldCapsResponse } from './field_capabilities';
 
@@ -46,15 +46,15 @@ export interface IndexAliasResponse {
  *  @return {Promise<IndexAliasResponse>}
  */
 export async function callIndexAliasApi(
-  callCluster: LegacyAPICaller,
+  callCluster: ElasticsearchClient,
   indices: string[] | string
-): Promise<IndicesAliasResponse> {
+) {
   try {
-    return (await callCluster('indices.getAlias', {
+    return await callCluster.indices.getAlias({
       index: indices,
-      ignoreUnavailable: true,
-      allowNoIndices: false,
-    })) as Promise<IndicesAliasResponse>;
+      ignore_unavailable: true,
+      allow_no_indices: false,
+    });
   } catch (error) {
     throw convertEsError(indices, error);
   }
@@ -73,17 +73,17 @@ export async function callIndexAliasApi(
  *  @return {Promise<FieldCapsResponse>}
  */
 export async function callFieldCapsApi(
-  callCluster: LegacyAPICaller,
+  callCluster: ElasticsearchClient,
   indices: string[] | string,
-  fieldCapsOptions: { allowNoIndices: boolean } = { allowNoIndices: false }
+  fieldCapsOptions: { allow_no_indices: boolean } = { allow_no_indices: false }
 ) {
   try {
-    return (await callCluster('fieldCaps', {
+    return await callCluster.fieldCaps<FieldCapsResponse>({
       index: indices,
       fields: '*',
-      ignoreUnavailable: true,
+      ignore_unavailable: true,
       ...fieldCapsOptions,
-    })) as FieldCapsResponse;
+    });
   } catch (error) {
     throw convertEsError(indices, error);
   }

src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/field_capabilities.test.js

@@ -48,9 +48,11 @@ describe('index_patterns/field_capabilities/field_capabilities', () => {
   };
 
   const stubDeps = (options = {}) => {
-    const { esResponse = {}, fieldsFromFieldCaps = [], mergeOverrides = identity } = options;
+    const { esResponse = [], fieldsFromFieldCaps = [], mergeOverrides = identity } = options;
 
-    sandbox.stub(callFieldCapsApiNS, 'callFieldCapsApi').callsFake(async () => esResponse);
+    sandbox
+      .stub(callFieldCapsApiNS, 'callFieldCapsApi')
+      .callsFake(async () => ({ body: esResponse }));
     sandbox.stub(readFieldCapsResponseNS, 'readFieldCapsResponse').returns(fieldsFromFieldCaps);
     sandbox.stub(mergeOverridesNS, 'mergeOverrides').callsFake(mergeOverrides);
   };

src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/field_capabilities.ts

@@ -19,9 +19,9 @@
 
 import { defaults, keyBy, sortBy } from 'lodash';
 
-import { LegacyAPICaller } from 'kibana/server';
+import { ElasticsearchClient } from 'kibana/server';
 import { callFieldCapsApi } from '../es_api';
-import { FieldCapsResponse, readFieldCapsResponse } from './field_caps_response';
+import { readFieldCapsResponse } from './field_caps_response';
 import { mergeOverrides } from './overrides';
 import { FieldDescriptor } from '../../index_patterns_fetcher';
 
@@ -36,17 +36,13 @@ import { FieldDescriptor } from '../../index_patterns_fetcher';
  *  @return {Promise<Array<FieldDescriptor>>}
  */
 export async function getFieldCapabilities(
-  callCluster: LegacyAPICaller,
+  callCluster: ElasticsearchClient,
   indices: string | string[] = [],
   metaFields: string[] = [],
-  fieldCapsOptions?: { allowNoIndices: boolean }
+  fieldCapsOptions?: { allow_no_indices: boolean }
 ) {
-  const esFieldCaps: FieldCapsResponse = await callFieldCapsApi(
-    callCluster,
-    indices,
-    fieldCapsOptions
-  );
-  const fieldsFromFieldCapsByName = keyBy(readFieldCapsResponse(esFieldCaps), 'name');
+  const esFieldCaps = await callFieldCapsApi(callCluster, indices, fieldCapsOptions);
+  const fieldsFromFieldCapsByName = keyBy(readFieldCapsResponse(esFieldCaps.body), 'name');
 
   const allFieldsUnsorted = Object.keys(fieldsFromFieldCapsByName)
     .filter((name) => !name.startsWith('_'))