upstream-zulip/zerver/webhooks/dbt/view.py

from urllib.parse import urljoin

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 JsonBodyPayload, 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

NOTIFICATION_TEMPLATE = """
{emoji} {job_name} {run_text} {status} in **{environment}**.

{job_text} was {run_reason} at <time:{start_time}>.
"""

EVENT_TYPE_MAPPER = {
    "job.run.started": {
        "running": (":yellow_circle:", "started"),
    },
    "job.run.completed": {
        "success": (":green_circle:", "succeeded"),
        "errored": (":cross_mark:", "completed with errors"),
    },
    "job.run.errored": {
        "errored": (":cross_mark:", "failed"),
    },
}

ALL_EVENT_TYPES = list(EVENT_TYPE_MAPPER.keys())


def extract_data_from_payload(payload: JsonBodyPayload[WildValue]) -> dict[str, str]:
    data: dict[str, str] = {
        "account_id": str(payload["accountId"].tame(check_int)),
        "event_type": payload["eventType"].tame(check_string),
        "job_id": payload["data"]["jobId"].tame(check_string),
        "job_name": payload["data"]["jobName"].tame(check_string),
        "project_name": payload["data"]["projectName"].tame(check_string),
        "project_id": payload["data"]["projectId"].tame(check_string),
        "environment": payload["data"]["environmentName"].tame(check_string),
        "run_id": payload["data"]["runId"].tame(check_string),
        "start_time": payload["data"]["runStartedAt"].tame(check_string),
        "run_status": payload["data"]["runStatus"].tame(check_string).lower(),
    }
    # We only change the capitalization of the first letter in this
    # string for the formatting of our notification template.
    run_reason = payload["data"]["runReason"].tame(check_string)
    data["run_reason"] = run_reason[:1].lower() + run_reason[1:]
    return data


def get_job_run_body(data: dict[str, str], access_url: str | None) -> str:
    emoji, status = EVENT_TYPE_MAPPER[data["event_type"]][data["run_status"]]

    project_url = (
        urljoin(
            access_url,
            f"/deploy/{data['account_id']}/projects/{data['project_id']}",
        )
        if access_url
        else None
    )
    job_text = (
        f"[Job #{data['job_id']}]({project_url}/jobs/{data['job_id']})"
        if project_url
        else f"Job #{data['job_id']}"
    )
    run_text = f"[deployment]({project_url}/runs/{data['run_id']})" if project_url else "deployment"

    body = NOTIFICATION_TEMPLATE.format(
        emoji=emoji,
        status=status,
        run_text=run_text,
        job_text=job_text,
        **data,
    )
    return body


@webhook_view("DBT", all_event_types=ALL_EVENT_TYPES)
@typed_endpoint
def api_dbt_webhook(
    request: HttpRequest,
    user_profile: UserProfile,
    *,
    payload: JsonBodyPayload[WildValue],
    access_url: str | None = None,
) -> HttpResponse:
    data = extract_data_from_payload(payload)
    body = get_job_run_body(data, access_url)
    topic_name = data["project_name"]
    event = data["event_type"]
    check_send_webhook_message(request, user_profile, topic_name, body, event)
    return json_success(request)