fix: replace synchronous package.json require with async getPackageMeta utility

Author: PavelPashov

lib/redis/event_handler.ts

@@ -5,10 +5,13 @@ import { AbortError } from "redis-errors";
 import Command from "../Command";
 import { MaxRetriesPerRequestError } from "../errors";
 import { CommandItem, Respondable } from "../types";
-import { Debug, noop, CONNECTION_CLOSED_ERROR_MSG } from "../utils";
+import {
+  Debug,
+  noop,
+  CONNECTION_CLOSED_ERROR_MSG,
+  getPackageMeta,
+} from "../utils";
 import DataHandler from "../DataHandler";
-// This seems to be less problematic, than import
-const { version } = require("../../package.json");
 
 const debug = Debug("connection");
 
@@ -268,7 +271,18 @@ export function readyHandler(self) {
 
     if (!self.options?.disableClientInfo) {
       debug("set the client info");
-      self.client("SETINFO", "LIB-VER", version).catch(noop);
+
+      getPackageMeta()
+        .then((packageMeta) => {
+          self
+            .client(
+              "SETINFO",
+              "LIB-VER",
+              packageMeta?.version ?? "error-fetching-version"
+            )
+            .catch(noop);
+        })
+        .catch(noop);
 
       self
         .client(

lib/utils/index.ts

@@ -1,3 +1,5 @@
+import { promises as fsPromises } from "fs";
+import { resolve } from "path";
 import { parse as urllibParse } from "url";
 import { defaults, noop } from "./lodash";
 import { Callback } from "../types";
@@ -319,4 +321,39 @@ export function zipMap<K, V>(keys: K[], values: V[]): Map<K, V> {
   return map;
 }
 
+/**
+ * Memoized package metadata to avoid repeated file system reads.
+ *
+ * @internal
+ */
+let cachedPackageMeta: { version: string } = null;
+
+/**
+ * Retrieves cached package metadata from package.json.
+ *
+ * @internal
+ * @returns {Promise<{version: string} | null>} Package metadata or null if unavailable
+ */
+export async function getPackageMeta() {
+  if (cachedPackageMeta) {
+    return cachedPackageMeta;
+  }
+
+  try {
+    const filePath = resolve(__dirname, "..", "..", "package.json");
+    const data = await fsPromises.readFile(filePath, "utf8");
+    const parsed = JSON.parse(data);
+
+    cachedPackageMeta = {
+      version: parsed.version,
+    };
+  } catch (err) {
+    cachedPackageMeta = {
+      version: "error-fetching-version",
+    };
+  } finally {
+    return cachedPackageMeta;
+  }
+}
+
 export { Debug, defaults, noop };

test/functional/client_info.ts

@@ -46,7 +46,9 @@ describe("clientInfo", function () {
         (cmd) => cmd.key === "LIB-NAME"
       );
 
-      expect(libVerCommand).to.exist; // version will change over time
+      expect(libVerCommand).to.exist;
+      expect(libVerCommand?.value).to.be.a("string");
+      expect(libVerCommand?.value).to.not.equal("unknown");
       expect(libNameCommand).to.exist;
       expect(libNameCommand?.value).to.equal("ioredis");
     });
@@ -183,6 +185,8 @@ describe("clientInfo", function () {
       );
 
       expect(libVerCommand).to.exist;
+      expect(libVerCommand?.value).to.be.a("string");
+      expect(libVerCommand?.value).to.not.equal("unknown");
       expect(libNameCommand).to.exist;
       expect(libNameCommand?.value).to.equal("ioredis");
     });

tsconfig.json

@@ -10,8 +10,7 @@
     ],
     "moduleResolution": "node",
     "module": "commonjs",
-    "outDir": "./built",
-    "resolveJsonModule": true,
+    "outDir": "./built"
   },
   "include": ["./lib/**/*"]
 }