record schema and check mismatch

Author: ScriptRaccoon

.prettierignore

@@ -2,3 +2,5 @@
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
+
+schema.json

databases/.gitignore

@@ -1,4 +1,5 @@
 **/*.db
 **/*.db-wal
 **/*.db-shm
-**/*.db-journal
+**/*.db-journal
+**/*.schema.json

databases/catdat/scripts/schema.utils.ts

@@ -0,0 +1,37 @@
+import { createHash } from 'node:crypto'
+import fs from 'node:fs'
+import path from 'node:path'
+
+const schema_folder = path.join(process.cwd(), 'databases', 'catdat', 'schema')
+
+export function create_schema_hash(): string {
+	const schema = fs
+		.readdirSync(schema_folder, 'utf8')
+		.filter((file) => file.endsWith('.sql'))
+		.sort()
+		.map((file) => fs.readFileSync(path.join(schema_folder, file), 'utf8'))
+		.join('\n')
+	return sha256_hex(schema)
+}
+
+export function write_schema_hash(hash: string) {
+	fs.writeFileSync(
+		path.join(schema_folder, 'schema.json'),
+		JSON.stringify({ hash }),
+		'utf8',
+	)
+}
+
+export function get_saved_schema_hash() {
+	try {
+		const txt = fs.readFileSync(path.join(schema_folder, 'schema.json'), 'utf8')
+		const json = JSON.parse(txt) as { hash: string }
+		return json.hash
+	} catch (_) {
+		return ''
+	}
+}
+
+export function sha256_hex(input: string): string {
+	return createHash('sha256').update(input).digest('hex')
+}

databases/catdat/scripts/seed.ts

@@ -1,12 +1,23 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import { get_client } from './shared'
+import { create_schema_hash, get_saved_schema_hash } from './schema.utils'
+
+seed()
 
 /**
  * Seeds the data recorded in SQL files into the database.
  */
 function seed() {
 	console.info('\n--- Seed CatDat database ---')
+
+	const schema_hash = get_saved_schema_hash()
+	const actual_hash = create_schema_hash()
+	if (schema_hash !== actual_hash) {
+		console.error(`❌ Your schema is outdated. Run first pnpm db:setup.`)
+		process.exit(1)
+	}
+
 	const db = get_client()
 	const data_folder = path.join(process.cwd(), 'databases', 'catdat', 'data')
 
@@ -53,5 +64,3 @@ function seed() {
 		process.exit(1)
 	}
 }
-
-seed()

databases/catdat/scripts/setup.ts

@@ -1,6 +1,9 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import { get_client } from './shared'
+import { create_schema_hash, write_schema_hash } from './schema.utils'
+
+const schema_folder = path.join(process.cwd(), 'databases', 'catdat', 'schema')
 
 setup()
 
@@ -13,8 +16,6 @@ function setup() {
 	const db = get_client()
 	db.pragma('foreign_keys = ON')
 
-	const schema_folder = path.join(process.cwd(), 'databases', 'catdat', 'schema')
-
 	const files = fs
 		.readdirSync(schema_folder, 'utf8')
 		.filter((file) => file.endsWith('.sql'))
@@ -36,5 +37,8 @@ function setup() {
 		}
 	}
 
+	const hash = create_schema_hash()
+	write_schema_hash(hash)
+
 	console.info('Setup complete')
 }