Add query result and time to the query editor footer by abbyhu2000 · Pull Request #7951 · opensearch-project/OpenSearch-Dashboards

abbyhu2000 · 2024-08-30T23:17:40Z

Description

Add query result and query execution time to the query editor footer.

TODO:

query error UI in the follow up PR

Issues Resolved

Screenshot

Screen.Recording.2024-09-03.at.11.36.07.AM.mov

Testing the changes

Changelog

feat: Add query result and time to the query editor footer

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-08-30T23:18:17Z

❌ 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.

github-actions · 2024-09-03T18:33:19Z

❌ 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.

kavilla

generally looks good. just clean up

src/plugins/data/common/data_frames/types.ts

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

kavilla · 2024-09-03T20:20:45Z

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

+      anchorPosition={'downRight'}
+    >
+      <EuiPopoverTitle>ERRORS</EuiPopoverTitle>
+      <div style={{ width: '250px' }}>


add a stylesheet

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

kavilla · 2024-09-03T20:24:49Z

src/plugins/discover/public/application/view_components/canvas/top_nav.tsx

 export const TopNav = ({ opts, showSaveQuery, isEnhancementsEnabled }: TopNavProps) => {
  const { services } = useOpenSearchDashboards<DiscoverViewServices>();
-  const { inspectorAdapters, savedSearch, indexPattern } = useDiscoverContext();
+  const { data$, inspectorAdapters, savedSearch, indexPattern } = useDiscoverContext();


if we only require do we think we should maybe just create a new observable that this listens to instead of subscribing to a lot of data in the top nav?

kavilla · 2024-09-03T20:29:31Z

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

  bucketInterval?: TimechartHeaderBucketInterval | {};
  chartData?: Chart;
  title?: string;
+  statusBody?: {


nit:

i still think maybe we maybe we can:

status: ResultStatus | DetailedResultStatus

and then the DetailedResultStatus is

status: ResultStatus, message: string, statusCode?: number, elapsedMs?: number,

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

joshuali925 · 2024-09-03T22:48:29Z

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

+
+  if (queryStatus.status === 'ready') {
+    return (
+      <EuiButtonEmpty iconSide="left" iconType={'checkInCircleEmpty'} size="xs" onClick={() => {}}>


is it expected that clicking on this button doesn't do anything?

src/plugins/discover/public/application/view_components/canvas/top_nav.tsx

yarn.lock

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

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

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

ashwin-pc · 2024-09-04T01:10:09Z

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


 export class UiService implements Plugin<IUiSetup, IUiStart> {
  enhancementsConfig: ConfigSchema['enhancements'];
+  private queryStatus$ = new BehaviorSubject<QueryStatus>({ status: ResultStatus.READY });


We should not do this. This would mean that we are duplicating state information in multiple places and no longer have a single source of truth. If we forget to set or clear the status correctly, the UI could show both an error and the correct result at the same time, which could lead to bugs. If we are afraid of prop drilling, lets use react context within the TopNav of the data plugin, but not have 2 places that have the same state.

Do we still need this now?

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

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

src/plugins/query_enhancements/server/search/ppl_search_strategy.ts

ashwin-pc · 2024-09-04T21:35:34Z

src/plugins/query_enhancements/common/utils.ts

@@ -42,16 +42,9 @@ export const removeKeyword = (queryString: string | undefined) => {
 };

 export const handleFacetError = (response: any) => {


We should add a test for this

ashwin-pc · 2024-09-04T21:37:51Z

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

A lot of components depend on this hook working as expected, we should add some tests here

ashwin-pc · 2024-09-04T21:43:35Z

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


 export class UiService implements Plugin<IUiSetup, IUiStart> {
  enhancementsConfig: ConfigSchema['enhancements'];
+  private queryStatus$ = new BehaviorSubject<QueryStatus>({ status: ResultStatus.READY });


Do we still need this now?

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

src/plugins/data/public/query/query_string/query_string_manager.ts

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* add query result to the footer Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * fix unit test Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * conditional language Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * native language still use toast Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * refactor to not use two states Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * address comments Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> (cherry picked from commit 7e8612f) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* add query result to the footer * fix unit test * conditional language * native language still use toast * refactor to not use two states * address comments --------- (cherry picked from commit 7e8612f) Signed-off-by: abbyhu2000 <abigailhu2000@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>

…ect#7951) * add query result to the footer Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * fix unit test Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * conditional language Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * native language still use toast Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * refactor to not use two states Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * address comments Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

github-actions bot added the distinguished-contributor label Aug 30, 2024

github-actions bot added the failed changeset label Aug 30, 2024

abbyhu2000 force-pushed the query_error_try_2 branch from 24d3d55 to 6844332 Compare September 3, 2024 18:32

abbyhu2000 changed the title ~~Query error try 2~~ Add query result and time to the query editor footer Sep 3, 2024

abbyhu2000 marked this pull request as ready for review September 3, 2024 18:32

opensearch-changeset-bot bot added a commit to abbyhu2000/OpenSearch-Dashboards that referenced this pull request Sep 3, 2024

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

ee9579f

abbyhu2000 added v2.17.0 backport 2.x labels Sep 3, 2024

kavilla reviewed Sep 3, 2024

View reviewed changes

joshuali925 reviewed Sep 3, 2024

View reviewed changes

sejli reviewed Sep 3, 2024

View reviewed changes

yarn.lock Show resolved Hide resolved

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

abbyhu2000 force-pushed the query_error_try_2 branch 2 times, most recently from f1a273a to 8051384 Compare September 3, 2024 23:31

ashwin-pc added the discover for discover reinvent label Sep 4, 2024

abbyhu2000 added 2 commits September 4, 2024 00:45

add query result to the footer

aff6eac

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

fix unit test

ac754c4

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 force-pushed the query_error_try_2 branch from 815a4a2 to ac754c4 Compare September 4, 2024 00:45

conditional language

4f94324

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

ashwin-pc requested changes Sep 4, 2024

View reviewed changes

ashwin-pc reviewed Sep 4, 2024

View reviewed changes

src/plugins/discover/public/application/view_components/utils/use_search.ts Show resolved Hide resolved

abbyhu2000 added 2 commits September 4, 2024 18:37

native language still use toast

2037abf

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

refactor to not use two states

d752f25

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

ashwin-pc reviewed Sep 4, 2024

View reviewed changes

address comments

430b2a7

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

ashwin-pc approved these changes Sep 4, 2024

View reviewed changes

kavilla approved these changes Sep 4, 2024

View reviewed changes

sejli approved these changes Sep 4, 2024

View reviewed changes

kavilla added the backport 2.17 label Sep 4, 2024

kavilla merged commit 7e8612f into opensearch-project:main Sep 4, 2024

opensearch-trigger-bot bot mentioned this pull request Sep 4, 2024

[Backport 2.x] Add query result and time to the query editor footer #8003

Merged

opensearch-trigger-bot bot mentioned this pull request Sep 4, 2024

[Backport 2.17] Add query result and time to the query editor footer #8004

Merged

		@@ -42,16 +42,9 @@ export const removeKeyword = (queryString: string \| undefined) => {
		};

		export const handleFacetError = (response: any) => {

Conversation

abbyhu2000 commented Aug 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

Uh oh!

github-actions bot commented Aug 30, 2024

❌ Empty Changelog Section

Uh oh!

github-actions bot commented Sep 3, 2024

❌ Empty Changelog Section

Uh oh!

kavilla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

abbyhu2000 commented Aug 30, 2024 •

edited

Loading