@opennextjs/cloudflare 0.5.1 → 0.5.2

package/dist/api/cloudflare-context.d.ts

@@ -23,7 +23,12 @@ export type CloudflareContext<CfProperties extends Record<string, unknown> = Inc
  *
  * @returns the cloudflare context
  */
-export declare function getCloudflareContext<CfProperties extends Record<string, unknown> = IncomingRequestCfProperties, Context = ExecutionContext>(): CloudflareContext<CfProperties, Context>;
+export declare function getCloudflareContext<CfProperties extends Record<string, unknown> = IncomingRequestCfProperties, Context = ExecutionContext>(options: {
+    async: true;
+}): Promise<CloudflareContext<CfProperties, Context>>;
+export declare function getCloudflareContext<CfProperties extends Record<string, unknown> = IncomingRequestCfProperties, Context = ExecutionContext>(options?: {
+    async: false;
+}): CloudflareContext<CfProperties, Context>;
 /**
  * Performs some initial setup to integrate as best as possible the local Next.js dev server (run via `next dev`)
  * with the open-next Cloudflare adapter

package/dist/api/cloudflare-context.js

@@ -6,41 +6,65 @@
  * Note: this symbol needs to be kept in sync with the one used in `src/cli/templates/worker.ts`
  */
 const cloudflareContextSymbol = Symbol.for("__cloudflare-context__");
+export function getCloudflareContext(options = { async: false }) {
+    return options.async ? getCloudflareContextAsync() : getCloudflareContextSync();
+}
 /**
- * Utility to get the current Cloudflare context
- *
- * @returns the cloudflare context
+ * Get the cloudflare context from the current global scope
+ */
+function getCloudflareContextFromGlobalScope() {
+    const global = globalThis;
+    return global[cloudflareContextSymbol];
+}
+/**
+ * Detects whether the current code is being evaluated in a statically generated route
  */
