[Discover-next] Add query editor extensions #7034

joshuali925 · 2024-06-14T22:20:37Z

Description

This PR picks #6894, #6895, #6933, #6972 to main. Additionally,

separates extensions from query enhancements
adds banner support
partially revert [Discover-next] Support data sources for query assist #6972 as it's pending on the data source commit to main
renames search bar extension to query editor extension

A query editor extension can display a UI component above the query editor and/or a banner above the language selector. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of UI Enhancements.

export interface QueryEditorExtensionDependencies {
  /**
   * Currently selected index patterns.
   */
  indexPatterns?: Array<IIndexPattern | string>;
  /**
   * Currently selected data source.
   */
  dataSource?: DataSource;
  /**
   * Currently selected query language.
   */
  language: string;
}

export interface QueryEditorExtensionConfig {
  /**
   * The id for the search bar extension.
   */
  id: string;
  /**
   * Lower order indicates higher position on UI.
   */
  order: number;
  /**
   * A function that determines if the search bar extension is enabled and should be rendered on UI.
   * @returns whether the extension is enabled.
   */
  isEnabled: (dependencies: QueryEditorExtensionDependencies) => Promise<boolean>;
  /**
   * A function that returns the search bar extension component. The component
   * will be displayed on top of the query editor in the search bar.
   * @param dependencies - The dependencies required for the extension.
   * @returns The component the search bar extension.
   */
  getComponent?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null;
  /**
   * A function that returns the search bar extension banner. The banner is a
   * component that will be displayed on top of the search bar.
   * @param dependencies - The dependencies required for the extension.
   * @returns The component the search bar extension.
   */
  getBanner?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null;
}

export interface UiEnhancements {
  query?: QueryEnhancement;
+ queryEditorExtension?: QueryEditorExtensionConfig;
}

Issues Resolved

Developers can utilize search bar extensions to add additional features to the search bar, such as query assist.

Part of #6077

Screenshot

Testing the changes

Changelog

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

@returns

