Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 95 additions & 16 deletions scripts/submit.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
python -m scripts.submit decide (--event EVENT.json | --issue N) --out result.json
python -m scripts.submit apply --result result.json
python -m scripts.submit comment --result result.json --kind {accepted,rejected,pr,error}
python -m scripts.submit seed --file seeds.csv --out report.json [--apply]
"""

import argparse
import csv
import json
import os
import re
Expand All @@ -14,8 +16,8 @@
from datetime import datetime, timedelta, timezone

from scripts.devstream.description import clean_description
from scripts.devstream.entries import CATEGORIES, DEFAULT_PATH, Entry, find, load, save
from scripts.devstream.gh import GitHub
from scripts.devstream.entries import CATEGORIES, DEFAULT_PATH, Entry, find, load, normalize_repo, save
from scripts.devstream.gh import GitHub, GitHubError, RateLimited
from scripts.devstream.issue_form import FormError, parse_submission
from scripts.devstream.quality import check_repo
from scripts.devstream.trust import check_user, ensure_block_access
Expand All @@ -25,6 +27,9 @@
SITE = "https://devstream.jamesconway.dev"
QUALITY_BAR = f"https://github.com/{REPO}/wiki/Quality-Bar"
WEEKLY_LIMIT = 3
SEED_BY = "jamesconwaydev"
# The schema takes any integer; 0 marks an entry that no submission issue backs.
SEED_ISSUE = 0

RATE_LIMIT = "You've hit the limit of 3 submissions a week. Try again in a few days."
DUPLICATE = "This repo is already on the list."
Expand All @@ -33,6 +38,7 @@
"It comes back automatically once it's active again."
)
NOT_FOUND = "We couldn't find that repo on GitHub. Is it public?"
SEED_DUP = "This repo appears earlier in the seed file."


@dataclass
Expand Down Expand Up @@ -70,39 +76,51 @@ def decide(issue: dict, gh, now: datetime, entries: list[Entry], excluded: set[s
if _recent_submissions(login, gh, now) > WEEKLY_LIMIT:
reasons.append(RATE_LIMIT)

dup = find(entries, form["repository"])
more, canonical, description = _check(form["repository"], form["description"], gh, now, entries)
reasons += more
if reasons:
return Decision(False, reasons)
return Decision(True, [], _entry(canonical, form["category"], description, login, now, issue["number"]))


def _check(link: str, text: str, gh, now: datetime, entries: list[Entry]) -> tuple[list[str], str, str | None]:
"""The repo and description checks: (reasons, canonical repo, cleaned description)."""
dup = find(entries, link)
if dup:
return Decision(False, reasons + [_dup_reason(dup)])
return [_dup_reason(dup)], link, None

result = check_repo(form["repository"], gh, now, "submit")
reasons = []
result = check_repo(link, gh, now, "submit")
if not result.exists:
reasons.append(NOT_FOUND)
else:
dup = find(entries, result.canonical)
if dup:
return Decision(False, reasons + [_dup_reason(dup)])
return [_dup_reason(dup)], result.canonical, None
reasons += result.failures

description, why = clean_description(form["description"])
description, why = clean_description(text)
if description is None and result.meta.get("description"):
description = clean_description(result.meta["description"])[0]
if description is None:
reasons.append(why)
return reasons, result.canonical, description

if reasons:
return Decision(False, reasons)
return Decision(True, [], {
"repo": result.canonical,
"category": form["category"],

def _entry(repo: str, category: str, description: str, login: str, now: datetime, issue: int,
seed: bool = False) -> Entry:
return {
"repo": repo,
"category": category,
"description": description,
"submitted_by": login,
"submitted_at": now.strftime("%Y-%m-%dT%H:%M:%SZ"),
"issue": issue["number"],
"issue": issue,
"status": "live",
"warned_at": None,
"superseded_by": None,
"added_by_seed": False,
})
"added_by_seed": seed,
}


def comment(result: dict, kind: str) -> str:
Expand Down Expand Up @@ -189,6 +207,62 @@ def _apply(args) -> int:
return 0


def _seed_row(row: dict, gh, now: datetime, entries: list[Entry], seen: set[str]) -> dict:
out = {"repo": row["repo"], "category": row["category"], "status": "fail", "reasons": [], "entry": None}
if normalize_repo(row["repo"]) in seen:
out["reasons"] = [SEED_DUP]
return out
if row["category"] not in CATEGORIES:
out["reasons"] = [f"unknown category {row['category']!r}"]
return out
try:
reasons, canonical, description = _check(row["repo"], row["description"], gh, now, entries)
except (GitHubError, RateLimited, OSError) as e:
# Undecided is a GitHubError; none of these say anything about the repo.
return out | {"status": "undecided", "reasons": [str(e)]}
if normalize_repo(canonical) in seen:
reasons = [SEED_DUP]
if reasons:
return out | {"reasons": reasons}
return out | {"status": "ok", "entry": _entry(canonical, row["category"], description, SEED_BY, now,
SEED_ISSUE, seed=True)}


def _seed(args) -> int:
with open(args.file, encoding="utf-8", newline="") as f:
rows = list(csv.DictReader(f))
done: dict[str, dict] = {}
if os.path.exists(args.out):
with open(args.out, encoding="utf-8") as f:
for r in json.load(f)["rows"]:
if r["status"] != "undecided":
done.setdefault(r["repo"], r)
gh = GitHub(os.environ["GITHUB_TOKEN"])
entries = load(args.entries)
known = list(entries)
seen: set[str] = set()
report = []
for row in rows:
r = done.pop(row["repo"], None) or _seed_row(row, gh, datetime.now(timezone.utc), known, seen)
seen.add(normalize_repo(row["repo"]))
if r["entry"]:
seen.add(normalize_repo(r["entry"]["repo"]))
known.append(r["entry"])
report.append(r)
# Written every row so a stopped run resumes where it left off.
with open(args.out, "w", encoding="utf-8") as f:
json.dump({"rows": report}, f, indent=2, ensure_ascii=False)
print(f"{r['status']}\t{r['repo']}\t{'; '.join(r['reasons'])}", flush=True)
if not args.apply:
return 0
entries += [r["entry"] for r in report if r["status"] == "ok" and not find(entries, r["entry"]["repo"])]
save(entries, args.entries)
errors = validate(load(args.entries))
for e in errors:
print(e, file=sys.stderr)
return 1 if errors else 0


def _comment(args) -> int:
with open(args.result, encoding="utf-8") as f:
sys.stdout.write(comment(json.load(f), args.kind))
Expand All @@ -206,11 +280,16 @@ def main(argv: list[str]) -> int:
a = sub.add_parser("apply")
a.add_argument("--result", required=True)
a.add_argument("--entries", default=DEFAULT_PATH)
sd = sub.add_parser("seed")
sd.add_argument("--file", required=True)
sd.add_argument("--out", required=True)
sd.add_argument("--entries", default=DEFAULT_PATH)
sd.add_argument("--apply", action="store_true")
c = sub.add_parser("comment")
c.add_argument("--result", required=True)
c.add_argument("--kind", required=True, choices=("accepted", "rejected", "pr", "error"))
args = p.parse_args(argv)
return {"decide": _decide, "apply": _apply, "comment": _comment}[args.cmd](args)
return {"decide": _decide, "apply": _apply, "comment": _comment, "seed": _seed}[args.cmd](args)


if __name__ == "__main__":
Expand Down
104 changes: 103 additions & 1 deletion scripts/tests/test_submit.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import io
import json
import os
import subprocess
Expand All @@ -9,7 +10,10 @@

from scripts.devstream.entries import save
from scripts.devstream.gh import GitHubError, RateLimited
from scripts.submit import ARCHIVED_DUP, DUPLICATE, RATE_LIMIT, comment, decide, main
from scripts.submit import (
ARCHIVED_DUP, DUPLICATE, NOT_FOUND, RATE_LIMIT, SEED_DUP, comment, decide, main,
)
from scripts.validate_data import validate
from scripts.tests.fake_gh import FakeGitHub
from scripts.tests.test_quality import README, b64, iso, repo

Expand Down Expand Up @@ -321,5 +325,103 @@ def test_apply_refuses_rejected_result(self):
self.assertNotEqual(p.returncode, 0)


class SeedCliTest(unittest.TestCase):
CLI = {"repo": "cli/cli", "category": "developer-tools",
"description": "GitHub on the command line, so you can open PRs from the terminal.",
"submitted_by": "jamesconwaydev", "submitted_at": "2026-11-05T00:00:00Z", "issue": 8,
"status": "live", "warned_at": None, "superseded_by": None, "added_by_seed": False}
ROWS = [
("alice/tool", "developer-tools", "A small tool that does one thing well"),
("Alice/Tool", "testing", "The same tool again, under another case"),
("ghost/gone", "testing", "A repo that does not exist on GitHub"),
("CLI/cli", "developer-tools", "Already on the list, so this is a duplicate"),
("flaky/api", "testing", "GitHub answers this one with a server error"),
]

def setUp(self):
tmp = tempfile.TemporaryDirectory()
self.addCleanup(tmp.cleanup)
self.csv = os.path.join(tmp.name, "seeds.csv")
self.out = os.path.join(tmp.name, "report.json")
self.entries = os.path.join(tmp.name, "entries.json")
save([self.CLI], self.entries)
with open(self.csv, "w", newline="") as f:
f.write("repo,category,description,stars\n")
for r in self.ROWS:
f.write(",".join(r) + ",10\n")

def flaky(self, _):
raise GitHubError(502, "bad gateway")

def main(self, g, *extra):
with mock.patch("scripts.submit.GitHub", lambda token: g), \
mock.patch("scripts.submit.datetime") as dt, \
mock.patch.dict(os.environ, {"GITHUB_TOKEN": "t"}), \
mock.patch("sys.stdout", io.StringIO()):
dt.now.return_value = NOW
code = main(["seed", "--file", self.csv, "--out", self.out, "--entries", self.entries, *extra])
with open(self.out) as f:
self.report = json.load(f)
return code

def rows(self):
return {(r["repo"], r["status"]): r for r in self.report["rows"]}

def test_pass_fail_duplicate_and_undecided(self):
g = gh(extra={"GET /repos/flaky/api": self.flaky})
self.assertEqual(self.main(g), 0)
self.assertEqual([(r["repo"], r["status"]) for r in self.report["rows"]], [
("alice/tool", "ok"), ("Alice/Tool", "fail"), ("ghost/gone", "fail"),
("CLI/cli", "fail"), ("flaky/api", "undecided"),
])
rows = self.rows()
self.assertEqual(rows["alice/tool", "ok"]["entry"], {
"repo": "alice/tool", "category": "developer-tools",
"description": "A small tool that does one thing well.",
"submitted_by": "jamesconwaydev", "submitted_at": "2026-11-05T12:00:00Z", "issue": 0,
"status": "live", "warned_at": None, "superseded_by": None, "added_by_seed": True,
})
self.assertEqual(rows["Alice/Tool", "fail"]["reasons"], [SEED_DUP])
self.assertEqual(rows["ghost/gone", "fail"]["reasons"], [NOT_FOUND])
self.assertEqual(rows["CLI/cli", "fail"]["reasons"], [DUPLICATE])
self.assertIn("502", rows["flaky/api", "undecided"]["reasons"][0])
# No trust check, no rate limit search, no block list.
self.assertFalse([c for c in g.calls if "/users/" in c[1] or "/search/" in c[1] or "/blocks" in c[1]])

def test_rate_limited_row_is_undecided_and_run_continues(self):
def limited(_):
raise RateLimited(0)

g = gh(extra={"GET /repos/ghost/gone": limited})
self.assertEqual(self.main(g), 0)
self.assertEqual(self.rows()["ghost/gone", "undecided"]["entry"], None)
self.assertIn(("flaky/api", "fail"), self.rows())

def test_bad_category_fails(self):
with open(self.csv, "w") as f:
f.write("repo,category,description\nalice/tool,nope,A small tool that does one thing well\n")
self.main(gh())
self.assertEqual(self.report["rows"][0]["status"], "fail")
self.assertIn("unknown category", self.report["rows"][0]["reasons"][0])

def test_resume_skips_decided_rows_and_retries_undecided(self):
self.main(gh(extra={"GET /repos/flaky/api": self.flaky}))
g = gh(extra={"GET /repos/flaky/api": repo(full_name="flaky/api"),
"GET /repos/flaky/api/readme": b64(README),
"GET /repos/flaky/api/community/profile": {"files": {"contributing": {}, "code_of_conduct": {}}}})
self.main(g)
self.assertEqual({c[1] for c in g.calls if c[0] == "GET"} & {R, "/repos/ghost/gone"}, set())
self.assertIn(("flaky/api", "ok"), self.rows())
self.assertIn(("alice/tool", "ok"), self.rows())

def test_apply_appends_passing_entries_and_validates(self):
self.assertEqual(self.main(gh(extra={"GET /repos/flaky/api": self.flaky}), "--apply"), 0)
with open(self.entries) as f:
doc = json.load(f)
self.assertEqual([e["repo"] for e in doc["entries"]], ["alice/tool", "cli/cli"])
self.assertTrue(doc["entries"][0]["added_by_seed"])
self.assertEqual(validate(doc["entries"]), [])


if __name__ == "__main__":
unittest.main()
Loading