[Backport 2.x] [discover] S3 data connection

changelogs/fragments/7917.yml

@@ -0,0 +1,2 @@
+feat:
+- Add S3 data exploration for connections, databases, and tables ([#7917](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7917))

src/plugins/data/common/constants.ts

@@ -38,10 +38,15 @@ export const DEFAULT_DATA = {
       type: 'ROOT',
       meta: {
         type: DATA_STRUCTURE_META_TYPES.FEATURE,
-        icon: 'folderOpen',
+        icon: { type: 'folderOpen' },
         tooltip: 'Root Data Structure',
       },
     } as DataStructure,
+    LOCAL_DATASOURCE: {
+      id: '',
+      title: 'Local Cluster',
+      type: 'DATA_SOURCE',
+    },
   },
 
   SET_TYPES: {

src/plugins/data/public/query/query_string/dataset_service/dataset_service.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { CoreStart, SavedObjectsClientContract } from 'opensearch-dashboards/public';
+import { CoreStart } from 'opensearch-dashboards/public';
 import {
   Dataset,
   DataStructure,
@@ -15,6 +15,7 @@ import {
 import { DatasetTypeConfig } from './types';
 import { indexPatternTypeConfig, indexTypeConfig } from './lib';
 import { IndexPatternsContract } from '../../../index_patterns';
+import { IDataPluginServices } from '../../../types';
 
 export class DatasetService {
   private indexPatterns?: IndexPatternsContract;
@@ -83,15 +84,15 @@ export class DatasetService {
   }
 
   public fetchOptions(
-    savedObjects: SavedObjectsClientContract,
+    services: IDataPluginServices,
     path: DataStructure[],
     dataType: string
   ): Promise<DataStructure> {
     const type = this.typesRegistry.get(dataType);
     if (!type) {
       throw new Error(`No handler found for type: ${path[0]}`);
     }
-    return type.fetch(savedObjects, path);
+    return type.fetch(services, path);
   }
 
   private async fetchDefaultDataset(): Promise<Dataset | undefined> {

src/plugins/data/public/query/query_string/dataset_service/lib/index_pattern_type.ts

@@ -44,9 +44,9 @@ export const indexPatternTypeConfig: DatasetTypeConfig = {
     } as Dataset;
   },
 
-  fetch: async (savedObjects, path) => {
+  fetch: async (services, path) => {
     const dataStructure = path[path.length - 1];
-    const indexPatterns = await fetchIndexPatterns(savedObjects);
+    const indexPatterns = await fetchIndexPatterns(services.savedObjects.client);
     return {
       ...dataStructure,
       columnHeader: 'Index patterns',

src/plugins/data/public/query/query_string/dataset_service/lib/index_type.ts

@@ -15,14 +15,6 @@ import { DatasetTypeConfig } from '../types';
 import { getSearchService, getIndexPatterns } from '../../../../services';
 import { injectMetaToDataStructures } from './utils';
 
-const INDEX_INFO = {
-  LOCAL_DATASOURCE: {
-    id: '',
-    title: 'Local Cluster',
-    type: 'DATA_SOURCE',
-  },
-};
-
 export const indexTypeConfig: DatasetTypeConfig = {
   id: DEFAULT_DATA.SET_TYPES.INDEX,
   title: 'Indexes',
@@ -47,11 +39,11 @@ export const indexTypeConfig: DatasetTypeConfig = {
             title: dataSource.title,
             type: dataSource.type,
           }
-        : INDEX_INFO.LOCAL_DATASOURCE,
+        : DEFAULT_DATA.STRUCTURES.LOCAL_DATASOURCE,
     };
   },
 
-  fetch: async (savedObjects, path) => {
+  fetch: async (services, path) => {
     const dataStructure = path[path.length - 1];
     switch (dataStructure.type) {
       case 'DATA_SOURCE': {
@@ -69,7 +61,7 @@ export const indexTypeConfig: DatasetTypeConfig = {
       }
 
       default: {
-        const dataSources = await fetchDataSources(savedObjects);
+        const dataSources = await fetchDataSources(services.savedObjects.client);
         return {
           ...dataStructure,
           columnHeader: 'Cluster',
@@ -97,12 +89,12 @@ export const indexTypeConfig: DatasetTypeConfig = {
 };
 
 const fetchDataSources = async (client: SavedObjectsClientContract) => {
-  const resp = await client.find<any>({
+  const response = await client.find<any>({
     type: 'data-source',
     perPage: 10000,
   });
-  const dataSources: DataStructure[] = [INDEX_INFO.LOCAL_DATASOURCE].concat(
-    resp.savedObjects.map((savedObject) => ({
+  const dataSources: DataStructure[] = [DEFAULT_DATA.STRUCTURES.LOCAL_DATASOURCE].concat(
+    response.savedObjects.map((savedObject) => ({
       id: savedObject.id,
       title: savedObject.attributes.title,
       type: 'DATA_SOURCE',

src/plugins/data/public/query/query_string/dataset_service/types.ts

@@ -2,9 +2,9 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
-import { SavedObjectsClientContract } from 'opensearch-dashboards/public';
 import { EuiIconProps } from '@elastic/eui';
 import { Dataset, DatasetField, DataStructure } from '../../../../common';
+import { IDataPluginServices } from '../../../types';
 
 /**
  * Configuration for handling dataset operations.
@@ -29,11 +29,11 @@ export interface DatasetTypeConfig {
   toDataset: (path: DataStructure[]) => Dataset;
   /**
    * Fetches child options for a given DataStructure.
-   * @param {SavedObjectsClientContract} client - The saved objects client.
+   * @param {IDataPluginServices} services - The data plugin services.
    * @param {DataStructure} dataStructure - The parent DataStructure.
    * @returns {Promise<DatasetHandlerFetchResponse>} A promise that resolves to a DatasetHandlerFetchResponse.
    */
-  fetch: (client: SavedObjectsClientContract, path: DataStructure[]) => Promise<DataStructure>;
+  fetch: (services: IDataPluginServices, path: DataStructure[]) => Promise<DataStructure>;
   /**
    * Fetches fields for the dataset.
    * @returns {Promise<DatasetField[]>} A promise that resolves to an array of DatasetFields.

src/plugins/data/public/ui/dataset_selector/advanced_selector.tsx

@@ -4,7 +4,6 @@
  */
 
 import React, { useState } from 'react';
-import { SavedObjectsClientContract } from 'opensearch-dashboards/public';
 import {
   BaseDataset,
   DATA_STRUCTURE_META_TYPES,
@@ -15,13 +14,14 @@ import {
 import { DatasetExplorer } from './dataset_explorer';
 import { Configurator } from './configurator';
 import { getQueryService } from '../../services';
+import { IDataPluginServices } from '../../types';
 
 export const AdvancedSelector = ({
-  savedObjects,
+  services,
   onSelect,
   onCancel,
 }: {
-  savedObjects: SavedObjectsClientContract;
+  services: IDataPluginServices;
   onSelect: (dataset: Dataset) => void;
   onCancel: () => void;
 }) => {
@@ -59,7 +59,7 @@ export const AdvancedSelector = ({
     />
   ) : (
     <DatasetExplorer
-      savedObjects={savedObjects}
+      services={services}
       queryString={queryString}
       path={path}
       setPath={setPath}

src/plugins/data/public/ui/dataset_selector/dataset_explorer.tsx

@@ -19,19 +19,19 @@ import {
   EuiToolTip,
 } from '@elastic/eui';
 import { FormattedMessage } from '@osd/i18n/react';
-import { SavedObjectsClientContract } from 'opensearch-dashboards/public';
 import { BaseDataset, DATA_STRUCTURE_META_TYPES, DataStructure } from '../../../common';
 import { QueryStringContract } from '../../query';
+import { IDataPluginServices } from '../../types';
 
 export const DatasetExplorer = ({
-  savedObjects,
+  services,
   queryString,
   path,
   setPath,
   onNext,
   onCancel,
 }: {
-  savedObjects: SavedObjectsClientContract;
+  services: IDataPluginServices;
   queryString: QueryStringContract;
   path: DataStructure[];
   setPath: (path: DataStructure[]) => void;
@@ -55,7 +55,7 @@ export const DatasetExplorer = ({
     }
 
     setLoading(true);
-    const nextDataStructure = await typeConfig.fetch(savedObjects, nextPath);
+    const nextDataStructure = await typeConfig.fetch(services, nextPath);
     setLoading(false);
 
     setPath([...newPath, nextDataStructure]);

src/plugins/data/public/ui/dataset_selector/dataset_selector.tsx

@@ -34,7 +34,7 @@ export const DatasetSelector = ({
 }: DatasetSelectorProps) => {
   const [isOpen, setIsOpen] = useState(false);
   const [datasets, setDatasets] = useState<Dataset[]>([]);
-  const { overlays, savedObjects } = services;
+  const { overlays } = services;
 
   const isMounted = useRef(true);
 
@@ -53,7 +53,7 @@ export const DatasetSelector = ({
     const typeConfig = datasetService.getType(DEFAULT_DATA.SET_TYPES.INDEX_PATTERN);
     if (!typeConfig) return;
 
-    const fetchedIndexPatternDataStructures = await typeConfig.fetch(savedObjects.client, []);
+    const fetchedIndexPatternDataStructures = await typeConfig.fetch(services, []);
 
     if (!isMounted.current) return;
 
@@ -67,7 +67,7 @@ export const DatasetSelector = ({
     if (!selectedDataset && fetchedDatasets.length > 0) {
       setSelectedDataset(fetchedDatasets[0]);
     }
-  }, [datasetService, savedObjects.client, selectedDataset, setSelectedDataset]);
+  }, [datasetService, selectedDataset, services, setSelectedDataset]);
 
   useEffect(() => {
     fetchDatasets();
@@ -183,7 +183,7 @@ export const DatasetSelector = ({
             const overlay = overlays?.openModal(
               toMountPoint(
                 <AdvancedSelector
-                  savedObjects={savedObjects.client}
+                  services={services}
                   onSelect={(dataset?: Dataset) => {
                     overlay?.close();
                     if (dataset) {