Merge branch 'main' into type

Author: 314systems

.changeset/drop-unused-vercel-og.md

@@ -105,7 +105,7 @@ test("Revalidate tag - stale data served first", async ({ page, request }) => {
 	const staleResponse = await responsePromise;
 	const staleHeaders = staleResponse.headers();
 	const staleCache = staleHeaders["x-nextjs-cache"] ?? staleHeaders["x-opennext-cache"];
-	expect(staleCache).toMatch(/^(STALE|HIT)$/);
+	expect(staleCache).toMatch(/^(STALE)$/);
 
 	const staleTime = await page.getByTestId("cached-time").textContent();
 	// Stale content must match the pre-revalidation value
@@ -129,6 +129,19 @@ test("Revalidate tag - stale data served first", async ({ page, request }) => {
 	// After background regen the cached value must have been updated
 	expect(freshTime).not.toBeNull();
 	expect(freshTime).not.toEqual(originalTime);
+
+	// Now we want to verfiy that the next entries stays fresh (HIT) after the first stale entry
+	responsePromise = page.waitForResponse(
+		(response) => response.url().includes("/revalidate-tag/stale") && response.status() === 200
+	);
+	await page.goto("/revalidate-tag/stale");
+	const finalResponse = await responsePromise;
+	const finalHeaders = finalResponse.headers();
+	const finalCache = finalHeaders["x-nextjs-cache"] ?? finalHeaders["x-opennext-cache"];
+	expect(finalCache).toEqual("HIT");
+
+	const finalTime = await page.getByTestId("cached-time").textContent();
+	expect(finalTime).toEqual(freshTime);
 });
 
 test("Revalidate path", async ({ page, request }) => {

examples/e2e/app-router/e2e/revalidateTag.test.ts

@@ -1,5 +1,23 @@
 # @opennextjs/cloudflare
 
+## 1.19.4
+
+### Patch Changes
+
+- [#1221](https://github.com/opennextjs/opennextjs-cloudflare/pull/1221) [`a2679bf`](https://github.com/opennextjs/opennextjs-cloudflare/commit/a2679bf9549f620e1ab0e1900dcc7a6b6ac03e0a) Thanks [@mushan0x0](https://github.com/mushan0x0)! - Stop bundling `@vercel/og` (and its ~1.4 MiB `resvg.wasm`) when the app does not use it.
+
+  Next.js's `externalImport` helper keeps a dynamic `import("next/dist/compiled/@vercel/og/index.edge.js")` in the emitted handler even for apps that never use `ImageResponse` / `opengraph-image`. Previously this module was marked as `external` when `useOg` was `false`, which left Wrangler to resolve and bundle it — pulling in ~800 KiB of JS plus `resvg.wasm` and pushing many Workers over the Cloudflare free-tier 3 MiB gzip limit.
+
+  When `useOg` is `false`, the edge entry is now aliased to the existing `throw.js` shim, so the unreachable dynamic import resolves to a tiny module and the real `@vercel/og` library is no longer pulled into the Worker bundle.
+
+- [#1208](https://github.com/opennextjs/opennextjs-cloudflare/pull/1208) [`2c5b472`](https://github.com/opennextjs/opennextjs-cloudflare/commit/2c5b4729b6a48560b550af820c46c2350e149fa6) Thanks [@edmundhung](https://github.com/edmundhung)! - Use `OPEN_NEXT_BUILD_ID` instead of `NEXT_BUILD_ID` in the cache keys.
+
+  As of Next 16.2 `NEXT_BUILD_ID` is a fixed value when deploymentId is set explicitly.
+
+  See <https://github.com/opennextjs/opennextjs-aws/pull/1144>
+
+- [#1193](https://github.com/opennextjs/opennextjs-cloudflare/pull/1193) [`1e8d232`](https://github.com/opennextjs/opennextjs-cloudflare/commit/1e8d232672353920a8e05e468cf3a5890b82b0f6) Thanks [@conico974](https://github.com/conico974)! - Fix tag cache stale logic
+
 ## 1.19.3
 
 ### Patch Changes

packages/cloudflare/CHANGELOG.md

@@ -1,7 +1,7 @@
 {
 	"name": "@opennextjs/cloudflare",
 	"description": "Cloudflare builder for next apps",
-	"version": "1.19.3",
+	"version": "1.19.4",
 	"type": "module",
 	"scripts": {
 		"clean": "rimraf dist",
@@ -54,7 +54,7 @@
 	"dependencies": {
 		"@ast-grep/napi": "^0.40.5",
 		"@dotenvx/dotenvx": "catalog:",
-		"@opennextjs/aws": "3.10.2",
+		"@opennextjs/aws": "3.10.4",
 		"ci-info": "^4.2.0",
 		"cloudflare": "^4.4.1",
 		"comment-json": "^4.5.1",

packages/cloudflare/package.json

@@ -165,7 +165,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 					"INSERT OR REPLACE INTO sync (id, lastSuccess, buildId) VALUES (?, unixepoch(), ?)",
 					// We cannot use the deduplication id because it's not unique per route - every time a route is revalidated, the deduplication id is different.
 					`${host}${url}`,
-					process.env.__NEXT_BUILD_ID
+					process.env.__OPEN_NEXT_BUILD_ID
 				);
 			}
 			// If everything went well, we can remove the route from the failed state
@@ -238,7 +238,7 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 				"INSERT OR REPLACE INTO failed_state (id, data, buildId) VALUES (?, ?, ?)",
 				msg.MessageDeduplicationId,
 				JSON.stringify(updatedFailedState),
-				process.env.__NEXT_BUILD_ID
+				process.env.__OPEN_NEXT_BUILD_ID
 			);
 		}
 		// We probably want to do something if routeInFailedState is becoming too big, at least log it
@@ -273,8 +273,8 @@ export class DOQueueHandler extends DurableObject<CloudflareEnv> {
 
 		// Before doing anything else, we clear the DB for any potential old data
 		// TODO: extract this to a function so that it could be called by the user at another time than init
-		this.sql.exec("DELETE FROM failed_state WHERE buildId != ?", process.env.__NEXT_BUILD_ID);
-		this.sql.exec("DELETE FROM sync WHERE buildId != ?", process.env.__NEXT_BUILD_ID);
+		this.sql.exec("DELETE FROM failed_state WHERE buildId != ?", process.env.__OPEN_NEXT_BUILD_ID);
+		this.sql.exec("DELETE FROM sync WHERE buildId != ?", process.env.__OPEN_NEXT_BUILD_ID);
 
 		const failedStateCursor = this.sql.exec<{ id: string; data: string }>("SELECT * FROM failed_state");
 		for (const row of failedStateCursor) {

packages/cloudflare/src/api/durable-objects/queue.ts

@@ -102,7 +102,7 @@ class KVIncrementalCache implements IncrementalCache {
 	protected getKVKey(key: string, cacheType?: CacheEntryType): string {
 		return computeCacheKey(key, {
 			prefix: getCloudflareContext().env[PREFIX_ENV_NAME],
-			buildId: process.env.NEXT_BUILD_ID,
+			buildId: process.env.OPEN_NEXT_BUILD_ID,
 			cacheType,
 		});
 	}

packages/cloudflare/src/api/overrides/incremental-cache/kv-incremental-cache.ts

@@ -82,7 +82,7 @@ class R2IncrementalCache implements IncrementalCache {
 	protected getR2Key(key: string, cacheType?: CacheEntryType): string {
 		return computeCacheKey(key, {
 			prefix: getCloudflareContext().env[PREFIX_ENV_NAME],
-			buildId: process.env.NEXT_BUILD_ID,
+			buildId: process.env.OPEN_NEXT_BUILD_ID,
 			cacheType,
 		});
 	}

packages/cloudflare/src/api/overrides/incremental-cache/r2-incremental-cache.ts

@@ -5,6 +5,7 @@ import {
 	IncrementalCache,
 	WithLastModified,
 } from "@opennextjs/aws/types/overrides.js";
+import { compareSemver } from "@opennextjs/aws/utils/semver.js";
 
 import { getCloudflareContext } from "../../cloudflare-context.js";
 import { debugCache, FALLBACK_BUILD_ID, IncrementalCacheEntry, isPurgeCacheEnabled } from "../internal.js";
@@ -31,21 +32,33 @@ type Options = {
 	defaultLongLivedTtlSec?: number;
 
 	/**
-	 * Whether the regional cache entry should be updated in the background or not when it experiences
-	 * a cache hit.
+	 * Whether the regional cache entry should be updated in the background on regional cache hits.
 	 *
-	 * @default `true` in `long-lived` mode when cache purge is not used, `false` otherwise.
+	 * NOTE: Use the default value unless you know what you are doing. It is set to:
+	 * - Next < 16:
+	 *   `true` in `long-lived` mode when cache purge is not used, `false` otherwise.
+	 * - Next >= 16:
+	 *   `!bypassTagCacheOnCacheHit`
 	 */
 	shouldLazilyUpdateOnCacheHit?: boolean;
 
 	/**
-	 * Whether on cache hits the tagCache should be skipped or not. Skipping the tagCache allows requests to be
-	 * handled faster,
+	 * Whether the tagCache should be skipped on regional cache hits.
 	 *
-	 * Note: When this is enabled, make sure that the cache gets purged
-	 *       either by enabling the auto cache purging feature or manually.
+	 * Note:
+	 * - Skipping the tagCache allows requests to be handled faster
+	 * - When `true`, make sure the cache gets purged
+	 *   either by enabling the auto cache purging feature or manually
 	 *
-	 * @default `true` if the auto cache purging is enabled, `false` otherwise.
+	 * `true` is not compatible with SWR types of revalidateTag
+	 * i.e. on Next 16+, anything different than `revalidateTag("tag", { expire: 0 })`.
+	 * That's why the default is `false` for Next 16+ which uses SWR by default.
+	 *
+	 * NOTE: Use the default value unless you know what you are doing. It is set to:
+	 * - Next <16:
+	 *    `true` if the auto cache purging is enabled, `false` otherwise.
+	 * - Next >= 16:
+	 *   `false`
 	 */
 	bypassTagCacheOnCacheHit?: boolean;
 };
@@ -78,17 +91,33 @@ class RegionalCache implements IncrementalCache {
 		private opts: Options
 	) {
 		this.name = this.store.name;
-		// `shouldLazilyUpdateOnCacheHit` is not needed when cache purge is enabled.
-		this.opts.shouldLazilyUpdateOnCacheHit ??= this.opts.mode === "long-lived" && !isPurgeCacheEnabled();
-	}
 
-	get #bypassTagCacheOnCacheHit(): boolean {
-		if (this.opts.bypassTagCacheOnCacheHit !== undefined) {
-			return this.opts.bypassTagCacheOnCacheHit;
+		// `globalThis.nextVersion` is only defined at runtime but not when the Open Next build runs.
+		// The options do no matter at build time so we can skip setting them.
+		const { nextVersion } = globalThis;
+		if (nextVersion) {
+			if (compareSemver(nextVersion, "<", "16")) {
+				// Next < 16
+				this.opts.shouldLazilyUpdateOnCacheHit ??= this.opts.mode === "long-lived" && !isPurgeCacheEnabled();
+				this.opts.bypassTagCacheOnCacheHit ??= isPurgeCacheEnabled();
+			} else {
+				// Next >= 16
+				this.opts.bypassTagCacheOnCacheHit ??= false;
+				if (this.opts.bypassTagCacheOnCacheHit) {
+					debugCache(
+						"RegionalCache",
+						`bypassTagCacheOnCacheHit is not recommended for Next 16+ as it is not compatible with SWR tags. Make sure to always use \`revalidateTag\` with \`{ expire: 0 }\` if you want to bypass the tag cache.`
+					);
+				}
+				this.opts.shouldLazilyUpdateOnCacheHit ??= !this.opts.bypassTagCacheOnCacheHit;
+				if (this.opts.shouldLazilyUpdateOnCacheHit !== this.opts.bypassTagCacheOnCacheHit) {
+					debugCache(
+						"RegionalCache",
+						`\`shouldLazilyUpdateOnCacheHit\` and \`bypassTagCacheOnCacheHit\` are mutually exclusive for Next 16+.`
+					);
+				}
+			}
 		}
-
-		// When `bypassTagCacheOnCacheHit` is not set, we default to whether the automatic cache purging is enabled or not
-		return isPurgeCacheEnabled();
 	}
 
 	async get<CacheType extends CacheEntryType = "cache">(
@@ -123,7 +152,7 @@ class RegionalCache implements IncrementalCache {
 
 				return {
 					...responseJson,
-					shouldBypassTagCache: this.#bypassTagCacheOnCacheHit,
+					shouldBypassTagCache: this.opts.bypassTagCacheOnCacheHit,
 				};
 			}
 
@@ -190,7 +219,7 @@ class RegionalCache implements IncrementalCache {
 	}
 
 	protected getCacheUrlKey(key: string, cacheType?: CacheEntryType): string {
-		const buildId = process.env.NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
+		const buildId = process.env.OPEN_NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
 		return "http://cache.local" + `/${buildId}/${key}`.replace(/\/+/g, "/") + `.${cacheType ?? "cache"}`;
 	}
 

packages/cloudflare/src/api/overrides/incremental-cache/regional-cache.ts

@@ -65,7 +65,7 @@ class StaticAssetsIncrementalCache implements IncrementalCache {
 		if (cacheType === "composable") {
 			throw new Error("Composable cache is not supported in static assets incremental cache");
 		}
-		const buildId = process.env.NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
+		const buildId = process.env.OPEN_NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
 		const name = (
 			cacheType === "fetch"
 				? `${CACHE_DIR}/__fetch/${buildId}/${key}`

packages/cloudflare/src/api/overrides/incremental-cache/static-assets-incremental-cache.ts

@@ -143,9 +143,10 @@ describe("D1NextModeTagCache", () => {
 			expect(error).toHaveBeenCalledWith(mockError);
 		});
 
-		it("should use custom build ID when NEXT_BUILD_ID is set", async () => {
+		it("should prefer OPEN_NEXT_BUILD_ID when it is set", async () => {
 			const customBuildId = "custom-build-id";
-			vi.stubEnv("NEXT_BUILD_ID", customBuildId);
+			vi.stubEnv("NEXT_BUILD_ID", "legacy-build-id");
+			vi.stubEnv("OPEN_NEXT_BUILD_ID", customBuildId);
 
 			mockRaw.mockResolvedValue([[`${customBuildId}/tag1`, 123, 123, null]]);
 
@@ -395,6 +396,17 @@ describe("D1NextModeTagCache", () => {
 			expect(result).toBe(false);
 		});
 
+		it("should return false when revalidatedAt <= lastModified even if stale > lastModified", async () => {
+			const now = 2000;
+			vi.spyOn(Date, "now").mockReturnValue(now);
+			// revalidatedAt=500 <= lastModified=1000, so the stale window is from a previous ISR cycle
+			mockRaw.mockResolvedValue([[`${FALLBACK_BUILD_ID}/tag1`, 500, 1500, null]]);
+
+			const result = await tagCache.isStale(["tag1"], 1000);
+
+			expect(result).toBe(false);
+		});
+
 		it("should return false when expire <= now (tag expired)", async () => {
 			const now = 2000;
 			vi.spyOn(Date, "now").mockReturnValue(now);
@@ -534,9 +546,9 @@ describe("D1NextModeTagCache", () => {
 			expect(cacheKey).toBe(`${FALLBACK_BUILD_ID}/${key}`);
 		});
 
-		it("should use custom build ID when NEXT_BUILD_ID is set", () => {
+		it("should use custom build ID when OPEN_NEXT_BUILD_ID is set", () => {
 			const customBuildId = "custom-build-id";
-			vi.stubEnv("NEXT_BUILD_ID", customBuildId);
+			vi.stubEnv("OPEN_NEXT_BUILD_ID", customBuildId);
 
 			const key = "test-tag";
 			const cacheKey = (tagCache as unknown as { getCacheKey: (key: string) => string }).getCacheKey(key);
@@ -545,7 +557,7 @@ describe("D1NextModeTagCache", () => {
 		});
 
 		it("should handle double slashes by replacing them with single slash", () => {
-			vi.stubEnv("NEXT_BUILD_ID", "build//id");
+			vi.stubEnv("OPEN_NEXT_BUILD_ID", "build//id");
 
 			const key = "test-tag";
 			const cacheKey = (tagCache as unknown as { getCacheKey: (key: string) => string }).getCacheKey(key);
@@ -555,16 +567,16 @@ describe("D1NextModeTagCache", () => {
 	});
 
 	describe("getBuildId", () => {
-		it("should return NEXT_BUILD_ID when set", () => {
+		it("should return OPEN_NEXT_BUILD_ID when set", () => {
 			const customBuildId = "custom-build-id";
-			vi.stubEnv("NEXT_BUILD_ID", customBuildId);
+			vi.stubEnv("OPEN_NEXT_BUILD_ID", customBuildId);
 
 			const buildId = (tagCache as unknown as { getBuildId: () => string }).getBuildId();
 
 			expect(buildId).toBe(customBuildId);
 		});
 
-		it("should return fallback build ID when NEXT_BUILD_ID is not set", () => {
+		it("should return fallback build ID when no build ID env vars are set", () => {
 			const buildId = (tagCache as unknown as { getBuildId: () => string }).getBuildId();
 
 			expect(buildId).toBe(FALLBACK_BUILD_ID);