-export function getCloudflareContext() {
+function inSSG() {
     const global = globalThis;
-    const cloudflareContext = global[cloudflareContextSymbol];
-    if (!cloudflareContext) {
-        // For SSG Next.js creates (jest) workers that run in parallel, those don't get the current global
-        // state so they can't get access to the cloudflare context, unfortunately there isn't anything we
-        // can do about this, so the only solution is to error asking the developer to opt-out of SSG
-        // Next.js sets globalThis.__NEXT_DATA__.nextExport to true for the worker, so we can use that to detect
-        // that the route is being SSG'd (source: https://github.com/vercel/next.js/blob/4e394608423/packages/next/src/export/worker.ts#L55-L57)
-        if (global.__NEXT_DATA__?.nextExport === true) {
-            throw new Error(`\n\nERROR: \`getCloudflareContext\` has been called in a static route` +
-                ` that is not allowed, please either avoid calling \`getCloudflareContext\`` +
-                ` in the route or make the route non static (for example by exporting the` +
-                ` \`dynamic\` route segment config set to \`'force-dynamic'\`.\n`);
-        }
-        // the cloudflare context is initialized by the worker and is always present in production/preview
-        // during local development (`next dev`) it might be missing only if the developers hasn't called
-        // the `initOpenNextCloudflareForDev` function in their Next.js config file
-        throw new Error(`\n\nERROR: \`getCloudflareContext\` has been called without having called` +
-            ` \`initOpenNextCloudflareForDev\` from the Next.js config file.\n` +
-            `You should update your Next.js config file as shown below:\n\n` +
-            "   ```\n   // next.config.mjs\n\n" +
-            `   import { initOpenNextCloudflareForDev } from "@opennextjs/cloudflare";\n\n` +
-            `   initOpenNextCloudflareForDev();\n\n` +
-            "   const nextConfig = { ... };\n" +
-            "   export default nextConfig;\n" +
-            "   ```\n" +
-            "\n");
+    // Note: Next.js sets globalThis.__NEXT_DATA__.nextExport to true for SSG routes
+    // source: https://github.com/vercel/next.js/blob/4e394608423/packages/next/src/export/worker.ts#L55-L57)
+    return global.__NEXT_DATA__?.nextExport === true;
+}
+/**
+ * Utility to get the current Cloudflare context in sync mode
+ */
+function getCloudflareContextSync() {
+    const cloudflareContext = getCloudflareContextFromGlobalScope();
+    if (cloudflareContext) {
+        return cloudflareContext;
+    }
+    // The sync mode of `getCloudflareContext`, relies on the context being set on the global state
+    // by either the worker entrypoint (in prod) or by `initOpenNextCloudflareForDev` (in dev), neither
+    // can work during SSG since for SSG Next.js creates (jest) workers that don't get access to the
+    // normal global state so we throw with a helpful error message.
+    if (inSSG()) {
+        throw new Error(`\n\nERROR: \`getCloudflareContext\` has been called in a static route,` +
+            ` that is not allowed, this can be solved in different ways:\n\n` +
+            ` - call \`getCloudflareContext({async: true})\` to use the \`async\` mode\n` +
+            ` - avoid calling \`getCloudflareContext\` in the route\n` +
+            ` - make the route non static\n`);
+    }
+    throw new Error(initOpenNextCloudflareForDevErrorMsg);
+}
+/**
+ * Utility to get the current Cloudflare context in async mode
+ */
+async function getCloudflareContextAsync() {
+    const cloudflareContext = getCloudflareContextFromGlobalScope();
+    if (cloudflareContext) {
+        return cloudflareContext;
+    }
+    // Note: Next.js sets process.env.NEXT_RUNTIME to 'nodejs' when the runtime in use is the node.js one
+    // We want to detect when the runtime is the node.js one so that during development (`next dev`) we know wether
+    // we are or not in a node.js process and that access to wrangler's node.js apis
+    const inNodejsRuntime = process.env.NEXT_RUNTIME === "nodejs";
+    if (inNodejsRuntime || inSSG()) {
+        // we're in a node.js process and also in "async mode" so we can use wrangler to asynchronously get the context
+        const cloudflareContext = await getCloudflareContextFromWrangler();
+        addCloudflareContextToNodejsGlobal(cloudflareContext);
+        return cloudflareContext;
     }
-    return cloudflareContext;
+    throw new Error(initOpenNextCloudflareForDevErrorMsg);
 }
 /**
  * Performs some initial setup to integrate as best as possible the local Next.js dev server (run via `next dev`)
@@ -72,7 +96,7 @@ function shouldContextInitializationRun() {
     return !!AsyncLocalStorage;
 }
 /**
- * Adds the cloudflare context to the global scope in which the Next.js dev node.js process runs in, enabling
+ * Adds the cloudflare context to the global scope of the current node.js process, enabling
  * future calls to `getCloudflareContext` to retrieve and return such context
  *
  * @param cloudflareContext the cloudflare context to add to the node.sj global scope
@@ -120,3 +144,16 @@ async function getCloudflareContextFromWrangler() {
         ctx: ctx,
     };
 }
+// In production the cloudflare context is initialized by the worker so it is always available.
+// During local development (`next dev`) it might be missing only if the developers hasn't called
+// the `initOpenNextCloudflareForDev` function in their Next.js config file
+const initOpenNextCloudflareForDevErrorMsg = `\n\nERROR: \`getCloudflareContext\` has been called without having called` +
+    ` \`initOpenNextCloudflareForDev\` from the Next.js config file.\n` +
+    `You should update your Next.js config file as shown below:\n\n` +
+    "   ```\n   // next.config.mjs\n\n" +
+    `   import { initOpenNextCloudflareForDev } from "@opennextjs/cloudflare";\n\n` +
+    `   initOpenNextCloudflareForDev();\n\n` +
+    "   const nextConfig = { ... };\n" +
+    "   export default nextConfig;\n" +
+    "   ```\n" +
+    "\n";

package/dist/cli/templates/worker.js

@@ -6,13 +6,11 @@ import { handler as middlewareHandler } from "./middleware/handler.mjs";
 // @ts-expect-error: resolved by wrangler build
 import { handler as serverHandler } from "./server-functions/default/handler.mjs";
 const cloudflareContextALS = new AsyncLocalStorage();
-// Note: this symbol needs to be kept in sync with the one defined in `src/api/get-cloudflare-context.ts`
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-globalThis[Symbol.for("__cloudflare-context__")] = new Proxy({}, {
-    ownKeys: () => Reflect.ownKeys(cloudflareContextALS.getStore()),
-    getOwnPropertyDescriptor: (_, ...args) => Reflect.getOwnPropertyDescriptor(cloudflareContextALS.getStore(), ...args),
-    get: (_, property) => Reflect.get(cloudflareContextALS.getStore(), property),
-    set: (_, property, value) => Reflect.set(cloudflareContextALS.getStore(), property, value),
+// Note: this symbol needs to be kept in sync with `src/api/get-cloudflare-context.ts`
+Object.defineProperty(globalThis, Symbol.for("__cloudflare-context__"), {
+    get() {
+        return cloudflareContextALS.getStore();
+    },
 });
 // Populate process.env on the first request
 let processEnvPopulated = false;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"