feat: update zscan's options (#12)

* feat: update zscan Signed-off-by: jhpung <[email protected]> * test: add zscan tests Signed-off-by: jhpung <[email protected]> * fix: update script error message Signed-off-by: jhpung <[email protected]> * test(scripting): change expect assertions from .equal to .match Signed-off-by: jhpung <[email protected]> --------- Signed-off-by: jhpung <[email protected]>
valkey-io · Oct 30, 2024 · 9505d6b · 9505d6b
1 parent 128c428
commit 9505d6b
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 6 deletions.
diff --git a/lib/ScanStream.ts b/lib/ScanStream.ts
@@ -4,6 +4,7 @@ interface Options extends ReadableOptions {
   key?: string;
   match?: string;
   type?: string;
+  noscores?: boolean;
   command: string;
   redis: any;
   count?: string | number;
@@ -39,6 +40,9 @@ export default class ScanStream extends Readable {
     if (this.opt.count) {
       args.push("COUNT", String(this.opt.count));
     }
+    if (this.opt.noscores) {
+      args.push("noscores");
+    }
 
     this.opt.redis[this.opt.command](args, (err, res) => {
       if (err) {

diff --git a/lib/types.ts b/lib/types.ts
@@ -30,4 +30,5 @@ export interface ScanStreamOptions {
   match?: string;
   type?: string;
   count?: number;
+  noscores?: boolean;
 }
diff --git a/lib/utils/RedisCommander.ts b/lib/utils/RedisCommander.ts
@@ -13798,32 +13798,94 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
     cursor: number | string,
     callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
   ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
+  zscan(
+    key: RedisKey,
+    cursor: number | string,
+    noscoresToken: "noscores",
+    callback?: Callback<[cursor: string, elements: string[]]>
+  ): Result<[cursor: string, elements: string[]], Context>;
+  zscanBuffer(
+    key: RedisKey,
+    cursor: number | string,
+    noscoresToken: "noscores",
+    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
+  ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
+  zscan(
+    key: RedisKey,
+    cursor: number | string,
+    countToken: "COUNT",
+    count: number | string,
+    callback?: Callback<[cursor: string, elements: string[]]>
+  ): Result<[cursor: string, elements: string[]], Context>;
+  zscanBuffer(
+    key: RedisKey,
+    cursor: number | string,
+    countToken: "COUNT",
+    count: number | string,
+    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
+  ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
   zscan(
     key: RedisKey,
     cursor: number | string,
     countToken: "COUNT",
     count: number | string,
+    noscoresToken: "noscores",
     callback?: Callback<[cursor: string, elements: string[]]>
   ): Result<[cursor: string, elements: string[]], Context>;
   zscanBuffer(
     key: RedisKey,
     cursor: number | string,
     countToken: "COUNT",
     count: number | string,
+    noscoresToken: "noscores",
+    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
+  ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
+  zscan(
+    key: RedisKey,
+    cursor: number | string,
+    patternToken: "MATCH",
+    pattern: string,
+    callback?: Callback<[cursor: string, elements: string[]]>
+  ): Result<[cursor: string, elements: string[]], Context>;
+  zscanBuffer(
+    key: RedisKey,
+    cursor: number | string,
+    patternToken: "MATCH",
+    pattern: string,
+    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
+  ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
+  zscan(
+    key: RedisKey,
+    cursor: number | string,
+    patternToken: "MATCH",
+    pattern: string,
+    noscoresToken: "noscores",
+    callback?: Callback<[cursor: string, elements: string[]]>
+  ): Result<[cursor: string, elements: string[]], Context>;
+  zscanBuffer(
+    key: RedisKey,
+    cursor: number | string,
+    patternToken: "MATCH",
+    pattern: string,
+    noscoresToken: "noscores",
     callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
   ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
   zscan(
     key: RedisKey,
     cursor: number | string,
     patternToken: "MATCH",
     pattern: string,
+    countToken: "COUNT",
+    count: number | string,
     callback?: Callback<[cursor: string, elements: string[]]>
   ): Result<[cursor: string, elements: string[]], Context>;
   zscanBuffer(
     key: RedisKey,
     cursor: number | string,
     patternToken: "MATCH",
     pattern: string,
+    countToken: "COUNT",
+    count: number | string,
     callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
   ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
   zscan(
@@ -13833,6 +13895,7 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
     pattern: string,
     countToken: "COUNT",
     count: number | string,
+    noscoresToken: "noscores",
     callback?: Callback<[cursor: string, elements: string[]]>
   ): Result<[cursor: string, elements: string[]], Context>;
   zscanBuffer(
@@ -13842,6 +13905,7 @@ interface RedisCommander<Context extends ClientContext = { type: "default" }> {
     pattern: string,
     countToken: "COUNT",
     count: number | string,
+    noscoresToken: "noscores",
     callback?: Callback<[cursor: Buffer, elements: Buffer[]]>
   ): Result<[cursor: Buffer, elements: Buffer[]], Context>;
 

diff --git a/test/functional/scripting.ts b/test/functional/scripting.ts
@@ -250,12 +250,8 @@ describe("scripting", () => {
       // @ts-expect-error
       const [a, b] = await redis.multi().test("foo").test("bar").exec();
 
-      expect(a[0].message).to.equal(
-        "NOSCRIPT No matching script. Please use EVAL."
-      );
-      expect(b[0].message).to.equal(
-        "NOSCRIPT No matching script. Please use EVAL."
-      );
+      expect(a[0].message).to.match(/^NOSCRIPT No matching script/);
+      expect(b[0].message).to.match(/^NOSCRIPT No matching script/);
     });
     spy.restore();
     expect(spy.callCount).to.equal(4);

diff --git a/test/unit/commander.ts b/test/unit/commander.ts
@@ -1,6 +1,7 @@
 import * as sinon from "sinon";
 import { expect } from "chai";
 import Commander from "../../lib/utils/Commander";
+import Command from "../../lib/Command";
 
 describe("Commander", () => {
   describe("#getBuiltinCommands()", () => {
@@ -63,4 +64,20 @@ describe("Commander", () => {
 
     Commander.prototype.sendCommand.restore();
   });
+
+  describe("#zscan", () => {
+    it("should pass noscores option", async (done) => {
+      const args: any[] = ["key", "0", "MATCH", "pattern", "COUNT", "10", "noscores"];
+      sinon.stub(Commander.prototype, "sendCommand").callsFake((command) => {
+        if(command.args.every((arg, index) => arg === args[index])) {
+          return done();
+        }
+        return done(new Error(`args should be ${args.join(", ")}`));
+      });
+      const c = new Commander();
+
+      await c.zscan(args[0], args[1], args[2], args[3], args[4], args[5], args[6]);
+      (Commander.prototype.sendCommand as any).restore();
+    });
+  });
 });