[Discover] Add Footer Bar for Single Line Editor #8565

sejli · 2024-10-11T23:39:32Z

Description

Adds footer bar in multiline editor to single line editor when editor is focused
Fixes query result component not displaying errors
Correctly surfaces errors from async search strategy

Issues Resolved

Screenshot

Testing the changes

Changelog

feat: Adds editor footer to single line editor on focus

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 · 2024-10-11T23:40:03Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

codecov · 2024-10-12T00:07:10Z

Codecov Report

Attention: Patch coverage is 0% with 29 lines in your changes missing coverage. Please review.

Project coverage is 60.86%. Comparing base (79fed30) to head (c8278f3).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...ins/data/public/ui/query_editor/editors/shared.tsx	0.00%	21 Missing ⚠️
...ic/application/view_components/utils/use_search.ts	0.00%	5 Missing ⚠️
...query_string/language_service/lib/query_result.tsx	0.00%	2 Missing ⚠️
src/plugins/data/common/utils/helpers.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8565      +/-   ##
==========================================
- Coverage   60.86%   60.86%   -0.01%     
==========================================
  Files        3793     3793              
  Lines       90447    90480      +33     
  Branches    14203    14209       +6     
==========================================
+ Hits        55053    55069      +16     
- Misses      31906    31922      +16     
- Partials     3488     3489       +1

Flag	Coverage Δ
Linux_1	`29.07% <0.00%> (-0.02%)`	⬇️
Linux_2	`56.40% <0.00%> (ø)`
Linux_3	`?`
Linux_4	`29.84% <0.00%> (-0.02%)`	⬇️
Windows_1	`29.10% <0.00%> (+<0.01%)`	⬆️
Windows_2	`56.35% <0.00%> (ø)`
Windows_3	`37.67% <0.00%> (-0.01%)`	⬇️
Windows_4	`29.84% <0.00%> (-0.02%)`	⬇️

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.

joshuali925 · 2024-10-21T21:43:24Z

