Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[query assist] use badge to show agent errors #7998

Merged
merged 22 commits into from
Sep 11, 2024
Merged

[query assist] use badge to show agent errors #7998

merged 22 commits into from
Sep 11, 2024

Conversation

joshuali925
Copy link
Member

@joshuali925 joshuali925 commented Sep 4, 2024 •
edited
Loading

Description

this PR fixes some bugs caused by dataset and ml-commons api change, and adds error to badge on UI

  • enable query assist for index patterns without data source
  • add agent error parsing utils
  • update ml-commons response schema processing
    • previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
  • use badge to show query assist error if possible
  • add unit tests

Issues Resolved

Screenshot

image

Testing the changes

Changelog

  • skip

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

@github-actions github-actions bot added seasoned-contributor Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry labels Sep 4, 2024
@joshuali925 joshuali925 added backport 2.x discover for discover reinvent labels Sep 4, 2024
@AMoo-Miki
Copy link
Collaborator

AMoo-Miki commented Sep 10, 2024 •
edited
Loading 

2. **using css to change background on focus**: this is less hacky because it doesn't involve math calculations. The downside is that it doesn't look perfect as the mocks (suggestions not full width and no animation for the append section), but i think it's good enough as a compromise

Thanks a ton for this. I too believe this is a good compromise until we can update the underlying component. While it is not perfect, it will prevent us from adding hackiness.

@AMoo-Miki
Copy link
Collaborator

Another option is hide the Error on focus.

@joshuali925
Copy link
Member Author

Another option is hide the Error on focus.

i actually like it better. showing "Error" when user writes the question doesn't really help, and hiding it gives more horizontal space
Sep-10-2024 14-30-32

@joshuali925
refactor: append badge and hide it when input is focused
0de06f6 
It would be ideal to add a feature in OUI text field so that it can
append element inside itself. For now we have 2 workarounds:
- calculate padding using dynamic width: it is hacky because it involves
dynamically retrieving badge width and doing math to compute the correct
padding. The math won't make sense if for example the layout changes, or
text field size changes.
- using css to change background on focus (implemented): this is less
hacky because it doesn't involve math calculations. The downside is that
it doesn't look perfect as the mocks.

Signed-off-by: Joshua Li <[email protected]>
@joshuali925
avoid display: none when badge is focused
48c42fc 
Signed-off-by: Joshua Li <[email protected]>
@joshuali925
update unit tests
b83fdec 
Signed-off-by: Joshua Li <[email protected]>
@kgcreative
Copy link
Member

kgcreative commented Sep 11, 2024 •
edited
Loading

There is a very limited subset of errors that would show up in the input; i would imagine they are mostly around illegal characters that we might underline in red in some way, or submit or connection errors where there is a failure before a query or a summary is generated

We also need to think about where we might show query errors, or summary errors. Those should be in the query area and the summary area respectively.

We should truncate the text when it's a single line and not in focus Some query that's trunc... [1 error | N errors] , and expand the input to full width and hide the error count on focus

AMoo-Miki
AMoo-Miki reviewed Sep 11, 2024
View reviewed changes
src/plugins/query_enhancements/public/query_assist/components/warning_badge.tsx
>
<EuiText size="s" className="queryAssist__popoverText">
<dl>
<dd id="queryAssistErrorTitle">
Copy link
Collaborator

@AMoo-Miki AMoo-Miki Sep 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should use <EuiIcon type="alert" /> as opposed to having CSS add a different icon that the prescribed one.

