|
| 1 | +import { readdirSync, readFileSync } from 'fs'; |
| 2 | +import path from 'path'; |
| 3 | + |
| 4 | +import { |
| 5 | + CANONICAL_PUBLIC_TABLES, |
| 6 | + getRequiredGeneratedTypeTableNames, |
| 7 | +} from '../src/data-health/checks'; |
| 8 | + |
| 9 | +interface SchemaTypeReport { |
| 10 | + ok: boolean; |
| 11 | + generatedTypesPath: string; |
| 12 | + ormTypesPath: string; |
| 13 | + migrationDirectory: string; |
| 14 | + missingFromGeneratedTypes: string[]; |
| 15 | + missingFromOrmTypes: string[]; |
| 16 | + missingFromMigrations: string[]; |
| 17 | +} |
| 18 | + |
| 19 | +function main() { |
| 20 | + const repoRoot = path.resolve(__dirname, '../../..'); |
| 21 | + const generatedTypesPath = path.join(repoRoot, 'packages/orm/src/types/database.generated.ts'); |
| 22 | + const ormTypesPath = path.join(repoRoot, 'packages/orm/src/types/database.ts'); |
| 23 | + const migrationDirectory = path.join(repoRoot, 'supabase/migrations'); |
| 24 | + const generatedTypes = readFileSync(generatedTypesPath, 'utf8'); |
| 25 | + const ormTypes = readFileSync(ormTypesPath, 'utf8'); |
| 26 | + const migrationSource = readMigrationSource(migrationDirectory); |
| 27 | + const requiredTables = getRequiredGeneratedTypeTableNames(); |
| 28 | + |
| 29 | + const report: SchemaTypeReport = { |
| 30 | + ok: true, |
| 31 | + generatedTypesPath, |
| 32 | + ormTypesPath, |
| 33 | + migrationDirectory, |
| 34 | + missingFromGeneratedTypes: missingTableNames(generatedTypes, requiredTables), |
| 35 | + missingFromOrmTypes: missingTableNames(ormTypes, requiredTables), |
| 36 | + missingFromMigrations: missingTablesFromMigrations(migrationSource, CANONICAL_PUBLIC_TABLES), |
| 37 | + }; |
| 38 | + |
| 39 | + report.ok = |
| 40 | + report.missingFromGeneratedTypes.length === 0 && |
| 41 | + report.missingFromOrmTypes.length === 0 && |
| 42 | + report.missingFromMigrations.length === 0; |
| 43 | + |
| 44 | + if (process.argv.includes('--json')) { |
| 45 | + console.log(JSON.stringify(report, null, 2)); |
| 46 | + } else { |
| 47 | + printReport(report); |
| 48 | + } |
| 49 | + |
| 50 | + process.exitCode = report.ok ? 0 : 1; |
| 51 | +} |
| 52 | + |
| 53 | +function readMigrationSource(migrationDirectory: string): string { |
| 54 | + return readdirSync(migrationDirectory) |
| 55 | + .filter((fileName) => fileName.endsWith('.sql')) |
| 56 | + .sort() |
| 57 | + .map((fileName) => readFileSync(path.join(migrationDirectory, fileName), 'utf8')) |
| 58 | + .join('\n'); |
| 59 | +} |
| 60 | + |
| 61 | +function missingTableNames(source: string, tableNames: readonly string[]): string[] { |
| 62 | + return tableNames.filter((tableName) => !new RegExp(`\\b${escapeRegExp(tableName)}\\s*:`).test(source)); |
| 63 | +} |
| 64 | + |
| 65 | +function missingTablesFromMigrations(source: string, tableNames: readonly string[]): string[] { |
| 66 | + return tableNames.filter((tableName) => { |
| 67 | + const quoted = new RegExp( |
| 68 | + `CREATE\\s+TABLE\\s+IF\\s+NOT\\s+EXISTS\\s+"?public"?\\."?${escapeRegExp(tableName)}"?\\s*\\(`, |
| 69 | + 'i', |
| 70 | + ); |
| 71 | + const unquoted = new RegExp( |
| 72 | + `CREATE\\s+TABLE\\s+IF\\s+NOT\\s+EXISTS\\s+public\\.${escapeRegExp(tableName)}\\s*\\(`, |
| 73 | + 'i', |
| 74 | + ); |
| 75 | + return !quoted.test(source) && !unquoted.test(source); |
| 76 | + }); |
| 77 | +} |
| 78 | + |
| 79 | +function escapeRegExp(value: string): string { |
| 80 | + return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); |
| 81 | +} |
| 82 | + |
| 83 | +function printReport(report: SchemaTypeReport) { |
| 84 | + console.log('[Bitcode schema types] generated types:', report.generatedTypesPath); |
| 85 | + console.log('[Bitcode schema types] ORM types:', report.ormTypesPath); |
| 86 | + console.log('[Bitcode schema types] migrations:', report.migrationDirectory); |
| 87 | + |
| 88 | + printList('Missing from generated Supabase types', report.missingFromGeneratedTypes); |
| 89 | + printList('Missing from ORM exported database types', report.missingFromOrmTypes); |
| 90 | + printList('Missing from migrations', report.missingFromMigrations); |
| 91 | + |
| 92 | + if (report.ok) { |
| 93 | + console.log('[Bitcode schema types] PASS'); |
| 94 | + } else { |
| 95 | + console.log('[Bitcode schema types] FAIL'); |
| 96 | + console.log('Refresh generated types after applying migrations, then rerun this check.'); |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +function printList(label: string, values: readonly string[]) { |
| 101 | + if (values.length === 0) { |
| 102 | + console.log(`${label}: none`); |
| 103 | + return; |
| 104 | + } |
| 105 | + |
| 106 | + console.log(`${label}:`); |
| 107 | + for (const value of values) { |
| 108 | + console.log(` - ${value}`); |
| 109 | + } |
| 110 | +} |
| 111 | + |
| 112 | +main(); |
0 commit comments