feat: show rich error messages on past failed queries #15158
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
betodealmeida
commented
Jun 15, 2021
Comment on lines
-2430
to
-2435
| msg = data["error"] | ||
| query = _session.query(Query).filter_by(id=query_id).one() | ||
| database = query.database | ||
| db_engine_spec = database.db_engine_spec | ||
| errors = db_engine_spec.extract_errors(msg) | ||
| _session.close() |
There was a problem hiding this comment.
This logic was moved to superset/sql_lab.py
betodealmeida
changed the title
betodealmeida
commented
Jun 15, 2021
Comment on lines
+121
to
+123
| if (latestQuery?.extra?.errors) { | ||
| latestQuery.errors = latestQuery.extra.errors; | ||
| } |
There was a problem hiding this comment.
This is all that's needed to show the rich error messages in the FE.
betodealmeida
commented
Jun 15, 2021
| from superset.utils import core as utils | ||
|
|
||
| if TYPE_CHECKING: | ||
| # prevent circular imports | ||
| from superset.models.core import Database | ||
|
|
||
|
|
||
| COLUMN_DOES_NOT_EXIST_REGEX = re.compile("no such column: (?P<column_name>.+)") |
There was a problem hiding this comment.
I was testing with gsheets, so I decided to add this to have a custom error to test.
Codecov Report
@@ Coverage Diff @@
## master #15158 +/- ##
=======================================
Coverage 77.41% 77.41%
=======================================
Files 969 969
Lines 49982 49988 +6
Branches 6422 6423 +1
=======================================
+ Hits 38692 38697 +5
- Misses 11087 11088 +1
Partials 203 203
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
hughhhh
reviewed
Jun 16, 2021
| @@ -118,6 +118,9 @@ export default function SouthPane({ | |||
| } | |||
| let results; | |||
| if (latestQuery) { | |||
| if (latestQuery?.extra?.errors) { | |||
There was a problem hiding this comment.
nit:
Suggested change
| if (latestQuery?.extra?.errors) { | |
| const { extra: { errors } } = latestQuery; | |
| if (errors) { | |
| latestQuery.errors = errors; | |
| } |
There was a problem hiding this comment.
This would fail if extra is not there, no?
>> const { extra: { errors } } = { foo: "bar" };
Uncaught TypeError: ({foo:"bar"}).extra is undefinedThough I just realized that I could've used if (latestQuery.extra?.errors) { instead, since we check if (latestQuery) already.
cccs-RyanS
pushed a commit
to CybercentreCanada/superset
that referenced
this pull request
Dec 17, 2021
* feat: store SIP-40 error payload with queries * Set errors in query on load
QAlexBall
pushed a commit
to QAlexBall/superset
that referenced
this pull request
Dec 29, 2021
* feat: store SIP-40 error payload with queries * Set errors in query on load
cccs-rc
pushed a commit
to CybercentreCanada/superset
that referenced
this pull request
Mar 6, 2024
* feat: store SIP-40 error payload with queries * Set errors in query on load
mistercrunch
added
🏷️ bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
This PR makes SQL Lab show rich error messages when refreshing queries that failed.
The steps needed were:
superset/sql_lab.pyso that the SIP-40 error payload gets saved with the query in theextra_jsoncolumn under theerrorskey.query.extra.errorstoquery.errors, so that errors are shown with the rich error component.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before, when refreshing a failed query we'd see:
After, when we refresh the page we see:
TESTING INSTRUCTIONS
Tested manually with sync and async queries.
ADDITIONAL INFORMATION