mirror of
https://github.com/apache/superset.git
synced 2026-06-04 15:19:25 +00:00
12cb27f5cb
* feat: new report schedule models * lint and unique constraint * support sqlite * fix sqlite * add audit mixin and minor fixes * feat(api): alerts and reports REST API * feat: new report schedule models * lint and unique constraint * support sqlite * fix sqlite * add audit mixin and minor fixes * feat(api): alerts and reports REST API * draft working version * add tests * test * black * remove copy pasta * solve dashboard object representation being used on cache * tests and custom filter * fix PUT has PATCH on active field * create feature flag * fix lint * address comments
102 lines
4.0 KiB
Python
102 lines
4.0 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.
|
|
import logging
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
from flask_appbuilder.models.sqla import Model
|
|
from flask_appbuilder.security.sqla.models import User
|
|
from marshmallow import ValidationError
|
|
|
|
from superset.commands.utils import populate_owners
|
|
from superset.dao.exceptions import DAOUpdateFailedError
|
|
from superset.databases.dao import DatabaseDAO
|
|
from superset.models.reports import ReportSchedule, ReportScheduleType
|
|
from superset.reports.commands.base import BaseReportScheduleCommand
|
|
from superset.reports.commands.exceptions import (
|
|
DatabaseNotFoundValidationError,
|
|
ReportScheduleInvalidError,
|
|
ReportScheduleNameUniquenessValidationError,
|
|
ReportScheduleNotFoundError,
|
|
ReportScheduleUpdateFailedError,
|
|
)
|
|
from superset.reports.dao import ReportScheduleDAO
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class UpdateReportScheduleCommand(BaseReportScheduleCommand):
|
|
def __init__(self, user: User, model_id: int, data: Dict[str, Any]):
|
|
self._actor = user
|
|
self._model_id = model_id
|
|
self._properties = data.copy()
|
|
self._model: Optional[ReportSchedule] = None
|
|
|
|
def run(self) -> Model:
|
|
self.validate()
|
|
try:
|
|
report_schedule = ReportScheduleDAO.update(self._model, self._properties)
|
|
except DAOUpdateFailedError as ex:
|
|
logger.exception(ex.exception)
|
|
raise ReportScheduleUpdateFailedError()
|
|
return report_schedule
|
|
|
|
def validate(self) -> None:
|
|
exceptions: List[ValidationError] = list()
|
|
owner_ids: Optional[List[int]] = self._properties.get("owners")
|
|
report_type = self._properties.get("type", ReportScheduleType.ALERT)
|
|
|
|
name = self._properties.get("name", "")
|
|
self._model = ReportScheduleDAO.find_by_id(self._model_id)
|
|
|
|
# Does the report exist?
|
|
if not self._model:
|
|
raise ReportScheduleNotFoundError()
|
|
|
|
# Validate name uniqueness
|
|
if not ReportScheduleDAO.validate_update_uniqueness(
|
|
name, report_schedule_id=self._model_id
|
|
):
|
|
exceptions.append(ReportScheduleNameUniquenessValidationError())
|
|
|
|
# validate relation by report type
|
|
if not report_type:
|
|
report_type = self._model.type
|
|
if report_type == ReportScheduleType.ALERT:
|
|
database_id = self._properties.get("database")
|
|
# If database_id was sent let's validate it exists
|
|
if database_id:
|
|
database = DatabaseDAO.find_by_id(database_id)
|
|
if not database:
|
|
exceptions.append(DatabaseNotFoundValidationError())
|
|
self._properties["database"] = database
|
|
|
|
# Validate chart or dashboard relations
|
|
self.validate_chart_dashboard(exceptions, update=True)
|
|
|
|
# Validate/Populate owner
|
|
if owner_ids is None:
|
|
owner_ids = [owner.id for owner in self._model.owners]
|
|
try:
|
|
owners = populate_owners(self._actor, owner_ids)
|
|
self._properties["owners"] = owners
|
|
except ValidationError as ex:
|
|
exceptions.append(ex)
|
|
if exceptions:
|
|
exception = ReportScheduleInvalidError()
|
|
exception.add_list(exceptions)
|
|
raise exception
|