@opennextjs/aws 3.4.0 → 3.4.2

package/dist/adapters/cache.js

@@ -16,7 +16,7 @@ export default class Cache {
     async get(key, 
     // fetchCache is for next 13.5 and above, kindHint is for next 14 and above and boolean is for earlier versions
     options) {
-        if (globalThis.disableIncrementalCache) {
+        if (globalThis.openNextConfig.dangerous?.disableIncrementalCache) {
             return null;
         }
         const softTags = typeof options === "object" ? options.softTags : [];
@@ -28,14 +28,14 @@ export default class Cache {
     async getFetchCache(key, softTags, tags) {
         debug("get fetch cache", { key, softTags, tags });
         try {
-            const { value, lastModified } = await globalThis.incrementalCache.get(key, true);
-            const _lastModified = await globalThis.tagCache.getLastModified(key, lastModified);
+            const cachedEntry = await globalThis.incrementalCache.get(key, true);
+            if (cachedEntry?.value === undefined)
+                return null;
+            const _lastModified = await globalThis.tagCache.getLastModified(key, cachedEntry?.lastModified);
             if (_lastModified === -1) {
                 // If some tags are stale we need to force revalidation
                 return null;
             }
-            if (value === undefined)
-                return null;
             // For cases where we don't have tags, we need to ensure that the soft tags are not being revalidated
             // We only need to check for the path as it should already contain all the tags
             if ((tags ?? []).length === 0) {
@@ -44,7 +44,7 @@ export default class Cache {
                     !tag.endsWith("layout") &&
                     !tag.endsWith("page"));
                 if (path) {
-                    const pathLastModified = await globalThis.tagCache.getLastModified(path.replace("_N_T_/", ""), lastModified);
+                    const pathLastModified = await globalThis.tagCache.getLastModified(path.replace("_N_T_/", ""), cachedEntry.lastModified);
                     if (pathLastModified === -1) {
                         // In case the path has been revalidated, we don't want to use the fetch cache
                         return null;
@@ -53,7 +53,7 @@ export default class Cache {
             }
             return {
                 lastModified: _lastModified,
-                value: value,
+                value: cachedEntry.value,
             };
         }
         catch (e) {
@@ -64,13 +64,17 @@ export default class Cache {
     }
     async getIncrementalCache(key) {
         try {
-            const { value: cacheData, lastModified } = await globalThis.incrementalCache.get(key, false);
-            const meta = cacheData?.meta;
-            const _lastModified = await globalThis.tagCache.getLastModified(key, lastModified);
+            const cachedEntry = await globalThis.incrementalCache.get(key, false);
+            if (!cachedEntry?.value) {
+                return null;
+            }
+            const meta = cachedEntry.value.meta;
+            const _lastModified = await globalThis.tagCache.getLastModified(key, cachedEntry?.lastModified);
             if (_lastModified === -1) {
                 // If some tags are stale we need to force revalidation
                 return null;
             }
+            const cacheData = cachedEntry?.value;
             const requestId = globalThis.__openNextAls.getStore()?.requestId ?? "";
             globalThis.lastModified[requestId] = _lastModified;
             if (cacheData?.type === "route") {
@@ -130,7 +134,7 @@ export default class Cache {
         }
     }
     async set(key, data, ctx) {
-        if (globalThis.disableIncrementalCache) {
+        if (globalThis.openNextConfig.dangerous?.disableIncrementalCache) {
             return;
         }
         // This one might not even be necessary anymore
@@ -242,7 +246,8 @@ export default class Cache {
         }
     }
     async revalidateTag(tags) {
-        if (globalThis.disableDynamoDBCache || globalThis.disableIncrementalCache) {
+        const config = globalThis.openNextConfig.dangerous;
+        if (config?.disableTagCache || config?.disableIncrementalCache) {
             return;
         }
         try {

package/dist/adapters/logger.js

@@ -21,9 +21,9 @@ const isDownplayedErrorLog = (errorLog) => DOWNPLAYED_ERROR_LOGS.some((downplaye
 export function error(...args) {
     // we try to catch errors from the aws-sdk client and downplay some of them
     if (args.some((arg) => isDownplayedErrorLog(arg))) {
-        debug(...args);
+        return debug(...args);
     }
-    else if (args.some((arg) => isOpenNextError(arg))) {
+    if (args.some((arg) => isOpenNextError(arg))) {
         // In case of an internal error, we log it with the appropriate log level
         const error = args.find((arg) => isOpenNextError(arg));
         if (error.logLevel < getOpenNextErrorLogLevel()) {

package/dist/build/createAssets.js

@@ -44,8 +44,8 @@ export function createStaticAssets(options) {
 export function createCacheAssets(options) {
     logger.info("Bundling cache assets...");
     const { appBuildOutputPath, outputDir } = options;
-    const packagePath = path.relative(options.monorepoRoot, appBuildOutputPath);
-    const buildId = buildHelper.getBuildId(appBuildOutputPath);
+    const packagePath = buildHelper.getPackagePath(options);
+    const buildId = buildHelper.getBuildId(options);
     let useTagCache = false;
     // Copy pages to cache folder
     const dotNextPath = path.join(appBuildOutputPath, ".next/standalone", packagePath);

package/dist/build/createServerBundle.js

@@ -36,10 +36,9 @@ export async function createServerBundle(options) {
     // We build every other function than default before so we know which route there is left
     await Promise.all(promises);
     const remainingRoutes = new Set();
-    const { appBuildOutputPath, monorepoRoot } = options;
-    const packagePath = path.relative(monorepoRoot, appBuildOutputPath);
+    const { appBuildOutputPath } = options;
     // Find remaining routes
-    const serverPath = path.join(appBuildOutputPath, ".next", "standalone", packagePath, ".next", "server");
+    const serverPath = path.join(appBuildOutputPath, ".next/standalone", buildHelper.getPackagePath(options), ".next/server");
     // Find app dir routes
     if (fs.existsSync(path.join(serverPath, "app"))) {
         const appPath = path.join(serverPath, "app");
@@ -78,7 +77,7 @@ async function generateBundle(name, options, fnOptions) {
     //       `node_modules` inside `.next/standalone`, and others inside
     //       `.next/standalone/package/path` (ie. `.next`, `server.js`).
     //       We need to output the handler file inside the package path.
-    const packagePath = path.relative(monorepoRoot, appBuildOutputPath);
+    const packagePath = buildHelper.getPackagePath(options);
     fs.mkdirSync(path.join(outputPath, packagePath), { recursive: true });
     const ext = fnOptions.runtime === "deno" ? "mjs" : "cjs";
     fs.copyFileSync(path.join(options.buildDir, `cache.${ext}`), path.join(outputPath, packagePath, "cache.cjs"));
@@ -110,7 +109,7 @@ async function generateBundle(name, options, fnOptions) {
         buildHelper.compareSemver(options.nextVersion, "13.4.1") <= 0;
     const overrides = fnOptions.override ?? {};
     const isBefore13413 = buildHelper.compareSemver(options.nextVersion, "13.4.13") <= 0;
-    const isAfter141 = buildHelper.compareSemver(options.nextVersion, "14.0.4") >= 0;
+    const isAfter141 = buildHelper.compareSemver(options.nextVersion, "14.1") >= 0;
     const disableRouting = isBefore13413 || config.middleware?.external;
     const plugins = [
         openNextReplacementPlugin({

package/dist/build/generateOutput.js

@@ -167,7 +167,7 @@ export async function generateOutput(options) {
         const patterns = "patterns" in value ? value.patterns : ["*"];
         patterns.forEach((pattern) => {
             behaviors.push({
-                pattern: prefixer(pattern.replace(/BUILD_ID/, getBuildId(appBuildOutputPath))),
+                pattern: prefixer(pattern.replace(/BUILD_ID/, getBuildId(options))),
                 origin: value.placement === "global" ? undefined : key,
                 edgeFunction: value.placement === "global"
                     ? key

package/dist/build/helper.d.ts

@@ -15,7 +15,7 @@ export declare function normalizeOptions(config: OpenNextConfig, distDir: string
     openNextVersion: string;
     openNextDistDir: string;
     outputDir: string;
-    packager: "npm" | "yarn" | "pnpm" | "bun";
+    packager: "bun" | "npm" | "yarn" | "pnpm";
     tempBuildDir: string;
 };
 export declare function esbuildSync(esbuildOptions: ESBuildOptions, options: BuildOptions): void;
@@ -48,9 +48,17 @@ export declare function traverseFiles(root: string, conditionFn: (paths: Travers
  */
 export declare function removeFiles(root: string, conditionFn: (paths: TraversePath) => boolean): void;
 export declare function getHtmlPages(dotNextPath: string): Set<string>;
-export declare function getBuildId(dotNextPath: string): string;
+export declare function getBuildId(options: BuildOptions): string;
 export declare function getOpenNextVersion(): string;
 export declare function getNextVersion(appPath: string): string;
+/**
+ * Compare two semver versions.
+ *
+ * @param v1 - First version. Can be "latest", otherwise it should be a valid semver version in the format of `major.minor.patch`. Usually is the next version from the package.json without canary suffix. If minor or patch are missing, they are considered 0.
+ * @param v2 - Second version. Should not be "latest", it should be a valid semver version in the format of `major.minor.patch`. If minor or patch are missing, they are considered 0.
+ * @example
+ * compareSemver("1.0.0", "1.0.0") // 0
+ */
 export declare function compareSemver(v1: string, v2: string): number;
 export declare function copyOpenNextConfig(inputDir: string, outputDir: string, isEdge?: boolean): void;
 export declare function copyEnvFile(appPath: string, packagePath: string, outputPath: string): void;
@@ -73,3 +81,4 @@ export declare function initOutputDir(options: BuildOptions): void;
  * @returns Whether the edge runtime is used
  */
 export declare function isEdgeRuntime(overrides: DefaultOverrideOptions | undefined): Promise<boolean | undefined>;
+export declare function getPackagePath(options: BuildOptions): string;

package/dist/build/helper.js

@@ -45,10 +45,12 @@ function findMonorepoRoot(appPath) {
     let currentPath = appPath;
     while (currentPath !== "/") {
         const found = [
+            // bun can generate yaml lock files (`bun install --yarn`) so bun should be before yarn
+            { file: "bun.lockb", packager: "bun" },
+            { file: "bun.lock", packager: "bun" },
             { file: "package-lock.json", packager: "npm" },
             { file: "yarn.lock", packager: "yarn" },
             { file: "pnpm-lock.yaml", packager: "pnpm" },
-            { file: "bun.lockb", packager: "bun" },
         ].find((f) => fs.existsSync(path.join(currentPath, f.file)));
         if (found) {
             if (currentPath !== appPath) {
@@ -99,12 +101,15 @@ export function esbuildSync(esbuildOptions, options) {
 }
 export async function esbuildAsync(esbuildOptions, options) {
     const { openNextVersion, debug, minify } = options;
+    // Dump ESBuild build metadata to file in debug mode
+    const metafile = debug && esbuildOptions.outfile !== undefined;
     const result = await buildAsync({
         target: "esnext",
         format: "esm",
         platform: "node",
         bundle: true,
         minify,
+        metafile,
         mainFields: ["module", "main"],
         sourcemap: debug ? "inline" : false,
         sourcesContent: false,
@@ -127,6 +132,10 @@ export async function esbuildAsync(esbuildOptions, options) {
         result.errors.forEach((error) => logger.error(error));
         throw new Error(`There was a problem bundling ${esbuildOptions.entryPoints[0]}.`);
     }
+    if (result.metafile) {
+        const metaFile = `${esbuildOptions.outfile}.meta.json`;
+        fs.writeFileSync(metaFile, JSON.stringify(result.metafile, null, 2));
+    }
 }
 /**
  * Recursively traverse files in a directory and call `callbackFn` when `conditionFn` returns true
@@ -178,9 +187,9 @@ export function getHtmlPages(dotNextPath) {
         .map(([_, value]) => value.replace(/^pages\//, ""))
         .reduce((acc, page) => acc.add(page), new Set());
 }
-export function getBuildId(dotNextPath) {
+export function getBuildId(options) {
     return fs
-        .readFileSync(path.join(dotNextPath, ".next/BUILD_ID"), "utf-8")
+        .readFileSync(path.join(options.appBuildOutputPath, ".next/BUILD_ID"), "utf-8")
         .trim();
 }
 export function getOpenNextVersion() {
@@ -198,6 +207,14 @@ export function getNextVersion(appPath) {
     // Drop the -canary.n suffix
     return version.split("-")[0];
 }
+/**
+ * Compare two semver versions.
+ *
+ * @param v1 - First version. Can be "latest", otherwise it should be a valid semver version in the format of `major.minor.patch`. Usually is the next version from the package.json without canary suffix. If minor or patch are missing, they are considered 0.
+ * @param v2 - Second version. Should not be "latest", it should be a valid semver version in the format of `major.minor.patch`. If minor or patch are missing, they are considered 0.
+ * @example
+ * compareSemver("1.0.0", "1.0.0") // 0
+ */
 export function compareSemver(v1, v2) {
     if (v1 === "latest")
         return 1;
@@ -209,8 +226,11 @@ export function compareSemver(v1, v2) {
         // biome-ignore lint/style/noParameterAssign:
         v2 = v2.substring(1);
     }
-    const [major1, minor1, patch1] = v1.split(".").map(Number);
-    const [major2, minor2, patch2] = v2.split(".").map(Number);
+    const [major1, minor1 = 0, patch1 = 0] = v1.split(".").map(Number);
+    const [major2, minor2 = 0, patch2 = 0] = v2.split(".").map(Number);
+    if (Number.isNaN(major1) || Number.isNaN(major2)) {
+        throw new Error("The major version is required.");
+    }
     if (major1 !== major2)
         return major1 - major2;
     if (minor1 !== minor2)
@@ -276,3 +296,6 @@ export async function isEdgeRuntime(overrides) {
     }
     return (await overrides?.wrapper?.())?.edgeRuntime;
 }
+export function getPackagePath(options) {
+    return path.relative(options.monorepoRoot, options.appBuildOutputPath);
+}

package/dist/core/edgeFunctionHandler.js

@@ -6,7 +6,8 @@ export default async function edgeFunctionHandler(request) {
     if (!correspondingRoute) {
         throw new Error(`No route found for ${request.url}`);
     }
-    const result = await self._ENTRIES[`middleware_${correspondingRoute.name}`].default({
+    const entry = await self._ENTRIES[`middleware_${correspondingRoute.name}`];
+    const result = await entry.default({
         page: correspondingRoute.page,
         request: {
             ...request,

package/dist/core/routing/cacheInterceptor.js

@@ -120,7 +120,10 @@ export async function cacheInterceptor(event) {
         try {
             const cachedData = await globalThis.incrementalCache.get(localizedPath);
             debug("cached data in interceptor", cachedData);
-            if (cachedData.value?.type === "app") {
+            if (!cachedData?.value) {
+                return event;
+            }
+            if (cachedData?.value?.type === "app") {
                 // We need to check the tag cache now
                 const _lastModified = await globalThis.tagCache.getLastModified(localizedPath, cachedData.lastModified);
                 if (_lastModified === -1) {
@@ -129,7 +132,7 @@ export async function cacheInterceptor(event) {
                 }
             }
             const host = event.headers.host;
-            switch (cachedData.value?.type) {
+            switch (cachedData?.value?.type) {
                 case "app":
                 case "page":
                     return generateResult(event, localizedPath, cachedData.value, cachedData.lastModified);

package/dist/core/routing/matcher.js

@@ -166,8 +166,9 @@ export function handleRewrites(event, rewrites) {
     };
 }
 function handleTrailingSlashRedirect(event) {
-    const url = new URL(event.url, "http://localhost");
-    const emptyBody = emptyReadableStream();
+    // When rawPath is `//domain`, `url.host` would be `domain`.
+    // https://github.com/opennextjs/opennextjs-aws/issues/355
+    const url = new URL(event.rawPath, "http://localhost");
     if (
     // Someone is trying to redirect to a different origin, let's not do that
     url.host !== "localhost" ||
@@ -176,6 +177,7 @@ function handleTrailingSlashRedirect(event) {
         event.rawPath.startsWith("/api/")) {
         return false;
     }
+    const emptyBody = emptyReadableStream();
     if (NextConfig.trailingSlash &&
         !event.headers["x-nextjs-data"] &&
         !event.rawPath.endsWith("/") &&

package/dist/overrides/incrementalCache/multi-tier-ddb-s3.js

@@ -77,7 +77,7 @@ const multiTierCache = {
             }
         }
         const result = await S3Cache.get(key, isFetch);
-        if (result.value) {
+        if (result?.value) {
             localCache.set(key, {
                 value: result.value,
                 lastModified: result.lastModified ?? Date.now(),

package/dist/overrides/proxyExternalRequest/fetch.js

@@ -3,7 +3,8 @@ const fetchProxy = {
     name: "fetch-proxy",
     // @ts-ignore
     proxy: async (internalEvent) => {
-        const { url, headers, method, body } = internalEvent;
+        const { url, headers: eventHeaders, method, body } = internalEvent;
+        const headers = Object.fromEntries(Object.entries(eventHeaders).filter(([key]) => key.toLowerCase() !== "cf-connecting-ip"));
         const response = await fetch(url, {
             method,
             headers,

package/dist/overrides/tagCache/dynamodb-lite.js

@@ -49,8 +49,9 @@ function buildDynamoObject(path, tags, revalidatedAt) {
 const tagCache = {
     async getByPath(path) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return [];
+            }
             const { CACHE_DYNAMO_TABLE, NEXT_BUILD_ID } = process.env;
             const result = await awsFetch(JSON.stringify({
                 TableName: CACHE_DYNAMO_TABLE,
@@ -79,8 +80,9 @@ const tagCache = {
     },
     async getByTag(tag) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return [];
+            }
             const { CACHE_DYNAMO_TABLE, NEXT_BUILD_ID } = process.env;
             const result = await awsFetch(JSON.stringify({
                 TableName: CACHE_DYNAMO_TABLE,
@@ -107,8 +109,9 @@ const tagCache = {
     },
     async getLastModified(key, lastModified) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return lastModified ?? Date.now();
+            }
             const { CACHE_DYNAMO_TABLE } = process.env;
             const result = await awsFetch(JSON.stringify({
                 TableName: CACHE_DYNAMO_TABLE,
@@ -139,8 +142,9 @@ const tagCache = {
     async writeTags(tags) {
         try {
             const { CACHE_DYNAMO_TABLE } = process.env;
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return;
+            }
             const dataChunks = chunk(tags, MAX_DYNAMO_BATCH_WRITE_ITEM_COUNT).map((Items) => ({
                 RequestItems: {
                     [CACHE_DYNAMO_TABLE ?? ""]: Items.map((Item) => ({

package/dist/overrides/tagCache/dynamodb.js

@@ -27,8 +27,9 @@ function buildDynamoObject(path, tags, revalidatedAt) {
 const tagCache = {
     async getByPath(path) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return [];
+            }
             const result = await dynamoClient.send(new QueryCommand({
                 TableName: CACHE_DYNAMO_TABLE,
                 IndexName: "revalidate",
@@ -52,8 +53,9 @@ const tagCache = {
     },
     async getByTag(tag) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return [];
+            }
             const { Items } = await dynamoClient.send(new QueryCommand({
                 TableName: CACHE_DYNAMO_TABLE,
                 KeyConditionExpression: "#tag = :tag",
@@ -75,8 +77,9 @@ const tagCache = {
     },
     async getLastModified(key, lastModified) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return lastModified ?? Date.now();
+            }
             const result = await dynamoClient.send(new QueryCommand({
                 TableName: CACHE_DYNAMO_TABLE,
                 IndexName: "revalidate",
@@ -102,8 +105,9 @@ const tagCache = {
     },
     async writeTags(tags) {
         try {
-            if (globalThis.disableDynamoDBCache)
+            if (globalThis.openNextConfig.dangerous?.disableTagCache) {
                 return;
+            }
             const dataChunks = chunk(tags, MAX_DYNAMO_BATCH_WRITE_ITEM_COUNT).map((Items) => ({
                 RequestItems: {
                     [CACHE_DYNAMO_TABLE ?? ""]: Items.map((Item) => ({

package/dist/overrides/wrappers/cloudflare-node.js

@@ -26,6 +26,11 @@ const handler = async (handler, converter) => async (request, env, ctx) => {
             for (const cookie of cookies) {
                 responseHeaders.append("Set-Cookie", cookie);
             }
+            // TODO(vicb): this is a workaround to make PPR work with `wrangler dev`
+            // See https://github.com/cloudflare/workers-sdk/issues/8004
+            if (url.hostname === "localhost") {
+                responseHeaders.set("Content-Encoding", "identity");
+            }
             const { readable, writable } = new TransformStream({
                 transform(chunk, controller) {
                     controller.enqueue(Uint8Array.from(chunk.chunk ?? chunk));

package/dist/types/global.d.ts

@@ -29,16 +29,17 @@ export interface RequestData {
     body?: ReadableStream<Uint8Array>;
     signal: AbortSignal;
 }
+interface Entry {
+    default: (props: {
+        page: string;
+        request: RequestData;
+    }) => Promise<{
+        response: Response;
+        waitUntil: Promise<void>;
+    }>;
+}
 interface Entries {
-    [k: string]: {
-        default: (props: {
-            page: string;
-            request: RequestData;
-        }) => Promise<{
-            response: Response;
-            waitUntil: Promise<void>;
-        }>;
-    };
+    [k: string]: Entry | Promise<Entry>;
 }
 export interface EdgeRoute {
     name: string;
@@ -66,13 +67,13 @@ declare global {
     var tagCache: TagCache;
     /**
      * A boolean that indicates if the DynamoDB cache is disabled.
-     * TODO: Remove this, we already have access to the config file
+     * @deprecated This will be removed, use `globalThis.openNextConfig.dangerous?.disableTagCache` instead.
      * Defined in esbuild banner for the cache adapter.
      */
     var disableDynamoDBCache: boolean;
     /**
      * A boolean that indicates if the incremental cache is disabled.
-     * TODO: Remove this, we already have access to the config file
+     * @deprecated This will be removed, use `globalThis.openNextConfig.dangerous?.disableIncrementalCache` instead.
      * Defined in esbuild banner for the cache adapter.
      */
     var disableIncrementalCache: boolean;

package/dist/types/overrides.d.ts

@@ -41,7 +41,7 @@ export type CacheValue<IsFetch extends boolean> = (IsFetch extends true ? FetchC
     revalidate?: number | false;
 };
 export type IncrementalCache = {
-    get<IsFetch extends boolean = false>(key: string, isFetch?: IsFetch): Promise<WithLastModified<CacheValue<IsFetch>>>;
+    get<IsFetch extends boolean = false>(key: string, isFetch?: IsFetch): Promise<WithLastModified<CacheValue<IsFetch>> | null>;
     set<IsFetch extends boolean = false>(key: string, value: CacheValue<IsFetch>, isFetch?: IsFetch): Promise<void>;
     delete(key: string): Promise<void>;
     name: string;

package/package.json

@@ -3,7 +3,7 @@
     "access": "public"
   },
   "name": "@opennextjs/aws",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "bin": {
     "open-next": "./dist/index.js"
   },