Fix: Correctly show error message in DQL and PPL query editor #9589

ruchidh · 2025-03-21T23:46:34Z

Description

This PR fix a bug that causing error message in query editor to show Cannot read properties of undefined (reading 'hasOwnProperty') and message[object object] instead of the correct error message and also added a toaster at bottom for detailed error message.

There are 3 major changes in this PR:

Correctly throw error from fetch result
Properly handle error message base on current error structure
Add toaster for query editor dispaly error

Reference from pr by @Maosaic - #9586

Issues Resolved

Fix a issue that cause error message in query editor to show Cannot read properties of undefined (reading 'hasOwnProperty')
Fix message [object object] issue

Screenshot

Before

After

Changelog

fix: Correctly show error message in DQL and PPL query editor
feat: Add toaster for query errors

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

Signed-off-by: Joey Liu <[email protected]>

Signed-off-by: Ruchi Sharma <[email protected]>

github-actions · 2025-03-21T23:47:12Z

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

Signed-off-by: Ruchi Sharma <[email protected]>

github-actions · 2025-03-21T23:49:34Z

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

Signed-off-by: Ruchi Sharma <[email protected]>

github-actions · 2025-03-21T23:53:47Z

❌ 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 · 2025-03-21T23:55:35Z

❌ Changelog Entry Missing Hyphen

Changelog entries must begin with a hyphen (-).

github-actions · 2025-03-21T23:56:10Z

❌ Changelog Entry Missing Hyphen

Changelog entries must begin with a hyphen (-).

github-actions · 2025-03-21T23:57:40Z

❌ Changelog Entry Missing Hyphen

Changelog entries must begin with a hyphen (-).

codecov · 2025-03-22T00:13:02Z

Codecov Report

Attention: Patch coverage is 41.37931% with 17 lines in your changes missing coverage. Please review.

Project coverage is 61.79%. Comparing base (411e108) to head (f888102).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...ic/application/view_components/utils/use_search.ts	0.00%	8 Missing ⚠️
...query_string/language_service/lib/query_result.tsx	60.00%	2 Missing and 2 partials ⚠️
src/plugins/query_enhancements/common/utils.ts	66.66%	2 Missing and 1 partial ⚠️
...lic/application/view_components/canvas/top_nav.tsx	0.00%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #9589    +/-   ##
========================================
  Coverage   61.78%   61.79%            
========================================
  Files        3807     3797    -10     
  Lines       91933    91777   -156     
  Branches    14597    14570    -27     
========================================
- Hits        56802    56713    -89     
+ Misses      31452    31440    -12     
+ Partials     3679     3624    -55

Flag	Coverage Δ
Linux_1	`28.89% <0.00%> (+0.04%)`	⬆️
Linux_2	`?`
Linux_3	`39.32% <30.00%> (-0.01%)`	⬇️
Linux_4	`28.81% <20.68%> (+0.05%)`	⬆️
Windows_1	`28.90% <0.00%> (+0.04%)`	⬆️
Windows_2	`56.26% <ø> (ø)`
Windows_3	`39.32% <30.00%> (-0.01%)`	⬇️
Windows_4	`28.81% <20.68%> (+0.05%)`	⬆️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

LDrago27 · 2025-03-22T00:16:21Z

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

@@ -329,6 +350,19 @@ export const useSearch = (services: DiscoverViewServices) => {
        }
      }

+      // Currently error message is sent as encoded JSON string, which requires extra parsing
+      // TODO: Confirm error contract


nit: You can create an issue to track the "Todo: Confirm error contract" and mention it here

understood , thank you

Signed-off-by: Ruchi Sharma <[email protected]>

d-buckner · 2025-03-22T01:21:51Z

src/plugins/query_enhancements/common/utils.ts

+  let errorMessage = response.data.body?.message ?? response.data.body ?? response.data;
+
+  // Check if errorMessage is an object and handle Error objects
+  if (typeof errorMessage === 'object') {
+    if (errorMessage instanceof Error) {
+      // If errorMessage is an instance of Error, extract its message
+      errorMessage = errorMessage.message;
+    } else if (errorMessage.message) {
+      // If errorMessage has a message property, extract that message
+      errorMessage = JSON.stringify(errorMessage.message);
+    } else {
+      // If errorMessage is a plain object, stringify it
+      errorMessage = JSON.stringify(errorMessage);
+    }
+  }


