fix: safer mock resolves

Maybe fixes #345

Author: harlan-zw

src/build/build.ts

@@ -9,7 +9,7 @@ import { dirname } from 'pathe'
 import { applyNitroPresetCompatibility, getPresetNitroPresetCompatibility, resolveNitroPreset } from '../compatibility'
 
 // we need all of the runtime dependencies when using build
-export async function setupBuildHandler(config: ModuleOptions, resolve: Resolver['resolve'], nuxt: Nuxt = useNuxt()) {
+export async function setupBuildHandler(config: ModuleOptions, resolve: Resolver, nuxt: Nuxt = useNuxt()) {
   nuxt.options.nitro.storage = nuxt.options.nitro.storage || {}
   if (typeof config.runtimeCacheStorage === 'object')
     nuxt.options.nitro.storage['og-image'] = config.runtimeCacheStorage
@@ -18,12 +18,12 @@ export async function setupBuildHandler(config: ModuleOptions, resolve: Resolver
     await applyNitroPresetCompatibility(nitroConfig, { compatibility: config.compatibility?.runtime, resolve })
     // patch implicit dependencies:
     // - playwright-core
-    nitroConfig.alias!.electron = resolve('./runtime/mock/proxy-cjs')
-    nitroConfig.alias!.bufferutil = resolve('./runtime/mock/proxy-cjs')
-    nitroConfig.alias!['utf-8-validate'] = resolve('./runtime/mock/proxy-cjs')
+    nitroConfig.alias!.electron = await resolve.resolvePath('./runtime/mock/proxy-cjs')
+    nitroConfig.alias!.bufferutil = await resolve.resolvePath('./runtime/mock/proxy-cjs')
+    nitroConfig.alias!['utf-8-validate'] = await resolve.resolvePath('./runtime/mock/proxy-cjs')
     // - image-size
-    nitroConfig.alias!.queue = resolve('./runtime/mock/proxy-cjs')
-    nitroConfig.alias!['chromium-bidi'] = resolve('./runtime/mock/proxy-cjs')
+    nitroConfig.alias!.queue = await resolve.resolvePath('./runtime/mock/proxy-cjs')
+    nitroConfig.alias!['chromium-bidi'] = await resolve.resolvePath('./runtime/mock/proxy-cjs')
   })
 
   // HACK: we need to patch the compiled output to fix the wasm resolutions using esmImport

src/build/dev.ts

@@ -5,7 +5,7 @@ import { useNuxt } from '@nuxt/kit'
 import { applyNitroPresetCompatibility } from '../compatibility'
 
 // we need all of the runtime dependencies when using build
-export function setupDevHandler(options: ModuleOptions, resolve: Resolver['resolve'], nuxt: Nuxt = useNuxt()) {
+export function setupDevHandler(options: ModuleOptions, resolve: Resolver, nuxt: Nuxt = useNuxt()) {
   nuxt.hooks.hook('nitro:config', async (nitroConfig) => {
     await applyNitroPresetCompatibility(nitroConfig, { compatibility: options.compatibility?.dev, resolve })
   })

src/build/generate.ts

@@ -6,7 +6,7 @@ import { applyNitroPresetCompatibility } from '../compatibility'
 
 // we don't need any of the runtime dependencies when we use nuxt generate
 // same as dev but we inject the aliases into the prerender config and noop the regular nitro
-export function setupGenerateHandler(options: ModuleOptions, resolve: Resolver['resolve'], nuxt: Nuxt = useNuxt()) {
+export function setupGenerateHandler(options: ModuleOptions, resolve: Resolver, nuxt: Nuxt = useNuxt()) {
   nuxt.hooks.hook('nitro:config', async (nitroConfig) => {
     // bindings
     await applyNitroPresetCompatibility(nitroConfig, {

src/build/prerender.ts

@@ -6,7 +6,7 @@ import { applyNitroPresetCompatibility } from '../compatibility'
 
 // prerender will always be called when using nuxi generate and sometimes be used when using nuxi build
 
-export function setupPrerenderHandler(options: ModuleOptions, resolve: Resolver['resolve'], nuxt: Nuxt = useNuxt()) {
+export function setupPrerenderHandler(options: ModuleOptions, resolve: Resolver, nuxt: Nuxt = useNuxt()) {
   nuxt.hooks.hook('nitro:init', async (nitro) => {
     nitro.hooks.hook('prerender:config', async (nitroConfig) => {
       // bindings

src/compatibility.ts

@@ -1,3 +1,4 @@
+import type { Resolver } from '@nuxt/kit'
 import type { Nuxt } from '@nuxt/schema'
 import type { NitroConfig } from 'nitropack'
 import type { CompatibilityFlags, RuntimeCompatibilitySchema } from './runtime/types'
@@ -129,7 +130,7 @@ export function getPresetNitroPresetCompatibility(target: string) {
   return compatibility
 }
 
-export async function applyNitroPresetCompatibility(nitroConfig: NitroConfig, options: { compatibility?: CompatibilityFlags, resolve: (s: string) => string, overrides?: RuntimeCompatibilitySchema }): Promise<Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>> {
+export async function applyNitroPresetCompatibility(nitroConfig: NitroConfig, options: { compatibility?: CompatibilityFlags, resolve: Resolver, overrides?: RuntimeCompatibilitySchema }): Promise<Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>>> {
   const target = resolveNitroPreset(nitroConfig)
   const compatibility: RuntimeCompatibilitySchema = getPresetNitroPresetCompatibility(target)
 
@@ -141,11 +142,12 @@ export async function applyNitroPresetCompatibility(nitroConfig: NitroConfig, op
   const satoriEnabled = typeof options.compatibility?.satori !== 'undefined' ? !!options.compatibility.satori : !!compatibility.satori
   const chromiumEnabled = typeof options.compatibility?.chromium !== 'undefined' ? !!options.compatibility.chromium : !!compatibility.chromium
   // renderers
-  nitroConfig.alias!['#og-image/renderers/satori'] = satoriEnabled ? resolve('./runtime/server/og-image/satori/renderer') : resolve('./runtime/mock/empty')
-  nitroConfig.alias!['#og-image/renderers/chromium'] = chromiumEnabled ? resolve('./runtime/server/og-image/chromium/renderer') : resolve('./runtime/mock/empty')
+  const emptyMock = await resolve.resolvePath('./runtime/mock/empty')
+  nitroConfig.alias!['#og-image/renderers/satori'] = satoriEnabled ? await resolve.resolvePath('./runtime/server/og-image/satori/renderer') : emptyMock
+  nitroConfig.alias!['#og-image/renderers/chromium'] = chromiumEnabled ? await resolve.resolvePath('./runtime/server/og-image/chromium/renderer') : emptyMock
 
   const resolvedCompatibility: Partial<Omit<RuntimeCompatibilitySchema, 'wasm'>> = {}
-  function applyBinding(key: keyof Omit<RuntimeCompatibilitySchema, 'wasm'>) {
+  async function applyBinding(key: keyof Omit<RuntimeCompatibilitySchema, 'wasm'>) {
     let binding = options.compatibility?.[key]
     if (typeof binding === 'undefined')
       binding = compatibility[key]
@@ -160,15 +162,15 @@ export async function applyNitroPresetCompatibility(nitroConfig: NitroConfig, op
     // @ts-expect-error untyped
     resolvedCompatibility[key] = binding
     return {
-      [`#og-image/bindings/${key}`]: binding === false ? resolve('./runtime/mock/empty') : resolve(`./runtime/server/og-image/bindings/${key}/${binding}`),
+      [`#og-image/bindings/${key}`]: binding === false ? emptyMock : await resolve.resolvePath(`./runtime/server/og-image/bindings/${key}/${binding}`),
     }
   }
   nitroConfig.alias = defu(
-    applyBinding('chromium'),
-    applyBinding('satori'),
-    applyBinding('resvg'),
-    applyBinding('sharp'),
-    applyBinding('css-inline'),
+    await applyBinding('chromium'),
+    await applyBinding('satori'),
+    await applyBinding('resvg'),
+    await applyBinding('sharp'),
+    await applyBinding('css-inline'),
     nitroConfig.alias || {},
   )
   // if we're using any wasm modules we need to enable the wasm runtime

src/module.ts

@@ -169,7 +169,8 @@ export default defineNuxtModule<ModuleOptions>({
     }
   },
   async setup(config, nuxt) {
-    const { resolve } = createResolver(import.meta.url)
+    const resolver = createResolver(import.meta.url)
+    const { resolve } = resolver
     const { version } = await readPackageJSON(resolve('../package.json'))
     logger.level = (config.debug || nuxt.options.debug) ? 4 : 3
     if (config.enabled === false) {
@@ -611,19 +612,19 @@ declare module '#og-image/unocss-config' {
 
     // Setup playground. Only available in development
     if (nuxt.options.dev) {
-      setupDevHandler(config, resolve)
+      setupDevHandler(config, resolver)
       setupDevToolsUI(config, resolve)
     }
     else if (isNuxtGenerate()) {
-      setupGenerateHandler(config, resolve)
+      setupGenerateHandler(config, resolver)
     }
     else if (nuxt.options.build) {
-      await setupBuildHandler(config, resolve)
+      await setupBuildHandler(config, resolver)
     }
     // no way to know if we'll prerender any routes
     if (nuxt.options.build)
       addServerPlugin(resolve('./runtime/server/plugins/prerender'))
     // always call this as we may have routes only discovered at build time
-    setupPrerenderHandler(config, resolve)
+    setupPrerenderHandler(config, resolver)
   },
 })

src/runtime/mock/empty.ts

@@ -1,4 +1,3 @@
-// @ts-expect-error missing types
 import empty from 'mocked-exports/empty'
 
 export default empty

src/runtime/mock/proxy-cjs.ts

@@ -1,4 +1,3 @@
-// @ts-expect-error missing types
 import proxy from 'mocked-exports/proxy-cjs'
 
 export default proxy