feat: add redis driver identification (#201)

Author: vchomakov

examples/redis-minimal/cache-handler.mjs

@@ -6,6 +6,7 @@ import createLruHandler from "@fortedigital/nextjs-cache-handler/local-lru";
 import createRedisHandler from "@fortedigital/nextjs-cache-handler/redis-strings";
 import createCompositeHandler from "@fortedigital/nextjs-cache-handler/composite";
 import { ioredisAdapter } from "@fortedigital/nextjs-cache-handler/helpers/ioredisAdapter";
+import { getClientInfoTag } from "@fortedigital/nextjs-cache-handler/helpers/getClientInfoTag";
 
 const isSingleConnectionModeEnabled = !!process.env.REDIS_SINGLE_CONNECTION;
 const redisType = process.env.REDIS_TYPE || "redis"; // "redis" or "ioredis"
@@ -17,7 +18,11 @@ async function setupRedisClient() {
     try {
       if (redisType === "ioredis") {
         console.info(`Using ioredis client...`);
-        const ioredisClient = new Redis(process.env.REDIS_URL);
+        const ioredisClient = new Redis(process.env.REDIS_URL, {
+          // Set clientInfoTag for Redis driver identification
+          // This helps identify the framework in CLIENT LIST output
+          clientInfoTag: getClientInfoTag(),
+        });
 
         // Wait for connection to be ready
         console.info("Connecting ioredis client...");
@@ -35,6 +40,9 @@ async function setupRedisClient() {
         redisClient = createClient({
           url: process.env.REDIS_URL,
           pingInterval: 10000,
+          // Set clientInfoTag for Redis driver identification
+          // This helps identify the framework in CLIENT LIST output
+          clientInfoTag: getClientInfoTag(),
         });
 
         console.info("Connecting Redis client...");

packages/nextjs-cache-handler/package.json

@@ -54,6 +54,10 @@
     "./helpers/ioredisAdapter": {
       "require": "./dist/helpers/ioredisAdapter.cjs",
       "import": "./dist/helpers/ioredisAdapter.js"
+    },
+    "./helpers/getClientInfoTag": {
+      "require": "./dist/helpers/getClientInfoTag.cjs",
+      "import": "./dist/helpers/getClientInfoTag.js"
     }
   },
   "typesVersions": {
@@ -87,6 +91,9 @@
       ],
       "helpers/ioredisAdapter": [
         "dist/helpers/ioredisAdapter.d.ts"
+      ],
+      "helpers/getClientInfoTag": [
+        "dist/helpers/getClientInfoTag.d.ts"
       ]
     }
   },

packages/nextjs-cache-handler/src/helpers/getClientInfoTag.test.ts

@@ -0,0 +1,31 @@
+import { getClientInfoTag } from "./getClientInfoTag";
+
+describe("getClientInfoTag", () => {
+  it("should return a string starting with 'nextjs-cache-handler'", () => {
+    const result = getClientInfoTag();
+
+    expect(result).toMatch(/^nextjs-cache-handler/);
+  });
+
+  it("should return a string with version in format 'nextjs-cache-handler_vX.X.X'", () => {
+    const result = getClientInfoTag();
+
+    // Should match pattern like "nextjs-cache-handler_v2.5.1"
+    expect(result).toMatch(/^nextjs-cache-handler_v\d+\.\d+\.\d+$/);
+  });
+
+  it("should include the correct package version", () => {
+    const result = getClientInfoTag();
+
+    // The version should be 2.5.1 based on package.json
+    expect(result).toBe("nextjs-cache-handler_v2.5.1");
+  });
+
+  it("should return consistent results on multiple calls", () => {
+    const result1 = getClientInfoTag();
+    const result2 = getClientInfoTag();
+
+    expect(result1).toBe(result2);
+  });
+});
+

packages/nextjs-cache-handler/src/helpers/getClientInfoTag.ts

@@ -0,0 +1,43 @@
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+function getPackageVersion(): string | undefined {
+  try {
+    const packageJsonPath = resolve(__dirname, '..', '..', 'package.json')
+    const content = readFileSync(packageJsonPath, 'utf-8')
+    const packageJson = JSON.parse(content) as { version: string }
+    return packageJson.version
+  } catch {
+    return undefined
+  }
+}
+
+/**
+ * Returns a client info tag string for Redis client identification.
+ *
+ * This function reads the version from `@fortedigital/nextjs-cache-handler/package.json`
+ * and returns a formatted string like `nextjs-cache-handler_v2.5.1`.
+ *
+ * If the version cannot be read, it falls back to `nextjs-cache-handler`.
+ *
+ * @example
+ * ```js
+ * import { createClient } from 'redis';
+ * import { getClientInfoTag } from '@fortedigital/nextjs-cache-handler/helpers/getClientInfoTag';
+ *
+ * const client = createClient({
+ *   url: 'redis://localhost:6379',
+ *   clientInfoTag: getClientInfoTag(),
+ * });
+ * ```
+ *
+ * @returns The client info tag string for Redis identification.
+ */
+export function getClientInfoTag(): string {
+  const version = getPackageVersion();
+  if (version) {
+    return `nextjs-cache-handler_v${version}`;
+  }
+  return "nextjs-cache-handler";
+}
+

packages/nextjs-cache-handler/tsup.config.ts

@@ -10,6 +10,7 @@ export const tsup = defineConfig({
     "src/helpers/withAbortSignal.ts",
     "src/helpers/withAbortSignalProxy.ts",
     "src/helpers/ioredisAdapter.ts",
+    "src/helpers/getClientInfoTag.ts",
   ],
   splitting: false,
   outDir: "dist",