Filter Saved Search Based on AppName Supported by Language (#7999)

* Filter Saved Search Based on AppName Supported by Language Signed-off-by: Suchit Sahoo <[email protected]> * Fixed test failures Signed-off-by: Suchit Sahoo <[email protected]> --------- Signed-off-by: Suchit Sahoo <[email protected]> (cherry picked from commit f694be4) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Sep 10, 2024 · 5e2ed9a · 5e2ed9a
1 parent 4ee18a3
commit 5e2ed9a
Show file tree

Hide file tree

Showing 17 changed files with 107 additions and 7 deletions.
diff --git a/src/plugins/dashboard/public/application/utils/create_dashboard_container.tsx b/src/plugins/dashboard/public/application/utils/create_dashboard_container.tsx
@@ -282,7 +282,12 @@ const getEmptyScreenProps = (
             getFactory: embeddable.getEmbeddableFactory,
             notifications,
             overlays,
-            SavedObjectFinder: getSavedObjectFinder(savedObjects, uiSettings),
+            SavedObjectFinder: getSavedObjectFinder(
+              savedObjects,
+              uiSettings,
+              services.data,
+              services.application
+            ),
           });
         }
       } else {

diff --git a/src/plugins/dashboard/public/application/utils/get_nav_actions.tsx b/src/plugins/dashboard/public/application/utils/get_nav_actions.tsx
@@ -174,7 +174,12 @@ export const getNavActions = (
         getFactory: embeddable.getEmbeddableFactory,
         notifications,
         overlays,
-        SavedObjectFinder: getSavedObjectFinder(savedObjects, uiSettings),
+        SavedObjectFinder: getSavedObjectFinder(
+          savedObjects,
+          uiSettings,
+          services.data,
+          services.application
+        ),
       });
     }
   };

diff --git a/src/plugins/dashboard/public/plugin.tsx b/src/plugins/dashboard/public/plugin.tsx
@@ -567,7 +567,12 @@ export class DashboardPlugin
       embeddable,
     } = plugins;
 
-    const SavedObjectFinder = getSavedObjectFinder(core.savedObjects, core.uiSettings);
+    const SavedObjectFinder = getSavedObjectFinder(
+      core.savedObjects,
+      core.uiSettings,
+      plugins.data,
+      core.application
+    );
 
     const changeViewAction = new ReplacePanelAction(
       core,

diff --git a/src/plugins/data/public/query/query_string/language_service/lib/dql_language.ts b/src/plugins/data/public/query/query_string/language_service/lib/dql_language.ts
@@ -24,5 +24,6 @@ export const getDQLLanguageConfig = (
     },
     showDocLinks: true,
     editorSupportedAppNames: ['discover'],
+    supportedAppNames: ['discover', 'dashboards', 'visualize', 'data-explorer'],
   };
 };
diff --git a/src/plugins/data/public/query/query_string/language_service/lib/lucene_language.ts b/src/plugins/data/public/query/query_string/language_service/lib/lucene_language.ts
@@ -24,5 +24,6 @@ export const getLuceneLanguageConfig = (
     },
     showDocLinks: true,
     editorSupportedAppNames: ['discover'],
+    supportedAppNames: ['discover', 'dashboards', 'visualize', 'data-explorer'],
   };
 };
diff --git a/src/plugins/data/public/query/query_string/language_service/types.ts b/src/plugins/data/public/query/query_string/language_service/types.ts
@@ -50,4 +50,5 @@ export interface LanguageConfig {
   };
   showDocLinks?: boolean;
   editorSupportedAppNames?: string[];
+  supportedAppNames?: string[];
 }
diff --git a/...cover/public/application/components/top_nav/__snapshots__/open_search_panel.test.tsx.snap b/...cover/public/application/components/top_nav/__snapshots__/open_search_panel.test.tsx.snap
diff --git a/src/plugins/discover/public/application/components/top_nav/open_search_panel.tsx b/src/plugins/discover/public/application/components/top_nav/open_search_panel.tsx
@@ -57,6 +57,7 @@ export function OpenSearchPanel({ onClose, makeUrl }: Props) {
     services: {
       core: { uiSettings, savedObjects, application },
       addBasePath,
+      data,
     },
   } = useOpenSearchDashboards<DiscoverViewServices>();
 
