add test to check for Nuxt 3 compatibility (old folder structure)

package.json

@@ -40,9 +40,10 @@
     "prepack": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:playground-disk": "nuxi dev playground-disk",
+    "dev:playground-nuxt3": "nuxi dev playground-nuxt3",
     "dev:build": "nuxi build playground",
     "dev:serve": "node playground/.output/server/index.mjs",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground-disk && nuxi prepare playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground-disk && nuxi prepare playground-nuxt3 && nuxi prepare playground",
     "dev:inspect": "nuxi dev playground --inspect",
     "typecheck": "nuxi typecheck",
     "docs:dev": "vitepress dev docs --port 5000",

playground-nuxt3/app.vue

@@ -0,0 +1,5 @@
+<template>
+  <div class="app">
+    <NuxtPage />
+  </div>
+</template>

playground-nuxt3/app/multiCache.serverOptions.ts

@@ -0,0 +1,7 @@
+import { defineMultiCacheOptions } from './../../src/runtime/serverOptions/defineMultiCacheOptions'
+
+export default defineMultiCacheOptions({
+  cacheKeyPrefix: (): Promise<string> => {
+    return Promise.resolve('MY_CACHE_PREFIX_')
+  },
+})

playground-nuxt3/nuxt.config.ts

@@ -0,0 +1,39 @@
+import { defineNuxtConfig } from 'nuxt/config'
+import NuxtMultiCache from './../src/module'
+
+export default defineNuxtConfig({
+  modules: [NuxtMultiCache],
+
+  imports: {
+    autoImport: true,
+  },
+
+  multiCache: {
+    debug: true,
+    component: {
+      enabled: true,
+    },
+    route: {
+      enabled: true,
+    },
+
+    data: {
+      enabled: true,
+    },
+
+    cdn: {
+      enabled: true,
+    },
+    api: {
+      enabled: true,
+      cacheTagInvalidationDelay: 5000,
+      authorization: false,
+    },
+  },
+
+  compatibilityDate: '2024-10-19',
+
+  future: {
+    compatibilityVersion: 3,
+  },
+})

playground-nuxt3/pages/index.vue

@@ -0,0 +1,11 @@
+<template>
+  <div>This is a cached page.</div>
+</template>
+
+<script lang="ts" setup>
+import { useRouteCache } from '#imports'
+
+useRouteCache((helper) => {
+  helper.setCacheable()
+})
+</script>

playground-nuxt3/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}

src/module.ts

@@ -165,7 +165,7 @@ export default defineNuxtModule<ModuleOptions>({
     // Creates the template with runtime server configuration.
     const extensions = ['js', 'mjs', 'ts']
 
-    const resolvedPath = [
+    const candidates: string[] = [
       '~/multiCache.serverOptions',
       '~/app/multiCache.serverOptions',
     ]
@@ -174,7 +174,10 @@ export default defineNuxtModule<ModuleOptions>({
           .replace(/^(~~|@@)/, nuxt.options.rootDir)
           .replace(/^(~|@)/, nuxt.options.srcDir)
       })
-      .map((fullPath) => fileExists(fullPath))[0]
+      .map((fullPath) => fileExists(fullPath))
+      .filter(Boolean)
+
+    const resolvedPath = candidates[0] as string | undefined
 
     const moduleTypesPath = relative(
       nuxt.options.buildDir,
@@ -184,6 +187,10 @@ export default defineNuxtModule<ModuleOptions>({
     const template = (() => {
       const maybeUserFile = resolvedPath && fileExists(resolvedPath, extensions)
 
+      if (!maybeUserFile) {
+        logger.warn('No multiCache.serverOptions file found.')
+      }
+
       const serverOptionsLine = maybeUserFile
         ? `import serverOptions from '${relative(nuxt.options.buildDir, srcResolver(resolvedPath))}'`
         : `const serverOptions = {}`

test/nuxt3.e2e.spec.ts

@@ -0,0 +1,23 @@
+import path from 'path'
+import { setup, $fetch } from '@nuxt/test-utils/e2e'
+import { describe, expect, test } from 'vitest'
+import purgeAll from './__helpers__/purgeAll'
+
+describe('With Nuxt 3 "classic" folder structure', async () => {
+  await setup({
+    rootDir: path.resolve(__dirname, './../playground-nuxt3'),
+  })
+  test('the serverOptions file is included correctly', async () => {
+    await purgeAll()
+
+    // First call puts it into cache.
+    await $fetch('/', {
+      method: 'get',
+    })
+
+    const stats: any = await $fetch('/__nuxt_multi_cache/stats/route')
+
+    // If the serverOptions was included correctly, it will set a cache prefix.
+    expect(stats.rows[0].key).toContain('MY_CACHE_PREFIX_')
+  })
+})