feat: check deps instead of installing + big improvements on hubDrizzle

Author: atinux

playground/server/api/tests/db.ts

@@ -1,7 +1,7 @@
 import { sqliteTable, integer, text } from 'drizzle-orm/sqlite-core'
 
 export default defineEventHandler(async () => {
-  const db0 = useDatabase()
+  const db0 = useDatabase('db')
 
   const _tables = await db0.sql`
     SELECT
@@ -14,10 +14,9 @@ export default defineEventHandler(async () => {
       name NOT LIKE 'sqlite_%' and name NOT LIKE '_litestream_%' and name NOT LIKE '__drizzle%'
     ;`
 
-  console.log(_tables.rows)
   const db = await useDrizzle()
 
-  const tables = await db.all(sql`
+  const drizzleTables = await db.all(sql`
     SELECT
       name,
       type
@@ -29,18 +28,14 @@ export default defineEventHandler(async () => {
     ;
   `)
 
-  const todos = sqliteTable('todos', {
-    id: integer('id').primaryKey(),
-    text: text('text')
-  })
   // const inserted = await db.insert(todos).values({ text: 'hello' }).returning().get()
   // const todo = await db.select().from(todos).where(eq(todos.id, inserted.id)).get()
   // const updated = await db.update(todos).set({ text: 'Bonjour' }).where(eq(todos.id, inserted.id)).returning()
-  const all = await db.select().from(todos).limit(3)
+  const all = await db.select().from(tables.todos).limit(3)
   // const deleted = await db.delete(todos).where(eq(todos.id, all[0].id))
 
   return {
-    tables,
+    drizzleTables,
     // todo,
     // inserted,
     // updated,

playground/server/utils/db.ts renamed to playground/server/utils/drizzle.ts

@@ -1,11 +1,7 @@
+
 import { sqliteTable, text, integer } from 'drizzle-orm/sqlite-core'
 // import { pgTable, text as pgText, boolean as pgBoolean, serial as pgSerial, timestamp as pgTimestamp } from 'drizzle-orm/pg-core'
 
-import { drizzle as drizzleSqlite } from 'drizzle-orm/better-sqlite3'
-// import { drizzle as drizzleD1 } from 'drizzle-orm/d1'
-// import { drizzle as drizzlePglite } from 'drizzle-orm/pglite'
-// import { drizzle as drizzlePostgres } from 'drizzle-orm/node-postgres'
-
 export { sql } from 'drizzle-orm'
 
 const todos = sqliteTable('todos', {
@@ -27,12 +23,5 @@ export const tables = {
 }
 
 export async function useDrizzle() {
-  const database = hubDatabase()
-  const instance = await database.getInstance()
-
-  if (import.meta.dev) {
-    return drizzleSqlite(instance, { schema: tables })
-  }
-
-  return drizzleSqlite(instance, { schema: tables })
+  return hubDrizzle({ schema: tables })
 }

src/features/ai.ts

@@ -1,5 +1,4 @@
 import { addServerImportsDir, addServerScanDir, addTypeTemplate, logger } from '@nuxt/kit'
-import { ensureDependencyInstalled } from 'nypm'
 import { logWhenReady } from '../features'
 import { resolve } from '../module'
 
@@ -9,18 +8,14 @@ import type { HubConfig } from '../features'
 
 const log = logger.withTag('nuxt:hub')
 
-export async function setupAI(nuxt: Nuxt, hub: HubConfig) {
+export async function setupAI(nuxt: Nuxt, hub: HubConfig, deps: Record<string, string>) {
   const providerName = hub.ai === 'vercel' ? 'Vercel AI Gateway' : 'Workers AI Provider'
 
-  if (hub.ai === 'vercel') {
-    await Promise.all([
-      ensureDependencyInstalled('@ai-sdk/gateway')
-    ])
-  } else if (hub.ai === 'cloudflare') {
-    await Promise.all([
-      ensureDependencyInstalled('workers-ai-provider')
-    ])
-  } else {
+  if (hub.ai === 'vercel' && !deps['@ai-sdk/gateway']) {
+    return logWhenReady(nuxt, 'Please run `npx nypm i @ai-sdk/gateway` to use Vercel AI Gateway', 'error')
+  } else if (hub.ai === 'cloudflare' && !deps['workers-ai-provider']) {
+    return logWhenReady(nuxt, 'Please run `npx nypm i workers-ai-provider` to use Workers AI Provider', 'error')
+  } else if (hub.ai && !['vercel', 'cloudflare'].includes(hub.ai)) {
     return logWhenReady(nuxt, `\`${hub.ai}\` is not a supported AI provider. Set \`hub.ai\` to \`'vercel'\` or \`'cloudflare'\` in your \`nuxt.config.ts\`. Learn more at https://hub.nuxt.com/docs/features/ai.`, 'error')
   }
 
@@ -58,7 +53,7 @@ export async function setupAI(nuxt: Nuxt, hub: HubConfig) {
   logWhenReady(nuxt, `\`hubAI()\` configured with \`${providerName}\``)
 }
 
-export async function setupProductionAI(nitro: Nitro, hub: HubConfig) {
+export async function setupProductionAI(nitro: Nitro, hub: HubConfig, _deps: Record<string, string>) {
   const preset = nitro.options.preset
   if (!preset) return
 

src/features/blob.ts

@@ -8,11 +8,9 @@ import type { Nitro, NitroOptions } from 'nitropack'
 import type { HubConfig } from '../features'
 import { resolve } from '../module'
 
-import { ensureDependencyInstalled } from 'nypm'
-
 const log = logger.withTag('nuxt:hub')
 
-export function setupBlob(nuxt: Nuxt, hub: HubConfig) {
+export function setupBlob(nuxt: Nuxt, hub: HubConfig, _deps: Record<string, string>) {
   // Configure dev storage
   nuxt.options.nitro.devStorage ||= {}
 
@@ -37,7 +35,7 @@ export function setupBlob(nuxt: Nuxt, hub: HubConfig) {
   logWhenReady(nuxt, `\`hubBlob()\` configured with \`${nuxt.options.nitro.devStorage.blob.driver}\` driver`)
 }
 
-export async function setupProductionBlob(nitro: Nitro, _hub: HubConfig) {
+export async function setupProductionBlob(nitro: Nitro, _hub: HubConfig, deps: Record<string, string>) {
   const preset = nitro.options.preset
   if (!preset) return
 
@@ -135,20 +133,14 @@ export async function setupProductionBlob(nitro: Nitro, _hub: HubConfig) {
 
   if (blobConfig) {
     // check if driver dependencies are installed
-    switch (blobConfig.driver) {
-      case 'vercel-blob':
-        await ensureDependencyInstalled('@vercel/blob')
-        break
-      case 's3':
-        await ensureDependencyInstalled('aws4fetch')
-        break
-      case 'netlify-blobs':
-        await ensureDependencyInstalled('@netlify/blobs')
-        break
-      case 'azure-storage-blob':
-        await ensureDependencyInstalled('@azure/storage-blob')
-        await ensureDependencyInstalled('@azure/identity')
-        break
+    if (blobConfig.driver === 'vercel-blob' && !deps['@vercel/blob']) {
+      throw new Error('Please run `npx nypm i @vercel/blob` to use Vercel Blob')
+    } else if (blobConfig.driver === 's3' && !deps['aws4fetch']) {
+      throw new Error('Please run `npx nypm i aws4fetch` to use S3')
+    } else if (blobConfig.driver === 'netlify-blobs' && !deps['@netlify/blobs']) {
+      throw new Error('Please run `npx nypm i @netlify/blobs` to use Netlify Blobs')
+    } else if (blobConfig.driver === 'azure-storage-blob' && (!deps['@azure/storage-blob'] || !deps['@azure/identity'])) {
+      throw new Error('Please run `npx nypm i @azure/storage-blob @azure/identity` to use Azure Blob Storage')
     }
 
     // set driver

src/features/cache.ts

@@ -12,7 +12,7 @@ import type { HubConfig } from '../features'
 
 const log = logger.withTag('nuxt:hub')
 
-export async function setupCache(nuxt: Nuxt, hub: HubConfig) {
+export async function setupCache(nuxt: Nuxt, hub: HubConfig, _deps: Record<string, string>) {
   // Configure dev storage
   nuxt.options.nitro.devStorage ||= {}
   nuxt.options.nitro.devStorage.cache = defu(nuxt.options.nitro.devStorage.cache, {
@@ -23,10 +23,10 @@ export async function setupCache(nuxt: Nuxt, hub: HubConfig) {
   // Add Server scanning
   addServerScanDir(resolve('runtime/cache/server'))
 
-  logWhenReady(nuxt, `Application cache configured with \`${nuxt.options.nitro.devStorage.cache.driver}\` driver`)
+  logWhenReady(nuxt, `\`Hub cache\` configured with \`${nuxt.options.nitro.devStorage.cache.driver}\` driver`)
 }
 
-export async function setupProductionCache(nitro: Nitro, _hub: HubConfig) {
+export async function setupProductionCache(nitro: Nitro, _hub: HubConfig, _deps: Record<string, string>) {
   const preset = nitro.options.preset
   if (!preset) return
 
@@ -74,6 +74,6 @@ export async function setupProductionCache(nitro: Nitro, _hub: HubConfig) {
   if (cacheConfig) {
     nitro.options.storage ||= {}
     nitro.options.storage.cache = defu(nitro.options.storage?.cache, cacheConfig)
-    log.info(`Application cache configured with \`${nitro.options.storage.cache.driver}\` driver`)
+    log.info(`\`Hub cache\` configured with \`${nitro.options.storage.cache.driver}\` driver`)
   }
 }

src/features/database.ts

@@ -1,8 +1,7 @@
 import { mkdir, writeFile } from 'node:fs/promises'
 import { defu } from 'defu'
 import { join } from 'pathe'
-import { ensureDependencyInstalled } from 'nypm'
-import { addServerImportsDir, addServerScanDir, logger } from '@nuxt/kit'
+import { addServerImportsDir, addServerScanDir, addServerTemplate, addTypeTemplate, logger } from '@nuxt/kit'
 import { copyDatabaseMigrationsToHubDir, copyDatabaseQueriesToHubDir } from '../runtime/database/server/utils/migrations/helpers'
 import { logWhenReady } from '../features'
 import { resolve } from '../module'
@@ -14,7 +13,7 @@ import type { HubConfig } from '../features'
 
 const log = logger.withTag('nuxt:hub')
 
-export async function setupDatabase(nuxt: Nuxt, hub: HubConfig) {
+export async function setupDatabase(nuxt: Nuxt, hub: HubConfig, deps: Record<string, string>) {
   // Configure dev storage
   if (typeof hub.database === 'string' && !['postgresql', 'sqlite', 'mysql'].includes(hub.database)) {
     return logWhenReady(nuxt, `Unknown database dialect set in hub.database: ${hub.database}`, 'error')
@@ -104,7 +103,8 @@ export async function setupDatabase(nuxt: Nuxt, hub: HubConfig) {
         path: join(hub.dir!, 'database/sqlite/db.sqlite3')
       }
     }
-  } else if (dialect === 'mysql') {
+      await mkdir(join(hub.dir!, 'database/sqlite'), { recursive: true })
+    } else if (dialect === 'mysql') {
     if (!nuxt.options.nitro.devDatabase?.db?.connector) {
       logWhenReady(nuxt, '`hubDatabase()` configured with `MySQL` during local development is not supported yet. Please manually configure your development database in `nitro.devDatabase.db` in `nuxt.config.ts`. Learn more at https://hub.nuxt.com/docs/features/database.', 'warn')
     }
@@ -115,14 +115,14 @@ export async function setupDatabase(nuxt: Nuxt, hub: HubConfig) {
 
   // Verify development database dependencies are installed
   const developmentDriver = nuxt.options.nitro.devDatabase?.db?.connector as ConnectorName
-  if (developmentDriver === 'postgresql') {
-    await ensureDependencyInstalled('pg')
-  } else if (developmentDriver === 'pglite') {
-    await ensureDependencyInstalled('@electric-sql/pglite')
-  } else if (developmentDriver === 'mysql2') {
-    await ensureDependencyInstalled('mysql2')
-  } else if (developmentDriver === 'better-sqlite3') {
-    await ensureDependencyInstalled('better-sqlite3')
+  if (developmentDriver === 'postgresql' && !deps.pg) {
+    logWhenReady(nuxt, 'Please run `npx nypm i pg` to use PostgreSQL as database.', 'error')
+  } else if (developmentDriver === 'pglite' && !deps['@electric-sql/pglite']) {
+    logWhenReady(nuxt, 'Please run `npx nypm i @electric-sql/pglite` to use PGlite as database.', 'error')
+  } else if (developmentDriver === 'mysql2' && !deps.mysql2) {
+    logWhenReady(nuxt, 'Please run `npx nypm i mysql2` to use MySQL as database.', 'error')
+  } else if (developmentDriver === 'better-sqlite3' && !deps['better-sqlite3']) {
+    logWhenReady(nuxt, 'Please run `npx nypm i better-sqlite3` to use SQLite as database.', 'error')
   }
 
   // Enable Nitro database
@@ -145,22 +145,14 @@ export async function setupDatabase(nuxt: Nuxt, hub: HubConfig) {
   })
 
   // Setup Drizzle ORM
-  let isDrizzleOrmInstalled = false
-  try {
-    require.resolve('drizzle-orm', { paths: [nuxt.options.rootDir] })
-    isDrizzleOrmInstalled = true
-  } catch {
-    // Ignore
-  }
-
-  if (isDrizzleOrmInstalled) {
+  if (deps['drizzle-orm']) {
     const connector = nuxt.options.nitro.devDatabase.db.connector as ConnectorName
     const dbConfig = nuxt.options.nitro.devDatabase.db.options
 
     // @ts-expect-error not all connectors are supported
     const db0ToDrizzle: Record<ConnectorName, string> = {
       postgresql: 'node-postgres',
-      pglite: 'pglite',
+      pglite: 'pg-proxy',
       mysql2: 'mysql2',
       planetscale: 'planetscale-serverless',
       'better-sqlite3': 'better-sqlite3',
@@ -180,23 +172,29 @@ export async function setupDatabase(nuxt: Nuxt, hub: HubConfig) {
     let connectionConfig = dbConfig
     if (connector === 'postgresql' && dbConfig?.url) {
       connectionConfig = { connectionString: dbConfig.url, ...dbConfig.options }
+    } else if (connector === 'better-sqlite3' && dbConfig?.path) {
+      connectionConfig = { source: dbConfig.path, ...dbConfig.options }
     }
 
     let drizzleOrmContent = `import { drizzle } from 'drizzle-orm/${db0ToDrizzle[connector]}'
-import type { DrizzleConfig } from 'drizzle-orm'
 
-export function hubDrizzle<TSchema extends Record<string, unknown> = Record<string, never>>(options?: DrizzleConfig<TSchema>) {
+export function hubDrizzle(options) {
   return drizzle({
     ...options,
     connection: ${JSON.stringify(connectionConfig)}
   })
 }`
+    const drizzleOrmTypes = `import type { DrizzleConfig } from 'drizzle-orm'
+import { drizzle } from 'drizzle-orm/${db0ToDrizzle[connector]}'
+
+declare module '#hub/drizzle-orm' {
+  export function hubDrizzle<TSchema extends Record<string, unknown> = Record<string, never>>(options?: DrizzleConfig<TSchema>): ReturnType<typeof drizzle<TSchema>>
+}`
 
     if (connector === 'pglite') {
       drizzleOrmContent = `import { drizzle } from 'drizzle-orm/pg-proxy'
-import type { DrizzleConfig } from 'drizzle-orm'
 
-export function hubDrizzle<TSchema extends Record<string, unknown> = Record<string, never>>(options?: DrizzleConfig<TSchema>) {
+export function hubDrizzle(options) {
   return drizzle(async (sql, params, method) => {
     try {
       const rows = await $fetch<any[]>('/api/_hub/database/query', { method: 'POST', body: { sql, params, method } })
@@ -211,18 +209,19 @@ export function hubDrizzle<TSchema extends Record<string, unknown> = Record<stri
 }`
     }
 
-    // create hub directory in .nuxt if it doesn't exist
-    const hubBuildDir = join(nuxt.options.buildDir, 'hub')
-    await mkdir(hubBuildDir, { recursive: true })
-
-    const drizzleOrmPath = join(hubBuildDir, 'drizzle-orm.ts')
-    await writeFile(drizzleOrmPath, drizzleOrmContent, 'utf-8')
-
-    nuxt.options.alias['#hub/drizzle-orm'] = drizzleOrmPath
+    addServerTemplate({
+      filename: '#hub/drizzle-orm',
+      getContents: () => drizzleOrmContent
+    })
+    addTypeTemplate({
+      filename: 'types/hub/drizzle-orm.d.ts',
+      getContents: () => drizzleOrmTypes
+    })
+    addServerImportsDir(resolve('runtime/database/server/drizzle-utils'))
   }
 }
 
-export async function setupProductionDatabase(nitro: Nitro, hub: HubConfig) {
+export async function setupProductionDatabase(nitro: Nitro, hub: HubConfig, deps: Record<string, string>) {
   const preset = nitro.options.preset
   if (!preset) return
 
@@ -238,7 +237,6 @@ export async function setupProductionDatabase(nitro: Nitro, hub: HubConfig) {
 
   switch (preset) {
     // Does your favourite cloud provider require special configuration? Feel free to open a PR to add zero-config support for other presets
-
     case 'vercel': {
       if (dialect === true || dialect === 'postgresql') {
         databaseConfig = {
@@ -347,19 +345,6 @@ export async function setupProductionDatabase(nitro: Nitro, hub: HubConfig) {
   }
 
   if (databaseConfig!) {
-    // check if connector dependencies are installed
-    switch (databaseConfig.connector) {
-      case 'postgresql':
-        await ensureDependencyInstalled('pg')
-        break
-      case 'better-sqlite3':
-        await ensureDependencyInstalled('better-sqlite3')
-        break
-      case 'mysql2':
-        await ensureDependencyInstalled('mysql2')
-        break
-    }
-
     // set connector
     // @ts-expect-error temporarily set to empty object
     nitro.options.database ||= {}

src/features/kv.ts

@@ -1,6 +1,5 @@
 import { join } from 'pathe'
 import { defu } from 'defu'
-import { ensureDependencyInstalled } from 'nypm'
 import { addServerScanDir, addServerImportsDir, logger } from '@nuxt/kit'
 import { logWhenReady } from '../features'
 import { resolve } from '../module'
@@ -11,7 +10,7 @@ import type { HubConfig } from '../features'
 
 const log = logger.withTag('nuxt:hub')
 
-export function setupKV(nuxt: Nuxt, hub: HubConfig) {
+export function setupKV(nuxt: Nuxt, hub: HubConfig, _deps: Record<string, string>) {
   // Configure dev storage
   nuxt.options.nitro.devStorage ||= {}
   nuxt.options.nitro.devStorage.kv = defu(nuxt.options.nitro.devStorage.kv, {
@@ -28,7 +27,7 @@ export function setupKV(nuxt: Nuxt, hub: HubConfig) {
   logWhenReady(nuxt, `\`hubKV()\` configured with \`${driver}\` driver`)
 }
 
-export async function setupProductionKV(nitro: Nitro, _hub: HubConfig) {
+export async function setupProductionKV(nitro: Nitro, _hub: HubConfig, deps: Record<string, string>) {
   const preset = nitro.options.preset
   if (!preset) return
 
@@ -84,10 +83,8 @@ export async function setupProductionKV(nitro: Nitro, _hub: HubConfig) {
 
   if (kvConfig) {
     // check if driver dependencies are installed
-    switch (kvConfig.driver) {
-      case 'redis':
-        await ensureDependencyInstalled('ioredis')
-        break
+    if (kvConfig.driver === 'redis' && !deps['ioredis']) {
+      throw new Error('Please run `npx nypm i ioredis` to use Redis KV storage')
     }
 
     // set driver