replace NEXT_BUILD_ID with OPEN_NEXT_BUILD_ID (#1208)

Co-authored-by: Victor Berchet <victor@suumit.com>

Author: edmundhung

.changeset/funny-toes-exist.md

@@ -0,0 +1,9 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+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>

packages/cloudflare/package.json

@@ -54,7 +54,7 @@
 	"dependencies": {
 		"@ast-grep/napi": "^0.40.5",
 		"@dotenvx/dotenvx": "catalog:",
-		"@opennextjs/aws": "3.10.3",
+		"@opennextjs/aws": "3.10.4",
 		"ci-info": "^4.2.0",
 		"cloudflare": "^4.4.1",
 		"comment-json": "^4.5.1",

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

@@ -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/overrides/incremental-cache/kv-incremental-cache.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/r2-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/regional-cache.ts

@@ -219,7 +219,7 @@ class RegionalCache implements IncrementalCache {
 	}
 
 	protected getCacheUrlKey(key: string, cacheType?: CacheEntryType) {
-		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/static-assets-incremental-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/tag-cache/d1-next-tag-cache.spec.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]]);
 
@@ -545,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);
@@ -556,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);
@@ -566,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);

packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts

@@ -196,7 +196,7 @@ export class D1NextModeTagCache implements NextModeTagCache {
 	}
 
 	protected getBuildId() {
-		return process.env.NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
+		return process.env.OPEN_NEXT_BUILD_ID ?? FALLBACK_BUILD_ID;
 	}
 
 	/**

packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.spec.ts

@@ -126,9 +126,10 @@ describe("KVNextModeTagCache", () => {
 			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);
 
 			mockGet.mockResolvedValue(new Map([["tag1", null]]));
 
@@ -406,9 +407,9 @@ describe("KVNextModeTagCache", () => {
 			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);
@@ -417,7 +418,7 @@ describe("KVNextModeTagCache", () => {
 		});
 
 		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);
@@ -427,18 +428,16 @@ describe("KVNextModeTagCache", () => {
 	});
 
 	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", () => {
-			// Environment variables are cleared by vi.unstubAllEnvs() in beforeEach
-
+		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);