Add DB schema validation (#111)

* Add DB schema validation

Closes #105

* Remove redundant .string()

Author: corrideat

build/main.js

@@ -54,6 +54,7 @@
     "npm:@hapi/inert": "npm:@hapi/[email protected]",
     "npm:chalk": "npm:[email protected]",
     "npm:ws": "npm:[email protected]",
+    "npm:zod": "npm:[email protected]",
     "npm:@types/ws": "npm:@types/[email protected]",
     "npm:joi": "npm:[email protected]",
     "npm:bottleneck": "npm:[email protected]",

deno.json

@@ -29,7 +29,13 @@ export async function migrate (args: ArgumentsCamelCase<Params>): Promise<void>
     nconf.set(`database:backendOptions:${backend}`, fromConfigOpts)
   }
 
-  await initDB({ skipDbPreloading: true })
+  try {
+    await initDB({ skipDbPreloading: true })
+  } catch (e) {
+    console.error('Error setting up database')
+    exit(e)
+    throw e
+  }
 
   let backendTo: DatabaseBackend
   try {

deno.lock

@@ -1,9 +1,17 @@
-import { Buffer } from 'node:buffer'
+import type { Buffer } from 'node:buffer'
 import { mkdir, readdir, readFile, rm, unlink, writeFile } from 'node:fs/promises'
 import { basename, dirname, join, normalize, resolve } from 'node:path'
 import { checkKey } from 'npm:@chelonia/lib/db'
+import * as z from 'npm:zod'
 import DatabaseBackend from './DatabaseBackend.ts'
 
+const ConfigSchema = z.strictObject({
+  dirname: z.optional(z.string()),
+  depth: z.optional(z.number()),
+  keyChunkLength: z.optional(z.number()),
+  skipFsCaseSensitivityCheck: z.optional(z.boolean()),
+})
+
 // Some operating systems (such as macOS and Windows) use case-insensitive
 // filesystems by default. This can be problematic for Chelonia / Group Income,
 // as we rely on keys being case-sensitive. This is especially relevant for CIDs,
@@ -48,6 +56,7 @@ export default class FsBackend extends DatabaseBackend {
 
   constructor (options: { dirname?: string; depth?: number; keyChunkLength?: number, skipFsCaseSensitivityCheck?: boolean } = {}) {
     super()
+    ConfigSchema.parse(options)
     if (options.dirname) this.dataFolder = resolve(options.dirname)
     if (options.depth) this.depth = options.depth
     if (options.keyChunkLength) this.keyChunkLength = options.keyChunkLength

src/migrate.ts

@@ -1,13 +1,19 @@
 import { Buffer } from 'node:buffer'
 import { RESP_TYPES, createClient, type RedisClientType } from 'npm:redis'
+import * as z from 'npm:zod'
 import DatabaseBackend from './DatabaseBackend.ts'
 
+const ConfigSchema = z.strictObject({
+  url: z.optional(z.url({ protocol: /^rediss?$/ })),
+})
+
 export default class RedisBackend extends DatabaseBackend {
   db: RedisClientType | null = null
   url: string | undefined
 
   constructor (options: { url?: string } = {}) {
     super()
+    ConfigSchema.parse(options)
     this.url = options.url
   }
 

src/serve/database-fs.ts

@@ -1,6 +1,16 @@
 import type { Buffer } from 'node:buffer'
+import * as z from 'npm:zod'
 import DatabaseBackend from './DatabaseBackend.ts'
 
+const ConfigEntrySchema = z.strictObject({
+  name: z.string(),
+  options: z.object()
+})
+const ConfigSchema = z.intersection(
+  z.object({ '*': ConfigEntrySchema }),
+  z.record(z.string(), ConfigEntrySchema)
+)
+
 type ConfigEntry = { name: string; options: Record<string, unknown> }
 type Config = {
   [key: string]: ConfigEntry
@@ -13,6 +23,7 @@ export default class RouterBackend extends DatabaseBackend {
   constructor (config: Config = {}) {
     super()
     // Return a sorted copy where entries with longer keys come first.
+    ConfigSchema.parse(config)
     const configCopy = Object.fromEntries(Object.entries(config).sort((a, b) => b[0].length - a[0].length)) as Config
     const errors = this.validateConfig(configCopy)
     if (errors.length) {

src/serve/database-redis.ts

@@ -3,8 +3,13 @@ import * as sqlite from 'jsr:@db/sqlite'
 import { Buffer } from 'node:buffer'
 import { mkdir } from 'node:fs/promises'
 import { basename, dirname, join, resolve } from 'node:path'
+import * as z from 'npm:zod'
 import DatabaseBackend from './DatabaseBackend.ts'
 
+const ConfigSchema = z.strictObject({
+  filepath: z.optional(z.string()),
+})
+
 export default class SqliteBackend extends DatabaseBackend {
   dataFolder: string = 'data'
   db: SQLiteDB | null = null
@@ -17,6 +22,7 @@ export default class SqliteBackend extends DatabaseBackend {
 
   constructor (options: { filepath?: string } = {}) {
     super()
+    ConfigSchema.parse(options)
     const { filepath } = options
     if (!filepath) return
     const resolvedPath = resolve(filepath)

src/serve/database-router.ts

@@ -1,4 +1,4 @@
-import { Buffer } from 'node:buffer'
+import type { Buffer } from 'node:buffer'
 import process from 'node:process'
 import { Readable } from 'node:stream'
 import 'npm:@chelonia/lib/chelonia'