Feat Add additional params to the queue override (#773)

conico974 · web-flow · commit daa330b22e8b · 2025-03-13T13:58:10.000+01:00
* add additional info on the queue message

* add .js so that test doesn't fail in cloudflare

* changeset

* fix test

* review fix
diff --git a/.changeset/sour-boxes-jump.md b/.changeset/sour-boxes-jump.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": patch
+---
+
+Add additional params to the queue override
diff --git a/packages/open-next/src/adapters/logger.ts b/packages/open-next/src/adapters/logger.ts
@@ -1,4 +1,4 @@
-import { isOpenNextError } from "utils/error";
+import { isOpenNextError } from "utils/error.js";
 
 export function debug(...args: any[]) {
   if (globalThis.openNextDebug) {
diff --git a/packages/open-next/src/core/routing/cacheInterceptor.ts b/packages/open-next/src/core/routing/cacheInterceptor.ts
@@ -63,7 +63,12 @@ async function computeCacheControl(
         url = `${NextConfig.basePath}${url}`;
       }
       await globalThis.queue.send({
-        MessageBody: { host, url },
+        MessageBody: {
+          host,
+          url,
+          eTag: etag,
+          lastModified: lastModified ?? Date.now(),
+        },
         MessageDeduplicationId: hash(`${path}-${lastModified}-${etag}`),
         MessageGroupId: generateMessageGroupId(path),
       });
diff --git a/packages/open-next/src/core/routing/util.ts b/packages/open-next/src/core/routing/util.ts
@@ -324,11 +324,11 @@ export async function revalidateIfRequired(
 
       // For some weird cases, lastModified is not set, haven't been able to figure out yet why
       // For those cases we add the etag to the deduplication id, it might help
-      const etag = headers.etag ?? headers.ETag ?? "";
+      const eTag = `${headers.etag ?? headers.ETag ?? ""}`;
 
       await globalThis.queue.send({
-        MessageBody: { host, url: revalidateUrl },
-        MessageDeduplicationId: hash(`${rawPath}-${lastModified}-${etag}`),
+        MessageBody: { host, url: revalidateUrl, eTag, lastModified },
+        MessageDeduplicationId: hash(`${rawPath}-${lastModified}-${eTag}`),
         MessageGroupId: generateMessageGroupId(rawPath),
       });
     } catch (e) {
diff --git a/packages/open-next/src/types/overrides.ts b/packages/open-next/src/types/overrides.ts
@@ -20,6 +20,8 @@ export interface QueueMessage {
   MessageBody: {
     host: string;
     url: string;
+    lastModified: number;
+    eTag: string;
   };
   MessageGroupId: string;
 }
diff --git a/packages/tests-unit/tests/core/routing/util.test.ts b/packages/tests-unit/tests/core/routing/util.test.ts
@@ -668,7 +668,12 @@ describe("revalidateIfRequired", () => {
     await revalidateIfRequired("localhost", "/path", headers);
 
     expect(sendMock).toHaveBeenCalledWith({
-      MessageBody: { host: "localhost", url: "/path" },
+      MessageBody: {
+        host: "localhost",
+        url: "/path",
+        eTag: expect.any(String),
+        lastModified: expect.any(Number),
+      },
       MessageDeduplicationId: expect.any(String),
       MessageGroupId: expect.any(String),
     });
@@ -682,7 +687,12 @@ describe("revalidateIfRequired", () => {
     await revalidateIfRequired("localhost", "/path", headers);
 
     expect(sendMock).toHaveBeenCalledWith({
-      MessageBody: { host: "localhost", url: "/path" },
+      MessageBody: {
+        host: "localhost",
+        url: "/path",
+        eTag: expect.any(String),
+        lastModified: expect.any(Number),
+      },
       MessageDeduplicationId: expect.any(String),
       MessageGroupId: expect.any(String),
     });

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@opennextjs/aws": patch
 +---
++
 +Add additional params to the queue override
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { isOpenNextError } from "utils/error";`
	`1`	`+import { isOpenNextError } from "utils/error.js";`
`2`	`2`
`3`	`3`	`export function debug(...args: any[]) {`
`4`	`4`	`if (globalThis.openNextDebug) {`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@ export interface QueueMessage {`
`20`	`20`	`MessageBody: {`
`21`	`21`	`host: string;`
`22`	`22`	`url: string;`
	`23`	`+ lastModified: number;`
	`24`	`+ eTag: string;`
`23`	`25`	`};`
`24`	`26`	`MessageGroupId: string;`
`25`	`27`	`}`