Function logRateLimitFromResponse

actions/setup/js/github_rate_limit_logger.cjs:90–117

* Log GitHub API rate-limit information extracted from a REST response's * headers. Call this immediately after any `github.rest.*.*()` call to * record the current rate-limit state without an extra API round-trip. * * @param {{ headers?: Record }} response - The git

(response, operation)

 * @param {string} operation - Human-readable description of the operation (e.g. "issues.listComments")
 */
function logRateLimitFromResponse(response, operation) {
  const headers = response?.headers;
  if (!headers) return;

  const limit = headers["x-ratelimit-limit"];
  const remaining = headers["x-ratelimit-remaining"];
  const reset = headers["x-ratelimit-reset"];
  const used = headers["x-ratelimit-used"];
  const resource = headers["x-ratelimit-resource"];

  // Skip if no rate-limit headers are present (e.g. GraphQL responses)
  if (!limit && !remaining && !reset) return;

  /** @type {Record<string, unknown>} */
  const entry = {
    timestamp: new Date().toISOString(),
    source: "response_headers",
    operation,
  };

  if (resource) entry.resource = resource;
  if (limit !== undefined) entry.limit = parseInt(limit, 10);
  if (remaining !== undefined) entry.remaining = parseInt(remaining, 10);
  if (used !== undefined) entry.used = parseInt(used, 10);
  if (reset) entry.reset = parseResetTimestamp(reset);

  appendEntry(entry);
}

/**
 * Fetch the current GitHub API rate-limit information via the rate-limit API