Integrate index pattern with new data client (opensearch-project#2146)

Signed-off-by: Kristen Tian <tyarong@amazon.com>
kristenTian · Sep 15, 2022 · 0a34341 · 0a34341
1 parent 72d9b1a
commit 0a34341
Show file tree

Hide file tree

Showing 15 changed files with 155 additions and 44 deletions.
diff --git a/...ugins/data/common/index_patterns/index_patterns/__snapshots__/index_patterns.test.ts.snap b/...ugins/data/common/index_patterns/index_patterns/__snapshots__/index_patterns.test.ts.snap
diff --git a/src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts b/src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts
@@ -29,8 +29,8 @@
  */
 
 import { i18n } from '@osd/i18n';
+import _ from 'lodash';
 import { SavedObjectsClientCommon } from '../..';
-
 import { createIndexPatternCache } from '.';
 import { IndexPattern } from './index_pattern';
 import {
@@ -238,6 +238,7 @@ export class IndexPatternsService {
       metaFields,
       type: options.type,
       params: options.params || {},
+      dataSourceId: options.dataSourceId,
     });
   };
 
@@ -254,6 +255,7 @@ export class IndexPatternsService {
       ...options,
       type: indexPattern.type,
       params: indexPattern.typeMeta && indexPattern.typeMeta.params,
+      dataSourceId: indexPattern.dataSourceRef?.id,
     });
 
   /**
@@ -355,12 +357,14 @@ export class IndexPatternsService {
         typeMeta,
         type,
       },
+      references,
     } = savedObject;
 
     const parsedSourceFilters = sourceFilters ? JSON.parse(sourceFilters) : undefined;
     const parsedTypeMeta = typeMeta ? JSON.parse(typeMeta) : undefined;
     const parsedFieldFormatMap = fieldFormatMap ? JSON.parse(fieldFormatMap) : {};
     const parsedFields: FieldSpec[] = fields ? JSON.parse(fields) : [];
+    const dataSourceRef = !_.isEmpty(references) ? references[0] : undefined;
 
     this.addFormatsToFields(parsedFields, parsedFieldFormatMap);
     return {
@@ -373,6 +377,7 @@ export class IndexPatternsService {
       fields: this.fieldArrayToMap(parsedFields),
       typeMeta: parsedTypeMeta,
       type,
+      dataSourceRef,
     };
   };
 
@@ -401,7 +406,7 @@ export class IndexPatternsService {
     }
 
     const spec = this.savedObjectToSpec(savedObject);
-    const { title, type, typeMeta } = spec;
+    const { title, type, typeMeta, dataSourceRef } = spec;
     const parsedFieldFormats: FieldFormatMap = savedObject.attributes.fieldFormatMap
       ? JSON.parse(savedObject.attributes.fieldFormatMap)
       : {};
@@ -415,6 +420,7 @@ export class IndexPatternsService {
             metaFields: await this.config.get(UI_SETTINGS.META_FIELDS),
             type,
             params: typeMeta && typeMeta.params,
+            dataSourceId: dataSourceRef?.id,
           })
         : spec.fields;
     } catch (err) {

diff --git a/src/plugins/data/common/index_patterns/types.ts b/src/plugins/data/common/index_patterns/types.ts
@@ -113,6 +113,7 @@ export interface GetFieldsOptions {
   params?: any;
   lookBack?: boolean;
   metaFields?: string[];
+  dataSourceId?: string;
 }
 
 export interface IIndexPatternsApiClient {

diff --git a/src/plugins/data/public/index_patterns/index_patterns/index_patterns_api_client.ts b/src/plugins/data/public/index_patterns/index_patterns/index_patterns_api_client.ts
@@ -60,19 +60,20 @@ export class IndexPatternsApiClient implements IIndexPatternsApiClient {
   }
 
   getFieldsForTimePattern(options: GetFieldsOptions = {}) {
-    const { pattern, lookBack, metaFields } = options;
+    const { pattern, lookBack, metaFields, dataSourceId } = options;
 
     const url = this._getUrl(['_fields_for_time_pattern']);
 
     return this._request(url, {
       pattern,
       look_back: lookBack,
       meta_fields: metaFields,
+      data_source: dataSourceId,
     }).then((resp: any) => resp.fields);
   }
 
   getFieldsForWildcard(options: GetFieldsOptions = {}) {
-    const { pattern, metaFields, type, params } = options;
+    const { pattern, metaFields, type, params, dataSourceId } = options;
 
     let url;
     let query;
@@ -83,12 +84,14 @@ export class IndexPatternsApiClient implements IIndexPatternsApiClient {
         pattern,
         meta_fields: metaFields,
         params: JSON.stringify(params),
+        data_source: dataSourceId,
       };
     } else {
       url = this._getUrl(['_fields_for_wildcard']);
       query = {
         pattern,
         meta_fields: metaFields,
+        data_source: dataSourceId,
       };
     }
 

diff --git a/src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts b/src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts
@@ -28,7 +28,7 @@
  * under the License.
  */
 