@@ -87,6 +88,7 @@ export function OpenSearchPanel({ onClose, makeUrl }: Props) {
               name: i18n.translate('discover.savedSearch.savedObjectName', {
                 defaultMessage: 'Saved search',
               }),
+              includeFields: ['kibanaSavedObjectMeta'],
             },
           ]}
           onChoose={(id) => {
@@ -95,6 +97,8 @@ export function OpenSearchPanel({ onClose, makeUrl }: Props) {
           }}
           uiSettings={uiSettings}
           savedObjects={savedObjects}
+          application={application}
+          data={data}
         />
       </EuiFlyoutBody>
       <EuiFlyoutFooter>

diff --git a/src/plugins/discover/public/embeddable/search_embeddable_factory.tsx b/src/plugins/discover/public/embeddable/search_embeddable_factory.tsx
@@ -55,6 +55,7 @@ export class SearchEmbeddableFactory
     }),
     type: 'search',
     getIconForSavedObject: () => 'search',
+    includeFields: ['kibanaSavedObjectMeta'],
   };
 
   constructor(private getStartServices: () => Promise<StartServices>) {}

diff --git a/src/plugins/embeddable/public/plugin.tsx b/src/plugins/embeddable/public/plugin.tsx
@@ -194,7 +194,12 @@ export class EmbeddablePublicPlugin implements Plugin<EmbeddableSetup, Embeddabl
         notifications={core.notifications}
         application={core.application}
         inspector={inspector}
-        SavedObjectFinder={getSavedObjectFinder(core.savedObjects, core.uiSettings)}
+        SavedObjectFinder={getSavedObjectFinder(
+          core.savedObjects,
+          core.uiSettings,
+          data,
+          core.application
+        )}
       />
     );
 

diff --git a/src/plugins/query_enhancements/public/plugin.tsx b/src/plugins/query_enhancements/public/plugin.tsx
@@ -80,6 +80,7 @@ export class QueryEnhancementsPlugin
       showDocLinks: false,
       editor: enhancedPPLQueryEditor,
       editorSupportedAppNames: ['discover'],
+      supportedAppNames: ['discover', 'data-explorer'],
     };
     queryString.getLanguageService().registerLanguage(pplLanguageConfig);
 
@@ -98,6 +99,7 @@ export class QueryEnhancementsPlugin
       showDocLinks: false,
       editor: enhancedSQLQueryEditor,
       editorSupportedAppNames: ['discover'],
+      supportedAppNames: ['discover', 'data-explorer'],
     };
     queryString.getLanguageService().registerLanguage(sqlLanguageConfig);
 

diff --git a/src/plugins/saved_objects/public/finder/saved_object_finder.tsx b/src/plugins/saved_objects/public/finder/saved_object_finder.tsx
@@ -58,9 +58,12 @@ import {
   CoreStart,
   IUiSettingsClient,
   SavedObjectsStart,
+  ApplicationStart,
 } from 'src/core/public';
 
 import { DataSourceAttributes } from 'src/plugins/data_source/common/data_sources';
+import { DataPublicPluginStart, LanguageServiceContract } from 'src/plugins/data/public';
+import { first } from 'rxjs/operators';
 import { getIndexPatternTitle } from '../../../data/common/index_patterns/utils';
 import { LISTING_LIMIT_SETTING } from '../../common';
 
