From 5e067d6111c082ad6a1589fd60bc84c67c1e7199 Mon Sep 17 00:00:00 2001
From: Tyson Andre <tysonandre775@hotmail.com>
Date: Wed, 28 Jul 2021 12:34:42 -0400
Subject: [PATCH] fix(cluster): autopipeline when keyPrefix is used

Previously the building of pipelines ignored the key prefix.
It was possible that two keys, foo and bar, might be set into
the same pipeline. However, after being prefixed by a configured
"keyPrefix" value, they may no longer belong to the same
pipeline.

This led to the error:
"All keys in the pipeline should belong to the same slots
allocation group"

Amended version of https://github.com/luin/ioredis/pull/1335/files - see comments on that PR

This may fix #1264 and #1248.
---
 lib/autoPipelining.ts                     | 12 ++++-
 test/functional/cluster/autopipelining.ts | 58 +++++++++++++++++++----
 2 files changed, 60 insertions(+), 10 deletions(-)

diff --git a/lib/autoPipelining.ts b/lib/autoPipelining.ts
index 238fe1149..7c8cfbdaf 100644
--- a/lib/autoPipelining.ts
+++ b/lib/autoPipelining.ts
@@ -1,4 +1,5 @@
 import * as PromiseContainer from "./promiseContainer";
+import { flatten } from "./utils/lodash";
 import * as calculateSlot from "cluster-key-slot";
 import asCallback from "standard-as-callback";
 
@@ -78,7 +79,7 @@ export function executeWithAutoPipelining(
   client,
   functionName: string,
   commandName: string,
-  args: string[],
+  args: (string | string[])[],
   callback
 ) {
   const CustomPromise = PromiseContainer.get();
@@ -104,7 +105,14 @@ export function executeWithAutoPipelining(
   }
 
   // If we have slot information, we can improve routing by grouping slots served by the same subset of nodes
-  const slotKey = client.isCluster ? client.slots[calculateSlot(args[0])].join(",") : 'main';
+  // Note that the first value in args may be a (possibly empty) array.
+  // ioredis will only flatten one level of the array, in the Command constructor.
+  const prefix = client.options.keyPrefix || "";
+  const slotKey = client.isCluster
+    ? client.slots[
+        calculateSlot(`${client.options.keyPrefix}${flatten(args)[0]}`)
+      ].join(",")
+    : "main";
 
   if (!client._autoPipelines.has(slotKey)) {
     const pipeline = client.pipeline();
diff --git a/test/functional/cluster/autopipelining.ts b/test/functional/cluster/autopipelining.ts
index 02f933d64..82ac77add 100644
--- a/test/functional/cluster/autopipelining.ts
+++ b/test/functional/cluster/autopipelining.ts
@@ -35,6 +35,10 @@ describe("autoPipelining for cluster", function () {
       if (argv[0] === "get" && argv[1] === "foo6") {
         return "bar6";
       }
+
+      if (argv[0] === "get" && argv[1] === "baz:foo10") {
+        return "bar10";
+      }
     });
 
     new MockServer(30002, function (argv) {
@@ -68,6 +72,10 @@ describe("autoPipelining for cluster", function () {
         return "bar5";
       }
 
+      if (argv[0] === "get" && argv[1] === "baz:foo1") {
+        return "bar1";
+      }
+
       if (argv[0] === "evalsha") {
         return argv.slice(argv.length - 4);
       }
@@ -177,6 +185,40 @@ describe("autoPipelining for cluster", function () {
     cluster.disconnect();
   });
 
+  it("should support building pipelines when a prefix is used", async () => {
+    const cluster = new Cluster(hosts, {
+      enableAutoPipelining: true,
+      keyPrefix: "baz:",
+    });
+    await new Promise((resolve) => cluster.once("connect", resolve));
+
+    await cluster.set("foo1", "bar1");
+    await cluster.set("foo10", "bar10");
+
+    expect(
+      await Promise.all([cluster.get("foo1"), cluster.get("foo10")])
+    ).to.eql(["bar1", "bar10"]);
+
+    cluster.disconnect();
+  });
+
+  it("should support building pipelines when a prefix is used with arrays to flatten", async () => {
+    const cluster = new Cluster(hosts, {
+      enableAutoPipelining: true,
+      keyPrefix: "baz:",
+    });
+    await new Promise((resolve) => cluster.once("connect", resolve));
+
+    await cluster.set(["foo1"], "bar1");
+    await cluster.set(["foo10"], "bar10");
+
+    expect(
+      await Promise.all([cluster.get(["foo1"]), cluster.get(["foo10"])])
+    ).to.eql(["bar1", "bar10"]);
+
+    cluster.disconnect();
+  });
+
   it("should support commands queued after a pipeline is already queued for execution", (done) => {
     const cluster = new Cluster(hosts, { enableAutoPipelining: true });
 
@@ -407,9 +449,9 @@ describe("autoPipelining for cluster", function () {
     const promise4 = cluster.set("foo6", "bar");
 
     // Override slots to induce a failure
-    const key1Slot = calculateKeySlot('foo1');
-    const key2Slot = calculateKeySlot('foo2');
-    const key5Slot = calculateKeySlot('foo5');
+    const key1Slot = calculateKeySlot("foo1");
+    const key2Slot = calculateKeySlot("foo2");
+    const key5Slot = calculateKeySlot("foo5");
 
     changeSlot(cluster, key1Slot, key2Slot);
     changeSlot(cluster, key2Slot, key5Slot);
@@ -498,9 +540,9 @@ describe("autoPipelining for cluster", function () {
       expect(cluster.autoPipelineQueueSize).to.eql(4);
 
       // Override slots to induce a failure
-      const key1Slot = calculateKeySlot('foo1');
-      const key2Slot = calculateKeySlot('foo2');
-      const key5Slot = calculateKeySlot('foo5');
+      const key1Slot = calculateKeySlot("foo1");
+      const key2Slot = calculateKeySlot("foo2");
+      const key5Slot = calculateKeySlot("foo5");
       changeSlot(cluster, key1Slot, key2Slot);
       changeSlot(cluster, key2Slot, key5Slot);
     });
@@ -547,8 +589,8 @@ describe("autoPipelining for cluster", function () {
 
       expect(cluster.autoPipelineQueueSize).to.eql(3);
 
-      const key1Slot = calculateKeySlot('foo1');
-      const key2Slot = calculateKeySlot('foo2');
+      const key1Slot = calculateKeySlot("foo1");
+      const key2Slot = calculateKeySlot("foo2");
       changeSlot(cluster, key1Slot, key2Slot);
     });
   });