@opennextjs/cloudflare 1.6.5 → 1.7.1

package/dist/api/config.d.ts

@@ -1,6 +1,6 @@
-import type { BuildOptions } from "@opennextjs/aws/build/helper";
-import { BaseOverride, LazyLoadedOverride, OpenNextConfig as AwsOpenNextConfig, type RoutePreloadingBehavior } from "@opennextjs/aws/types/open-next";
-import type { CDNInvalidationHandler, IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/overrides";
+import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
+import { BaseOverride, LazyLoadedOverride, OpenNextConfig as AwsOpenNextConfig, type RoutePreloadingBehavior } from "@opennextjs/aws/types/open-next.js";
+import type { CDNInvalidationHandler, IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/overrides.js";
 export type Override<T extends BaseOverride> = "dummy" | T | LazyLoadedOverride<T>;
 /**
  * Cloudflare specific overrides.

package/dist/api/durable-objects/bucket-cache-purge.js

@@ -1,5 +1,5 @@
 import { DurableObject } from "cloudflare:workers";
-import { internalPurgeCacheByTags } from "../overrides/internal";
+import { internalPurgeCacheByTags } from "../overrides/internal.js";
 const DEFAULT_BUFFER_TIME_IN_SECONDS = 5;
 // https://developers.cloudflare.com/cache/how-to/purge-cache/#hostname-tag-prefix-url-and-purge-everything-limits
 const MAX_NUMBER_OF_TAGS_PER_PURGE = 100;

package/dist/api/durable-objects/queue.d.ts

@@ -1,4 +1,4 @@
-import type { QueueMessage } from "@opennextjs/aws/types/overrides";
+import type { QueueMessage } from "@opennextjs/aws/types/overrides.js";
 import { DurableObject } from "cloudflare:workers";
 interface FailedState {
     msg: QueueMessage;

package/dist/api/overrides/asset-resolver/index.d.ts

@@ -1,4 +1,4 @@
-import type { AssetResolver } from "@opennextjs/aws/types/overrides";
+import type { AssetResolver } from "@opennextjs/aws/types/overrides.js";
 /**
  * Serves assets when `run_worker_first` is set to true.
  *

package/dist/api/overrides/cache-purge/index.d.ts

@@ -6,7 +6,7 @@ export declare const purgeCache: ({ type }: PurgeOptions) => {
     invalidatePaths(paths: {
         initialPath: string;
         rawPath: string;
-        resolvedRoutes: import("@opennextjs/aws/types/open-next").ResolvedRoute[];
+        resolvedRoutes: import("@opennextjs/aws/types/open-next.js").ResolvedRoute[];
     }[]): Promise<void>;
 };
 export {};

package/dist/api/overrides/cache-purge/index.js

@@ -1,4 +1,5 @@
-import { getCloudflareContext } from "../../cloudflare-context";
+import { error } from "@opennextjs/aws/adapters/logger.js";
+import { getCloudflareContext } from "../../cloudflare-context.js";
 import { debugCache, internalPurgeCacheByTags } from "../internal.js";
 export const purgeCache = ({ type = "direct" }) => {
     return {
@@ -13,7 +14,7 @@ export const purgeCache = ({ type = "direct" }) => {
             else {
                 const durableObject = env.NEXT_CACHE_DO_PURGE;
                 if (!durableObject) {
-                    debugCache("cdnInvalidation", "No durable object found. Skipping cache purge.");
+                    error("Purge cache: NEXT_CACHE_DO_PURGE not found. Skipping cache purge.");
                     return;
                 }
                 const id = durableObject.idFromName("cache-purge");

package/dist/api/overrides/incremental-cache/regional-cache.d.ts

@@ -23,6 +23,14 @@ type Options = {
      * @default `false` for the `short-lived` mode, and `true` for the `long-lived` mode.
      */
     shouldLazilyUpdateOnCacheHit?: boolean;
+    /**
+     * Whether on cache hits the tagCache should be skipped or not. Skipping the tagCache allows requests to be
+     * handled faster, the downside of this is that you need to make sure that the cache gets correctly purged
+     * either by enabling the auto cache purging feature or doing that manually.
+     *
+     * @default `true` if the auto cache purging is enabled, `false` otherwise.
+     */
+    bypassTagCacheOnCacheHit?: boolean;
 };
 interface PutToCacheInput {
     key: string;
@@ -33,6 +41,7 @@ interface PutToCacheInput {
  * Wrapper adding a regional cache on an `IncrementalCache` implementation
  */
 declare class RegionalCache implements IncrementalCache {
+    #private;
     private store;
     private opts;
     name: string;

package/dist/api/overrides/incremental-cache/regional-cache.js

@@ -21,6 +21,15 @@ class RegionalCache {
         this.name = this.store.name;
         this.opts.shouldLazilyUpdateOnCacheHit ??= this.opts.mode === "long-lived";
     }
+    get #bypassTagCacheOnCacheHit() {
+        if (this.opts.bypassTagCacheOnCacheHit !== undefined) {
+            // If the bypassTagCacheOnCacheHit option is set we return that one
+            return this.opts.bypassTagCacheOnCacheHit;
+        }
+        // Otherwise we default to whether the automatic cache purging is enabled or not
+        const hasAutomaticCachePurging = !!getCloudflareContext().env.NEXT_CACHE_DO_PURGE;
+        return hasAutomaticCachePurging;
+    }
     async get(key, cacheType) {
         try {
             const cache = await this.getCacheInstance();
@@ -38,7 +47,11 @@ class RegionalCache {
                         }
                     }));
                 }
-                return cachedResponse.json();
+                const responseJson = await cachedResponse.json();
+                return {
+                    ...responseJson,
+                    shouldBypassTagCache: this.#bypassTagCacheOnCacheHit,
+                };
             }
             const rawEntry = await this.store.get(key, cacheType);
             const { value, lastModified } = rawEntry ?? {};

