Clean up files and use helper functions

Some clean up to reduce file count

common/constants.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const PLUGIN_ID = 'queryEnhancements';
+export const PLUGIN_NAME = 'queryEnhancements';
+
+export const BASE_API = '/api/enhancements';
+
+export const SEARCH_STRATEGY = {
+  PPL: 'ppl',
+  SQL: 'sql',
+};
+
+export const API = {
+  SEARCH: `${BASE_API}/search`,
+  PPL_SEARCH: `${BASE_API}/search/${SEARCH_STRATEGY.PPL}`,
+  SQL_SEARCH: `${BASE_API}/search/${SEARCH_STRATEGY.SQL}`,
+};
+
+export const URI = {
+  PPL: '/_plugins/_ppl',
+  SQL: '/_plugins/_sql',
+  ASYNC_QUERY: '/_plugins/_async_query',
+  ML: '/_plugins/_ml',
+  OBSERVABILITY: '/_plugins/_observability',
+  DATA_CONNECTIONS: '/_plugins/_query/_datasources',
+};
+
+export const OPENSEARCH_API = {
+  PANELS: `${URI.OBSERVABILITY}/object`,
+  DATA_CONNECTIONS: URI.DATA_CONNECTIONS,
+};
+
+export const UI_SETTINGS = {};

common/index.ts

@@ -3,29 +3,5 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export const PLUGIN_ID = 'queryEnhancements';
-export const PLUGIN_NAME = 'queryEnhancements';
-
-export const PPL_SEARCH_STRATEGY = 'ppl';
-export const SQL_SEARCH_STRATEGY = 'sql';
-
-export const PPL_ENDPOINT = '/_plugins/_ppl';
-export const SQL_ENDPOINT = '/_plugins/_sql';
-
-const BASE_OBSERVABILITY_URI = '/_plugins/_observability';
-const BASE_DATACONNECTIONS_URI = '/_plugins/_query/_datasources';
-export const OPENSEARCH_PANELS_API = {
-  OBJECT: `${BASE_OBSERVABILITY_URI}/object`,
-};
-export const OPENSEARCH_DATACONNECTIONS_API = {
-  DATACONNECTION: `${BASE_DATACONNECTIONS_URI}`,
-};
-
-export const JOBS_ENDPOINT_BASE = '/_plugins/_async_query';
-
-export const BASE_ML_COMMONS_URI = '/_plugins/_ml';
-
-// Advanced Settings
-export const QUERY_ENABLE_ENHANCEMENTS_SETTING = 'query:enableEnhancements';
-
+export * from './constants';
 export * from './utils';

opensearch_dashboards.json

@@ -1,6 +1,6 @@
 {
   "id": "queryEnhancements",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "opensearchDashboardsVersion": "opensearchDashboards",
   "server": true,
   "ui": true,

package.json

@@ -1,10 +1,13 @@
 {
   "name": "queryEnhancements",
-  "version": "0.0.0",
-  "private": true,
+  "license": "Apache-2.0",
+  "version": "3.0.0.0",
+  "main": "index.ts",
   "scripts": {
     "build": "yarn plugin-helpers build",
-    "plugin-helpers": "../../scripts/use_node ../../scripts/plugin_helpers",
-    "osd": "../../scripts/use_node ../../scripts/osd"
-  }
+    "plugin-helpers": "node ../../scripts/plugin_helpers",
+    "osd": "node ../../scripts/osd"
+  },
+  "dependencies": {},
+  "devDependencies": {}
 }

public/index.ts

@@ -1,10 +1,14 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import './index.scss';
 
 import { QueryEnhancementsPlugin } from './plugin';
 
-// This exports static code and TypeScript types,
-// as well as, OpenSearch Dashboards Platform `plugin()` initializer.
 export function plugin() {
   return new QueryEnhancementsPlugin();
 }
+
 export { QueryEnhancementsPluginSetup, QueryEnhancementsPluginStart } from './types';

public/plugin.tsx

@@ -1,8 +1,12 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import moment from 'moment';
 import { CoreSetup, CoreStart, Plugin } from '../../../src/core/public';
 import { IStorageWrapper, Storage } from '../../../src/plugins/opensearch_dashboards_utils/public';
