feat(e2e): support env option for startServer

examples/module/test/basic.test.ts

@@ -1,6 +1,6 @@
 import { fileURLToPath } from 'node:url'
 import { describe, expect, it } from 'vitest'
-import { $fetch, setup } from '@nuxt/test-utils/e2e'
+import { $fetch, setRuntimeConfig, setup } from '@nuxt/test-utils/e2e'
 
 describe('ssr', async () => {
   await setup({
@@ -10,6 +10,17 @@ describe('ssr', async () => {
   it('renders the index page', async () => {
     // Get response to a server-rendered page with `$fetch`.
     const html = await $fetch('/')
-    expect(html).toContain('<div>basic</div>')
+    expect(html).toContain('<div>basic <span>original value</span></div>')
+  })
+
+  it('changes runtime config and restarts', async () => {
+    const restoreConfig = await setRuntimeConfig({ public: { myValue: 'overwritten by test!' } })
+
+    const html = await $fetch('/')
+    expect(html).toContain('<div>basic <span>overwritten by test!</span></div>')
+
+    await restoreConfig()
+    const htmlRestored = await $fetch('/')
+    expect(htmlRestored).toContain('<div>basic <span>original value</span></div>')
   })
 })

examples/module/test/fixtures/basic/app.vue

@@ -1,6 +1,7 @@
 <template>
-  <div>basic</div>
+  <div>basic <span>{{ config.public.myValue }}</span></div>
 </template>
 
 <script setup>
+const config = useRuntimeConfig();
 </script>

examples/module/test/fixtures/basic/nuxt.config.ts

@@ -1,6 +1,11 @@
 import MyModule from '../../../src/module'
 
 export default defineNuxtConfig({
+  runtimeConfig: {
+    public: {
+      myValue: 'original value',
+    },
+  },
   modules: [
     MyModule
   ]

package.json

@@ -53,6 +53,7 @@
     "pathe": "^1.1.1",
     "perfect-debounce": "^1.0.0",
     "radix3": "^1.1.0",
+    "scule": "^1.1.1",
     "std-env": "^3.6.0",
     "ufo": "^1.3.2",
     "unenv": "^1.8.0",

src/core/runtime-config.ts

@@ -0,0 +1,45 @@
+import { snakeCase } from 'scule'
+import { startServer } from './server'
+
+export function flattenObject(obj: Record<string, unknown> = {}) {
+  const flattened: Record<string, unknown> = {}
+
+  for (const key in obj) {
+    if (!(key in obj)) continue
+
+    const entry = obj[key]
+    if (typeof entry !== 'object' || entry == null) {
+      flattened[key] = obj[key]
+      continue
+    }
+    const flatObject = flattenObject(entry as Record<string, unknown>)
+
+    for (const x in flatObject) {
+      if (!(x in flatObject)) continue
+
+      flattened[key + '_' + x] = flatObject[x]
+    }
+  }
+
+  return flattened
+}
+
+export function convertObjectToConfig(obj: Record<string, unknown>, envPrefix: string) {
+  const makeEnvKey = (str: string) => `${envPrefix}${snakeCase(str).toUpperCase()}`
+
+  const env: Record<string, unknown> = {}
+  const flattened = flattenObject(obj)
+  for (const key in flattened) {
+    env[makeEnvKey(key)] = flattened[key]
+  }
+
+  return env
+}
+
+export async function setRuntimeConfig(config: Record<string, unknown>, envPrefix = 'NUXT_') {
+  const env = convertObjectToConfig(config, envPrefix)
+  await startServer({ env })
+
+  // restore
+  return async () => startServer()
+}

src/core/server.ts

@@ -10,7 +10,11 @@ import { useTestContext } from './context'
 // eslint-disable-next-line
 const kit: typeof _kit = _kit.default || _kit
 
-export async function startServer () {
+export interface StartServerOptions {
+  env?: Record<string, unknown>
+}
+
+export async function startServer (options: StartServerOptions = {}) {
   const ctx = useTestContext()
   await stopServer()
   const host = '127.0.0.1'
@@ -26,7 +30,8 @@ export async function startServer () {
         _PORT: String(port), // Used by internal _dev command
         PORT: String(port),
         HOST: host,
-        NODE_ENV: 'development'
+        NODE_ENV: 'development',
+        ...options.env
       }
     })
     await waitForPort(port, { retries: 32, host }).catch(() => {})
@@ -53,7 +58,8 @@ export async function startServer () {
         ...process.env,
         PORT: String(port),
         HOST: host,
-        NODE_ENV: 'test'
+        NODE_ENV: 'test',
+        ...options.env
       }
     })
     await waitForPort(port, { retries: 20, host })

src/e2e.ts

@@ -5,4 +5,5 @@ export * from './core/nuxt'
 export * from './core/server'
 export * from './core/setup/index'
 export * from './core/run'
+export { setRuntimeConfig } from './core/runtime-config'
 export * from './core/types'