Fixed instrumentation kind mapping

Author: AyronK

README.md

@@ -4,6 +4,43 @@
 
 This package extends the functionality of [`@neshca/cache-handler`](https://www.npmjs.com/package/@neshca/cache-handler) by providing additional cache handlers for specialized use cases, specifically for Redis-based caching solutions. The original `@neshca/cache-handler` offers a robust caching API for Next.js applications, and this package introduces two new handlers for managing Redis cache with different expiration strategies and tag-based revalidation.
 
+
+## Migration
+
+### 1.2.x -> 1.3.x
+
+#### cache-handler
+1.2.x
+```
+const { Next15CacheHandler } = require("@fortedigital/nextjs-cache-handler/next-15-cache-handler");
+module.exports = new Next15CacheHandler();
+```
+
+1.3.x
+```
+const { Next15CacheHandler } = require("@fortedigital/nextjs-cache-handler");
+module.exports = Next15CacheHandler;
+```
+
+#### instrumentation
+1.2.x
+```
+if (process.env.NEXT_RUNTIME === "nodejs") {
+    const { registerInitialCache } = await import('@neshca/cache-handler/instrumentation')
+    const CacheHandler = (await import("./cache-handler.js")).default;
+    await registerInitialCache(CacheHandler);
+}
+```
+
+1.3.x
+```
+if (process.env.NEXT_RUNTIME === "nodejs") {
+    const { registerInitialCache } = await import("@fortedigital/nextjs-cache-handler/instrumentation");
+    const CacheHandler = (await import("./cache-handler.js")).default;
+    await registerInitialCache(CacheHandler);
+}
+```
+
 ## Installation
 
 To install this package along with its dependencies:
@@ -53,15 +90,13 @@ Use this:
 
 ```js
 const { CacheHandler } = require("@neshca/cache-handler");
-const {
-  Next15CacheHandler,
-} = require("@fortedigital/nextjs-cache-handler/next-15-cache-handler");
+const { Next15CacheHandler } = require("@fortedigital/nextjs-cache-handler");
 
 CacheHandler.onCreation(() => {
   // your usual setup
 });
 
-module.exports = new Next15CacheHandler();
+module.exports = Next15CacheHandler;
 ```
 
 ### Instrumentation
@@ -270,7 +305,7 @@ CacheHandler.onCreation(() => {
   return global.cacheHandlerConfigPromise;
 });
 
-module.exports = new Next15CacheHandler();
+module.exports = Next15CacheHandler;
 ```
 
 ## Reference to Original Package

packages/nextjs-cache-handler/package.json

@@ -30,23 +30,20 @@
   },
   "typesVersions": {
     "*": {
-      "Next15CacheHandler": [
+      "*": [
         "dist/handlers/next-15-cache-handler.d.ts"
       ],
-      "composite": [
-        "dist/handlers/composite.d.ts"
-      ],
-      "redis-strings": [
-        "dist/handlers/redis-strings.d.ts"
+      "instrumentation": [
+        "dist/instrumentation/instrumentation.d.ts"
       ],
       "buffer-string-decorator": [
         "dist/handlers/buffer-string-decorator.d.ts"
       ],
-      "instrumentation/instrumentation": [
-        "dist/instrumentation/instrumentation.d.ts"
+      "composite": [
+        "dist/handlers/composite.d.ts"
       ],
-      "instrumentation/register-initial-cache": [
-        "dist/instrumentation/register-initial-cache.d.ts"
+      "redis-strings": [
+        "dist/handlers/redis-strings.d.ts"
       ]
     }
   },

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

@@ -1,33 +1,64 @@
 import { CacheHandler } from "@neshca/cache-handler";
+import { OutgoingHttpHeaders } from "http";
 import {
+  CachedRedirectValue,
+  CachedImageValue,
   CachedFetchValue,
   IncrementalCacheValue,
 } from "next/dist/server/response-cache";
 
+export interface CachedRouteValue {
+  kind: "APP_ROUTE";
+  body: Buffer;
+  status: number;
+  headers: OutgoingHttpHeaders;
+}
+
+interface IncrementalCachedPageValue {
+  kind: "APP_PAGE";
+  html: string;
+  pageData: Object;
+  postponed: string | undefined;
+  headers: OutgoingHttpHeaders | undefined;
+  status: number | undefined;
+}
+
+export type Next15IncrementalCacheValue =
+  | CachedRedirectValue
+  | IncrementalCachedPageValue
+  | CachedImageValue
+  | CachedFetchValue
+  | CachedRouteValue;
+
 /*
  * 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, {
+export class Next15CacheHandler extends CacheHandler {
+  async set(
+    cacheKey: string,
+    incrementalCacheValue:
+      | IncrementalCacheValue
+      | Next15IncrementalCacheValue
+      | null,
+    ctx: {
+      revalidate?: number | false;
+      fetchCache?: boolean;
+      fetchUrl?: string;
+      fetchIdx?: number;
+      tags?: string[];
+    } & { neshca_lastModified?: number },
+  ) {
+    await super.set(
+      cacheKey,
+      incrementalCacheValue as unknown as IncrementalCacheValue,
+      {
         ...ctx,
         revalidate:
           ctx.revalidate ||
           (incrementalCacheValue as CachedFetchValue)?.revalidate,
-      });
-    }
-  };
+      },
+    );
+  }
 }

packages/nextjs-cache-handler/src/instrumentation/helpers/getTagsFromHeaders.ts

@@ -9,15 +9,15 @@ import type { OutgoingHttpHeaders } from "http";
  */
 
 export function getTagsFromHeaders(headers: OutgoingHttpHeaders): string[] {
-    const tagsHeader = headers["x-next-cache-tags"];
+  const tagsHeader = headers["x-next-cache-tags"];
 
-    if (Array.isArray(tagsHeader)) {
-        return tagsHeader;
-    }
+  if (Array.isArray(tagsHeader)) {
+    return tagsHeader;
+  }
 
-    if (typeof tagsHeader === "string") {
-        return tagsHeader.split(",");
-    }
+  if (typeof tagsHeader === "string") {
+    return tagsHeader.split(",");
+  }
 
-    return [];
+  return [];
 }

packages/nextjs-cache-handler/src/instrumentation/instrumentation.ts

@@ -1,4 +1,4 @@
 export {
   registerInitialCache,
   type RegisterInitialCacheOptions,
-} from './register-initial-cache';
+} from "./register-initial-cache";

packages/nextjs-cache-handler/src/instrumentation/register-initial-cache.ts

@@ -3,14 +3,13 @@ import path from "node:path";
 import { PRERENDER_MANIFEST, SERVER_DIRECTORY } from "next/constants";
 import type { PrerenderManifest } from "next/dist/build";
 import { CACHE_ONE_YEAR } from "next/dist/lib/constants";
-import { CacheHandler } from "@neshca/cache-handler";
-import { Next15CacheHandler } from "../handlers/next-15-cache-handler";
 import { Revalidate } from "next/dist/server/lib/revalidate";
 import { CachedFetchValue } from "next/dist/server/response-cache";
 import type { OutgoingHttpHeaders } from "http";
 import { getTagsFromHeaders } from "./helpers/getTagsFromHeaders";
 
-type CacheHandlerType = typeof import('../handlers/next-15-cache-handler').Next15CacheHandler;
+type CacheHandlerType =
+  typeof import("../handlers/next-15-cache-handler").Next15CacheHandler;
 
 type NextRouteMetadata = {
   status: number | undefined;
@@ -202,7 +201,7 @@ export async function registerInitialCache(
       await cacheHandler.set(
         cachePath,
         {
-          kind: "ROUTE",
+          kind: "APP_ROUTE",
           body,
           headers: meta.headers,
           status: meta.status,
@@ -289,7 +288,7 @@ export async function registerInitialCache(
       await cacheHandler.set(
         cachePath,
         {
-          kind: "PAGE",
+          kind: "APP_PAGE",
           html,
           pageData,
           postponed: meta?.postponed,