feat: exclude some commands from auto pipeline

CahidArda · CahidArda · commit deb999c8b1df · 2025-04-30T15:07:50.000+01:00
excluded some commands that may take a long time from the auto pipeline
diff --git a/pkg/auto-pipeline.test.ts b/pkg/auto-pipeline.test.ts
@@ -162,7 +162,8 @@ describe("Auto pipeline", () => {
     ]);
     expect(result).toBeTruthy();
     expect(result.length).toBe(134); // returns
-    // @ts-expect-error pipelineCounter is not in type but accessible120 results
+
+    // @ts-expect-error pipelineCounter is not in type but accessible results
     expect(redis.pipelineCounter).toBe(1);
   });
 
@@ -376,4 +377,33 @@ describe("Auto pipeline", () => {
     const result = await redis.get("foobar");
     expect(result).toBe("foobar");
   });
+
+  describe("excluded commands", () => {
+    test("should not exclude set", async () => {
+      const redis = Redis.fromEnv();
+      // @ts-expect-error pipelineCounter is not in type but accessible
+      expect(redis.pipelineCounter).toBe(0);
+
+      await redis.set("foo", "bar");
+
+      // @ts-expect-error pipelineCounter is not in type but accessible
+      expect(redis.pipelineCounter).toBe(1);
+    });
+
+    test("should exclude some commands", async () => {
+      const redis = Redis.fromEnv({});
+
+      // @ts-expect-error pipelineCounter is not in type but accessible
+      expect(redis.pipelineCounter).toBe(0);
+
+      await redis.scan(0, { count: 1 });
+      await redis.keys("some-random-pattern");
+      await redis.flushdb();
+      await redis.flushall();
+      await redis.dbsize();
+
+      // @ts-expect-error pipelineCounter is not in type but accessible
+      expect(redis.pipelineCounter).toBe(0);
+    });
+  });
 });
diff --git a/pkg/auto-pipeline.ts b/pkg/auto-pipeline.ts
@@ -8,6 +8,14 @@ import type { CommandArgs } from "./types";
 // properties which are only available in redis
 type redisOnly = Exclude<keyof Redis, keyof Pipeline>;
 
+export const EXCLUDE_COMMANDS: Set<keyof Redis> = new Set([
+  "scan",
+  "keys",
+  "flushdb",
+  "flushall",
+  "dbsize",
+]);
+
 export function createAutoPipelineProxy(_redis: Redis, json?: boolean): Redis {
   const redis = _redis as Redis & {
     autoPipelineExecutor: AutoPipelineExecutor;
@@ -30,8 +38,9 @@ export function createAutoPipelineProxy(_redis: Redis, json?: boolean): Redis {
 
       const commandInRedisButNotPipeline =
         command in redis && !(command in redis.autoPipelineExecutor.pipeline);
+      const isCommandExcluded = EXCLUDE_COMMANDS.has(command as keyof Redis);
 
-      if (commandInRedisButNotPipeline) {
+      if (commandInRedisButNotPipeline || isCommandExcluded) {
         return redis[command as redisOnly];
       }
 
