fix: support passing keyPrefix via redisOptions

Author: luin

lib/cluster/ClusterOptions.ts

@@ -1,4 +1,5 @@
 import { SrvRecord, resolveSrv, lookup } from "dns";
+import { RedisOptions } from "../redis/RedisOptions";
 import { CommanderOptions } from "../utils/Commander";
 import { NodeRole } from "./util";
 
@@ -123,7 +124,16 @@ export interface ClusterOptions extends CommanderOptions {
    *
    * @default null
    */
-  redisOptions?: any;
+  redisOptions?: Omit<
+    RedisOptions,
+    | "port"
+    | "host"
+    | "path"
+    | "sentinels"
+    | "retryStrategy"
+    | "enableOfflineQueue"
+    | "readOnly"
+  >;
 
   /**
    * By default, When a new Cluster instance is created,

lib/cluster/index.ts

@@ -108,6 +108,14 @@ class Cluster extends Commander {
     this.startupNodes = startupNodes;
     this.options = defaults({}, options, DEFAULT_CLUSTER_OPTIONS, this.options);
 
+    if (
+      this.options.redisOptions &&
+      this.options.redisOptions.keyPrefix &&
+      !this.options.keyPrefix
+    ) {
+      this.options.keyPrefix = this.options.redisOptions.keyPrefix;
+    }
+
     // validate options
     if (
       typeof this.options.scaleReads !== "function" &&

test-cluster/basic.ts

@@ -125,4 +125,24 @@ describe("cluster", () => {
       expect(await cluster.get("foo")).to.eql("auto pipelining");
     });
   });
+
+  describe("key prefixing", () => {
+    it("works when passing via redisOptions", async () => {
+      const cluster1 = new Cluster([{ host: "127.0.0.1", port: masters[0] }], {
+        redisOptions: { keyPrefix: "prefix:" },
+      });
+      await cluster1.set("foo", "bar");
+      const cluster2 = new Cluster([{ host: "127.0.0.1", port: masters[0] }]);
+      expect(await cluster2.get("prefix:foo")).to.eql("bar");
+    });
+
+    it("works when passing via root", async () => {
+      const cluster1 = new Cluster([{ host: "127.0.0.1", port: masters[0] }], {
+        keyPrefix: "prefix:",
+      });
+      await cluster1.set("foo", "bar");
+      const cluster2 = new Cluster([{ host: "127.0.0.1", port: masters[0] }]);
+      expect(await cluster2.get("prefix:foo")).to.eql("bar");
+    });
+  });
 });

test/unit/clusters/index.ts

@@ -26,6 +26,13 @@ describe("cluster", () => {
     expect(cluster.options).to.have.property("showFriendlyErrorStack", true);
   });
 
+  it("should support passing keyPrefix via redisOptions", () => {
+    const cluster = new Cluster([{ port: 7777 }], {
+      redisOptions: { keyPrefix: "prefix:" },
+    });
+    expect(cluster.options).to.have.property("keyPrefix", "prefix:");
+  });
+
   it("throws when scaleReads is invalid", () => {
     expect(() => {
       new Cluster([{}], { scaleReads: "invalid" });