[Discover-next] add query enhancements plugin as a core plugin

changelogs/fragments/7212.yml

@@ -0,0 +1,2 @@
+feat:
+- Add query enhancements plugin as a core plugin ([#7212](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7212))

docs/_sidebar.md

@@ -59,6 +59,7 @@
           - forms
             - [Form_wizard](../src/plugins/opensearch_ui_shared/public/forms/form_wizard/README.md)
             - [Multi_content](../src/plugins/opensearch_ui_shared/public/forms/multi_content/README.md)
+      - [Query_enhancements](../src/plugins/query_enhancements/README.md)
       - [Saved_objects](../src/plugins/saved_objects/README.md)
       - [Saved_objects_management](../src/plugins/saved_objects_management/README.md)
       - [Share](../src/plugins/share/README.md)

src/plugins/data/public/index.ts

@@ -437,6 +437,12 @@ export {
   IndexPatternSelectProps,
   QueryStringInput,
   QueryStringInputProps,
+  QueryEditor,
+  QueryEditorExtensionConfig,
+  QueryEditorExtensions,
+  QueryEditorExtensionDependencies,
+  QueryEditorProps,
+  QueryEditorTopRow,
   // for BWC, keeping the old name
   IUiStart as DataPublicPluginStartUi,
 } from './ui';

src/plugins/data/public/ui/index.ts

@@ -39,5 +39,13 @@ export {
 export { IndexPatternSelectProps } from './index_pattern_select';
 export { FilterLabel } from './filter_bar';
 export { QueryStringInput, QueryStringInputProps } from './query_string_input';
+export {
+  QueryEditorTopRow,
+  QueryEditor,
+  QueryEditorProps,
+  QueryEditorExtensions,
+  QueryEditorExtensionDependencies,
+  QueryEditorExtensionConfig,
+} from './query_editor';
 export { SearchBar, SearchBarProps, StatefulSearchBarProps } from './search_bar';
 export { SuggestionsComponent } from './typeahead';

src/plugins/data/public/ui/query_editor/index.tsx

@@ -25,4 +25,8 @@ export const QueryEditor = (props: QueryEditorProps) => (
 );
 export type { QueryEditorProps };
 
-export { QueryEditorExtensions, QueryEditorExtensionConfig } from './query_editor_extensions';
+export {
+  QueryEditorExtensions,
+  QueryEditorExtensionDependencies,
+  QueryEditorExtensionConfig,
+} from './query_editor_extensions';

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

@@ -215,9 +215,9 @@ export default class QueryEditorUI extends Component<Props, State> {
       : undefined;
     this.onChange(newQuery, dateRange);
     this.onSubmit(newQuery, dateRange);
-    this.setState({ isDataSetsVisible: enhancement?.searchBar?.showDataSetsSelector ?? true });
     this.setState({
       isDataSourcesVisible: enhancement?.searchBar?.showDataSourcesSelector ?? true,
+      isDataSetsVisible: enhancement?.searchBar?.showDataSetsSelector ?? true,
     });
   };
 
@@ -231,19 +231,15 @@ export default class QueryEditorUI extends Component<Props, State> {
   private initDataSourcesVisibility = () => {
     if (this.componentIsUnmounting) return;
 
-    const isDataSourcesVisible =
-      this.props.settings.getQueryEnhancements(this.props.query.language)?.searchBar
-        ?.showDataSourcesSelector ?? true;
-    this.setState({ isDataSourcesVisible });
+    return this.props.settings.getQueryEnhancements(this.props.query.language)?.searchBar
+      ?.showDataSourcesSelector;
   };
 
   private initDataSetsVisibility = () => {
     if (this.componentIsUnmounting) return;
 
-    const isDataSetsVisible =
-      this.props.settings.getQueryEnhancements(this.props.query.language)?.searchBar
-        ?.showDataSetsSelector ?? true;
-    this.setState({ isDataSetsVisible });
+    return this.props.settings.getQueryEnhancements(this.props.query.language)?.searchBar
+      ?.showDataSetsSelector;
   };
 
   public onMouseEnterSuggestion = (index: number) => {
@@ -260,8 +256,10 @@ export default class QueryEditorUI extends Component<Props, State> {
 
     this.initPersistedLog();
     // this.fetchIndexPatterns().then(this.updateSuggestions);
-    this.initDataSourcesVisibility();
-    this.initDataSetsVisibility();
+    this.setState({
+      isDataSourcesVisible: this.initDataSourcesVisibility() || true,
+      isDataSetsVisible: this.initDataSetsVisibility() || true,
+    });
   }
 
   public componentDidUpdate(prevProps: Props) {

src/plugins/data/public/ui/query_editor/query_editor_extensions/index.tsx

@@ -14,4 +14,7 @@ export const QueryEditorExtensions = (props: ComponentProps<typeof LazyQueryEdit
   </React.Suspense>
 );
 
-export { QueryEditorExtensionConfig } from './query_editor_extension';
+export {
+  QueryEditorExtensionDependencies,
+  QueryEditorExtensionConfig,
+} from './query_editor_extension';

src/plugins/query_enhancements/.i18nrc.json

@@ -0,0 +1,7 @@
+{
+  "prefix": "queryEnhancements",
+  "paths": {
+    "queryEnhancements": "."
+  },
+  "translations": ["translations/ja-JP.json"]
+}

src/plugins/query_enhancements/README.md

@@ -0,0 +1,9 @@
+# Query Enhancements Plugin
+
+Optional plugin, that registers query enhancing capabilities within
+the application.
+
+## List of enhancements
+
+* PPL within Discover
+* SQL within Discover

src/plugins/query_enhancements/common/config.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { schema, TypeOf } from '@osd/config-schema';
+
+export const configSchema = schema.object({
+  enabled: schema.boolean({ defaultValue: true }),
+  queryAssist: schema.object({
+    supportedLanguages: schema.arrayOf(
+      schema.object({
+        language: schema.string(),
+        agentConfig: schema.string(),
+      }),
+      {
+        defaultValue: [{ language: 'PPL', agentConfig: 'os_query_assist_ppl' }],
+      }
+    ),
+  }),
+});
+
+export type ConfigSchema = TypeOf<typeof configSchema>;

src/plugins/query_enhancements/common/constants.ts

@@ -0,0 +1,47 @@
+/*
+ * 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',
+  SQL_ASYNC: 'sqlasync',
+};
+
+export const API = {
+  SEARCH: `${BASE_API}/search`,
+  PPL_SEARCH: `${BASE_API}/search/${SEARCH_STRATEGY.PPL}`,
+  SQL_SEARCH: `${BASE_API}/search/${SEARCH_STRATEGY.SQL}`,
+  SQL_ASYNC_SEARCH: `${BASE_API}/search/${SEARCH_STRATEGY.SQL_ASYNC}`,
+  QUERY_ASSIST: {
+    LANGUAGES: `${BASE_API}/assist/languages`,
+    GENERATE: `${BASE_API}/assist/generate`,
+  },
+  DATA_SOURCE: {
+    CONNECTIONS: `${BASE_API}/datasource/connections`,
+  },
+};
+
+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 = {};
+
+export const ERROR_DETAILS = { GUARDRAILS_TRIGGERED: 'guardrails triggered' };

src/plugins/query_enhancements/common/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from './constants';
+export * from './types';
+export * from './utils';

src/plugins/query_enhancements/common/query_assist/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export { QueryAssistParameters, QueryAssistResponse } from './types';

src/plugins/query_enhancements/common/query_assist/types.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { TimeRange } from 'src/plugins/data/common';
+
+export interface QueryAssistResponse {
+  query: string;
+  timeRange?: TimeRange;
+}
+
+export interface QueryAssistParameters {
+  question: string;
+  index: string;
+  language: string;
+  // for MDS
+  dataSourceId?: string;
+}

src/plugins/query_enhancements/common/types.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { CoreSetup } from 'opensearch-dashboards/public';
+import { Observable } from 'rxjs';
+
+export interface FetchDataFrameContext {
+  http: CoreSetup['http'];
+  path: string;
+  signal?: AbortSignal;
+}
+
+export type FetchFunction<T, P = void> = (params?: P) => Observable<T>;