feat: basic in-memory de-duping revalidation queue

Author: james-elicx

.changeset/witty-baboons-smile.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": minor
+---
+
+feat: basic in-memory de-duping revalidation queue

examples/e2e/app-router/open-next.config.ts

@@ -1,13 +1,14 @@
 import type { OpenNextConfig } from "@opennextjs/aws/types/open-next.js";
 import cache from "@opennextjs/cloudflare/kv-cache";
+import memoryQueue from "@opennextjs/cloudflare/memory-queue";
 
 const config: OpenNextConfig = {
   default: {
     override: {
       wrapper: "cloudflare-node",
       converter: "edge",
       incrementalCache: async () => cache,
-      queue: "direct",
+      queue: () => memoryQueue,
       // Unused implementation
       tagCache: "dummy",
     },

packages/cloudflare/package.json

@@ -73,7 +73,7 @@
   "dependencies": {
     "@ast-grep/napi": "^0.34.1",
     "@dotenvx/dotenvx": "catalog:",
-    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@727",
+    "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@0b8705a",
     "enquirer": "^2.4.1",
     "glob": "catalog:",
     "yaml": "^2.7.0"

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

@@ -2,6 +2,7 @@ import type { CacheValue, IncrementalCache, WithLastModified } from "@opennextjs
 import { IgnorableError, RecoverableError } from "@opennextjs/aws/utils/error.js";
 
 import { getCloudflareContext } from "./cloudflare-context.js";
+import memoryQueue from "./memory-queue.js";
 
 export const CACHE_ASSET_DIR = "cdn-cgi/_next_cache";
 
@@ -116,6 +117,8 @@ class Cache implements IncrementalCache {
       );
     } catch {
       throw new RecoverableError(`Failed to set cache [${key}]`);
+    } finally {
+      memoryQueue.remove(key);
     }
   }
 

packages/cloudflare/src/api/memory-queue.ts

@@ -0,0 +1,52 @@
+import { generateMessageGroupId } from "@opennextjs/aws/core/routing/queue.js";
+import logger from "@opennextjs/aws/logger.js";
+import type { Queue, QueueMessage } from "@opennextjs/aws/types/overrides.js";
+
+/**
+ * The Memory Queue offers basic ISR revalidation by directly requesting a revalidation of a route.
+ *
+ * It offers basic support for in-memory de-duping per isolate.
+ */
+class MemoryQueue implements Queue {
+  readonly name = "memory-queue";
+
+  public revalidatedPaths = new Map<string, ReturnType<typeof setTimeout>>();
+
+  public async send({ MessageBody: { host, url }, MessageGroupId }: QueueMessage): Promise<void> {
+    this.revalidatedPaths.set(
+      MessageGroupId,
+      // force remove to allow new revalidations incase something went wrong
+      setTimeout(() => this.removeId(MessageGroupId), 10_000)
+    );
+
+    try {
+      // @ts-expect-error
+      const manifest = await import("./.next/prerender-manifest.json");
+      const protocol = host.includes("localhost") ? "http" : "https";
+
+      await globalThis.internalFetch(`${protocol}://${host}${url}`, {
+        method: "HEAD",
+        headers: {
+          "x-prerender-revalidate": manifest.preview.previewModeId,
+          "x-isr": "1",
+        },
+      });
+    } catch (e) {
+      logger.error(e);
+      this.revalidatedPaths.delete(MessageGroupId);
+    }
+  }
+
+  private removeId(id: string) {
+    clearTimeout(this.revalidatedPaths.get(id));
+    this.revalidatedPaths.delete(id);
+  }
+
+  public remove(path: string) {
+    if (this.revalidatedPaths.size > 0) {
+      this.removeId(generateMessageGroupId(path));
+    }
+  }
+}
+
+export default new MemoryQueue();

packages/cloudflare/src/cli/build/utils/ensure-cf-config.ts

@@ -15,7 +15,9 @@ export function ensureCloudflareConfig(config: OpenNextConfig) {
       typeof config.default?.override?.incrementalCache === "function",
     dftUseDummyTagCache: config.default?.override?.tagCache === "dummy",
     dftMaybeUseQueue:
-      config.default?.override?.queue === "dummy" || config.default?.override?.queue === "direct",
+      config.default?.override?.queue === "dummy" ||
+      config.default?.override?.queue === "direct" ||
+      typeof config.default?.override?.incrementalCache === "function",
     disableCacheInterception: config.dangerous?.enableCacheInterception !== true,
     mwIsMiddlewareExternal: config.middleware?.external == true,
     mwUseCloudflareWrapper: config.middleware?.override?.wrapper === "cloudflare-edge",
@@ -37,7 +39,7 @@ export function ensureCloudflareConfig(config: OpenNextConfig) {
               converter: "edge",
               incrementalCache: "dummy" | function,
               tagCache: "dummy",
-              queue: "dummy" | "direct",
+              queue: "dummy" | "direct" | function,
             },
           },
 

packages/cloudflare/tsconfig.json

@@ -13,7 +13,7 @@
     "noPropertyAccessFromIndexSignature": false,
     "outDir": "./dist",
     "target": "ES2022",
-    "types": ["@cloudflare/workers-types"]
+    "types": ["@cloudflare/workers-types", "@opennextjs/aws/types/global.d.ts"]
   },
   "include": ["src/**/*.ts"]
 }