feat(3000): Expose safe CH errors in HogQL query endpoint #15959
Conversation
This file contains hidden or 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
| @@ -100,6 +101,8 @@ | |||
| return JsonResponse(process_query(self.team, query_json), safe=False) | |||
| except HogQLException as e: | |||
| raise ValidationError(str(e)) | |||
| except ExposedCHQueryError as e: | |||
| raise ValidationError(str(e), e.code_name) | |||
Check warning
Code scanning / CodeQL
Information exposure through an exception
There was a problem hiding this comment.
We're only exposing the error message for error we've deemed safe, so this is intentional
| @@ -110,6 +113,8 @@ | |||
| return JsonResponse(process_query(self.team, query_json), safe=False) | |||
| except HogQLException as e: | |||
| raise ValidationError(str(e)) | |||
| except ExposedCHQueryError as e: | |||
| raise ValidationError(str(e), e.code_name) | |||
Check warning
Code scanning / CodeQL
Information exposure through an exception
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.
Problem
Users are confused when their HogQL isn't right and the problem is only caught in the ClickHouse layer, and not HogQL.
Changes
We now expose selected CH error types in the HogQL full query endpoint.
How did you test this code?
API test.