zulip/zerver/webhooks/errbit/view.py

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_string
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile

ERRBIT_TOPIC_TEMPLATE = "{project_name}"
ERRBIT_MESSAGE_TEMPLATE = '[{error_class}]({error_url}): "{error_message}" occurred.'


@webhook_view("Errbit")
@typed_endpoint
def api_errbit_webhook(
    request: HttpRequest,
    user_profile: UserProfile,
    *,
    payload: WebhookPayload[WildValue],
) -> HttpResponse:
    topic = get_topic(payload)
    body = get_body(payload)
    check_send_webhook_message(request, user_profile, topic, body)
    return json_success(request)


def get_topic(payload: WildValue) -> str:
    project = payload["problem"]["app_name"].tame(check_string)
    project += " / " + payload["problem"]["environment"].tame(check_string)
    return ERRBIT_TOPIC_TEMPLATE.format(project_name=project)


def get_body(payload: WildValue) -> str:
    data = {
        "error_url": payload["problem"]["url"].tame(check_string),
        "error_class": payload["problem"]["error_class"].tame(check_string),
        "error_message": payload["problem"]["message"].tame(check_string),
    }
    return ERRBIT_MESSAGE_TEMPLATE.format(**data)