Added Next15 support for fetch revalidate (#4)

* Added Next15 support for fetch revalidate

* Updated readme

Author: AyronK

README.md

@@ -14,6 +14,48 @@ npm install @fortedigital/nextjs-cache-handler
 
 Package depends on the original `@neshca/cache-handler` package - you can use anything provided by it by using import/require from `@neshca/cache-handler`.
 
+## Next 15 Support
+
+As `@neshca/cache-handler` does not officially support Next 15+ yet, we try to keep up with Next and prepare more or less temporary workarounds. At some point we will either create a fork of `@neshca/cache-handler` to fully support Next 15 or it gets updated by the maintainers. As for now we're building a set of decorators/workarounds you can use to build cache solutions for Next 15. We might need to do a full-blown rework which will be marked with a proper major version upgrade.
+
+### String buffer breaking change
+
+If you use Redis Strings cache handler with Next15+ you need to decorate the default Redis String handler with a buffer converter like this:
+
+```
+// ...
+const redisCacheHandler = createRedisHandler({
+    client: redisClient,
+    keyPrefix: "nextjs:",
+});
+
+return {
+  handlers: [
+    createBufferStringHandler(redisCacheHandler)
+  ]
+}
+
+// ...
+```
+
+Read more about this in Handlers section below.
+
+### Revalidate fetch breaking change
+
+Instead of:
+
+```
+const { CacheHandler } = require("@neshca/cache-handler");
+module.exports = CacheHandler;
+```
+
+Use this:
+
+```
+const { Next15CacheHandler } = require("@fortedigital/next-15-cache-handler");
+module.exports = new Next15CacheHandler();
+```
+
 ## Handlers
 
 ### 1. `redis-strings`

packages/nextjs-cache-handler/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "git+https://github.com/fortedigital/nextjs-cache-handler.git"
   },
-  "version": "1.1.2-alpha-2",
+  "version": "1.1.3",
   "type": "module",
   "license": "MIT",
   "description": "Next.js cache handlers",
@@ -22,6 +22,9 @@
   },
   "typesVersions": {
     "*": {
+      "Next15CacheHandler": [
+        "dist/next-15-cache-handler.d.ts"
+      ],
       "composite": [
         "dist/composite.d.ts"
       ],
@@ -69,7 +72,8 @@
   },
   "distTags": [
     "next13.5",
-    "next14"
+    "next14",
+    "next15"
   ],
   "optionalDependencies": {
     "@rollup/rollup-linux-x64-gnu": "^4.37.0"

packages/nextjs-cache-handler/src/handlers/next-15-cache-handler.ts

@@ -0,0 +1,33 @@
+import { CacheHandler } from "@neshca/cache-handler";
+import {
+  CachedFetchValue,
+  IncrementalCacheValue,
+} from "next/dist/server/response-cache";
+
+/*
+ * Use this handler in Next 15.2.1 and higher after `revalidate` property had been removed from context object.
+ * https://github.com/caching-tools/next-shared-cache/issues/1027
+ * https://github.com/vercel/next.js/commit/6a1b6336a3062dfdb1b9dddcee6b836da94fd198
+ */
+export function Next15CacheHandler() {
+  return class extends CacheHandler {
+    async set(
+      cacheKey: string,
+      incrementalCacheValue: IncrementalCacheValue | null,
+      ctx: {
+        revalidate?: number | false;
+        fetchCache?: boolean;
+        fetchUrl?: string;
+        fetchIdx?: number;
+        tags?: string[];
+      } & { neshca_lastModified?: number },
+    ) {
+      await super.set(cacheKey, incrementalCacheValue, {
+        ...ctx,
+        revalidate:
+          ctx.revalidate ||
+          (incrementalCacheValue as CachedFetchValue)?.revalidate,
+      });
+    }
+  };
+}

packages/nextjs-cache-handler/src/handlers/redis-strings.ts

@@ -102,10 +102,7 @@ export default function createHandler({
       return;
     }
 
-    await client.unlink(
-      getTimeoutRedisCommandOptions(timeoutMs),
-      keysToDelete,
-    );
+    await client.unlink(getTimeoutRedisCommandOptions(timeoutMs), keysToDelete);
 
     const updateTagsOperation = client.hDel(
       { isolated: true, ...getTimeoutRedisCommandOptions(timeoutMs) },
@@ -119,10 +116,7 @@ export default function createHandler({
       tagsToDelete,
     );
 
-    await Promise.all([
-      updateTtlOperation,
-      updateTagsOperation,
-    ]);
+    await Promise.all([updateTtlOperation, updateTagsOperation]);
   }
 
   async function revalidateSharedKeys() {
@@ -161,10 +155,7 @@ export default function createHandler({
       return;
     }
 
-    await client.unlink(
-      getTimeoutRedisCommandOptions(timeoutMs),
-      keysToDelete,
-    );
+    await client.unlink(getTimeoutRedisCommandOptions(timeoutMs), keysToDelete);
 
     const updateTtlOperation = client.hDel(
       {
@@ -184,10 +175,7 @@ export default function createHandler({
       tagsAndTtlToDelete,
     );
 
-    await Promise.all([
-      updateTagsOperation,
-      updateTtlOperation,
-    ]);
+    await Promise.all([updateTagsOperation, updateTtlOperation]);
   }
 
   const revalidatedTagsKey = keyPrefix + REVALIDATED_TAGS_KEY;
@@ -268,10 +256,7 @@ export default function createHandler({
           )
         : undefined;
 
-        await Promise.all([
-          setTagsOperation,
-          setSharedTtlOperation,
-        ]);
+      await Promise.all([setTagsOperation, setSharedTtlOperation]);
 
       switch (keyExpirationStrategy) {
         case "EXAT": {
@@ -306,10 +291,7 @@ export default function createHandler({
         }
       }
 
-        await Promise.all([
-          setOperation,
-          expireOperation,
-        ]);
+      await Promise.all([setOperation, expireOperation]);
     },
     async revalidateTag(tag) {
       assertClientIsReady();