feat: add setRuntimeConfig module utility

Author: BobbieGoede

build.config.ts

@@ -9,6 +9,7 @@ export default defineBuildConfig({
     'src/experimental',
     'src/config',
     'src/module.ts',
+    isStub ? { input: 'src/module-utils/', outDir: 'dist/module-utils', format: 'esm' } : 'src/module-utils/index.mjs',
     'src/vitest-environment',
     isStub ? { input: 'src/runtime-utils/', outDir: 'dist/runtime-utils', format: 'esm' } : 'src/runtime-utils/index.mjs',
     { input: 'src/runtime/', outDir: 'dist/runtime', format: 'esm' }
@@ -17,5 +18,6 @@ export default defineBuildConfig({
     "#app/entry",
     "#build/root-component.mjs",
     "#imports",
-  ]
+  ],
+  failOnWarn: false,
 })

module-utils.d.ts

@@ -0,0 +1 @@
+export * from './dist/module-utils/index.mjs'

package.json

@@ -15,6 +15,7 @@
     "./e2e": "./dist/e2e.mjs",
     "./experimental": "./dist/experimental.mjs",
     "./module": "./dist/module.mjs",
+    "./module-utils": "./dist/module-utils/index.mjs",
     "./runtime": "./dist/runtime-utils/index.mjs",
     "./vitest-environment": "./dist/vitest-environment.mjs"
   },
@@ -81,6 +82,7 @@
     "nuxt": "3.8.2",
     "playwright-core": "1.40.1",
     "rollup": "4.7.0",
+    "scule": "^1.1.1",
     "semver": "7.5.4",
     "unbuild": "latest",
     "unimport": "3.6.1",

pnpm-lock.yaml

@@ -6,11 +6,12 @@ import * as _kit from '@nuxt/kit'
 import { resolve } from 'pathe'
 import { useTestContext } from './context'
 
+
 // @ts-expect-error type cast
 // eslint-disable-next-line
 const kit: typeof _kit = _kit.default || _kit
 
-export async function startServer () {
+export async function startServer (env: Record<string, unknown> = {}) {
   const ctx = useTestContext()
   await stopServer()
   const host = '127.0.0.1'
@@ -26,7 +27,8 @@ export async function startServer () {
         _PORT: String(port), // Used by internal _dev command
         PORT: String(port),
         HOST: host,
-        NODE_ENV: 'development'
+        NODE_ENV: 'development',
+        ...env
       }
     })
     await waitForPort(port, { retries: 32, host }).catch(() => {})
@@ -53,7 +55,8 @@ export async function startServer () {
         ...process.env,
         PORT: String(port),
         HOST: host,
-        NODE_ENV: 'test'
+        NODE_ENV: 'test',
+        ...env
       }
     })
     await waitForPort(port, { retries: 20, host })

src/core/server.ts

@@ -0,0 +1 @@
+export { setRuntimeConfig } from './runtime-config'

src/module-utils/index.mjs

@@ -0,0 +1,47 @@
+import { snakeCase } from "scule"
+import { startServer } from "../e2e";
+
+const NUXT_ENV_PREFIX = 'NUXT_'
+
+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>) {
+  const makeEnvKey = (str: string) => `${NUXT_ENV_PREFIX}${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(env: Record<string, unknown>) {
+  const converted = convertObjectToConfig(env)
+  await startServer(converted)
+
+  // restore
+  return async () => startServer()
+}