Created language manager inside query string service

changelogs/fragments/7756.yml

@@ -0,0 +1,2 @@
+feat:
+- Created language manager inside query string service ([#7756](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7756))

src/plugins/data/public/antlr/dql/code_completion.ts

@@ -13,7 +13,7 @@ import { getTokenPosition } from '../shared/cursor';
 import { IndexPattern, IndexPatternField } from '../../index_patterns';
 import { QuerySuggestionGetFnArgs } from '../../autocomplete';
 import { DQLParserVisitor } from './.generated/DQLParserVisitor';
-import { getUiService } from '../../services';
+import { getQueryService } from '../../services';
 
 const findCursorIndex = (
   tokenStream: TokenStream,
@@ -132,7 +132,9 @@ export const getSuggestions = async ({
   if (
     !services ||
     !services.appName ||
-    !getUiService().Settings.supportsEnhancementsEnabled(services.appName) ||
+    !getQueryService()
+      .queryString.getLanguageManager()
+      .supportsEnhancementsEnabled(services.appName) ||
     !indexPattern
   ) {
     return [];

src/plugins/data/public/index.ts

@@ -62,6 +62,7 @@ import {
 } from '../common';
 
 import { FilterLabel } from './ui';
+export { createEditor, DefaultInput, DQLBody, SingleLineInput } from './ui';
 
 import {
   generateFilters,

src/plugins/data/public/plugin.ts

@@ -119,7 +119,7 @@
   constructor(initializerContext: PluginInitializerContext<ConfigSchema>) {
     this.searchService = new SearchService(initializerContext);
     this.uiService = new UiService(initializerContext);
-    this.queryService = new QueryService();
+    this.queryService = new QueryService(initializerContext);
     this.fieldFormatsService = new FieldFormatsService();
     this.autocomplete = new AutocompleteService(initializerContext);
     this.storage = createStorage({ engine: window.localStorage, prefix: 'opensearch_dashboards.' });
@@ -176,7 +176,8 @@
       query: queryService,
       __enhance: (enhancements: DataPublicPluginEnhancements) => {
         if (enhancements.search) searchService.__enhance(enhancements.search);
-        if (enhancements.ui) uiService.__enhance(enhancements.ui);
+        if (enhancements.ui)
+          queryService.queryString.getLanguageManager().__enhance(enhancements.ui);
       },
     };
   }

src/plugins/data/public/query/query_service.ts

@@ -29,7 +29,11 @@
  */
 
 import { share } from 'rxjs/operators';
-import { IUiSettingsClient, SavedObjectsClientContract } from 'src/core/public';
+import {
+  IUiSettingsClient,
+  PluginInitializerContext,
+  SavedObjectsClientContract,
+} from 'src/core/public';
 import { FilterManager } from './filter_manager';
 import { createAddToQueryLog } from './lib';
 import { TimefilterService, TimefilterSetup } from './timefilter';
@@ -45,6 +49,7 @@
 } from '../../common';
 import { getUiSettings } from '../services';
 import { IndexPattern } from '..';
+import { ConfigSchema } from '../../config';
 
 /**
  * Query Service
@@ -71,6 +76,8 @@
 
   state$!: ReturnType<typeof createQueryStateObservable>;
 
+  constructor(private initializerContext: PluginInitializerContext<ConfigSchema>) {}
+
   public setup({ storage, uiSettings }: QueryServiceSetupDependencies) {
     this.filterManager = new FilterManager(uiSettings);
 
@@ -80,7 +87,9 @@
       storage,
     });
 
-    this.queryStringManager = new QueryStringManager(storage, uiSettings);
+    const { enhancements: supportedAppNames } = this.initializerContext.config.get<ConfigSchema>();
+
+    this.queryStringManager = new QueryStringManager(storage, uiSettings, supportedAppNames);
     this.dataSetManager = new DataSetManager(uiSettings);
 
     this.state$ = createQueryStateObservable({

src/plugins/data/public/ui/settings/settings.ts → src/plugins/data/public/query/query_string/language_manager/language_manager.ts

@@ -4,11 +4,10 @@
  */
 
 import { BehaviorSubject } from 'rxjs';
-import { DataStorage, setOverrides as setFieldOverrides } from '../../../common';
-import { ConfigSchema } from '../../../config';
-import { ISearchStart } from '../../search';
-import { QueryEditorExtensionConfig } from '../query_editor/query_editor_extensions';
-import { QueryEnhancement } from '../types';
+import { QueryEnhancement, UiEnhancements } from '../../../ui/types';
+import { createEditor, DQLBody, QueryEditorExtensionConfig, SingleLineInput } from '../../../ui';
+import { ConfigSchema } from '../../../../config';
+import { DataStorage, setOverrides as setFieldOverrides } from '../../../../common';
 
 export interface DataSettings {
   userQueryLanguage: string;
@@ -22,21 +21,49 @@
   };
 }
 
-export class Settings {
+export class LanguageManager {
   private isEnabled = false;
   private enabledQueryEnhancementsUpdated$ = new BehaviorSubject<boolean>(this.isEnabled);
   private enhancedAppNames: string[] = [];
+  private queryEnhancements: Map<string, QueryEnhancement>;
+  private queryEditorExtensionMap: Record<string, QueryEditorExtensionConfig>;
 
   constructor(
     private readonly config: ConfigSchema['enhancements'],
-    private readonly search: ISearchStart,
-    private readonly storage: DataStorage,
-    private readonly queryEnhancements: Map<string, QueryEnhancement>,
-    private readonly queryEditorExtensionMap: Record<string, QueryEditorExtensionConfig>
+    private readonly storage: DataStorage
   ) {
     this.isEnabled = true;
     this.setUserQueryEnhancementsEnabled(this.isEnabled);
     this.enhancedAppNames = this.isEnabled ? this.config.supportedAppNames : [];
+    this.queryEnhancements = new Map();
+    this.queryEditorExtensionMap = {};
+  }
+
+  public createDefaultQueryEditor() {
+    return createEditor(SingleLineInput, SingleLineInput, DQLBody);
+  }
+
+  public __enhance = (enhancements: UiEnhancements) => {
+    if (!enhancements) return;
+    if (enhancements.query && enhancements.query.language) {
+      this.queryEnhancements.set(enhancements.query.language, enhancements.query);
+    }
+    if (enhancements.queryEditorExtension) {
+      this.queryEditorExtensionMap[enhancements.queryEditorExtension.id] =
+        enhancements.queryEditorExtension;
+    }
+  };
+
+  public getAllQueryEnhancements() {
+    return this.queryEnhancements;
+  }
+
+  public getQueryEnhancements(language: string) {
+    return this.queryEnhancements.get(language);
+  }
+
+  public getQueryEditorExtensionMap() {
+    return this.queryEditorExtensionMap;
   }
 
   supportsEnhancementsEnabled(appName: string) {
@@ -58,18 +85,6 @@
     return true;
   }
 
-  getAllQueryEnhancements() {
-    return this.queryEnhancements;
-  }
-
-  getQueryEnhancements(language: string) {
-    return this.queryEnhancements.get(language);
-  }
-
-  getQueryEditorExtensionMap() {
-    return this.queryEditorExtensionMap;
-  }
-
   getUserQueryLanguageBlocklist() {
     return this.storage.get('userQueryLanguageBlocklist') || [];
   }
@@ -87,18 +102,8 @@
   }
 
   setUserQueryLanguage(language: string) {
-    if (language !== this.getUserQueryLanguage()) {
-      this.search.df.clear();
-    }
     this.storage.set('userQueryLanguage', language);
-    const queryEnhancement = this.queryEnhancements.get(language);
-    this.search.__enhance({
-      searchInterceptor: queryEnhancement
-        ? queryEnhancement.search
-        : this.search.getDefaultSearchInterceptor(),
-    });
     this.setUiOverridesByUserQueryLanguage(language);
-
     return true;
   }
 
@@ -129,10 +134,10 @@
   setUiOverridesByUserQueryLanguage(language: string) {
     const queryEnhancement = this.queryEnhancements.get(language);
     if (queryEnhancement) {
-      const { fields = {}, showDocLinks } = queryEnhancement;
-      this.setUiOverrides({ fields, showDocLinks });
+      const { fields = {} } = queryEnhancement;
+      this.setUiOverrides({ fields });
     } else {
-      this.setUiOverrides({ fields: undefined, showDocLinks: undefined });
+      this.setUiOverrides({ fields: undefined });
     }
   }
 
@@ -167,20 +172,4 @@
   }
 }
 
-interface Deps {
-  config: ConfigSchema['enhancements'];
-  search: ISearchStart;
-  storage: DataStorage;
-  queryEnhancements: Map<string, QueryEnhancement>;
-  queryEditorExtensionMap: Record<string, QueryEditorExtensionConfig>;
-}
-
-export function createSettings({
-  config,
-  search,
-  storage,
-  queryEnhancements,
-  queryEditorExtensionMap,
-}: Deps) {
-  return new Settings(config, search, storage, queryEnhancements, queryEditorExtensionMap);
-}
+export type LanguageContract = PublicMethodsOf<LanguageManager>;

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

@@ -33,17 +33,22 @@
 import { CoreStart } from 'opensearch-dashboards/public';
 import { DataStorage, Query, SimpleDataSet, TimeRange, UI_SETTINGS } from '../../../common';
 import { createHistory, QueryHistory } from './query_history';
+import { LanguageManager } from './language_manager/language_manager';
+import { ConfigSchema } from '../../../config';
 
 export class QueryStringManager {
   private query$: BehaviorSubject<Query>;
   private queryHistory: QueryHistory;
+  public languageManager: LanguageManager;
 
   constructor(
     private readonly storage: DataStorage,
-    private readonly uiSettings: CoreStart['uiSettings']
+    private readonly uiSettings: CoreStart['uiSettings'],
+    private readonly supportedAppNames: ConfigSchema['enhancements']
   ) {
     this.query$ = new BehaviorSubject<Query>(this.getDefaultQuery());
     this.queryHistory = createHistory({ storage });
+    this.languageManager = new LanguageManager(this.supportedAppNames, this.storage);
   }
 
   private getDefaultQueryString() {
@@ -121,6 +126,10 @@
   public changeQueryHistory(listener: (reqs: any[]) => void) {
     return this.queryHistory.change(listener);
   }
+
+  public getLanguageManager() {
+    return this.languageManager;
+  }
 }
 
 export type QueryStringContract = PublicMethodsOf<QueryStringManager>;

src/plugins/data/public/search/search_service.ts

@@ -64,7 +64,7 @@
   createDataFrameCache,
   dataFrameToSpec,
 } from '../../common/data_frames';
-import { getQueryService, getUiService } from '../services';
+import { getQueryService } from '../services';
 import { UI_SETTINGS } from '../../common';
 
 /** @internal */
@@ -135,10 +135,10 @@
     { fieldFormats, indexPatterns }: SearchServiceStartDependencies
   ): ISearchStart {
     const search = ((request, options) => {
+      const queryString = getQueryService().queryString;
       const selectedLanguage = getQueryService().queryString.getQuery().language;
-      const uiService = getUiService();
-      const enhancement = uiService.Settings.getQueryEnhancements(selectedLanguage);
-      uiService.Settings.setUiOverridesByUserQueryLanguage(selectedLanguage);
+      const enhancement = queryString.getLanguageManager().getQueryEnhancements(selectedLanguage);
+      queryString.getLanguageManager().setUiOverridesByUserQueryLanguage(selectedLanguage);
       const isEnhancedEnabled = uiSettings.get(UI_SETTINGS.QUERY_ENHANCEMENTS_ENABLED);
 
       if (enhancement) {

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

@@ -61,6 +61,7 @@
 }) => {
   const searchService = getSearchService();
   const queryService = getQueryService();
+  const languageManager = queryService.queryString.getLanguageManager();
   const uiService = getUiService();
   const indexPatternsService = getIndexPatterns();
   const notifications = getNotifications();
@@ -107,14 +108,14 @@
       const selectedDataSet = ds ?? selectedDataSetState;
       if (!selectedDataSet || !selectedDataSet.id) return;
 
-      const language = uiService.Settings.getUserQueryLanguage();
-      const queryEnhancements = uiService.Settings.getQueryEnhancements(language);
+      const language = languageManager.getUserQueryLanguage();
+      const queryEnhancements = languageManager.getQueryEnhancements(language);
       const initialInput = queryEnhancements?.searchBar?.queryStringInput?.initialValue;
 
       const query = initialInput
         ? initialInput.replace('<data_source>', selectedDataSet.title!)
         : '';
-      uiService.Settings.setUserQueryString(query);
+      languageManager.setUserQueryString(query);
       queryService.queryString.setQuery({ query, language });
 
       queryService.dataSetManager.setDataSet(selectedDataSet);
@@ -143,7 +144,7 @@
 
       closePopover();
     },
-    [queryService, setSelectedDataSetState, selectedDataSetState, uiService.Settings]
+    [queryService, setSelectedDataSetState, selectedDataSetState, languageManager]
   );
 
   useEffect(() => {

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

@@ -28,14 +28,7 @@
  * under the License.
  */
 
-export {
-  UiEnhancements,
-  IUiStart,
-  IUiSetup,
-  createSettings,
-  Settings,
-  DataSettings,
-} from './types';
+export { UiEnhancements, IUiStart, IUiSetup } from './types';
 export { IndexPatternSelectProps } from './index_pattern_select';
 export { FilterLabel } from './filter_bar';
 export { QueryStringInput, QueryStringInputProps } from './query_string_input';
@@ -46,6 +39,10 @@ export {
   QueryEditorExtensions,
   QueryEditorExtensionDependencies,
   QueryEditorExtensionConfig,
+  createEditor,
+  DefaultInput,
+  DQLBody,
+  SingleLineInput,
 } from './query_editor';
 export { SearchBar, SearchBarProps, StatefulSearchBarProps } from './search_bar';
 export { SuggestionsComponent } from './typeahead';

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

@@ -27,7 +27,7 @@ interface DefaultInputProps extends React.JSX.IntrinsicAttributes {
   provideCompletionItems: monaco.languages.CompletionItemProvider['provideCompletionItems'];
 }
 
-const DefaultInput: React.FC<DefaultInputProps> = ({
+export const DefaultInput: React.FC<DefaultInputProps> = ({
   languageId,
   value,
   onChange,
@@ -95,5 +95,3 @@ const FooterItem: React.FC<{ item: FooterItem | string }> = ({ item }) => {
     </EuiText>
   );
 };
-
-export const createDefaultEditor = createEditor(SingleLineInput, null, DefaultInput);

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

@@ -4,12 +4,9 @@
  */
 
 import React from 'react';
-import { createEditor, SingleLineInput } from '../shared';
 
 interface DQLBodyProps extends React.JSX.IntrinsicAttributes {
   filterBar?: any;
 }
 
-const DQLBody: React.FC<DQLBodyProps> = ({ filterBar }) => <div>{filterBar}</div>;
-
-export const createDQLEditor = createEditor(SingleLineInput, SingleLineInput, DQLBody);
+export const DQLBody: React.FC<DQLBodyProps> = ({ filterBar }) => <div>{filterBar}</div>;

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

@@ -27,7 +27,7 @@ export interface Editor<TCollapsed, TExpanded, TBody> {
   Body: BodyComponent<TBody>;
 }
 
-interface EditorInstance<TCollapsed, TExpanded, TBody> {
+export interface EditorInstance<TCollapsed, TExpanded, TBody> {
   TopBar: {
     Collapsed: () => React.ReactElement;
     Expanded: (() => React.ReactElement) | null;