feat: enable nitro node-cluster preset

Author: LouisHaftmann

lib/db/index.ts

@@ -1,7 +1,8 @@
 import type { Selectable } from 'kysely'
-
 import type { DatabaseDriverName } from '~/lib/db/drivers'
 
+import cluster from 'node:cluster'
+
 import { hash } from 'node:crypto'
 import { Kysely, Migrator } from 'kysely'
 import { getDatabaseDriver } from '~/lib/db/drivers'
@@ -57,31 +58,33 @@ export async function initializeDatabase() {
       // eslint-disable-next-line unicorn/no-process-exit
       process.exit(1)
     }
-    logger.info(`Using database driver: ${driverName}`)
+    if (cluster.isPrimary) logger.info(`Using database driver: ${driverName}`)
 
     const driver = await driverSetup()
 
     _db = new Kysely<Database>({
       dialect: driver,
     })
 
-    logger.info('Migrating database...')
-    const migrator = new Migrator({
-      db: _db,
-      provider: {
-        async getMigrations() {
-          return migrations(driverName as DatabaseDriverName)
+    if (cluster.isPrimary) {
+      logger.info('Migrating database...')
+      const migrator = new Migrator({
+        db: _db,
+        provider: {
+          async getMigrations() {
+            return migrations(driverName as DatabaseDriverName)
+          },
         },
-      },
-    })
-    const { error, results } = await migrator.migrateToLatest()
-    if (error) {
-      logger.error('Database migration failed', error)
-      // eslint-disable-next-line unicorn/no-process-exit
-      process.exit(1)
+      })
+      const { error, results } = await migrator.migrateToLatest()
+      if (error) {
+        logger.error('Database migration failed', error)
+        // eslint-disable-next-line unicorn/no-process-exit
+        process.exit(1)
+      }
+      logger.debug('Migration results', results)
+      logger.success('Database migrated')
     }
-    logger.debug('Migration results', results)
-    logger.success('Database migrated')
   }
 
   initializationPromise = init()

lib/logger.ts

@@ -1,10 +1,11 @@
-import { createConsola, LogLevels } from 'consola'
+import cluster from 'node:cluster'
 
+import { createConsola, LogLevels } from 'consola'
 import { ENV } from '~/lib/env'
 
 export const logger = createConsola({
   defaults: {
-    tag: 'cache-server',
+    tag: cluster.isPrimary ? 'cache-server' : `cache-server-node-${cluster.worker?.id}`,
   },
   level: ENV.DEBUG ? LogLevels.debug : LogLevels.info,
 })

lib/storage/index.ts

@@ -1,7 +1,8 @@
 import type { Buffer } from 'node:buffer'
-
 import type { Readable } from 'node:stream'
 
+import cluster from 'node:cluster'
+
 import { randomBytes, randomInt } from 'node:crypto'
 import consola from 'consola'
 import {
@@ -62,7 +63,7 @@ export async function initializeStorage() {
         // eslint-disable-next-line unicorn/no-process-exit
         process.exit(1)
       }
-      logger.info(`Using storage driver: ${driverName}`)
+      if (cluster.isPrimary) logger.info(`Using storage driver: ${driverName}`)
 
       const driver = await driverSetup()
       const db = await useDB()

nitro.config.ts

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url'
 import { version } from './package.json'
 
 export default defineNitroConfig({
-  preset: 'node-server',
+  preset: 'node-cluster',
   runtimeConfig: {
     version: `v${version}${process.env.BUILD_HASH ? ` [${process.env.BUILD_HASH}]` : ''}`,
   },
@@ -21,8 +21,6 @@ export default defineNitroConfig({
   },
   alias: {
     '@': fileURLToPath(new URL('.', import.meta.url)),
-    // https://github.com/unjs/consola/issues/276
-    'consola': 'consola',
   },
   esbuild: {
     options: {

package.json

@@ -33,11 +33,11 @@
     "consola": "^3.4.0",
     "croner": "^9.0.0",
     "execa": "^9.5.2",
-    "h3": "^1.14.0",
+    "h3": "npm:[email protected]",
     "kysely": "^0.27.5",
     "mockttp": "^3.16.0",
     "mysql2": "^3.12.0",
-    "nitropack": "^2.10.4",
+    "nitropack": "npm:[email protected]",
     "pg": "^8.13.1",
     "remeda": "^2.21.0",
     "typescript": "^5.7.3",
@@ -76,7 +76,9 @@
     "onlyBuiltDependencies": [
       "@parcel/watcher",
       "better-sqlite3",
-      "esbuild"
+      "cpu-features",
+      "esbuild",
+      "ssh2"
     ]
   }
 }

plugins/cleanup.ts

@@ -1,3 +1,4 @@
+import cluster from 'node:cluster'
 import { ENV } from '@/lib/env'
 import { logger } from '@/lib/logger'
 
@@ -7,6 +8,8 @@ import { Cron } from 'croner'
 import { useStorageAdapter } from '~/lib/storage'
 
 export default defineNitroPlugin(() => {
+  if (!cluster.isPrimary) return
+
   // cache cleanup
   if (ENV.CACHE_CLEANUP_OLDER_THAN_DAYS > 0) {
     const job = new Cron(ENV.CACHE_CLEANUP_CRON)

plugins/setup.ts

@@ -1,5 +1,6 @@
-import { H3Error } from 'h3'
+import cluster from 'node:cluster'
 
+import { H3Error } from 'h3'
 import { initializeDatabase, useDB } from '~/lib/db'
 import { ENV } from '~/lib/env'
 import { logger } from '~/lib/logger'
@@ -8,9 +9,9 @@ import { initializeStorage, useStorageAdapter } from '~/lib/storage'
 
 export default defineNitroPlugin(async (nitro) => {
   const version = useRuntimeConfig().version
-  logger.info(`🚀 Starting GitHub Actions Cache Server (${version})`)
+  if (cluster.isPrimary) logger.info(`🚀 Starting GitHub Actions Cache Server (${version})`)
 
-  await initializeProxy()
+  if (cluster.isPrimary) await initializeProxy()
   await initializeDatabase()
   await initializeStorage()
 
@@ -37,26 +38,28 @@ export default defineNitroPlugin(async (nitro) => {
 
   if (!version) throw new Error('No version found in runtime config')
 
-  const db = await useDB()
-  const existing = await db
-    .selectFrom('meta')
-    .where('key', '=', 'version')
-    .select('value')
-    .executeTakeFirst()
+  if (cluster.isPrimary) {
+    const db = await 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...`,
-    )
-    const adapter = await useStorageAdapter()
-    await adapter.pruneCaches()
-  }
+    if (!existing || existing.value !== version) {
+      logger.info(
+        `Version changed from ${existing?.value ?? '[no version, first install]'} to ${version}. Pruning cache...`,
+      )
+      const adapter = await useStorageAdapter()
+      await adapter.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()
+    if (existing) {
+      await db.updateTable('meta').set('value', version).where('key', '=', 'version').execute()
+    } else {
+      await db.insertInto('meta').values({ key: 'version', value: version }).execute()
+    }
   }
 
-  if (process.send) process.send('nitro:ready')
+  if (process.send && cluster.isPrimary) process.send('nitro:ready')
 })