319 lines
13 KiB
JavaScript
319 lines
13 KiB
JavaScript
#!/usr/bin/env node
|
|
/* eslint-disable no-console */
|
|
import { spawn } from "node:child_process";
|
|
import { createHash } from "node:crypto";
|
|
import { mkdir, readdir, readFile, stat, writeFile } from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
|
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = path.resolve(__dirname, "..");
|
|
export const reportPath = path.join(repoRoot, ".tc/baselines/production-docs/baseline-health.md");
|
|
|
|
const ignoredDirectoryNames = new Set([
|
|
".git",
|
|
".cache",
|
|
".next",
|
|
".react-router",
|
|
".tc",
|
|
".turbo",
|
|
".vite",
|
|
"build",
|
|
"cache",
|
|
"coverage",
|
|
"dist",
|
|
"generated",
|
|
"node_modules",
|
|
]);
|
|
|
|
const ignoredFileNames = new Set(["package-lock.json", "pnpm-lock.yaml", "yarn.lock"]);
|
|
|
|
export const productionDocsDocumentationInventoryScanRoots = [
|
|
"README.md",
|
|
"docs/new-project.md",
|
|
"docs/configuration.md",
|
|
"docs/db-ci.md",
|
|
"docs/mail-auth.md",
|
|
"docs/deployment.md",
|
|
"docs/security/runbook.md",
|
|
"packages/db/README.md",
|
|
"packages/mail/README.md",
|
|
"apps/api/README.md",
|
|
"apps/worker/README.md",
|
|
".github/workflows/cla.yml",
|
|
];
|
|
|
|
export const productionDocsDocumentationInventoryPatterns = [
|
|
{ id: "quickstart-new-project-local-dev", pattern: /\b(?:quickstart|new project|new-project|local dev|local development|getting started|setup|install(?:ation)?)\b/gi },
|
|
{ id: "env-config", pattern: /\b(?:env(?:ironment)?|configuration|config|\.env|DATABASE_URL|REDIS_URL|MAILERSEND_[A-Z0-9_]+|API_KEY|SECRET)\b/g },
|
|
{ id: "database-migration", pattern: /\b(?:database|PostgreSQL|Postgres|Prisma|migration|migrate|schema|seed)\b/gi },
|
|
{ id: "mail", pattern: /\b(?:mail|email|MailerSend|Postmark|SMTP|transactional|webhook signing|Svix)\b/gi },
|
|
{ id: "worker-queue", pattern: /\b(?:worker|queue|job|BullMQ|Redis|BULLMQ_REDIS_URL|background)\b/gi },
|
|
{ id: "api", pattern: /\b(?:API|endpoint|OpenAPI|REST|route|request|response|authentication|authorization)\b/g },
|
|
{ id: "deployment", pattern: /\b(?:deploy(?:ment)?|Docker|Dockerfile|Gitea|Coolify|registry|CONTAINER_REGISTRY|workflow_dispatch|CI|production)\b/gi },
|
|
{ id: "security", pattern: /\b(?:security|secret|auth|permission|token|csrf|xss|rate limit|vulnerability|runbook)\b/gi },
|
|
{ id: "observability", pattern: /\b(?:observability|logging|metrics|tracing|monitoring|alert|healthcheck|diagnostic)\b/gi },
|
|
{ id: "plugins", pattern: /\b(?:plugin|extension|MCP|integration|hook)\b/gi },
|
|
{ id: "upgrades", pattern: /\b(?:upgrade|migration guide|breaking change|version|changelog|release)\b/gi },
|
|
{ id: "troubleshooting", pattern: /\b(?:troubleshoot(?:ing)?|debug|failure|error|known issue|FAQ|problem)\b/gi },
|
|
{ id: "link-check-command", pattern: /(?:https?:\/\/[^\s)>'\"]+|\[[^\]]+\]\([^\)]+\)|`[^`]*(?:pnpm|npm|node|tsx|npx|yarn)[^`]*`)/gi },
|
|
{ id: "todo-tbd-marker", pattern: /\b(?:TODO|TBD|FIXME|XXX|follow-up|Follow-up)\b/g },
|
|
];
|
|
|
|
export const gates = [
|
|
{ id: "typecheck", command: "pnpm", args: ["run", "typecheck"] },
|
|
{ id: "lint", command: "pnpm", args: ["run", "lint"] },
|
|
{
|
|
id: "vitest-productionDocs-focused",
|
|
command: "pnpm",
|
|
args: [
|
|
"exec",
|
|
"vitest",
|
|
"run",
|
|
"scripts/verify-production-docs-baseline.test.mjs",
|
|
"scripts/verify-ci-baseline.test.mjs",
|
|
"scripts/verify-gitea-ci-workflow.test.mjs",
|
|
],
|
|
},
|
|
{ id: "productionDocs-production-docs-inventory", type: "productionDocs-production-docs-inventory" },
|
|
];
|
|
|
|
function shellCommand(gate) {
|
|
if (gate.type === "productionDocs-production-docs-inventory") return "read-only Production Docs production docs inventory";
|
|
return [gate.command, ...gate.args].join(" ");
|
|
}
|
|
|
|
function outputFingerprint(output) {
|
|
const normalized = output
|
|
.split(/\r?\n/)
|
|
.map((line) => line.trim())
|
|
.filter(Boolean)
|
|
.slice(-40)
|
|
.join("\n");
|
|
return { hash: createHash("sha256").update(output).digest("hex").slice(0, 12), excerpt: normalized.slice(0, 1200) || "(no output)" };
|
|
}
|
|
|
|
function parseNumber(value) {
|
|
const parsed = Number.parseInt(value, 10);
|
|
return Number.isFinite(parsed) ? parsed : 0;
|
|
}
|
|
|
|
function conservativeFailureCount(count, output) {
|
|
return count > 0 ? count : output.trim() ? 1 : 0;
|
|
}
|
|
|
|
function countVitestFailures(output) {
|
|
const failedTests = output.match(/Tests\s+(\d+)\s+failed/i);
|
|
if (failedTests) return parseNumber(failedTests[1]);
|
|
const failedFiles = output.match(/Test Files\s+(\d+)\s+failed/i);
|
|
return failedFiles ? parseNumber(failedFiles[1]) : 0;
|
|
}
|
|
|
|
export function failureCount(gateId, stdout, stderr, exitCode = 1) {
|
|
if (exitCode === 0 || gateId === "productionDocs-production-docs-inventory") return 0;
|
|
const output = `${stdout}\n${stderr}`;
|
|
if (gateId === "typecheck") return conservativeFailureCount((output.match(/error TS\d+/g) ?? []).length, output);
|
|
if (gateId === "lint") {
|
|
const problemsMatch = output.match(/✖\s+(\d+)\s+problems?\s+\((\d+)\s+errors?/i);
|
|
const compactMatch = output.match(/(\d+)\s+errors?/i);
|
|
return conservativeFailureCount(problemsMatch ? parseNumber(problemsMatch[2]) : compactMatch ? parseNumber(compactMatch[1]) : 0, output);
|
|
}
|
|
if (gateId === "vitest-productionDocs-focused") return conservativeFailureCount(countVitestFailures(output), output);
|
|
return output.trim() ? 1 : 0;
|
|
}
|
|
|
|
function runShellGate(gate) {
|
|
return new Promise((resolve) => {
|
|
const startedAt = Date.now();
|
|
const child = spawn(gate.command, gate.args, { cwd: repoRoot, env: { ...process.env, CI: "1" }, shell: false });
|
|
let stdout = "";
|
|
let stderr = "";
|
|
child.stdout.on("data", (chunk) => {
|
|
stdout += chunk;
|
|
});
|
|
child.stderr.on("data", (chunk) => {
|
|
stderr += chunk;
|
|
});
|
|
child.on("error", (error) => {
|
|
stderr += `\n${error.message}`;
|
|
});
|
|
child.on("close", (code) => {
|
|
const output = `${stdout}\n${stderr}`;
|
|
resolve({
|
|
id: gate.id,
|
|
command: shellCommand(gate),
|
|
exitCode: code ?? 1,
|
|
durationMs: Date.now() - startedAt,
|
|
failureCount: failureCount(gate.id, stdout, stderr, code ?? 1),
|
|
fingerprint: outputFingerprint(output),
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
function isIgnoredDirectory(name, relativePath) {
|
|
return ignoredDirectoryNames.has(name) || ignoredDirectoryNames.has(relativePath) || name.endsWith(".cache");
|
|
}
|
|
|
|
function isIgnoredFile(name) {
|
|
return ignoredFileNames.has(name) || name.endsWith(".generated.ts") || name.endsWith(".generated.tsx") || name.endsWith(".min.js") || name.endsWith(".map");
|
|
}
|
|
|
|
async function rootExists(root, rootRelativePath) {
|
|
try {
|
|
await stat(path.join(root, rootRelativePath));
|
|
return true;
|
|
} catch (error) {
|
|
if (error?.code === "ENOENT") return false;
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
async function collectFiles(root, rootRelativePath) {
|
|
const absoluteRoot = path.join(root, rootRelativePath);
|
|
const rootStat = await stat(absoluteRoot);
|
|
if (rootStat.isFile()) return [absoluteRoot];
|
|
const files = [];
|
|
async function walk(directory) {
|
|
const entries = await readdir(directory, { withFileTypes: true });
|
|
for (const entry of entries) {
|
|
const absolutePath = path.join(directory, entry.name);
|
|
const relativePath = path.relative(root, absolutePath).split(path.sep).join("/");
|
|
if (entry.isDirectory()) {
|
|
if (isIgnoredDirectory(entry.name, relativePath)) continue;
|
|
await walk(absolutePath);
|
|
} else if (entry.isFile() && /\.(?:mdx?|json)$/.test(entry.name) && !isIgnoredFile(entry.name)) {
|
|
files.push(absolutePath);
|
|
}
|
|
}
|
|
}
|
|
await walk(absoluteRoot);
|
|
return files;
|
|
}
|
|
|
|
export async function runProductionDocsDocumentationInventory(root = repoRoot) {
|
|
const existingRoots = [];
|
|
const missingRoots = [];
|
|
for (const rootRelativePath of productionDocsDocumentationInventoryScanRoots) {
|
|
if (await rootExists(root, rootRelativePath)) existingRoots.push(rootRelativePath);
|
|
else missingRoots.push(rootRelativePath);
|
|
}
|
|
const files = (await Promise.all(existingRoots.map((rootRelativePath) => collectFiles(root, rootRelativePath)))).flat();
|
|
const counts = new Map(productionDocsDocumentationInventoryPatterns.map(({ id }) => [id, 0]));
|
|
const matches = [];
|
|
for (const file of files) {
|
|
const relativeFile = path.relative(root, file).split(path.sep).join("/");
|
|
const lines = (await readFile(file, "utf8")).split(/\r?\n/);
|
|
lines.forEach((line, index) => {
|
|
for (const { id, pattern } of productionDocsDocumentationInventoryPatterns) {
|
|
pattern.lastIndex = 0;
|
|
const found = line.match(pattern);
|
|
if (!found) continue;
|
|
counts.set(id, (counts.get(id) ?? 0) + found.length);
|
|
matches.push(`${relativeFile}:${index + 1}: [${id}] ${line.trim()}`);
|
|
}
|
|
});
|
|
}
|
|
return { roots: existingRoots, missingRoots, filesScanned: files.length, counts: Object.fromEntries(counts.entries()), totalMatches: matches.length, matches };
|
|
}
|
|
|
|
async function runProductionDocsDocumentationInventoryGate(gate) {
|
|
const startedAt = Date.now();
|
|
const inventory = await runProductionDocsDocumentationInventory(repoRoot);
|
|
const outputLines = [
|
|
`Production Docs production docs inventory scanned roots: ${inventory.roots.join(", ") || "(none)"}`,
|
|
`Production Docs production docs inventory missing roots skipped: ${inventory.missingRoots.join(", ") || "(none)"}`,
|
|
`files scanned: ${inventory.filesScanned}`,
|
|
...Object.entries(inventory.counts).map(([id, count]) => `${id}: ${count}`),
|
|
`total matches: ${inventory.totalMatches}`,
|
|
...inventory.matches.slice(0, 240),
|
|
];
|
|
if (inventory.matches.length > 240) outputLines.push(`... ${inventory.matches.length - 240} additional matches omitted`);
|
|
const output = outputLines.join("\n");
|
|
return { id: gate.id, command: shellCommand(gate), exitCode: 0, durationMs: Date.now() - startedAt, failureCount: 0, inventory, fingerprint: outputFingerprint(output) };
|
|
}
|
|
|
|
async function runGate(gate) {
|
|
if (gate.type === "productionDocs-production-docs-inventory") return runProductionDocsDocumentationInventoryGate(gate);
|
|
return runShellGate(gate);
|
|
}
|
|
|
|
function renderInventoryCounts(result) {
|
|
if (!result.inventory) return [];
|
|
return [
|
|
"- Inventory Roots: " + (result.inventory.roots.join(", ") || "(none)"),
|
|
"- Missing Roots Skipped: " + (result.inventory.missingRoots.join(", ") || "(none)"),
|
|
`- Files Scanned: ${result.inventory.filesScanned}`,
|
|
"- Inventory Counts:",
|
|
...Object.entries(result.inventory.counts).map(([id, count]) => ` - ${id}: ${count}`),
|
|
`- Total Inventory Matches: ${result.inventory.totalMatches}`,
|
|
];
|
|
}
|
|
|
|
export function renderReport(results) {
|
|
const lines = [
|
|
"# Production Docs Baseline Health",
|
|
"",
|
|
`Generated: ${new Date().toISOString()}`,
|
|
"",
|
|
"This report captures non-E2E baseline gates for Production Docs baseline. The runner exits non-zero when any shell gate fails; inventory gates remain read-only unless the runner itself fails.",
|
|
"The shell gates run with CI=1 and fingerprint TypeScript, ESLint, and focused Vitest smoke coverage. The Production Docs production docs inventory gate is read-only and fingerprints production-doc readiness terms for quickstart/new-project/local-dev, env/config, database/migration, mail, worker/queue, API, deployment, security, observability, plugins, upgrades, troubleshooting, link/check-command, and TODO/TBD markers across the configured docs while reporting missing optional documentation roots as skipped.",
|
|
"",
|
|
];
|
|
for (const result of results) {
|
|
lines.push(
|
|
`## ${result.id}`,
|
|
"",
|
|
`- Command: \`${result.command}\``,
|
|
`- Exitcode: ${result.exitCode}`,
|
|
`- Failure Count: ${result.failureCount}`,
|
|
`- Duration: ${result.durationMs}ms`,
|
|
`- Output Fingerprint: ${result.fingerprint.hash}`,
|
|
...renderInventoryCounts(result),
|
|
"",
|
|
"```text",
|
|
result.fingerprint.excerpt,
|
|
"```",
|
|
"",
|
|
);
|
|
}
|
|
return `${lines.join("\n")}\n`;
|
|
}
|
|
|
|
async function writeFailureReport(error) {
|
|
await mkdir(path.dirname(reportPath), { recursive: true });
|
|
const output = error?.stack ?? String(error);
|
|
await writeFile(
|
|
reportPath,
|
|
renderReport([{ id: "runner-error", command: "node scripts/verify-production-docs-baseline.mjs", exitCode: 1, durationMs: 0, failureCount: 1, fingerprint: outputFingerprint(output) }]),
|
|
"utf8",
|
|
);
|
|
}
|
|
|
|
async function main() {
|
|
const results = [];
|
|
for (const gate of gates) {
|
|
console.log(`Running ${gate.id}: ${shellCommand(gate)}`);
|
|
results.push(await runGate(gate));
|
|
}
|
|
await mkdir(path.dirname(reportPath), { recursive: true });
|
|
await writeFile(reportPath, renderReport(results), "utf8");
|
|
console.log(`Wrote ${path.relative(repoRoot, reportPath)}`);
|
|
const failedResults = results.filter((result) => result.exitCode !== 0 || result.failureCount > 0);
|
|
if (failedResults.length > 0) {
|
|
console.error(`Baseline gates failed: ${failedResults.map((result) => result.id).join(", ")}`);
|
|
process.exitCode = 1;
|
|
}
|
|
}
|
|
|
|
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
|
main().catch(async (error) => {
|
|
console.error(error);
|
|
try {
|
|
await writeFailureReport(error);
|
|
} finally {
|
|
process.exit(1);
|
|
}
|
|
});
|
|
}
|