mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-24 06:41:16 +00:00
* chore(pr): reuse green hosted CI from patch-identical pre-rebase heads (24h window) * fix(pr): type-safe fixtures and lint cleanup for hosted-CI reuse tests
901 lines
28 KiB
JavaScript
901 lines
28 KiB
JavaScript
#!/usr/bin/env node
|
|
import { execFileSync, spawnSync } from "node:child_process";
|
|
import { mkdirSync, writeFileSync } from "node:fs";
|
|
import path from "node:path";
|
|
import { isDirectRunUrl } from "./lib/direct-run.mjs";
|
|
import { execGhApiRead, plainGhEnv } from "./lib/plain-gh.mjs";
|
|
|
|
export const SCHEDULED_HOSTED_WORKFLOWS = [
|
|
"Blacksmith Testbox",
|
|
"Blacksmith ARM Testbox",
|
|
"Blacksmith Build Artifacts Testbox",
|
|
"Workflow Sanity",
|
|
];
|
|
const CI_WORKFLOW_PATH = ".github/workflows/ci.yml";
|
|
const BUILD_ARTIFACTS_WORKFLOW = "Blacksmith Build Artifacts Testbox";
|
|
const ARTIFACT_FALLBACK_REQUIRED_WORKFLOWS = [
|
|
"Blacksmith Testbox",
|
|
"Blacksmith ARM Testbox",
|
|
"Workflow Sanity",
|
|
];
|
|
// Full workflow-run objects are large enough for a 100-row response to exceed
|
|
// the Octopool relay cap on busy SHAs. Keep each REST page bounded and retain
|
|
// the existing 1,000-result search window through pagination.
|
|
const WORKFLOW_RUNS_PAGE_SIZE = 30;
|
|
const MAX_WORKFLOW_RUN_SEARCH_RESULTS = 1_000;
|
|
const COMPARE_COMMITS_PAGE_SIZE = 100;
|
|
export const HOSTED_GATE_MAX_AGE_HOURS = 24;
|
|
const HOSTED_GATE_MAX_AGE_MS = HOSTED_GATE_MAX_AGE_HOURS * 60 * 60 * 1_000;
|
|
const HOSTED_GATE_CLOCK_SKEW_MS = 5 * 60 * 1_000;
|
|
const MAX_CI_REUSE_CANDIDATES = 5;
|
|
const CI_REUSE_RUN_LIST_LIMIT = 50;
|
|
const GIT_MAX_BUFFER_BYTES = 64 * 1024 * 1024;
|
|
|
|
function readOptionValue(argv, index, optionName) {
|
|
const value = argv[index + 1];
|
|
if (!value || value.startsWith("-")) {
|
|
throw new Error(`Expected ${optionName} <value>.`);
|
|
}
|
|
return value;
|
|
}
|
|
|
|
export function parseArgs(argv) {
|
|
const args = {
|
|
repo: "",
|
|
sha: "",
|
|
pr: 0,
|
|
recentSha: "",
|
|
output: "",
|
|
changelogOnly: false,
|
|
};
|
|
const seen = new Set();
|
|
const setOnce = (flag, key, value) => {
|
|
if (seen.has(flag)) {
|
|
throw new Error(`${flag} was provided more than once.`);
|
|
}
|
|
seen.add(flag);
|
|
args[key] = value;
|
|
};
|
|
for (let index = 0; index < argv.length; index += 1) {
|
|
const arg = argv[index];
|
|
switch (arg) {
|
|
case "--repo":
|
|
setOnce(arg, "repo", readOptionValue(argv, index, arg));
|
|
index += 1;
|
|
break;
|
|
case "--sha":
|
|
setOnce(arg, "sha", readOptionValue(argv, index, arg));
|
|
index += 1;
|
|
break;
|
|
case "--pr": {
|
|
const value = Number(readOptionValue(argv, index, arg));
|
|
if (!Number.isSafeInteger(value) || value <= 0) {
|
|
throw new Error("Expected --pr <positive-integer>.");
|
|
}
|
|
setOnce(arg, "pr", value);
|
|
index += 1;
|
|
break;
|
|
}
|
|
case "--recent-sha":
|
|
setOnce(arg, "recentSha", readOptionValue(argv, index, arg));
|
|
index += 1;
|
|
break;
|
|
case "--output":
|
|
setOnce(arg, "output", readOptionValue(argv, index, arg));
|
|
index += 1;
|
|
break;
|
|
case "--changelog-only":
|
|
setOnce(arg, "changelogOnly", true);
|
|
break;
|
|
default:
|
|
throw new Error(`Unknown option: ${arg}`);
|
|
}
|
|
}
|
|
if (!args.repo || !args.sha || !args.pr || !args.output) {
|
|
throw new Error(
|
|
"Usage: node scripts/verify-pr-hosted-gates.mjs --repo <owner/repo> --sha <sha> --pr <number> [--recent-sha <sha>] --output <path>",
|
|
);
|
|
}
|
|
return args;
|
|
}
|
|
|
|
function formatObservedRuns(runs) {
|
|
if (runs.length === 0) {
|
|
return "none";
|
|
}
|
|
return runs
|
|
.map(
|
|
(run) => `${run.id ?? "unknown"}:${run.status ?? "unknown"}/${run.conclusion ?? "unknown"}`,
|
|
)
|
|
.join(", ");
|
|
}
|
|
|
|
function isReleaseGateCiRun(run, sha) {
|
|
return (
|
|
run?.event === "workflow_dispatch" &&
|
|
run?.head_sha === sha &&
|
|
String(run?.path ?? "").split("@", 1)[0] === CI_WORKFLOW_PATH &&
|
|
run?.display_title === `CI release gate ${sha}`
|
|
);
|
|
}
|
|
|
|
function matchingAuthoritativeRuns(runs, workflowName, sha, allowManual = true) {
|
|
return runs.filter((run) => {
|
|
if (run?.head_sha !== sha) {
|
|
return false;
|
|
}
|
|
if (run?.event === "pull_request") {
|
|
return run?.name === workflowName;
|
|
}
|
|
return allowManual && workflowName === "CI" && isReleaseGateCiRun(run, sha);
|
|
});
|
|
}
|
|
|
|
function latestRun(runs) {
|
|
return runs.toSorted((left, right) =>
|
|
String(right.updated_at ?? "").localeCompare(String(left.updated_at ?? "")),
|
|
)[0];
|
|
}
|
|
|
|
function runUpdatedAtMs(run) {
|
|
const value = Date.parse(String(run?.updated_at ?? ""));
|
|
return Number.isFinite(value) ? value : null;
|
|
}
|
|
|
|
function isRecentRun(run, nowMs) {
|
|
const updatedAtMs = runUpdatedAtMs(run);
|
|
return (
|
|
updatedAtMs !== null &&
|
|
updatedAtMs >= nowMs - HOSTED_GATE_MAX_AGE_MS &&
|
|
updatedAtMs <= nowMs + HOSTED_GATE_CLOCK_SKEW_MS
|
|
);
|
|
}
|
|
|
|
function isSuccessfulRecentRun(run, nowMs) {
|
|
return run?.status === "completed" && run.conclusion === "success" && isRecentRun(run, nowMs);
|
|
}
|
|
|
|
function runGit(args, { input } = {}) {
|
|
const result = spawnSync("git", args, {
|
|
encoding: "utf8",
|
|
input,
|
|
maxBuffer: GIT_MAX_BUFFER_BYTES,
|
|
stdio: [input === undefined ? "ignore" : "pipe", "pipe", "pipe"],
|
|
});
|
|
if (result.error) {
|
|
throw result.error;
|
|
}
|
|
if (result.status !== 0) {
|
|
throw new Error(`git ${args[0]} failed with exit code ${result.status ?? "unknown"}`);
|
|
}
|
|
return result.stdout;
|
|
}
|
|
|
|
function parseSingleObjectId(raw, label) {
|
|
const values = String(raw).trim().split(/\s+/u).filter(Boolean);
|
|
if (values.length !== 1 || !/^[0-9a-f]{40,64}$/u.test(values[0])) {
|
|
throw new Error(`Expected one ${label} object id.`);
|
|
}
|
|
return values[0];
|
|
}
|
|
|
|
function computePatchId(sha, mainRef, execGit) {
|
|
const mergeBase = parseSingleObjectId(
|
|
execGit(["merge-base", mainRef, sha]),
|
|
`merge base for ${sha}`,
|
|
);
|
|
const diff = execGit(["diff", mergeBase, sha]);
|
|
const patchIdLines = String(execGit(["patch-id", "--stable"], { input: diff }))
|
|
.trim()
|
|
.split(/\r?\n/u)
|
|
.filter(Boolean);
|
|
if (patchIdLines.length !== 1) {
|
|
throw new Error(`Expected one patch id for ${sha}.`);
|
|
}
|
|
const [patchId, commitId, ...rest] = patchIdLines[0].trim().split(/\s+/u);
|
|
if (
|
|
rest.length > 0 ||
|
|
!/^[0-9a-f]{40,64}$/u.test(patchId ?? "") ||
|
|
!/^[0-9a-f]{40,64}$/u.test(commitId ?? "")
|
|
) {
|
|
throw new Error(`Invalid patch-id output for ${sha}.`);
|
|
}
|
|
return patchId;
|
|
}
|
|
|
|
function ensureCommitAvailable(sha, execGit) {
|
|
try {
|
|
execGit(["cat-file", "-e", `${sha}^{commit}`]);
|
|
return true;
|
|
} catch {
|
|
try {
|
|
execGit(["fetch", "origin", sha]);
|
|
execGit(["cat-file", "-e", `${sha}^{commit}`]);
|
|
return true;
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
function isQualifyingCiReuseRun(run) {
|
|
if (run?.event === "pull_request") {
|
|
return run?.name === "CI";
|
|
}
|
|
return isReleaseGateCiRun(run, run?.head_sha);
|
|
}
|
|
|
|
function findPatchIdenticalCiReuse({
|
|
sha,
|
|
candidateRuns,
|
|
nowMs,
|
|
mainRef = "origin/main",
|
|
execGit = runGit,
|
|
}) {
|
|
if (!Array.isArray(candidateRuns)) {
|
|
return undefined;
|
|
}
|
|
const candidates = candidateRuns
|
|
.filter(
|
|
(run) =>
|
|
run?.head_sha !== sha &&
|
|
/^[0-9a-f]{40,64}$/u.test(String(run?.head_sha ?? "")) &&
|
|
isQualifyingCiReuseRun(run) &&
|
|
isSuccessfulRecentRun(run, nowMs),
|
|
)
|
|
.toSorted((left, right) =>
|
|
String(right.updated_at ?? "").localeCompare(String(left.updated_at ?? "")),
|
|
)
|
|
.slice(0, MAX_CI_REUSE_CANDIDATES);
|
|
if (candidates.length === 0) {
|
|
return undefined;
|
|
}
|
|
|
|
let currentPatchId;
|
|
try {
|
|
currentPatchId = computePatchId(sha, mainRef, execGit);
|
|
} catch {
|
|
return undefined;
|
|
}
|
|
for (const run of candidates) {
|
|
if (!ensureCommitAvailable(run.head_sha, execGit)) {
|
|
continue;
|
|
}
|
|
try {
|
|
if (computePatchId(run.head_sha, mainRef, execGit) === currentPatchId) {
|
|
return {
|
|
run,
|
|
reusedFromSha: run.head_sha,
|
|
reusedRunId: run.id,
|
|
patchIdMatched: true,
|
|
};
|
|
}
|
|
} catch {
|
|
// A candidate is reusable only when every local git proof step succeeds.
|
|
}
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
const CI_GATE_CHECK_NAME = "openclaw/ci-gate";
|
|
|
|
/**
|
|
* True when this run's own openclaw/ci-gate job already succeeded on the
|
|
* run's CURRENT attempt. The gate job needs every selected lane and fails on
|
|
* any non-success result, so a successful gate proves the merge-relevant
|
|
* outcome minutes before post-gate stragglers (timing summaries, artifact
|
|
* uploads) let the run itself reach completed. Check suites survive reruns,
|
|
* so binding goes through the attempt-scoped jobs listing: the job must carry
|
|
* the run's own run_attempt — a prior attempt's gate success can never vouch
|
|
* for a rerun that has not reached its gate yet.
|
|
*/
|
|
function hasSuccessfulCiGateJob(run, ciGateJobs, nowMs) {
|
|
if (!run?.id || !Array.isArray(ciGateJobs)) {
|
|
return false;
|
|
}
|
|
const runAttempt = run.run_attempt ?? 1;
|
|
return ciGateJobs.some((job) => {
|
|
if (job?.name !== CI_GATE_CHECK_NAME) {
|
|
return false;
|
|
}
|
|
// Workflow attempts share a run id and filter=latest keeps a not-yet-rerun
|
|
// job's prior-attempt execution, so bind to the attempt explicitly: the
|
|
// REST job payload exposes run_attempt, and jobs are fetched from the
|
|
// attempt-specific endpoint. Both must agree with the run's attempt.
|
|
if (job?.run_id !== run.id || (job?.run_attempt ?? runAttempt) !== runAttempt) {
|
|
return false;
|
|
}
|
|
if (job?.status !== "completed" || job?.conclusion !== "success") {
|
|
return false;
|
|
}
|
|
const completedAtMs = Date.parse(String(job?.completed_at ?? ""));
|
|
return (
|
|
Number.isFinite(completedAtMs) &&
|
|
completedAtMs >= nowMs - HOSTED_GATE_MAX_AGE_MS &&
|
|
completedAtMs <= nowMs + HOSTED_GATE_CLOCK_SKEW_MS
|
|
);
|
|
});
|
|
}
|
|
|
|
function isGateProvenInProgressRun(run, ciGateJobs, nowMs) {
|
|
return (
|
|
(run?.status === "in_progress" || run?.status === "queued") &&
|
|
isRecentRun(run, nowMs) &&
|
|
hasSuccessfulCiGateJob(run, ciGateJobs, nowMs)
|
|
);
|
|
}
|
|
|
|
function preferredCiRun(runs, nowMs) {
|
|
const scheduledRuns = runs.filter((run) => run.event === "pull_request");
|
|
const latestScheduledRun = latestRun(scheduledRuns);
|
|
const latestCompletedScheduledRun = latestRun(
|
|
scheduledRuns.filter((run) => run.status === "completed"),
|
|
);
|
|
const latestManualRun = latestRun(runs.filter((run) => run.event === "workflow_dispatch"));
|
|
|
|
// Manual proof may replace stale scheduled success or a pending run,
|
|
// never an unresolved terminal non-success.
|
|
if (latestCompletedScheduledRun && latestCompletedScheduledRun.conclusion !== "success") {
|
|
return latestCompletedScheduledRun;
|
|
}
|
|
if (latestScheduledRun?.status === "completed" && isRecentRun(latestScheduledRun, nowMs)) {
|
|
return latestScheduledRun;
|
|
}
|
|
return latestManualRun ?? latestScheduledRun;
|
|
}
|
|
|
|
function successfulRunOrThrow(
|
|
runs,
|
|
workflowName,
|
|
sha,
|
|
{ allowManual = true, nowMs = Date.now(), ciGateJobs = [] } = {},
|
|
) {
|
|
const matchingRuns = matchingAuthoritativeRuns(runs, workflowName, sha, allowManual);
|
|
const run = workflowName === "CI" ? preferredCiRun(matchingRuns, nowMs) : latestRun(matchingRuns);
|
|
if (isSuccessfulRecentRun(run, nowMs)) {
|
|
return run;
|
|
}
|
|
if (workflowName === "CI") {
|
|
if (isGateProvenInProgressRun(run, ciGateJobs, nowMs)) {
|
|
return run;
|
|
}
|
|
// A terminal non-success stays blocking unless a NEWER pending SCHEDULED
|
|
// rerun on the same head has already passed its own gate — the gate needs
|
|
// every selected lane, so that attempt is authoritative proof the failure
|
|
// is re-resolved. The newer-than bound stops a stalled older run's gate
|
|
// from masking a later failure, and manual runs can never mask one.
|
|
if (run?.status === "completed" && run.conclusion !== "success") {
|
|
const failedRunCreatedAtMs = Date.parse(String(run?.created_at ?? ""));
|
|
const gateProvenRerun = matchingRuns.find((candidate) => {
|
|
if (candidate === run || candidate.event !== "pull_request") {
|
|
return false;
|
|
}
|
|
const candidateCreatedAtMs = Date.parse(String(candidate?.created_at ?? ""));
|
|
if (
|
|
!Number.isFinite(candidateCreatedAtMs) ||
|
|
!Number.isFinite(failedRunCreatedAtMs) ||
|
|
candidateCreatedAtMs <= failedRunCreatedAtMs
|
|
) {
|
|
return false;
|
|
}
|
|
return isGateProvenInProgressRun(candidate, ciGateJobs, nowMs);
|
|
});
|
|
if (gateProvenRerun) {
|
|
return gateProvenRerun;
|
|
}
|
|
}
|
|
}
|
|
throw new Error(
|
|
`Missing successful recent ${workflowName} workflow for ${sha}. Observed: ${formatObservedRuns(matchingRuns)}`,
|
|
);
|
|
}
|
|
|
|
function hasSuccessfulRecentReleaseGate(workflowRuns, sha, nowMs) {
|
|
const releaseGate = latestRun(workflowRuns.filter((run) => isReleaseGateCiRun(run, sha)));
|
|
return isSuccessfulRecentRun(releaseGate, nowMs);
|
|
}
|
|
|
|
function runBelongsToPullRequest(
|
|
run,
|
|
pr,
|
|
pullRequestCommitShas,
|
|
pullRequestHeadBranch,
|
|
pullRequestHeadRepository,
|
|
) {
|
|
if (run?.pull_requests?.some((pullRequest) => pullRequest?.number === pr)) {
|
|
return true;
|
|
}
|
|
if (Array.isArray(run?.pull_requests) && run.pull_requests.length > 0) {
|
|
return false;
|
|
}
|
|
// Fork pull_request runs currently arrive with pull_requests: []. Require
|
|
// the immutable commit plus its PR head identity; branch identity alone is
|
|
// mutable, while ancestry alone can include commits from merged branches.
|
|
return (
|
|
pullRequestCommitShas.has(run?.head_sha) &&
|
|
run?.head_branch === pullRequestHeadBranch &&
|
|
run?.head_repository?.full_name?.toLowerCase() === pullRequestHeadRepository.toLowerCase()
|
|
);
|
|
}
|
|
|
|
function canCoverQueuedBuildArtifacts(workflowRuns, sha, nowMs) {
|
|
if (!hasSuccessfulRecentReleaseGate(workflowRuns, sha, nowMs)) {
|
|
return false;
|
|
}
|
|
const supportingGatesPassed = ARTIFACT_FALLBACK_REQUIRED_WORKFLOWS.every((workflowName) => {
|
|
const run = latestRun(matchingAuthoritativeRuns(workflowRuns, workflowName, sha, false));
|
|
return isSuccessfulRecentRun(run, nowMs);
|
|
});
|
|
if (!supportingGatesPassed) {
|
|
return false;
|
|
}
|
|
const buildArtifactRuns = matchingAuthoritativeRuns(
|
|
workflowRuns,
|
|
BUILD_ARTIFACTS_WORKFLOW,
|
|
sha,
|
|
false,
|
|
);
|
|
const latestBuildArtifactRun = latestRun(buildArtifactRuns);
|
|
return (
|
|
latestBuildArtifactRun?.status === "queued" &&
|
|
isRecentRun(latestBuildArtifactRun, nowMs) &&
|
|
buildArtifactRuns.every(
|
|
(run) =>
|
|
run.status === "queued" || (run.status === "completed" && run.conclusion === "success"),
|
|
)
|
|
);
|
|
}
|
|
|
|
function stripAnsi(raw) {
|
|
const escape = String.fromCharCode(27);
|
|
return raw.replace(new RegExp(`${escape}\\[[0-?]*[ -/]*[@-~]`, "gu"), "");
|
|
}
|
|
|
|
export function parseWorkflowRunPage(raw) {
|
|
const page = JSON.parse(stripAnsi(raw));
|
|
return {
|
|
totalCount: page.total_count ?? 0,
|
|
workflowRuns: page.workflow_runs ?? [],
|
|
};
|
|
}
|
|
|
|
export function workflowRunPageCount(totalCount) {
|
|
return Math.min(
|
|
Math.ceil(totalCount / WORKFLOW_RUNS_PAGE_SIZE),
|
|
Math.ceil(MAX_WORKFLOW_RUN_SEARCH_RESULTS / WORKFLOW_RUNS_PAGE_SIZE),
|
|
);
|
|
}
|
|
|
|
export function collectHostedGateEvidence({
|
|
sha,
|
|
pr,
|
|
recentSha,
|
|
pullRequestCommitShas = [],
|
|
pullRequestHeadBranch = "",
|
|
pullRequestHeadRepository = "",
|
|
workflowRuns,
|
|
ciGateJobs = [],
|
|
loadCiReuseCandidates = () => [],
|
|
execGit = runGit,
|
|
changelogOnly = false,
|
|
nowMs = Date.now(),
|
|
}) {
|
|
if (!Array.isArray(workflowRuns)) {
|
|
throw new Error("workflowRuns must be an array.");
|
|
}
|
|
const pullRequestCommitShaSet = new Set(pullRequestCommitShas);
|
|
|
|
const collectForSha = (
|
|
evidenceSha,
|
|
{ allowManual, requiredScheduledWorkflows = new Set(), ciRun },
|
|
) => {
|
|
const workflows = [];
|
|
const fallbackCoveredWorkflows = [];
|
|
if (!changelogOnly) {
|
|
workflows.push(
|
|
ciRun ??
|
|
successfulRunOrThrow(workflowRuns, "CI", evidenceSha, {
|
|
allowManual,
|
|
nowMs,
|
|
// Gate proof only vouches for the exact head under verification.
|
|
ciGateJobs: evidenceSha === sha ? ciGateJobs : [],
|
|
}),
|
|
);
|
|
}
|
|
for (const workflowName of SCHEDULED_HOSTED_WORKFLOWS) {
|
|
const matchingRuns = matchingAuthoritativeRuns(
|
|
workflowRuns,
|
|
workflowName,
|
|
evidenceSha,
|
|
allowManual,
|
|
);
|
|
if (matchingRuns.length === 0 && !requiredScheduledWorkflows.has(workflowName)) {
|
|
continue;
|
|
}
|
|
if (
|
|
allowManual &&
|
|
workflowName === BUILD_ARTIFACTS_WORKFLOW &&
|
|
canCoverQueuedBuildArtifacts(workflowRuns, evidenceSha, nowMs)
|
|
) {
|
|
fallbackCoveredWorkflows.push({
|
|
name: workflowName,
|
|
coveredBy: "CI release gate",
|
|
reason: "scheduled workflow is queued",
|
|
});
|
|
continue;
|
|
}
|
|
workflows.push(
|
|
successfulRunOrThrow(workflowRuns, workflowName, evidenceSha, {
|
|
allowManual,
|
|
nowMs,
|
|
}),
|
|
);
|
|
}
|
|
return { workflows, fallbackCoveredWorkflows };
|
|
};
|
|
|
|
let ciRun;
|
|
let ciReuse;
|
|
if (!changelogOnly) {
|
|
try {
|
|
ciRun = successfulRunOrThrow(workflowRuns, "CI", sha, {
|
|
allowManual: true,
|
|
nowMs,
|
|
ciGateJobs,
|
|
});
|
|
} catch (exactCiError) {
|
|
let candidateRuns;
|
|
try {
|
|
candidateRuns = loadCiReuseCandidates();
|
|
} catch {
|
|
candidateRuns = [];
|
|
}
|
|
ciReuse = findPatchIdenticalCiReuse({
|
|
sha,
|
|
candidateRuns,
|
|
nowMs,
|
|
execGit,
|
|
});
|
|
if (!ciReuse) {
|
|
throw exactCiError;
|
|
}
|
|
ciRun = ciReuse.run;
|
|
}
|
|
}
|
|
|
|
let evidenceSha = sha;
|
|
let selected;
|
|
try {
|
|
selected = collectForSha(sha, { allowManual: true, ciRun });
|
|
} catch (exactError) {
|
|
// Scheduled hosted workflows retain their existing recent-cohort fallback.
|
|
// CI itself is either exact-head proof or the patch-identical run selected
|
|
// above; never silently replace it with an unverified prior-head run.
|
|
const targetScheduledWorkflows = new Set(
|
|
SCHEDULED_HOSTED_WORKFLOWS.filter(
|
|
(workflowName) =>
|
|
matchingAuthoritativeRuns(workflowRuns, workflowName, sha, false).length > 0,
|
|
),
|
|
);
|
|
const fallbackShas = [
|
|
ciReuse?.reusedFromSha,
|
|
recentSha,
|
|
...workflowRuns
|
|
.filter(
|
|
(run) =>
|
|
run?.event === "pull_request" &&
|
|
run?.head_sha !== sha &&
|
|
runBelongsToPullRequest(
|
|
run,
|
|
pr,
|
|
pullRequestCommitShaSet,
|
|
pullRequestHeadBranch,
|
|
pullRequestHeadRepository,
|
|
) &&
|
|
isRecentRun(run, nowMs),
|
|
)
|
|
.toSorted((left, right) =>
|
|
String(right.updated_at ?? "").localeCompare(String(left.updated_at ?? "")),
|
|
)
|
|
.map((run) => run.head_sha),
|
|
].filter(Boolean);
|
|
let fallbackError;
|
|
for (const fallbackSha of new Set(fallbackShas)) {
|
|
try {
|
|
selected = collectForSha(fallbackSha, {
|
|
allowManual: false,
|
|
requiredScheduledWorkflows: targetScheduledWorkflows,
|
|
ciRun,
|
|
});
|
|
evidenceSha = fallbackSha;
|
|
break;
|
|
} catch (error) {
|
|
fallbackError ??= error;
|
|
}
|
|
}
|
|
if (!selected) {
|
|
throw fallbackError ?? exactError;
|
|
}
|
|
}
|
|
|
|
const evidence = {
|
|
headSha: sha,
|
|
workflows: selected.workflows.map((run) => ({
|
|
id: run.id,
|
|
name: run.name,
|
|
event: run.event,
|
|
headSha: run.head_sha,
|
|
headBranch: run.head_branch,
|
|
status: run.status,
|
|
conclusion: run.conclusion,
|
|
createdAt: run.created_at,
|
|
updatedAt: run.updated_at,
|
|
url: run.html_url,
|
|
})),
|
|
};
|
|
if (evidenceSha !== sha) {
|
|
evidence.evidenceHeadSha = evidenceSha;
|
|
}
|
|
if (ciReuse) {
|
|
evidence.reusedFromSha = ciReuse.reusedFromSha;
|
|
evidence.reusedRunId = ciReuse.reusedRunId;
|
|
evidence.patchIdMatched = true;
|
|
}
|
|
if (selected.fallbackCoveredWorkflows.length > 0) {
|
|
evidence.fallbackCoveredWorkflows = selected.fallbackCoveredWorkflows;
|
|
}
|
|
return evidence;
|
|
}
|
|
|
|
export function workflowRunQueryPaths(repo, { sha, recentSha, headBranch }, page = 1) {
|
|
const pageSuffix = `per_page=${WORKFLOW_RUNS_PAGE_SIZE}&page=${page}`;
|
|
const shas = [...new Set([sha, recentSha].filter(Boolean))];
|
|
const queries = shas.map(
|
|
(headSha) => `repos/${repo}/actions/runs?head_sha=${encodeURIComponent(headSha)}&${pageSuffix}`,
|
|
);
|
|
if (headBranch) {
|
|
queries.push(
|
|
`repos/${repo}/actions/runs?branch=${encodeURIComponent(headBranch)}&event=pull_request&${pageSuffix}`,
|
|
);
|
|
}
|
|
return queries;
|
|
}
|
|
|
|
function loadWorkflowRunsForQuery(queryForPage) {
|
|
const loadPage = (page) =>
|
|
parseWorkflowRunPage(
|
|
execGhApiRead(queryForPage(page), {
|
|
encoding: "utf8",
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
}),
|
|
);
|
|
|
|
// Bound every SHA query to GitHub's documented search window.
|
|
const firstPage = loadPage(1);
|
|
const workflowRuns = [...firstPage.workflowRuns];
|
|
for (let page = 2; page <= workflowRunPageCount(firstPage.totalCount); page += 1) {
|
|
workflowRuns.push(...loadPage(page).workflowRuns);
|
|
}
|
|
return workflowRuns;
|
|
}
|
|
|
|
function loadWorkflowRuns(repo, sha, recentSha, headBranch) {
|
|
const queries = workflowRunQueryPaths(repo, { sha, recentSha, headBranch });
|
|
const withPage = (query, page) => query.replace(/page=1$/u, `page=${page}`);
|
|
const workflowRuns = queries.flatMap((query) =>
|
|
loadWorkflowRunsForQuery((page) => withPage(query, page)),
|
|
);
|
|
return [...new Map(workflowRuns.map((run) => [run.id, run])).values()];
|
|
}
|
|
|
|
function loadCiReuseCandidateRuns(repo, headBranch) {
|
|
const raw = execFileSync(
|
|
"gh",
|
|
[
|
|
"run",
|
|
"list",
|
|
"--repo",
|
|
repo,
|
|
"--workflow",
|
|
"ci.yml",
|
|
"--branch",
|
|
headBranch,
|
|
"--limit",
|
|
String(CI_REUSE_RUN_LIST_LIMIT),
|
|
"--json",
|
|
"databaseId,workflowName,headSha,headBranch,event,status,conclusion,createdAt,updatedAt,url,displayTitle",
|
|
],
|
|
{
|
|
encoding: "utf8",
|
|
env: plainGhEnv(),
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
},
|
|
);
|
|
const runs = JSON.parse(stripAnsi(raw));
|
|
if (!Array.isArray(runs)) {
|
|
throw new Error("Expected gh run list to return an array.");
|
|
}
|
|
// The workflow selector above supplies the path identity that the REST
|
|
// release-gate matcher normally reads from each full workflow-run object.
|
|
return runs.map((run) => ({
|
|
id: run.databaseId,
|
|
name: run.workflowName,
|
|
event: run.event,
|
|
status: run.status,
|
|
conclusion: run.conclusion,
|
|
head_sha: run.headSha,
|
|
head_branch: run.headBranch,
|
|
path: CI_WORKFLOW_PATH,
|
|
created_at: run.createdAt,
|
|
updated_at: run.updatedAt,
|
|
html_url: run.url,
|
|
display_title: run.displayTitle,
|
|
}));
|
|
}
|
|
|
|
export function compareCommitPageCount(totalCommits) {
|
|
if (!Number.isSafeInteger(totalCommits) || totalCommits < 0) {
|
|
throw new Error("Expected comparison total_commits to be a non-negative integer.");
|
|
}
|
|
return Math.max(1, Math.ceil(totalCommits / COMPARE_COMMITS_PAGE_SIZE));
|
|
}
|
|
|
|
function loadPullRequestCommitShas(repo, { baseSha, headSha }) {
|
|
const loadPage = (page) =>
|
|
JSON.parse(
|
|
execGhApiRead(
|
|
`repos/${repo}/compare/${baseSha}...${headSha}?per_page=${COMPARE_COMMITS_PAGE_SIZE}&page=${page}`,
|
|
{
|
|
encoding: "utf8",
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
},
|
|
),
|
|
);
|
|
|
|
// The PR commits endpoint stops at 250. GitHub's paginated comparison is
|
|
// equivalent to git log BASE..HEAD and keeps the membership proof complete.
|
|
const firstPage = loadPage(1);
|
|
const pages = [firstPage];
|
|
for (let page = 2; page <= compareCommitPageCount(firstPage?.total_commits); page += 1) {
|
|
pages.push(loadPage(page));
|
|
}
|
|
const shas = pages.flatMap((comparison, index) => {
|
|
if (!Array.isArray(comparison?.commits)) {
|
|
throw new Error(`Expected comparison commit page ${index + 1} to be an array.`);
|
|
}
|
|
return comparison.commits.map((commit) => commit?.sha).filter(Boolean);
|
|
});
|
|
if (shas.length !== firstPage.total_commits) {
|
|
throw new Error(
|
|
`Expected ${firstPage.total_commits} comparison commits, received ${shas.length}.`,
|
|
);
|
|
}
|
|
return shas;
|
|
}
|
|
|
|
function loadCiGateJobs(repo, workflowRuns, sha, nowMs = Date.now()) {
|
|
// Only an in-progress exact-head CI run can benefit from gate proof.
|
|
const candidates = workflowRuns.filter(
|
|
(run) =>
|
|
run?.name === "CI" &&
|
|
run?.head_sha === sha &&
|
|
(run?.status === "in_progress" || run?.status === "queued") &&
|
|
isRecentRun(run, nowMs),
|
|
);
|
|
return candidates.flatMap((run) => {
|
|
const attempt = run.run_attempt ?? 1;
|
|
// The jobs endpoint pages at 100 and full-scope runs already sit near
|
|
// that; page until the gate job is visible so growth past one page can
|
|
// never silently disable the early-proof path.
|
|
const jobs = [];
|
|
for (let page = 1; page <= 5; page += 1) {
|
|
const payload = JSON.parse(
|
|
execGhApiRead(
|
|
`repos/${repo}/actions/runs/${run.id}/attempts/${attempt}/jobs?per_page=100&page=${page}`,
|
|
{ encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] },
|
|
),
|
|
);
|
|
const pageJobs = Array.isArray(payload?.jobs) ? payload.jobs : [];
|
|
jobs.push(...pageJobs);
|
|
const totalCount = Number(payload?.total_count ?? 0);
|
|
if (
|
|
pageJobs.length === 0 ||
|
|
jobs.length >= totalCount ||
|
|
jobs.some((job) => job?.name === CI_GATE_CHECK_NAME)
|
|
) {
|
|
break;
|
|
}
|
|
}
|
|
// Re-read the run after fetching its attempt jobs and drop the evidence if
|
|
// the attempt advanced in between: otherwise a rerun starting in that
|
|
// window would let the just-fetched prior-attempt gate vouch for an
|
|
// attempt that has not reached its own gate. Same-attempt completion is
|
|
// fine — a run that finished successfully still proves this attempt, and
|
|
// a non-success completion must not be blessed by its own earlier gate.
|
|
const current = JSON.parse(
|
|
execGhApiRead(`repos/${repo}/actions/runs/${run.id}`, {
|
|
encoding: "utf8",
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
}),
|
|
);
|
|
const sameAttempt = (current?.run_attempt ?? attempt) === attempt;
|
|
const stillPending = current?.status === "in_progress" || current?.status === "queued";
|
|
const completedSuccess = current?.status === "completed" && current?.conclusion === "success";
|
|
if (!sameAttempt || (!stillPending && !completedSuccess)) {
|
|
return [];
|
|
}
|
|
return jobs;
|
|
});
|
|
}
|
|
|
|
function main(argv = process.argv.slice(2)) {
|
|
const args = parseArgs(argv);
|
|
const pullRequest = JSON.parse(
|
|
execGhApiRead(`repos/${args.repo}/pulls/${args.pr}`, {
|
|
encoding: "utf8",
|
|
stdio: ["ignore", "pipe", "pipe"],
|
|
}),
|
|
);
|
|
const headBranch = pullRequest?.head?.ref;
|
|
const headRepository = pullRequest?.head?.repo?.full_name;
|
|
const baseSha = pullRequest?.base?.sha;
|
|
const headSha = pullRequest?.head?.sha;
|
|
if (!headBranch || !headRepository || !baseSha || !headSha) {
|
|
throw new Error(`PR #${args.pr} is missing head or base metadata.`);
|
|
}
|
|
if (headSha !== args.sha) {
|
|
throw new Error(`PR #${args.pr} head changed from ${args.sha} to ${headSha}.`);
|
|
}
|
|
const workflowRuns = loadWorkflowRuns(args.repo, args.sha, args.recentSha, headBranch);
|
|
const evidence = collectHostedGateEvidence({
|
|
sha: args.sha,
|
|
pr: args.pr,
|
|
recentSha: args.recentSha,
|
|
pullRequestCommitShas: loadPullRequestCommitShas(args.repo, { baseSha, headSha }),
|
|
pullRequestHeadBranch: headBranch,
|
|
pullRequestHeadRepository: headRepository,
|
|
workflowRuns,
|
|
ciGateJobs: loadCiGateJobs(args.repo, workflowRuns, args.sha),
|
|
loadCiReuseCandidates: () => loadCiReuseCandidateRuns(args.repo, headBranch),
|
|
changelogOnly: args.changelogOnly,
|
|
});
|
|
const evidenceHeadSha = evidence.evidenceHeadSha ?? args.sha;
|
|
const manifest = {
|
|
schemaVersion: 2,
|
|
generatedAt: new Date().toISOString(),
|
|
repo: args.repo,
|
|
pullRequestNumber: args.pr,
|
|
selection: {
|
|
mode: evidence.patchIdMatched
|
|
? "patch-identical-pre-rebase"
|
|
: evidenceHeadSha === args.sha
|
|
? "exact-head"
|
|
: "recent-pr-head",
|
|
maxAgeHours: HOSTED_GATE_MAX_AGE_HOURS,
|
|
},
|
|
...evidence,
|
|
};
|
|
mkdirSync(path.dirname(args.output), { recursive: true });
|
|
writeFileSync(args.output, `${JSON.stringify(manifest, null, 2)}\n`);
|
|
if (evidence.patchIdMatched) {
|
|
const reusedRun = manifest.workflows.find((workflow) => workflow.id === evidence.reusedRunId);
|
|
const updatedAtMs = runUpdatedAtMs({ updated_at: reusedRun?.updatedAt });
|
|
const ageHours =
|
|
updatedAtMs === null
|
|
? "unknown"
|
|
: `${(Math.max(0, Date.now() - updatedAtMs) / (60 * 60 * 1_000)).toFixed(1)}h`;
|
|
console.log(
|
|
`hosted CI reused from patch-identical pre-rebase head ${evidence.reusedFromSha} (run ${evidence.reusedRunId}, age ${ageHours})`,
|
|
);
|
|
}
|
|
console.log(
|
|
`Hosted gates passed for PR #${args.pr} at ${args.sha} using ${evidenceHeadSha}: ${manifest.workflows
|
|
.map((workflow) => `${workflow.name}#${workflow.id}`)
|
|
.join(", ")}`,
|
|
);
|
|
}
|
|
|
|
if (isDirectRunUrl(process.argv[1], import.meta.url)) {
|
|
main();
|
|
}
|