255 lines
12 KiB
JavaScript
255 lines
12 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/tenant-auth/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 tenantAuthInventoryScanRoots = ["apps/web/app/routes", "apps/web/app/utils", "apps/web/app/modules", "packages/db/src", "packages/entitlements/src", "prisma"];
|
|
export const tenantAuthInventoryPatterns = [
|
|
{ id: "tenant-workspace", pattern: /\b(?:tenant|tenants|workspace|workspaces|organization|organizations|orgId|tenantId|workspaceId)\b/gi },
|
|
{ id: "invite", pattern: /\b(?:invite|invites|invitation|invitations|invited|inviter|invitee)\b/gi },
|
|
{ id: "expiry-revocation-accept", pattern: /\b(?:expiry|expires|expiresAt|expired|revocation|revoke|revoked|accept|accepted|acceptance|redeem|redeemed)\b/gi },
|
|
{ id: "oauth-google-apple", pattern: /\b(?:oauth|OAuth|google|Google|apple|Apple|provider|providers|strategy|strategies)\b/g },
|
|
{ id: "magic-link", pattern: /\b(?:magic\s*link|magicLink|email\s*link|passwordless|one-time|oneTime|otp|token)\b/gi },
|
|
{ id: "callback-redirect-host-aware", pattern: /\b(?:callback|redirect|redirectTo|returnTo|host-aware|hostAware|hostname|origin|baseUrl|requestUrl|URL\()\b/g },
|
|
{ id: "context-switch", pattern: /\b(?:context\s*switch|contextSwitch|switchTenant|switchWorkspace|activeTenant|activeWorkspace|currentTenant|currentWorkspace)\b/gi },
|
|
{ id: "role-feature-plan-revalidation", pattern: /\b(?:role|roles|permission|permissions|feature|features|featureFlag|entitlement|entitlements|plan|plans|subscription|revalidate|revalidation|validateAccess|canAccess)\b/gi },
|
|
{ id: "sso-saml-oidc", pattern: /\b(?:sso|SSO|saml|SAML|oidc|OIDC|OpenID|single\s*sign-on|identity\s*provider|idp|IdP)\b/g },
|
|
];
|
|
|
|
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-tenantAuth-tenant-auth-smoke", command: "pnpm", args: ["exec", "vitest", "run", "apps/web/app/routes/app.$tenant.host-aware.test.ts", "apps/web/app/routes/app.$tenant.test.tsx", "apps/web/app/routes/admin/settings/authentication.test.tsx", "apps/web/app/utils/data/.server/auth-boundary-imports.test.ts", "packages/db/src/index.test.ts", "packages/entitlements/src/index.test.ts"] },
|
|
{ id: "tenantAuth-tenant-auth-inventory", type: "tenantAuth-tenant-auth-inventory" },
|
|
];
|
|
|
|
function shellCommand(gate) {
|
|
if (gate.type === "tenantAuth-tenant-auth-inventory") return "read-only Tenant Auth tenant/auth/OAuth/invite 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 === "tenantAuth-tenant-auth-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-tenantAuth-tenant-auth-smoke") 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");
|
|
}
|
|
|
|
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() && /\.(?:ts|tsx|js|jsx|mjs|cjs|css|json|prisma|mdx?)$/.test(entry.name) && !isIgnoredFile(entry.name)) files.push(absolutePath);
|
|
}
|
|
}
|
|
await walk(absoluteRoot);
|
|
return files;
|
|
}
|
|
|
|
export async function runTenantAuthInventory(root = repoRoot) {
|
|
const existingRoots = [];
|
|
const missingRoots = [];
|
|
for (const rootRelativePath of tenantAuthInventoryScanRoots) {
|
|
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(tenantAuthInventoryPatterns.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 tenantAuthInventoryPatterns) {
|
|
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 runTenantAuthInventoryGate(gate) {
|
|
const startedAt = Date.now();
|
|
const inventory = await runTenantAuthInventory(repoRoot);
|
|
const outputLines = [
|
|
`Tenant Auth inventory scanned roots: ${inventory.roots.join(", ") || "(none)"}`,
|
|
`Tenant Auth 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 === "tenantAuth-tenant-auth-inventory") return runTenantAuthInventoryGate(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 = [
|
|
"# Tenant Auth Baseline Health",
|
|
"",
|
|
`Generated: ${new Date().toISOString()}`,
|
|
"",
|
|
"This report captures non-E2E baseline gates for Tenant Auth baseline. Every gate is attempted and this report is written even if individual shell gates fail; the runner exits non-zero when any shell gate fails.",
|
|
"The shell gates run with CI=1 and fingerprint TypeScript, ESLint, CI baseline, and focused tenant/auth Vitest smoke coverage. The Tenant Auth inventory gate is read-only and fingerprints tenant/workspace, invite, expiry/revocation/accept, OAuth/Google/Apple, magic-link, callback/redirect/host-aware, context-switch, role/feature/plan revalidation, and SSO/SAML/OIDC surfaces while skipping missing roots plus generated, dependency, build, cache, coverage, swagger, 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}`,
|
|
...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-tenant-auth-baseline.mjs", exitCode: 1, durationMs: 0, failureCount: 1, fingerprint: outputFingerprint(output) }]),
|
|
"utf8",
|
|
);
|
|
}
|
|
|
|
function aggregateExitCode(results) {
|
|
return results.some((result) => result.exitCode !== 0) ? 1 : 0;
|
|
}
|
|
|
|
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)}`);
|
|
process.exitCode = aggregateExitCode(results);
|
|
}
|
|
|
|
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
|
main().catch(async (error) => {
|
|
console.error(error);
|
|
try {
|
|
await writeFailureReport(error);
|
|
} finally {
|
|
process.exit(1);
|
|
}
|
|
});
|
|
}
|