basic purge cache

Author: conico974

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

@@ -1,10 +1,12 @@
 import { defineCloudflareConfig } from "@opennextjs/cloudflare";
 import r2IncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache";
+import {withRegionalCache} from "@opennextjs/cloudflare/overrides/incremental-cache/regional-cache";
 import shardedTagCache from "@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache";
 import doQueue from "@opennextjs/cloudflare/overrides/queue/do-queue";
+import cachePurge from "@opennextjs/cloudflare/overrides/cache-purge/index";
 
 export default defineCloudflareConfig({
-  incrementalCache: r2IncrementalCache,
+  incrementalCache: withRegionalCache(r2IncrementalCache, {mode: "long-lived"}),
   // With such a configuration, we could have up to 12 * (8 + 2) = 120 Durable Objects instances
   tagCache: shardedTagCache({
     baseShardSize: 12,
@@ -14,5 +16,6 @@ export default defineCloudflareConfig({
     },
   }),
   queue: doQueue,
+  cachePurge: cachePurge,
   enableCacheInterception: true,
 });

packages/cloudflare/src/api/cloudflare-context.ts

@@ -54,6 +54,10 @@ declare global {
     // Disable SQLite for the durable object queue handler
     // This can be safely used if you don't use an eventually consistent incremental cache (i.e. R2 without the regional cache for example)
     NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE?: string;
+
+    // Below are the optional env variables for purging the cache
+    CACHE_ZONE_ID?: string;
+    CACHE_API_TOKEN?: string;
   }
 }
 

packages/cloudflare/src/api/config.ts

@@ -4,7 +4,7 @@ import {
   LazyLoadedOverride,
   OpenNextConfig as AwsOpenNextConfig,
 } from "@opennextjs/aws/types/open-next";
