Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
webhooks/grafana: Validate legacy payload fields before processing.
Pritesh Shettyaebe64db7117
diff --git a/zerver/webhooks/grafana/fixtures/alert_test_anomalous_notification.json b/zerver/webhooks/grafana/fixtures/alert_test_anomalous_notification.jsonnew file mode 100644index 00000000000..7b8603a54cd--- /dev/null+++ b/zerver/webhooks/grafana/fixtures/alert_test_anomalous_notification.json@@ -0,0 +1,3 @@+{+ "text": "🚨 TestAlert - Notification test"+}diff --git a/zerver/webhooks/grafana/tests.py b/zerver/webhooks/grafana/tests.pyindex 84b5d195329..3626123a80f 100644--- a/zerver/webhooks/grafana/tests.py+++ b/zerver/webhooks/grafana/tests.py@@ -296,3 +296,17 @@ Annotations:expected_message,content_type="application/x-www-form-urlencoded",)++ def test_anomalous_webhook_payload_test_notification(self) -> None:+ with self.assertRaises(AssertionError) as e:+ self.check_webhook(+ fixture_name="alert_test_anomalous_notification",+ expected_topic_name="",+ expected_message="",+ expect_noop=True,+ )++ self.assertIn(+ "Unable to parse request: Did Grafana generate this event?",+ e.exception.args[0],+ )diff --git a/zerver/webhooks/grafana/view.py b/zerver/webhooks/grafana/view.pyindex a31f596c0b0..6862c8541f8 100644--- a/zerver/webhooks/grafana/view.py+++ b/zerver/webhooks/grafana/view.py@@ -1,8 +1,11 @@+from dataclasses import dataclassfrom datetime import datetime+from django.core.exceptions import ValidationErrorfrom django.http import HttpRequest, HttpResponsefrom zerver.decorator import webhook_view+from zerver.lib.exceptions import AnomalousWebhookPayloadErrorfrom zerver.lib.response import json_successfrom zerver.lib.timestamp import datetime_to_global_timefrom zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint@@ -55,6 +58,29 @@ def get_global_time(dt_str: str) -> str:return datetime_to_global_time(dt)+# The fields that this webhook needs from a Grafana 7.0 alert payload.+@dataclass+class GrafanaLegacyAlert:+ title: str+ state: str+ rule_name: str+ rule_url: str+++def parse_legacy_alert(payload: WildValue) -> GrafanaLegacyAlert:+ """Parses the fields that this webhook needs from a Grafana 7.0+ alert payload, raising ValidationError if any is missing or is+ not the type that we expect.+ """+ title = payload["title"].tame(check_string)+ state = payload["state"].tame(+ check_string_in(["no_data", "paused", "alerting", "ok", "pending", "unknown"])+ )+ rule_name = payload["ruleName"].tame(check_string)+ rule_url = payload["ruleUrl"].tame(check_string)+ return GrafanaLegacyAlert(title, state, rule_name, rule_url)++@webhook_view("Grafana", all_event_types=ALL_EVENT_TYPES)@typed_endpointdef api_grafana_webhook(@@ -147,9 +173,16 @@ def api_grafana_webhook(return json_success(request)- # Grafana 7.0 alerts:- # https://grafana.com/docs/grafana/v7.0/alerting/notifications/#webhook- topic_name = OLD_TOPIC_TEMPLATE.format(alert_title=payload["title"].tame(check_string))+ try:+ # Grafana 7.0 alerts:+ # https://grafana.com/docs/grafana/v7.0/alerting/notifications/#webhook+ legacy_alert = parse_legacy_alert(payload)+ except ValidationError:+ # The payload did not include the expected fields for either+ # current or legacy Grafana webhooks.+ raise AnomalousWebhookPayloadError++ topic_name = OLD_TOPIC_TEMPLATE.format(alert_title=legacy_alert.title)eval_matches_text = ""if "evalMatches" in payload and payload["evalMatches"] is not None:@@ -163,9 +196,7 @@ def api_grafana_webhook(if "message" in payload:message_text = payload["message"].tame(check_string) + "\n\n"- state = payload["state"].tame(- check_string_in(["no_data", "paused", "alerting", "ok", "pending", "unknown"])- )+ state = legacy_alert.stateif state == "alerting":alert_status = ALERT_STATUS_TEMPLATE.format(alert_icon=":alert:", alert_state=state.upper())elif state == "ok":@@ -178,8 +209,8 @@ def api_grafana_webhook(body = OLD_MESSAGE_TEMPLATE.format(alert_message=message_text,alert_status=alert_status,- rule_name=payload["ruleName"].tame(check_string),- rule_url=payload["ruleUrl"].tame(check_string),+ rule_name=legacy_alert.rule_name,+ rule_url=legacy_alert.rule_url,eval_matches=eval_matches_text,)