Skip to content
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 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion superset/models/sql_lab.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from flask_appbuilder.models.decorators import renders
from flask_babel import gettext as __
from humanize import naturaltime
from jinja2.exceptions import TemplateError
from sqlalchemy import (
Boolean,
Column,
Expand Down Expand Up @@ -76,7 +77,7 @@ def sql_tables(self) -> list[Table]:
self.database.db_engine_spec.engine, # type: ignore
)
)
except SupersetSecurityException:
except (SupersetSecurityException, TemplateError):
Copy link
Member

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.

Copy link
Member Author

@john-bodley john-bodley Mar 26, 2024

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.

Copy link
Member

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

Finally to properly handle all possible exceptions use the safe decorator, that will catch all uncaught exceptions for you and return a proper error response.

So, in the case of a template or security error we would get an error message.

Copy link
Member

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.

return []


Expand Down
1 change: 1 addition & 0 deletions superset/sql_parse.py
Original file line number Diff line number Diff line change
Expand Up @@ -1525,6 +1525,7 @@ def extract_tables_from_jinja_sql(sql: str, engine: str | None = None) -> set[Ta
:param engine: The associated database engine
:returns: The set of tables referenced in the SQL statement
:raises SupersetSecurityException: If SQLGlot is unable to parse the SQL statement
:raises jinja2.exceptions.TemplateError: If the Jinjafied SQL could not be rendered
"""

from superset.jinja_context import ( # pylint: disable=import-outside-toplevel
Expand Down
59 changes: 59 additions & 0 deletions tests/unit_tests/models/sql_lab_test.py
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 == []
Loading