feat: nitro async plugin patch & prod build testing (#61)

Author: LouisHaftmann

lib/db/index.ts

@@ -19,7 +19,9 @@ export interface CacheKeysTable {
   accessed_at: string
 }
 
-async function initializeDatabase() {
+let db: Kysely<Database>
+
+export async function initializeDatabase() {
   const driverName = ENV.DB_DRIVER
   const driverSetup = getDatabaseDriver(driverName)
   if (!driverSetup) {
@@ -31,7 +33,7 @@ async function initializeDatabase() {
 
   const driver = await driverSetup()
 
-  const db = new Kysely<Database>({
+  db = new Kysely<Database>({
     dialect: driver,
   })
 
@@ -52,12 +54,8 @@ async function initializeDatabase() {
   }
   logger.debug('Migration results', results)
   logger.success('Database migrated')
-
-  return db
 }
 
-const db = await initializeDatabase()
-
 /**
  * @see https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#matching-a-cache-key
  */

lib/storage/index.ts

@@ -20,7 +20,9 @@ await fs.mkdir(bufferDir, {
   recursive: true,
 })
 
-async function initializeStorageDriver() {
+let storageAdapter: StorageAdapter
+
+export async function initializeStorageAdapter() {
   try {
     const driverName = ENV.STORAGE_DRIVER
     const driverSetup = getStorageDriver(driverName)
@@ -38,7 +40,7 @@ async function initializeStorageDriver() {
     const commitLocks = new Set<number>()
     const uploadChunkLocks = new Map<string, Promise<any>>()
 
-    return <StorageAdapter>{
+    storageAdapter = {
       async reserveCache(key, version, cacheSize) {
         logger.debug('Reserve: Reserving cache for', key, version, cacheSize ?? '[no cache size]')
         const bufferKey = `${key}:${version}`
@@ -199,4 +201,6 @@ async function initializeStorageDriver() {
   }
 }
 
-export const storageAdapter = await initializeStorageDriver()
+export function useStorageAdapter() {
+  return storageAdapter
+}

package.json

@@ -30,6 +30,7 @@
     "better-sqlite3": "^11.1.2",
     "consola": "^3.2.3",
     "croner": "^8.1.0",
+    "execa": "^9.3.1",
     "h3": "^1.12.0",
     "kysely": "^0.27.4",
     "minio": "^8.0.1",
@@ -66,5 +67,10 @@
     "ts-pattern": "^5.2.0",
     "vitest": "^2.0.4",
     "wait-on": "^8.0.0"
+  },
+  "pnpm": {
+    "patchedDependencies": {
+      "nitropack@2.9.7": "patches/nitropack@2.9.7.patch"
+    }
   }
 }

patches/nitropack@2.9.7.patch

@@ -0,0 +1,41 @@
+diff --git a/dist/runtime/app.mjs b/dist/runtime/app.mjs
+index 6e968f59e719851b0fc166bc02a30e41ebbb8e63..10d19fed1cf71f82d912be1210dc9ec906fe9d6f 100644
+--- a/dist/runtime/app.mjs
++++ b/dist/runtime/app.mjs
+@@ -22,7 +22,7 @@ import { nitroAsyncContext } from "./context.mjs";
+ import { plugins } from "#internal/nitro/virtual/plugins";
+ import errorHandler from "#internal/nitro/virtual/error-handler";
+ import { handlers } from "#internal/nitro/virtual/server-handlers";
+-function createNitroApp() {
++async function createNitroApp() {
+   const config = useRuntimeConfig();
+   const hooks = createHooks();
+   const captureError = (error, context = {}) => {
+@@ -140,7 +140,7 @@ function createNitroApp() {
+   };
+   for (const plugin of plugins) {
+     try {
+-      plugin(app);
++      await plugin(app);
+     } catch (err) {
+       captureError(err, { tags: ["plugin"] });
+       throw err;
+@@ -148,5 +148,5 @@ function createNitroApp() {
+   }
+   return app;
+ }
+-export const nitroApp = createNitroApp();
++export const nitroApp = await createNitroApp();
+ export const useNitroApp = () => nitroApp;
+diff --git a/dist/runtime/plugin.d.ts b/dist/runtime/plugin.d.ts
+index a83e51dc732331862e8eac011e97ae784ee525b8..7907875fe883e837e9305acccdd4cd55a1bf3353 100644
+--- a/dist/runtime/plugin.d.ts
++++ b/dist/runtime/plugin.d.ts
+@@ -1,6 +1,6 @@
+ import type { NitroApp } from "./app";
+ export interface NitroAppPlugin {
+-    (nitro: NitroApp): void;
++    (nitro: NitroApp): Promise<void> | void;
+ }
+ export declare function defineNitroPlugin(def: NitroAppPlugin): NitroAppPlugin;
+ export declare const nitroPlugin: typeof defineNitroPlugin;

plugins/cleanup.ts

@@ -1,9 +1,10 @@
 import { colorize } from 'consola/utils'
 import { Cron } from 'croner'
 
+import { useStorageAdapter } from '~/lib/storage'
+
 import { ENV } from '@/lib/env'
 import { logger } from '@/lib/logger'
-import { storageAdapter } from '@/lib/storage'
 
 export default defineNitroPlugin(() => {
   if (ENV.CLEANUP_OLDER_THAN_DAYS === 0) return
@@ -14,6 +15,6 @@ export default defineNitroPlugin(() => {
     `Cleaning up cache entries older than ${colorize('blue', `${ENV.CLEANUP_OLDER_THAN_DAYS}d`)} with schedule ${colorize('blue', job.getPattern() ?? '')}${nextRun ? ` (next run: ${nextRun.toLocaleString()})` : ''}`,
   )
   job.schedule(async () => {
-    await storageAdapter.pruneCaches(ENV.CLEANUP_OLDER_THAN_DAYS)
+    await useStorageAdapter().pruneCaches(ENV.CLEANUP_OLDER_THAN_DAYS)
   })
 })

plugins/setup.ts

@@ -1,13 +1,15 @@
 import { H3Error } from 'h3'
 
+import { initializeDatabase } from '~/lib/db'
 import { ENV } from '~/lib/env'
 import { logger } from '~/lib/logger'
+import { initializeStorageAdapter } from '~/lib/storage'
 
 export default defineNitroPlugin(async (nitro) => {
   logger.info(`🚀 Starting GitHub Actions Cache Server (${useRuntimeConfig().version})`)
 
-  await import('~/lib/env')
-  await import('~/lib/db')
+  await initializeDatabase()
+  await initializeStorageAdapter()
 
   nitro.hooks.hook('error', (error, { event }) => {
     if (!event) {
@@ -31,6 +33,8 @@ export default defineNitroPlugin(async (nitro) => {
       )
     })
   }
+
+  if (process.send) process.send('nitro:ready')
 })
 
 function obfuscateTokenFromPath(path: string) {