@@ -76,6 +79,7 @@ export interface SavedObjectMetaData<T = unknown> {
 interface FinderAttributes {
   title?: string;
   type: string;
+  kibanaSavedObjectMeta?: string;
 }
 
 interface SavedObjectFinderState {
@@ -122,6 +126,8 @@ export type SavedObjectFinderProps = SavedObjectFinderFixedPage | SavedObjectFin
 export type SavedObjectFinderUiProps = {
   savedObjects: CoreStart['savedObjects'];
   uiSettings: CoreStart['uiSettings'];
+  data?: DataPublicPluginStart;
+  application?: CoreStart['application'];
 } & SavedObjectFinderProps;
 
 class SavedObjectFinderUi extends React.Component<
@@ -137,8 +143,29 @@ class SavedObjectFinderUi extends React.Component<
     showFilter: PropTypes.bool,
   };
 
+  public async getCurrentAppId() {
+    return (
+      (await this.props?.application?.currentAppId$?.pipe(first()).toPromise()) ??
+      Promise.resolve(undefined)
+    );
+  }
+
+  readonly languageService = this.props.data?.query?.queryString?.getLanguageService();
   private isComponentMounted: boolean = false;
 
+  private isSavedSearchLanguageSupported(
+    languageId?: string,
+    currentAppId?: string,
+    languageService?: LanguageServiceContract
+  ) {
+    if (!languageId || !currentAppId || !languageService) {
+      return true;
+    }
+    return (
+      languageService?.getLanguage(languageId)?.supportedAppNames?.includes(currentAppId) ?? true
+    );
+  }
+
   private debouncedFetch = _.debounce(async (query: string) => {
     const metaDataMap = this.getSavedObjectMetaDataMap();
 
@@ -162,6 +189,8 @@ class SavedObjectFinderUi extends React.Component<
       return await client.get<DataSourceAttributes>('data-source', id);
     };
 
+    const currentAppId = await this.getCurrentAppId();
+
     const savedObjects = await Promise.all(
       resp.savedObjects.map(async (obj) => {
         if (obj.type === 'index-pattern') {
@@ -172,13 +201,24 @@ class SavedObjectFinderUi extends React.Component<
             getDataSource
           );
           return result;
+        } else if (obj.type === 'search') {
+          const sourceObject = JSON.parse(
+            obj.attributes?.kibanaSavedObjectMeta?.searchSourceJSON ?? null
+          );
+          const languageId = sourceObject?.query?.language;
+          if (this.isSavedSearchLanguageSupported(languageId, currentAppId, this.languageService)) {
+            return obj;
+          }
         } else {
           return obj;
         }
       })
     );
 
     resp.savedObjects = savedObjects.filter((savedObject) => {
+      if (!savedObject) {
+        return false;
+      }
       const metaData = metaDataMap[savedObject.type];
       if (metaData.showSavedObject) {
         return metaData.showSavedObject(savedObject);
@@ -571,9 +611,20 @@ class SavedObjectFinderUi extends React.Component<
   }
 }
 
-const getSavedObjectFinder = (savedObject: SavedObjectsStart, uiSettings: IUiSettingsClient) => {
+const getSavedObjectFinder = (
+  savedObject: SavedObjectsStart,
+  uiSettings: IUiSettingsClient,
+  data?: DataPublicPluginStart,
+  application?: ApplicationStart
+) => {
   return (props: SavedObjectFinderProps) => (
-    <SavedObjectFinderUi {...props} savedObjects={savedObject} uiSettings={uiSettings} />
+    <SavedObjectFinderUi
+      {...props}
+      savedObjects={savedObject}
+      uiSettings={uiSettings}
+      data={data}
+      application={application}
+    />
   );
 };
 

diff --git a/src/plugins/visualizations/public/plugin.ts b/src/plugins/visualizations/public/plugin.ts
@@ -64,6 +64,7 @@ import {
   setEmbeddable,
   setNotifications,
   setDocLinks,
+  setDataStart,
 } from './services';
 import {
   VISUALIZE_EMBEDDABLE_TYPE,
@@ -192,6 +193,7 @@ export class VisualizationsPlugin
       chrome: core.chrome,
       overlays: core.overlays,
     });
+    setDataStart(data);
     setSavedAugmentVisLoader(savedAugmentVisLoader);
     setI18n(core.i18n);
     setTypes(types);

diff --git a/src/plugins/visualizations/public/services.ts b/src/plugins/visualizations/public/services.ts
@@ -119,3 +119,5 @@ export const [getSavedAugmentVisLoader, setSavedAugmentVisLoader] = createGetter
 >('savedAugmentVisLoader');
 
 export const [getDocLinks, setDocLinks] = createGetterSetter<DocLinksStart>('docLinks');
+
+export const [getDataStart, setDataStart] = createGetterSetter<DataPublicPluginStart>('DataStart');
diff --git a/src/plugins/visualizations/public/wizard/new_vis_modal.tsx b/src/plugins/visualizations/public/wizard/new_vis_modal.tsx
@@ -34,6 +34,7 @@ import { EuiModal } from '@elastic/eui';
 import { i18n } from '@osd/i18n';
 
 import { METRIC_TYPE, UiStatsMetricType } from '@osd/analytics';
+import { DataPublicPluginStart } from 'src/plugins/data/public';
 import { ApplicationStart, IUiSettingsClient, SavedObjectsStart } from '../../../../core/public';
 import { SearchSelection } from './search_selection';
 import { TypeSelection } from './type_selection';
@@ -55,6 +56,7 @@ interface TypeSelectionProps {
   outsideVisualizeApp?: boolean;
   stateTransfer?: EmbeddableStateTransfer;
   originatingApp?: string;
+  data: DataPublicPluginStart;
 }
 
 interface TypeSelectionState {
@@ -112,6 +114,8 @@ class NewVisModal extends React.Component<TypeSelectionProps, TypeSelectionState
             visType={this.state.visType}
             uiSettings={this.props.uiSettings}
             savedObjects={this.props.savedObjects}
+            application={this.props.application}
+            data={this.props.data}
           />
         </EuiModal>
       ) : (

diff --git a/src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx b/src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx
@@ -32,7 +32,8 @@ import { EuiModalBody, EuiModalHeader, EuiModalHeaderTitle } from '@elastic/eui'
 import { i18n } from '@osd/i18n';
 import { FormattedMessage } from '@osd/i18n/react';
 import React from 'react';
-import { IUiSettingsClient, SavedObjectsStart } from '../../../../../core/public';
+import { DataPublicPluginStart } from 'src/plugins/data/public';
+import { ApplicationStart, IUiSettingsClient, SavedObjectsStart } from '../../../../../core/public';
 
 import { SavedObjectFinderUi } from '../../../../saved_objects/public';
 import { VisType } from '../../vis_types';
@@ -42,6 +43,8 @@ interface SearchSelectionProps {
   visType: VisType;
   uiSettings: IUiSettingsClient;
   savedObjects: SavedObjectsStart;
+  data: DataPublicPluginStart;
+  application: ApplicationStart;
 }
 
 export class SearchSelection extends React.Component<SearchSelectionProps> {
@@ -85,6 +88,7 @@ export class SearchSelection extends React.Component<SearchSelectionProps> {
                     defaultMessage: 'Saved search',
                   }
                 ),
+                includeFields: ['kibanaSavedObjectMeta'],
               },
               {
                 type: 'index-pattern',
@@ -100,6 +104,8 @@ export class SearchSelection extends React.Component<SearchSelectionProps> {
             fixedPageSize={this.fixedPageSize}
             uiSettings={this.props.uiSettings}
             savedObjects={this.props.savedObjects}
+            application={this.props.application}
+            data={this.props.data}
           />
         </EuiModalBody>
       </React.Fragment>

diff --git a/src/plugins/visualizations/public/wizard/show_new_vis.tsx b/src/plugins/visualizations/public/wizard/show_new_vis.tsx
@@ -41,6 +41,7 @@ import {
   getUsageCollector,
   getApplication,
   getEmbeddable,
+  getDataStart,
 } from '../services';
 
 export interface ShowNewVisModalParams {
@@ -90,6 +91,7 @@ export function showNewVisModal({
         savedObjects={getSavedObjects()}
         usageCollection={getUsageCollector()}
         application={getApplication()}
+        data={getDataStart()}
       />
     </I18nProvider>
   );