Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

webhooks/github: Combine the two review request handlers.

Niloth P13dcbb5ab22d
diff --git a/zerver/webhooks/github/tests.py b/zerver/webhooks/github/tests.py
index 90c563f0e2d..51ea478eced 100644
--- a/zerver/webhooks/github/tests.py
+++ b/zerver/webhooks/github/tests.py
@@ -546,11 +546,33 @@ class GitHubWebhookTest(WebhookTestCase):
)
def test_pull_request_review_request_removed_msg(self) -> None:
- expected_message = "soheil-star01 unassigned redolat from [PR #1 Feat/webhook](https://github.com/techpillars-oy/test1/pull/1)."
+ expected_message = "soheil-star01 unassigned [redolat](https://github.com/redolat) from [PR #1](https://github.com/techpillars-oy/test1/pull/1)."
self.check_webhook(
"pull_request__review_request_removed", "test1 / PR #1 Feat/webhook", expected_message
)
+ def test_pull_request_review_request_removed_with_custom_topic_in_url(self) -> None:
+ self.url = self.build_webhook_url(topic="notifications")
+ expected_message = "soheil-star01 unassigned [redolat](https://github.com/redolat) from [PR #1 Feat/webhook](https://github.com/techpillars-oy/test1/pull/1)."
+ self.check_webhook(
+ "pull_request__review_request_removed", "notifications", expected_message
+ )
+
+ def test_pull_request_review_request_removed_team_reviewer_msg(self) -> None:
+ payload = orjson.loads(self.get_body("pull_request__review_request_removed"))
+ del payload["requested_reviewer"]
+ payload["requested_team"] = orjson.loads(
+ self.get_body("pull_request__review_requested_team_reviewer")
+ )["requested_team"]
+
+ expected_message = "soheil-star01 unassigned [authority](https://github.com/orgs/test-org965/teams/authority) from [PR #1](https://github.com/techpillars-oy/test1/pull/1)."
+ self.check_webhook(
+ "pull_request__review_request_removed",
+ "test1 / PR #1 Feat/webhook",
+ expected_message,
+ custom_payload=payload,
+ )
+
def test_pull_request_milestoned_msg(self) -> None:
expected_message = "soheil-star01 linked [PR #1](https://github.com/soheil-star01/soheil-star01/pull/1) to the milestone `new_ms`."
self.check_webhook(
diff --git a/zerver/webhooks/github/view.py b/zerver/webhooks/github/view.py
index e9df4cbcbe5..e7df1e40005 100644
--- a/zerver/webhooks/github/view.py
+++ b/zerver/webhooks/github/view.py
@@ -723,16 +723,21 @@ def get_requested_reviewer_link(payload: WildValue) -> str:
return f"[{reviewer_name}]({reviewer['html_url'].tame(check_string)})"
-def get_pull_request_review_request_removed_body(helper: Helper) -> str:
+def get_pull_request_review_requested_or_removed_body(helper: Helper) -> str:
payload = helper.payload
-
sender = get_sender_name(helper)
- reviewer = payload["requested_reviewer"]["login"].tame(check_string)
+ reviewer_link = get_requested_reviewer_link(payload)
pr_number = payload["pull_request"]["number"].tame(check_int)
- title = payload["pull_request"]["title"].tame(check_string)
+ pr_title = payload["pull_request"]["title"].tame(check_string)
pr_url = payload["pull_request"]["html_url"].tame(check_string)
+ pr_reference = f"PR #{pr_number} {pr_title}" if helper.include_title else f"PR #{pr_number}"
+ review_request_change = (
+ f"requested {reviewer_link} for a review on"
+ if payload["action"].tame(check_string) == "review_requested"
+ else f"unassigned {reviewer_link} from"
+ )
- return f"{sender} unassigned {reviewer} from [PR #{pr_number} {title}]({pr_url})."
+ return f"{sender} {review_request_change} [{pr_reference}]({pr_url})."
def get_pull_request_converted_to_draft_body(helper: Helper) -> str:
@@ -817,28 +822,6 @@ def get_pull_request_review_comment_body(helper: Helper) -> str:
)
-def get_pull_request_review_requested_body(helper: Helper) -> str:
- payload = helper.payload
- include_title = helper.include_title
-
- sender = get_sender_name(helper)
- pr_number = payload["pull_request"]["number"].tame(check_int)
- pr_url = payload["pull_request"]["html_url"].tame(check_string)
- message = "{sender} requested {reviewers} for a review on [PR #{pr_number}]({pr_url})."
- message_with_title = (
- "{sender} requested {reviewers} for a review on [PR #{pr_number} {title}]({pr_url})."
- )
- body = message_with_title if include_title else message
-
- return body.format(
- sender=sender,
- reviewers=get_requested_reviewer_link(payload),
- pr_number=pr_number,
- pr_url=pr_url,
- title=payload["pull_request"]["title"].tame(check_string) if include_title else None,
- )
-
-
def get_check_run_body(helper: Helper) -> str:
payload = helper.payload
template = """
@@ -1131,12 +1114,12 @@ EVENT_FUNCTION_MAPPER: dict[str, Callable[[Helper], str]] = {
"pull_request_ready_for_review": get_pull_request_ready_for_review_body,
"pull_request_review": get_pull_request_review_body,
"pull_request_review_comment": get_pull_request_review_comment_body,
- "pull_request_review_requested": get_pull_request_review_requested_body,
+ "pull_request_review_requested": get_pull_request_review_requested_or_removed_body,
"pull_request_milestoned_or_demilestoned": get_pull_request_milestoned_or_demilestoned_body,
"pull_request_enqueued_or_dequeued": get_pull_request_enqueued_or_dequeued_body,
"pull_request_labeled_or_unlabeled": get_pull_request_labeled_or_unlabeled_body,
"pull_request_converted_to_draft": get_pull_request_converted_to_draft_body,
- "pull_request_review_request_removed": get_pull_request_review_request_removed_body,
+ "pull_request_review_request_removed": get_pull_request_review_requested_or_removed_body,
"pull_request_auto_merge": get_pull_request_auto_merge_body,
"locked_or_unlocked_pull_request": get_locked_or_unlocked_pull_request_body,
"push_commits": get_push_commits_body,