Add query assist to query enhancements plugin #14

joshuali925 · 2024-06-18T20:53:54Z

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.

banner screenshot:

query assist screenshot:

TODO items, will send PRs later

add UT/IT for query assist
support keyboard navigation in suggestions component
implement load more logic in suggestions component if needed
add URL for Natural Language Query Generation for PPL inside banner
use data source and index from datasource and dataset selectors when they are implemented in discover

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 acb0d41937e30bd76c666a225407743243692d11. 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 016e0f2f73efd8bb0649151908c67dd7ac09d174)

…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 4aade0f993559b0bae9cbcee8e889868afa88547)

* 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 983514ee11362c5efe4cdb59802b3ff402b61ef2. 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 328e08e688c39de1f47fee1c357e9928c0576390)

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

kavilla · 2024-06-20T10:04:39Z

will review this today as i was holding off for the OSD PR to be merged first.

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

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 · 2024-06-24T21:06:39Z

test/jest.config.js

+
+process.env.TZ = 'UTC';
+
+module.exports = {


does this have something that we dont have available already within the global jest config?

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/dev/jest/config.js

i don't think global config applies to plugin tests?

kavilla · 2024-06-24T21:09:18Z

package.json

@@ -6,6 +6,7 @@
  "scripts": {
    "build": "yarn plugin-helpers build",
    "plugin-helpers": "node ../../scripts/plugin_helpers",
+    "test": "../../node_modules/.bin/jest --config ./test/jest.config.js",


similar to below will yarn test:jest not capture these tests?

in queryEnhancements yarn test:jest is not defined

yeah i mean like like if i was in the root repo and ran like

yarn test:jest {pathtotest} does it work?

joshuali925 · 2024-06-24T22:14:06Z

i copied the test configs from another plugin just so i can run tests. they can be removed if this plugin is going into core

kavilla

some comments but overall awesome! i would be fine merging as is if you want to give my comments a. once over

common/query_assist/index.ts

kavilla · 2024-06-24T21:26:56Z

public/assets/query_assist_logo.svg

nit: is this technically a mark?
nit: i think we can either remove the logo or call it mark to match the pattern:
https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/server/core_app/assets/logos/opensearch_mark.svg

so like query_assist_mark.svg

and to match the current strucutre can we add duplicates for light and dark ? im not sure if there is a light mode or dark mode. might need ux feedback.

more info: opensearch-project/OpenSearch-Dashboards#4702

opensearch_mark is inside the logo directory, i'm not really sure what the difference is between a mark and a logo, but i'll rename it to mark. currently we only have one version, i can duplicate but why are there three versions: mark, mark_on_light, mark_on_dark?

public/query_assist/components/index_selector.tsx

kavilla · 2024-06-24T21:42:13Z

public/query_assist/utils/get_mds_id.ts

+  indexPatterns: IndexPatternsContract,
+  indexPattern: IIndexPattern | string | undefined
+): Promise<string | undefined> => {
+  if (!indexPattern || typeof indexPattern !== 'object' || !indexPattern.id) return undefined;


nit: would this be needed if i got this in?

opensearch-project/OpenSearch-Dashboards#7092
#18

where it registers schemas from observability? we might have to just do the same for query assist?

server/routes/query_assist/routes.ts

kavilla · 2024-06-24T21:59:42Z

babel.config.js

+
+// babelrc doesn't respect NODE_PATH anymore but using require does.
+// Alternative to install them locally in node_modules
+module.exports = function (api) {


can't we add the @osd/babel-preset to our dev dependencies?

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/7f0e9d0fcc1fb172c6d4d21ab9a35fcb47700b6f/packages/osd-babel-preset/README.md#L4

or does this: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/7f0e9d0fcc1fb172c6d4d21ab9a35fcb47700b6f/packages/osd-babel-preset/node_preset.js need to be updated?

not sure, i'm getting

ERROR [queryEnhancements] depends on [@osd/babel-preset] but it's not using the local package. Update its package.json to the expected value below. info Additional debugging info: │ info actual: "@osd/babel-preset": "1.0.0" │ expected: "@osd/babel-preset": "link:../../packages/osd-babel-preset"

oh wow. we might need to open a bug into core.

opensearch-project/OpenSearch-Dashboards#7105

common/query_assist/index.ts

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

joshuali925 added 6 commits June 14, 2024 21:33

add query assist banner

56ab13b

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

implement banner rendering logic

43d1d43

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

pick opensearch-project/dashboards-observability/pull/1896

c97cd2d

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

joshuali925 added 2 commits June 21, 2024 19:58

add basic tests

780fbd5

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

kavilla reviewed Jun 24, 2024

View reviewed changes

kavilla reviewed Jun 25, 2024

View reviewed changes

joshuali925 added 2 commits June 25, 2024 20:24

rename logo to mark

fd651e7

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

extract supported languages to config

8ad8600

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

kavilla merged commit 90ab0bf into kavilla:main Jun 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add query assist to query enhancements plugin #14

Add query assist to query enhancements plugin #14

joshuali925 commented Jun 18, 2024 •

edited

Loading

kavilla commented Jun 20, 2024

kavilla Jun 24, 2024

joshuali925 Jun 24, 2024

kavilla Jun 24, 2024

joshuali925 Jun 24, 2024

kavilla Jun 25, 2024

joshuali925 commented Jun 24, 2024

kavilla left a comment

kavilla Jun 24, 2024

kavilla Jun 24, 2024

joshuali925 Jun 25, 2024

kavilla Jun 24, 2024

kavilla Jun 24, 2024

joshuali925 Jun 25, 2024

kavilla Jun 25, 2024

joshuali925 Jun 25, 2024


		process.env.TZ = 'UTC';

		module.exports = {

Add query assist to query enhancements plugin #14

Add query assist to query enhancements plugin #14

Conversation

joshuali925 commented Jun 18, 2024 • edited Loading

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

joshuali925 commented Jun 24, 2024

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

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 18, 2024 •

edited

Loading