-import type { IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/overrides";
+import type { CDNInvalidationHandler, IncrementalCache, Queue, TagCache } from "@opennextjs/aws/types/overrides";
 
 export type Override<T extends BaseOverride> = "dummy" | T | LazyLoadedOverride<T>;
 
@@ -29,6 +29,11 @@ export type CloudflareOverrides = {
    */
   queue?: "direct" | Override<Queue>;
 
+  /**
+   * Sets the automatic cache purge implementation
+   */
+  cachePurge?: Override<CDNInvalidationHandler>
+
   /**
    * Enable cache interception
    * Should be `false` when PPR is used
@@ -44,7 +49,7 @@ export type CloudflareOverrides = {
  * @returns the OpenNext configuration object
  */
 export function defineCloudflareConfig(config: CloudflareOverrides = {}): OpenNextConfig {
-  const { incrementalCache, tagCache, queue, enableCacheInterception = false } = config;
+  const { incrementalCache, tagCache, queue, cachePurge, enableCacheInterception = false } = config;
 
   return {
     default: {
@@ -55,6 +60,7 @@ export function defineCloudflareConfig(config: CloudflareOverrides = {}): OpenNe
         incrementalCache: resolveIncrementalCache(incrementalCache),
         tagCache: resolveTagCache(tagCache),
         queue: resolveQueue(queue),
+        cdnInvalidation: resolveCdnInvalidation(cachePurge),
       },
       routePreloadingBehavior: "withWaitUntil",
     },
@@ -93,6 +99,14 @@ function resolveQueue(value: CloudflareOverrides["queue"] = "dummy") {
   return typeof value === "function" ? value : () => value;
 }
 
+function resolveCdnInvalidation(value: CloudflareOverrides["cachePurge"] = "dummy") {
+  if (typeof value === "string") {
+    return value;
+  }
+
+  return typeof value === "function" ? value : () => value;
+}
+
 interface OpenNextConfig extends AwsOpenNextConfig {
   cloudflare?: {
     /**

packages/cloudflare/src/api/overrides/cache-purge/index.ts

@@ -0,0 +1,13 @@
+import type { CDNInvalidationHandler } from "@opennextjs/aws/types/overrides";
+
+import { debugCache, purgeCacheByTags } from "../internal.js";
+
+export default {
+  name: "cloudflare",
+  async invalidatePaths(paths) {
+    const tags = paths.map((path) => `_N_T_${path.rawPath}`);
+    debugCache("cdnInvalidation", "Invalidating paths:", tags);
+    await purgeCacheByTags(tags);
+    debugCache("cdnInvalidation", "Invalidated paths:", tags);
+  }
+} satisfies CDNInvalidationHandler;

packages/cloudflare/src/api/overrides/internal.ts

@@ -2,6 +2,8 @@ import { createHash } from "node:crypto";
 
 import type { CacheEntryType, CacheValue } from "@opennextjs/aws/types/overrides.js";
 
+import { getCloudflareContext } from "../cloudflare-context.js";
+
 export type IncrementalCacheEntry<CacheType extends CacheEntryType> = {
   value: CacheValue<CacheType>;
   lastModified: number;
@@ -28,3 +30,44 @@ export function computeCacheKey(key: string, options: KeyOptions) {
   const hash = createHash("sha256").update(key).digest("hex");
   return `${prefix}/${buildId}/${hash}.${cacheType}`.replace(/\/+/g, "/");
 }
+
+
+export async function purgeCacheByTags(tags: string[]) {
+  const {env} = getCloudflareContext()
+
+  if(!env.CACHE_ZONE_ID && !env.CACHE_API_TOKEN) {
+    // THIS IS A NO-OP
+    debugCache("purgeCacheByTags", "No cache zone ID or API token provided. Skipping cache purge.");
+    return;
+  }
+
+  try {
+    const response = await fetch(
+      `https://api.cloudflare.com/client/v4/zones/${env.CACHE_ZONE_ID}/purge_cache`,
+    {
+      headers: {
+        "Authorization": `Bearer ${env.CACHE_API_TOKEN}`,
+        "Content-Type": "application/json",
+      },
+      method: "POST",
+      body: JSON.stringify({
+        tags,
+      }),
+    })
+    if (!response.ok) {
+      const text = await response.text();
+      throw new Error(`Failed to purge cache: ${response.status} ${text}`);
+    }
+    const bodyResponse = await response.json() as {
+      success: boolean;
+      errors: Array<{ code: number; message: string }>;
+      messages: Array<{ code: number; message: string }>;
+    }
+    if (!bodyResponse.success) {
+      throw new Error(`Failed to purge cache: ${JSON.stringify(bodyResponse.errors)}`);
+    }
+    debugCache("purgeCacheByTags", "Cache purged successfully for tags:", tags);
+  }catch (error) {
+    console.error("Error purging cache by tags:", error);
+  }
+}

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

@@ -3,7 +3,7 @@ import type { NextModeTagCache } from "@opennextjs/aws/types/overrides.js";
 
 import type { OpenNextConfig } from "../../../api/config.js";
 import { getCloudflareContext } from "../../cloudflare-context.js";
-import { debugCache, FALLBACK_BUILD_ID } from "../internal.js";
+import { debugCache, FALLBACK_BUILD_ID, purgeCacheByTags } from "../internal.js";
 
 export const NAME = "d1-next-mode-tag-cache";
 
@@ -66,6 +66,7 @@ export class D1NextModeTagCache implements NextModeTagCache {
           .bind(this.getCacheKey(tag), Date.now())
       )
     );
+    await purgeCacheByTags(tags);
   }
 
   private getConfig() {

packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts

@@ -5,7 +5,7 @@ import { IgnorableError } from "@opennextjs/aws/utils/error.js";
 
 import type { OpenNextConfig } from "../../../api/config.js";
 import { getCloudflareContext } from "../../cloudflare-context";
-import { debugCache } from "../internal";
+import { debugCache, purgeCacheByTags } from "../internal";
 
 export const DEFAULT_WRITE_RETRIES = 3;
 export const DEFAULT_NUM_SHARDS = 4;
@@ -304,6 +304,7 @@ class ShardedDOTagCache implements NextModeTagCache {
         await this.performWriteTagsWithRetry(doId, tags, currentTime);
       })
     );
+    await purgeCacheByTags(tags);
   }
 
   async performWriteTagsWithRetry(doId: DOId, tags: string[], lastModified: number, retryNumber = 0) {