feat: prune caches on version change

Author: LouisHaftmann

lib/db/index.ts

@@ -30,10 +30,16 @@ export interface UploadPartsTable {
   e_tag: string | null
 }
 
+export interface MetaTable {
+  key: 'version'
+  value: string
+}
+
 export interface Database {
   cache_keys: CacheKeysTable
   uploads: UploadsTable
   upload_parts: UploadPartsTable
+  meta: MetaTable
 }
 
 let _db: Kysely<Database>
@@ -238,3 +244,18 @@ export async function uploadExists(db: DB, { key, version }: { key: string; vers
     .executeTakeFirst()
   return !!row
 }
+
+export async function upsertVersion(db: DB, version: string) {
+  const existing = await db
+    .selectFrom('meta')
+    .where('key', '=', 'version')
+    .select('value')
+    .executeTakeFirst()
+  if (existing) {
+    await db.updateTable('meta').set('value', version).where('key', '=', 'version').execute()
+  } else {
+    await db.insertInto('meta').values({ key: 'version', value: version }).execute()
+  }
+
+  return version !== existing?.value
+}

lib/db/migrations.ts

@@ -4,7 +4,7 @@ import type { DatabaseDriverName } from '~/lib/db/drivers'
 
 export function migrations(dbType: DatabaseDriverName) {
   return {
-    cache_keys_table: {
+    $0_cache_keys_table: {
       async up(db) {
         let query = db.schema
           .createTable('cache_keys')
@@ -22,7 +22,7 @@ export function migrations(dbType: DatabaseDriverName) {
         await db.schema.dropTable('cache_keys').ifExists().execute()
       },
     },
-    uploads_and_upload_parts_tables: {
+    $1_uploads_and_upload_parts_tables: {
       async up(db) {
         await db.schema
           .createTable('uploads')
@@ -56,5 +56,18 @@ export function migrations(dbType: DatabaseDriverName) {
         await db.schema.dropTable('upload_parts').ifExists().execute()
       },
     },
+    $2_meta_table: {
+      async up(db) {
+        await db.schema
+          .createTable('meta')
+          .addColumn('key', dbType === 'mysql' ? 'varchar(255)' : 'text', (c) => c.primaryKey())
+          .addColumn('value', 'text')
+          .ifNotExists()
+          .execute()
+      },
+      async down(db) {
+        await db.schema.dropTable('meta').ifExists().execute()
+      },
+    },
   } satisfies Record<string, Migration>
 }

plugins/setup.ts

@@ -1,9 +1,9 @@
 import { H3Error } from 'h3'
 
-import { initializeDatabase } from '~/lib/db'
+import { initializeDatabase, useDB } from '~/lib/db'
 import { ENV } from '~/lib/env'
 import { logger } from '~/lib/logger'
-import { initializeStorage } from '~/lib/storage'
+import { initializeStorage, useStorageAdapter } from '~/lib/storage'
 
 export default defineNitroPlugin(async (nitro) => {
   logger.info(`🚀 Starting GitHub Actions Cache Server (${useRuntimeConfig().version})`)
@@ -34,6 +34,31 @@ export default defineNitroPlugin(async (nitro) => {
     })
   }
 
+  const version = useRuntimeConfig().version
+  if (version) {
+    const db = useDB()
+    const existing = await db
+      .selectFrom('meta')
+      .where('key', '=', 'version')
+      .select('value')
+      .executeTakeFirst()
+
+    if (!existing || existing.value !== version) {
+      logger.info(
+        `Version changed from ${existing?.value ?? '[no version, first install]'} to ${version}. Pruning cache...`,
+      )
+      await useStorageAdapter().pruneCaches()
+    }
+
+    if (existing) {
+      await db.updateTable('meta').set('value', version).where('key', '=', 'version').execute()
+    } else {
+      await db.insertInto('meta').values({ key: 'version', value: version }).execute()
+    }
+  } else {
+    logger.warn('No version found in runtime config')
+  }
+
   if (process.send) process.send('nitro:ready')
 })