[MD]Allow create and distinguish index pattern with same name but from different datasources

CHANGELOG.md

@@ -67,6 +67,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Multiple DataSource] Refactor test connection to support SigV4 auth type ([#3456](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3456))
 - [Darwin] Add support for Darwin for running OpenSearch snapshots with `yarn opensearch snapshot` ([#3537](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3537))
 - [Vis Builder] Add metric to metric, bucket to bucket aggregation persistence ([#3495](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3495))
+- [Multiple DataSource] Prepend data source name to index pattern title in UI to distinguish across data sources ([#3571](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/3571))
 
 ### 🐛 Bug Fixes
 

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

@@ -33,3 +33,4 @@ export * from './types';
 export { IndexPatternsService } from './index_patterns';
 export type { IndexPattern } from './index_patterns';
 export * from './errors';
+export { validateDataSourceReference, getIndexPatternTitle } from './utils';

src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts

@@ -366,7 +366,7 @@ export class IndexPattern implements IIndexPattern {
     };
   }
 
-  getSaveObjectReference() {
+  getSaveObjectReference = () => {
     return this.dataSourceRef
       ? [
           {
@@ -376,7 +376,7 @@ export class IndexPattern implements IIndexPattern {
           },
         ]
       : [];
-  }
+  };
 
   /**
    * Provide a field, get its formatter

src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts

@@ -29,6 +29,7 @@
  */
 
 import { i18n } from '@osd/i18n';
+import { DataSourceAttributes } from 'src/plugins/data_source/common/data_sources';
 import { SavedObjectsClientCommon } from '../..';
 import { createIndexPatternCache } from '.';
 import { IndexPattern } from './index_pattern';
@@ -53,7 +54,7 @@ import { FieldFormatsStartCommon } from '../../field_formats';
 import { UI_SETTINGS, SavedObject } from '../../../common';
 import { SavedObjectNotFound } from '../../../../opensearch_dashboards_utils/common';
 import { IndexPatternMissingIndices } from '../lib';
-import { findByTitle } from '../utils';
+import { findByTitle, getIndexPatternTitle } from '../utils';
 import { DuplicateIndexPatternError } from '../errors';
 
 const indexPatternCache = createIndexPatternCache();
@@ -118,8 +119,28 @@ export class IndexPatternsService {
       fields: ['title'],
       perPage: 10000,
     });
+
+    this.savedObjectsCache = await Promise.all(
+      this.savedObjectsCache.map(async (obj) => {
+        if (obj.type === 'index-pattern') {
+          const result = { ...obj };
+          result.attributes.title = await getIndexPatternTitle(
+            obj.attributes.title,
+            obj.references,
+            this.getDataSource
+          );
+          return result;
+        } else {
+          return obj;
+        }
+      })
+    );
   }
 
+  getDataSource = async (id: string) => {
+    return await this.savedObjectsClient.get<DataSourceAttributes>('data-source', id);
+  };
+
   /**
    * Get list of index pattern ids
    * @param refresh Force refresh of index pattern list
@@ -557,7 +578,11 @@ export class IndexPatternsService {
    */
 
   async createSavedObject(indexPattern: IndexPattern, override = false) {
-    const dupe = await findByTitle(this.savedObjectsClient, indexPattern.title);
+    const dupe = await findByTitle(
+      this.savedObjectsClient,
+      indexPattern.title,
+      indexPattern.dataSourceRef?.id
+    );
     if (dupe) {
       if (override) {
         await this.delete(dupe.id);

src/plugins/data/common/index_patterns/utils.ts

@@ -28,26 +28,69 @@
  * under the License.
  */
 
+import { DataSourceAttributes } from 'src/plugins/data_source/common/data_sources';
 import type { IndexPatternSavedObjectAttrs } from './index_patterns';
-import type { SavedObjectsClientCommon } from '../types';
+import type { SavedObject, SavedObjectReference, SavedObjectsClientCommon } from '../types';
 
 /**
  * Returns an object matching a given title
  *
  * @param client {SavedObjectsClientCommon}
  * @param title {string}
+ * @param dataSourceId {string}{optional}
  * @returns {Promise<SavedObject|undefined>}
  */
-export async function findByTitle(client: SavedObjectsClientCommon, title: string) {
+export async function findByTitle(
+  client: SavedObjectsClientCommon,
+  title: string,
+  dataSourceId?: string
+) {
   if (title) {
-    const savedObjects = await client.find<IndexPatternSavedObjectAttrs>({
-      type: 'index-pattern',
-      perPage: 10,
-      search: `"${title}"`,
-      searchFields: ['title'],
-      fields: ['title'],
+    const savedObjects = (
+      await client.find<IndexPatternSavedObjectAttrs>({
+        type: 'index-pattern',
+        perPage: 10,
+        search: `"${title}"`,
+        searchFields: ['title'],
+        fields: ['title'],
+      })
+    ).filter((obj) => {
+      return obj && obj.attributes && validateDataSourceReference(obj, dataSourceId);
     });
 
     return savedObjects.find((obj) => obj.attributes.title.toLowerCase() === title.toLowerCase());
   }
 }
+
+// This is used to validate datasource reference of index pattern
+export const validateDataSourceReference = (
+  indexPattern: SavedObject<any>,
+  dataSourceId?: string
+) => {
+  const references = indexPattern.references;
+  if (dataSourceId) {
+    return references.some((ref) => ref.id === dataSourceId && ref.type === 'data-source');
+  } else {
+    // No datasource id passed as input meaning we are getting index pattern from default cluster,
+    // and it's supposed to be an empty array
+    return references.length === 0;
+  }
+};
+
+export const getIndexPatternTitle = async (
+  indexPatternTitle: string,
+  references: SavedObjectReference[],
+  getDataSource: (id: string) => Promise<SavedObject<DataSourceAttributes>>
+): Promise<string> => {
+  const DELIMITER = '.';
+  // If an index-pattern references datasource, prepend data source name with index pattern name for display purpose
+  if (Array.isArray(references) && references[0] && references[0].type === 'data-source') {
+    const {
+      attributes: { title: dataSourceTitle },
+    } = await getDataSource(references[0].id);
+    return dataSourceTitle.concat(DELIMITER).concat(indexPatternTitle);
+  } else {
+    // if index pattern doesn't reference datasource, return as it is.
+    return indexPatternTitle;
+  }
+};

src/plugins/data/opensearch_dashboards.json

@@ -5,7 +5,7 @@
   "ui": true,
   "requiredPlugins": ["expressions", "uiActions"],
   "optionalPlugins": ["usageCollection", "dataSource"],
-  "extraPublicDirs": ["common", "common/utils/abort_utils"],
+  "extraPublicDirs": ["common", "common/utils/abort_utils", "common/index_patterns/utils.ts"],
   "requiredBundles": [
     "usageCollection",
     "opensearchDashboardsUtils",

src/plugins/data_source/server/routes/test_connection.ts

@@ -30,18 +30,19 @@ export const registerTestConnectionRoute = (
                   schema.literal(AuthType.NoAuth),
                   schema.literal(AuthType.SigV4),
                 ]),
-                credentials: schema.oneOf([
-                  schema.object({
-                    username: schema.string(),
-                    password: schema.string(),
-                  }),
-                  schema.object({
-                    region: schema.string(),
-                    accessKey: schema.string(),
-                    secretKey: schema.string(),
-                  }),
-                  schema.literal(null),
-                ]),
+                credentials: schema.maybe(
+                  schema.oneOf([
+                    schema.object({
+                      username: schema.string(),
+                      password: schema.string(),
+                    }),
+                    schema.object({
+                      region: schema.string(),
+                      accessKey: schema.string(),
+                      secretKey: schema.string(),
+                    }),
+                  ])
+                ),
               })
             ),
           }),

src/plugins/data_source_management/public/components/utils.ts

@@ -4,7 +4,7 @@
  */
 
 import { HttpStart, SavedObjectsClientContract } from 'src/core/public';
-import { AuthType, DataSourceAttributes, DataSourceTableItem } from '../types';
+import { DataSourceAttributes, DataSourceTableItem } from '../types';
 
 export async function getDataSources(savedObjectsClient: SavedObjectsClientContract) {
   return savedObjectsClient

src/plugins/discover/public/application/components/sidebar/discover_index_pattern.tsx

@@ -70,8 +70,10 @@ export function DiscoverIndexPattern({
   });
   useEffect(() => {
     const { id, title } = selectedIndexPattern;
-    setSelected({ id, title });
-  }, [selectedIndexPattern]);
+    const indexPattern = indexPatternList.find((pattern) => pattern.id === id);
+    const titleToDisplay = indexPattern ? indexPattern.attributes!.title : title;
+    setSelected({ id, title: titleToDisplay });
+  }, [indexPatternList, selectedIndexPattern]);
   if (!selectedId) {
     return null;
   }

src/plugins/index_pattern_management/public/components/create_index_pattern_wizard/components/step_index_pattern/step_index_pattern.tsx

@@ -55,6 +55,7 @@ import { context as contextType } from '../../../../../../opensearch_dashboards_
 import { IndexPatternCreationConfig } from '../../../../../../../plugins/index_pattern_management/public';
 import { MatchedItem, StepInfo } from '../../types';
 import { DataSourceRef, IndexPatternManagmentContextValue } from '../../../../types';
+import { validateDataSourceReference } from '../../../../../../../plugins/data/common';
 
 interface StepIndexPatternProps {
   allIndices: MatchedItem[];
@@ -131,7 +132,7 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
 
   ILLEGAL_CHARACTERS = [...indexPatterns.ILLEGAL_CHARACTERS];
 
-  dataSrouceEnabled: boolean;
+  dataSourceEnabled: boolean;
 
   constructor(props: StepIndexPatternProps, context: IndexPatternManagmentContextValue) {
     super(props, context);
@@ -140,7 +141,7 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
     this.state.query =
       initialQuery || context.services.uiSettings.get(UI_SETTINGS.INDEXPATTERN_PLACEHOLDER);
     this.state.indexPatternName = indexPatternCreationType.getIndexPatternName();
-    this.dataSrouceEnabled = context.services.dataSourceEnabled;
+    this.dataSourceEnabled = context.services.dataSourceEnabled;
   }
 
   lastQuery = '';
@@ -163,7 +164,9 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
     });
 
     const existingIndexPatterns = savedObjects.map((obj) =>
-      obj && obj.attributes ? obj.attributes.title : ''
+      obj && obj.attributes && validateDataSourceReference(obj, this.props.dataSourceRef?.id)
+        ? obj.attributes.title
+        : ''
     ) as string[];
 
     this.setState({ existingIndexPatterns });
@@ -461,7 +464,7 @@ export class StepIndexPattern extends Component<StepIndexPatternProps, StepIndex
         {this.renderStatusMessage(matchedIndices)}
         <EuiSpacer />
         {this.renderList(matchedIndices)}
-        {this.dataSrouceEnabled && this.renderGoToPrevious()}
+        {this.dataSourceEnabled && this.renderGoToPrevious()}
       </>
     );
   }

src/plugins/saved_objects/public/finder/saved_object_finder.tsx

@@ -60,6 +60,8 @@ import {
   SavedObjectsStart,
 } from 'src/core/public';
 
+import { DataSourceAttributes } from 'src/plugins/data_source/common/data_sources';
+import { getIndexPatternTitle } from '../../../data/common/index_patterns/utils';
 import { LISTING_LIMIT_SETTING } from '../../common';
 
 export interface SavedObjectMetaData<T = unknown> {
@@ -155,7 +157,28 @@ class SavedObjectFinderUi extends React.Component<
       defaultSearchOperator: 'AND',
     });
 
-    resp.savedObjects = resp.savedObjects.filter((savedObject) => {
+    const getDataSource = async (id: string) => {
+      const client = this.props.savedObjects.client;
+      return await client.get<DataSourceAttributes>('data-source', id);
+    };
+
+    const savedObjects = await Promise.all(
+      resp.savedObjects.map(async (obj) => {
+        if (obj.type === 'index-pattern') {
+          const result = { ...obj };
+          result.attributes.title = await getIndexPatternTitle(
+            obj.attributes.title!,
+            obj.references,
+            getDataSource
+          );
+          return result;
+        } else {
+          return obj;
+        }
+      })
+    );
+
+    resp.savedObjects = savedObjects.filter((savedObject) => {
       const metaData = metaDataMap[savedObject.type];
       if (metaData.showSavedObject) {
         return metaData.showSavedObject(savedObject);

src/plugins/saved_objects_management/server/routes/find.ts

@@ -30,6 +30,8 @@
 
 import { schema } from '@osd/config-schema';
 import { IRouter } from 'src/core/server';
+import { DataSourceAttributes } from 'src/plugins/data_source/common/data_sources';
+import { getIndexPatternTitle } from '../../../data/common/index_patterns/utils';
 import { injectMetaAttributes } from '../lib';
 import { ISavedObjectsManagement } from '../services';
 
@@ -84,13 +86,33 @@ export const registerFindRoute = (
         }
       });
 
+      const getDataSource = async (id: string) => {
+        return await client.get<DataSourceAttributes>('data-source', id);
+      };
+
       const findResponse = await client.find<any>({
         ...req.query,
         fields: undefined,
         searchFields: [...searchFields],
       });
 
-      const enhancedSavedObjects = findResponse.saved_objects
+      const savedObjects = await Promise.all(
+        findResponse.saved_objects.map(async (obj) => {
+          if (obj.type === 'index-pattern') {
+            const result = { ...obj };
+            result.attributes.title = await getIndexPatternTitle(
+              obj.attributes.title,
+              obj.references,
+              getDataSource
+            );
+            return result;
+          } else {
+            return obj;
+          }
+        })
+      );
+
+      const enhancedSavedObjects = savedObjects
         .map((so) => injectMetaAttributes(so, managementService))
         .map((obj) => {
           const result = { ...obj, attributes: {} as Record<string, any> };