fix: Provide more inclusive error handling for saved queries (#27644)

This commit is contained in:
John Bodley 2024-03-27 08:22:14 +13:00 committed by GitHub
parent 12921e6ec3
commit 3ae74d1f2d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 62 additions and 1 deletions

View File

@ -30,6 +30,7 @@ from flask_appbuilder import Model
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,
@ -76,7 +77,7 @@ class SqlTablesMixin: # pylint: disable=too-few-public-methods
self.database, # type: ignore
)
)
except SupersetSecurityException:
except (SupersetSecurityException, TemplateError):
return []

View File

@ -1527,6 +1527,7 @@ def extract_tables_from_jinja_sql(sql: str, database: Database) -> set[Table]:
:param database: The database associated with the SQL statement
: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

View File

@ -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 == []