feat(notif platform): Impl basic Slack renderer (#97623)

Author: Christinarlong

src/sentry/notifications/platform/slack/provider.py

@@ -1,4 +1,15 @@
-from typing import Any
+from typing import TypedDict
+
+from slack_sdk.models.blocks import (
+    ActionsBlock,
+    Block,
+    ButtonElement,
+    HeaderBlock,
+    ImageBlock,
+    MarkdownTextObject,
+    PlainTextObject,
+    SectionBlock,
+)
 
 from sentry.notifications.platform.provider import NotificationProvider
 from sentry.notifications.platform.registry import provider_registry
@@ -13,18 +24,39 @@
 )
 from sentry.organizations.services.organization.model import RpcOrganizationSummary
 
-# TODO(ecosystem): Figure out a way to use 'SlackBlock' type
-type SlackRenderable = Any
+
+class SlackRenderable(TypedDict):
+    blocks: list[Block]
 
 
 class SlackRenderer(NotificationRenderer[SlackRenderable]):
-    provider_key = NotificationProviderKey.DISCORD
+    provider_key = NotificationProviderKey.SLACK
 
     @classmethod
     def render[DataT: NotificationData](
         cls, *, data: DataT, rendered_template: NotificationRenderedTemplate
     ) -> SlackRenderable:
-        return {}
+        subject = HeaderBlock(text=PlainTextObject(text=rendered_template.subject))
+        body = SectionBlock(text=MarkdownTextObject(text=rendered_template.body))
+
+        blocks = [subject, body]
+
+        if len(rendered_template.actions) > 0:
+            actions_block = ActionsBlock(elements=[])
+            for action in rendered_template.actions:
+                actions_block.elements.append(ButtonElement(text=action.label, url=action.link))
+            blocks.append(actions_block)
+
+        if rendered_template.footer:
+            footer = SectionBlock(text=MarkdownTextObject(text=rendered_template.footer))
+            blocks.append(footer)
+        if rendered_template.chart:
+            chart = ImageBlock(
+                image_url=rendered_template.chart.url, alt_text=rendered_template.chart.alt_text
+            )
+            blocks.append(chart)
+
+        return SlackRenderable(blocks=blocks)
 
 
 @provider_registry.register(NotificationProviderKey.SLACK)

src/sentry/notifications/platform/types.py

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
 import abc
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from enum import StrEnum
-from typing import Any, Protocol, TypedDict
+from typing import Any, Protocol
 
 from sentry.integrations.types import ExternalProviderEnum
 
@@ -80,7 +80,8 @@ class NotificationData(Protocol):
     """
 
 
-class NotificationRenderedAction(TypedDict):
+@dataclass(frozen=True)
+class NotificationRenderedAction:
     """
     A rendered action for an integration.
     """
@@ -96,6 +97,22 @@ class NotificationRenderedAction(TypedDict):
     """
 
 
+@dataclass(frozen=True)
+class NotificationRenderedImage:
+    """
+    An image that will be displayed in the notification.
+    """
+
+    url: str
+    """
+    The URL of the image.
+    """
+    alt_text: str
+    """
+    The alt text of the image.
+    """
+
+
 @dataclass(frozen=True)
 class NotificationRenderedTemplate:
     subject: str
@@ -110,13 +127,13 @@ class NotificationRenderedTemplate:
     keeping it concise and useful to the receiver. This string should not contain any formatting,
     and will be displayed as is.
     """
-    actions: list[NotificationRenderedAction]
+    actions: list[NotificationRenderedAction] = field(default_factory=list)
     """
     The list of actions that a receiver may take after having received the notification.
     """
-    chart: str | None = None
+    chart: NotificationRenderedImage | None = None
     """
-    The accessible URL of a chart that will be displayed in the notification.
+    The image that will be displayed in the notification.
     """
     footer: str | None = None
     """

src/sentry/testutils/notifications/platform.py

@@ -4,6 +4,8 @@
 from sentry.notifications.platform.types import (
     NotificationCategory,
     NotificationData,
+    NotificationRenderedAction,
+    NotificationRenderedImage,
     NotificationRenderedTemplate,
     NotificationStrategy,
     NotificationTarget,
@@ -25,16 +27,28 @@ def render(self, data: MockNotification) -> NotificationRenderedTemplate:
         return NotificationRenderedTemplate(
             subject="Mock Notification",
             body=data.message,
-            actions=[{"label": "Visit Sentry", "link": "https://www.sentry.io"}],
+            actions=[
+                NotificationRenderedAction(label="Visit Sentry", link="https://www.sentry.io")
+            ],
             footer="This is a mock footer",
+            chart=NotificationRenderedImage(
+                url="https://raw.githubusercontent.com/knobiknows/all-the-bufo/main/all-the-bufo/bufo-pog.png",
+                alt_text="Bufo Pog",
+            ),
         )
 
     def render_example(self) -> NotificationRenderedTemplate:
         return NotificationRenderedTemplate(
             subject="Mock Notification",
             body="This is a mock notification",
-            actions=[{"label": "Visit Sentry", "link": "https://www.sentry.io"}],
+            actions=[
+                NotificationRenderedAction(label="Visit Sentry", link="https://www.sentry.io")
+            ],
             footer="This is a mock footer",
+            chart=NotificationRenderedImage(
+                url="https://raw.githubusercontent.com/knobiknows/all-the-bufo/main/all-the-bufo/bufo-pog.png",
+                alt_text="Bufo Pog",
+            ),
         )
 
 

tests/sentry/notifications/platform/slack/test_provider.py

@@ -17,7 +17,30 @@ def test_default_renderer(self) -> None:
         renderer = SlackNotificationProvider.get_renderer(
             data=data, category=NotificationCategory.DEBUG
         )
-        assert renderer.render(data=data, rendered_template=rendered_template) == {}
+
+        rendererable = renderer.render(data=data, rendered_template=rendered_template)
+        rendererable_dict = [block.to_dict() for block in rendererable.get("blocks", [])]
+
+        assert rendererable_dict == [
+            {"text": {"text": "Mock Notification", "type": "plain_text"}, "type": "header"},
+            {"text": {"text": "test", "type": "mrkdwn"}, "type": "section"},
+            {
+                "elements": [
+                    {
+                        "text": {"emoji": True, "text": "Visit Sentry", "type": "plain_text"},
+                        "type": "button",
+                        "url": "https://www.sentry.io",
+                    }
+                ],
+                "type": "actions",
+            },
+            {"text": {"text": "This is a mock footer", "type": "mrkdwn"}, "type": "section"},
+            {
+                "image_url": "https://raw.githubusercontent.com/knobiknows/all-the-bufo/main/all-the-bufo/bufo-pog.png",
+                "alt_text": "Bufo Pog",
+                "type": "image",
+            },
+        ]
 
 
 class SlackNotificationProviderTest(TestCase):