[.github] Log rate limits after each API call (#36386)

Author: mikeharder

.github/package-lock.json

@@ -17,8 +17,9 @@
   "devDependencies": {
     "@actions/github-script": "github:actions/github-script",
     "@eslint/js": "^9.22.0",
-    "@octokit/webhooks-types": "^7.5.1",
     "@octokit/rest": "^22.0.0",
+    "@octokit/types": "^14.1.0",
+    "@octokit/webhooks-types": "^7.5.1",
     "@tsconfig/node20": "^20.1.4",
     "@types/debug": "^4.1.12",
     "@types/js-yaml": "^4.0.9",

.github/package.json

@@ -2,6 +2,7 @@
 
 import { inspect } from "util";
 import { PER_PAGE_MAX } from "../../shared/src/github.js";
+import { rateLimitHook } from "./github.js";
 import { getIssueNumber } from "./issues.js";
 
 /**
@@ -30,6 +31,8 @@ export async function extractInputs(github, context, core) {
     core.debug(`context: ${JSON.stringify(context)}`);
   }
 
+  github.hook.after("request", rateLimitHook);
+
   /** @type {{ owner: string, repo: string, head_sha: string, issue_number: number, run_id: number, details_url?: string }} */
   let inputs;
 

.github/workflows/src/context.js

@@ -100,3 +100,19 @@ export async function getWorkflowRuns(github, context, workflowName, ref) {
     .filter((run) => run.name === workflowName)
     .sort(invert(byDate((run) => run.updated_at)));
 }
+
+/**
+ * @param {import("@octokit/types").OctokitResponse<any>} response
+ * @param {import("@octokit/types").RequestParameters & {url: string, method: string}} options
+ */
+export function rateLimitHook(response, options) {
+  const limits = {
+    method: options.method.toUpperCase(),
+    url: options.url,
+    limit: response.headers["x-ratelimit-limit"],
+    remaining: response.headers["x-ratelimit-remaining"],
+    reset: new Date(parseInt(response.headers["x-ratelimit-reset"] || "") * 1000),
+  };
+
+  console.log(`rate-limits: ${JSON.stringify(limits)}`);
+}

.github/workflows/src/github.js

@@ -34,7 +34,7 @@ describe("extractInputs", () => {
       },
     };
 
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual({
+    await expect(extractInputs(createMockGithub(), context, createMockCore())).resolves.toEqual({
       owner: "TestRepoOwnerLogin",
       repo: "TestRepoName",
       head_sha: "abc123",
@@ -44,6 +44,8 @@ describe("extractInputs", () => {
   });
 
   it("pull_request_target", async () => {
+    const github = createMockGithub();
+
     const context = {
       eventName: "pull_request_target",
       payload: {
@@ -71,23 +73,23 @@ describe("extractInputs", () => {
       run_id: NaN,
     };
 
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual(expected);
+    await expect(extractInputs(github, context, createMockCore())).resolves.toEqual(expected);
 
     context.payload.action = "unlabeled";
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual(expected);
+    await expect(extractInputs(github, context, createMockCore())).resolves.toEqual(expected);
 
     context.payload.action = "opened";
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual(expected);
+    await expect(extractInputs(github, context, createMockCore())).resolves.toEqual(expected);
 
     context.payload.action = "synchronize";
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual(expected);
+    await expect(extractInputs(github, context, createMockCore())).resolves.toEqual(expected);
 
     context.payload.action = "reopened";
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual(expected);
+    await expect(extractInputs(github, context, createMockCore())).resolves.toEqual(expected);
 
     // Action not yet supported
     context.payload.action = "assigned";
-    await expect(extractInputs(null, context, createMockCore())).rejects.toThrow();
+    await expect(extractInputs(github, context, createMockCore())).rejects.toThrow();
   });
 
   it("issue_comment:edited", async () => {
@@ -140,7 +142,7 @@ describe("extractInputs", () => {
       },
     };
 
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual({
+    await expect(extractInputs(createMockGithub(), context, createMockCore())).resolves.toEqual({
       owner: "TestRepoOwnerLogin",
       repo: "TestRepoName",
       head_sha: "",
@@ -157,7 +159,7 @@ describe("extractInputs", () => {
       },
     };
 
-    await expect(extractInputs(null, context, createMockCore())).rejects.toThrow();
+    await expect(extractInputs(createMockGithub(), context, createMockCore())).rejects.toThrow();
   });
 
   it("workflow_run:completed:pull_request (same repo)", async () => {
@@ -180,7 +182,7 @@ describe("extractInputs", () => {
       },
     };
 
-    await expect(extractInputs(null, context, createMockCore())).resolves.toEqual({
+    await expect(extractInputs(createMockGithub(), context, createMockCore())).resolves.toEqual({
       owner: "TestRepoOwnerLogin",
       repo: "TestRepoName",
       head_sha: "abc123",

.github/workflows/test/context.test.js

@@ -4,6 +4,9 @@ import { vi } from "vitest";
 // Partial mock of `github` parameter passed into github-script actions
 export function createMockGithub() {
   return {
+    hook: {
+      after: vi.fn(),
+    },
     paginate: async (func, params) => {
       // Assume all test data fits in single page
       const data = (await func(params)).data;