Derive the remediation from WHICH copies are vulnerable, not from whether the package is declared. A manifest can declare a safe `pkg@4` while a dependency drags a vulnerable `pkg@3` into a nested folder; the old boolean called that "direct" and asked for a range bump that would have changed nothing, omitting the override the nested copy needs. - `lockfileEntries` keeps each copy's tree path and whether it is the hoisted one; `lockfileVersions` is now derived from it. - `remediation(affected, declared)` returns both flags, so the issue can ask for a range bump, an overrides pin, or explicitly both. The body lists the vulnerable copies and their paths. - An undeclared hoisted copy counts as transitive: it got there the same way any other transitive copy did, and no declared range reaches it. (Found by a test written for this change.) The `vulnerability-alerts: read` finding is declined — verified against a real runner, which reports `VulnerabilityAlerts: read` and reads the alerts successfully. See the PR comment for the log. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013H6Cew3KB3jVmQ5x4Dq1sq Signed-off-by: cliffhall <cliff@futurescale.com>
941 lines
34 KiB
JavaScript
941 lines
34 KiB
JavaScript
#!/usr/bin/env node
|
|
// Dependabot alert sweep (#2233), the alert-consuming half of #2229.
|
|
//
|
|
// Dependabot's SECURITY-update PRs are turned off in repo settings; its alerts
|
|
// stay on. This script is what consumes them:
|
|
//
|
|
// alert -> scheduled sweep -> issue (labeled, milestoned, boarded) -> maintainer PR -> v2/main
|
|
//
|
|
// A Dependabot-opened PR carries no `Closes #N` and no board card, which is the
|
|
// carve-out from "every PR references an issue" that #2229 exists to remove.
|
|
// The version-update half was removed outright in #2235 and replaced by
|
|
// `dependency-refresh.mjs`; this is the security half, and it files issues
|
|
// rather than PRs for the same reason.
|
|
//
|
|
// Three things shape the design, each verified against this repo before it was
|
|
// written:
|
|
//
|
|
// 1. There is no `dependabot_alert` WORKFLOW trigger — it is a webhook event
|
|
// only — so this is a scheduled sweep, not event-driven. Daily is enough;
|
|
// alerts are not minute-sensitive.
|
|
// 2. `GITHUB_TOKEN` can read alerts with `vulnerability-alerts: read`, so no
|
|
// PAT is needed for the sweep itself. Two side steps DO need one, and both
|
|
// degrade rather than block: writing the board card (an org project is
|
|
// outside `GITHUB_TOKEN`'s reach — an unboarded-but-milestoned issue is
|
|
// swept into Todo by the next `/issue-triage` pass), and reading back the
|
|
// `automated-security-fixes` setting (`administration: read`, which
|
|
// `permissions:` cannot grant at all — so that guard reports UNVERIFIED
|
|
// rather than failing when the token cannot see it).
|
|
// 3. Alerts are per-ADVISORY but a fix is per-BUMP. Today's seven open alerts
|
|
// are three `overrides` entries, so grouping by
|
|
// `(package, manifest_path, first_patched_version)` is what keeps this from
|
|
// filing seven issues for three pieces of work.
|
|
//
|
|
// ⚠️ GitHub computes the dependency graph — and therefore every alert — from
|
|
// the DEFAULT branch (`main`), while we ship from `v2/main`. So an alert is not
|
|
// trusted on its face: the vulnerable range is re-checked against `v2/main`'s
|
|
// own lockfile before anything is filed. The blind spot that leaves is stated
|
|
// plainly in the workflow header: a vulnerable dependency introduced on
|
|
// `v2/main` and not yet merged to `main` produces no alert at all, and no
|
|
// approach that consumes GitHub's alerts can see it. The release-time
|
|
// `npm audit --audit-level=high` report (#2231) is the partial second signal.
|
|
//
|
|
// Idempotency key is the marker comment at the top of each issue body, which
|
|
// names the package, the manifest and every GHSA the issue covers. A second run
|
|
// the same day is a complete no-op; a NEW advisory for a package that already
|
|
// has an open issue lands as a comment on it and rewrites the marker, rather
|
|
// than filing a second issue.
|
|
//
|
|
// Everything here is covered by `dependabot-alerts.test.mjs`: the pure halves
|
|
// directly, and `main()` through an injected spawn function, the same way
|
|
// `dependency-refresh.mjs` does it. `workflow_dispatch` is a production
|
|
// trigger, not a test, so the orchestration that handles API failures, lockfile
|
|
// filtering, issue idempotency and partial board writes is exercised here
|
|
// rather than left to a real run (Copilot).
|
|
|
|
import { spawnSync } from "node:child_process";
|
|
import { readFileSync } from "node:fs";
|
|
import semver from "semver";
|
|
|
|
/** Board #28 (v2). The project and field node ids are stable; option ids are not. */
|
|
export const PROJECT_ID = "PVT_kwDOCt2Azc4BJVxt";
|
|
export const STATUS_FIELD_ID = "PVTSSF_lADOCt2Azc4BJVxtzg5iI8c";
|
|
export const PRIORITY_FIELD_ID = "PVTSSF_lADOCt2Azc4BJVxtzg5iJE4";
|
|
/**
|
|
* Option ids are regenerated whenever a single-select field's option list is
|
|
* edited, so they are resolved by NAME at run time rather than hardcoded here —
|
|
* a hardcoded id turns an unrelated board edit into a silently mis-set field.
|
|
*/
|
|
export const BOARD_STATUS = "Todo";
|
|
export const BOARD_PRIORITY = "High";
|
|
|
|
/**
|
|
* The branch this repo actually ships from, and whose lockfiles are probed.
|
|
*
|
|
* The workflow checks this branch out, so manifests are read from the working
|
|
* tree rather than through `git show` — the same shape `dependency-refresh.mjs`
|
|
* uses to run `npm outdated` against it. Named here only so the issue body can
|
|
* say which branch the versions it quotes came from.
|
|
*/
|
|
export const TARGET_BRANCH = "v2/main";
|
|
|
|
const MARKER_RE =
|
|
/^<!-- dependabot-alerts: pkg=(.+?); manifest=(.+?); fixed=(.+?); ghsas=(.+?) -->/;
|
|
|
|
/** Marker on the comment that announces newly-seen advisories, keyed by GHSA. */
|
|
const COMMENT_MARKER_RE = /^<!-- dependabot-alerts:added (.+?) -->/;
|
|
|
|
/**
|
|
* The issue body's first line: the idempotency key.
|
|
*
|
|
* It carries `fixedIn` as well as the package and manifest because that triple
|
|
* IS the grouping key — two advisories on one package needing different patched
|
|
* versions are different bumps and get different issues. Keyed on the pair
|
|
* alone, a second bump would match the first issue and merge its GHSAs and its
|
|
* target version into the wrong one (Copilot).
|
|
*
|
|
* @param {{package: string, manifestPath: string, fixedIn: string, ghsas: string[]}} group
|
|
* @returns {string}
|
|
*/
|
|
export function buildMarker({ package: pkg, manifestPath, fixedIn, ghsas }) {
|
|
return `<!-- dependabot-alerts: pkg=${pkg}; manifest=${manifestPath}; fixed=${fixedIn}; ghsas=${[...ghsas].sort().join(",")} -->`;
|
|
}
|
|
|
|
/**
|
|
* Read a marker back off an issue body.
|
|
*
|
|
* @param {string | undefined} body
|
|
* @returns {{package: string, manifestPath: string, fixedIn: string, ghsas: string[]} | null}
|
|
*/
|
|
export function parseMarker(body) {
|
|
const match = MARKER_RE.exec(body ?? "");
|
|
if (!match) return null;
|
|
return {
|
|
package: match[1],
|
|
manifestPath: match[2],
|
|
fixedIn: match[3],
|
|
ghsas: match[4].split(",").filter(Boolean),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* The GHSAs a previously-posted "new advisories" comment already announced.
|
|
*
|
|
* @param {string | undefined} body
|
|
* @returns {string[] | null} `null` when the comment carries no marker
|
|
*/
|
|
export function parseCommentMarker(body) {
|
|
const match = COMMENT_MARKER_RE.exec(body ?? "");
|
|
if (!match) return null;
|
|
return match[1].split(",").filter(Boolean);
|
|
}
|
|
|
|
/**
|
|
* Which of `group`'s advisories the existing issue does not already name.
|
|
*
|
|
* @param {string[]} existing the marker's GHSA list
|
|
* @param {string[]} incoming the GHSAs the sweep just saw
|
|
* @returns {{merged: string[], added: string[]}} both sorted
|
|
*/
|
|
export function mergeGhsas(existing, incoming) {
|
|
const known = new Set(existing);
|
|
const added = [...new Set(incoming.filter((g) => !known.has(g)))].sort();
|
|
const merged = [...new Set([...existing, ...incoming])].sort();
|
|
return { merged, added };
|
|
}
|
|
|
|
/**
|
|
* Translate a GitHub `vulnerable_version_range` into a range npm `semver`
|
|
* understands.
|
|
*
|
|
* ⚠️ GitHub separates conjuncts with a COMMA (`>= 3.1.3, < 3.1.6`); node-semver
|
|
* reads a comma as nothing at all and quietly returns `false` for a version
|
|
* that is in fact in range. Space is semver's AND, so the fix is a split/join —
|
|
* but the failure it prevents is silent, which is why this is its own tested
|
|
* function rather than an inline `.replace`.
|
|
*
|
|
* @param {string} range
|
|
* @returns {string}
|
|
*/
|
|
export function toSemverRange(range) {
|
|
return range
|
|
.split(",")
|
|
.map((part) => part.trim())
|
|
.filter(Boolean)
|
|
.join(" ");
|
|
}
|
|
|
|
/**
|
|
* Every installed copy of `pkg` in an npm lockfile, with its tree path.
|
|
*
|
|
* A package can legitimately appear more than once — a hoisted
|
|
* `node_modules/x` plus one or more nested `node_modules/y/node_modules/x` —
|
|
* and the copies can be at DIFFERENT versions. The path is kept rather than
|
|
* just the version because it is what distinguishes the copy the manifest
|
|
* declares from a copy some dependency dragged in, and the fix for those two
|
|
* is not the same (Copilot).
|
|
*
|
|
* @param {object} lock parsed `package-lock.json` (lockfileVersion 2 or 3)
|
|
* @param {string} pkg
|
|
* @returns {Array<{path: string, version: string, hoisted: boolean}>} sorted by version
|
|
*/
|
|
export function lockfileEntries(lock, pkg) {
|
|
const hoistedPath = `node_modules/${pkg}`;
|
|
const entries = [];
|
|
for (const [path, entry] of Object.entries(lock.packages ?? {})) {
|
|
if (path !== hoistedPath && !path.endsWith(`/${hoistedPath}`)) continue;
|
|
if (!entry?.version) continue;
|
|
entries.push({
|
|
path,
|
|
version: entry.version,
|
|
hoisted: path === hoistedPath,
|
|
});
|
|
}
|
|
return entries.sort(
|
|
(a, b) =>
|
|
semver.compare(a.version, b.version) || a.path.localeCompare(b.path),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Every version of `pkg` installed anywhere in an npm lockfile.
|
|
*
|
|
* @param {object} lock parsed `package-lock.json` (lockfileVersion 2 or 3)
|
|
* @param {string} pkg
|
|
* @returns {string[]} sorted, deduped
|
|
*/
|
|
export function lockfileVersions(lock, pkg) {
|
|
return [...new Set(lockfileEntries(lock, pkg).map((e) => e.version))].sort(
|
|
semver.compare,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Is `pkg` declared by the manifest itself, rather than pulled in transitively?
|
|
*
|
|
* ⚠️ Being declared is NOT by itself the question the issue needs answered —
|
|
* see `remediation` below. A manifest can declare a safe `pkg@^4` while some
|
|
* dependency drags a vulnerable `pkg@3` into a nested folder, and telling the
|
|
* maintainer to raise an already-safe range would leave the vulnerable copy
|
|
* exactly where it is (Copilot).
|
|
*
|
|
* @param {object} lock parsed `package-lock.json`
|
|
* @param {string} pkg
|
|
* @returns {boolean}
|
|
*/
|
|
export function isDirectDependency(lock, pkg) {
|
|
const root = lock.packages?.[""] ?? {};
|
|
return Boolean(
|
|
root.dependencies?.[pkg] ??
|
|
root.devDependencies?.[pkg] ??
|
|
root.optionalDependencies?.[pkg] ??
|
|
root.peerDependencies?.[pkg],
|
|
);
|
|
}
|
|
|
|
const SEVERITY_RANK = { critical: 4, high: 3, medium: 2, moderate: 2, low: 1 };
|
|
|
|
/**
|
|
* Collapse per-advisory alerts into one entry per BUMP.
|
|
*
|
|
* Grouped by `(package, manifest_path, first_patched_version)`: that triple is
|
|
* one edit to one manifest, which is the unit a maintainer actually acts on.
|
|
* Two advisories on the same package with different patched versions are
|
|
* different bumps and stay apart.
|
|
*
|
|
* @param {object[]} alerts raw `GET /repos/{o}/{r}/dependabot/alerts` entries
|
|
* @returns {Array<{key: string, package: string, manifestPath: string, fixedIn: string, scope: string, severity: string, ghsas: string[], advisories: Array<{ghsa: string, cve: string | null, severity: string, summary: string, range: string, url: string}>}>}
|
|
*/
|
|
export function groupAlerts(alerts) {
|
|
const groups = new Map();
|
|
for (const alert of alerts) {
|
|
if (alert.state !== "open") continue;
|
|
const pkg = alert.dependency?.package?.name;
|
|
const manifestPath = alert.dependency?.manifest_path;
|
|
const fixedIn =
|
|
alert.security_vulnerability?.first_patched_version?.identifier;
|
|
// No patched version means there is nothing to bump TO — an issue asking
|
|
// for an unavailable upgrade is noise, so it waits for one to be published.
|
|
if (!pkg || !manifestPath || !fixedIn) continue;
|
|
|
|
// JSON rather than a delimited string: the three fields are free-form,
|
|
// so any separator has to be argued for — and the one that was here was
|
|
// a literal NUL, which classified the whole source file as binary and
|
|
// made repository searches skip it (Copilot).
|
|
const key = JSON.stringify([pkg, manifestPath, fixedIn]);
|
|
const advisory = {
|
|
ghsa: alert.security_advisory?.ghsa_id ?? "",
|
|
cve: alert.security_advisory?.cve_id ?? null,
|
|
severity: alert.security_advisory?.severity ?? "unknown",
|
|
summary: alert.security_advisory?.summary ?? "",
|
|
range: alert.security_vulnerability?.vulnerable_version_range ?? "*",
|
|
url: alert.html_url ?? "",
|
|
};
|
|
|
|
const existing = groups.get(key);
|
|
if (existing) {
|
|
existing.advisories.push(advisory);
|
|
if (
|
|
(SEVERITY_RANK[advisory.severity] ?? 0) >
|
|
(SEVERITY_RANK[existing.severity] ?? 0)
|
|
) {
|
|
existing.severity = advisory.severity;
|
|
}
|
|
continue;
|
|
}
|
|
groups.set(key, {
|
|
key,
|
|
package: pkg,
|
|
manifestPath,
|
|
fixedIn,
|
|
scope: alert.dependency?.scope ?? "runtime",
|
|
severity: advisory.severity,
|
|
advisories: [advisory],
|
|
});
|
|
}
|
|
|
|
return [...groups.values()]
|
|
.map((group) => {
|
|
group.advisories.sort((a, b) => a.ghsa.localeCompare(b.ghsa));
|
|
group.ghsas = group.advisories.map((a) => a.ghsa);
|
|
return group;
|
|
})
|
|
.sort(
|
|
(a, b) =>
|
|
a.package.localeCompare(b.package) ||
|
|
a.manifestPath.localeCompare(b.manifestPath) ||
|
|
a.fixedIn.localeCompare(b.fixedIn),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param {ReturnType<typeof groupAlerts>[number]} group
|
|
* @param {number} [count] advisories the issue covers, when that is more than
|
|
* this run saw — an issue grown by a later advisory keeps one title.
|
|
* @returns {string}
|
|
*/
|
|
export function buildIssueTitle(group, count = group.advisories.length) {
|
|
const n = count;
|
|
return `chore(deps): bump \`${group.package}\` to \`${group.fixedIn}\` in \`${group.manifestPath}\` (${n} ${n === 1 ? "advisory" : "advisories"})`;
|
|
}
|
|
|
|
const PLACEMENT_DOC =
|
|
"https://github.com/modelcontextprotocol/inspector/blob/v2/main/AGENTS.md#dependency-placement";
|
|
|
|
/**
|
|
* What the maintainer actually has to change, derived from WHICH copies are
|
|
* vulnerable rather than from whether the package is declared.
|
|
*
|
|
* The three cases are genuinely different edits, and the mixed one is why this
|
|
* is not a boolean (Copilot):
|
|
*
|
|
* | vulnerable copies | fix |
|
|
* | --- | --- |
|
|
* | the declared (hoisted) one | raise the declared range |
|
|
* | nested ones only | an `overrides` pin |
|
|
* | both | both, and neither alone is enough |
|
|
*
|
|
* A manifest declaring a safe `pkg@^4` alongside a dependency that drags in a
|
|
* vulnerable nested `pkg@3` lands in the middle row: the declared range is
|
|
* already correct, and raising it changes nothing.
|
|
*
|
|
* @param {Array<{path: string, version: string, hoisted: boolean}>} affected
|
|
* @param {boolean} declared whether the manifest declares the package
|
|
* @returns {{direct: boolean, transitive: boolean}}
|
|
*/
|
|
export function remediation(affected, declared) {
|
|
const isDeclaredCopy = (entry) => declared && entry.hoisted;
|
|
return {
|
|
direct: affected.some(isDeclaredCopy),
|
|
// Everything that is NOT the declared copy needs the override — nested
|
|
// copies, and also a hoisted copy of a package this manifest never
|
|
// declared, which got there transitively like any other.
|
|
transitive: affected.some((entry) => !isDeclaredCopy(entry)),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @param {ReturnType<typeof groupAlerts>[number]} group
|
|
* @param {{affected: Array<{path: string, version: string, hoisted: boolean}>, declared: boolean, ghsas?: string[]}} probe
|
|
* `ghsas` overrides the marker's list when an existing issue is being
|
|
* rewritten to cover advisories it did not originally name.
|
|
* @returns {string}
|
|
*/
|
|
export function buildIssueBody(group, { affected, declared, ghsas }) {
|
|
const covered = ghsas ?? group.ghsas;
|
|
const rows = group.advisories
|
|
.map(
|
|
(a) =>
|
|
`| [${a.ghsa}](${a.url}) | ${a.cve ?? "—"} | ${a.severity} | ${a.range} | ${a.summary.replace(/\|/g, "\\|")} |`,
|
|
)
|
|
.join("\n");
|
|
|
|
const manifestJson = group.manifestPath.replace(
|
|
/package-lock\.json$/,
|
|
"package.json",
|
|
);
|
|
const { direct, transitive } = remediation(affected, declared);
|
|
const steps = [];
|
|
if (direct) {
|
|
steps.push(
|
|
`**Raise the declared range in \`${manifestJson}\`** so \`${group.package}\` can no longer resolve below \`${group.fixedIn}\`, keeping the operator the manifest already uses — widening it to a bare \`>=\` would drop the compatibility bound with it.`,
|
|
);
|
|
}
|
|
if (transitive) {
|
|
steps.push(
|
|
`**Add an [\`overrides\`](${PLACEMENT_DOC}) entry** pinning \`${group.package}\` to \`${group.fixedIn}\`, for the ${direct ? "nested copies below, which the declared range does not reach" : "copies below, which no declared range reaches"}. **Not** \`npm audit fix\`, which "resolves" an advisory with no upward escape by silently downgrading.`,
|
|
);
|
|
}
|
|
const fix = [
|
|
...(steps.length === 2
|
|
? [
|
|
"Both edits are needed; neither alone clears every vulnerable copy.",
|
|
"",
|
|
]
|
|
: []),
|
|
...steps.map((step, i) => (steps.length > 1 ? `${i + 1}. ${step}` : step)),
|
|
"",
|
|
"| Vulnerable copy | Version |",
|
|
"| --- | --- |",
|
|
...affected.map((e) => `| \`${e.path}\` | \`${e.version}\` |`),
|
|
].join("\n");
|
|
|
|
return [
|
|
buildMarker({ ...group, ghsas: covered }),
|
|
`Filed automatically from ${covered.length} open Dependabot ${covered.length === 1 ? "alert" : "alerts"} (#2233). Dependabot opens no security-update PRs on this repo; the fix is written by hand against \`v2/main\`.`,
|
|
"",
|
|
"| | |",
|
|
"| --- | --- |",
|
|
`| Package | \`${group.package}\` |`,
|
|
`| Manifest | \`${group.manifestPath}\` |`,
|
|
`| Vulnerable on \`${TARGET_BRANCH}\` | ${[...new Set(affected.map((e) => e.version))].map((v) => `\`${v}\``).join(", ") || "—"} |`,
|
|
`| Fixed in | \`${group.fixedIn}\` |`,
|
|
`| Scope | ${group.scope} |`,
|
|
`| Highest severity | ${group.severity} |`,
|
|
"",
|
|
"## Advisories",
|
|
"",
|
|
"| GHSA | CVE | Severity | Vulnerable range | Summary |",
|
|
"| --- | --- | --- | --- | --- |",
|
|
rows,
|
|
"",
|
|
"## Fix",
|
|
"",
|
|
fix,
|
|
"",
|
|
"> [!NOTE]",
|
|
`> **Priority is a standing rubric override.** A routine bump scores Medium; a security bump is filed **${BOARD_PRIORITY}** so it does not sit. The version and severity above come from \`${TARGET_BRANCH}\`'s own lockfile, not from the alert — GitHub computes alerts from the default branch, so an alert is only filed here after its vulnerable range is re-checked against the branch we ship from.`,
|
|
].join("\n");
|
|
}
|
|
|
|
/**
|
|
* The marker that makes a "new advisories" comment idempotent on its own.
|
|
*
|
|
* @param {string[]} added
|
|
* @returns {string}
|
|
*/
|
|
export function buildCommentMarker(added) {
|
|
return `<!-- dependabot-alerts:added ${[...added].sort().join(",")} -->`;
|
|
}
|
|
|
|
/**
|
|
* The comment a NEW advisory for an already-open issue gets, instead of a
|
|
* second issue.
|
|
*
|
|
* @param {ReturnType<typeof groupAlerts>[number]} group
|
|
* @param {string[]} added the GHSAs not previously covered
|
|
* @returns {string}
|
|
*/
|
|
export function buildNewAdvisoryComment(group, added) {
|
|
const rows = group.advisories
|
|
.filter((a) => added.includes(a.ghsa))
|
|
.map(
|
|
(a) =>
|
|
`| [${a.ghsa}](${a.url}) | ${a.severity} | ${a.summary.replace(/\|/g, "\\|")} |`,
|
|
)
|
|
.join("\n");
|
|
return [
|
|
buildCommentMarker(added),
|
|
`${added.length} new Dependabot ${added.length === 1 ? "advisory" : "advisories"} for \`${group.package}\`, cleared by the same bump to \`${group.fixedIn}\`. The issue body's marker now covers ${added.length === 1 ? "it" : "them"} too.`,
|
|
"",
|
|
"| GHSA | Severity | Summary |",
|
|
"| --- | --- | --- |",
|
|
rows,
|
|
].join("\n");
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Impure half: everything below shells out to `gh`. Each takes its spawn
|
|
// function as a parameter, defaulted to `spawnSync`, so `main()` is testable
|
|
// with an injected fake rather than left to `workflow_dispatch` — the same
|
|
// shape `dependency-refresh.mjs` uses.
|
|
// ---------------------------------------------------------------------------
|
|
|
|
function gh(spawn, args, { token } = {}) {
|
|
const env = token ? { ...process.env, GH_TOKEN: token } : process.env;
|
|
const result = spawn("gh", args, { encoding: "utf8", env });
|
|
if (result.error) throw result.error;
|
|
return result;
|
|
}
|
|
|
|
function ghJson(spawn, args) {
|
|
const result = gh(spawn, args);
|
|
if (result.status !== 0) {
|
|
throw new Error(`gh ${args[0]} failed: ${(result.stderr ?? "").trim()}`);
|
|
}
|
|
return JSON.parse(result.stdout || "null");
|
|
}
|
|
|
|
/**
|
|
* Is this failed lookup the "the token may not read this" answer, rather than a
|
|
* real API failure?
|
|
*
|
|
* The distinction is what keeps the security-PR guard honest: a bad token, a
|
|
* rate limit or a transient 5xx must NOT be waved through as "unverified", or
|
|
* the sweep exits green having silently skipped its own precondition
|
|
* (Copilot). Only an authorization-shaped status is tolerated.
|
|
*
|
|
* @param {string} stderr stderr from a non-zero `gh api` call
|
|
* @returns {boolean}
|
|
*/
|
|
export function isPermissionDenied(stderr) {
|
|
return /HTTP (401|403|404)\b/.test(stderr);
|
|
}
|
|
|
|
/**
|
|
* Detect whether Dependabot's security-update PRs have been switched back on.
|
|
*
|
|
* `automated-security-fixes` is a repo SETTING, so it can be re-enabled from
|
|
* the UI without a commit and nothing in this repo would record it. This check
|
|
* is this design's analogue of the merge guard #2060 needed: one API call
|
|
* standing in for a required status check plus a ruleset change.
|
|
*
|
|
* ⚠️ **The endpoint needs `administration: read`, which `GITHUB_TOKEN` cannot
|
|
* be granted** — `permissions:` has no such key. So with the default token the
|
|
* call 403s, and treating that as failure would make every scheduled run red
|
|
* for a reason unrelated to the alerts. An authorization-shaped failure is
|
|
* therefore reported and skipped; every other failure throws, and an explicit
|
|
* `enabled: true` throws. Give `PROJECT_TOKEN` the extra `administration: read`
|
|
* scope and the guard becomes a real assertion; without it the sweep still does
|
|
* its job, it just cannot see that setting.
|
|
*
|
|
* @returns {boolean} whether the setting was actually read
|
|
*/
|
|
function checkSecurityPrsStillDisabled(repo, spawn) {
|
|
const result = gh(spawn, ["api", `repos/${repo}/automated-security-fixes`], {
|
|
token: process.env.PROJECT_TOKEN,
|
|
});
|
|
if (result.status !== 0) {
|
|
const stderr = (result.stderr ?? "").trim();
|
|
if (!isPermissionDenied(stderr)) {
|
|
throw new Error(`automated-security-fixes lookup failed: ${stderr}`);
|
|
}
|
|
console.log(
|
|
`dependabot-alerts: cannot read automated-security-fixes (${stderr}) — ` +
|
|
"the token lacks `administration: read`, so whether Dependabot security " +
|
|
"PRs are still off is UNVERIFIED this run",
|
|
);
|
|
return false;
|
|
}
|
|
const state = JSON.parse(result.stdout || "{}");
|
|
if (state.enabled === true) {
|
|
throw new Error(
|
|
"Dependabot security-update PRs are ENABLED again. This sweep exists to replace them; " +
|
|
"an enabled setting means both flows are running and Dependabot is opening PRs with no " +
|
|
"issue and no board card. Disable it (Settings -> Code security, or " +
|
|
`DELETE /repos/${repo}/automated-security-fixes) and re-run.`,
|
|
);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Every open Dependabot alert.
|
|
*
|
|
* ⚠️ `--slurp` is load-bearing. Without it `gh api --paginate` concatenates one
|
|
* top-level JSON array PER PAGE, which `JSON.parse` rejects outright the moment
|
|
* open alerts exceed the 100-per-page limit (Copilot). With it the pages arrive
|
|
* as an array of arrays, flattened here.
|
|
*/
|
|
function openAlerts(repo, spawn) {
|
|
const pages = ghJson(spawn, [
|
|
"api",
|
|
"--paginate",
|
|
"--slurp",
|
|
`repos/${repo}/dependabot/alerts?state=open&per_page=100`,
|
|
]);
|
|
return (pages ?? []).flat();
|
|
}
|
|
|
|
/**
|
|
* A manifest's contents in the checkout, or `null` when it is absent — an alert
|
|
* against a manifest this branch does not have is not actionable.
|
|
*/
|
|
function readManifest(manifestPath) {
|
|
try {
|
|
return JSON.parse(readFileSync(manifestPath, "utf8"));
|
|
} catch (error) {
|
|
if (error.code === "ENOENT") return null;
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
function openDependabotIssues(repo, spawn) {
|
|
return (
|
|
ghJson(spawn, [
|
|
"issue",
|
|
"list",
|
|
"--repo",
|
|
repo,
|
|
"--state",
|
|
"open",
|
|
"--label",
|
|
"dependabot",
|
|
"--json",
|
|
"number,body",
|
|
"--limit",
|
|
"100",
|
|
]) ?? []
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Every GHSA already announced by a comment on an issue, unioned.
|
|
*
|
|
* Unioned per ADVISORY, not compared per comment. Comparing whole sets looks
|
|
* equivalent and is not: a run that posts `[B]` and then fails before rewriting
|
|
* the marker leaves the next run computing `[B, C]`, which matches no existing
|
|
* comment, and `B` is announced a second time (Copilot). Individual GHSAs are
|
|
* what a comment actually claims to have announced.
|
|
*/
|
|
function announcedAdvisories(repo, number, spawn) {
|
|
const issue = ghJson(spawn, [
|
|
"issue",
|
|
"view",
|
|
String(number),
|
|
"--repo",
|
|
repo,
|
|
"--json",
|
|
"comments",
|
|
]);
|
|
const announced = new Set();
|
|
for (const comment of issue?.comments ?? []) {
|
|
for (const ghsa of parseCommentMarker(comment.body) ?? []) {
|
|
announced.add(ghsa);
|
|
}
|
|
}
|
|
return announced;
|
|
}
|
|
|
|
function currentMilestone(repo, spawn) {
|
|
const result = gh(spawn, [
|
|
"api",
|
|
`repos/${repo}/milestones`,
|
|
"--jq",
|
|
'map(select(.state=="open")) | sort_by(.due_on) | .[0].title // empty',
|
|
]);
|
|
if (result.status !== 0) {
|
|
throw new Error(`milestone lookup failed: ${(result.stderr ?? "").trim()}`);
|
|
}
|
|
return result.stdout.trim() || null;
|
|
}
|
|
|
|
/**
|
|
* Resolve a single-select option id by NAME.
|
|
*
|
|
* Option ids are regenerated whenever the field's option list is edited, so
|
|
* looking them up each run is what keeps an unrelated board edit from turning
|
|
* into a silently mis-set field here.
|
|
*/
|
|
function optionId(fieldName, optionName, token, spawn) {
|
|
const result = gh(
|
|
spawn,
|
|
[
|
|
"project",
|
|
"field-list",
|
|
"28",
|
|
"--owner",
|
|
"modelcontextprotocol",
|
|
"--format",
|
|
"json",
|
|
],
|
|
{ token },
|
|
);
|
|
if (result.status !== 0) {
|
|
throw new Error(`field-list failed: ${(result.stderr ?? "").trim()}`);
|
|
}
|
|
const field = JSON.parse(result.stdout).fields.find(
|
|
(f) => f.name === fieldName,
|
|
);
|
|
const option = field?.options?.find((o) => o.name === optionName);
|
|
if (!option) {
|
|
throw new Error(
|
|
`no ${fieldName} option named "${optionName}" on board #28`,
|
|
);
|
|
}
|
|
return option.id;
|
|
}
|
|
|
|
/**
|
|
* Put the issue on board #28 at Todo / High.
|
|
*
|
|
* Failing to add the card at all is benign — the issue is already labeled and
|
|
* milestoned, which is enough for the next `/issue-triage` sweep to board it
|
|
* (its documented exception moves an unboarded-but-milestoned issue straight
|
|
* into Todo). That is why an org-project PAT is an optimization here rather
|
|
* than a prerequisite.
|
|
*
|
|
* ⚠️ **Failing PART WAY through is not benign**, and the two cases must not be
|
|
* reported the same way (Copilot). Once `item-add` succeeds the issue IS
|
|
* boarded, so no later triage sweep will look at it — a failed field edit
|
|
* leaves a card sitting on the board with no Status or no Priority, in exactly
|
|
* the state nothing else will fix. So a partial placement is returned to the
|
|
* caller, which finishes every remaining group and then fails the run.
|
|
*
|
|
* Todo rather than Incoming: arriving through this pipeline IS the approval.
|
|
*
|
|
* @returns {string | null} a description of a PARTIAL placement, else `null`
|
|
*/
|
|
function addToBoard(issueUrl, spawn) {
|
|
const token = process.env.PROJECT_TOKEN;
|
|
if (!token) {
|
|
console.log(
|
|
"dependabot-alerts: PROJECT_TOKEN unset — issue left unboarded for the next triage sweep",
|
|
);
|
|
return null;
|
|
}
|
|
|
|
let itemId;
|
|
try {
|
|
const added = gh(
|
|
spawn,
|
|
[
|
|
"project",
|
|
"item-add",
|
|
"28",
|
|
"--owner",
|
|
"modelcontextprotocol",
|
|
"--url",
|
|
issueUrl,
|
|
"--format",
|
|
"json",
|
|
],
|
|
{ token },
|
|
);
|
|
if (added.status !== 0) throw new Error((added.stderr ?? "").trim());
|
|
itemId = JSON.parse(added.stdout).id;
|
|
} catch (error) {
|
|
// Nothing was added, so the issue is simply unboarded — recoverable.
|
|
console.log(
|
|
`dependabot-alerts: board add failed (${error.message}) — issue is labeled and milestoned, next triage sweep will board it`,
|
|
);
|
|
return null;
|
|
}
|
|
|
|
// Each item-edit sets exactly one field, so Status and Priority are two calls.
|
|
for (const [fieldId, fieldName, optionName] of [
|
|
[STATUS_FIELD_ID, "Status", BOARD_STATUS],
|
|
[PRIORITY_FIELD_ID, "Priority", BOARD_PRIORITY],
|
|
]) {
|
|
try {
|
|
const edit = gh(
|
|
spawn,
|
|
[
|
|
"project",
|
|
"item-edit",
|
|
"--project-id",
|
|
PROJECT_ID,
|
|
"--id",
|
|
itemId,
|
|
"--field-id",
|
|
fieldId,
|
|
"--single-select-option-id",
|
|
optionId(fieldName, optionName, token, spawn),
|
|
],
|
|
{ token },
|
|
);
|
|
if (edit.status !== 0) throw new Error((edit.stderr ?? "").trim());
|
|
} catch (error) {
|
|
return `${issueUrl} is on board #28 but its ${fieldName} was not set (${error.message}) — no triage sweep will fix this, set it by hand`;
|
|
}
|
|
}
|
|
|
|
console.log(
|
|
`dependabot-alerts: boarded ${issueUrl} at ${BOARD_STATUS}/${BOARD_PRIORITY}`,
|
|
);
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @returns {{url: string, milestone: string | null}}
|
|
*/
|
|
function createIssue(repo, group, body, spawn) {
|
|
const milestone = currentMilestone(repo, spawn);
|
|
const args = [
|
|
"issue",
|
|
"create",
|
|
"--repo",
|
|
repo,
|
|
"--title",
|
|
buildIssueTitle(group),
|
|
"--label",
|
|
"v2",
|
|
"--label",
|
|
"chore",
|
|
"--label",
|
|
"dependabot",
|
|
"--body",
|
|
body,
|
|
];
|
|
if (milestone) args.push("--milestone", milestone);
|
|
const result = gh(spawn, args);
|
|
if (result.status !== 0) {
|
|
throw new Error(`gh issue create failed: ${(result.stderr ?? "").trim()}`);
|
|
}
|
|
const url = result.stdout.trim();
|
|
console.log(`dependabot-alerts: filed ${url}`);
|
|
return { url, milestone };
|
|
}
|
|
|
|
export function main(repo = process.env.GITHUB_REPOSITORY, spawn = spawnSync) {
|
|
if (!repo) throw new Error("repo not specified (GITHUB_REPOSITORY unset)");
|
|
|
|
checkSecurityPrsStillDisabled(repo, spawn);
|
|
|
|
const groups = groupAlerts(openAlerts(repo, spawn));
|
|
if (groups.length === 0) {
|
|
console.log("dependabot-alerts: no open alerts — no-op");
|
|
return;
|
|
}
|
|
|
|
const existingIssues = openDependabotIssues(repo, spawn).map((issue) => ({
|
|
...issue,
|
|
marker: parseMarker(issue.body),
|
|
}));
|
|
|
|
const manifests = new Map();
|
|
const boardProblems = [];
|
|
|
|
for (const group of groups) {
|
|
if (!manifests.has(group.manifestPath)) {
|
|
manifests.set(group.manifestPath, readManifest(group.manifestPath));
|
|
}
|
|
const lock = manifests.get(group.manifestPath);
|
|
if (lock === null) {
|
|
console.log(
|
|
`dependabot-alerts: ${group.manifestPath} absent on ${TARGET_BRANCH} — skipping ${group.package}`,
|
|
);
|
|
continue;
|
|
}
|
|
|
|
const entries = lockfileEntries(lock, group.package);
|
|
const affected = entries.filter((entry) =>
|
|
group.advisories.some((a) =>
|
|
semver.satisfies(entry.version, toSemverRange(a.range)),
|
|
),
|
|
);
|
|
if (affected.length === 0) {
|
|
const seen = [...new Set(entries.map((e) => e.version))];
|
|
console.log(
|
|
`dependabot-alerts: ${group.package}@${seen.join("/") || "(absent)"} is already out of range on ${TARGET_BRANCH} — skipping`,
|
|
);
|
|
continue;
|
|
}
|
|
|
|
const declared = isDirectDependency(lock, group.package);
|
|
// Matched on the full grouping key, `fixedIn` included: a second bump of
|
|
// the same package is a different issue, not an update to this one.
|
|
const existing = existingIssues.find(
|
|
(i) =>
|
|
i.marker?.package === group.package &&
|
|
i.marker?.manifestPath === group.manifestPath &&
|
|
i.marker?.fixedIn === group.fixedIn,
|
|
);
|
|
|
|
if (!existing) {
|
|
const { url, milestone } = createIssue(
|
|
repo,
|
|
group,
|
|
buildIssueBody(group, { affected, declared }),
|
|
spawn,
|
|
);
|
|
// `Incoming` <=> no milestone, everything past it <=> milestoned. With no
|
|
// open milestone to assign there is nothing to put the card past Incoming
|
|
// WITH, so boarding it at Todo would assert an approval the invariant
|
|
// reads off the milestone (Copilot). Leave it for triage instead.
|
|
if (!milestone) {
|
|
console.log(
|
|
"dependabot-alerts: no open milestone — issue filed unmilestoned and unboarded, next triage sweep places it",
|
|
);
|
|
continue;
|
|
}
|
|
const problem = addToBoard(url, spawn);
|
|
if (problem) boardProblems.push(problem);
|
|
continue;
|
|
}
|
|
|
|
const { merged, added } = mergeGhsas(existing.marker.ghsas, group.ghsas);
|
|
if (added.length === 0) {
|
|
console.log(
|
|
`dependabot-alerts: #${existing.number} already covers ${group.package} — no-op`,
|
|
);
|
|
continue;
|
|
}
|
|
|
|
// ⚠️ Comment FIRST, then rewrite the marker. The marker is the idempotency
|
|
// key, so editing it first and failing on the comment would make the next
|
|
// run take the no-op branch above and skip the comment permanently
|
|
// (Copilot). In this order the worst case is a repeat, and the comment's
|
|
// own marker rules that out too.
|
|
const announced = announcedAdvisories(repo, existing.number, spawn);
|
|
const unannounced = added.filter((ghsa) => !announced.has(ghsa));
|
|
if (unannounced.length > 0) {
|
|
const comment = gh(spawn, [
|
|
"issue",
|
|
"comment",
|
|
String(existing.number),
|
|
"--repo",
|
|
repo,
|
|
"--body",
|
|
buildNewAdvisoryComment(group, unannounced),
|
|
]);
|
|
if (comment.status !== 0) {
|
|
throw new Error(
|
|
`gh issue comment failed: ${(comment.stderr ?? "").trim()}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
// The title carries the advisory count, so it goes stale the moment the
|
|
// issue covers one more than it was filed with (Copilot).
|
|
const edit = gh(spawn, [
|
|
"issue",
|
|
"edit",
|
|
String(existing.number),
|
|
"--repo",
|
|
repo,
|
|
"--title",
|
|
buildIssueTitle(group, merged.length),
|
|
"--body",
|
|
buildIssueBody(group, { affected, declared, ghsas: merged }),
|
|
]);
|
|
if (edit.status !== 0) {
|
|
throw new Error(`gh issue edit failed: ${(edit.stderr ?? "").trim()}`);
|
|
}
|
|
console.log(
|
|
`dependabot-alerts: added ${added.join(", ")} to #${existing.number}`,
|
|
);
|
|
}
|
|
|
|
// Every group is processed before this throws: a half-placed card is worth
|
|
// failing the run over, but not at the cost of the issues still unfiled.
|
|
if (boardProblems.length > 0) {
|
|
throw new Error(
|
|
`dependabot-alerts: incomplete board placement —\n ${boardProblems.join("\n ")}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
|
main();
|
|
}
|