mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
eca9088176
This commit strengthens types by typing the webhook's incoming payload as WildValue and taming the values of the payload before usage, which eradicates the use of Any within the UptimeRobot incoming webhook integration. The payload's values are now tamed, stored in variables and passed into message templates as opposed to passing in the payload dict as keyword arguments. The KeyError exception has been replaced to catch a ValidationError instead now, since the incoming payload's keys will be tamed before usage and the non-existence of the key is raised as a ValidationError in the taming function.
92 lines
3.7 KiB
Python
92 lines
3.7 KiB
Python
from django.core.exceptions import ValidationError
|
|
from django.http import HttpRequest, HttpResponse
|
|
from django.utils.translation import gettext as _
|
|
|
|
from zerver.actions.message_send import send_rate_limited_pm_notification_to_bot_owner
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.exceptions import JsonableError
|
|
from zerver.lib.request import REQ, has_request_variables
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.send_email import FromAddress
|
|
from zerver.lib.validator import WildValue, check_string, to_wild_value
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
MISCONFIGURED_PAYLOAD_ERROR_MESSAGE = """
|
|
Hi there! Your bot {bot_name} just received a UptimeRobot payload that is missing
|
|
some data that Zulip requires. This usually indicates a configuration issue
|
|
in your UptimeRobot webhook settings. Please make sure that you set the required parameters
|
|
when configuring the UptimeRobot webhook. Contact {support_email} if you
|
|
need further help!
|
|
"""
|
|
|
|
UPTIMEROBOT_TOPIC_TEMPLATE = "{monitor_friendly_name}"
|
|
UPTIMEROBOT_MESSAGE_UP_TEMPLATE = """
|
|
{monitor_friendly_name} ({monitor_url}) is back UP ({alert_details}).
|
|
It was down for {alert_friendly_duration}.
|
|
""".strip()
|
|
UPTIMEROBOT_MESSAGE_DOWN_TEMPLATE = (
|
|
"{monitor_friendly_name} ({monitor_url}) is DOWN ({alert_details})."
|
|
)
|
|
ALL_EVENT_TYPES = ["up", "down"]
|
|
|
|
|
|
@webhook_view("UptimeRobot", all_event_types=ALL_EVENT_TYPES)
|
|
@has_request_variables
|
|
def api_uptimerobot_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
payload: WildValue = REQ(argument_type="body", converter=to_wild_value),
|
|
) -> HttpResponse:
|
|
event_type = payload["alert_type_friendly_name"].tame(check_string)
|
|
if event_type == "Up":
|
|
event = "up"
|
|
elif event_type == "Down":
|
|
event = "down"
|
|
|
|
try:
|
|
body = get_body_for_http_request(payload, event_type)
|
|
subject = get_subject_for_http_request(payload)
|
|
except ValidationError:
|
|
message = MISCONFIGURED_PAYLOAD_ERROR_MESSAGE.format(
|
|
bot_name=user_profile.full_name,
|
|
support_email=FromAddress.SUPPORT,
|
|
).strip()
|
|
send_rate_limited_pm_notification_to_bot_owner(user_profile, user_profile.realm, message)
|
|
|
|
raise JsonableError(_("Invalid payload"))
|
|
|
|
check_send_webhook_message(request, user_profile, subject, body, event)
|
|
return json_success(request)
|
|
|
|
|
|
def get_subject_for_http_request(payload: WildValue) -> str:
|
|
return UPTIMEROBOT_TOPIC_TEMPLATE.format(
|
|
monitor_friendly_name=payload["monitor_friendly_name"].tame(check_string)
|
|
)
|
|
|
|
|
|
def get_body_for_http_request(payload: WildValue, event_type: str) -> str:
|
|
if event_type == "Up":
|
|
monitor_friendly_name = payload["monitor_friendly_name"].tame(check_string)
|
|
monitor_url = payload["monitor_url"].tame(check_string)
|
|
alert_details = payload["alert_details"].tame(check_string)
|
|
alert_friendly_duration = payload["alert_friendly_duration"].tame(check_string)
|
|
body = UPTIMEROBOT_MESSAGE_UP_TEMPLATE.format(
|
|
monitor_friendly_name=monitor_friendly_name,
|
|
monitor_url=monitor_url,
|
|
alert_details=alert_details,
|
|
alert_friendly_duration=alert_friendly_duration,
|
|
)
|
|
elif event_type == "Down":
|
|
monitor_friendly_name = payload["monitor_friendly_name"].tame(check_string)
|
|
monitor_url = payload["monitor_url"].tame(check_string)
|
|
alert_details = payload["alert_details"].tame(check_string)
|
|
body = UPTIMEROBOT_MESSAGE_DOWN_TEMPLATE.format(
|
|
monitor_friendly_name=monitor_friendly_name,
|
|
monitor_url=monitor_url,
|
|
alert_details=alert_details,
|
|
)
|
|
|
|
return body
|