feat: invoke a remove method on the queue after cache set

Author: james-elicx

.changeset/stupid-gifts-cough.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": minor
+---
+
+Invoke a remove method on the queue after an incremental cache set for a route takes place.

packages/open-next/src/adapters/cache.ts

@@ -393,6 +393,19 @@ export default class Cache {
     } finally {
       // We need to resolve the promise even if there was an error
       detachedPromise?.resolve();
+
+      switch (data?.kind) {
+        case "ROUTE":
+        case "APP_ROUTE":
+        case "PAGE":
+        case "PAGES":
+        case "APP_PAGE":
+        case "REDIRECT":
+          globalThis.queue.remove?.(key);
+          break;
+        default:
+        // Fetch cache entries and images do not use the queue
+      }
     }
   }
 

packages/open-next/src/types/overrides.ts

@@ -24,8 +24,9 @@ export interface QueueMessage {
 }
 
 export interface Queue {
-  send(message: QueueMessage): Promise<void>;
   name: string;
+  send(message: QueueMessage): Promise<void>;
+  remove?(path: string): void;
 }
 
 // Incremental cache

packages/tests-unit/tests/adapters/cache.test.ts

@@ -41,6 +41,13 @@ describe("CacheHandler", () => {
   };
   globalThis.tagCache = tagCache;
 
+  const queue = {
+    name: "mock",
+    send: vi.fn(),
+    remove: vi.fn(),
+  };
+  globalThis.queue = queue;
+
   const invalidateCdnHandler = {
     name: "mock",
     invalidatePaths: vi.fn(),
@@ -335,6 +342,7 @@ describe("CacheHandler", () => {
         { type: "route", body: "{}", meta: { status: 200, headers: {} } },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should set cache when for APP_ROUTE", async () => {
@@ -356,6 +364,7 @@ describe("CacheHandler", () => {
         },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should set cache when for PAGE", async () => {
@@ -376,6 +385,7 @@ describe("CacheHandler", () => {
         },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should set cache when for PAGES", async () => {
@@ -397,6 +407,7 @@ describe("CacheHandler", () => {
         },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should set cache when for APP_PAGE", async () => {
@@ -418,6 +429,7 @@ describe("CacheHandler", () => {
         },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should set cache when for FETCH", async () => {
@@ -448,6 +460,7 @@ describe("CacheHandler", () => {
         },
         true,
       );
+      expect(globalThis.queue.remove).not.toHaveBeenCalled();
     });
 
     it("Should set cache when for REDIRECT", async () => {
@@ -461,6 +474,7 @@ describe("CacheHandler", () => {
         },
         false,
       );
+      expect(globalThis.queue.remove).toHaveBeenCalledWith("key");
     });
 
     it("Should not set cache when for IMAGE (not implemented)", async () => {
@@ -472,6 +486,7 @@ describe("CacheHandler", () => {
       });
 
       expect(incrementalCache.set).not.toHaveBeenCalled();
+      expect(globalThis.queue.remove).not.toHaveBeenCalled();
     });
 
     it("Should not throw when set cache throws", async () => {