-import { LegacyAPICaller } from 'opensearch-dashboards/server';
+import { LegacyAPICaller, OpenSearchClient } from 'opensearch-dashboards/server';
 
 import { getFieldCapabilities, resolveTimePattern, createNoMatchingIndicesError } from './lib';
 
@@ -48,9 +48,9 @@ interface FieldSubType {
 }
 
 export class IndexPatternsFetcher {
-  private _callDataCluster: LegacyAPICaller;
+  private _callDataCluster: LegacyAPICaller | OpenSearchClient;
 
-  constructor(callDataCluster: LegacyAPICaller) {
+  constructor(callDataCluster: LegacyAPICaller | OpenSearchClient) {
     this._callDataCluster = callDataCluster;
   }
 

diff --git a/src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/field_capabilities.ts b/src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/field_capabilities.ts
@@ -30,7 +30,7 @@
 
 import { defaults, keyBy, sortBy } from 'lodash';
 
-import { LegacyAPICaller } from 'opensearch-dashboards/server';
+import { LegacyAPICaller, OpenSearchClient } from 'opensearch-dashboards/server';
 import { callFieldCapsApi } from '../opensearch_api';
 import { FieldCapsResponse, readFieldCapsResponse } from './field_caps_response';
 import { mergeOverrides } from './overrides';
@@ -47,7 +47,7 @@ import { FieldDescriptor } from '../../index_patterns_fetcher';
  *  @return {Promise<Array<FieldDescriptor>>}
  */
 export async function getFieldCapabilities(
-  callCluster: LegacyAPICaller,
+  callCluster: LegacyAPICaller | OpenSearchClient,
   indices: string | string[] = [],
   metaFields: string[] = [],
   fieldCapsOptions?: { allowNoIndices: boolean }

diff --git a/src/plugins/data/server/index_patterns/fetcher/lib/opensearch_api.ts b/src/plugins/data/server/index_patterns/fetcher/lib/opensearch_api.ts
@@ -28,7 +28,7 @@
  * under the License.
  */
 
-import { LegacyAPICaller } from 'opensearch-dashboards/server';
+import { LegacyAPICaller, OpenSearchClient } from 'opensearch-dashboards/server';
 import { convertOpenSearchError } from './errors';
 import { FieldCapsResponse } from './field_capabilities';
 
@@ -57,10 +57,18 @@ export interface IndexAliasResponse {
  *  @return {Promise<IndexAliasResponse>}
  */
 export async function callIndexAliasApi(
-  callCluster: LegacyAPICaller,
+  callCluster: LegacyAPICaller | OpenSearchClient,
   indices: string[] | string
 ): Promise<IndicesAliasResponse> {
   try {
+    if ('transport' in callCluster) {
+      return ((await callCluster.indices.getAlias({
+        index: indices,
+        ignore_unavailable: true,
+        allow_no_indices: true,
+      })) as unknown) as Promise<IndicesAliasResponse>; // todo: Pending #... verify test
+    }
+
     return (await callCluster('indices.getAlias', {
       index: indices,
       ignoreUnavailable: true,
@@ -84,11 +92,20 @@ export async function callIndexAliasApi(
  *  @return {Promise<FieldCapsResponse>}
  */
 export async function callFieldCapsApi(
-  callCluster: LegacyAPICaller,
+  callCluster: LegacyAPICaller | OpenSearchClient,
   indices: string[] | string,
   fieldCapsOptions: { allowNoIndices: boolean } = { allowNoIndices: false }
 ) {
   try {
+    if ('transport' in callCluster) {
+      return ((await callCluster.fieldCaps({
+        index: indices,
+        fields: '*',
+        ignore_unavailable: true,
+        allow_no_indices: fieldCapsOptions.allowNoIndices,
+      })) as unknown) as FieldCapsResponse; // todo: Pending #... verify test
+    }
+
     return (await callCluster('fieldCaps', {
       index: indices,
       fields: '*',

diff --git a/src/plugins/data/server/index_patterns/fetcher/lib/resolve_time_pattern.ts b/src/plugins/data/server/index_patterns/fetcher/lib/resolve_time_pattern.ts
@@ -31,7 +31,7 @@
 import { chain } from 'lodash';
 import moment from 'moment';
 
-import { LegacyAPICaller } from 'opensearch-dashboards/server';
+import { LegacyAPICaller, OpenSearchClient } from 'opensearch-dashboards/server';
 
 import { timePatternToWildcard } from './time_pattern_to_wildcard';
 import { callIndexAliasApi, IndicesAliasResponse } from './opensearch_api';
@@ -47,7 +47,10 @@ import { callIndexAliasApi, IndicesAliasResponse } from './opensearch_api';
  *                            and the indices that actually match the time
  *                            pattern (matches);
  */
-export async function resolveTimePattern(callCluster: LegacyAPICaller, timePattern: string) {
+export async function resolveTimePattern(
+  callCluster: LegacyAPICaller | OpenSearchClient,
+  timePattern: string
+) {
   const aliases = await callIndexAliasApi(callCluster, timePatternToWildcard(timePattern));
 
   const allIndexDetails = chain<IndicesAliasResponse>(aliases)

diff --git a/src/plugins/data/server/index_patterns/routes.ts b/src/plugins/data/server/index_patterns/routes.ts
@@ -53,11 +53,12 @@ export function registerRoutes(http: HttpServiceSetup) {
           meta_fields: schema.oneOf([schema.string(), schema.arrayOf(schema.string())], {
             defaultValue: [],
           }),
+          data_source: schema.maybe(schema.string()),
         }),
       },
     },
     async (context, request, response) => {
-      const { callAsCurrentUser } = context.core.opensearch.legacy.client;
+      const callAsCurrentUser = decideClient(context, request);
       const indexPatterns = new IndexPatternsFetcher(callAsCurrentUser);
       const { pattern, meta_fields: metaFields } = request.query;
 
@@ -112,11 +113,13 @@ export function registerRoutes(http: HttpServiceSetup) {
           meta_fields: schema.oneOf([schema.string(), schema.arrayOf(schema.string())], {
             defaultValue: [],
           }),
+          data_source: schema.maybe(schema.string()),
         }),
       },
     },
     async (context: RequestHandlerContext, request: any, response: any) => {
-      const { callAsCurrentUser } = context.core.opensearch.legacy.client;
+      const callAsCurrentUser = decideClient(context, request);
+
       const indexPatterns = new IndexPatternsFetcher(callAsCurrentUser);
       const { pattern, interval, look_back: lookBack, meta_fields: metaFields } = request.query;
 
@@ -147,3 +150,11 @@ export function registerRoutes(http: HttpServiceSetup) {
     }
   );
 }
+
+const decideClient = (context: RequestHandlerContext, request: any) => {
+  if (request.query.data_source) {
+    // todo: # Pending
+  }
+
+  return context.core.opensearch.legacy.client.callAsCurrentUser;
+};
diff --git a/...mponents/create_index_pattern_wizard/components/step_index_pattern/step_index_pattern.tsx b/...mponents/create_index_pattern_wizard/components/step_index_pattern/step_index_pattern.tsx
@@ -54,7 +54,7 @@ import { Header } from './components/header';
 import { context as contextType } from '../../../../../../opensearch_dashboards_react/public';
 import { IndexPatternCreationConfig } from '../../../../../../../plugins/index_pattern_management/public';
 import { MatchedItem } from '../../types';
-import { IndexPatternManagmentContextValue } from '../../../../types';
+import { DataSourceRef, IndexPatternManagmentContextValue } from '../../../../types';
 
 interface StepIndexPatternProps {
   allIndices: MatchedItem[];
@@ -63,6 +63,7 @@ interface StepIndexPatternProps {
   goToNextStep: (query: string, timestampField?: string) => void;
   initialQuery?: string;
   showSystemIndices: boolean;
+  dataSourceRef?: DataSourceRef;
 }
 
 interface StepIndexPatternState {
@@ -163,7 +164,8 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
   };
 
   fetchIndices = async (query: string) => {
-    const { indexPatternCreationType } = this.props;
+    const { indexPatternCreationType, dataSourceRef } = this.props;
+    const dataSourceId = dataSourceRef?.id;
     const { existingIndexPatterns } = this.state;
     const { http } = this.context.services;
     const getIndexTags = (indexName: string) => indexPatternCreationType.getIndexTags(indexName);
@@ -179,7 +181,14 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
 
     if (query.endsWith('*')) {
       const exactMatchedIndices = await ensureMinimumTime(
-        getIndices({ http, getIndexTags, pattern: query, showAllIndices, searchClient })
+        getIndices({
+          http,
+          getIndexTags,
+          pattern: query,
+          showAllIndices,
+          searchClient,
+          dataSourceId,
+        })
       );
       // If the search changed, discard this state
       if (query !== this.lastQuery) {
@@ -190,8 +199,22 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
     }
 
     const [partialMatchedIndices, exactMatchedIndices] = await ensureMinimumTime([
-      getIndices({ http, getIndexTags, pattern: `${query}*`, showAllIndices, searchClient }),
-      getIndices({ http, getIndexTags, pattern: query, showAllIndices, searchClient }),
+      getIndices({
+        http,
+        getIndexTags,
+        pattern: `${query}*`,
+        showAllIndices,
+        searchClient,
+        dataSourceId,
+      }),
+      getIndices({
+        http,
+        getIndexTags,
+        pattern: query,
+        showAllIndices,
+        searchClient,
+        dataSourceId,
+      }),
     ]);
 
     // If the search changed, discard this state

diff --git a/...lic/components/create_index_pattern_wizard/components/step_time_field/step_time_field.tsx b/...lic/components/create_index_pattern_wizard/components/step_time_field/step_time_field.tsx
@@ -46,7 +46,7 @@ import { TimeField } from './components/time_field';
 import { AdvancedOptions } from './components/advanced_options';
 import { ActionButtons } from './components/action_buttons';
 import { context } from '../../../../../../opensearch_dashboards_react/public';
-import { IndexPatternManagmentContextValue } from '../../../../types';
+import { DataSourceRef, IndexPatternManagmentContextValue } from '../../../../types';
 import { IndexPatternCreationConfig } from '../../../..';
 
 interface StepTimeFieldProps {
@@ -55,6 +55,7 @@ interface StepTimeFieldProps {
   createIndexPattern: (selectedTimeField: string | undefined, indexPatternId: string) => void;
   indexPatternCreationType: IndexPatternCreationConfig;
   selectedTimeField?: string;
+  dataSourceRef?: DataSourceRef;
 }
 
 interface StepTimeFieldState {
@@ -116,14 +117,15 @@ export class StepTimeField extends Component<StepTimeFieldProps, StepTimeFieldSt
   }
 
   fetchTimeFields = async () => {
-    const { indexPattern: pattern } = this.props;
+    const { indexPattern: pattern, dataSourceRef } = this.props;
     const { getFetchForWildcardOptions } = this.props.indexPatternCreationType;
 
     this.setState({ isFetchingTimeFields: true });
     const fields = await ensureMinimumTime(
       this.context.services.data.indexPatterns.getFieldsForWildcard({
         pattern,
         ...getFetchForWildcardOptions(),
+        dataSourceId: dataSourceRef?.id,
       })
     );
     const timeFields = extractTimeFields(fields);