src/plugins/discover/public/application/view_components/utils/use_search.ts

      } catch (e) {
-        errorBody = error.message;
+        errorBody = error.body;


how do you know that there is error.body? and does it follow type correctly?

OpenSearch-Dashboards/src/plugins/discover/public/application/view_components/utils/use_search.ts

Lines 55 to 59 in 7da5443

queryStatus?: {

body?: {

error?: {

reason?: string;

details: string;

joshuali925 · 2024-10-21T21:46:31Z

src/plugins/data/common/utils/helpers.ts

      i18n.translate('data.search.request.failed', {
        defaultMessage: 'An error occurred while executing the search query',
      })
    );
+    return {
+      status: 'failed',
+      body: { error },


the returned error only contains the hard coded message "An error occurred while executing the search query", should we return the actual backend error to tell users what the error was?

ashwin-pc · 2024-10-22T18:38:10Z

@sejli can you call out all that your PR is fixing here.

Signed-off-by: Sean Li <lnse@amazon.com>

This reverts commit 64b5969.

Signed-off-by: Sean Li <lnse@amazon.com>

ashwin-pc · 2024-10-18T20:38:11Z

src/plugins/data/public/ui/query_editor/_query_editor.scss

@@ -215,3 +215,40 @@
    display: block;
  }
 }
+
+.queryEditor__footer {


@sejli lets fix this in a fast follow

ashwin-pc · 2024-10-18T20:39:24Z

src/plugins/data/public/ui/query_editor/_query_editor.scss

+
+.euiFormControlLayout--group .osdQuerEditor__singleLine .euiText {
+  background-color: unset !important;
+  line-height: 21px !important;


Discover as a whole has a lot of overrides. This was an accepted deviation given the timelines. we will need to discuss how much of this needs to move to OUI vs stay custom long term

ashwin-pc · 2024-10-23T14:09:53Z

src/plugins/data/public/query/query_string/language_service/lib/query_result.tsx

@@ -22,10 +22,9 @@ export interface QueryStatus {
  status: ResultStatus;
  body?: {
    error?: {
-      reason?: string;
-      details: string;
+      statusCode?: number;


why do we have this here? We dont want to show the user the status code, but rather the error and the reason

src/plugins/query_enhancements/server/routes/index.ts

ashwin-pc

The PR is good, has some follow up work though. Lets follow up on how we display the error. I think for now this is better than what we have, but we need to fix:

Error when the editor is not focussed
How the error is displayed
Loading state when the query is run after the initial load

virajsanghvi

Approving. There are some open questions, but none are blocking

virajsanghvi · 2024-10-23T17:10:56Z

src/plugins/query_enhancements/server/routes/index.ts

          return res.custom({
-            statusCode: err.name,
+            statusCode: error.status,


all error types above won't necessarily have status, right? Is that okay?

opensearch-trigger-bot · 2024-10-23T17:25:13Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-8565-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c11a801410fff1ea19f1debeb517cd9c5018b7c6
# Push it to GitHub
git push --set-upstream origin backport/backport-8565-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-8565-to-2.x.

opensearch-trigger-bot · 2024-10-23T18:17:19Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-8565-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c11a801410fff1ea19f1debeb517cd9c5018b7c6
# Push it to GitHub
git push --set-upstream origin backport/backport-8565-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-8565-to-2.x.

…8565) * initial commit for single line editor footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing styling and functionality Signed-off-by: Sean Li <lnse@amazon.com> * Changeset file for PR opensearch-project#8565 created/updated * fixing bug with error not showing up in footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing loading state thanks ashwinpc Signed-off-by: Sean Li <lnse@amazon.com> * trying to surface errors Signed-off-by: Sean Li <lnse@amazon.com> * adding new error for error state Signed-off-by: Sean Li <lnse@amazon.com> * Revert "fixing loading state thanks ashwinpc" This reverts commit 64b5969. * correctly passing async search strat errors Signed-off-by: Sean Li <lnse@amazon.com> --------- Signed-off-by: Sean Li <lnse@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

…opensearch-project#8565) Backport PR: opensearch-project#8565 From the original PR: * initial commit for single line editor footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing styling and functionality Signed-off-by: Sean Li <lnse@amazon.com> * Changeset file for PR opensearch-project#8565 created/updated * fixing bug with error not showing up in footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing loading state thanks ashwinpc Signed-off-by: Sean Li <lnse@amazon.com> * trying to surface errors Signed-off-by: Sean Li <lnse@amazon.com> * adding new error for error state Signed-off-by: Sean Li <lnse@amazon.com> * Revert "fixing loading state thanks ashwinpc" This reverts commit 64b5969. * correctly passing async search strat errors Signed-off-by: Sean Li <lnse@amazon.com> --------- Signed-off-by: Sean Li <lnse@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

…#8565) (#8691) * [2.x-manual-backport][Discover] Add Footer Bar for Single Line Editor (#8565) Backport PR: #8565 From the original PR: * initial commit for single line editor footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing styling and functionality Signed-off-by: Sean Li <lnse@amazon.com> * Changeset file for PR #8565 created/updated * fixing bug with error not showing up in footer Signed-off-by: Sean Li <lnse@amazon.com> * fixing loading state thanks ashwinpc Signed-off-by: Sean Li <lnse@amazon.com> * trying to surface errors Signed-off-by: Sean Li <lnse@amazon.com> * adding new error for error state Signed-off-by: Sean Li <lnse@amazon.com> * Revert "fixing loading state thanks ashwinpc" This reverts commit 64b5969. * correctly passing async search strat errors Signed-off-by: Sean Li <lnse@amazon.com> --------- Signed-off-by: Sean Li <lnse@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> * fix snapshot Signed-off-by: Anan Zhuang <ananzh@amazon.com> --------- Signed-off-by: Sean Li <lnse@amazon.com> Signed-off-by: Anan Zhuang <ananzh@amazon.com> Co-authored-by: Sean Li <lnse@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

github-actions bot added the seasoned-contributor label Oct 11, 2024

github-actions bot added failed changeset and removed failed changeset labels Oct 11, 2024

opensearch-changeset-bot bot added a commit to sejli/OpenSearch-Dashboards that referenced this pull request Oct 11, 2024

Changeset file for PR opensearch-project#8565 created/updated

1a1f9c3

sejli added backport 2.x discover for discover reinvent discover-next v2.18.0 labels Oct 11, 2024

sejli force-pushed the dql-bar branch from 1a1f9c3 to a7f7fcc Compare October 15, 2024 06:57

sejli marked this pull request as ready for review October 15, 2024 06:57

sejli 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 and zhyuanqi as code owners October 15, 2024 06:58

sejli force-pushed the dql-bar branch from f3f83f5 to 54ce0ce Compare October 21, 2024 21:24

sejli pushed a commit to sejli/OpenSearch-Dashboards that referenced this pull request Oct 21, 2024

Changeset file for PR opensearch-project#8565 created/updated

b0aa157

sejli force-pushed the dql-bar branch from 54ce0ce to 58f3c1b Compare October 21, 2024 21:33

joshuali925 reviewed Oct 21, 2024

View reviewed changes

sejli and others added 7 commits October 23, 2024 00:49

initial commit for single line editor footer

4c4def0

Signed-off-by: Sean Li <lnse@amazon.com>

fixing styling and functionality

a0c931e

Signed-off-by: Sean Li <lnse@amazon.com>

Changeset file for PR opensearch-project#8565 created/updated

21cae71

fixing bug with error not showing up in footer

8bd7627

Signed-off-by: Sean Li <lnse@amazon.com>

fixing loading state thanks ashwinpc

64b5969

Signed-off-by: Sean Li <lnse@amazon.com>

trying to surface errors

65c1e78

Signed-off-by: Sean Li <lnse@amazon.com>

adding new error for error state

b7ab03f

Signed-off-by: Sean Li <lnse@amazon.com>

sejli force-pushed the dql-bar branch from 8bac5ef to b7ab03f Compare October 23, 2024 07:49

sejli added 2 commits October 23, 2024 01:34

Revert "fixing loading state thanks ashwinpc"

cf676d4

This reverts commit 64b5969.

correctly passing async search strat errors

c8278f3

Signed-off-by: Sean Li <lnse@amazon.com>

ashwin-pc reviewed Oct 23, 2024

View reviewed changes

src/plugins/query_enhancements/server/routes/index.ts Show resolved Hide resolved

ashwin-pc approved these changes Oct 23, 2024

View reviewed changes

virajsanghvi approved these changes Oct 23, 2024

View reviewed changes

virajsanghvi merged commit c11a801 into opensearch-project:main Oct 23, 2024
66 of 69 checks passed

opensearch-trigger-bot bot added the failed backport label Oct 23, 2024

ashwin-pc added backport 2.x and removed backport 2.x labels Oct 23, 2024

ananzh mentioned this pull request Oct 23, 2024

[2.x-manual-backport][Discover] Add Footer Bar for Single Line Editor (#8565) #8691

Merged

7 tasks

sejli mentioned this pull request Oct 23, 2024

[CI] Adding Missing Snapshot for query_result.test.tsx #8694

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Add Footer Bar for Single Line Editor #8565

[Discover] Add Footer Bar for Single Line Editor #8565

sejli commented Oct 11, 2024 •

edited

Loading

github-actions bot commented Oct 11, 2024

codecov bot commented Oct 12, 2024 •

edited

Loading

joshuali925 Oct 21, 2024

joshuali925 Oct 21, 2024

ashwin-pc commented Oct 22, 2024

ashwin-pc Oct 18, 2024

ashwin-pc Oct 18, 2024

ashwin-pc Oct 23, 2024

ashwin-pc left a comment

virajsanghvi left a comment

virajsanghvi Oct 23, 2024

opensearch-trigger-bot bot commented Oct 23, 2024

opensearch-trigger-bot bot commented Oct 23, 2024

	queryStatus?: {
	body?: {
	error?: {
	reason?: string;
	details: string;

[Discover] Add Footer Bar for Single Line Editor #8565

[Discover] Add Footer Bar for Single Line Editor #8565

Conversation

sejli commented Oct 11, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Oct 11, 2024

❌ Empty Changelog Section

codecov bot commented Oct 12, 2024 • edited Loading

Codecov Report

joshuali925 Oct 21, 2024

Choose a reason for hiding this comment

joshuali925 Oct 21, 2024

Choose a reason for hiding this comment

ashwin-pc commented Oct 22, 2024

ashwin-pc Oct 18, 2024

Choose a reason for hiding this comment

ashwin-pc Oct 18, 2024

Choose a reason for hiding this comment

ashwin-pc Oct 23, 2024

Choose a reason for hiding this comment

ashwin-pc left a comment

Choose a reason for hiding this comment

virajsanghvi left a comment

Choose a reason for hiding this comment

virajsanghvi Oct 23, 2024

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Oct 23, 2024

opensearch-trigger-bot bot commented Oct 23, 2024

sejli commented Oct 11, 2024 •

edited

Loading

codecov bot commented Oct 12, 2024 •

edited

Loading