Files
HiveGrid-Wireframes/hivegrid-cloud/scripts/verify-theme-error-state-baseline.mjs
T

279 lines
11 KiB
JavaScript

#!/usr/bin/env node
/* eslint-disable no-console */
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";
import { spawn } from "node:child_process";
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const repoRoot = path.resolve(__dirname, "..");
export const reportPath = path.join(repoRoot, ".tc/baselines/theme-error-state/baseline-health.md");
const ignoredDirectoryNames = new Set([
".git",
"node_modules",
"build",
"dist",
"coverage",
".react-router",
".turbo",
".next",
".cache",
".vite",
"generated",
"llm-docs",
"docs",
".tc",
]);
export const baselineInventoryScanRoots = ["apps/web/app/root.tsx", "apps/web/app/routes", "apps/web/app/components", "apps/web/app/application", "apps/web/public", "apps/web/vite.config.ts"];
export const baselineInventoryPatterns = [
{ id: "theme", pattern: /\btheme(?:Color|\b)|data-theme|ThemeProvider|theme-color/gi },
{ id: "dark-mode", pattern: /dark-mode|darkMode|\bdark:\b|prefers-color-scheme|\bdark\b/gi },
{ id: "maintenance", pattern: /maintenance|maintenace|scheduled downtime|temporarily unavailable/gi },
{ id: "error-404", pattern: /\b404\b|not found|not-found/gi },
{ id: "error-500", pattern: /\b500\b|internal server error|server error/gi },
{ id: "error-401", pattern: /\b401\b|unauthorized|unauthenticated/gi },
{ id: "error-403", pattern: /\b403\b|forbidden|permission denied/gi },
{ id: "plan-required", pattern: /plan-required|plan required|requires plan|subscription required|upgrade required/gi },
{ id: "feature-disabled", pattern: /feature-disabled|feature disabled|disabled feature|isFeatureEnabled|feature flag/gi },
];
export const gates = [
{ id: "typecheck", command: "pnpm", args: ["run", "typecheck"] },
{ id: "lint", command: "pnpm", args: ["run", "lint"] },
{ id: "ci-baseline", command: "node", args: ["scripts/verify-ci-baseline.mjs"] },
{
id: "vitest-health-readiness",
command: "pnpm",
args: [
"exec",
"vitest",
"run",
"apps/web/app/routes/healthz.test.ts",
"apps/web/app/routes/readyz.test.ts",
"apps/web/app/routes/healthcheck.test.ts",
"apps/web/app/routes/health-readiness.test.ts",
],
},
{ id: "theme-error-inventory", type: "baseline-inventory" },
];
function shellCommand(gate) {
if (gate.type === "baseline-inventory") return "read-only theme/error surface 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 === "theme-error-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-health-readiness") return conservativeFailureCount(countVitestFailures(output), output);
if (gateId === "ci-baseline") return conservativeFailureCount((output.match(/^FAIL\s/gm) ?? []).length, 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");
}
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() && /\.(?:ts|tsx|js|jsx|mjs|cjs|css|json|webmanifest|html)$/.test(entry.name) && !entry.name.endsWith(".generated.ts") && !entry.name.endsWith(".generated.tsx")) {
files.push(absolutePath);
}
}
}
await walk(absoluteRoot);
return files;
}
export async function runBaselineInventory(root = repoRoot) {
const existingRoots = [];
const missingRoots = [];
for (const rootRelativePath of baselineInventoryScanRoots) {
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(baselineInventoryPatterns.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 baselineInventoryPatterns) {
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, counts: Object.fromEntries(counts.entries()), totalMatches: matches.length, matches };
}
async function runBaselineInventoryGate(gate) {
const startedAt = Date.now();
const inventory = await runBaselineInventory(repoRoot);
const outputLines = [
`PWA/theme/error inventory scanned roots: ${inventory.roots.join(", ") || "(none)"}`,
`PWA/theme/error inventory missing roots skipped: ${inventory.missingRoots.join(", ") || "(none)"}`,
...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, fingerprint: outputFingerprint(output) };
}
async function runGate(gate) {
if (gate.type === "baseline-inventory") return runBaselineInventoryGate(gate);
return runShellGate(gate);
}
export function renderReport(results) {
const lines = [
"# Theme Error State Baseline Health",
"",
`Generated: ${new Date().toISOString()}`,
"",
"This report captures non-E2E baseline gates for Theme Error State baseline. The runner exits 0 when every gate was attempted and this report was written, even if individual gates fail.",
"The PWA/theme/error inventory gate is read-only and fingerprints PWA, manifest, service-worker, theme, dark-mode, maintenance, 404/500/401/403, plan-required, and feature-disabled markers while skipping missing roots plus generated, dependency, build, cache, documentation, and TC artifact folders.",
"",
];
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}`,
"",
"```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-theme-error-state-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)}`);
}
if (process.argv[1] === fileURLToPath(import.meta.url)) {
main().catch(async (error) => {
console.error(error);
try {
await writeFailureReport(error);
} finally {
process.exit(1);
}
});
}