superset2/superset/commands/explore/permalink/create.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.
import logging
from functools import partial
from typing import Any, Optional

from jinja2.exceptions import TemplateError
from sqlalchemy.exc import SQLAlchemyError

from superset import db
from superset.commands.explore.permalink.base import BaseExplorePermalinkCommand
from superset.daos.key_value import KeyValueDAO
from superset.exceptions import SupersetTemplateException
from superset.explore.permalink.exceptions import ExplorePermalinkCreateFailedError
from superset.explore.utils import check_access as check_chart_access
from superset.key_value.exceptions import (
    KeyValueCodecEncodeException,
    KeyValueCreateFailedError,
)
from superset.key_value.utils import encode_permalink_key
from superset.utils.core import DatasourceType
from superset.utils.decorators import on_error, transaction

logger = logging.getLogger(__name__)


class CreateExplorePermalinkCommand(BaseExplorePermalinkCommand):
    def __init__(self, state: dict[str, Any]):
        self.chart_id: Optional[int] = state["formData"].get("slice_id")
        self.datasource: str = state["formData"]["datasource"]
        self.state = state

    @transaction(
        on_error=partial(
            on_error,
            catches=(
                KeyValueCodecEncodeException,
                KeyValueCreateFailedError,
                SQLAlchemyError,
            ),
            reraise=ExplorePermalinkCreateFailedError,
        ),
    )
    def run(self) -> str:
        self.validate()
        d_id, d_type = self.datasource.split("__")
        datasource_id = int(d_id)
        datasource_type = DatasourceType(d_type)
        try:
            check_chart_access(datasource_id, self.chart_id, datasource_type)
        except TemplateError as ex:
            raise SupersetTemplateException(str(ex)) from ex
        value = {
            "chartId": self.chart_id,
            "datasourceId": datasource_id,
            "datasourceType": datasource_type.value,
            "datasource": self.datasource,
            "state": self.state,
        }
        entry = KeyValueDAO.create_entry(self.resource, value, self.codec)
        db.session.flush()
        key = entry.id
        if key is None:
            raise ExplorePermalinkCreateFailedError("Unexpected missing key id")
        return encode_permalink_key(key=key, salt=self.salt)

    def validate(self) -> None:
        pass