package/dist/api/overrides/internal.js

@@ -1,4 +1,5 @@
 import { createHash } from "node:crypto";
+import { error } from "@opennextjs/aws/adapters/logger.js";
 import { getCloudflareContext } from "../cloudflare-context.js";
 export const debugCache = (name, ...args) => {
     if (process.env.NEXT_PRIVATE_DEBUG_CACHE) {
@@ -31,7 +32,7 @@ export async function purgeCacheByTags(tags) {
 export async function internalPurgeCacheByTags(env, tags) {
     if (!env.CACHE_PURGE_ZONE_ID && !env.CACHE_PURGE_API_TOKEN) {
         // THIS IS A NO-OP
-        debugCache("purgeCacheByTags", "No cache zone ID or API token provided. Skipping cache purge.");
+        error("No cache zone ID or API token provided. Skipping cache purge.");
         return "missing-credentials";
     }
     let response;
@@ -48,12 +49,12 @@ export async function internalPurgeCacheByTags(env, tags) {
         });
         if (response.status === 429) {
             // Rate limit exceeded
-            debugCache("purgeCacheByTags", "Rate limit exceeded. Skipping cache purge.");
+            error("purgeCacheByTags: Rate limit exceeded. Skipping cache purge.");
             return "rate-limit-exceeded";
         }
         const bodyResponse = (await response.json());
         if (!bodyResponse.success) {
-            debugCache("purgeCacheByTags", "Cache purge failed. Errors:", bodyResponse.errors.map((error) => `${error.code}: ${error.message}`));
+            error("purgeCacheByTags: Cache purge failed. Errors:", bodyResponse.errors.map((error) => `${error.code}: ${error.message}`));
             return "purge-failed";
         }
         debugCache("purgeCacheByTags", "Cache purged successfully for tags:", tags);

package/dist/api/overrides/queue/do-queue.d.ts

@@ -1,4 +1,4 @@
-import type { QueueMessage } from "@opennextjs/aws/types/overrides";
+import type { QueueMessage } from "@opennextjs/aws/types/overrides.js";
 declare const _default: {
     name: string;
     send: (msg: QueueMessage) => Promise<void>;

package/dist/api/overrides/queue/do-queue.js

@@ -1,5 +1,5 @@
 import { IgnorableError } from "@opennextjs/aws/utils/error.js";
-import { getCloudflareContext } from "../../cloudflare-context";
+import { getCloudflareContext } from "../../cloudflare-context.js";
 export default {
     name: "durable-queue",
     send: async (msg) => {

package/dist/api/overrides/queue/memory-queue.js

@@ -1,7 +1,7 @@
 import { error } from "@opennextjs/aws/adapters/logger.js";
 import { IgnorableError } from "@opennextjs/aws/utils/error.js";
-import { getCloudflareContext } from "../../cloudflare-context";
-import { debugCache } from "../internal";
+import { getCloudflareContext } from "../../cloudflare-context.js";
+import { debugCache } from "../internal.js";
 export const DEFAULT_REVALIDATION_TIMEOUT_MS = 10_000;
 /**
  * The Memory Queue offers basic ISR revalidation by directly requesting a revalidation of a route.

package/dist/api/overrides/queue/queue-cache.d.ts

@@ -1,4 +1,4 @@
-import type { Queue, QueueMessage } from "@opennextjs/aws/types/overrides";
+import type { Queue, QueueMessage } from "@opennextjs/aws/types/overrides.js";
 interface QueueCachingOptions {
     /**
      * The TTL for the regional cache in seconds.

package/dist/api/overrides/tag-cache/do-sharded-tag-cache.js

@@ -1,8 +1,8 @@
 import { debug, error } from "@opennextjs/aws/adapters/logger.js";
 import { generateShardId } from "@opennextjs/aws/core/routing/queue.js";
 import { IgnorableError } from "@opennextjs/aws/utils/error.js";
-import { getCloudflareContext } from "../../cloudflare-context";
-import { debugCache, purgeCacheByTags } from "../internal";
+import { getCloudflareContext } from "../../cloudflare-context.js";
+import { debugCache, purgeCacheByTags } from "../internal.js";
 export const DEFAULT_WRITE_RETRIES = 3;
 export const DEFAULT_NUM_SHARDS = 4;
 export const NAME = "do-sharded-tag-cache";

package/dist/api/overrides/tag-cache/tag-cache-filter.d.ts

@@ -1,4 +1,4 @@
-import { NextModeTagCache } from "@opennextjs/aws/types/overrides";
+import { NextModeTagCache } from "@opennextjs/aws/types/overrides.js";
 interface WithFilterOptions {
     /**
      * The original tag cache.

package/dist/cli/build/build.js

@@ -35,6 +35,8 @@ export async function build(options, config, projectOpts, wranglerConfig) {
     const { aws, cloudflare } = getVersion();
     logger.info(`@opennextjs/cloudflare version: ${cloudflare}`);
     logger.info(`@opennextjs/aws version: ${aws}`);
+    // Clean the output directory before building the Next app.
+    buildHelper.initOutputDir(options);
     if (projectOpts.skipNextBuild) {
         logger.warn("Skipping Next.js build");
     }
@@ -46,7 +48,6 @@ export async function build(options, config, projectOpts, wranglerConfig) {
     }
     // Generate deployable bundle
     printHeader("Generating bundle");
-    buildHelper.initOutputDir(options);
     compileCache(options);
     compileEnvFiles(options);
     compileInit(options, wranglerConfig);

package/dist/cli/build/bundle-server.js

@@ -13,7 +13,6 @@ import { inlineFindDir } from "./patches/plugins/find-dir.js";
 import { patchInstrumentation } from "./patches/plugins/instrumentation.js";
 import { inlineLoadManifest } from "./patches/plugins/load-manifest.js";
 import { patchNextServer } from "./patches/plugins/next-server.js";
-import { patchNodeEnvironment } from "./patches/plugins/node-environment.js";
 import { patchResolveCache } from "./patches/plugins/open-next.js";
 import { handleOptionalDependencies } from "./patches/plugins/optional-deps.js";
 import { patchPagesRouterContext } from "./patches/plugins/pages-router-context.js";
@@ -91,7 +90,6 @@ export async function bundleServer(buildOpts, projectOpts) {
             patchRouteModules(updater, buildOpts),
             patchDepdDeprecations(updater),
             patchResolveCache(updater, buildOpts),
-            patchNodeEnvironment(updater),
             // Apply updater updates, must be the last plugin
             updater.plugin,
         ],

package/dist/cli/build/open-next/compile-skew-protection.d.ts

@@ -1,3 +1,3 @@
 import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
-import type { OpenNextConfig } from "../../../api";
+import type { OpenNextConfig } from "../../../api/index.js";
 export declare function compileSkewProtection(options: BuildOptions, config: OpenNextConfig): Promise<void>;

package/dist/cli/build/open-next/createServerBundle.js

@@ -138,6 +138,7 @@ async function generateBundle(name, options, fnOptions, codeCustomization) {
         awsPatches.patchNextServer,
         awsPatches.patchEnvVars,
         awsPatches.patchBackgroundRevalidation,
+        awsPatches.patchNodeEnvironment,
         // Cloudflare specific patches
         patchResRevalidate,
         patchUseCacheIO,

package/dist/cli/build/patches/plugins/next-server.d.ts

@@ -22,3 +22,23 @@ export declare const buildIdRule = "\nrule:\n  pattern:\n    selector: method_de
  */
 export declare function createCacheHandlerRule(handlerPath: string): string;
 export declare function createComposableCacheHandlersRule(handlerPath: string): string;
+/**
+ * `attachRequestMeta` sets `initUrl` to always be with `https` cause this.fetchHostname && this.port is undefined in our case.
+ * this.nextConfig.experimental.trustHostHeader is also true.
+ *
+ * This patch checks if the original protocol was "http:" and rewrites the `initUrl` to reflect the actual host protocol.
+ * It will make `request.url` in route handlers end up with the correct protocol.
+ *
+ * Note: We cannot use the already defined `initURL` we passed in as requestMetaData to NextServer's request handler as pages router
+ * data routes would fail. It would miss the `_next/data` part in the path in that case.
+ *
+ * Therefor we just replace the protocol if necessary in the value from this template string:
+ * https://github.com/vercel/next.js/blob/ea08bf27/packages/next/src/server/next-server.ts#L1920
+ *
+ * Affected lines:
+ * https://github.com/vercel/next.js/blob/ea08bf27/packages/next/src/server/next-server.ts#L1916-L1923
+ *
+ * Callstack: handleRequest-> handleRequestImpl -> attachRequestMeta
+ *
+ */
+export declare const attachRequestMetaRule = "\nrule:\n  kind: identifier\n  regex: ^initUrl$\n  inside:\n    kind: arguments\n    all:\n      - has: {kind: identifier, regex: ^req$}\n      - has: {kind: string, regex: initURL}\n    inside:\n      kind: call_expression\n      all:\n        - has: {kind: parenthesized_expression, regex: '0'}\n        - has: { regex: _requestmeta.addRequestMeta}\n      inside:\n        kind: expression_statement\n        inside:\n          kind: statement_block\n          inside:\n            kind: method_definition\n            has:\n              kind: property_identifier\n              regex: ^attachRequestMeta$\nfix:\n  'req[Symbol.for(\"NextInternalRequestMeta\")]?.initProtocol === \"http:\" && initUrl.startsWith(\"https://\") ? `http://${initUrl.slice(8)}`: initUrl'";

package/dist/cli/build/patches/plugins/next-server.js

@@ -28,6 +28,7 @@ export function patchNextServer(updater, buildOpts) {
                 contents = patchCode(contents, createComposableCacheHandlersRule(composableCacheHandler));
                 // Node middleware are not supported on Cloudflare yet
                 contents = patchCode(contents, disableNodeMiddlewareRule);
+                contents = patchCode(contents, attachRequestMetaRule);
                 return contents;
             },
         },
@@ -100,3 +101,47 @@ fix: |-
   globalThis[handlersSetSymbol] = new Set(globalThis[handlersMapSymbol].values());
 `;
 }
+/**
+ * `attachRequestMeta` sets `initUrl` to always be with `https` cause this.fetchHostname && this.port is undefined in our case.
+ * this.nextConfig.experimental.trustHostHeader is also true.
+ *
+ * This patch checks if the original protocol was "http:" and rewrites the `initUrl` to reflect the actual host protocol.
+ * It will make `request.url` in route handlers end up with the correct protocol.
+ *
+ * Note: We cannot use the already defined `initURL` we passed in as requestMetaData to NextServer's request handler as pages router
+ * data routes would fail. It would miss the `_next/data` part in the path in that case.
+ *
+ * Therefor we just replace the protocol if necessary in the value from this template string:
+ * https://github.com/vercel/next.js/blob/ea08bf27/packages/next/src/server/next-server.ts#L1920
+ *
+ * Affected lines:
+ * https://github.com/vercel/next.js/blob/ea08bf27/packages/next/src/server/next-server.ts#L1916-L1923
+ *
+ * Callstack: handleRequest-> handleRequestImpl -> attachRequestMeta
+ *
+ */
+export const attachRequestMetaRule = `
+rule:
+  kind: identifier
+  regex: ^initUrl$
+  inside:
+    kind: arguments
+    all:
+      - has: {kind: identifier, regex: ^req$}
+      - has: {kind: string, regex: initURL}
+    inside:
+      kind: call_expression
+      all:
+        - has: {kind: parenthesized_expression, regex: '0'}
+        - has: { regex: _requestmeta.addRequestMeta}
+      inside:
+        kind: expression_statement
+        inside:
+          kind: statement_block
+          inside:
+            kind: method_definition
+            has:
+              kind: property_identifier
+              regex: ^attachRequestMeta$
+fix:
+  'req[Symbol.for("NextInternalRequestMeta")]?.initProtocol === "http:" && initUrl.startsWith("https://") ? \`http://\${initUrl.slice(8)}\`: initUrl'`;

package/dist/cli/build/utils/needs-experimental-react.d.ts

@@ -1,4 +1,4 @@
-import type { NextConfig } from "@opennextjs/aws/types/next-types";
+import type { NextConfig } from "@opennextjs/aws/types/next-types.js";
 interface ExtendedNextConfig extends NextConfig {
     experimental: {
         ppr?: boolean;

package/dist/cli/commands/skew-protection.d.ts

@@ -21,7 +21,7 @@
  */
 import type { BuildOptions } from "@opennextjs/aws/build/helper.js";
 import { Cloudflare } from "cloudflare";
-import type { OpenNextConfig } from "../../api";
+import type { OpenNextConfig } from "../../api/index.js";
 import type { WorkerEnvVar } from "./helpers.js";
 /**
  * Compute the deployment mapping for a deployment.

package/dist/cli/templates/worker.js

@@ -44,7 +44,7 @@ export default {
             }
             // @ts-expect-error: resolved by wrangler build
             const { handler } = await import("./server-functions/default/handler.mjs");
-            return handler(reqOrResp, env, ctx);
+            return handler(reqOrResp, env, ctx, request.signal);
         });
     },
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennextjs/cloudflare",
   "description": "Cloudflare builder for next apps",
-  "version": "1.6.5",
+  "version": "1.7.1",
   "type": "module",
   "bin": {
     "opennextjs-cloudflare": "dist/cli/index.js"
@@ -43,7 +43,7 @@
   "homepage": "https://github.com/opennextjs/opennextjs-cloudflare",
   "dependencies": {
     "@dotenvx/dotenvx": "1.31.0",
-    "@opennextjs/aws": "3.7.4",
+    "@opennextjs/aws": "3.7.6",
     "cloudflare": "^4.4.1",
     "enquirer": "^2.4.1",
     "glob": "^11.0.0",

package/dist/cli/build/patches/plugins/node-environment.d.ts

@@ -1,9 +0,0 @@
-/**
- * Remove a dependency on Babel by dropping the require of error-inspect
- */
-import type { ContentUpdater, Plugin } from "@opennextjs/aws/plugins/content-updater.js";
-export declare function patchNodeEnvironment(updater: ContentUpdater): Plugin;
-/**
- * Drops `require("./node-environment-extensions/error-inspect");`
- */
-export declare const errorInspectRule = "\nrule:\n  pattern: require(\"./node-environment-extensions/error-inspect\");\nfix: |-\n  // Removed by OpenNext\n  // require(\"./node-environment-extensions/error-inspect\");\n";

package/dist/cli/build/patches/plugins/node-environment.js

@@ -1,26 +0,0 @@
-/**
- * Remove a dependency on Babel by dropping the require of error-inspect
- */
-import { patchCode } from "@opennextjs/aws/build/patch/astCodePatcher.js";
-import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
-export function patchNodeEnvironment(updater) {
-    return updater.updateContent("node-environment", [
-        {
-            filter: getCrossPlatformPathRegex(String.raw `/next/dist/server/node-environment\.js$`, {
-                escape: false,
-            }),
-            contentFilter: /error-inspect/,
-            callback: async ({ contents }) => patchCode(contents, errorInspectRule),
-        },
-    ]);
-}
-/**
- * Drops `require("./node-environment-extensions/error-inspect");`
- */
-export const errorInspectRule = `
-rule:
-  pattern: require("./node-environment-extensions/error-inspect");
-fix: |-
-  // Removed by OpenNext
-  // require("./node-environment-extensions/error-inspect");
-`;