superset2/superset/commands/dataset/duplicate.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

from flask_appbuilder.models.sqla import Model
from flask_babel import gettext as __
from marshmallow import ValidationError

from superset import security_manager
from superset.commands.base import BaseCommand, CreateMixin
from superset.commands.dataset.exceptions import (
    DatasetAccessDeniedError,
    DatasetDuplicateFailedError,
    DatasetExistsValidationError,
    DatasetInvalidError,
    DatasetNotFoundError,
)
from superset.commands.exceptions import DatasourceTypeInvalidError
from superset.connectors.sqla.models import SqlaTable, SqlMetric, TableColumn
from superset.daos.dataset import DatasetDAO
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
from superset.exceptions import SupersetErrorException, SupersetSecurityException
from superset.extensions import db
from superset.models.core import Database
from superset.sql.parse import Table
from superset.utils.decorators import on_error, transaction

logger = logging.getLogger(__name__)


class DuplicateDatasetCommand(CreateMixin, BaseCommand):
    def __init__(self, data: dict[str, Any]) -> None:
        self._base_model: SqlaTable = SqlaTable()
        self._properties = data.copy()

    @transaction(on_error=partial(on_error, reraise=DatasetDuplicateFailedError))
    def run(self) -> Model:
        self.validate()
        # Declare the high-level avenue before the duplicate touches
        # the session. The change-record listener stamps
        # ``version_transaction.action_kind = 'clone'`` so the new
        # dataset's baseline records read as a clone in the timeline.
        # Method-scoped import — defers the versioning bootstrap path
        # out of this command's module-load graph; see ``changes.py``
        # module docstring for the broader init-order rationale.
        from superset.versioning.changes import ACTION_KIND_CLONE, ACTION_KIND_KEY

        db.session.info[ACTION_KIND_KEY] = ACTION_KIND_CLONE
        database_id = self._base_model.database_id
        table_name = self._properties["table_name"]
        editors = self._properties["editors"]
        database = db.session.query(Database).get(database_id)
        if not database:
            raise SupersetErrorException(
                SupersetError(
                    message=__("The database was not found."),
                    error_type=SupersetErrorType.DATABASE_NOT_FOUND_ERROR,
                    level=ErrorLevel.ERROR,
                ),
                status=404,
            )
        table = SqlaTable(table_name=table_name, editors=editors)
        table.database = database
        table.schema = self._base_model.schema
        table.catalog = self._base_model.catalog
        table.template_params = self._base_model.template_params
        table.normalize_columns = self._base_model.normalize_columns
        table.always_filter_main_dttm = self._base_model.always_filter_main_dttm
        table.is_sqllab_view = True
        table.sql = self._base_model.sql.strip().strip(";")
        db.session.add(table)
        cols = []
        for config_ in self._base_model.columns:
            column_name = config_.column_name
            col = TableColumn(
                column_name=column_name,
                verbose_name=config_.verbose_name,
                expression=config_.expression,
                filterable=True,
                groupby=True,
                is_dttm=config_.is_dttm,
                type=config_.type,
                description=config_.description,
            )
            cols.append(col)
        table.columns = cols
        mets = []
        for config_ in self._base_model.metrics:
            metric_name = config_.metric_name
            met = SqlMetric(
                metric_name=metric_name,
                verbose_name=config_.verbose_name,
                expression=config_.expression,
                metric_type=config_.metric_type,
                description=config_.description,
            )
            mets.append(met)
        table.metrics = mets
        return table

    def validate(self) -> None:
        exceptions: list[ValidationError] = []
        base_model_id = self._properties["base_model_id"]
        duplicate_name = self._properties["table_name"]

        base_model = DatasetDAO.find_by_id(base_model_id)
        if not base_model:
            exceptions.append(DatasetNotFoundError())
        else:
            try:
                security_manager.raise_for_access(datasource=base_model)
            except SupersetSecurityException as ex:
                raise DatasetAccessDeniedError() from ex
            self._base_model = base_model

        if self._base_model and self._base_model.kind != "virtual":
            exceptions.append(DatasourceTypeInvalidError())

        # Use the shared uniqueness check (same as create/update) rather than a
        # name-only filtered lookup: it scopes to the base model's
        # database/schema, is catalog-NULL-aware, and bypasses the soft-delete
        # visibility filter. A filtered lookup misses a soft-deleted twin, so
        # the duplicate would proceed and either hit a DB constraint as an
        # opaque IntegrityError or — where no constraint applies (the
        # model-level UniqueConstraint is metadata-only and the legacy
        # _customer_location_uc is NULL-leaky) — create an active twin that
        # permanently blocks restore of the soft-deleted dataset.
        if base_model and not DatasetDAO.validate_uniqueness(
            base_model.database,
            Table(duplicate_name, base_model.schema, base_model.catalog),
        ):
            exceptions.append(DatasetExistsValidationError(table=Table(duplicate_name)))

        try:
            from superset.commands.utils import populate_subject_list

            editors = populate_subject_list(
                self._properties.get("editors"),
                default_to_user=True,
                field_name="editors",
            )
            self._properties["editors"] = editors
        except ValidationError as ex:
            exceptions.append(ex)

        if exceptions:
            raise DatasetInvalidError(exceptions=exceptions)