A search bar extension can display a UI component above the query bar. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of Query Enhancements. ```ts export interface SearchBarExtensionDependencies { /** * Currently selected index patterns. */ indexPatterns?: IIndexPattern[]; } export interface SearchBarExtensionConfig { /** * The id for the search bar extension. */ id: string; /** * Lower order indicates higher position on UI. */ order: number; /** * A function that determines if the search bar extension is enabled and should be rendered on UI. * @returns whether the extension is enabled. */ isEnabled: () => Promise<boolean>; /** * A function that returns the mount point for the search bar extension. * @param dependencies - The dependencies required for the extension. * @returns The mount point for the search bar extension. */ getComponent: (dependencies: SearchBarExtensionDependencies) => React.ReactElement; } export interface QueryEnhancement { ... searchBar?: { ... extensions?: SearchBarExtensionConfig[]; }; } Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit e748e81)

…arch-project#6895) it adds query assist specific logic in query enhancements plugin to show a UI above the PPL search bar if user has configured PPL agent. Issues Resolved: opensearch-project#6820 * add query assist to query enhancements Signed-off-by: Joshua Li <joshuali925@gmail.com> * align language to uppercase Signed-off-by: Joshua Li <joshuali925@gmail.com> * pick PR 6167 Signed-off-by: Joshua Li <joshuali925@gmail.com> * use useState hooks for query assist There is a bug in data explorer `AppContainer` where memorized `DiscoverCanvas` gets unmounted after `setQuery`. PR 6167 works around it by memorizing `AppContainer`. As query assist is no longer being unmounted, we can use proper hooks to persist state now. Signed-off-by: Joshua Li <joshuali925@gmail.com> * Revert "pick PR 6167" This reverts commit acb0d41. Wait for official 6167 to merge to avoid conflict Signed-off-by: Joshua Li <joshuali925@gmail.com> * address comments for PR 6894 Signed-off-by: Joshua Li <joshuali925@gmail.com> --------- Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit 016e0f2)

…assist (opensearch-project#6933) * pass dependencies to isEnabled func Signed-off-by: Joshua Li <joshuali925@gmail.com> * add lazy and memo to search bar extensions Signed-off-by: Joshua Li <joshuali925@gmail.com> * move ppl specific string out from query assist Signed-off-by: Joshua Li <joshuali925@gmail.com> * prevent setstate after hook unmounts Signed-off-by: Joshua Li <joshuali925@gmail.com> * add max-height to search bar extensions Signed-off-by: Joshua Li <joshuali925@gmail.com> * prevent setstate after component unmounts Signed-off-by: Joshua Li <joshuali925@gmail.com> * move ml-commons API to common/index.ts Signed-off-by: Joshua Li <joshuali925@gmail.com> * improve i18n and accessibility usages Signed-off-by: Joshua Li <joshuali925@gmail.com> * add hard-coded suggestions for sample data indices Signed-off-by: Joshua Li <joshuali925@gmail.com> --------- Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit 4aade0f)

…ject#6972) * disable query assist for non-default datasource Signed-off-by: Joshua Li <joshuali925@gmail.com> * disable query assist input when loading Signed-off-by: Joshua Li <joshuali925@gmail.com> * support MDS for query assist Signed-off-by: Joshua Li <joshuali925@gmail.com> * add unit tests for agents Signed-off-by: Joshua Li <joshuali925@gmail.com> * Revert "add unit tests for agents" This reverts commit 983514e. The test configs are not yet setup in query_enhancements plugins. Signed-off-by: Joshua Li <joshuali925@gmail.com> --------- Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit 328e08e)

SearchBar extensions depend on the currently selected dataSource, which depends on opensearch-project#6833 to be ported to main Signed-off-by: Joshua Li <joshuali925@gmail.com>

github-actions · 2024-06-14T22:21:09Z

ℹ️ Manual Changeset Creation Reminder

Please ensure manual commit for changeset file 7034.yml under folder changelogs/fragments to complete this PR.

If you want to use the available OpenSearch Changeset Bot App to avoid manual creation of changeset file you can install it in your forked repository following this link.

For more information about formatting of changeset files, please visit OpenSearch Auto Changeset and Release Notes Tool.

Signed-off-by: Joshua Li <joshuali925@gmail.com>

codecov · 2024-06-14T22:34:21Z

Codecov Report

Attention: Patch coverage is 75.75758% with 8 lines in your changes missing coverage. Please review.

Project coverage is 67.45%. Comparing base (a4aa682) to head (7f0e39e).
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/plugins/data/public/ui/ui_service.ts	0.00%	3 Missing ⚠️
...query_editor_extensions/query_editor_extension.tsx	88.23%	0 Missing and 2 partials ⚠️
src/plugins/data/public/ui/settings/settings.ts	0.00%	2 Missing ⚠️
.../ui/query_editor/query_editor_extensions/index.tsx	75.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7034   +/-   ##
=======================================
  Coverage   67.44%   67.45%           
=======================================
  Files        3444     3447    +3     
  Lines       67865    67905   +40     
  Branches    11027    11034    +7     
=======================================
+ Hits        45772    45802   +30     
- Misses      19429    19436    +7     
- Partials     2664     2667    +3

Flag	Coverage Δ
Linux_1	`33.07% <0.00%> (-0.01%)`	⬇️
Linux_2	`55.11% <ø> (ø)`
Linux_3	`45.26% <75.75%> (+0.03%)`	⬆️
Linux_4	`34.85% <0.00%> (-0.01%)`	⬇️
Windows_1	`33.09% <0.00%> (-0.01%)`	⬇️
Windows_2	`55.06% <ø> (ø)`
Windows_3	`45.27% <75.75%> (+0.03%)`	⬆️
Windows_4	`34.85% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

To support bannar callout for query assist in un-supported languages and notify user the feature, the search bar extensions need to be enabled for all languages. Signed-off-by: Joshua Li <joshuali925@gmail.com>

kavilla

awesome !!! looks great.

have a couple comments and nits, but nothing blocking and could just be fast follows after merging this.

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

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

kavilla · 2024-06-15T22:02:22Z

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

