superset2/tests/unit_tests/tasks/test_async_queries.py

# 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 import mock

import pytest
from flask_babel import lazy_gettext as _

from superset.commands.chart.exceptions import ChartDataQueryFailedError
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
from superset.exceptions import (
    OAuth2RedirectError,
    SupersetErrorException,
    SupersetErrorsException,
    SupersetVizException,
)


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.ChartDataQueryContextSchema")
def test_load_chart_data_into_cache_with_error(
    mock_query_context_schema_cls, mock_async_query_manager, mock_security_manager
):
    """Test that the task is gracefully marked failed in event of error"""
    from superset.tasks.async_queries import load_chart_data_into_cache

    job_metadata = {"user_id": 1}
    form_data = {}
    err_message = "Something went wrong"
    err = ChartDataQueryFailedError(_(err_message))

    mock_user = mock.MagicMock()
    mock_query_context_schema = mock.MagicMock()

    mock_security_manager.get_user_by_id.return_value = mock_user
    mock_async_query_manager.STATUS_ERROR = "error"
    mock_query_context_schema_cls.return_value = mock_query_context_schema

    mock_query_context_schema.load.side_effect = err

    with pytest.raises(ChartDataQueryFailedError):
        load_chart_data_into_cache(job_metadata, form_data)

    expected_errors = [{"message": err_message}]

    mock_async_query_manager.update_job.assert_called_once_with(
        job_metadata, "error", errors=expected_errors
    )


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.ChartDataQueryContextSchema")
def test_load_chart_data_into_cache_with_superset_error_exception(
    mock_query_context_schema_cls, mock_async_query_manager, mock_security_manager
):
    """Test that SupersetErrorException extracts SIP-40 style errors"""
    from superset.tasks.async_queries import load_chart_data_into_cache

    job_metadata = {"user_id": 1}
    form_data = {}

    superset_error = SupersetError(
        message="Access denied to datasource",
        error_type=SupersetErrorType.DATASOURCE_SECURITY_ACCESS_ERROR,
        level=ErrorLevel.ERROR,
        extra={"datasource": "my_table"},
    )
    err = SupersetErrorException(superset_error)

    mock_user = mock.MagicMock()
    mock_query_context_schema = mock.MagicMock()

    mock_security_manager.get_user_by_id.return_value = mock_user
    mock_async_query_manager.STATUS_ERROR = "error"
    mock_query_context_schema_cls.return_value = mock_query_context_schema

    mock_query_context_schema.load.side_effect = err

    with pytest.raises(SupersetErrorException):
        load_chart_data_into_cache(job_metadata, form_data)

    # Verify the full SIP-40 error structure is preserved
    call_args = mock_async_query_manager.update_job.call_args
    assert call_args[0] == (job_metadata, "error")
    errors = call_args[1]["errors"]
    assert len(errors) == 1
    assert errors[0]["message"] == "Access denied to datasource"
    assert errors[0]["error_type"] == SupersetErrorType.DATASOURCE_SECURITY_ACCESS_ERROR
    assert errors[0]["level"] == ErrorLevel.ERROR
    assert errors[0]["extra"]["datasource"] == "my_table"


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.ChartDataQueryContextSchema")
def test_load_chart_data_into_cache_with_superset_errors_exception(
    mock_query_context_schema_cls, mock_async_query_manager, mock_security_manager
):
    """Test that SupersetErrorsException extracts multiple SIP-40 style errors"""
    from superset.tasks.async_queries import load_chart_data_into_cache

    job_metadata = {"user_id": 1}
    form_data = {}

    superset_errors = [
        SupersetError(
            message="Column not found",
            error_type=SupersetErrorType.COLUMN_DOES_NOT_EXIST_ERROR,
            level=ErrorLevel.ERROR,
        ),
        SupersetError(
            message="Table not found",
            error_type=SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR,
            level=ErrorLevel.WARNING,
        ),
    ]
    err = SupersetErrorsException(superset_errors)

    mock_user = mock.MagicMock()
    mock_query_context_schema = mock.MagicMock()

    mock_security_manager.get_user_by_id.return_value = mock_user
    mock_async_query_manager.STATUS_ERROR = "error"
    mock_query_context_schema_cls.return_value = mock_query_context_schema

    mock_query_context_schema.load.side_effect = err

    with pytest.raises(SupersetErrorsException):
        load_chart_data_into_cache(job_metadata, form_data)

    # Verify all SIP-40 errors are preserved
    call_args = mock_async_query_manager.update_job.call_args
    assert call_args[0] == (job_metadata, "error")
    errors = call_args[1]["errors"]
    assert len(errors) == 2
    assert errors[0]["message"] == "Column not found"
    assert errors[0]["error_type"] == SupersetErrorType.COLUMN_DOES_NOT_EXIST_ERROR
    assert errors[0]["level"] == ErrorLevel.ERROR
    assert errors[1]["message"] == "Table not found"
    assert errors[1]["error_type"] == SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR
    assert errors[1]["level"] == ErrorLevel.WARNING


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.get_viz")
@mock.patch("superset.tasks.async_queries.get_datasource_info")
def test_load_explore_json_into_cache_preserves_oauth2_redirect_error(
    mock_get_datasource_info,
    mock_get_viz,
    mock_async_query_manager,
    mock_security_manager,
):
    """
    OAuth2RedirectError raised by ``viz_obj.get_payload`` must reach the async
    job's errors list as a structured SIP-40 envelope so the frontend can
    render the OAuth2 banner identically to the sync legacy path.
    """
    from superset.tasks.async_queries import load_explore_json_into_cache

    job_metadata = {"user_id": 1}
    form_data: dict = {}

    mock_get_datasource_info.return_value = (1, "table")
    mock_security_manager.get_user_by_id.return_value = mock.MagicMock()
    mock_async_query_manager.STATUS_ERROR = "error"

    viz_obj = mock.MagicMock()
    viz_obj.get_payload.side_effect = OAuth2RedirectError(
        url="https://accounts.example.com/o/oauth2/v2/auth?...",
        tab_id="tab-123",
        redirect_uri="https://superset.example.com/oauth2/redirect",
    )
    mock_get_viz.return_value = viz_obj

    with pytest.raises(OAuth2RedirectError):
        load_explore_json_into_cache(job_metadata, form_data)

    call_args = mock_async_query_manager.update_job.call_args
    assert call_args[0] == (job_metadata, "error")
    errors = call_args[1]["errors"]
    assert len(errors) == 1
    assert errors[0]["error_type"] == SupersetErrorType.OAUTH2_REDIRECT
    assert errors[0]["extra"] == {
        "url": "https://accounts.example.com/o/oauth2/v2/auth?...",
        "tab_id": "tab-123",
        "redirect_uri": "https://superset.example.com/oauth2/redirect",
    }


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.get_viz")
@mock.patch("superset.tasks.async_queries.get_datasource_info")
def test_load_explore_json_into_cache_preserves_superset_errors_exception(
    mock_get_datasource_info,
    mock_get_viz,
    mock_async_query_manager,
    mock_security_manager,
):
    """SupersetErrorsException must be preserved as a list of SIP-40 dicts."""
    from superset.tasks.async_queries import load_explore_json_into_cache

    job_metadata = {"user_id": 1}
    form_data: dict = {}

    mock_get_datasource_info.return_value = (1, "table")
    mock_security_manager.get_user_by_id.return_value = mock.MagicMock()
    mock_async_query_manager.STATUS_ERROR = "error"

    viz_obj = mock.MagicMock()
    viz_obj.get_payload.side_effect = SupersetErrorsException(
        [
            SupersetError(
                message="Column not found",
                error_type=SupersetErrorType.COLUMN_DOES_NOT_EXIST_ERROR,
                level=ErrorLevel.ERROR,
            ),
            SupersetError(
                message="Table not found",
                error_type=SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR,
                level=ErrorLevel.WARNING,
            ),
        ]
    )
    mock_get_viz.return_value = viz_obj

    with pytest.raises(SupersetErrorsException):
        load_explore_json_into_cache(job_metadata, form_data)

    errors = mock_async_query_manager.update_job.call_args[1]["errors"]
    assert len(errors) == 2
    assert errors[0]["error_type"] == SupersetErrorType.COLUMN_DOES_NOT_EXIST_ERROR
    assert errors[1]["error_type"] == SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.get_viz")
