-
Notifications
You must be signed in to change notification settings - Fork 13.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Provide more inclusive error handling for saved queries #27644
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
from unittest.mock import MagicMock | ||
|
||
import pytest | ||
from flask_appbuilder import Model | ||
from jinja2.exceptions import TemplateError | ||
from pytest_mock import MockFixture | ||
|
||
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType | ||
from superset.exceptions import SupersetSecurityException | ||
from superset.models.sql_lab import Query, SavedQuery, SqlTablesMixin | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"klass", | ||
[ | ||
Query, | ||
SavedQuery, | ||
], | ||
) | ||
@pytest.mark.parametrize( | ||
"exception", | ||
[ | ||
SupersetSecurityException( | ||
SupersetError( | ||
error_type=SupersetErrorType.QUERY_SECURITY_ACCESS_ERROR, | ||
message="", | ||
level=ErrorLevel.ERROR, | ||
) | ||
), | ||
TemplateError, | ||
], | ||
) | ||
def test_sql_tables_mixin_sql_tables_exception( | ||
klass: type[Model], | ||
exception: Exception, | ||
mocker: MockFixture, | ||
) -> None: | ||
mocker.patch( | ||
"superset.models.sql_lab.extract_tables_from_jinja_sql", | ||
side_effect=exception, | ||
) | ||
|
||
assert klass(sql="SELECT 1", database=MagicMock()).sql_tables == [] |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we propagate the error here and let the caller handle it? Returning empty for an error condition is not the same as returning empty when the select actually does not have a table.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@michael-s-molina per a code search the caller is the Flask-AppBuilder API and AFAIK that logic is all somewhat magical, i.e., I'm not sure if/how model errors are handled and it seems like the various API endpoints are using the @safe decorator. Given that, this was the highest point in the stack where I felt the error should be handled.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't @safe throw a proper error response in that case? @dpgaspar
So, in the case of a template or security error we would get an error message.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed that FlaskAppBuilder does not expect models to throw an error when accessing its properties. We'll probably won't be able to fix this without changing FlaskAppBuilder.