feat: Backend Validation for Creation Method (#16375)
* backend creation method validation
* added tests
* Update superset/reports/dao.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update superset/reports/dao.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update tests/integration_tests/reports/api_tests.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update tests/integration_tests/reports/api_tests.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update superset/reports/dao.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update superset/reports/dao.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update superset/reports/commands/create.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* Update superset/reports/commands/exceptions.py
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
* revisions
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
diff --git a/superset/models/slice.py b/superset/models/slice.py
index b4c7f66..9093cfa 100644
--- a/superset/models/slice.py
+++ b/superset/models/slice.py
@@ -53,7 +53,7 @@
logger = logging.getLogger(__name__)
-class Slice( # pylint: disable=too-many-public-methods
+class Slice( # pylint: disable=too-many-public-methods, too-many-instance-attributes
Model, AuditMixinNullable, ImportExportMixin
):
"""A slice is essentially a report or a view on data"""
diff --git a/superset/reports/api.py b/superset/reports/api.py
index 3a049c0..1a5907f 100644
--- a/superset/reports/api.py
+++ b/superset/reports/api.py
@@ -271,7 +271,6 @@
@expose("/", methods=["POST"])
@protect()
- @safe
@statsd_metrics
@permission_name("post")
def post(self) -> Response:
diff --git a/superset/reports/commands/create.py b/superset/reports/commands/create.py
index b260fb9..b1b6c73 100644
--- a/superset/reports/commands/create.py
+++ b/superset/reports/commands/create.py
@@ -25,12 +25,13 @@
from superset.commands.base import CreateMixin
from superset.dao.exceptions import DAOCreateFailedError
from superset.databases.dao import DatabaseDAO
-from superset.models.reports import ReportScheduleType
+from superset.models.reports import ReportCreationMethodType, ReportScheduleType
from superset.reports.commands.base import BaseReportScheduleCommand
from superset.reports.commands.exceptions import (
DatabaseNotFoundValidationError,
ReportScheduleAlertRequiredDatabaseValidationError,
ReportScheduleCreateFailedError,
+ ReportScheduleCreationMethodUniquenessValidationError,
ReportScheduleInvalidError,
ReportScheduleNameUniquenessValidationError,
ReportScheduleRequiredTypeValidationError,
@@ -59,6 +60,10 @@
owner_ids: Optional[List[int]] = self._properties.get("owners")
name = self._properties.get("name", "")
report_type = self._properties.get("type")
+ creation_method = self._properties.get("creation_method")
+ chart_id = self._properties.get("chart")
+ dashboard_id = self._properties.get("dashboard")
+ user_id = self._actor.id
# Validate type is required
if not report_type:
@@ -84,6 +89,16 @@
# Validate chart or dashboard relations
self.validate_chart_dashboard(exceptions)
+ # Validate that each chart or dashboard only has one report with
+ # the respective creation method.
+ if (
+ creation_method != ReportCreationMethodType.ALERTS_REPORTS
+ and not ReportScheduleDAO.validate_unique_creation_method(
+ user_id, dashboard_id, chart_id
+ )
+ ):
+ raise ReportScheduleCreationMethodUniquenessValidationError()
+
if "validator_config_json" in self._properties:
self._properties["validator_config_json"] = json.dumps(
self._properties["validator_config_json"]
diff --git a/superset/reports/commands/exceptions.py b/superset/reports/commands/exceptions.py
index 41b2e56..27fcd1e 100644
--- a/superset/reports/commands/exceptions.py
+++ b/superset/reports/commands/exceptions.py
@@ -167,6 +167,11 @@
super().__init__([_("Name must be unique")], field_name="name")
+class ReportScheduleCreationMethodUniquenessValidationError(CommandException):
+ status = 409
+ message = "Resource already has an attached report."
+
+
class AlertQueryMultipleRowsError(CommandException):
message = _("Alert query returned more then one row.")
diff --git a/superset/reports/dao.py b/superset/reports/dao.py
index ce69ba0..11947a3 100644
--- a/superset/reports/dao.py
+++ b/superset/reports/dao.py
@@ -114,6 +114,24 @@
raise DAODeleteFailedError(str(ex)) from ex
@staticmethod
+ def validate_unique_creation_method(
+ user_id: int, dashboard_id: Optional[int] = None, chart_id: Optional[int] = None
+ ) -> bool:
+ """
+ Validate if the user already has a chart or dashboard
+ with a report attached form the self subscribe reports
+ """
+
+ query = db.session.query(ReportSchedule).filter_by(created_by_fk=user_id)
+ if dashboard_id is not None:
+ query = query.filter(ReportSchedule.dashboard_id == dashboard_id)
+
+ if chart_id is not None:
+ query = query.filter(ReportSchedule.chart_id == chart_id)
+
+ return not db.session.query(query.exists()).scalar()
+
+ @staticmethod
def validate_update_uniqueness(
name: str, report_type: str, report_schedule_id: Optional[int] = None
) -> bool:
diff --git a/tests/integration_tests/reports/api_tests.py b/tests/integration_tests/reports/api_tests.py
index 55fce65..7526d11 100644
--- a/tests/integration_tests/reports/api_tests.py
+++ b/tests/integration_tests/reports/api_tests.py
@@ -768,7 +768,7 @@
)
def test_no_dashboard_report_schedule_schema(self):
"""
- ReportSchedule Api: Test create report schedule with not dashboard id
+ ReportSchedule Api: Test create report schedule with no dashboard id
"""
self.login(username="admin")
chart = db.session.query(Slice).first()
@@ -790,6 +790,122 @@
== "Please save your dashboard first, then try creating a new email report."
)
+ @pytest.mark.usefixtures(
+ "load_birth_names_dashboard_with_slices", "create_report_schedules"
+ )
+ def test_create_multiple_creation_method_report_schedule_charts(self):
+ """
+ ReportSchedule Api: Test create multiple reports with the same creation method
+ """
+ self.login(username="admin")
+ chart = db.session.query(Slice).first()
+ dashboard = db.session.query(Dashboard).first()
+ example_db = get_example_database()
+ report_schedule_data = {
+ "type": ReportScheduleType.REPORT,
+ "name": "name4",
+ "description": "description",
+ "creation_method": ReportCreationMethodType.CHARTS,
+ "crontab": "0 9 * * *",
+ "working_timeout": 3600,
+ "chart": chart.id,
+ }
+ uri = "api/v1/report/"
+ rv = self.client.post(uri, json=report_schedule_data)
+ data = json.loads(rv.data.decode("utf-8"))
+ assert rv.status_code == 201
+
+ # this second time it should receive an error because the chart has an attached report
+ # with the same creation method from the same user.
+ report_schedule_data = {
+ "type": ReportScheduleType.REPORT,
+ "name": "name5",
+ "description": "description",
+ "creation_method": ReportCreationMethodType.CHARTS,
+ "crontab": "0 9 * * *",
+ "working_timeout": 3600,
+ "chart": chart.id,
+ }
+ uri = "api/v1/report/"
+ rv = self.client.post(uri, json=report_schedule_data)
+ data = json.loads(rv.data.decode("utf-8"))
+ assert rv.status_code == 409
+ assert data == {
+ "errors": [
+ {
+ "message": "Resource already has an attached report.",
+ "error_type": "GENERIC_COMMAND_ERROR",
+ "level": "warning",
+ "extra": {
+ "issue_codes": [
+ {
+ "code": 1010,
+ "message": "Issue 1010 - Superset encountered an error while running a command.",
+ }
+ ]
+ },
+ }
+ ]
+ }
+
+ @pytest.mark.usefixtures(
+ "load_birth_names_dashboard_with_slices", "create_report_schedules"
+ )
+ def test_create_multiple_creation_method_report_schedule_dashboards(self):
+ """
+ ReportSchedule Api: Test create multiple reports with the same creation method
+ """
+ self.login(username="admin")
+ chart = db.session.query(Slice).first()
+ dashboard = db.session.query(Dashboard).first()
+ example_db = get_example_database()
+ report_schedule_data = {
+ "type": ReportScheduleType.REPORT,
+ "name": "name4",
+ "description": "description",
+ "creation_method": ReportCreationMethodType.DASHBOARDS,
+ "crontab": "0 9 * * *",
+ "working_timeout": 3600,
+ "dashboard": dashboard.id,
+ }
+ uri = "api/v1/report/"
+ rv = self.client.post(uri, json=report_schedule_data)
+ data = json.loads(rv.data.decode("utf-8"))
+ assert rv.status_code == 201
+
+ # this second time it should receive an error because the dashboard has an attached report
+ # with the same creation method from the same user.
+ report_schedule_data = {
+ "type": ReportScheduleType.REPORT,
+ "name": "name5",
+ "description": "description",
+ "creation_method": ReportCreationMethodType.DASHBOARDS,
+ "crontab": "0 9 * * *",
+ "working_timeout": 3600,
+ "dashboard": dashboard.id,
+ }
+ uri = "api/v1/report/"
+ rv = self.client.post(uri, json=report_schedule_data)
+ data = json.loads(rv.data.decode("utf-8"))
+ assert rv.status_code == 409
+ assert data == {
+ "errors": [
+ {
+ "message": "Resource already has an attached report.",
+ "error_type": "GENERIC_COMMAND_ERROR",
+ "level": "warning",
+ "extra": {
+ "issue_codes": [
+ {
+ "code": 1010,
+ "message": "Issue 1010 - Superset encountered an error while running a command.",
+ }
+ ]
+ },
+ }
+ ]
+ }
+
@pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
def test_create_report_schedule_chart_dash_validation(self):
"""