@mock.patch("superset.tasks.async_queries.get_datasource_info")
def test_load_explore_json_into_cache_preserves_superset_viz_exception(
    mock_get_datasource_info,
    mock_get_viz,
    mock_async_query_manager,
    mock_security_manager,
):
    """
    Test that SupersetVizException passes ``ex.errors`` straight through.
    """
    from superset.tasks.async_queries import load_explore_json_into_cache

    job_metadata = {"user_id": 1}
    form_data: dict = {}

    mock_get_datasource_info.return_value = (1, "table")
    mock_security_manager.get_user_by_id.return_value = mock.MagicMock()
    mock_async_query_manager.STATUS_ERROR = "error"

    payload_errors = [
        {
            "message": "Bad column",
            "error_type": SupersetErrorType.VIZ_GET_DF_ERROR,
            "level": ErrorLevel.ERROR,
        }
    ]
    viz_obj = mock.MagicMock()
    viz_obj.get_payload.return_value = {"errors": payload_errors}
    viz_obj.has_error.return_value = True
    mock_get_viz.return_value = viz_obj

    with pytest.raises(SupersetVizException):
        load_explore_json_into_cache(job_metadata, form_data)

    errors = mock_async_query_manager.update_job.call_args[1]["errors"]
    assert errors == payload_errors


@mock.patch("superset.tasks.async_queries.security_manager")
@mock.patch("superset.tasks.async_queries.async_query_manager")
@mock.patch("superset.tasks.async_queries.get_viz")
@mock.patch("superset.tasks.async_queries.get_datasource_info")
def test_load_explore_json_into_cache_falls_back_to_string_for_generic_exception(
    mock_get_datasource_info,
    mock_get_viz,
    mock_async_query_manager,
    mock_security_manager,
):
    """
    Test that Non-Superset exception are passed as plain-string error.
    """
    from superset.tasks.async_queries import load_explore_json_into_cache

    job_metadata = {"user_id": 1}
    form_data: dict = {}

    mock_get_datasource_info.return_value = (1, "table")
    mock_security_manager.get_user_by_id.return_value = mock.MagicMock()
    mock_async_query_manager.STATUS_ERROR = "error"

    viz_obj = mock.MagicMock()
    viz_obj.get_payload.side_effect = RuntimeError("boom")
    mock_get_viz.return_value = viz_obj

    with pytest.raises(RuntimeError):
        load_explore_json_into_cache(job_metadata, form_data)

    errors = mock_async_query_manager.update_job.call_args[1]["errors"]
    assert errors == ["boom"]