@joshuali925 joshuali925 merged commit 461a395 into opensearch-project:main Sep 11, 2024
69 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 11, 2024
@github-actions
[query assist] use badge to show agent errors (#7998)
fa7f70a 
- enable query assist for index patterns without data source
- add agent error parsing utils
- update ml-commons response schema processing
   - previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
- use badge to show query assist error if possible
- add unit tests

Signed-off-by: Joshua Li <[email protected]>
(cherry picked from commit 461a395)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Sep 11, 2024
Merged
kavilla pushed a commit that referenced this pull request Sep 12, 2024
@opensearch-trigger-bot @github-actions
[query assist] use badge to show agent errors (#7998) (#8146)
5cce5a0 
- enable query assist for index patterns without data source
- add agent error parsing utils
- update ml-commons response schema processing
   - previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
- use badge to show query assist error if possible
- add unit tests


(cherry picked from commit 461a395)

Signed-off-by: Joshua Li <[email protected]>
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>
@ashwin-pc ashwin-pc added 2.17.1 and removed v2.18.0 labels Sep 17, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 20, 2024
@github-actions
[query assist] use badge to show agent errors (#7998)
da29545 
- enable query assist for index patterns without data source
- add agent error parsing utils
- update ml-commons response schema processing
   - previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
- use badge to show query assist error if possible
- add unit tests

Signed-off-by: Joshua Li <[email protected]>
(cherry picked from commit 461a395)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Sep 20, 2024
Merged
abbyhu2000 pushed a commit that referenced this pull request Sep 21, 2024
@opensearch-trigger-bot @github-actions
[query assist] use badge to show agent errors (#7998) (#8259)
e0c40b3 
- enable query assist for index patterns without data source
- add agent error parsing utils
- update ml-commons response schema processing
   - previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
- use badge to show query assist error if possible
- add unit tests


(cherry picked from commit 461a395)

Signed-off-by: Joshua Li <[email protected]>
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>
abbyhu2000 added a commit to abbyhu2000/OpenSearch-Dashboards that referenced this pull request Sep 24, 2024
@abbyhu2000
Revert "[query assist] use badge to show agent errors (opensearch-pro…
0fde1a3 
…ject#7998) (opensearch-project#8259)"

This reverts commit e0c40b3.
SuZhou-Joe pushed a commit to SuZhou-Joe/OpenSearch-Dashboards that referenced this pull request Oct 3, 2024
@opensearch-trigger-bot @github-actions @SuZhou-Joe
[query assist] use badge to show agent errors (opensearch-project#7998)…
6054c0c 
… (opensearch-project#8146)

- enable query assist for index patterns without data source
- add agent error parsing utils
- update ml-commons response schema processing
   - previously ml-commons returns error.body as a string, now it is a JSON object. Ideally frontend should keep it as is to reduce serializing/deserializing, but since older version of ml-commons can be used through MDS, we'll keep it as a string for consistency
- use badge to show query assist error if possible
- add unit tests


(cherry picked from commit 461a395)

Signed-off-by: Joshua Li <[email protected]>
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws left review comments

@kavilla kavilla kavilla left review comments

@ashwin-pc ashwin-pc ashwin-pc approved these changes

@AMoo-Miki AMoo-Miki AMoo-Miki approved these changes

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner

@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner

@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner

@manasvinibs manasvinibs Awaiting requested review from manasvinibs manasvinibs is a code owner

@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

@curq curq Awaiting requested review from curq curq is a code owner

@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner

@SuZhou-Joe SuZhou-Joe Awaiting requested review from SuZhou-Joe SuZhou-Joe is a code owner

@ruanyl ruanyl Awaiting requested review from ruanyl ruanyl is a code owner

@BionIT BionIT Awaiting requested review from BionIT BionIT is a code owner

@xinruiba xinruiba Awaiting requested review from xinruiba xinruiba is a code owner

@zhyuanqi zhyuanqi Awaiting requested review from zhyuanqi zhyuanqi is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@LDrago27 LDrago27 Awaiting requested review from LDrago27 LDrago27 is a code owner

@virajsanghvi virajsanghvi Awaiting requested review from virajsanghvi virajsanghvi is a code owner

@sejli sejli Awaiting requested review from sejli sejli is a code owner

@huyaboo huyaboo Awaiting requested review from huyaboo huyaboo is a code owner

Assignees
No one assigned
Labels
2.17.1 backport 2.x backport 2.17 discover for discover reinvent in-next seasoned-contributor Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@joshuali925 @kavilla @AMoo-Miki @kgcreative @ashwin-pc @kolchfa-aws @SuZhou-Joe @sejli