not for this PR, but looks like there's some more digging we can do to figure out how we can have some sort of response interface here. Right now it looks we're in the wild west 🤠

angle943

could we add some unit tests?

Maosaic · 2025-03-31T18:58:21Z

can you remove the code changes included in #9586 ? I have made some change on that PR, to avoid conflicts and keep thing clean, I think we should remove the duplicate change here.

Signed-off-by: Ruchi Sharma <[email protected]>

Maosaic and others added 3 commits March 21, 2025 02:24

Fix: Correctly show error message in DQL and PPL query editor

ba32d52

Signed-off-by: Joey Liu <[email protected]>

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

652c28e

fix message object issue in query editor

bc25c92

Signed-off-by: Ruchi Sharma <[email protected]>

github-actions bot added the repeat-contributor label Mar 21, 2025

github-actions bot added the failed changeset label Mar 21, 2025

ruchidh added 2 commits March 21, 2025 23:47

remove ym and package json query for debug

5267012

Signed-off-by: Ruchi Sharma <[email protected]>

revert flag from yaml

eff9255

Signed-off-by: Ruchi Sharma <[email protected]>

ruchidh changed the title ~~Fix error handling in discover query editor~~ Fix: Correctly show error message in DQL and PPL query editor Mar 21, 2025

Update yarn.lock

55ecae7

Signed-off-by: Ruchi Sharma <[email protected]>

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

7b2052c

github-actions bot removed the failed changeset label Mar 21, 2025

LDrago27 reviewed Mar 22, 2025

View reviewed changes

LDrago27 previously approved these changes Mar 22, 2025

View reviewed changes

ruchidh added 2 commits March 22, 2025 00:29

update failed snapshot for query result

06de4de

Signed-off-by: Ruchi Sharma <[email protected]>

update error handling to fix jest and all type

f5d0ef5

Signed-off-by: Ruchi Sharma <[email protected]>

ruchidh dismissed LDrago27’s stale review via f5d0ef5 March 22, 2025 01:17

d-buckner reviewed Mar 22, 2025

View reviewed changes

Merge branch 'main' into fix-query-error-handling

ca6c3c0

angle943 requested changes Mar 29, 2025

View reviewed changes

remove tooster

f888102

Signed-off-by: Ruchi Sharma <[email protected]>

ruchidh requested a review from wanglam as a code owner April 2, 2025 00:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Correctly show error message in DQL and PPL query editor #9589

Fix: Correctly show error message in DQL and PPL query editor #9589

ruchidh commented Mar 21, 2025 •

edited

Loading

github-actions bot commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

codecov bot commented Mar 22, 2025 •

edited

Loading

LDrago27 Mar 22, 2025

ruchidh Mar 22, 2025

d-buckner Mar 22, 2025

angle943 left a comment

Maosaic commented Mar 31, 2025

Fix: Correctly show error message in DQL and PPL query editor #9589

Are you sure you want to change the base?

Fix: Correctly show error message in DQL and PPL query editor #9589

Conversation

ruchidh commented Mar 21, 2025 • edited Loading

Description

Issues Resolved

Screenshot

Changelog

Check List

github-actions bot commented Mar 21, 2025

❌ Empty Changelog Section

github-actions bot commented Mar 21, 2025

❌ Empty Changelog Section

github-actions bot commented Mar 21, 2025

❌ Empty Changelog Section

github-actions bot commented Mar 21, 2025

❌ Changelog Entry Missing Hyphen

github-actions bot commented Mar 21, 2025

❌ Changelog Entry Missing Hyphen

github-actions bot commented Mar 21, 2025

❌ Changelog Entry Missing Hyphen

codecov bot commented Mar 22, 2025 • edited Loading

Codecov Report

LDrago27 Mar 22, 2025

Choose a reason for hiding this comment

ruchidh Mar 22, 2025

Choose a reason for hiding this comment

d-buckner Mar 22, 2025

Choose a reason for hiding this comment

angle943 left a comment

Choose a reason for hiding this comment

Maosaic commented Mar 31, 2025

ruchidh commented Mar 21, 2025 •

edited

Loading

codecov bot commented Mar 22, 2025 •

edited

Loading