[Backport 2.17] [discover] Clean up enhanced search API

changelogs/fragments/8226.yml

@@ -0,0 +1,2 @@
+fix:
+- Remove unused enhancements APIs, clean up, and error handling ([#8226](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8226))

src/plugins/data/common/constants.ts

@@ -44,7 +44,7 @@ export const DEFAULT_DATA = {
     } as DataStructure,
     LOCAL_DATASOURCE: {
       id: '',
-      title: 'Local Cluster',
+      title: 'Default Cluster',
       type: 'DATA_SOURCE',
     },
   },

src/plugins/data/common/search/search_source/fetch/get_search_params.ts

@@ -53,19 +53,16 @@
   searchRequest: SearchRequest,
   dependencies: {
     getConfig: GetConfigFn;
-    getDataFrame: GetDataFrameFn;
   }
 ): ISearchRequestParams {
-  const { getConfig, getDataFrame } = dependencies;
+  const { getConfig } = dependencies;
   const searchParams = getSearchParams(getConfig);
-  const dataFrame = getDataFrame();
   const indexTitle = searchRequest.index.title || searchRequest.index;
 
   return {
     index: indexTitle,
     body: {
       ...searchRequest.body,
-      ...(dataFrame && dataFrame?.name === indexTitle ? { df: dataFrame } : {}),
     },
     ...searchParams,
   };

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

@@ -64,7 +64,7 @@ export const indexTypeConfig: DatasetTypeConfig = {
         const dataSources = await fetchDataSources(services.savedObjects.client);
         return {
           ...dataStructure,
-          columnHeader: 'Cluster',
+          columnHeader: 'Clusters',
           hasNext: true,
           children: dataSources,
         };

src/plugins/query_enhancements/common/constants.ts

@@ -29,9 +29,8 @@ export const API = {
     GENERATE: `${BASE_API}/assist/generate`,
   },
   DATA_SOURCE: {
-    EXTERNAL: `${BASE_API}/datasource/external`,
-    ASYNC_JOBS: `${BASE_API}/datasource/jobs`,
-    CONNECTIONS: `${BASE_API}/datasource/connections`,
+    ASYNC_JOBS: `${BASE_API}/jobs`,
+    CONNECTIONS: `${BASE_API}/connections`,
   },
 };
 

src/plugins/query_enhancements/public/datasets/s3_type.ts

@@ -4,6 +4,7 @@
  */
 
 import { HttpSetup, SavedObjectsClientContract } from 'opensearch-dashboards/public';
+import { trimEnd } from 'lodash';
 import {
   DATA_STRUCTURE_META_TYPES,
   DEFAULT_DATA,
@@ -14,7 +15,7 @@
   DatasetField,
 } from '../../../data/common';
 import { DatasetTypeConfig, IDataPluginServices } from '../../../data/public';
-import { DATASET, handleQueryStatus } from '../../common';
+import { API, DATASET, handleQueryStatus } from '../../common';
 import S3_ICON from '../assets/s3_mark.svg';
 
 export const s3TypeConfig: DatasetTypeConfig = {
@@ -115,7 +116,9 @@
   try {
     const response = await handleQueryStatus({
       fetchStatus: () =>
-        http.fetch('../../api/enhancements/datasource/jobs', {
+        http.fetch({
+          method: 'GET',
+          path: trimEnd(`${API.DATA_SOURCE.ASYNC_JOBS}`),
           query: {
             id: dataSource?.id,
             queryId: meta.queryId,
@@ -171,9 +174,13 @@
   http: HttpSetup,
   dataSource: DataStructure
 ): Promise<DataStructure[]> => {
-  const query = (dataSource.meta as DataStructureCustomMeta).query;
-  const response = await http.fetch(`../../api/enhancements/datasource/external`, {
-    query,
+  const abortController = new AbortController();
+  const query =
+    dataSource.id !== '' ? (dataSource.meta as DataStructureCustomMeta).query : undefined;
+  const response = await http.fetch({
+    method: 'GET',
+    path: trimEnd(`${API.DATA_SOURCE.CONNECTIONS}/${query?.id || ''}`),
+    signal: abortController.signal,
   });
 
   return response
@@ -190,10 +197,13 @@
 };
 
 const fetchDatabases = async (http: HttpSetup, path: DataStructure[]): Promise<DataStructure[]> => {
+  const abortController = new AbortController();
   const dataSource = path.find((ds) => ds.type === 'DATA_SOURCE');
   const connection = path[path.length - 1];
   const meta = connection.meta as DataStructureCustomMeta;
-  const response = await http.post(`../../api/enhancements/datasource/jobs`, {
+  const response = await http.fetch({
+    method: 'POST',
+    path: trimEnd(`${API.DATA_SOURCE.ASYNC_JOBS}`),
     body: JSON.stringify({
       lang: 'sql',
       query: `SHOW DATABASES in ${connection.title}`,
@@ -203,6 +213,7 @@
     query: {
       id: dataSource?.id,
     },
+    signal: abortController.signal,
   });
 
   connection.meta = setMeta(connection, response);
@@ -211,11 +222,14 @@
 };
 
 const fetchTables = async (http: HttpSetup, path: DataStructure[]): Promise<DataStructure[]> => {
+  const abortController = new AbortController();
   const dataSource = path.find((ds) => ds.type === 'DATA_SOURCE');
   const connection = path.find((ds) => ds.type === 'CONNECTION');
   const sessionId = (connection?.meta as DataStructureCustomMeta).sessionId;
   const database = path[path.length - 1];
-  const response = await http.post(`../../api/enhancements/datasource/jobs`, {
+  const response = await http.fetch({
+    method: 'POST',
+    path: trimEnd(`${API.DATA_SOURCE.ASYNC_JOBS}`),
     body: JSON.stringify({
       lang: 'sql',
       query: `SHOW TABLES in ${database.title}`,
@@ -225,6 +239,7 @@
     query: {
       id: dataSource?.id,
     },
+    signal: abortController.signal,
   });
 
   database.meta = setMeta(database, response);

src/plugins/query_enhancements/public/services/index.ts

@@ -9,5 +9,3 @@ import { createGetterSetter } from '../../../opensearch_dashboards_utils/common'
 
 export const [getStorage, setStorage] = createGetterSetter<DataStorage>('storage');
 export const [getData, setData] = createGetterSetter<DataPublicPluginStart>('data');
-
-export { ConnectionsService } from './connections_service';

src/plugins/query_enhancements/public/types.ts

@@ -31,8 +31,3 @@ export interface Connection {
     auth?: any;
   };
 }
-
-export interface ConnectionsServiceDeps {
-  http: CoreSetup['http'];
-  startServices: Promise<[CoreStart, QueryEnhancementsPluginStartDependencies, unknown]>;
-}

src/plugins/query_enhancements/server/routes/data_source_connection/routes.ts

@@ -13,62 +13,26 @@ export function registerDataSourceConnectionsRoutes(
 ) {
   router.get(
     {
-      path: API.DATA_SOURCE.CONNECTIONS,
-      validate: {
-        params: schema.object({}, { unknowns: 'allow' }),
-      },
-    },
-    async (context, request, response) => {
-      const fields = ['id', 'title', 'auth.type'];
-      const resp = await context.core.savedObjects.client.find({
-        type: 'data-source',
-        fields,
-        perPage: 10000,
-      });
-
-      return response.ok({ body: { savedObjects: resp.saved_objects } });
-    }
-  );
-
-  router.get(
-    {
-      path: `${API.DATA_SOURCE.CONNECTIONS}/{dataSourceId}`,
+      path: `${API.DATA_SOURCE.CONNECTIONS}/{id?}`,
       validate: {
         params: schema.object({
-          dataSourceId: schema.string(),
-        }),
-      },
-    },
-    async (context, request, response) => {
-      const resp = await context.core.savedObjects.client.get(
-        'data-source',
-        request.params.dataSourceId
-      );
-      return response.ok({ body: resp });
-    }
-  );
-
-  router.get(
-    {
-      path: `${API.DATA_SOURCE.EXTERNAL}`,
-      validate: {
-        query: schema.object({
-          id: schema.string(),
-          name: schema.nullable(schema.string()),
+          id: schema.maybe(schema.string()),
         }),
       },
     },
     async (context, request, response) => {
-      const client = request.query.id
-        ? context.dataSource.opensearch.legacy.getClient(request.query.id).callAPI
+      const client = request.params.id
+        ? context.dataSource.opensearch.legacy.getClient(request.params.id).callAPI
         : defaultClient.asScoped(request).callAsCurrentUser;
-
-      const resp = request.query.name
-        ? await client('enhancements.getDataConnectionById', {
-            dataconnection: request.query.name,
-          })
-        : await client('enhancements.getDataConnections');
-      return response.ok({ body: resp });
+      try {
+        const resp = await client('enhancements.getDataConnections');
+        return response.ok({ body: resp });
+      } catch (error) {
+        if (error.statusCode === 404 || error.statusCode === 400) {
+          return response.ok({ body: [] });
+        }
+        return response.custom({ statusCode: error.statusCode || 500, body: error.message });
+      }
     }
   );