Added new buffer-string-decorator handler (#1)

* Added new buffer-string-decorator handler

* Removed try-catch

Author: AyronK

README.md

@@ -56,6 +56,16 @@ const compositeHandler = createHandler({
 });
 ```
 
+### 3. `buffer-string-decorator`
+
+#### Features:
+
+This cache handler converts buffers from cached route values to strings on save and back to buffers on read.
+
+Next 15 decided to change type of data.value.body property from String to Buffer which conflicts with how data is serialized to redis.
+
+It is recommended to use this handler with `redis-strings` in Next 15.
+
 ## Reference to Original Package
 
 This package builds upon the core functionality provided by [`@neshca/cache-handler`](https://www.npmjs.com/package/@neshca/cache-handler). You can find more information about the core library, including usage examples and API documentation, at the [official documentation page](https://caching-tools.github.io/next-shared-cache).

packages/nextjs-cache-handler/package.json

@@ -10,7 +10,7 @@
     "type": "git",
     "url": "git+https://github.com/fortedigital/nextjs-cache-handler.git"
   },
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "module",
   "license": "MIT",
   "description": "Next.js cache handlers",
@@ -27,6 +27,9 @@
       ],
       "redis-strings": [
         "dist/redis-strings.d.ts"
+      ],
+      "buffer-string-decorator": [
+        "buffer-string-decorator.d.ts"
       ]
     }
   },

packages/nextjs-cache-handler/src/handlers/buffer-string-decorator.ts

@@ -0,0 +1,57 @@
+import { Handler } from "@neshca/cache-handler";
+import { CachedRouteValue } from "next/dist/server/response-cache";
+
+type ConvertedStaticPageCacheData = CachedRouteValue & {
+  body: string;
+};
+
+/*
+ * This cache handler converts buffers from cached route values to strings on save and back to buffers on read.
+ *
+ * Next 15 decided to change type of data.value.body property from String to Buffer
+ * which conflicts with how data is serialized to redis.
+ */
+export default function bufferStringDecorator(handler: Handler): Handler {
+  return {
+    name: "forte-digital-next15-buffer-resolver-handler",
+
+    async get(key, ctx) {
+      const hit = await handler.get(key, ctx);
+      const staticPageCacheData =
+        hit?.value as unknown as ConvertedStaticPageCacheData;
+      if (hit?.value && staticPageCacheData?.body) {
+        return {
+          ...hit,
+          value: {
+            ...hit.value,
+            body: Buffer.from(staticPageCacheData.body, "utf-8"),
+          },
+        };
+      }
+      return hit;
+    },
+
+    async set(key, data) {
+      const routeValue = data.value as CachedRouteValue;
+      if (routeValue?.kind === "ROUTE" && routeValue?.body) {
+        await handler.set(key, {
+          ...data,
+          value: {
+            ...data.value,
+            body: routeValue.body.toString(),
+          } as ConvertedStaticPageCacheData,
+        });
+      } else {
+        await handler.set(key, data);
+      }
+    },
+
+    async revalidateTag(tag) {
+      await handler.revalidateTag(tag);
+    },
+
+    async delete(key) {
+      await handler.delete?.(key);
+    },
+  };
+}

packages/nextjs-cache-handler/src/handlers/composite.ts

@@ -39,7 +39,7 @@ export default function createHandler({
   }
 
   return {
-    name: "apopro-composite",
+    name: "forte-digital-composite",
 
     async get(key, ctx) {
       for (const handler of handlers) {

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

@@ -195,7 +195,7 @@ export default function createHandler({
   const revalidatedTagsKey = keyPrefix + REVALIDATED_TAGS_KEY;
 
   return {
-    name: "apopro-redis-strings",
+    name: "forte-digital-redis-strings",
     async get(key, { implicitTags }) {
       assertClientIsReady();