zulip/zerver/webhooks/gci/view.py

from typing import Callable, Optional

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_float, check_int, check_string
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile

GCI_MESSAGE_TEMPLATE = "**{actor}** {action} the task [{task_name}]({task_url})."
GCI_TOPIC_TEMPLATE = "{student_name}"


def build_instance_url(instance_id: int) -> str:
    return f"https://codein.withgoogle.com/dashboard/task-instances/{instance_id}/"


class UnknownEventTypeError(Exception):
    pass


def get_abandon_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["task_claimed_by"].tame(check_string),
        action="{}ed".format(payload["event_type"].tame(check_string)),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_submit_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["task_claimed_by"].tame(check_string),
        action="{}ted".format(payload["event_type"].tame(check_string)),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_comment_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["author"].tame(check_string),
        action="{}ed on".format(payload["event_type"].tame(check_string)),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_claim_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["task_claimed_by"].tame(check_string),
        action="{}ed".format(payload["event_type"].tame(check_string)),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_approve_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["author"].tame(check_string),
        action="{}d".format(payload["event_type"].tame(check_string)),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_approve_pending_pc_event_body(payload: WildValue) -> str:
    template = "{} (pending parental consent).".format(GCI_MESSAGE_TEMPLATE.rstrip("."))
    return template.format(
        actor=payload["author"].tame(check_string),
        action="approved",
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_needswork_event_body(payload: WildValue) -> str:
    template = "{} for more work.".format(GCI_MESSAGE_TEMPLATE.rstrip("."))
    return template.format(
        actor=payload["author"].tame(check_string),
        action="submitted",
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_extend_event_body(payload: WildValue) -> str:
    template = "{} by {days} day(s).".format(
        GCI_MESSAGE_TEMPLATE.rstrip("."), days=payload["extension_days"].tame(check_float)
    )
    return template.format(
        actor=payload["author"].tame(check_string),
        action="extended the deadline for",
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_unassign_event_body(payload: WildValue) -> str:
    return GCI_MESSAGE_TEMPLATE.format(
        actor=payload["author"].tame(check_string),
        action="unassigned **{student}** from".format(
            student=payload["task_claimed_by"].tame(check_string)
        ),
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


def get_outoftime_event_body(payload: WildValue) -> str:
    return "The deadline for the task [{task_name}]({task_url}) has passed.".format(
        task_name=payload["task_definition_name"].tame(check_string),
        task_url=build_instance_url(payload["task_instance"].tame(check_int)),
    )


EVENTS_FUNCTION_MAPPER = {
    "abandon": get_abandon_event_body,
    "approve": get_approve_event_body,
    "approve-pending-pc": get_approve_pending_pc_event_body,
    "claim": get_claim_event_body,
    "comment": get_comment_event_body,
    "extend": get_extend_event_body,
    "needswork": get_needswork_event_body,
    "outoftime": get_outoftime_event_body,
    "submit": get_submit_event_body,
    "unassign": get_unassign_event_body,
}

ALL_EVENT_TYPES = list(EVENTS_FUNCTION_MAPPER.keys())


@webhook_view("GoogleCodeIn", all_event_types=ALL_EVENT_TYPES)
@typed_endpoint
def api_gci_webhook(
    request: HttpRequest,
    user_profile: UserProfile,
    *,
    payload: WebhookPayload[WildValue],
) -> HttpResponse:
    event = get_event(payload)
    if event is not None:
        body = get_body_based_on_event(event)(payload)
        topic = GCI_TOPIC_TEMPLATE.format(
            student_name=payload["task_claimed_by"].tame(check_string),
        )
        check_send_webhook_message(request, user_profile, topic, body, event)

    return json_success(request)


def get_event(payload: WildValue) -> Optional[str]:
    event = payload["event_type"].tame(check_string)
    if event in EVENTS_FUNCTION_MAPPER:
        return event

    raise UnknownEventTypeError(f"Event '{event}' is unknown and cannot be handled")  # nocoverage


def get_body_based_on_event(event: str) -> Callable[[WildValue], str]:
    return EVENTS_FUNCTION_MAPPER[event]