Files
superset2/tests/unit_tests/models/sql_lab_test.py
Evan Rusackas cdc1397033 fix(sqllab): keep saved-query list working when Jinja dataset(id) references a deleted dataset
When a saved query contains a Jinja macro such as `{{ dataset(id) }}` and the
referenced dataset is later deleted, `process_jinja_sql` raises
`DatasetNotFoundError` while computing the `sql_tables` field. That exception
was not caught by `SqlTablesMixin.sql_tables`, so the entire saved-query list
endpoint failed with "Dataset ID not found", hiding every saved query from
the user and preventing them from deleting the broken one (#32771).

Treat any `SupersetException` raised during table extraction the same way as
existing parse/security/template errors: log a warning and return an empty
list so the rest of the row can still be serialized.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-04-27 11:49:15 -07:00

113 lines
3.3 KiB
Python

# 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 MockerFixture
from superset.commands.dataset.exceptions import DatasetNotFoundError
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
from superset.exceptions import (
SupersetParseError,
SupersetSecurityException,
SupersetTemplateException,
)
from superset.models.sql_lab import Query, SavedQuery
@pytest.mark.parametrize(
"klass",
[
Query,
SavedQuery,
],
)
@pytest.mark.parametrize(
"exception",
[
SupersetSecurityException(
SupersetError(
error_type=SupersetErrorType.QUERY_SECURITY_ACCESS_ERROR,
message="",
level=ErrorLevel.ERROR,
)
),
SupersetParseError(
sql="INVALID SQL",
message="Invalid SQL syntax",
),
TemplateError,
# ``{{ dataset(id) }}`` referencing a deleted dataset previously
# bubbled up through ``sql_tables`` and broke saved-query list
# endpoints (see issue #32771).
DatasetNotFoundError("Dataset 1 not found!"),
SupersetTemplateException("Template rendering failed"),
],
)
def test_sql_tables_mixin_sql_tables_exception(
klass: type[Model],
exception: Exception,
mocker: MockerFixture,
) -> None:
mocker.patch(
"superset.models.sql_lab.process_jinja_sql",
side_effect=exception,
)
assert klass(sql="SELECT 1", database=MagicMock()).sql_tables == []
@pytest.mark.parametrize(
"klass",
[
Query,
SavedQuery,
],
)
@pytest.mark.parametrize(
"invalid_sql",
[
"SELECT * FROM table WHERE invalid syntax",
"INVALID SQL STATEMENT",
"SELECT * FROM; DROP TABLE users;",
"",
None,
],
)
def test_sql_tables_mixin_invalid_sql_returns_empty_list(
klass: type[Model],
invalid_sql: str,
mocker: MockerFixture,
) -> None:
"""Test that SqlTablesMixin returns empty list when SQL parsing fails."""
mocker.patch(
"superset.models.sql_lab.process_jinja_sql",
side_effect=SupersetParseError(
sql=invalid_sql or "INVALID SQL",
message=f"Failed to parse SQL: {invalid_sql}",
),
)
instance = (
klass(sql=invalid_sql, database=MagicMock())
if invalid_sql is not None
else klass(database=MagicMock())
)
assert instance.sql_tables == []