fix(chart-data-api): improve chart data endpoint errors #10300
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
villebro
changed the title
Codecov Report
@@ Coverage Diff @@
## master #10300 +/- ##
==========================================
- Coverage 70.58% 65.60% -4.99%
==========================================
Files 600 600
Lines 32103 32107 +4
Branches 3244 3245 +1
==========================================
- Hits 22661 21063 -1598
- Misses 9339 10863 +1524
- Partials 103 181 +78
Continue to review full report at Codecov.
|
villebro
changed the title
villebro
force-pushed
the
villebro/chart-data-error-msg
branch
from
f7f4c1b
to
a2846a8
Compare
villebro
changed the title
dpgaspar
approved these changes
Jul 14, 2020
| ) | ||
| try: | ||
| query_context.raise_for_access() | ||
| except SupersetSecurityException: | ||
| return self.response_401() | ||
| payload = query_context.get_payload() | ||
| for query in payload: | ||
| if query["error"]: | ||
| return self.response_400(message=f"Error: {query['error']}") |
There was a problem hiding this comment.
Would be great if query_context.get_payload() would raise custom superset exceptions instead of checking for errors on the payload. But we can address that later
There was a problem hiding this comment.
That's a great idea 👍 To unblock 0.37 I'll merge this as-is, but will improve exception handling after we ship the release.
6 tasks
villebro
added a commit
that referenced
this pull request
Jul 14, 2020
* fix: improve chart data error response * Populate error_message in QueryResult * add tests * Lint + fix incorrect raise * add more tests
auxten
pushed a commit
to auxten/incubator-superset
that referenced
this pull request
Nov 20, 2020
* fix: improve chart data error response * Populate error_message in QueryResult * add tests * Lint + fix incorrect raise * add more tests
cccs-rc
pushed a commit
to CybercentreCanada/superset
that referenced
this pull request
Mar 6, 2024
* fix: improve chart data error response * Populate error_message in QueryResult * add tests * Lint + fix incorrect raise * add more tests
mistercrunch
added
🍒 0.37.0
🍒 0.37.1
🍒 0.37.2
🏷️ 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
TL;DR: this makes viz plugins behave in the same way as legacy viz plugins when the request fails or returns no data.
This fixes the following problems in the chart data endpoint:
QueryContextwas updated to return a non-error response with an empty data field for empty result sets.error_messageproperty ofQueryResultwas not being populated for failed requests in SQLA model, leading to theerrorfield onQueryObjectalways beingNone.QueryObjects when calling the chart data endpoint. This meant that erroneous requests were returned as 200s with an error-field that was not handled in any way, causing the chart to render in unexpected ways. Now theerrorfield is is checked for each response dataset; if a single one is defined, a 400 is returned (these are mostly expected to be incorrect SQL).BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
AFTER
When no data is returned, the chart data endpoint returns a response that the
Chartcomponent can properly identify as an empty response. Previously this left the previous rendered state visible.When an incorrect request is performed, the error message is displayed, making debugging easier. Previously only "An error occurred." was displayed (please note that the error in this screenshot has been fixed by #10299).
When an a query is incorrect, the error is displayed in the warning (previously this would print "An error occurred while rendering the visualization: TypeError: Cannot read property 'map' of undefined")
TEST PLAN
Local testing.
ADDITIONAL INFORMATION