mirror of
https://github.com/zulip/zulip.git
synced 2025-11-18 04:43:58 +00:00
9377080f1f
This converts most webhook integration views to use @typed_endpoint instead of @has_request_variables, rewriting REQ parameters. For these webhooks, it simply requires switching the decorator, rewriting the type annotation of payload/message to WebhookPayload[WildValue], and removing the REQ default that defines the to_wild_value converter.
45 lines
1.6 KiB
Python
45 lines
1.6 KiB
Python
# Webhooks for external integrations.
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.typed_endpoint import WebhookPayload, typed_endpoint
|
|
from zerver.lib.validator import WildValue, check_int, check_string
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
CRASHLYTICS_TOPIC_TEMPLATE = "{display_id}: {title}"
|
|
CRASHLYTICS_MESSAGE_TEMPLATE = "[Issue]({url}) impacts at least {impacted_devices_count} device(s)."
|
|
|
|
CRASHLYTICS_SETUP_TOPIC_TEMPLATE = "Setup"
|
|
CRASHLYTICS_SETUP_MESSAGE_TEMPLATE = "Webhook has been successfully configured."
|
|
|
|
VERIFICATION_EVENT = "verification"
|
|
|
|
|
|
@webhook_view("Crashlytics")
|
|
@typed_endpoint
|
|
def api_crashlytics_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
*,
|
|
payload: WebhookPayload[WildValue],
|
|
) -> HttpResponse:
|
|
event = payload["event"]
|
|
if event == VERIFICATION_EVENT:
|
|
topic = CRASHLYTICS_SETUP_TOPIC_TEMPLATE
|
|
body = CRASHLYTICS_SETUP_MESSAGE_TEMPLATE
|
|
else:
|
|
issue_body = payload["payload"]
|
|
topic = CRASHLYTICS_TOPIC_TEMPLATE.format(
|
|
display_id=issue_body["display_id"].tame(check_int),
|
|
title=issue_body["title"].tame(check_string),
|
|
)
|
|
body = CRASHLYTICS_MESSAGE_TEMPLATE.format(
|
|
impacted_devices_count=issue_body["impacted_devices_count"].tame(check_int),
|
|
url=issue_body["url"].tame(check_string),
|
|
)
|
|
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
return json_success(request)
|