Pass revalidate value to the incremental cache for ISR/SSG route (#833)

* pass revalidate for isr incremental cache

* changeset

* review fix

Author: conico974

.changeset/lucky-ghosts-knock.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": patch
+---
+
+pass revalidate for ISR/SSG cache

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

@@ -207,6 +207,7 @@ export default class Cache {
       if (data === null || data === undefined) {
         await globalThis.incrementalCache.delete(key);
       } else {
+        const revalidate = this.extractRevalidateForSet(ctx);
         switch (data.kind) {
           case "ROUTE":
           case "APP_ROUTE": {
@@ -224,6 +225,7 @@ export default class Cache {
                   status,
                   headers,
                 },
+                revalidate,
               },
               false,
             );
@@ -244,6 +246,7 @@ export default class Cache {
                     status,
                     headers,
                   },
+                  revalidate,
                 },
                 false,
               );
@@ -254,6 +257,7 @@ export default class Cache {
                   type: "page",
                   html,
                   json: pageData,
+                  revalidate,
                 },
                 false,
               );
@@ -272,6 +276,7 @@ export default class Cache {
                   status,
                   headers,
                 },
+                revalidate,
               },
               false,
             );
@@ -286,6 +291,7 @@ export default class Cache {
               {
                 type: "redirect",
                 props: data.props,
+                revalidate,
               },
               false,
             );
@@ -424,7 +430,8 @@ export default class Cache {
     // If we use an in house version of getDerivedTags in build we should use it here instead of next's one
     const derivedTags: string[] =
       data?.kind === "FETCH"
-        ? (ctx?.tags ?? data?.data?.tags ?? []) // before version 14 next.js used data?.data?.tags so we keep it for backward compatibility
+        ? //@ts-expect-error - On older versions of next, ctx was a number, but for these cases we use data?.data?.tags
+          (ctx?.tags ?? data?.data?.tags ?? []) // before version 14 next.js used data?.data?.tags so we keep it for backward compatibility
         : data?.kind === "PAGE"
           ? (data.headers?.["x-next-cache-tags"]?.split(",") ?? [])
           : [];
@@ -446,4 +453,22 @@ export default class Cache {
       );
     }
   }
+
+  private extractRevalidateForSet(
+    ctx?: IncrementalCacheContext,
+  ): number | false | undefined {
+    if (ctx === undefined) {
+      return undefined;
+    }
+    if (typeof ctx === "number" || ctx === false) {
+      return ctx;
+    }
+    if ("revalidate" in ctx) {
+      return ctx.revalidate;
+    }
+    if ("cacheControl" in ctx) {
+      return ctx.cacheControl?.revalidate;
+    }
+    return undefined;
+  }
 }

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

@@ -98,10 +98,44 @@ export type TagCacheMetaFile = {
   revalidatedAt: { N: string };
 };
 
-export type IncrementalCacheContext = {
-  revalidate?: number | false | undefined;
-  fetchCache?: boolean | undefined;
-  fetchUrl?: string | undefined;
-  fetchIdx?: number | undefined;
-  tags?: string[] | undefined;
-};
+// Cache context since vercel/next.js#76207
+interface SetIncrementalFetchCacheContext {
+  fetchCache: true;
+  fetchUrl?: string;
+  fetchIdx?: number;
+  tags?: string[];
+}
+
+interface SetIncrementalResponseCacheContext {
+  fetchCache?: false;
+  cacheControl?: {
+    revalidate: number | false;
+    expire?: number;
+  };
+
+  /**
+   * True if the route is enabled for PPR.
+   */
+  isRoutePPREnabled?: boolean;
+
+  /**
+   * True if this is a fallback request.
+   */
+  isFallback?: boolean;
+}
+
+// Before vercel/next.js#76207 revalidate was passed this way
+interface SetIncrementalCacheContext {
+  revalidate?: number | false;
+  isRoutePPREnabled?: boolean;
+  isFallback?: boolean;
+}
+
+// Before vercel/next.js#53321 context on set was just the revalidate
+type OldSetIncrementalCacheContext = number | false | undefined;
+
+export type IncrementalCacheContext =
+  | OldSetIncrementalCacheContext
+  | SetIncrementalCacheContext
+  | SetIncrementalFetchCacheContext
+  | SetIncrementalResponseCacheContext;

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

@@ -79,7 +79,12 @@ export type WithLastModified<T> = {
 
 export type CacheValue<IsFetch extends boolean> = (IsFetch extends true
   ? CachedFetchValue
-  : CachedFile) & { revalidate?: number | false };
+  : CachedFile) & {
+  /**
+   * This is available for page cache entry, but only at runtime.
+   */
+  revalidate?: number | false;
+};
 
 export type IncrementalCache = {
   get<IsFetch extends boolean = false>(