Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Automate cleanup of non-responsive PRs (#65930)
Lenacd1255fba14a
diff --git a/.config/typos.toml b/.config/typos.tomlindex 3bb2ec24881..b4e4e4d4bef 100644--- a/.config/typos.toml+++ b/.config/typos.toml@@ -112,6 +112,8 @@ extend-ignore-re = ["GHIzJ",# Intentionally non-matching query in project search tests"NOTHINGmATCHEStHIS",+ # Ordinal suffix for spelled-out dates in script/github-pr-cleanup.py+ '2: "nd"',]check-filename = truediff --git a/.github/workflows/community_pr_cleanup.yml b/.github/workflows/community_pr_cleanup.ymlindex 49290f50b18..d61b65b44e9 100644--- a/.github/workflows/community_pr_cleanup.yml+++ b/.github/workflows/community_pr_cleanup.yml@@ -1,5 +1,8 @@-# Warn and close pull requests that remain in draft without new commits, and-# close unsigned community pull requests that have not engaged about CLA trouble.+# Keep the community pull request queue actionable by closing some PRs:+# - unsigned PRs: retry the CLA check, close if it fails and the author hasn't engaged+# - PRs that remain in draft without new commits: ping, then close+# - PRs whose author didn't respond to changes requested by staff: ping, then close+# - PRs labeled "no self-review" that keep the README notice: ping, then closename: Community PR Cleanup@@ -36,6 +39,7 @@ jobs:owner: zed-industriesrepositories: zedpermission-issues: write+ permission-members: readpermission-pull-requests: write- name: Checkout repository@@ -43,6 +47,7 @@ jobs:with:sparse-checkout: |script/github-pr-cleanup.py+ script/github_helpers.pysparse-checkout-cone-mode: false- name: Set up Pythondiff --git a/script/github-pr-cleanup.py b/script/github-pr-cleanup.pyindex d0d1e478bed..7551ec61c9d 100644--- a/script/github-pr-cleanup.py+++ b/script/github-pr-cleanup.py@@ -2,35 +2,70 @@"""Clean up the community pull request queue:- retry CLA check and close PRs if that didn't help- - close stale draft PRs+ - close stale draft PRs (including staff's)+ - close stale PRs with changes requested+ - close PRs labeled "no self-review" that keep the README noticeRequires: requests"""import argparse-import os-import time+from collections import Counterfrom datetime import datetime, timedelta, timezonefrom functools import cache+from itertools import chain-import requests+from github_helpers import (+ github_graphql,+ github_rest_api,+ is_community_pull_request,+ is_staff_member,+ post_github_comment,+)-GITHUB_API_URL = "https://api.github.com"REPO_OWNER = "zed-industries"REPO_NAME = "zed"+COMMUNITY_BOT_LOGIN = "zed-community-bot"CLA_SIGNED_LABEL = "cla-signed"+NEVER_STALE_LABEL = "never stale"+NO_SELF_REVIEW_LABEL = "no self-review"+# Must match SELF_REVIEW_MARKER in script/danger/dangerfile.ts.+SELF_REVIEW_MARKER = "Remove this line to confirm you've reviewed this PR before submitting."-DRAFT_WARNING_AFTER = timedelta(days=21)-DRAFT_CLOSE_AFTER_WARNING = timedelta(days=7)CLA_RETRY_AFTER = timedelta(days=7)CLA_CLOSE_AFTER_RETRY = timedelta(days=1)+DRAFT_PING_AFTER = timedelta(days=21)+DRAFT_CLOSE_AFTER_PING = timedelta(days=7)+CHANGES_REQUESTED_PING_AFTER = timedelta(days=14)+CHANGES_REQUESTED_CLOSE_AFTER_PING = timedelta(days=7)+CHANGES_REQUESTED_CLOSE_AFTER_ACK = timedelta(days=14)+NO_SELF_REVIEW_PING_AFTER = timedelta(days=1)+NO_SELF_REVIEW_CLOSE_AFTER_PING = timedelta(days=3)-DRAFT_WARNING_MARKER = "<!-- zed-community-automation:stale-draft-warning -->"-DRAFT_CLOSE_MARKER = "<!-- zed-community-automation:close-reason=stale_draft -->"CLA_CLOSE_MARKER = "<!-- zed-community-automation:close-reason=CLA-not-signed -->"-COMMUNITY_BOT_LOGIN = "zed-community-bot[bot]"+# Pings posted before the rename carry the old name, so the marker keeps it.+DRAFT_PING_MARKER = "<!-- zed-community-automation:stale-draft-warning -->"+DRAFT_CLOSE_MARKER = "<!-- zed-community-automation:close-reason=stale_draft -->"+CHANGES_REQUESTED_PING_MARKER = "<!-- zed-community-automation:changes-requested-ping -->"+CHANGES_REQUESTED_ACK_MARKER = "<!-- zed-community-automation:changes-requested-ack -->"+CHANGES_REQUESTED_CLOSE_MARKER = "<!-- zed-community-automation:close-reason=changes-requested-inactive -->"+NO_SELF_REVIEW_PING_MARKER = "<!-- zed-community-automation:no-self-review-ping -->"+NO_SELF_REVIEW_CLOSE_MARKER = "<!-- zed-community-automation:close-reason=no-self-review -->"++CLA_RETRY_COMMENT = "@cla-bot check"++CLA_CLOSE_COMMENT = f"""{CLA_CLOSE_MARKER}++Closing this pull request because Zed's contribution requirements have not been+met: the Contributor License Agreement is unsigned after seven days and a+final automated re-check.++We need a signed CLA before we can review or merge a contribution. If you would like+to continue, please sign the CLA at https://zed.dev/cla and open a new pull request.+If the CLA bot does not recognize your completed signature, mention that in the+new pull request so a maintainer can help."""-DRAFT_WARNING_COMMENT = f"""{DRAFT_WARNING_MARKER}+DRAFT_PING_COMMENT = f"""{DRAFT_PING_MARKER}This pull request has remained in draft without new commits for three weeks.If it remains a draft without new commits for another week, it will be closed@@ -45,79 +80,71 @@ We close long-running drafts to keep the pull request queue focused on actionabland to avoid accumulating conflicts with `main`. If you want to continue this work,please open a new pull request when it is ready for review."""-CLA_RETRY_COMMENT = "@cla-bot check"+CHANGES_REQUESTED_PING_COMMENT = f"""{CHANGES_REQUESTED_PING_MARKER}-CLA_CLOSE_COMMENT = f"""{CLA_CLOSE_MARKER}+Changes were requested on this pull request, and there have been no new commits or comments from you in the last two weeks.-Closing this pull request because Zed's contribution requirements have not been-met: the Contributor License Agreement is unsigned after seven days and a-final automated re-check.+If there's no response by the {{closing_date}}, this pull request will be closed automatically. That's to keep the review queue focused, and you're welcome to come back to this work later by opening a new pull request.-We need a signed CLA before we can review or merge a contribution. If you would like-to continue, please sign the CLA at https://zed.dev/cla and open a new pull request.-If the CLA bot does not recognize your completed signature, mention that in the-new pull request so a maintainer can help."""+To keep this pull request open, do one of the following:+- If you've addressed the feedback, push your commits and **re-request review** using the 🔄 button next to the reviewer's name.+- If you think no changes are needed, explain why in a comment if you haven't already, and **re-request review**.+- If you need more time, leave a comment. That postpones the closure by two weeks.-RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}-MAX_RETRIES = 3-RETRY_DELAY_SECONDS = 5+Replying alone doesn't notify the reviewer that the pull request is ready for another look."""-GITHUB_HEADERS = {}+CHANGES_REQUESTED_ACK_COMMENT = f"""{CHANGES_REQUESTED_ACK_MARKER}+The automatic closure has been postponed because of your comment.-def parse_datetime(value):- return datetime.fromisoformat(value.replace("Z", "+00:00"))+If there are no new commits by the {{closing_date}}, this pull request will be closed automatically.+To keep this pull request open, do one of the following:+- Push commits that address the feedback, then **re-request review** using the 🔄 button next to the reviewer's name.+- If you think no changes are needed, explain why in a comment and **re-request review** so the reviewer can take another look."""-def github_graphql(query, variables):- for attempt in range(MAX_RETRIES + 1):- response = requests.post(- f"{GITHUB_API_URL}/graphql",- headers=GITHUB_HEADERS,- json={"query": query, "variables": variables},- timeout=30,- )- if response.status_code in RETRYABLE_STATUS_CODES and attempt < MAX_RETRIES:- time.sleep(RETRY_DELAY_SECONDS)- continue- response.raise_for_status()- result = response.json()- if "errors" in result:- raise RuntimeError(f"GraphQL error: {result['errors']}")- return result["data"]- raise RuntimeError("github_graphql: retry loop exited without return")---def github_rest_request(method, path, body=None):- for attempt in range(MAX_RETRIES + 1):- response = requests.request(- method, f"{GITHUB_API_URL}/{path}", headers=GITHUB_HEADERS, json=body, timeout=30)- if response.status_code in RETRYABLE_STATUS_CODES and attempt < MAX_RETRIES:- time.sleep(RETRY_DELAY_SECONDS)- continue- response.raise_for_status()- if response.status_code == 204 or not response.content:- return None- return response.json()- raise RuntimeError("github_rest_request: retry loop exited without return")+CHANGES_REQUESTED_CLOSE_COMMENT = f"""{CHANGES_REQUESTED_CLOSE_MARKER}+Closing this pull request because no new commits were pushed by the deadline in this bot's comment above.-def github_rest_get_paginated(path):- results = []- page = 1- while True:- separator = "&" if "?" in path else "?"- batch = github_rest_request("GET", f"{path}{separator}per_page=100&page={page}")- if not batch:- return results- results.extend(batch)- if len(batch) < 100:- return results- page += 1+Inactive pull requests are closed to keep the review queue focused. This pull request can't be reopened. To continue this work, open a new pull request with the requested changes and link to this one so reviewers can see the earlier discussion."""++NO_SELF_REVIEW_PING_COMMENT = f"""{NO_SELF_REVIEW_PING_MARKER}++This pull request will be closed automatically on the {{closing_date}} because it has a notice at the top of `README.md` that asks to be removed before submitting to confirm that you've reviewed the changes yourself.++To keep this pull request open, do both of the following:+- Remove the two-line `> [!IMPORTANT]` notice from the top of `README.md` and push the change.+- Leave a comment describing how you, the human, tested your changes manually: what you did, what happened, which platforms you tested on. Screenshots/videos are especially helpful."""++NO_SELF_REVIEW_CLOSE_COMMENT = f"""{NO_SELF_REVIEW_CLOSE_MARKER}++Closing this pull request because the notice in `README.md` wasn't removed, or no comment was posted by the author, by the deadline in this bot's comment above.++This pull request can't be reopened. To continue this work, review and test your changes, then open a new pull request without the notice in `README.md` and with a description of how you tested them."""++SUMMARY_FRAGMENT = """+fragment Summary on PullRequest {+ number+ isDraft+ createdAt+ author { login }+ labels(first: 100) { nodes { name } }+ reviews(last: 50, states: [APPROVED, CHANGES_REQUESTED, DISMISSED]) {+ nodes { state submittedAt author { login } }+ }+ latestCommit: commits(last: 1) { nodes { commit { committedDate } } }+ convertedToDraft: timelineItems(+ last: 1, itemTypes: [CONVERT_TO_DRAFT_EVENT]+ ) {+ nodes { ... on ConvertToDraftEvent { createdAt } }+ }+}+"""def fetch_open_pull_requests():- pull_requests = []+ summaries = []cursor = Nonewhile True:data = github_graphql(@@ -126,266 +153,412 @@ def fetch_open_pull_requests():repository(owner: $owner, name: $repo) {pullRequests(states: OPEN, first: 100, after: $cursor) {pageInfo { hasNextPage endCursor }- nodes {- number- state- isDraft- createdAt- author { __typename login }- labels(first: 100) { nodes { name } }- commits(last: 1) {- nodes {- commit { pushedDate committedDate }- }- }- timelineItems(- last: 20,- itemTypes: [CONVERT_TO_DRAFT_EVENT, READY_FOR_REVIEW_EVENT]- ) {- nodes {- __typename- ... on ConvertToDraftEvent { createdAt }- ... on ReadyForReviewEvent { createdAt }- }- }- }+ nodes { ...Summary }}}}- """,+ """+ + SUMMARY_FRAGMENT,{"owner": REPO_OWNER, "repo": REPO_NAME, "cursor": cursor},)page = data["repository"]["pullRequests"]- pull_requests.extend(page["nodes"])+ summaries += page["nodes"]if not page["pageInfo"]["hasNextPage"]:- return pull_requests+ return summariescursor = page["pageInfo"]["endCursor"]@cache-def fetch_comments(number):- return github_rest_get_paginated(- f"repos/{REPO_OWNER}/{REPO_NAME}/issues/{number}/comments"- )---def post_comment(number, body, dry_run):- if dry_run:- print(f" Would comment on PR #{number}:\n{body}\n")- else:- github_rest_request(- "POST",- f"repos/{REPO_OWNER}/{REPO_NAME}/issues/{number}/comments",- {"body": body},+def fetch_pull_request(number):+ """Fetch the summary plus recent comments, commits, timeline events and+ the README at the head commit.++ Each cleanup rules out what it can from the summary first, so most pull+ requests never need this call.+ """+ data = github_graphql(+ """+ query($owner: String!, $repo: String!, $number: Int!) {+ repository(owner: $owner, name: $repo) {+ pullRequest(number: $number) {+ ...Summary+ comments(last: 100) {+ nodes { createdAt body author { login } }+ }+ commits(last: 100) {+ nodes {+ commit {+ committedDate+ author { user { login } }+ parents { totalCount }+ }+ }+ }+ timelineItems(+ last: 100,+ itemTypes: [+ LABELED_EVENT,+ REOPENED_EVENT,+ READY_FOR_REVIEW_EVENT,+ REVIEW_REQUESTED_EVENT,+ PULL_REQUEST_REVIEW+ ]+ ) {+ nodes {+ __typename+ ... on LabeledEvent { createdAt label { name } }+ ... on ReopenedEvent { createdAt }+ ... on ReadyForReviewEvent { createdAt }+ ... on ReviewRequestedEvent { createdAt }+ ... on PullRequestReview { submittedAt author { login } }+ }+ }+ headCommit: commits(last: 1) {+ nodes {+ commit {+ file(path: "README.md") {+ object { ... on Blob { text } }+ }+ }+ }+ }+ }+ }+ }+ """+ + SUMMARY_FRAGMENT,+ {"owner": REPO_OWNER, "repo": REPO_NAME, "number": number},)---def close_pull_request(number, dry_run):- if dry_run:- print(f" Would close PR #{number}")- else:- github_rest_request(- "PATCH",- f"repos/{REPO_OWNER}/{REPO_NAME}/pulls/{number}",- {"state": "closed"},- )+ return data["repository"]["pullRequest"]def label_names(pull_request):return {- label["name"].lower()- for label in (pull_request.get("labels") or {}).get("nodes", [])+ label["name"].lower() for label in pull_request["labels"]["nodes"]}-def latest_commit_at(pull_request):- commits = (pull_request.get("commits") or {}).get("nodes", [])- if not commits:- return None- commit = commits[-1]["commit"]- timestamp = commit.get("pushedDate") or commit.get("committedDate")- return parse_datetime(timestamp) if timestamp else None+def author_login(node):+ # Deleted accounts show up as a missing author.+ return (node["author"] or {}).get("login")-def current_draft_started_at(pull_request):- if pull_request.get("state") != "OPEN" or not pull_request.get("isDraft"):- return None+def event_times(pull_request, typename):+ return [+ datetime.fromisoformat(item["createdAt"])+ for item in pull_request["timelineItems"]["nodes"]+ if item["__typename"] == typename+ ]- transitions = (pull_request.get("timelineItems") or {}).get("nodes", [])- if not transitions:- return parse_datetime(pull_request["createdAt"])- latest_transition = max(- transitions, key=lambda transition: parse_datetime(transition["createdAt"])- )- if latest_transition["__typename"] != "ConvertToDraftEvent":- return None- return parse_datetime(latest_transition["createdAt"])+def clock_start(pull_request, started_at):+ """Return when a cleanup's clock started: at `started_at`, or at the+ latest reopen if that's later.+ Restarting the clock on reopen also makes the bot ignore its comments from+ before the reopen, so a reopened pull request isn't closed again at once.+ """+ return max([started_at, *event_times(pull_request, "ReopenedEvent")])-def latest_draft_activity_at(pull_request):- draft_started_at = current_draft_started_at(pull_request)- if draft_started_at is None:- return None- commit_at = latest_commit_at(pull_request)- if commit_at is None:- return draft_started_at- return max(draft_started_at, commit_at)+def bot_commented_at(pull_request, text, since):+ """Return when this bot last posted a comment containing `text` after+ `since`."""+ times = (+ datetime.fromisoformat(comment["createdAt"])+ for comment in pull_request["comments"]["nodes"]+ if author_login(comment) == COMMUNITY_BOT_LOGIN+ and text in comment["body"]+ )+ return max((time for time in times if time > since), default=None)+++def author_commented_at(pull_request, since):+ """Return when the author last commented or replied to a review after+ `since`. A bare `@cla-bot check` doesn't count as a response."""+ author = author_login(pull_request)+ comments = (+ datetime.fromisoformat(comment["createdAt"])+ for comment in pull_request["comments"]["nodes"]+ if author_login(comment) == author+ and " ".join(comment["body"].lower().split()) != "@cla-bot check"+ )+ reviews = (+ datetime.fromisoformat(item["submittedAt"])+ for item in pull_request["timelineItems"]["nodes"]+ if item["__typename"] == "PullRequestReview"+ and author_login(item) == author+ )+ return max(+ (time for time in chain(comments, reviews) if time > since),+ default=None,+ )-def latest_marker_comment_at(comments, marker, not_before=None):- latest_timestamp = None- for comment in comments:- if marker not in (comment.get("body") or ""):- continue- timestamp = parse_datetime(comment["created_at"])- if not_before is not None and timestamp < not_before:++def author_pushed_since(pull_request, timestamp):+ """Return whether the author committed after `timestamp`. Merge commits,+ such as merging `main`, don't address feedback, so they don't count;+ neither do commits by others, such as staff or the autofix bot."""+ author = author_login(pull_request)+ for node in pull_request["commits"]["nodes"]:+ commit = node["commit"]+ if commit["parents"]["totalCount"] > 1:continue- if latest_timestamp is None or timestamp > latest_timestamp:- latest_timestamp = timestamp- return latest_timestamp+ user = commit["author"]["user"]+ # A commit email that isn't linked to a GitHub account leaves the+ # commit without a user, and in practice that's the author's own work.+ if (user is None or user["login"] == author) and (+ datetime.fromisoformat(commit["committedDate"]) > timestamp+ ):+ return True+ return False+++def with_closing_date(comment, closes_after, now):+ date = (now + closes_after).date()+ if 11 <= date.day <= 13:+ suffix = "th"+ else:+ suffix = {1: "st", 2: "nd", 3: "rd"}.get(date.day % 10, "th")+ return comment.format(closing_date=f"{date.day}{suffix} of {date:%B %Y}")-def find_stale_drafts(pull_requests, now):- stale_drafts = []- for pull_request in pull_requests:- activity_at = latest_draft_activity_at(pull_request)- if activity_at is not None and now - activity_at >= DRAFT_WARNING_AFTER:- stale_drafts.append((pull_request, activity_at))- return stale_drafts+def closing_date_reached(notice_at, closes_after, now):+ # Compare dates rather than durations so the pull request closes on the+ # date the comment promised, even if today's run starts a little earlier.+ return now.date() >= (notice_at + closes_after).date()+++def cla_action(summary, now):+ created_at = datetime.fromisoformat(summary["createdAt"])+ labels = label_names(summary)+ if (+ not is_community_pull_request(labels)+ or CLA_SIGNED_LABEL in labels+ or now - created_at < CLA_RETRY_AFTER+ ):+ return None+ pull_request = fetch_pull_request(summary["number"])+ since = clock_start(pull_request, created_at)+ if bot_commented_at(pull_request, CLA_CLOSE_MARKER, since):+ return "close", None+ if now - since < CLA_RETRY_AFTER:+ return None+ if author_commented_at(pull_request, since):+ return None+ retried_at = bot_commented_at(pull_request, CLA_RETRY_COMMENT, since)+ if retried_at is None:+ return "retry CLA check", CLA_RETRY_COMMENT+ if now - retried_at >= CLA_CLOSE_AFTER_RETRY:+ return "close", CLA_CLOSE_COMMENT+ return None-def draft_action(activity_at, comments, now):- # A previous run may have posted the explanation but failed to close the PR.- if latest_marker_comment_at(comments, DRAFT_CLOSE_MARKER, activity_at):- return None, True- warning_at = latest_marker_comment_at(- comments, DRAFT_WARNING_MARKER, activity_at+def draft_action(summary, now):+ if not summary["isDraft"]:+ return None+ conversions = summary["convertedToDraft"]["nodes"]+ # A pull request opened as a draft has no conversion event.+ drafted_at = (conversions[-1] if conversions else summary)["createdAt"]+ commit = summary["latestCommit"]["nodes"][-1]["commit"]+ active_at = max(+ datetime.fromisoformat(drafted_at),+ datetime.fromisoformat(commit["committedDate"]),)- if warning_at is not None:- if now - warning_at >= DRAFT_CLOSE_AFTER_WARNING:- return DRAFT_CLOSE_COMMENT, True+ if now - active_at < DRAFT_PING_AFTER:return None- return DRAFT_WARNING_COMMENT, False+ pull_request = fetch_pull_request(summary["number"])+ since = clock_start(pull_request, active_at)+ if bot_commented_at(pull_request, DRAFT_CLOSE_MARKER, since):+ return "close", None+ if now - since < DRAFT_PING_AFTER:+ return None+ pinged_at = bot_commented_at(pull_request, DRAFT_PING_MARKER, since)+ if pinged_at is None:+ return "ping", DRAFT_PING_COMMENT+ if now - pinged_at >= DRAFT_CLOSE_AFTER_PING:+ return "close", DRAFT_CLOSE_COMMENT+ return None+++def staff_change_request_at(summary):+ """Return when staff requested changes, if that's still the latest staff+ verdict on the pull request."""+ reviews = summary["reviews"]["nodes"]+ # Most pull requests have no change request at all, and ruling them out+ # first saves the staff membership lookups below.+ if not any(review["state"] == "CHANGES_REQUESTED" for review in reviews):+ return None+ for review in reversed(reviews):+ reviewer = author_login(review)+ if reviewer and is_staff_member(reviewer):+ if review["state"] != "CHANGES_REQUESTED":+ return None+ return datetime.fromisoformat(review["submittedAt"])+ return None+++def changes_requested_action(summary, now):+ community = is_community_pull_request(label_names(summary))+ if summary["isDraft"] or not community:+ return None+ requested_at = staff_change_request_at(summary)+ if (+ requested_at is None+ or now - requested_at < CHANGES_REQUESTED_PING_AFTER+ ):+ return None-def is_bare_cla_check(comment_body):- return " ".join((comment_body or "").lower().split()) == "@cla-bot check"+ pull_request = fetch_pull_request(summary["number"])+ review_requested = any(+ time > requested_at+ for time in event_times(pull_request, "ReviewRequestedEvent")+ )+ if review_requested or author_pushed_since(pull_request, requested_at):+ return None+ since = clock_start(pull_request, requested_at)+ if bot_commented_at(pull_request, CHANGES_REQUESTED_CLOSE_MARKER, since):+ return "close", None+ commented_at = author_commented_at(pull_request, since)+ pinged_at = bot_commented_at(+ pull_request, CHANGES_REQUESTED_PING_MARKER, since+ )+ if pinged_at is None:+ # Before the ping, an author comment restarts the clock silently.+ if now - (commented_at or since) < CHANGES_REQUESTED_PING_AFTER:+ return None+ return "ping", with_closing_date(+ CHANGES_REQUESTED_PING_COMMENT,+ CHANGES_REQUESTED_CLOSE_AFTER_PING,+ now,+ )-def author_has_comment_other_than_cla_check(comments, author):- return any(- (comment.get("user") or {}).get("login", "").lower() == author.lower()- and not is_bare_cla_check(comment.get("body"))- for comment in comments+ acknowledged_at = bot_commented_at(+ pull_request, CHANGES_REQUESTED_ACK_MARKER, since)+ if acknowledged_at:+ notice_at = acknowledged_at+ closes_after = CHANGES_REQUESTED_CLOSE_AFTER_ACK+ else:+ notice_at = pinged_at+ closes_after = CHANGES_REQUESTED_CLOSE_AFTER_PING+ if commented_at and commented_at > notice_at:+ return "acknowledge", with_closing_date(+ CHANGES_REQUESTED_ACK_COMMENT,+ CHANGES_REQUESTED_CLOSE_AFTER_ACK,+ now,+ )+ if closing_date_reached(notice_at, closes_after, now):+ return "close", CHANGES_REQUESTED_CLOSE_COMMENT+ return None-def latest_cla_retry_at(comments):- return max(+def no_self_review_action(summary, now):+ labels = label_names(summary)+ # Drafts are left alone, since authors may still be cleaning them up.+ if summary["isDraft"] or not (+ NO_SELF_REVIEW_LABEL in labels and is_community_pull_request(labels)+ ):+ return None++ pull_request = fetch_pull_request(summary["number"])+ labeled_at = max((- parse_datetime(comment["created_at"])- for comment in comments- if (comment.get("user") or {}).get("login", "").lower()- == COMMUNITY_BOT_LOGIN- and is_bare_cla_check(comment.get("body"))+ datetime.fromisoformat(item["createdAt"])+ for item in pull_request["timelineItems"]["nodes"]+ if item["__typename"] == "LabeledEvent"+ and item["label"]["name"].lower() == NO_SELF_REVIEW_LABEL),- default=None,+ # On a busy pull request the label event can be older than the+ # fetched timeline, and zed-zippy adds the label right at opening.+ default=datetime.fromisoformat(pull_request["createdAt"]),)+ # A draft labeled long ago gets the full 24 hours once it's ready.+ started_at = max(+ [labeled_at, *event_times(pull_request, "ReadyForReviewEvent")]+ )+ since = clock_start(pull_request, started_at)+ if bot_commented_at(pull_request, NO_SELF_REVIEW_CLOSE_MARKER, since):+ return "close", None--def cla_action(author, comments, now):- if author_has_comment_other_than_cla_check(comments, author):+ readme = pull_request["headCommit"]["nodes"][0]["commit"]["file"]+ notice_present = (+ readme is not None and SELF_REVIEW_MARKER in readme["object"]["text"]+ )+ pinged_at = bot_commented_at(+ pull_request, NO_SELF_REVIEW_PING_MARKER, since+ )+ if pinged_at is None:+ if notice_present and now - since >= NO_SELF_REVIEW_PING_AFTER:+ return "ping", with_closing_date(+ NO_SELF_REVIEW_PING_COMMENT,+ NO_SELF_REVIEW_CLOSE_AFTER_PING,+ now,+ )return None-- retry_at = latest_cla_retry_at(comments)- if retry_at is None:- return CLA_RETRY_COMMENT, False- if now - retry_at < CLA_CLOSE_AFTER_RETRY:+ if not closing_date_reached(+ pinged_at, NO_SELF_REVIEW_CLOSE_AFTER_PING, now+ ):return None- # A previous run may have posted the explanation but failed to close the PR.- if latest_marker_comment_at(comments, CLA_CLOSE_MARKER) is not None:- return None, True- return CLA_CLOSE_COMMENT, True---def needs_cla_follow_up(pull_request, now):- author = pull_request.get("author") or {}- return (- now - parse_datetime(pull_request["createdAt"]) >= CLA_RETRY_AFTER- and author.get("__typename") == "User"- and bool(author.get("login"))- and CLA_SIGNED_LABEL not in label_names(pull_request)- )+ if notice_present or author_commented_at(pull_request, pinged_at) is None:+ return "close", NO_SELF_REVIEW_CLOSE_COMMENT+ return None-def retry_or_close_unsigned_pull_requests(pull_requests, now, dry_run):- closed = 0- for pull_request in pull_requests:- number = pull_request["number"]- comments = fetch_comments(number)- action = cla_action(pull_request["author"]["login"], comments, now)- if action is None:- continue- comment, should_close = action- if should_close:- print(f"PR #{number}: closing because the CLA is unsigned")- if comment is not None:- post_comment(number, comment, dry_run)- close_pull_request(number, dry_run)- closed += 1- else:- print(f"PR #{number}: asking the CLA bot to check again")- post_comment(number, comment, dry_run)- return closed---def warn_or_close_stale_draft_pull_requests(stale_drafts, now, dry_run):- warned = closed = 0- for pull_request, activity_at in stale_drafts:- number = pull_request["number"]- comments = fetch_comments(number)- action = draft_action(activity_at, comments, now)- if action is None:- continue- comment, should_close = action- if should_close:- print(f"PR #{number}: closing a stale draft")- if comment is not None:- post_comment(number, comment, dry_run)- close_pull_request(number, dry_run)- closed += 1- else:- print(f"PR #{number}: warning about a stale draft")- post_comment(number, comment, dry_run)- warned += 1- return warned, closed+CLEANUPS = (+ ("CLA", cla_action),+ ("stale draft", draft_action),+ ("changes requested", changes_requested_action),+ ("no self-review", no_self_review_action),+)+++def take_step(number, kind, comment, dry_run):+ if dry_run:+ if comment:+ print(f" Would comment:\n{comment}\n")+ if kind == "close":+ print(" Would close")+ return+ if comment:+ post_github_comment(REPO_OWNER, REPO_NAME, number, comment)+ if kind == "close":+ github_rest_api(+ "PATCH",+ f"repos/{REPO_OWNER}/{REPO_NAME}/pulls/{number}",+ body={"state": "closed"},+ )def run(now, dry_run):- pull_requests = fetch_open_pull_requests()- print(f"Checking {len(pull_requests)} open pull requests")+ summaries = [+ summary+ for summary in fetch_open_pull_requests()+ if NEVER_STALE_LABEL not in label_names(summary)+ ]+ print(f"Checking {len(summaries)} open pull requests")if dry_run:print("Dry-run mode: no comments or closures will be made")- unsigned_pull_requests_closed = retry_or_close_unsigned_pull_requests(- [- pull_request- for pull_request in pull_requests- if needs_cla_follow_up(pull_request, now)- ],- now,- dry_run,- )- draft_warned, draft_closed = warn_or_close_stale_draft_pull_requests(- find_stale_drafts(pull_requests, now), now, dry_run- )+ steps_taken = Counter()+ for summary in summaries:+ for cleanup, action in CLEANUPS:+ step = action(summary, now)+ if step is None:+ continue+ kind, comment = step+ print(f"PR #{summary['number']}: {cleanup}: {kind}")+ take_step(summary["number"], kind, comment, dry_run)+ steps_taken[f"{cleanup}: {kind}"] += 1+ if kind == "close":+ breakprint(- "Cleanup complete: "- f"{unsigned_pull_requests_closed} unsigned PR closures, "- f"{draft_warned} draft warnings, "- f"{draft_closed} draft closures"+ "Cleanup complete:",+ ", ".join(f"{step} ×{count}" for step, count in steps_taken.items())+ or "nothing to do",)@@ -394,13 +567,7 @@ if __name__ == "__main__":argument_parser.add_argument("--dry-run",action="store_true",- help="Report actions without posting comments or closing pull requests",+ help="Report actions without commenting on or closing pull requests",)arguments = argument_parser.parse_args()-- GITHUB_HEADERS = {- "Authorization": f"Bearer {os.environ['GITHUB_TOKEN']}",- "Accept": "application/vnd.github+json",- "X-GitHub-Api-Version": "2022-11-28",- }run(datetime.now(timezone.utc), arguments.dry_run)diff --git a/script/github_helpers.py b/script/github_helpers.pyindex b49357dd417..166ded78159 100644--- a/script/github_helpers.py+++ b/script/github_helpers.py@@ -1,6 +1,7 @@import osimport sysimport time+from functools import cacheimport requests@@ -8,6 +9,7 @@ GITHUB_API_URL = "https://api.github.com"RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}MAX_ATTEMPTS = 4REQUEST_TIMEOUT_SECONDS = 30+NON_COMMUNITY_LABELS = {"staff", "bot"}def _github_headers():@@ -107,6 +109,24 @@ def post_github_comment(owner, repository, issue_number, body):)+@cache+def is_staff_member(login):+ try:+ membership = github_rest_api(+ "GET", f"orgs/zed-industries/teams/staff/memberships/{login}"+ )+ except requests.HTTPError as error:+ if error.response.status_code == 404:+ return False+ raise+ return membership["state"] == "active"+++def is_community_pull_request(label_names):+ # The PR Issue Labeler workflow labels pull requests by staff and bots.+ return not NON_COMMUNITY_LABELS & {name.lower() for name in label_names}++def github_graphql(query, variables=None, *, partial_errors_ok=False):# GraphQL uses POST for reads and writes, so classify the operation before retrying.retry = not query.lstrip().startswith("mutation")