mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
c32e6f4940
- Made the branch-filtering checks uniform across all the integrations, by adding a helper function to git.py, and re-using it. - Instead of checking if the name of the branch that generated the event is a substring of the "branches" parameter, we now check if there's an exact match. For example, if there are two branches named "main" and "release/v1.0-main", and the user wants to track pushes to only the "release/v1.0-main" branch, they wouldn't have been able to previously, it will always track pushes to both branches. There was no way to filter out the smaller named branch when there were overlaps.
102 lines
3.3 KiB
Python
102 lines
3.3 KiB
Python
from collections.abc import Callable
|
|
|
|
from django.core.exceptions import ValidationError
|
|
from django.http import HttpRequest, HttpResponse
|
|
|
|
from zerver.decorator import webhook_view
|
|
from zerver.lib.exceptions import UnsupportedWebhookEventTypeError
|
|
from zerver.lib.response import json_success
|
|
from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
|
|
from zerver.lib.validator import WildValue, check_string
|
|
from zerver.lib.webhooks.common import check_send_webhook_message
|
|
from zerver.lib.webhooks.git import (
|
|
TOPIC_WITH_BRANCH_TEMPLATE,
|
|
get_push_commits_event_message,
|
|
is_branch_name_notifiable,
|
|
)
|
|
from zerver.models import UserProfile
|
|
|
|
|
|
def get_push_commits_body(payload: WildValue) -> str:
|
|
commits_data = [
|
|
{
|
|
"name": commit["author"].tame(check_string),
|
|
"sha": commit["raw_id"].tame(check_string),
|
|
"url": commit["url"].tame(check_string),
|
|
"message": commit["message"].tame(check_string),
|
|
}
|
|
for commit in payload["event"]["push"]["commits"]
|
|
]
|
|
return get_push_commits_event_message(
|
|
get_user_name(payload),
|
|
None,
|
|
get_push_branch_name(payload),
|
|
commits_data,
|
|
)
|
|
|
|
|
|
def get_user_name(payload: WildValue) -> str:
|
|
return payload["event"]["actor"]["username"].tame(check_string)
|
|
|
|
|
|
def get_push_branch_name(payload: WildValue) -> str:
|
|
branches = payload["event"]["push"]["branches"]
|
|
try:
|
|
return branches[0]["name"].tame(check_string)
|
|
# this error happens when the event is a push to delete remote branch, where
|
|
# branches will be an empty list
|
|
except ValidationError:
|
|
return payload["event"]["push"]["commits"][0]["raw_id"].tame(check_string).split("=>")[1]
|
|
|
|
|
|
def get_event_name(payload: WildValue, branches: str | None) -> str | None:
|
|
event_name = payload["event"]["name"].tame(check_string)
|
|
if event_name == "repo-push" and branches is not None:
|
|
branch = get_push_branch_name(payload)
|
|
if not is_branch_name_notifiable(branch, branches):
|
|
return None
|
|
if event_name in EVENT_FUNCTION_MAPPER:
|
|
return event_name
|
|
raise UnsupportedWebhookEventTypeError(event_name)
|
|
|
|
|
|
def get_repository_name(payload: WildValue) -> str:
|
|
return payload["event"]["repo"]["repo_name"].tame(check_string)
|
|
|
|
|
|
def get_topic_based_on_event(payload: WildValue, event: str) -> str:
|
|
if event == "repo-push":
|
|
return TOPIC_WITH_BRANCH_TEMPLATE.format(
|
|
repo=get_repository_name(payload), branch=get_push_branch_name(payload)
|
|
)
|
|
return get_repository_name(payload) # nocoverage
|
|
|
|
|
|
EVENT_FUNCTION_MAPPER: dict[str, Callable[[WildValue], str]] = {
|
|
"repo-push": get_push_commits_body,
|
|
}
|
|
|
|
ALL_EVENT_TYPES = list(EVENT_FUNCTION_MAPPER.keys())
|
|
|
|
|
|
@webhook_view("RhodeCode", all_event_types=ALL_EVENT_TYPES)
|
|
@typed_endpoint
|
|
def api_rhodecode_webhook(
|
|
request: HttpRequest,
|
|
user_profile: UserProfile,
|
|
*,
|
|
payload: JsonBodyPayload[WildValue],
|
|
branches: str | None = None,
|
|
) -> HttpResponse:
|
|
event = get_event_name(payload, branches)
|
|
if event is None:
|
|
return json_success(request)
|
|
|
|
topic_name = get_topic_based_on_event(payload, event)
|
|
|
|
body_function = EVENT_FUNCTION_MAPPER[event]
|
|
body = body_function(payload)
|
|
|
|
check_send_webhook_message(request, user_profile, topic_name, body)
|
|
return json_success(request)
|