snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/pagerduty/view.py

@@ -0,0 +1,192 @@
+from typing import TypeAlias
+
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.exceptions import UnsupportedWebhookEventTypeError
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.validator import WildValue, check_int, check_none_or, check_string
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+FormatDictType: TypeAlias = dict[str, str | int]
+
+PAGER_DUTY_EVENT_NAMES_V2 = {
+    "incident.trigger": "triggered",
+    "incident.acknowledge": "acknowledged",
+    "incident.resolve": "resolved",
+    "incident.assign": "assigned",
+}
+
+PAGER_DUTY_EVENT_NAMES_V3 = {
+    "incident.triggered": "triggered",
+    "incident.acknowledged": "acknowledged",
+    "incident.unacknowledged": "unacknowledged",
+    "incident.resolved": "resolved",
+    "incident.reassigned": "reassigned",
+}
+
+ALL_EVENT_TYPES = [
+    "resolved",
+    "assigned",
+    "unacknowledged",
+    "acknowledged",
+    "triggered",
+    "reassigned",
+]
+
+AGENT_TEMPLATE = "[{username}]({url})"
+
+INCIDENT_WITH_SERVICE_AND_ASSIGNEE = (
+    "Incident [{incident_num_title}]({incident_url}) {action} by [{service_name}]"
+    "({service_url}) (assigned to {assignee_info})."
+)
+
+NUM_TITLE = "{incident_title} (#{incident_num})"
+
+INCIDENT_WITH_ASSIGNEE = """
+Incident [{incident_num_title}]({incident_url}) {action} by {assignee_info}.
+""".strip()
+
+INCIDENT_ASSIGNED = """
+Incident [{incident_num_title}]({incident_url}) {action} to {assignee_info}.
+""".strip()
+
+INCIDENT_RESOLVED_WITH_AGENT = """
+Incident [{incident_num_title}]({incident_url}) resolved by {agent_info}.
+""".strip()
+
+INCIDENT_RESOLVED = """
+Incident [{incident_num_title}]({incident_url}) resolved.
+""".strip()
+
+
+def build_pagerduty_formatdict_v2(message: WildValue) -> FormatDictType:
+    format_dict: FormatDictType = {}
+    format_dict["action"] = PAGER_DUTY_EVENT_NAMES_V2[message["event"].tame(check_string)]
+
+    format_dict["incident_id"] = message["incident"]["id"].tame(check_string)
+    format_dict["incident_num_title"] = NUM_TITLE.format(
+        incident_num=message["incident"]["incident_number"].tame(check_int),
+        incident_title=message["incident"]["title"].tame(check_string),
+    )
+    format_dict["incident_url"] = message["incident"]["html_url"].tame(check_string)
+
+    format_dict["service_name"] = message["incident"]["service"]["name"].tame(check_string)
+    format_dict["service_url"] = message["incident"]["service"]["html_url"].tame(check_string)
+
+    assignments = message["incident"]["assignments"]
+    if assignments:
+        assignee = assignments[0]["assignee"]
+        format_dict["assignee_info"] = AGENT_TEMPLATE.format(
+            username=assignee["summary"].tame(check_string),
+            url=assignee["html_url"].tame(check_string),
+        )
+    else:
+        format_dict["assignee_info"] = "nobody"
+
+    last_status_change_by = message["incident"].get("last_status_change_by")
+    if last_status_change_by is not None:
+        format_dict["agent_info"] = AGENT_TEMPLATE.format(
+            username=last_status_change_by["summary"].tame(check_string),
+            url=last_status_change_by["html_url"].tame(check_string),
+        )
+
+    return format_dict
+
+
+def build_pagerduty_formatdict_v3(event: WildValue) -> FormatDictType:
+    format_dict: FormatDictType = {}
+    format_dict["action"] = PAGER_DUTY_EVENT_NAMES_V3[event["event_type"].tame(check_string)]
+
+    format_dict["incident_id"] = event["data"]["id"].tame(check_string)
+    format_dict["incident_url"] = event["data"]["html_url"].tame(check_string)
+    format_dict["incident_num_title"] = NUM_TITLE.format(
+        incident_num=event["data"]["number"].tame(check_int),
+        incident_title=event["data"]["title"].tame(check_string),
+    )
+
+    format_dict["service_name"] = event["data"]["service"]["summary"].tame(check_string)
+    format_dict["service_url"] = event["data"]["service"]["html_url"].tame(check_string)
+
+    assignees = event["data"]["assignees"]
+    if assignees:
+        assignee = assignees[0]
+        format_dict["assignee_info"] = AGENT_TEMPLATE.format(
+            username=assignee["summary"].tame(check_string),
+            url=assignee["html_url"].tame(check_string),
+        )
+    else:
+        format_dict["assignee_info"] = "nobody"
+
+    agent = event.get("agent")
+    if agent is not None:
+        format_dict["agent_info"] = AGENT_TEMPLATE.format(
+            username=agent["summary"].tame(check_string),
+            url=agent["html_url"].tame(check_string),
+        )
+
+    return format_dict
+
+
+def send_formatted_pagerduty(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    message_type: str,
+    format_dict: FormatDictType,
+) -> None:
+    if message_type in (
+        "incident.trigger",
+        "incident.triggered",
+        "incident.unacknowledge",
+        "incident.unacknowledged",
+    ):
+        template = INCIDENT_WITH_SERVICE_AND_ASSIGNEE
+    elif message_type in ("incident.resolve", "incident.resolved"):
+        if "agent_info" in format_dict:
+            template = INCIDENT_RESOLVED_WITH_AGENT
+        else:
+            template = INCIDENT_RESOLVED  # nocoverage
+    elif message_type in ("incident.assign", "incident.reassigned"):
+        template = INCIDENT_ASSIGNED
+    else:
+        template = INCIDENT_WITH_ASSIGNEE
+
+    topic_name = "Incident {incident_num_title}".format(**format_dict)
+    body = template.format(**format_dict)
+    assert isinstance(format_dict["action"], str)
+    check_send_webhook_message(request, user_profile, topic_name, body, format_dict["action"])
+
+
+@webhook_view("PagerDuty", all_event_types=ALL_EVENT_TYPES)
+@typed_endpoint
+def api_pagerduty_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[WildValue],
+) -> HttpResponse:
+    messages = payload.get("messages")
+    if messages:
+        for message in messages:
+            message_event = message.get("event").tame(check_none_or(check_string))
+
+            if message_event not in PAGER_DUTY_EVENT_NAMES_V2:
+                raise UnsupportedWebhookEventTypeError(message_event)
+
+            format_dict = build_pagerduty_formatdict_v2(message)
+            send_formatted_pagerduty(request, user_profile, message_event, format_dict)
+    else:
+        if "event" in payload:
+            # V3 has no "messages" field, and it has key "event" instead
+            event = payload["event"]
+            event_type = event.get("event_type").tame(check_none_or(check_string))
+
+            if event_type not in PAGER_DUTY_EVENT_NAMES_V3:
+                raise UnsupportedWebhookEventTypeError(event_type)
+
+            format_dict = build_pagerduty_formatdict_v3(event)
+            send_formatted_pagerduty(request, user_profile, event_type, format_dict)
+
+    return json_success(request)