-import { PPLQlSearchInterceptor } from './search/ppl_search_interceptor';
-import { SQLQlSearchInterceptor } from './search/sql_search_interceptor';
+import { PPLSearchInterceptor, SQLSearchInterceptor } from './search';
 import { setData, setStorage } from './services';
 import {
   QueryEnhancementsPluginSetup,
@@ -23,15 +27,15 @@ export class QueryEnhancementsPlugin
     core: CoreSetup,
     { data }: QueryEnhancementsPluginSetupDependencies
   ): QueryEnhancementsPluginSetup {
-    const pplSearchInterceptor = new PPLQlSearchInterceptor({
+    const pplSearchInterceptor = new PPLSearchInterceptor({
       toasts: core.notifications.toasts,
       http: core.http,
       uiSettings: core.uiSettings,
       startServices: core.getStartServices(),
       usageCollector: data.search.usageCollector,
     });
 
-    const sqlSearchInterceptor = new SQLQlSearchInterceptor({
+    const sqlSearchInterceptor = new SQLSearchInterceptor({
       toasts: core.notifications.toasts,
       http: core.http,
       uiSettings: core.uiSettings,

public/search/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { PPLSearchInterceptor } from './ppl_search_interceptor';
+export { SQLSearchInterceptor } from './sql_search_interceptor';

public/search/ppl_search_interceptor.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { trimEnd } from 'lodash';
 import { Observable, from } from 'rxjs';
 import { stringify } from '@osd/std';
@@ -20,10 +25,10 @@ import {
   SearchInterceptor,
   SearchInterceptorDeps,
 } from '../../../../src/plugins/data/public';
-import { formatDate, PPL_SEARCH_STRATEGY, removeKeyword } from '../../common';
+import { formatDate, SEARCH_STRATEGY, removeKeyword, API } from '../../common';
 import { QueryEnhancementsPluginStartDependencies } from '../types';
 
-export class PPLQlSearchInterceptor extends SearchInterceptor {
+export class PPLSearchInterceptor extends SearchInterceptor {
   protected queryService!: DataPublicPluginStart['query'];
   protected aggsService!: DataPublicPluginStart['search']['aggs'];
 
@@ -42,7 +47,7 @@ export class PPLQlSearchInterceptor extends SearchInterceptor {
     strategy?: string
   ): Observable<IOpenSearchDashboardsSearchResponse> {
     const { id, ...searchRequest } = request;
-    const path = trimEnd('/api/pplql/search');
+    const path = trimEnd(API.PPL_SEARCH);
     const { timefilter } = this.queryService;
     const dateRange = timefilter.timefilter.getTime();
     const { fromDate, toDate } = formatTimePickerDate(dateRange, 'YYYY-MM-DD HH:mm:ss.SSS');
@@ -186,6 +191,6 @@ export class PPLQlSearchInterceptor extends SearchInterceptor {
   }
 
   public search(request: IOpenSearchDashboardsSearchRequest, options: ISearchOptions) {
-    return this.runSearch(request, options.abortSignal, PPL_SEARCH_STRATEGY);
+    return this.runSearch(request, options.abortSignal, SEARCH_STRATEGY.PPL);
   }
 }

public/search/sql_search_interceptor.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { trimEnd } from 'lodash';
 import { Observable, from } from 'rxjs';
 import { stringify } from '@osd/std';
@@ -10,10 +15,10 @@ import {
   SearchInterceptor,
   SearchInterceptorDeps,
 } from '../../../../src/plugins/data/public';
-import { SQL_SEARCH_STRATEGY } from '../../common';
+import { API, SEARCH_STRATEGY } from '../../common';
 import { QueryEnhancementsPluginStartDependencies } from '../types';
 
-export class SQLQlSearchInterceptor extends SearchInterceptor {
+export class SQLSearchInterceptor extends SearchInterceptor {
   protected queryService!: DataPublicPluginStart['query'];
   protected aggsService!: DataPublicPluginStart['search']['aggs'];
 
@@ -32,7 +37,7 @@ export class SQLQlSearchInterceptor extends SearchInterceptor {
     strategy?: string
   ): Observable<IOpenSearchDashboardsSearchResponse> {
     const { id, ...searchRequest } = request;
-    const path = trimEnd('/api/sqlql/search');
+    const path = trimEnd(API.SQL_SEARCH);
 
     const fetchDataFrame = (queryString: string, df = null) => {
       const body = stringify({ query: { qs: queryString, format: 'jdbc' }, df });
@@ -56,7 +61,7 @@ export class SQLQlSearchInterceptor extends SearchInterceptor {
       if (!df.body.error) return;
       const jsError = new Error(df.body.error.response);
       this.deps.toasts.addError(jsError, {
-        title: i18n.translate('dqlPlugin.sqlQueryError', {
+        title: i18n.translate('queryEnhancements.sqlQueryError', {
           defaultMessage: 'Could not complete the SQL query',
         }),
         toastMessage: df.body.error.msg,
@@ -67,6 +72,6 @@ export class SQLQlSearchInterceptor extends SearchInterceptor {
   }
 
   public search(request: IOpenSearchDashboardsSearchRequest, options: ISearchOptions) {
-    return this.runSearch(request, options.abortSignal, SQL_SEARCH_STRATEGY);
+    return this.runSearch(request, options.abortSignal, SEARCH_STRATEGY.SQL);
   }
 }

public/services.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { createGetterSetter } from '../../../src/plugins/opensearch_dashboards_utils/common';
 import { IStorageWrapper } from '../../../src/plugins/opensearch_dashboards_utils/public';
 import { DataPublicPluginStart } from '../../../src/plugins/data/public';

public/types.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { DataPublicPluginSetup, DataPublicPluginStart } from 'src/plugins/data/public';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

server/index.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { PluginConfigDescriptor, PluginInitializerContext } from '../../../src/core/server';
 import { QueryEnhancementsPlugin } from './plugin';
 import { configSchema, ConfigSchema } from '../common/config';
@@ -11,4 +16,11 @@ export function plugin(initializerContext: PluginInitializerContext) {
   return new QueryEnhancementsPlugin(initializerContext);
 }
 
+export {
+  Facet,
+  OpenSearchPPLPlugin,
+  OpenSearchObservabilityPlugin,
+  shimStats,
+  shimSchemaRow,
+} from './utils';
 export { QueryEnhancementsPluginSetup, QueryEnhancementsPluginStart } from './types';

server/plugin.ts

@@ -1,3 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { Observable } from 'rxjs';
 import {
   CoreSetup,
@@ -7,18 +12,15 @@ import {
   PluginInitializerContext,
   SharedGlobalConfig,
 } from '../../../src/core/server';
-import { PPL_SEARCH_STRATEGY, SQL_ASYNC_SEARCH_STRATEGY, SQL_SEARCH_STRATEGY } from '../common';
+import { SEARCH_STRATEGY } from '../common';
 import { defineRoutes } from './routes';
-import { EnginePlugin } from './search/engine_plugin';
-import { PPLPlugin } from './search/ppl/ppl_plugin';
-import { pplSearchStrategyProvider } from './search/ppl/ppl_search_strategy';
-import { sqlSearchStrategyProvider } from './search/sql/sql_search_strategy';
+import { pplSearchStrategyProvider, sqlSearchStrategyProvider } from './search';
 import {
   QueryEnhancementsPluginSetup,
   QueryEnhancementsPluginSetupDependencies,
   QueryEnhancementsPluginStart,
 } from './types';
-import { uiSettings } from './ui_settings';
+import { OpenSearchPPLPlugin, OpenSearchObservabilityPlugin } from './utils';
 
 export class QueryEnhancementsPlugin
   implements Plugin<QueryEnhancementsPluginSetup, QueryEnhancementsPluginStart> {
@@ -34,16 +36,14 @@ export class QueryEnhancementsPlugin
     const router = core.http.createRouter();
     // Register server side APIs
     const client = core.opensearch.legacy.createClient('opensearch_observability', {
-      plugins: [PPLPlugin, EnginePlugin],
+      plugins: [OpenSearchPPLPlugin, OpenSearchObservabilityPlugin],
     });
 
-    core.uiSettings.register(uiSettings);
-
     const pplSearchStrategy = pplSearchStrategyProvider(this.config$, this.logger, client);
     const sqlSearchStrategy = sqlSearchStrategyProvider(this.config$, this.logger, client);
 
-    data.search.registerSearchStrategy(PPL_SEARCH_STRATEGY, pplSearchStrategy);
-    data.search.registerSearchStrategy(SQL_SEARCH_STRATEGY, sqlSearchStrategy);
+    data.search.registerSearchStrategy(SEARCH_STRATEGY.PPL, pplSearchStrategy);
+    data.search.registerSearchStrategy(SEARCH_STRATEGY.SQL, sqlSearchStrategy);
 
     defineRoutes(this.logger, router, {
       ppl: pplSearchStrategy,