willbarrett commented on a change in pull request #11606: URL: https://github.com/apache/incubator-superset/pull/11606#discussion_r520917918
########## File path: superset/reports/schemas.py ########## @@ -0,0 +1,209 @@ +# 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 typing import Union + +from croniter import croniter +from marshmallow import fields, Schema, validate +from marshmallow.validate import Length, ValidationError + +from superset.models.reports import ( + ReportRecipientType, + ReportScheduleType, + ReportScheduleValidatorType, +) + +openapi_spec_methods_override = { + "get": {"get": {"description": "Get a report schedule"}}, + "get_list": { + "get": { + "description": "Get a list of report schedules, use Rison or JSON " + "query parameters for filtering, sorting," + " pagination and for selecting specific" + " columns and metadata.", + } + }, + "post": {"post": {"description": "Create a report schedule"}}, + "put": {"put": {"description": "Update a report schedule"}}, + "delete": {"delete": {"description": "Delete a report schedule"}}, +} + +get_delete_ids_schema = {"type": "array", "items": {"type": "integer"}} + +type_description = "The report schedule type" +name_description = "The report schedule name." +# :) +description_description = "Use a nice description to give context to this Alert/Report" +context_markdown_description = "Markdown description" +crontab_description = ( + "A CRON-like expression." Review comment: nit: I think this is actually a CRON expression, not a CRON-like expression ########## File path: superset/reports/commands/create.py ########## @@ -0,0 +1,93 @@ +# 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 json +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 DAOCreateFailedError +from superset.databases.dao import DatabaseDAO +from superset.models.reports import ReportScheduleType +from superset.reports.commands.base import BaseReportScheduleCommand +from superset.reports.commands.exceptions import ( + DatabaseNotFoundValidationError, + ReportScheduleAlertRequiredDatabaseValidationError, + ReportScheduleCreateFailedError, + ReportScheduleInvalidError, + ReportScheduleNameUniquenessValidationError, +) +from superset.reports.dao import ReportScheduleDAO + +logger = logging.getLogger(__name__) + + +class CreateReportScheduleCommand(BaseReportScheduleCommand): + def __init__(self, user: User, data: Dict[str, Any]): + self._actor = user + self._properties = data.copy() + + def run(self) -> Model: + self.validate() + try: + report_schedule = ReportScheduleDAO.create(self._properties) + except DAOCreateFailedError as ex: + logger.exception(ex.exception) + raise ReportScheduleCreateFailedError() + return report_schedule + + def validate(self) -> None: + exceptions: List[ValidationError] = list() + owner_ids: Optional[List[int]] = self._properties.get("owners") + name = self._properties.get("name", "") + report_type = self._properties.get("type", ReportScheduleType.ALERT) Review comment: Let's not assume that this is an alert unless otherwise specified - I think we should error if the front end fails to specify a type. ########## File path: superset/reports/commands/delete.py ########## @@ -0,0 +1,55 @@ +# 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 Optional + +from flask_appbuilder.models.sqla import Model +from flask_appbuilder.security.sqla.models import User + +from superset.commands.base import BaseCommand +from superset.dao.exceptions import DAODeleteFailedError +from superset.models.reports import ReportSchedule +from superset.reports.commands.exceptions import ( + ReportScheduleDeleteFailedError, + ReportScheduleNotFoundError, +) +from superset.reports.dao import ReportScheduleDAO + +logger = logging.getLogger(__name__) + + +class DeleteReportScheduleCommand(BaseCommand): + def __init__(self, user: User, model_id: int): + self._actor = user + self._model_id = model_id + self._model: Optional[ReportSchedule] = None + + def run(self) -> Model: + self.validate() + try: + report_schedule = ReportScheduleDAO.delete(self._model) + except DAODeleteFailedError as ex: + logger.exception(ex.exception) + raise ReportScheduleDeleteFailedError() + return report_schedule + + def validate(self) -> None: + # Validate/populate model exists + self._model = ReportScheduleDAO.find_by_id(self._model_id) + if not self._model: + raise ReportScheduleNotFoundError() + # TODO check integrity Review comment: Let's not leave TODOs lying around. Can we address in this PR? ########## File path: superset/reports/commands/exceptions.py ########## @@ -0,0 +1,111 @@ +# 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 flask_babel import lazy_gettext as _ + +from superset.commands.exceptions import ( + CommandException, + CommandInvalidError, + CreateFailedError, + DeleteFailedError, + ValidationError, +) + + +class DatabaseNotFoundValidationError(ValidationError): + """ + Marshmallow validation error for database does not exist + """ + + def __init__(self) -> None: + super().__init__(_("Database does not exist"), field_name="database") + + +class DashboardNotFoundValidationError(ValidationError): + """ + Marshmallow validation error for dashboard does not exist + """ + + def __init__(self) -> None: + super().__init__(_("Dashboard does not exist"), field_name="dashboard") + + +class ChartNotFoundValidationError(ValidationError): + """ + Marshmallow validation error for chart does not exist + """ + + def __init__(self) -> None: + super().__init__(_("Chart does not exist"), field_name="chart") + + +class ReportScheduleAlertRequiredDatabaseValidationError(ValidationError): + """ + Marshmallow validation error for report schedule alert missing database field + """ + + def __init__(self) -> None: + super().__init__(_("Database is required for alerts"), field_name="database") + + +class ReportScheduleChartOrDashboardValidationError(ValidationError): + """ + Marshmallow validation error for report schedule accept exlusive chart or dashboard + """ + + def __init__(self) -> None: + super().__init__(_("Choose a chart or dashboard not both"), field_name="chart") + + +class ReportScheduleInvalidError(CommandInvalidError): + message = _("Report Schedule parameters are invalid.") + + +class ReportScheduleBulkDeleteFailedError(DeleteFailedError): + message = _("Report Schedule could not be deleted.") + + +class ReportScheduleCreateFailedError(CreateFailedError): + message = _("Report Schedule could not be created.") + + +class ReportScheduleUpdateFailedError(CreateFailedError): + message = _("Report Schedule could not be updated.") + + +class ReportScheduleNotFoundError(CommandException): + message = _("Report Schedule not found.") + + +class ReportScheduleDeleteFailedError(CommandException): + message = _("Report Schedule delete failed.") + + +class ReportScheduleDeleteIntegrityError(CommandException): + message = _("Report Schedule has associated logs or recipients.") Review comment: It should be possible to delete a ReportSchedule with associated logs and recipients. Neither of those related objects have meaningful stand-alone delete operations and they make no sense without the related ReportSchedule record. Let's use a cascading delete and remove this error. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
