Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

fix(ci): respect GitHub backoff during release reconciliation (#2029)

Michael D'Angelo9d6d7a060f66
diff --git a/sdk/typescript/scripts/release-pr.mjs b/sdk/typescript/scripts/release-pr.mjs
index e450d93a6..559218ee9 100644
--- a/sdk/typescript/scripts/release-pr.mjs
+++ b/sdk/typescript/scripts/release-pr.mjs
@@ -854,6 +854,7 @@ export function createGitHubClient(
? "https://api.github.com/graphql"
: `${apiRoot}${path}`;
for (let retry = 0; ; retry += 1) {
+ const retryDelay = 1000 * 2 ** retry;
let response;
try {
response = await fetcher(url, {
@@ -871,16 +872,26 @@ export function createGitHubClient(
}
} catch (error) {
if (!read || retry >= 2 || error instanceof SyntaxError) throw error;
- await sleep(1000 * 2 ** retry);
+ await sleep(retryDelay);
continue;
}
- if (read && retry < 2 && [500, 502, 503, 504].includes(response.status)) {
+ const retryAfter = response.headers.get("retry-after");
+ const minimumDelay = /^\d+$/u.test(retryAfter ?? "")
+ ? Number(retryAfter) * 1000
+ : Date.parse(retryAfter ?? "") - Date.now() || 0;
+ if (
+ read &&
+ retry < 2 &&
+ [500, 502, 503, 504].includes(response.status) &&
+ minimumDelay <= retryDelay
+ ) {
await response.body?.cancel().catch(() => undefined);
- await sleep(1000 * 2 ** retry);
+ await sleep(retryDelay);
continue;
}
const error = new Error(
- `GitHub ${method} ${path} failed with HTTP ${response.status}.`,
+ `GitHub ${method} ${path} failed with HTTP ${response.status}.` +
+ (retryAfter ? ` Retry-After: ${retryAfter}.` : ""),
);
error.status = response.status;
throw error;
diff --git a/sdk/typescript/tests-ts/release-pr.test.ts b/sdk/typescript/tests-ts/release-pr.test.ts
index 8d7386480..adb742ae6 100644
--- a/sdk/typescript/tests-ts/release-pr.test.ts
+++ b/sdk/typescript/tests-ts/release-pr.test.ts
@@ -829,21 +829,34 @@ describe("GitHub request transport", () => {
},
);
- test("reports a persistent server error after bounded read retries", async () => {
- let requests = 0;
- const { github, delays } = retryClient(async () => {
- requests++;
- return Response.json({ message: "Unavailable" }, { status: 503 });
- });
- await expect(
- github.request("GET", "git/ref/heads/main"),
- ).rejects.toMatchObject({
- status: 503,
- message: "GitHub GET git/ref/heads/main failed with HTTP 503.",
- });
- expect(requests).toBe(3);
- expect(delays).toEqual([1000, 2000]);
- });
+ test.each([
+ [null, [1000, 2000]],
+ ["1", [1000, 2000]],
+ ["120", []],
+ ["Fri, 01 Jan 2100 00:00:00 GMT", []],
+ ])(
+ "limits retries on HTTP 503 with Retry-After %j",
+ async (retryAfter, expectedDelays) => {
+ let requests = 0;
+ const { github, delays } = retryClient(async () => {
+ requests++;
+ return new Response(null, {
+ status: 503,
+ headers: retryAfter ? { "Retry-After": retryAfter } : {},
+ });
+ });
+ await expect(
+ github.request("GET", "git/ref/heads/main"),
+ ).rejects.toMatchObject({
+ status: 503,
+ message:
+ "GitHub GET git/ref/heads/main failed with HTTP 503." +
+ (retryAfter ? ` Retry-After: ${retryAfter}.` : ""),
+ });
+ expect(requests).toBe(expectedDelays.length + 1);
+ expect(delays).toEqual(expectedDelays);
+ },
+ );
test.each([
["POST", 500],