feat(pagerduty): Issue alerts will include alert name in summary (#87786)

For issue alerts that include a pagerduty notification action, the name
of the alert rule will be included in the title.

Also ensures test notifications have a label and can include one from
the alert. This will enable users to see what the actual Pagerduty
Incident title will be from the `Send Test Notification` button. If they
are setting up a notif for the first time and haven't added a name `Test
Alert` will be used instead.

Will require a followup FE PR to send the notif title along with the
preview alert payload.

<img width="1402" alt="image"
src="https://github.com/user-attachments/assets/fb481f48-03c5-4213-93fb-d2c6293f0617"
/>

**todo**
- [x] Add screenshots
- [x] Add tests

Author: leeandher

src/sentry/api/endpoints/project_rule_actions.py

@@ -9,7 +9,7 @@
 from sentry.api.api_publish_status import ApiPublishStatus
 from sentry.api.base import region_silo_endpoint
 from sentry.api.bases import ProjectAlertRulePermission, ProjectEndpoint
-from sentry.api.serializers.rest_framework import RuleActionSerializer
+from sentry.api.serializers.rest_framework import DummyRuleSerializer
 from sentry.eventstore.models import GroupEvent
 from sentry.models.rule import Rule
 from sentry.rules.processing.processor import activate_downstream_actions
@@ -33,10 +33,11 @@ def post(self, request: Request, project) -> Response:
             {method} {path}
             {{
                 "actions": []
+                "name": string
             }}
 
         """
-        serializer = RuleActionSerializer(
+        serializer = DummyRuleSerializer(
             context={"project": project, "organization": project.organization}, data=request.data
         )
 
@@ -58,7 +59,7 @@ def post(self, request: Request, project) -> Response:
                 "frequency": 30,
             }
         )
-        rule = Rule(id=-1, project=project, data=data)
+        rule = Rule(id=-1, project=project, data=data, label=data.get("name"))
 
         test_event = create_sample_event(
             project, platform=project.platform, default="javascript", tagged=True

src/sentry/api/serializers/rest_framework/rule.py

@@ -140,9 +140,17 @@ class RulePreviewSerializer(RuleSetSerializer):
     endpoint = serializers.DateTimeField(required=False, allow_null=True)
 
 
-class RuleActionSerializer(serializers.Serializer):
+class DummyRuleSerializer(serializers.Serializer):
+    name = serializers.CharField(
+        max_length=256, required=False, allow_null=True, allow_blank=True, default="Test Alert"
+    )
     actions = serializers.ListField(child=RuleNodeField(type="action/event"), required=False)
 
+    def validate_name(self, name):
+        if name == "" or name is None:
+            return "Test Alert"
+        return name
+
     def validate(self, attrs):
         return validate_actions(attrs)
 

src/sentry/integrations/pagerduty/actions/notification.py

@@ -12,6 +12,7 @@
     PagerdutySeverity,
     build_pagerduty_event_payload,
 )
+from sentry.models.rule import Rule
 from sentry.rules.actions import IntegrationEventAction
 from sentry.shared_integrations.exceptions import ApiError
 
@@ -90,6 +91,12 @@ def send_notification(event, futures):
                 severity=severity,
             )
 
+            rules: list[Rule] = [f.rule for f in futures]
+            rule = rules[0] if rules else None
+
+            if rule and rule.label:
+                data["payload"]["summary"] = f"[{rule.label}]: {data['payload']['summary']}"
+
             try:
                 resp = client.send_trigger(data=data)
             except ApiError as e:
@@ -104,8 +111,7 @@ def send_notification(event, futures):
                     },
                 )
                 raise
-            rules = [f.rule for f in futures]
-            rule = rules[0] if rules else None
+
             self.record_notification_sent(event, str(service["id"]), rule, notification_uuid)
 
             # TODO(meredith): Maybe have a generic success log statements for

tests/sentry/api/endpoints/test_project_rule_actions.py

@@ -3,6 +3,8 @@
 import sentry_sdk
 
 from sentry.integrations.jira.integration import JiraIntegration
+from sentry.integrations.pagerduty.client import PagerDutyClient
+from sentry.integrations.pagerduty.utils import PagerDutyServiceDict, add_service
 from sentry.rules.actions.notify_event import NotifyEventAction
 from sentry.shared_integrations.exceptions import IntegrationFormError
 from sentry.silo.base import SiloMode
@@ -20,6 +22,27 @@ class ProjectRuleActionsEndpointTest(APITestCase):
     def setUp(self):
         self.login_as(self.user)
 
+    def setup_pd_service(self) -> PagerDutyServiceDict:
+        service_info = {
+            "type": "service",
+            "integration_key": "PND123",
+            "service_name": "Sentry Service",
+        }
+        _integration, org_integration = self.create_provider_integration_for(
+            provider="pagerduty",
+            name="Example PagerDuty",
+            external_id="example-pd",
+            metadata={"services": [service_info]},
+            organization=self.organization,
+            user=self.user,
+        )
+        with assume_test_silo_mode(SiloMode.CONTROL):
+            return add_service(
+                org_integration,
+                service_name=service_info["service_name"],
+                integration_key=service_info["integration_key"],
+            )
+
     @mock.patch.object(NotifyEventAction, "after")
     def test_actions(self, action):
         action_data = [
@@ -29,9 +52,53 @@ def test_actions(self, action):
         ]
 
         self.get_success_response(self.organization.slug, self.project.slug, actions=action_data)
-
         assert action.called
 
+    @mock.patch.object(PagerDutyClient, "send_trigger")
+    def test_name_action_default(self, mock_send_trigger):
+        """
+        Tests that label will be used as 'Test Alert' if not present. Uses PagerDuty since those
+        notifications will differ based on the name of the alert.
+        """
+        service_info = self.setup_pd_service()
+        action_data = [
+            {
+                "account": service_info["integration_id"],
+                "service": service_info["id"],
+                "severity": "info",
+                "id": "sentry.integrations.pagerduty.notify_action.PagerDutyNotifyServiceAction",
+            }
+        ]
+        self.get_success_response(self.organization.slug, self.project.slug, actions=action_data)
+
+        assert mock_send_trigger.call_count == 1
+        pagerduty_data = mock_send_trigger.call_args.kwargs.get("data")
+        assert pagerduty_data["payload"]["summary"].startswith("[Test Alert]:")
+
+    @mock.patch.object(PagerDutyClient, "send_trigger")
+    def test_name_action_with_custom_name(self, mock_send_trigger):
+        """
+        Tests that custom names can be provided to the test notification. Uses PagerDuty since those
+        notifications will differ based on the name of the alert.
+        """
+        service_info = self.setup_pd_service()
+        action_data = [
+            {
+                "account": service_info["integration_id"],
+                "service": service_info["id"],
+                "severity": "info",
+                "id": "sentry.integrations.pagerduty.notify_action.PagerDutyNotifyServiceAction",
+            }
+        ]
+        custom_alert_name = "Check #feed-issues"
+
+        self.get_success_response(
+            self.organization.slug, self.project.slug, actions=action_data, name=custom_alert_name
+        )
+        assert mock_send_trigger.call_count == 1
+        pagerduty_data = mock_send_trigger.call_args.kwargs.get("data")
+        assert pagerduty_data["payload"]["summary"].startswith(f"[{custom_alert_name}]:")
+
     @mock.patch.object(JiraIntegration, "create_issue")
     @mock.patch.object(sentry_sdk, "capture_exception")
     def test_sample_event_raises_exceptions(self, mock_sdk_capture, mock_create_issue):

tests/sentry/integrations/pagerduty/test_notification.py

@@ -15,6 +15,7 @@
 from sentry.testutils.helpers.notifications import TEST_ISSUE_OCCURRENCE
 from sentry.testutils.silo import assume_test_silo_mode
 from sentry.testutils.skips import requires_snuba
+from sentry.types.rules import RuleFuture
 
 pytestmark = [requires_snuba]
 
@@ -35,6 +36,7 @@ class PagerDutyNotifyActionTest(RuleTestCase, PerformanceIssueTestCase):
     rule_cls = PagerDutyNotifyServiceAction
 
     def setUp(self):
+        self.project_rule = self.create_project_rule(name="Check #project-channel")
         with assume_test_silo_mode(SiloMode.CONTROL):
             self.integration, org_integration = self.create_provider_integration_for(
                 self.organization,
@@ -66,12 +68,21 @@ def test_applies_correctly(self, mock_record):
         )
 
         rule = self.get_rule(
-            data={"account": self.integration.id, "service": str(self.service["id"])}
+            data={
+                "account": self.integration.id,
+                "service": str(self.service["id"]),
+                "name": "Test Alert",
+            }
         )
 
         notification_uuid = "123e4567-e89b-12d3-a456-426614174000"
 
-        results = list(rule.after(event=event, notification_uuid=notification_uuid))
+        results = list(
+            rule.after(
+                event=event,
+                notification_uuid=notification_uuid,
+            )
+        )
         assert len(results) == 1
 
         responses.add(
@@ -83,11 +94,12 @@ def test_applies_correctly(self, mock_record):
         )
 
         # Trigger rule callback
-        results[0].callback(event, futures=[])
+        rule_future = RuleFuture(rule=self.project_rule, kwargs=results[0].kwargs)
+        results[0].callback(event, futures=[rule_future])
         data = orjson.loads(responses.calls[0].request.body)
 
         assert data["event_action"] == "trigger"
-        assert data["payload"]["summary"] == event.message
+        assert data["payload"]["summary"] == f"[{self.project_rule.label}]: {event.message}"
         assert data["payload"]["custom_details"]["message"] == event.message
         assert event.group is not None
         assert data["links"][0]["href"] == event.group.get_absolute_url(
@@ -97,7 +109,7 @@ def test_applies_correctly(self, mock_record):
         mock_record.assert_called_with(
             "alert.sent",
             provider="pagerduty",
-            alert_id="",
+            alert_id=self.project_rule.id,
             alert_type="issue_alert",
             organization_id=self.organization.id,
             project_id=event.project_id,
@@ -111,7 +123,7 @@ def test_applies_correctly(self, mock_record):
             project_id=event.project_id,
             group_id=event.group_id,
             notification_uuid=notification_uuid,
-            alert_id=None,
+            alert_id=self.project_rule.id,
         )
 
     @responses.activate
@@ -130,13 +142,14 @@ def test_applies_correctly_performance_issue(self):
         )
 
         # Trigger rule callback
-        results[0].callback(event, futures=[])
+        rule_future = RuleFuture(rule=self.project_rule, kwargs=results[0].kwargs)
+        results[0].callback(event, futures=[rule_future])
         data = orjson.loads(responses.calls[0].request.body)
 
         perf_issue_title = "N+1 Query"
 
         assert data["event_action"] == "trigger"
-        assert data["payload"]["summary"] == perf_issue_title
+        assert data["payload"]["summary"] == f"[{self.project_rule.label}]: {perf_issue_title}"
         assert data["payload"]["custom_details"]["title"] == perf_issue_title
 
     @responses.activate
@@ -165,11 +178,15 @@ def test_applies_correctly_generic_issue(self):
         )
 
         # Trigger rule callback
-        results[0].callback(group_event, futures=[])
+        rule_future = RuleFuture(rule=self.project_rule, kwargs=results[0].kwargs)
+        results[0].callback(group_event, futures=[rule_future])
         data = orjson.loads(responses.calls[0].request.body)
 
         assert data["event_action"] == "trigger"
-        assert data["payload"]["summary"] == group_event.occurrence.issue_title
+        assert (
+            data["payload"]["summary"]
+            == f"[{self.project_rule.label}]: {group_event.occurrence.issue_title}"
+        )
         assert data["payload"]["custom_details"]["title"] == group_event.occurrence.issue_title
 
     def test_render_label_without_severity(self):