feat: database version (#3148)

Author: farnabaz

src/module.ts

@@ -36,6 +36,12 @@ import { getLocalDatabase, refineDatabaseConfig, resolveDatabaseAdapter } from '
 export * from './utils'
 export type * from './types'
 
+/**
+ * Database version is used to identify schema changes
+ * and drop the info table when the version is not supported
+ */
+const databaseVersion = 'v3.2.0'
+
 export default defineNuxtModule<ModuleOptions>({
   meta: {
     name: 'Content',
@@ -142,6 +148,7 @@ export default defineNuxtModule<ModuleOptions>({
       wsUrl: '',
     }
     nuxt.options.runtimeConfig.content = {
+      databaseVersion,
       version,
       database: options.database,
       localDatabase: options._localDatabase!,
@@ -303,7 +310,7 @@ async function processCollectionItems(nuxt: Nuxt, collections: ResolvedCollectio
       collectionQueries.push(...list.flatMap(([, sql]) => sql!))
     }
 
-    const version = collectionChecksum[collection.name] = hash(collectionQueries)
+    const version = collectionChecksum[collection.name] = `${databaseVersion}--${hash(collectionQueries)}`
 
     collectionDump[collection.name] = [
       // we have to start the series of queries
@@ -317,7 +324,7 @@ async function processCollectionItems(nuxt: Nuxt, collections: ResolvedCollectio
       ...collectionQueries,
 
       // and finally when we are finished, we update the info table to say that the init is done
-      `UPDATE ${infoCollection.tableName} SET ready = true WHERE id = 'checksum_${collection.name}'`,
+      `UPDATE ${infoCollection.tableName} SET ready = true WHERE id = 'checksum_${collection.name}';`,
     ]
   }
 

src/presets/nuxthub.ts

@@ -26,7 +26,8 @@ export default definePreset({
       // Write SQL dump to database queries when not in dev mode
       await mkdir(resolve(nitroConfig.rootDir, '.data/hub/database/queries'), { recursive: true })
       let i = 1
-      let dump = ''
+      // Drop info table and prepare for new dump
+      let dump = 'DROP TABLE IF EXISTS _content_info;\n'
       const dumpFiles: Array<{ file: string, content: string }> = []
       Object.values(options.manifest.dump).forEach((value) => {
         value.forEach((line) => {

src/runtime/internal/database.server.ts

@@ -65,10 +65,16 @@ async function _checkAndImportDatabaseIntegrity(event: H3Event, collection: stri
 
   const before = await db.first<{ version: string, ready: boolean }>(`select * from ${tables.info} where id = ?`, [`checksum_${collection}`]).catch((): null => null)
 
+  if (before?.version && !String(before.version)?.startsWith(`${config.databaseVersion}--`)) {
+    // database version is not supported, drop the info table
+    await db.exec(`DROP TABLE IF EXISTS ${tables.info}`)
+    before.version = ''
+  }
+
   if (before?.version) {
     if (before.version === integrityVersion) {
       if (before.ready) {
-      // table is already initialized and ready, use it
+        // table is already initialized and ready, use it
         return true
       }
 

src/types/module.ts

@@ -184,6 +184,7 @@ export interface ModuleOptions {
 export interface RuntimeConfig {
   content: {
     version: string
+    databaseVersion: string
     database: D1DatabaseConfig | SqliteDatabaseConfig | PostgreSQLDatabaseConfig
     localDatabase: SqliteDatabaseConfig
     integrityCheck: boolean