[Discover-next] add query assist to query enhancements plugin #6895
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ℹ️ Manual Changeset Creation ReminderPlease ensure manual commit for changeset file 6895.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. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## feature/discover-next #6895 +/- ##
========================================================
Coverage ? 67.01%
========================================================
Files ? 3451
Lines ? 68216
Branches ? 11141
========================================================
Hits ? 45712
Misses ? 19883
Partials ? 2621
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
kavilla
force-pushed
the
feature/discover-next
branch
from
5b180dc to
cb6ab68
Compare
joshuali925
force-pushed
the
feature/query-assist
branch
2 times, most recently
from
dbf40d6 to
21d0426
Compare
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
kavilla
reviewed
Jun 4, 2024
| const params = { | ||
| question: inputRef.current.value, | ||
| index: selectedIndex, | ||
| language: 'PPL', |
There was a problem hiding this comment.
Future proofing, could we make this more generic even if it only works for PPL right now?
The last query in the query service should have the language attached to it assuming that is the language. And even more straight forward approach and preferred could be pulling from localstorage:
which you can access from the ui service in the data plugin:
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/public/ui/ui_service.ts#L65
There was a problem hiding this comment.
good point i missed moving this to a variable
query assist can run before before any query runs, would localStorage be set after changing language or executing query? I tested on my side but didn't see this key in localStorage
i think i can still pass in language when creating the query assist search bar extension, since currently they are language specific
kavilla
reviewed
Jun 4, 2024
| id: 'query-assist-ppl', | ||
| order: 1000, | ||
| isEnabled: (() => { | ||
| let agentConfigured: boolean; |
There was a problem hiding this comment.
do we want to pull from advanced settings to be able to catch all disable extensions?
kavilla
reviewed
Jun 4, 2024
| storage: IStorageWrapper, | ||
| language: string | ||
| ) { | ||
| return new PersistedLog( |
kavilla
reviewed
Jun 4, 2024
| isDisabled={props.isDisabled} | ||
| size="s" | ||
| type="submit" | ||
| aria-label="submit-question" |
There was a problem hiding this comment.
do we want to make this more detailed? imo i think it's fine as is for accessibility purposes but i'm not expert. perhaps we can get u/x feedback on what the aria label should be. like should be "Submit question to query assistant".
kavilla
reviewed
Jun 4, 2024
| }, [props.persistedLog, value]); | ||
|
|
||
| return ( | ||
| <EuiOutsideClickDetector onOutsideClick={() => setIsSuggestionsVisible(false)}> |
There was a problem hiding this comment.
should we check with ux to see if they want us to also submit the question if set on an outside click?
There was a problem hiding this comment.
then if user clicks the data-grid to copy a field, since it's an outside click, their incomplete question will be submitted. i think that can be weird?
kavilla
reviewed
Jun 4, 2024
| import { RequestBody, TransportRequestPromise } from '@opensearch-project/opensearch/lib/Transport'; | ||
| import { RequestHandlerContext } from 'src/core/server'; | ||
|
|
||
| const ML_COMMONS_API_PREFIX = '/_plugins/_ml'; |
There was a problem hiding this comment.
kavilla
reviewed
Jun 4, 2024
| import { RequestHandlerContext } from 'src/core/server'; | ||
|
|
||
| const ML_COMMONS_API_PREFIX = '/_plugins/_ml'; | ||
| const AGENT_REQUEST_OPTIONS = { |
There was a problem hiding this comment.
this should be an advanced setting and pull from that: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/server/ui_settings.ts
i will work on adding the base one and people can add to it
kavilla
reviewed
Jun 4, 2024
| const EmptyQueryCallOut: React.FC<CalloutDismiss> = (props) => ( | ||
| <EuiCallOut | ||
| data-test-subj="query-assist-empty-query-callout" | ||
| title="Enter a natural language question to automatically generate a query to view results." |
There was a problem hiding this comment.
do these need i18n and aria-labels.
kavilla
approved these changes
Jun 4, 2024
Signed-off-by: Joshua Li <joshuali925@gmail.com>
Signed-off-by: Joshua Li <joshuali925@gmail.com>
Signed-off-by: Joshua Li <joshuali925@gmail.com>
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>
This reverts commit acb0d41. Wait for official 6167 to merge to avoid conflict Signed-off-by: Joshua Li <joshuali925@gmail.com>
Signed-off-by: Joshua Li <joshuali925@gmail.com>
joshuali925
force-pushed
the
feature/query-assist
branch
from
21d0426 to
9c09135
Compare
kavilla
merged commit 8bb3b5d
into
opensearch-project:feature/discover-next
27 of 52 checks passed
kavilla
pushed a commit
that referenced
this pull request
Jun 5, 2024
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: #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>
7 tasks
joshuali925
added a commit
to joshuali925/OpenSearch-Dashboards
that referenced
this pull request
Jun 14, 2024
…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)
This was referenced Jun 14, 2024
kavilla
pushed a commit
that referenced
this pull request
Jun 20, 2024
### 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>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jun 20, 2024
### 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>
kavilla
pushed a commit
that referenced
this pull request
Jun 22, 2024
### 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>
mengweieric
pushed a commit
to mengweieric/OpenSearch-Dashboards
that referenced
this pull request
Jun 24, 2024
### 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>
kavilla
added a commit
to kavilla/queryEnhancements
that referenced
this pull request
Jun 25, 2024
This PR picks [Discover-next] add query assist to query enhancements plugin opensearch-project/OpenSearch-Dashboards#6895 [Discover-next] Address comments for search bar extensions and query assist opensearch-project/OpenSearch-Dashboards#6933 [Discover-next] Support data sources for query assist opensearch-project/OpenSearch-Dashboards#6972 adds query assist banner a callout that advertises query assist when user has at least 1 language with query assist configured and is not on a configured language adds index selector for local cluster only This is a temporary solution given that in discover the index pattern selector will be removed. Before datasource and dataset selectors are added, query assist will rely on this index pattern selector to determine which index user wants to query. Signed-off-by: Joshua Li <joshuali925@gmail.com>
kavilla
pushed a commit
to kavilla/OpenSearch-Dashboards-1
that referenced
this pull request
Jul 9, 2024
…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)
kavilla
added a commit
that referenced
this pull request
Jul 16, 2024
### Description Introduces the addition of a new core plugin called `Query Enhancements` This plugin seems to be focused on enhancing query capabilities, particularly in areas like PPL (Piped Processing Language), SQL, and natural language query assistance. #### Plugin Configuration and Setup The plugin is set up with the necessary configuration files: - src/plugins/query_enhancements/opensearch_dashboards.json: Defines the plugin's metadata and dependencies. - src/plugins/query_enhancements/common/config.ts: Contains the configuration schema for the plugin. - src/plugins/query_enhancements/public/plugin.tsx: The main plugin file that sets up the public-facing part of the plugin. - src/plugins/query_enhancements/server/plugin.ts: The server-side setup for the plugin. #### Query Assist Feature A significant part of the plugin is dedicated to a "Query Assist" feature: - src/plugins/query_enhancements/public/query_assist/: This directory contains components, hooks, and utilities for the Query Assist feature. - src/plugins/query_enhancements/public/query_assist/components/query_assist_bar.tsx: A React component for the Query Assist bar. - src/plugins/query_enhancements/server/routes/query_assist/: Server-side routing for Query Assist functionality. #### Search Interceptors The plugin introduces several search interceptors: - src/plugins/query_enhancements/public/search/ppl_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_async_search_interceptor.ts These interceptors likely modify or enhance the search functionality for different query languages. #### Data Source Connection There's a new feature for data source connections: - src/plugins/query_enhancements/public/data_source_connection/: This directory contains components and services for managing data source connections. #### Server-side Search Strategies The plugin implements server-side search strategies for different query types: - src/plugins/query_enhancements/server/search/ppl_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_async_search_strategy.ts #### Modifications to Existing Files There are some modifications to existing files outside the new plugin directory: - src/plugins/data/public/index.ts: Exports new types and interfaces. - src/plugins/data/public/ui/index.ts: Exports new UI components. - src/plugins/data/public/ui/query_editor/index.tsx: Modifies the QueryEditor component. #### Testing The plugin includes a comprehensive test setup: - src/plugins/query_enhancements/test/: Contains Jest configuration and setup files for testing. #### Acknowledgements Contains work by @sejli @joshuali925 @Swiddis @paulstn @mengweieric Thx @ashwin-pc for the description summary ### Issues Related #6072 #6074 #6075 Commits include: * init Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fixing bugs and removing target Signed-off-by: Sean Li <lnse@amazon.com> * add target and build to .gitignore Signed-off-by: Sean Li <lnse@amazon.com> * Remove SQL Async and Query Assist Going for the light weight solution for 2.15. So took out what wasn't required deliverable. However, I created a branch `feature/discover-next` which has the state where all the features where added so we can port it over post 2.15. Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * adding fix for PPL queries Signed-off-by: Sean Li <lnse@amazon.com> * Clean up files and add helper functions Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * final touches Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * [Discover-next] add query assist to query enhancements plugin (#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: #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) * [Discover-next] Address comments for search bar extensions and query assist (#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) * [Discover-next] Support data sources for query assist (#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) * add query assist banner Signed-off-by: Joshua Li <joshuali925@gmail.com> * implement banner rendering logic Signed-off-by: Joshua Li <joshuali925@gmail.com> * pick opensearch-project/dashboards-observability/pull/1896 Signed-off-by: Joshua Li <joshuali925@gmail.com> * Conditionally render the data source select config Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * restore no space Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add basic tests Signed-off-by: Joshua Li <joshuali925@gmail.com> * add index selector This is a temporary solution given that in discover the index pattern selector will be removed. Before datasource and dataset selectors are added, query assist will rely on this index pattern selector to determine which index user wants to query. Signed-off-by: Joshua Li <joshuali925@gmail.com> * MDS working with PPL and SQL Utilizing the work from MDS to make PPL and SQL calls to a remote cluster. Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * rename logo to mark Signed-off-by: Joshua Li <joshuali925@gmail.com> * extract supported languages to config Signed-off-by: Joshua Li <joshuali925@gmail.com> * Add missing license headers Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * initial implementation for async queries Signed-off-by: Sean Li <lnse@amazon.com> * remove queryId and sessionId from facet Signed-off-by: Sean Li <lnse@amazon.com> * fix: Update call out tests with intl wrapper Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * maintenance: Add and apply lint command Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * changing to observables Signed-off-by: Sean Li <lnse@amazon.com> * search interceptor and cleanup Signed-off-by: Sean Li <lnse@amazon.com> * moving polling class into plugin Signed-off-by: Sean Li <lnse@amazon.com> * Some minor clean ups plus lint Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * test: Add mock-heavy tests for sql search strategy Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * test: add GH workflows Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * More clean ups Add some props interfaces and consolidated some of the facets Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * chore: apply auto-lints to plugin Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * Not done Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * working Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * working and styled Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add connection service Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update public/types.ts Co-authored-by: Joshua Li <joshuali925@gmail.com> * Update public/plugin.tsx Co-authored-by: Joshua Li <joshuali925@gmail.com> * Update public/plugin.tsx Co-authored-by: Joshua Li <joshuali925@gmail.com> * fix linter Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add more tests for query assist (#31) add more tests for query assist update eslint config to make it work increase index selector width Signed-off-by: Joshua Li <joshuali925@gmail.com> * fix!: remove dataSource key in get connection response The `Connection` type does not have the extra `dataSource` object around response, and most of the time code references connection over dataSource. remove the redundent object to make response consistent with type. Signed-off-by: Joshua Li <joshuali925@gmail.com> * change isEnabled to an observable based on selected connection Signed-off-by: Joshua Li <joshuali925@gmail.com> * protect duplicated calls Signed-off-by: Joshua Li <joshuali925@gmail.com> * [build] import via start services Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Changeset file for PR #7212 created/updated * foobar Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * updating imports still in progress Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update more imports Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fix setting of state Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fixes bugs Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update test Signed-off-by: Kawika Avilla <kavilla414@gmail.com> --------- Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Signed-off-by: Sean Li <lnse@amazon.com> Signed-off-by: Joshua Li <joshuali925@gmail.com> Signed-off-by: Simeon Widdis <sawiddis@amazon.com> Co-authored-by: Sean Li <lnse@amazon.com> Co-authored-by: Joshua Li <joshuali925@gmail.com> Co-authored-by: Simeon Widdis <sawiddis@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
sejli
pushed a commit
to sejli/OpenSearch-Dashboards
that referenced
this pull request
Jul 23, 2024
…earch-project#7212) Introduces the addition of a new core plugin called `Query Enhancements` This plugin seems to be focused on enhancing query capabilities, particularly in areas like PPL (Piped Processing Language), SQL, and natural language query assistance. The plugin is set up with the necessary configuration files: - src/plugins/query_enhancements/opensearch_dashboards.json: Defines the plugin's metadata and dependencies. - src/plugins/query_enhancements/common/config.ts: Contains the configuration schema for the plugin. - src/plugins/query_enhancements/public/plugin.tsx: The main plugin file that sets up the public-facing part of the plugin. - src/plugins/query_enhancements/server/plugin.ts: The server-side setup for the plugin. A significant part of the plugin is dedicated to a "Query Assist" feature: - src/plugins/query_enhancements/public/query_assist/: This directory contains components, hooks, and utilities for the Query Assist feature. - src/plugins/query_enhancements/public/query_assist/components/query_assist_bar.tsx: A React component for the Query Assist bar. - src/plugins/query_enhancements/server/routes/query_assist/: Server-side routing for Query Assist functionality. The plugin introduces several search interceptors: - src/plugins/query_enhancements/public/search/ppl_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_async_search_interceptor.ts These interceptors likely modify or enhance the search functionality for different query languages. There's a new feature for data source connections: - src/plugins/query_enhancements/public/data_source_connection/: This directory contains components and services for managing data source connections. The plugin implements server-side search strategies for different query types: - src/plugins/query_enhancements/server/search/ppl_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_async_search_strategy.ts There are some modifications to existing files outside the new plugin directory: - src/plugins/data/public/index.ts: Exports new types and interfaces. - src/plugins/data/public/ui/index.ts: Exports new UI components. - src/plugins/data/public/ui/query_editor/index.tsx: Modifies the QueryEditor component. The plugin includes a comprehensive test setup: - src/plugins/query_enhancements/test/: Contains Jest configuration and setup files for testing. Contains work by @sejli @joshuali925 @Swiddis @paulstn @mengweieric Thx @ashwin-pc for the description summary opensearch-project#6072 opensearch-project#6074 opensearch-project#6075 Commits include: * init Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fixing bugs and removing target Signed-off-by: Sean Li <lnse@amazon.com> * add target and build to .gitignore Signed-off-by: Sean Li <lnse@amazon.com> * Remove SQL Async and Query Assist Going for the light weight solution for 2.15. So took out what wasn't required deliverable. However, I created a branch `feature/discover-next` which has the state where all the features where added so we can port it over post 2.15. Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * adding fix for PPL queries Signed-off-by: Sean Li <lnse@amazon.com> * Clean up files and add helper functions Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * final touches Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * [Discover-next] add query assist to query enhancements plugin (opensearch-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) * [Discover-next] Address comments for search bar extensions and query 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) * [Discover-next] Support data sources for query assist (opensearch-project#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) * add query assist banner Signed-off-by: Joshua Li <joshuali925@gmail.com> * implement banner rendering logic Signed-off-by: Joshua Li <joshuali925@gmail.com> * pick opensearch-project/dashboards-observability/pull/1896 Signed-off-by: Joshua Li <joshuali925@gmail.com> * Conditionally render the data source select config Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * restore no space Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add basic tests Signed-off-by: Joshua Li <joshuali925@gmail.com> * add index selector This is a temporary solution given that in discover the index pattern selector will be removed. Before datasource and dataset selectors are added, query assist will rely on this index pattern selector to determine which index user wants to query. Signed-off-by: Joshua Li <joshuali925@gmail.com> * MDS working with PPL and SQL Utilizing the work from MDS to make PPL and SQL calls to a remote cluster. Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * rename logo to mark Signed-off-by: Joshua Li <joshuali925@gmail.com> * extract supported languages to config Signed-off-by: Joshua Li <joshuali925@gmail.com> * Add missing license headers Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * initial implementation for async queries Signed-off-by: Sean Li <lnse@amazon.com> * remove queryId and sessionId from facet Signed-off-by: Sean Li <lnse@amazon.com> * fix: Update call out tests with intl wrapper Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * maintenance: Add and apply lint command Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * changing to observables Signed-off-by: Sean Li <lnse@amazon.com> * search interceptor and cleanup Signed-off-by: Sean Li <lnse@amazon.com> * moving polling class into plugin Signed-off-by: Sean Li <lnse@amazon.com> * Some minor clean ups plus lint Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * test: Add mock-heavy tests for sql search strategy Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * test: add GH workflows Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * More clean ups Add some props interfaces and consolidated some of the facets Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * chore: apply auto-lints to plugin Signed-off-by: Simeon Widdis <sawiddis@amazon.com> * Not done Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * working Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * working and styled Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add connection service Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update public/types.ts Co-authored-by: Joshua Li <joshuali925@gmail.com> * Update public/plugin.tsx Co-authored-by: Joshua Li <joshuali925@gmail.com> * Update public/plugin.tsx Co-authored-by: Joshua Li <joshuali925@gmail.com> * fix linter Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * add more tests for query assist (opensearch-project#31) add more tests for query assist update eslint config to make it work increase index selector width Signed-off-by: Joshua Li <joshuali925@gmail.com> * fix!: remove dataSource key in get connection response The `Connection` type does not have the extra `dataSource` object around response, and most of the time code references connection over dataSource. remove the redundent object to make response consistent with type. Signed-off-by: Joshua Li <joshuali925@gmail.com> * change isEnabled to an observable based on selected connection Signed-off-by: Joshua Li <joshuali925@gmail.com> * protect duplicated calls Signed-off-by: Joshua Li <joshuali925@gmail.com> * [build] import via start services Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Changeset file for PR opensearch-project#7212 created/updated * foobar Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * updating imports still in progress Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update more imports Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fix setting of state Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * fixes bugs Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Update test Signed-off-by: Kawika Avilla <kavilla414@gmail.com> --------- Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Signed-off-by: Sean Li <lnse@amazon.com> Signed-off-by: Joshua Li <joshuali925@gmail.com> Signed-off-by: Simeon Widdis <sawiddis@amazon.com> Co-authored-by: Sean Li <lnse@amazon.com> Co-authored-by: Joshua Li <joshuali925@gmail.com> Co-authored-by: Simeon Widdis <sawiddis@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Signed-off-by: Kawika Avilla <kavilla414@gmail.com> (cherry picked from commit 9194d83) Signed-off-by: Sean Li <lnse@amazon.com>
Merged
7 tasks
ruanyl
pushed a commit
that referenced
this pull request
Jul 23, 2024
#7400) Introduces the addition of a new core plugin called `Query Enhancements` This plugin seems to be focused on enhancing query capabilities, particularly in areas like PPL (Piped Processing Language), SQL, and natural language query assistance. The plugin is set up with the necessary configuration files: - src/plugins/query_enhancements/opensearch_dashboards.json: Defines the plugin's metadata and dependencies. - src/plugins/query_enhancements/common/config.ts: Contains the configuration schema for the plugin. - src/plugins/query_enhancements/public/plugin.tsx: The main plugin file that sets up the public-facing part of the plugin. - src/plugins/query_enhancements/server/plugin.ts: The server-side setup for the plugin. A significant part of the plugin is dedicated to a "Query Assist" feature: - src/plugins/query_enhancements/public/query_assist/: This directory contains components, hooks, and utilities for the Query Assist feature. - src/plugins/query_enhancements/public/query_assist/components/query_assist_bar.tsx: A React component for the Query Assist bar. - src/plugins/query_enhancements/server/routes/query_assist/: Server-side routing for Query Assist functionality. The plugin introduces several search interceptors: - src/plugins/query_enhancements/public/search/ppl_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_search_interceptor.ts - src/plugins/query_enhancements/public/search/sql_async_search_interceptor.ts These interceptors likely modify or enhance the search functionality for different query languages. There's a new feature for data source connections: - src/plugins/query_enhancements/public/data_source_connection/: This directory contains components and services for managing data source connections. The plugin implements server-side search strategies for different query types: - src/plugins/query_enhancements/server/search/ppl_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_search_strategy.ts - src/plugins/query_enhancements/server/search/sql_async_search_strategy.ts There are some modifications to existing files outside the new plugin directory: - src/plugins/data/public/index.ts: Exports new types and interfaces. - src/plugins/data/public/ui/index.ts: Exports new UI components. - src/plugins/data/public/ui/query_editor/index.tsx: Modifies the QueryEditor component. The plugin includes a comprehensive test setup: - src/plugins/query_enhancements/test/: Contains Jest configuration and setup files for testing. Contains work by @sejli @joshuali925 @Swiddis @paulstn @mengweieric Thx @ashwin-pc for the description summary #6072 #6074 #6075 Commits include: * init * fixing bugs and removing target * add target and build to .gitignore * Remove SQL Async and Query Assist Going for the light weight solution for 2.15. So took out what wasn't required deliverable. However, I created a branch `feature/discover-next` which has the state where all the features where added so we can port it over post 2.15. * adding fix for PPL queries * Clean up files and add helper functions * final touches * [Discover-next] add query assist to query enhancements plugin (#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: #6820 * add query assist to query enhancements * align language to uppercase * pick PR 6167 * 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. * Revert "pick PR 6167" This reverts commit acb0d41. Wait for official 6167 to merge to avoid conflict * address comments for PR 6894 --------- (cherry picked from commit 016e0f2) * [Discover-next] Address comments for search bar extensions and query assist (#6933) * pass dependencies to isEnabled func * add lazy and memo to search bar extensions * move ppl specific string out from query assist * prevent setstate after hook unmounts * add max-height to search bar extensions * prevent setstate after component unmounts * move ml-commons API to common/index.ts * improve i18n and accessibility usages * add hard-coded suggestions for sample data indices --------- (cherry picked from commit 4aade0f) * [Discover-next] Support data sources for query assist (#6972) * disable query assist for non-default datasource * disable query assist input when loading * support MDS for query assist * add unit tests for agents * Revert "add unit tests for agents" This reverts commit 983514e. The test configs are not yet setup in query_enhancements plugins. --------- (cherry picked from commit 328e08e) * add query assist banner * implement banner rendering logic * pick opensearch-project/dashboards-observability/pull/1896 * Conditionally render the data source select config * restore no space * add basic tests * add index selector This is a temporary solution given that in discover the index pattern selector will be removed. Before datasource and dataset selectors are added, query assist will rely on this index pattern selector to determine which index user wants to query. * MDS working with PPL and SQL Utilizing the work from MDS to make PPL and SQL calls to a remote cluster. * rename logo to mark * extract supported languages to config * Add missing license headers * initial implementation for async queries * remove queryId and sessionId from facet * fix: Update call out tests with intl wrapper * maintenance: Add and apply lint command * changing to observables * search interceptor and cleanup * moving polling class into plugin * Some minor clean ups plus lint * test: Add mock-heavy tests for sql search strategy * test: add GH workflows * More clean ups Add some props interfaces and consolidated some of the facets * chore: apply auto-lints to plugin * Not done * working * working and styled * add connection service * Update public/types.ts * Update public/plugin.tsx * Update public/plugin.tsx * fix linter * add more tests for query assist (#31) add more tests for query assist update eslint config to make it work increase index selector width * fix!: remove dataSource key in get connection response The `Connection` type does not have the extra `dataSource` object around response, and most of the time code references connection over dataSource. remove the redundent object to make response consistent with type. * change isEnabled to an observable based on selected connection * protect duplicated calls * [build] import via start services * Changeset file for PR #7212 created/updated * foobar * updating imports still in progress * Update more imports * fix setting of state * fixes bugs * Update test --------- (cherry picked from commit 9194d83) Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Signed-off-by: Sean Li <lnse@amazon.com> Co-authored-by: Kawika Avilla <kavilla414@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is working in progress.
This PR contains #6894. 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
#6820
Screenshot
Testing the changes
Changelog
Check List
yarn test:jestyarn test:jest_integration