fix(sql lab): Syntax errors should return with 422 status #20491
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
diegomedina248
force-pushed
the
fix/change-api-status-on-sql-lab-syntax-error
branch
from
32c7e7d
to
cf64245
Compare
eschutho
requested changes
Jun 24, 2022
superset/sqllab/command.py
Outdated
| except (SqlLabException, SupersetErrorsException) as ex: | ||
| except SupersetErrorsException as ex: | ||
| if all(ex.error_type == SupersetErrorType.SYNTAX_ERROR for ex in ex.errors): | ||
| ex.status = 422 |
There was a problem hiding this comment.
This is great @diegomedina248. Thank you! Can we raise a new error instead of the original one? We may have to create a new syntax error class with a 422 status.
AAfghahi
requested changes
Jun 24, 2022
diegomedina248
force-pushed
the
fix/change-api-status-on-sql-lab-syntax-error
branch
from
9ec5a09
to
b2fe396
Compare
diegomedina248
force-pushed
the
fix/change-api-status-on-sql-lab-syntax-error
branch
from
b2fe396
to
9fb87b1
Compare
The overall flow is covered by integration tests, but there's no command test setup for sqllab, and that setup could take a while. Will follow up with another pr for that one |
eschutho
reviewed
Jun 27, 2022
| if all(ex.error_type == SupersetErrorType.SYNTAX_ERROR for ex in ex.errors): | ||
| raise SupersetSyntaxErrorException(ex.errors) from ex | ||
| raise ex | ||
| except SupersetException as ex: |
There was a problem hiding this comment.
I noticed that we were catching SqlLabException before. This one is a parent class, correct, so it should still work?
There was a problem hiding this comment.
Yeah, correct, and most likely that exception will be thrown as is, unless it matches the criteria
AAfghahi
approved these changes
Jul 14, 2022
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
A syntax error in SQL Lab, like the following:
returns a 500 error.
This PR changes the status to a 422, to reflect it as an user error instead.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
Execute a query with a syntax error in SQL Lab and observe the response status. Should be 422
ADDITIONAL INFORMATION