From a8b35e16d529320a72cb80abf3aa77a4d475b16f Mon Sep 17 00:00:00 2001 From: John Bodley <4567245+john-bodley@users.noreply.github.com> Date: Tue, 26 Mar 2024 10:42:59 +1300 Subject: [PATCH] fix: Provide more inclusive error handling for saved queries --- superset/models/sql_lab.py | 3 ++- superset/sql_parse.py | 1 + tests/unit_tests/models/sql_lab_test.py | 36 +++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 tests/unit_tests/models/sql_lab_test.py diff --git a/superset/models/sql_lab.py b/superset/models/sql_lab.py index 2d7384a74e471..bd6eeae4434ad 100644 --- a/superset/models/sql_lab.py +++ b/superset/models/sql_lab.py @@ -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, @@ -76,7 +77,7 @@ def sql_tables(self) -> list[Table]: self.database.db_engine_spec.engine, # type: ignore ) ) - except SupersetSecurityException: + except (SupersetSecurityException, TemplateError): return [] diff --git a/superset/sql_parse.py b/superset/sql_parse.py index 11e4279aa276d..32d1e0fcae9ff 100644 --- a/superset/sql_parse.py +++ b/superset/sql_parse.py @@ -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 diff --git a/tests/unit_tests/models/sql_lab_test.py b/tests/unit_tests/models/sql_lab_test.py new file mode 100644 index 0000000000000..70001ab814153 --- /dev/null +++ b/tests/unit_tests/models/sql_lab_test.py @@ -0,0 +1,36 @@ +from unittest.mock import MagicMock + +import pytest +from flask_appbuilder import Model +from jinja2.exceptions import TemplateError +from pytest_mock import MockFixture + +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, + TemplateError, + ] +) +def test_sql_tables_mixin_sql_tables_exception( + klass: type[Model], + exception: type[Exception], + mocker: MockFixture, +) -> None: + mocker.patch( + "superset.models.sql_lab.extract_tables_from_jinja_sql", + side_effect=TemplateError(), + ) + + assert klass(sql="SELECT 1", database=MagicMock()).sql_tables == []