WebHooker/server/lib/github/check-run.ts
RhenCloud 449739ee97
feat(check): resolve build log url for failed check suites via GitHub API
check_suite payloads carry no details_url; the build log lives on the
underlying check_run. For failed suites, fetch the suite's check runs with
an installation token and inject the first run's details_url (preferring
the Cloudflare run) as a Build Log field.
2026-08-27 21:59:48 +08:00

55 lines
2.1 KiB
TypeScript

import { createAppJwt } from "./oauth";
const API_VERSION = "2022-11-28";
const CLOUDFLARE_SLUG = "cloudflare-workers-and-pages";
/**
* Resolve a check suite's build log URL. The `check_suite` webhook payload
* carries no `details_url` of its own — only the underlying `check_run` does
* (Cloudflare sets it to the build log page). For a failed suite we fetch the
* suite's check runs via the GitHub API and return the first run's
* `details_url`, preferring the Cloudflare run when present.
*
* Returns undefined when the App credentials are missing, the call fails, or
* no run exposes a `details_url`. Best-effort: callers must not depend on it.
*/
export async function getCheckSuiteBuildLogUrl(
checkRunsUrl: string | undefined,
appId: string | undefined,
privateKey: string | undefined,
installationId: number | undefined,
): Promise<string | undefined> {
if (!checkRunsUrl || !appId || !privateKey || !installationId) return undefined;
try {
const jwt = await createAppJwt(appId, privateKey);
const tokRes = await fetch(`https://api.github.com/app/installations/${installationId}/access_tokens`, {
method: "POST",
headers: {
Authorization: `Bearer ${jwt}`,
Accept: "application/vnd.github+json",
"X-GitHub-Api-Version": API_VERSION,
},
});
if (!tokRes.ok) return undefined;
const { token } = (await tokRes.json()) as { token?: string };
if (!token) return undefined;
const runsRes = await fetch(checkRunsUrl, {
headers: {
Authorization: `Bearer ${token}`,
Accept: "application/vnd.github+json",
"X-GitHub-Api-Version": API_VERSION,
},
});
if (!runsRes.ok) return undefined;
const data = (await runsRes.json()) as {
check_runs?: Array<{ details_url?: string; app?: { slug?: string } }>;
};
const runs = data.check_runs ?? [];
const cloudflare = runs.find((r) => r.app?.slug === CLOUDFLARE_SLUG && r.details_url);
const any = runs.find((r) => r.details_url);
return (cloudflare ?? any)?.details_url;
} catch {
return undefined;
}
}