feat: add descriptions to report emails (apache#13827)

* add description to report email * add report description to slack notification * fix issues caught by linter * fix long line * remove extra line * handle missing descriptions * run python black * properly run python black
allanco91 · May 21, 2021 · 2b37aec · 2b37aec
1 parent d30f17b
commit 2b37aec
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 5 deletions.
diff --git a/superset/reports/commands/execute.py b/superset/reports/commands/execute.py
@@ -219,7 +219,12 @@ def _get_notification_content(self) -> NotificationContent:
                 f"{self._report_schedule.name}: "
                 f"{self._report_schedule.dashboard.dashboard_title}"
             )
-        return NotificationContent(name=name, url=url, screenshot=screenshot_data)
+        return NotificationContent(
+            name=name,
+            url=url,
+            screenshot=screenshot_data,
+            description=self._report_schedule.description,
+        )
 
     def _send(self, notification_content: NotificationContent) -> None:
         """

diff --git a/superset/reports/notifications/__init__.py b/superset/reports/notifications/__init__.py
@@ -22,13 +22,13 @@
 
 
 def create_notification(
-    recipient: ReportRecipients, screenshot_data: NotificationContent
+    recipient: ReportRecipients, notification_content: NotificationContent
 ) -> BaseNotification:
     """
     Notification polymorphic factory
     Returns the Notification class for the recipient type
     """
     for plugin in BaseNotification.plugins:
         if plugin.type == recipient.type:
-            return plugin(recipient, screenshot_data)
+            return plugin(recipient, notification_content)
     raise Exception("Recipient type not supported")
diff --git a/superset/reports/notifications/base.py b/superset/reports/notifications/base.py
@@ -27,6 +27,7 @@ class NotificationContent:
     url: Optional[str] = None  # url to chart/dashboard for this screenshot
     screenshot: Optional[bytes] = None  # bytes for the screenshot
     text: Optional[str] = None
+    description: Optional[str] = ""
 
 
 class BaseNotification:  # pylint: disable=too-few-public-methods

diff --git a/superset/reports/notifications/email.py b/superset/reports/notifications/email.py
@@ -68,9 +68,11 @@ def _get_content(self) -> EmailContent:
         msgid = make_msgid(domain)[1:-1]
         body = __(
             """
+            <p>%(description)s</p>
             <b><a href="%(url)s">Explore in Superset</a></b><p></p>
             <img src="cid:%(msgid)s">
             """,
+            description=self._content.description or "",
             url=self._content.url,
             msgid=msgid,
         )

diff --git a/superset/reports/notifications/slack.py b/superset/reports/notifications/slack.py
@@ -44,25 +44,31 @@ def _get_channel(self) -> str:
         return json.loads(self._recipient.recipient_config_json)["target"]
 
     @staticmethod
-    def _error_template(name: str, text: str) -> str:
+    def _error_template(name: str, description: str, text: str) -> str:
         return __(
             """
             *%(name)s*\n
+            %(description)s\n
             Error: %(text)s
             """,
             name=name,
+            description=description,
             text=text,
         )
 
     def _get_body(self) -> str:
         if self._content.text:
-            return self._error_template(self._content.name, self._content.text)
+            return self._error_template(
+                self._content.name, self._content.description or "", self._content.text
+            )
         return __(
             """
             *%(name)s*\n
+            %(description)s\n
             <%(url)s|Explore in Superset>
             """,
             name=self._content.name,
+            description=self._content.description or "",
             url=self._content.url,
         )