Files
copilotkit--copilotkit/scripts/validate-integration-pins.ts
2026-07-13 12:58:18 +08:00

103 lines
3.1 KiB
TypeScript

import * as fs from "node:fs";
import * as path from "node:path";
// SCOPE DECISION (2026-04-28, Uli + Martha):
// This validator is currently scoped to ADK only. The 14 other integrations
// (a2a-*, agno, crewai-*, langgraph-*, llamaindex, mastra, mcp-apps,
// ms-agent-*, pydantic-ai, strands-python) are still on stale @copilotkit/*
// pins, but bumping them all in one sweep without per-framework QA testing
// is too risky for the demo timeline. They will be added to ENFORCED as
// each framework is cleared by QA.
//
// The structural fix (release-please automation that bumps all integrations
// in lockstep on each release) is tracked in CPK-7534. Once that lands and
// every framework has been QA'd against the current SDK, this allowlist
// goes away in favor of "enforce all (except agent-spec, which intentionally
// uses a pre-release pin)".
const ENFORCED = new Set<string>(["adk"]);
export interface PinViolation {
integration: string;
dep: string;
pinned: string;
reason: "stale" | "floating-tag" | "non-exact";
}
export interface ValidateOptions {
expectedVersion: string;
integrationsDir: string;
/** Override the default allowlist. Useful for tests. */
enforced?: Set<string>;
}
const STABLE_SEMVER = /^\d+\.\d+\.\d+$/;
const PRE_RELEASE = /-/;
const COPILOTKIT_SCOPE = "@copilotkit/";
export function validatePins({
expectedVersion,
integrationsDir,
enforced = ENFORCED,
}: ValidateOptions): PinViolation[] {
const violations: PinViolation[] = [];
const entries = fs.readdirSync(integrationsDir, { withFileTypes: true });
for (const entry of entries) {
if (!entry.isDirectory()) continue;
if (!enforced.has(entry.name)) continue;
const pkgPath = path.join(integrationsDir, entry.name, "package.json");
if (!fs.existsSync(pkgPath)) continue;
const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
const allDeps = {
...(pkg.dependencies ?? {}),
...(pkg.devDependencies ?? {}),
};
for (const [dep, value] of Object.entries(allDeps)) {
if (!dep.startsWith(COPILOTKIT_SCOPE)) continue;
const pinned = value as string;
// Pre-release pins (e.g. 0.0.0-ag-ui-pre-x) are intentional opt-outs.
if (PRE_RELEASE.test(pinned)) continue;
if (!STABLE_SEMVER.test(pinned)) {
violations.push({
integration: entry.name,
dep,
pinned,
reason:
pinned === "latest" || pinned === "next"
? "floating-tag"
: "non-exact",
});
continue;
}
if (pinned !== expectedVersion) {
violations.push({
integration: entry.name,
dep,
pinned,
reason: "stale",
});
}
}
}
return violations;
}
export function formatViolations(
violations: PinViolation[],
expectedVersion: string,
): string {
if (violations.length === 0) return "";
const lines = violations.map(
(v) =>
` [${v.reason}] ${v.integration}: ${v.dep}@${v.pinned} (expected ${expectedVersion})`,
);
return `Found ${violations.length} stale pin(s):\n${lines.join("\n")}`;
}