fix(sqllab): validate results backend writes and enhance 410 diagnostics (#36222)

This commit is contained in:
Daniel Vaz Gaspar
2025-11-21 15:05:48 +00:00
committed by GitHub
parent 979d385eea
commit 348b19cb4c
3 changed files with 211 additions and 22 deletions

View File

@@ -14,8 +14,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from unittest.mock import MagicMock, patch
from flask import current_app
from superset import db
from superset.common.db_query_status import QueryStatus
from superset.models.core import Database
from superset.models.sql_lab import Query
@@ -54,3 +57,124 @@ def test_non_async_execute(non_async_example_db: Database, example_query: Query)
if non_async_example_db.db_engine_spec.engine_name == "hive":
assert example_query.tracking_url_raw
@patch("superset.sql_lab.results_backend")
def test_results_backend_write_failure(
mock_results_backend: MagicMock,
async_example_db: Database,
example_query: Query,
):
"""Test async query marked FAILED when results_backend.set() False"""
import pytest
from superset.exceptions import SupersetErrorException
# Mock results backend to simulate write failure
mock_results_backend.set.return_value = False
# Execute query with store_results=True, return_results=False (async mode)
# Should raise exception because results can't be stored
with pytest.raises(SupersetErrorException) as exc_info:
execute_sql_statements(
example_query.id,
"select 1 as foo;",
store_results=True,
return_results=False,
start_time=now_as_float(),
expand_data=False,
log_params=dict(), # noqa: C408
)
# Verify exception message
assert "Failed to store query results" in str(exc_info.value.error.message)
# Refresh query from database to get updated state
db.session.refresh(example_query)
# Assert query status is FAILED (results inaccessible for async queries)
assert example_query.status == QueryStatus.FAILED
# Assert results_key is None (because backend write failed)
assert example_query.results_key is None
# Assert error message is set
assert "Failed to store query results" in example_query.error_message
# Assert backend.set() was called
assert mock_results_backend.set.called
@patch("superset.sql_lab.results_backend")
def test_results_backend_write_success(
mock_results_backend: MagicMock,
async_example_db: Database,
example_query: Query,
):
"""Test that query.results_key is set when results_backend.set() True"""
# Mock results backend to simulate successful write
mock_results_backend.set.return_value = True
# Execute query with store_results=True (async mode)
execute_sql_statements(
example_query.id,
"select 1 as foo;",
store_results=True,
return_results=False,
start_time=now_as_float(),
expand_data=False,
log_params=dict(), # noqa: C408
)
# Refresh query from database to get updated state
db.session.refresh(example_query)
# Assert query status is SUCCESS
assert example_query.status == QueryStatus.SUCCESS
# Assert results_key is set (UUID format)
assert example_query.results_key is not None
assert len(example_query.results_key) == 36 # UUID length with dashes
# Assert backend.set() was called
assert mock_results_backend.set.called
@patch("superset.sql_lab.results_backend")
def test_results_backend_write_failure_sync_mode(
mock_results_backend: MagicMock,
non_async_example_db: Database,
example_query: Query,
):
"""Test sync query SUCCESS when cache write fails (results inline)"""
# Mock results backend to simulate write failure
mock_results_backend.set.return_value = False
# Execute query with return_results=True (sync mode - results returned inline)
result = execute_sql_statements(
example_query.id,
"select 1 as foo;",
store_results=True,
return_results=True,
start_time=now_as_float(),
expand_data=True,
log_params=dict(), # noqa: C408
)
# Should return results inline even when cache write fails
assert result
assert result["query_id"] == example_query.id
assert result["status"] == QueryStatus.SUCCESS
assert result["data"] == [{"foo": 1}]
# Refresh query from database to get updated state
db.session.refresh(example_query)
# Assert query status is SUCCESS (results were returned inline)
assert example_query.status == QueryStatus.SUCCESS
# Assert results_key is None (because backend write failed)
assert example_query.results_key is None
# Assert backend.set() was called
assert mock_results_backend.set.called