@@ -497,6 +496,7 @@ class SearchBarUI extends Component<SearchBarProps, State> {
 screenTitle={this.props.screenTitle}
 onSubmit={this.onQueryBarSubmit}
 indexPatterns={this.props.indexPatterns}
+ dataSource={this.props.dataSource}


quick question: do we know if this will have to be reset if toggling this feature off?

like if the select a datasource and toggle it off and that data source isn't available that should be fine right? or do we think in the future we will need to reset it like how i do here: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/public/ui/settings/settings.ts#L52.

this 100% makes sense to me as you have it right now so I don't think we should change this because it's being passed in like index Patterns. but if we do think there might be implications on the toggle on and then off again, might be worth renaming the UI Settings service to something to else to be more descriptive and reset all that stuff in that service.

i'm not sure what the behavior would be, i wasn't able to test with data source too much. will need to revisit when we have the test environment

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

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

src/plugins/data/public/index.ts

kavilla · 2024-06-15T22:33:32Z

src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx

+ * A function that determines if the search bar extension is enabled and should be rendered on UI.
+ * @returns whether the extension is enabled.
+ */
+ isEnabled: (dependencies: SearchBarExtensionDependencies) => Promise<boolean>;


nit: should we consider making this a behavior subject? then appending $ like isEnabled$ might be easier to distinguish that i should subscribe to it.

i haven't used observables much, a quick search tells me to use const isEnabled$ = (dependencies) => from(isEnabled(dependencies)); which i can't see what the benefit is. could you elaborate more a bit?

src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx

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

src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx

kavilla · 2024-06-15T23:00:54Z

@joshuali925 you just have to install the bot: #7034 (comment) to your github then within the Changelog section of the PR description:, you can add the information in the correct format there and the changelog will automatically be generated with no manually requirement which we then use for the release notes generation. More info: #5519

Plugins should be able to onboard this too. s/o @BigSamu 🎆 this has been such a time saver.

src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx

move SearchBarExtensions to QueryEditorExtensions and change config settings from list to map. Signed-off-by: Joshua Li <joshuali925@gmail.com>

Signed-off-by: Joshua Li <joshuali925@gmail.com>

AMoo-Miki · 2024-06-19T23:17:37Z

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

+ const { configMap, componentContainer, bannerContainer, ...dependencies } = props;
+
+ const sortedConfigs = useMemo(() => {
+ if (!configMap || !Object.keys(configMap)) return [];


Object.keys will either return an array or throw. ![] is false always. If this was meant to prevent wasting time on an empty object, it fails to do that.

Suggested change

if (!configMap || !Object.keys(configMap)) return [];

if ('[object Object]' !== Object.prototype.toString.call(configMap) || Object.keys(configMap).length === 0) return [];

This will need linting though.

thanks good point on .length === 0, i missed that

is the object check necessary or conventional in OSD?

AMoo-Miki · 2024-06-19T23:21:24Z

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

+ if (
+ !shouldRenderQueryEditorExtensions() ||
+ !queryEditorHeaderRef.current ||
+ !queryEditorBannerRef.current ||
+ !queryLanguage
+ )


nit: perf

Suggested change

if (

!shouldRenderQueryEditorExtensions() ||

!queryEditorHeaderRef.current ||

!queryEditorBannerRef.current ||

!queryLanguage

)

if (!(

queryEditorHeaderRef.current &&

queryEditorBannerRef.current &&

queryLanguage &&

shouldRenderQueryEditorExtensions()

))

AMoo-Miki · 2024-06-19T23:23:05Z

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

@@ -282,6 +304,10 @@ export default function QueryEditorTopRow(props: QueryEditorTopRowProps) {
 );
 }

+ function shouldRenderQueryEditorExtensions(): boolean {
+ return Boolean(queryEditorExtensionMap && Object.keys(queryEditorExtensionMap).length);


Do we trust that queryEditorExtensionMap is going to be a plain object? I am not sure where it is coming from and hence asking: could it possibly be manipulated in the metadata store?

OpenSearch-Dashboards/src/plugins/data/public/ui/ui_service.ts

Line 31 in 7f0e39e

private queryEditorExtensionMap: Record<string, QueryEditorExtensionConfig> = {};

OpenSearch-Dashboards/src/plugins/data/public/ui/ui_service.ts

Lines 48 to 51 in 7f0e39e

if (enhancements.queryEditorExtension) {

this.queryEditorExtensionMap[enhancements.queryEditorExtension.id] =

enhancements.queryEditorExtension;

}

what is the metadata store?

AMoo-Miki · 2024-06-19T23:25:26Z

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

@@ -43,6 +45,10 @@ export class UiService implements Plugin<IUiSetup, IUiStart> {
 if (enhancements.query && enhancements.query.language) {
 this.queryEnhancements.set(enhancements.query.language, enhancements.query);
 }
+ if (enhancements.queryEditorExtension) {


Should this maybe be?

Suggested change

if (enhancements.queryEditorExtension) {

if (enhancements.queryEditorExtension?.id) {

id is enforced on the type level, is type checking not enough and we prefer to also add runtime checking in osd?

kavilla · 2024-06-20T10:00:42Z

Since this is disabled as default and @AMoo-Miki not blocking. Feel free to add to this issue with fast follows: #6957 (comment) or create a new issue than you can handle fast follows from here.

@returns

### Description see #6894 This PR picks #6894, #6895, #6933, #6972 to main. Additionally, - separates extensions from query enhancements - adds banner support - partially revert #6972 as it's pending on the data source commit to main - renames search bar extension to query editor extension A query editor extension can display a UI component above the query editor and/or a banner above the language selector. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of UI Enhancements. ```ts export interface QueryEditorExtensionDependencies { /** * Currently selected index patterns. */ indexPatterns?: Array<IIndexPattern | string>; /** * Currently selected data source. */ dataSource?: DataSource; /** * Currently selected query language. */ language: string; } export interface QueryEditorExtensionConfig { /** * The id for the search bar extension. */ id: string; /** * Lower order indicates higher position on UI. */ order: number; /** * A function that determines if the search bar extension is enabled and should be rendered on UI. * @returns whether the extension is enabled. */ isEnabled: (dependencies: QueryEditorExtensionDependencies) => Promise<boolean>; /** * A function that returns the search bar extension component. The component * will be displayed on top of the query editor in the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getComponent?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; /** * A function that returns the search bar extension banner. The banner is a * component that will be displayed on top of the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getBanner?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; } export interface UiEnhancements { query?: QueryEnhancement; + queryEditorExtension?: QueryEditorExtensionConfig; } ``` Developers can utilize search bar extensions to add additional features to the search bar, such as query assist. Issues resolved: #6077 A search bar extension can display a UI component above the query bar. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of Query Enhancements. Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit 4f54049) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

virajsanghvi · 2024-06-20T16:36:29Z

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

+ if (isMounted.current) setIsEnabled(enabled);
+ });
+ }, [props.dependencies, props.config]);
+
+ if (!isEnabled) return null;


nit: use braces even for single line if statements

i think this would be a good linter rule. I personally prefer one line if-returns, but i agree using braces is a better practice

i'll create an issue to track this and enable eslint curly, without linter there might be missed ones or mistakes

virajsanghvi · 2024-06-20T16:47:37Z

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

+ bannerContainer: Element;
+}
+
+const QueryEditorExtensions: React.FC<QueryEditorExtensionsProps> = React.memo((props) => {


nit: is there a better name for this given its both a collection of extensions as well as specifying their destinations (and its easy to confuse components that are one character apart). perhaps its a manager as its responsibilities could include managing what gets rendered if we want more rules than rendering everything

maybe QueryEditorExtensionManager and QueryEditorExtension? but I'm not very sure if a manager is something that should be rendered on the page, current impl needs QueryEditor to render QueryEditorExtensions. The one character naming existed in other places, like suggestion_component and suggestions_component, although i do find it to be confusing

virajsanghvi · 2024-06-20T16:48:18Z

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

+} from './query_editor_extension';
+
+interface QueryEditorExtensionsProps extends QueryEditorExtensionDependencies {
+ configMap?: Record<string, QueryEditorExtensionConfig>;


q: is there a reason this has to be a map vs an array?

consistency with existing code, see #7034 (comment)

@returns

### Description see #6894 This PR picks #6894, #6895, #6933, #6972 to main. Additionally, - separates extensions from query enhancements - adds banner support - partially revert #6972 as it's pending on the data source commit to main - renames search bar extension to query editor extension A query editor extension can display a UI component above the query editor and/or a banner above the language selector. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of UI Enhancements. ```ts export interface QueryEditorExtensionDependencies { /** * Currently selected index patterns. */ indexPatterns?: Array<IIndexPattern | string>; /** * Currently selected data source. */ dataSource?: DataSource; /** * Currently selected query language. */ language: string; } export interface QueryEditorExtensionConfig { /** * The id for the search bar extension. */ id: string; /** * Lower order indicates higher position on UI. */ order: number; /** * A function that determines if the search bar extension is enabled and should be rendered on UI. * @returns whether the extension is enabled. */ isEnabled: (dependencies: QueryEditorExtensionDependencies) => Promise<boolean>; /** * A function that returns the search bar extension component. The component * will be displayed on top of the query editor in the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getComponent?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; /** * A function that returns the search bar extension banner. The banner is a * component that will be displayed on top of the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getBanner?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; } export interface UiEnhancements { query?: QueryEnhancement; + queryEditorExtension?: QueryEditorExtensionConfig; } ``` Developers can utilize search bar extensions to add additional features to the search bar, such as query assist. Issues resolved: #6077 A search bar extension can display a UI component above the query bar. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of Query Enhancements. (cherry picked from commit 4f54049) Signed-off-by: Joshua Li <joshuali925@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

@returns

### Description see opensearch-project#6894 This PR picks opensearch-project#6894, opensearch-project#6895, opensearch-project#6933, opensearch-project#6972 to main. Additionally, - separates extensions from query enhancements - adds banner support - partially revert opensearch-project#6972 as it's pending on the data source commit to main - renames search bar extension to query editor extension A query editor extension can display a UI component above the query editor and/or a banner above the language selector. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of UI Enhancements. ```ts export interface QueryEditorExtensionDependencies { /** * Currently selected index patterns. */ indexPatterns?: Array<IIndexPattern | string>; /** * Currently selected data source. */ dataSource?: DataSource; /** * Currently selected query language. */ language: string; } export interface QueryEditorExtensionConfig { /** * The id for the search bar extension. */ id: string; /** * Lower order indicates higher position on UI. */ order: number; /** * A function that determines if the search bar extension is enabled and should be rendered on UI. * @returns whether the extension is enabled. */ isEnabled: (dependencies: QueryEditorExtensionDependencies) => Promise<boolean>; /** * A function that returns the search bar extension component. The component * will be displayed on top of the query editor in the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getComponent?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; /** * A function that returns the search bar extension banner. The banner is a * component that will be displayed on top of the search bar. * @param dependencies - The dependencies required for the extension. * @returns The component the search bar extension. */ getBanner?: (dependencies: QueryEditorExtensionDependencies) => React.ReactElement | null; } export interface UiEnhancements { query?: QueryEnhancement; + queryEditorExtension?: QueryEditorExtensionConfig; } ``` Developers can utilize search bar extensions to add additional features to the search bar, such as query assist. Issues resolved: opensearch-project#6077 A search bar extension can display a UI component above the query bar. The component has the ability to read and write discover search bar states to enhance the search experience for users. The configuration is part of Query Enhancements. Signed-off-by: Joshua Li <joshuali925@gmail.com>

@AMoo-Miki

#7077) Follow up for #7034, this PR - addresses #7034 (comment) - addresses #7034 (comment) - fixes render order - QueryEditorExtensions requires the container divs to be mounted first, but in the previous implementation, extensions will be mounted first and it relied on rerendering of queryEditorTopRow. Moving them into query editor fixes the render order and ensures refs are set. @AMoo-Miki I didn't use the object check `'[object Object]' !== Object.prototype.toString.call(configMap)`. I don't know what access user has, but if an attacker can arbitrarily alter `configMap`, the code will still break with something like ```tsx configMap={ new Proxy( {}, { ownKeys(target) { throw new Error('Accessing keys is not allowed.'); }, } ) } ``` Given that our code creates the config map here, I think relying on static type check is enough, but feel free to comment if otherwise. https://github.com/opensearch-project/OpenSearch-Dashboards/blob/7f0e39eb9809c95b98069cc971611edc2cbbc62b/src/plugins/data/public/ui/ui_service.ts#L31 Signed-off-by: Joshua Li <joshuali925@gmail.com>

@AMoo-Miki

#7077) Follow up for #7034, this PR - addresses #7034 (comment) - addresses #7034 (comment) - fixes render order - QueryEditorExtensions requires the container divs to be mounted first, but in the previous implementation, extensions will be mounted first and it relied on rerendering of queryEditorTopRow. Moving them into query editor fixes the render order and ensures refs are set. @AMoo-Miki I didn't use the object check `'[object Object]' !== Object.prototype.toString.call(configMap)`. I don't know what access user has, but if an attacker can arbitrarily alter `configMap`, the code will still break with something like ```tsx configMap={ new Proxy( {}, { ownKeys(target) { throw new Error('Accessing keys is not allowed.'); }, } ) } ``` Given that our code creates the config map here, I think relying on static type check is enough, but feel free to comment if otherwise. https://github.com/opensearch-project/OpenSearch-Dashboards/blob/7f0e39eb9809c95b98069cc971611edc2cbbc62b/src/plugins/data/public/ui/ui_service.ts#L31 Signed-off-by: Joshua Li <joshuali925@gmail.com> (cherry picked from commit b85e177) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

@AMoo-Miki

#7077) (#7140) Follow up for #7034, this PR - addresses #7034 (comment) - addresses #7034 (comment) - fixes render order - QueryEditorExtensions requires the container divs to be mounted first, but in the previous implementation, extensions will be mounted first and it relied on rerendering of queryEditorTopRow. Moving them into query editor fixes the render order and ensures refs are set. @AMoo-Miki I didn't use the object check `'[object Object]' !== Object.prototype.toString.call(configMap)`. I don't know what access user has, but if an attacker can arbitrarily alter `configMap`, the code will still break with something like ```tsx configMap={ new Proxy( {}, { ownKeys(target) { throw new Error('Accessing keys is not allowed.'); }, } ) } ``` Given that our code creates the config map here, I think relying on static type check is enough, but feel free to comment if otherwise. https://github.com/opensearch-project/OpenSearch-Dashboards/blob/7f0e39eb9809c95b98069cc971611edc2cbbc62b/src/plugins/data/public/ui/ui_service.ts#L31 (cherry picked from commit b85e177) Signed-off-by: Joshua Li <joshuali925@gmail.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

joshuali925 added 5 commits June 14, 2024 18:32

partially revert 5b2ad95

84a2013

SearchBar extensions depend on the currently selected dataSource, which depends on opensearch-project#6833 to be ported to main Signed-off-by: Joshua Li <joshuali925@gmail.com>

joshuali925 requested review from ananzh, kavilla, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, curq, bandinib-amzn, SuZhou-Joe, ruanyl, BionIT, xinruiba, zhyuanqi and mengweieric as code owners June 14, 2024 22:20

github-actions bot added the repeat-contributor label Jun 14, 2024

github-actions bot added the failed changeset label Jun 14, 2024

add changelog fragment

e798287

Signed-off-by: Joshua Li <joshuali925@gmail.com>

separate searchBarExtensions from queryEnhancements

8b0af9d

To support bannar callout for query assist in un-supported languages and notify user the feature, the search bar extensions need to be enabled for all languages. Signed-off-by: Joshua Li <joshuali925@gmail.com>

kavilla previously approved these changes Jun 15, 2024

View reviewed changes

kavilla reviewed Jun 15, 2024

View reviewed changes

src/plugins/data/public/ui/search_bar_extensions/search_bar_extension.tsx Outdated Show resolved Hide resolved

joshuali925 added 2 commits June 17, 2024 13:31

refactor search bar extensions

edb0390

move SearchBarExtensions to QueryEditorExtensions and change config settings from list to map. Signed-off-by: Joshua Li <joshuali925@gmail.com>

address comments

886ace5

Signed-off-by: Joshua Li <joshuali925@gmail.com>

joshuali925 dismissed kavilla’s stale review via 886ace5 June 17, 2024 20:36

joshuali925 marked this pull request as draft June 17, 2024 20:52

change query editor extension configs from map to record

7f0e39e

Signed-off-by: Joshua Li <joshuali925@gmail.com>

joshuali925 marked this pull request as ready for review June 17, 2024 21:07

kavilla approved these changes Jun 18, 2024

View reviewed changes

joshuali925 changed the title ~~[Discover-next] Add search bar extensions~~ [Discover-next] Add query editor extensions Jun 19, 2024

abbyhu2000 approved these changes Jun 19, 2024

View reviewed changes

AMoo-Miki reviewed Jun 19, 2024

View reviewed changes

kavilla merged commit 4f54049 into opensearch-project:main Jun 20, 2024
69 checks passed

opensearch-trigger-bot bot mentioned this pull request Jun 20, 2024

[Backport 2.x] [Discover-next] Add query editor extensions #7075

Merged

virajsanghvi reviewed Jun 20, 2024

View reviewed changes

This was referenced Jun 20, 2024

[Discover-Next] Meta Issue for Bugs, Updates, Fast-Follows #6957

Closed

Fix object empty check and minor perf issue in query editor extensions #7077

Merged

joshuali925 mentioned this pull request Jul 5, 2024

[Discover-next] (QueryEditorExtensions) change isEnabled to an observable #7183

Merged

7 tasks

kavilla mentioned this pull request Aug 22, 2024

Add registrable DiscoverActions to discover page #7793

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover-next] Add query editor extensions #7034

[Discover-next] Add query editor extensions #7034

joshuali925 commented Jun 14, 2024 •

edited

Loading

github-actions bot commented Jun 14, 2024

codecov bot commented Jun 14, 2024 •

edited

Loading

kavilla left a comment

kavilla Jun 15, 2024

joshuali925 Jun 17, 2024

kavilla Jun 15, 2024

joshuali925 Jun 17, 2024

kavilla commented Jun 15, 2024 •

edited

Loading

AMoo-Miki Jun 19, 2024 •

edited

Loading

joshuali925 Jun 19, 2024

AMoo-Miki Jun 19, 2024

AMoo-Miki Jun 19, 2024

joshuali925 Jun 19, 2024

AMoo-Miki Jun 19, 2024

joshuali925 Jun 19, 2024

kavilla commented Jun 20, 2024

virajsanghvi Jun 20, 2024

joshuali925 Jun 20, 2024

virajsanghvi Jun 20, 2024

joshuali925 Jun 20, 2024

virajsanghvi Jun 20, 2024

joshuali925 Jun 20, 2024

	if (!configMap \|\| !Object.keys(configMap)) return [];
	if ('[object Object]' !== Object.prototype.toString.call(configMap) \|\| Object.keys(configMap).length === 0) return [];

	if (enhancements.queryEditorExtension) {
	this.queryEditorExtensionMap[enhancements.queryEditorExtension.id] =
	enhancements.queryEditorExtension;
	}

	if (enhancements.queryEditorExtension) {
	if (enhancements.queryEditorExtension?.id) {

[Discover-next] Add query editor extensions #7034

[Discover-next] Add query editor extensions #7034

Conversation

joshuali925 commented Jun 14, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Jun 14, 2024

ℹ️ Manual Changeset Creation Reminder

codecov bot commented Jun 14, 2024 • edited Loading

Codecov Report

kavilla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kavilla commented Jun 15, 2024 • edited Loading

AMoo-Miki Jun 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kavilla commented Jun 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshuali925 commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading

kavilla commented Jun 15, 2024 •

edited

Loading

AMoo-Miki Jun 19, 2024 •

edited

Loading