diff --git a/scripts/devstream/gh.py b/scripts/devstream/gh.py index b9b736b..9db3df1 100644 --- a/scripts/devstream/gh.py +++ b/scripts/devstream/gh.py @@ -215,14 +215,23 @@ def graphql(self, query: str, variables: dict, allow_not_found: bool = False, """allow_not_found returns data with nulls where only NOT_FOUND errors occurred. allow_forbidden also lets through FORBIDDEN errors on one alias (an org IP allow list).""" self.last_redirect = None - r = self._request("POST", "/graphql", body={"query": query, "variables": variables}, - read=bool(READ_QUERY.match(query, LEADING_COMMENTS.match(query).end()))) - if r is None: - raise GitHubError(404, "graphql endpoint not found") - out = r[1] or {} - errors = out.get("errors") - if any(isinstance(e, dict) and e.get("type") == "RATE_LIMITED" for e in errors or []): - raise RateLimited(int(r[0].get("x-ratelimit-reset") or time.time() + 60)) + read = bool(READ_QUERY.match(query, LEADING_COMMENTS.match(query).end())) + retried = False + while True: + r = self._request("POST", "/graphql", body={"query": query, "variables": variables}, read=read) + if r is None: + raise GitHubError(404, "graphql endpoint not found") + out = r[1] or {} + errors = out.get("errors") + if not any(isinstance(e, dict) and e.get("type") == "RATE_LIMITED" for e in errors or []): + break + # Like a REST rate limit: wait once for a near reset. GitHub refuses the whole + # document before running it, so a mutation is safe to send again. + reset = int(r[0].get("x-ratelimit-reset") or time.time() + 60) + if reset - time.time() > MAX_SLEEP or retried: + raise RateLimited(reset) + self.sleep(max(0, reset - time.time())) + retried = True if errors and not all(_allowed(e, allow_not_found, allow_forbidden) for e in errors): raise GitHubError(200, json.dumps(out["errors"])[:500]) return out.get("data") diff --git a/scripts/tests/test_gh.py b/scripts/tests/test_gh.py index 695ad3e..8395cc7 100644 --- a/scripts/tests/test_gh.py +++ b/scripts/tests/test_gh.py @@ -268,9 +268,31 @@ def test_graphql_rate_limited(self): with self.assertRaises(RateLimited) as c: self.gh.graphql("query Q { viewer }", {"rl": 1}) self.assertEqual(c.exception.reset_at, LONG) + self.assertEqual(self.slept, []) with self.assertRaises(RateLimited) as c: self.gh.graphql("query Q { viewer }", {"rl": 2}) self.assertAlmostEqual(c.exception.reset_at, time.time() + 60, delta=5) + # A near reset is waited out once, then the still-limited answer raises. + self.assertEqual(len(self.slept), 1) + self.assertAlmostEqual(self.slept[0], 60, delta=5) + + def test_graphql_rate_limit_waits_then_retries(self): + reset = str(int(time.time()) + 30) + answers = [({"x-ratelimit-reset": reset}, {"errors": [{"type": "RATE_LIMITED"}]}), + ({}, {"data": {"viewer": 1}})] + sent = [] + + def request(method, path, params=None, body=None, read=None): + sent.append(read) + return answers[len(sent) - 1] + for q, read in (("query Q { viewer }", True), ("mutation M { x }", False)): + sent.clear() + self.slept.clear() + self.gh._request = request + self.assertEqual(self.gh.graphql(q, {}), {"viewer": 1}) + self.assertEqual(sent, [read, read]) + self.assertEqual(len(self.slept), 1) + self.assertAlmostEqual(self.slept[0], 30, delta=5) def test_cross_host_redirect_not_followed(self): self.assertEqual(self.gh.get("/foreign"), {"own": True})