mirror of
https://github.com/zulip/zulip.git
synced 2025-11-22 23:43:38 +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.
47 lines
1.6 KiB
Python
47 lines
1.6 KiB
Python
# Webhooks for external integrations.
|
|
from typing import Optional, Tuple
|
|
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.decorator import return_success_on_head_request, webhook_view
|
|
from zerver.lib.exceptions import UnsupportedWebhookEventTypeError
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.typed_endpoint import WebhookPayload, typed_endpoint
|
|
from zerver.lib.validator import WildValue, check_string
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.models import UserProfile
|
|
|
|
from .board_actions import SUPPORTED_BOARD_ACTIONS, process_board_action
|
|
from .card_actions import IGNORED_CARD_ACTIONS, SUPPORTED_CARD_ACTIONS, process_card_action
|
|
|
|
|
|
@webhook_view("Trello")
|
|
@return_success_on_head_request
|
|
@typed_endpoint
|
|
def api_trello_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
*,
|
|
payload: WebhookPayload[WildValue],
|
|
) -> HttpResponse:
|
|
action_type = payload["action"]["type"].tame(check_string)
|
|
message = get_topic_and_body(payload, action_type)
|
|
if message is None:
|
|
return json_success(request)
|
|
else:
|
|
topic, body = message
|
|
|
|
check_send_webhook_message(request, user_profile, topic, body)
|
|
return json_success(request)
|
|
|
|
|
|
def get_topic_and_body(payload: WildValue, action_type: str) -> Optional[Tuple[str, str]]:
|
|
if action_type in SUPPORTED_CARD_ACTIONS:
|
|
return process_card_action(payload, action_type)
|
|
if action_type in IGNORED_CARD_ACTIONS:
|
|
return None
|
|
if action_type in SUPPORTED_BOARD_ACTIONS:
|
|
return process_board_action(payload, action_type)
|
|
|
|
raise UnsupportedWebhookEventTypeError(action_type)
|