feat: support cloudflare env in runtimeConfig

nitrojs · Jun 18, 2023 · 7f840dc · 7f840dc
1 parent 46f4ddf
commit 7f840dc
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 4 deletions.
diff --git a/src/runtime/config.ts b/src/runtime/config.ts
@@ -12,27 +12,46 @@ const ENV_PREFIX_ALT =
   _inlineRuntimeConfig.nitro.envPrefix ?? process.env.NITRO_ENV_PREFIX ?? "_";
 
 // Runtime config
+let appliedRuntimeConfig = {};
 const _sharedRuntimeConfig = _deepFreeze(
   _applyEnv(klona(_inlineRuntimeConfig))
 );
+const getRuntimeConfig = () => ({
+  ..._sharedRuntimeConfig,
+  ...appliedRuntimeConfig,
+});
+
 export function useRuntimeConfig<
   T extends NitroRuntimeConfig = NitroRuntimeConfig
 >(event?: H3Event): T {
   // Backwards compatibility with ambient context
   if (!event) {
-    return _sharedRuntimeConfig as T;
+    return getRuntimeConfig() as T;
   }
   // Reuse cached runtime config from event context
   if (event.context.nitro.runtimeConfig) {
     return event.context.nitro.runtimeConfig;
   }
   // Prepare runtime config for event context
-  const runtimeConfig = klona(_inlineRuntimeConfig) as T;
+  const runtimeConfig = klona(getRuntimeConfig()) as T;
   _applyEnv(runtimeConfig);
   event.context.nitro.runtimeConfig = runtimeConfig;
   return runtimeConfig;
 }
 
+export function applyEnvToRuntimeConfig(
+  env: Record<string, any>,
+  prefixes = ["NITRO", "NUXT"]
+) {
+  const safeEnv = Object.fromEntries(
+    Object.entries(env).filter(([key]) =>
+      prefixes.some((prefix) => key.startsWith(`${prefix}_`))
+    )
+  );
+  appliedRuntimeConfig = safeEnv;
+  return useRuntimeConfig();
+}
+
 // App config
 const _sharedAppConfig = _deepFreeze(klona(_inlineAppConfig));
 export function useAppConfig(event?: H3Event) {

diff --git a/src/runtime/entries/cloudflare-module.ts b/src/runtime/entries/cloudflare-module.ts
@@ -8,6 +8,7 @@ import {
 // @ts-ignore Bundled by Wrangler
 // See https://github.com/cloudflare/kv-asset-handler#asset_manifest-required-for-es-modules
 import manifest from "__STATIC_CONTENT_MANIFEST";
+import { applyEnvToRuntimeConfig } from "../config";
 import { requestHasBody } from "../utils";
 import { nitroApp } from "#internal/nitro/app";
 import { useRuntimeConfig } from "#internal/nitro";
@@ -51,7 +52,7 @@ export default {
 
     // Expose latest env to the global context
     globalThis.__env__ = env;
-
+    applyEnvToRuntimeConfig(env);
     return nitroApp.localFetch(url.pathname + url.search, {
       context: {
         cf: (request as any).cf,

diff --git a/src/runtime/entries/cloudflare-pages.ts b/src/runtime/entries/cloudflare-pages.ts
@@ -3,6 +3,7 @@ import type {
   Request as CFRequest,
   EventContext,
 } from "@cloudflare/workers-types";
+import { applyEnvToRuntimeConfig } from "../config";
 import { requestHasBody } from "#internal/nitro/utils";
 import { nitroApp } from "#internal/nitro/app";
 import { isPublicAssetURL } from "#internal/nitro/virtual/public-assets";
@@ -38,7 +39,7 @@ export default {
 
     // Expose latest env to the global context
     globalThis.__env__ = env;
-
+    applyEnvToRuntimeConfig(env);
     return nitroApp.localFetch(url.pathname + url.search, {
       context: {
         cf: request.cf,

diff --git a/test/presets/cloudflare-module.test.ts b/test/presets/cloudflare-module.test.ts
@@ -15,6 +15,9 @@ describe("nitro:preset:cloudflare-module", async () => {
       scriptPath: resolve(ctx.outDir, "server/index.mjs"),
       sitePath: resolve(ctx.outDir, "public"),
       bindings: {
+        NITRO_HELLO: "world",
+        NUXT_HELLO: "world",
+        SECRET: "secret",
         ASSETS: {
           fetch: async (request) => {
             const contents = await fsp.readFile(

diff --git a/test/presets/cloudflare-pages.test.ts b/test/presets/cloudflare-pages.test.ts
@@ -14,6 +14,9 @@ describe("nitro:preset:cloudflare-pages", async () => {
       modules: true,
       scriptPath: resolve(ctx.outDir, "_worker.js"),
       bindings: {
+        NITRO_HELLO: "world",
+        NUXT_HELLO: "world",
+        SECRET: "secret",
         ASSETS: {
           fetch: async (request) => {
             const contents = await fsp.readFile(

diff --git a/test/tests.ts b/test/tests.ts
@@ -363,4 +363,17 @@ export function testNitro(
       expect(headers["server-timing"]).toMatch(/-;dur=\d+;desc="Generate"/);
     });
   }
+
+  if (
+    ["cloudflare-module", "cloudflare-pages"].includes(ctx.nitro.options.preset)
+  ) {
+    it("can load environment variables", async () => {
+      const { data } = await callHandler({
+        url: "/config",
+      });
+      expect(data.runtimeConfig.NITRO_HELLO).toBe("world");
+      expect(data.runtimeConfig.NUXT_HELLO).toBe("world");
+      expect(data.runtimeConfig.SECRET).toBeUndefined();
+    });
+  }
 }