.github/time/housekeeping.py

@@ -0,0 +1,265 @@
+"""Housekeeping: the daily sweep. Deterministic on purpose: no model decides what to delete or close. stdlib only.
+
+    python3 .github/time/housekeeping.py      # daily (housekeeping.yml), or by hand
+
+Four steps, each idempotent (a second run finds nothing to do) and each logged:
+  1. branches   delete every branch whose PR merged into the default branch. Never the default branch, `gh-pages`, a
+                protected branch, a branch with an open PR, or a branch that has commits newer than its merge.
+  2. signals    close `signal` issues whose venture's measuring window (TIME_VENTURE_MEASURE_DAYS, default 7) has passed
+                with no signups (no 👍 on the issue, no early-access issue for the venture), with one closing line.
+  3. milestones close milestones with no open issues and at least one closed one.
+  4. stale      list, never act: `needs-human` untouched for 3 days, open PRs idle 7 days, cards parked after their
+                automatic retries, cards whose last beat is `error` for 2 days. One comment on the Astra log; none if empty.
+Then one summary line on the Astra log. Only TIME_MODE=live changes anything; anything else (the default) prints what it
+would do and writes nothing, comments included. A step that fails is logged and the others still run (exit code 1).
+"""
+from __future__ import annotations
+
+import datetime as dt
+import importlib.util
+import os
+import re
+import sys
+import urllib.parse
+from pathlib import Path
+
+HERE = Path(__file__).resolve().parent
+_spec = importlib.util.spec_from_file_location("tm", HERE / "time.py")
+tm = importlib.util.module_from_spec(_spec)
+_spec.loader.exec_module(tm)
+
+NEVER = {"gh-pages"}          # besides the default branch and protected ones
+LOG_TITLE = "Astra log"
+LOG_FALLBACK = 57             # the Astra log's number here, if it cannot be found by title
+NEEDS_HUMAN_DAYS, PR_IDLE_DAYS, ERROR_DAYS = 3, 7, 2
+
+
+def log(msg: str) -> None:
+    print(msg, flush=True)
+
+
+def repo() -> str:
+    return f"/repos/{tm.REPO}"
+
+
+def paged(path: str, pages: int = 40) -> list[dict]:
+    sep = "&" if "?" in path else "?"
+    out: list[dict] = []
+    for page in range(1, pages + 1):
+        batch = tm.gh("GET", f"{path}{sep}limit=50&page={page}")
+        out += batch
+        if len(batch) < 50:
+            break
+    return out
+
+
+def parse(ts: str | None) -> dt.datetime | None:
+    if not ts:
+        return None
+    try:
+        d = dt.datetime.fromisoformat(ts.replace("Z", "+00:00"))
+    except ValueError:
+        return None
+    return d if d.tzinfo else d.replace(tzinfo=dt.timezone.utc)
+
+
+def age_days(ts: str | None, now: dt.datetime) -> float:
+    d = parse(ts)
+    return (now - d).total_seconds() / 86400 if d else 0.0
+
+
+def same_repo(pr: dict) -> bool:
+    return ((pr.get("head") or {}).get("repo") or {}).get("full_name", tm.REPO) == tm.REPO  # a fork's branch is not ours
+
+
+# ---------- 1. branches ----------
+
+def step_branches(live: bool) -> int:
+    default = tm.default_branch()
+    open_heads = {p["head"]["ref"] for p in paged(f"{repo()}/pulls?state=open") if same_repo(p)}
+    merged: dict[str, dt.datetime | None] = {}   # head ref -> when its latest merged PR merged
+    for p in paged(f"{repo()}/pulls?state=closed&sort=recentupdate"):
+        if (p.get("merged") or p.get("merged_at")) and (p.get("base") or {}).get("ref") == default and same_repo(p):
+            at = parse(p.get("merged_at"))
+            ref = p["head"]["ref"]
+            merged[ref] = max([d for d in (merged.get(ref), at) if d], default=None)
+    deleted = 0
+    for b in paged(f"{repo()}/branches"):
+        name = b["name"]
+        if name == default or name in NEVER or b.get("protected") or name not in merged:
+            continue
+        if name in open_heads:
+            log(f"branches: keep {name} (open PR)")
+            continue
+        tip = parse((b.get("commit") or {}).get("timestamp"))
+        if tip and merged[name] and tip > merged[name]:
+            log(f"branches: keep {name} (commits after its merge)")
+            continue
+        if not live:
+            log(f"branches: would delete {name}")
+            continue
+        try:
+            tm.gh("DELETE", f"{repo()}/branches/{urllib.parse.quote(name, safe='')}")
+        except RuntimeError as e:
+            if "-> 404" not in str(e):   # already gone is fine
+                raise
+            continue
+        log(f"branches: deleted {name}")
+        deleted += 1
+    return deleted
+
+
+# ---------- 2. signal issues ----------
+
+def person(user: dict | None) -> str | None:
+    login = ((user or {}).get("login") or "").lower()
+    if not login or (user or {}).get("type") == "Bot" or login in (tm.REPO.split("/")[0].lower(), tm.TIME_USER.lower(), tm.TIME_BOT.lower()):
+        return None
+    return login
+
+
+def signup_people() -> dict[str, set[str]]:
+    """venture slug -> distinct people who opened an early-access issue for it."""
+    out: dict[str, set[str]] = {}
+    for i in paged(f"{repo()}/issues?state=all&labels=signup&type=issues"):
+        m = re.search(r"^###\s*Venture\s*$\n+(.*?)(?=^###\s|\Z)", i.get("body") or "", re.M | re.S)
+        who = person(i.get("user"))
+        if m and who and m.group(1).strip():
+            out.setdefault(m.group(1).strip().lower(), set()).add(who)
+    return out
+
+
+def step_signals(live: bool, now: dt.datetime) -> int:
+    days = int(float(os.environ.get("TIME_VENTURE_MEASURE_DAYS") or 7))
+    due = [i for i in paged(f"{repo()}/issues?state=open&labels=signal&type=issues")
+           if not i.get("pull_request") and age_days(i.get("created_at"), now) >= days]
+    if not due:
+        return 0
+    signups = signup_people()
+    closed = 0
+    for i in due:
+        n = i["number"]
+        m = re.search(r"[?&]venture=([\w.-]+)", i.get("body") or "")
+        if not m:
+            log(f"signals: keep #{n} (cannot tell which venture it belongs to)")
+            continue
+        people = set(signups.get(m.group(1).lower(), set()))
+        people |= {w for r in paged(f"{repo()}/issues/{n}/reactions") if r.get("content") in ("+1", "👍")
+                   and (w := person(r.get("user")))}
+        if people:
+            log(f"signals: keep #{n} ({len(people)} signup(s))")
+            continue
+        if not live:
+            log(f"signals: would close #{n} (0 signups after {days} days)")
+            continue
+        tm.gh("PATCH", f"{repo()}/issues/{n}", {"state": "closed"})
+        tm.comment(n, f"Closed by housekeeping: 0 signups in the {days}-day measuring window.", {"housekeeping": "signal"})
+        log(f"signals: closed #{n}")
+        closed += 1
+    return closed
+
+
+# ---------- 3. milestones ----------
+
+def step_milestones(live: bool) -> int:
+    closed = 0
+    for m in paged(f"{repo()}/milestones?state=open"):
+        if int(m.get("open_issues") or 0) or not int(m.get("closed_issues") or 0):
+            continue
+        if not live:
+            log(f"milestones: would close {m.get('title')!r}")
+            continue
+        tm.gh("PATCH", f"{repo()}/milestones/{m['id']}", {"state": "closed"})
+        log(f"milestones: closed {m.get('title')!r}")
+        closed += 1
+    return closed
+
+
+# ---------- 4. the stale list ----------
+
+def stale(now: dt.datetime) -> dict[str, list[tuple[int, float, str]]]:
+    """category -> [(number, age in days, title)]. Read-only."""
+    out: dict[str, list[tuple[int, float, str]]] = {}
+
+    def add(cat: str, number: int, age: float, title: str) -> None:
+        out.setdefault(cat, []).append((number, age, title))
+    for i in paged(f"{repo()}/issues?state=open&labels=needs-human"):   # issues and PRs alike
+        age = age_days(i.get("updated_at") or i.get("created_at"), now)
+        if age > NEEDS_HUMAN_DAYS:
+            add(f"`needs-human`, untouched for over {NEEDS_HUMAN_DAYS} days", i["number"], age, i.get("title", ""))
+    for p in paged(f"{repo()}/pulls?state=open"):
+        age = age_days(p.get("updated_at") or p.get("created_at"), now)
+        if age >= PR_IDLE_DAYS:
+            add(f"open PRs idle {PR_IDLE_DAYS} days or more", p["number"], age, p.get("title", ""))
+    for i in paged(f"{repo()}/issues?state=open&labels=parked&type=issues"):
+        add("parked cards", i["number"], age_days(i.get("updated_at") or i.get("created_at"), now), i.get("title", ""))
+    for card in paged(f"{repo()}/issues?state=open&labels=ready&type=issues"):   # last beat: error for a while, or parked
+        beats = [b for b in tm.beats_of(paged(f"{repo()}/issues/{card['number']}/comments")) if b["beat"] not in ("blocked", "capped")]
+        last = beats[-1] if beats else None
+        if not last:
+            continue
+        age = age_days(last["at"], now)
+        if last["beat"] == "parked":
+            add("parked cards", card["number"], age, card.get("title", ""))
+        elif last["beat"] == "error" and age > ERROR_DAYS:
+            add(f"`error` cards older than {ERROR_DAYS} days", card["number"], age, card.get("title", ""))
+    for cat, rows in out.items():   # a card can be listed under two names (parked label and beat): once per category
+        out[cat] = list({r[0]: r for r in rows}.values())
+    return out
+
+
+def stale_text(found: dict[str, list[tuple[int, float, str]]]) -> str:
+    lines = ["🧹 Housekeeping: the stale list (nothing was changed; for the steward)", ""]
+    for cat, rows in found.items():
+        lines.append(f"- {cat}: " + "; ".join(f"#{n} {t[:60]} ({a:.0f}d)" for n, a, t in sorted(rows)))
+    return "\n".join(lines)
+
+
+def log_issue() -> int:
+    for i in paged(f"{repo()}/issues?state=open&labels=astra&type=issues"):
+        if i.get("title") == LOG_TITLE:
+            return i["number"]
+    return LOG_FALLBACK
+
+
+# ---------- the run ----------
+
+def main() -> int:
+    live = (os.environ.get("TIME_MODE") or "dry-run").strip() == "live"
+    now = dt.datetime.now(dt.timezone.utc)
+    log(f"housekeeping {now:%Y-%m-%dT%H:%MZ} mode={'live' if live else 'dry-run'}")
+    failed = 0
+    done = {"branches": 0, "signals": 0, "milestones": 0}
+    found: dict = {}
+    for name, step in (("branches", lambda: step_branches(live)), ("signals", lambda: step_signals(live, now)),
+                       ("milestones", lambda: step_milestones(live))):
+        try:
+            done[name] = step()
+        except Exception as e:  # noqa: BLE001  one step must not stop the others
+            failed += 1
+            log(f"{name}: failed: {type(e).__name__}: {str(e)[:200]}")
+    try:
+        found = stale(now)
+    except Exception as e:  # noqa: BLE001
+        failed += 1
+        log(f"stale: failed: {type(e).__name__}: {str(e)[:200]}")
+    count = len({r[0] for rows in found.values() for r in rows})
+    if found:
+        log(stale_text(found))
+    line = (f"🧹 Housekeeping: {done['branches']} branch(es) deleted, {done['signals']} signal issue(s) closed, "
+            f"{done['milestones']} milestone(s) closed, {count} stale." + (f" {failed} step(s) failed; see the run log." if failed else ""))
+    log(line)
+    if live:
+        try:
+            target = log_issue()
+            if found:
+                tm.comment(target, stale_text(found), {"housekeeping": "stale", "count": count})
+            tm.comment(target, line, {"housekeeping": "run", **done, "stale": count})
+        except Exception as e:  # noqa: BLE001
+            failed += 1
+            log(f"log: failed: {type(e).__name__}: {str(e)[:200]}")
+    return 1 if failed else 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())