redis-smq-common 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 1.0.3 (2022-08-16)
+
+* [RedisClient] Update tests (6f1fd51)
+* [RedisClient] Make validateRedisVersion() public (c2fccb3)
+* [RedisClient] Support MATCH and COUNT options for sscan (12b24ac)
+* [RedisClient] Fallback to smembers when sscan is not supported (8a4409f)
+* [RedisClient] Test sscan command (17b8279)
+* [RedisClient] Add sscan command (b771873)
+
 ## 1.0.2 (2022-08-10)
 
 * Update LockManager tests (321c8c4)

package/dist/src/redis-client/clients/ioredis-client.d.ts

@@ -17,6 +17,10 @@ export declare class IoredisClient extends RedisClient {
     watch(args: string[], cb: ICallback<string>): void;
     unwatch(cb: ICallback<string>): void;
     sismember(key: string, member: string, cb: ICallback<number>): void;
+    sscan(key: string, options: {
+        MATCH?: string;
+        COUNT?: number;
+    }, cb: ICallback<string[]>): void;
     zcard(key: string, cb: ICallback<number>): void;
     zrange(key: string, min: number, max: number, cb: ICallback<string[]>): void;
     psubscribe(pattern: string): void;

package/dist/src/redis-client/clients/ioredis-client.js

@@ -47,6 +47,28 @@ class IoredisClient extends redis_client_1.RedisClient {
     sismember(key, member, cb) {
         this.client.sismember(key, member, cb);
     }
+    sscan(key, options, cb) {
+        const result = new Set();
+        const iterate = (position) => {
+            const args = [key, position];
+            if (options.MATCH)
+                args.push('MATCH', options.MATCH);
+            if (options.COUNT)
+                args.push('COUNT', String(options.COUNT));
+            this.client.sscan(...args, (err, [cursor, items]) => {
+                if (err)
+                    cb(err);
+                else {
+                    items.forEach((i) => result.add(i));
+                    if (cursor === '0')
+                        cb(null, [...result]);
+                    else
+                        iterate(cursor);
+                }
+            });
+        };
+        iterate('0');
+    }
     zcard(key, cb) {
         this.client.zcard(key, cb);
     }

package/dist/src/redis-client/clients/node-redis-v3-client.d.ts

@@ -17,6 +17,10 @@ export declare class NodeRedisV3Client extends RedisClient {
     watch(args: string[], cb: ICallback<string>): void;
     unwatch(cb: ICallback<string>): void;
     sismember(key: string, member: string, cb: ICallback<number>): void;
+    sscan(key: string, options: {
+        MATCH?: string;
+        COUNT?: number;
+    }, cb: ICallback<string[]>): void;
     zcard(key: string, cb: ICallback<number>): void;
     zrange(key: string, min: number, max: number, cb: ICallback<string[]>): void;
     psubscribe(pattern: string): void;

package/dist/src/redis-client/clients/node-redis-v3-client.js

@@ -74,6 +74,28 @@ class NodeRedisV3Client extends redis_client_1.RedisClient {
     sismember(key, member, cb) {
         this.client.sismember(key, member, cb);
     }
+    sscan(key, options, cb) {
+        const result = new Set();
+        const iterate = (position) => {
+            const args = [key, position];
+            if (options.MATCH)
+                args.push('MATCH', options.MATCH);
+            if (options.COUNT)
+                args.push('COUNT', String(options.COUNT));
+            this.client.sscan(...args, (err, [cursor, items]) => {
+                if (err)
+                    cb(err);
+                else {
+                    items.forEach((i) => result.add(i));
+                    if (cursor === '0')
+                        cb(null, [...result]);
+                    else
+                        iterate(cursor);
+                }
+            });
+        };
+        iterate('0');
+    }
     zcard(key, cb) {
         this.client.zcard(key, cb);
     }

package/dist/src/redis-client/clients/node-redis-v4-client.d.ts

@@ -25,6 +25,10 @@ export declare class NodeRedisV4Client extends RedisClient {
     unsubscribe(channel: string): void;
     zrangebyscore(key: string, min: number | string, max: number | string, cb: ICallback<string[]>): void;
     smembers(key: string, cb: ICallback<string[]>): void;
+    sscan(key: string, options: {
+        MATCH?: string;
+        COUNT?: number;
+    }, cb: ICallback<string[]>): void;
     sadd(key: string, member: string, cb: ICallback<number>): void;
     hgetall(key: string, cb: ICallback<Record<string, string>>): void;
     hget(key: string, field: string, cb: ICallback<string | null>): void;

package/dist/src/redis-client/clients/node-redis-v4-client.js

@@ -94,6 +94,27 @@ class NodeRedisV4Client extends redis_client_1.RedisClient {
             .then((reply) => cb(null, reply))
             .catch(cb);
     }
+    sscan(key, options, cb) {
+        const result = new Set();
+        const iterate = (position) => {
+            const args = [
+                key,
+                position,
+                options,
+            ];
+            this.client
+                .sScan(...args)
+                .then(({ cursor, members }) => {
+                members.forEach((i) => result.add(i));
+                if (cursor === 0)
+                    cb(null, [...result]);
+                else
+                    iterate(cursor);
+            })
+                .catch(cb);
+        };
+        iterate(0);
+    }
     sadd(key, member, cb) {
         this.client
             .sAdd(key, member)

package/dist/src/redis-client/redis-client.d.ts

@@ -12,7 +12,7 @@ export declare abstract class RedisClient extends EventEmitter {
     protected static scriptsLoaded: boolean;
     protected static luaScripts: LuaScripts;
     protected connectionClosed: boolean;
-    protected validateRedisVersion(major: number, feature?: number, minor?: number): boolean;
+    validateRedisVersion(major: number, feature?: number, minor?: number): boolean;
     abstract set(key: string, value: string, options: {
         expire?: {
             mode: 'EX' | 'PX';
@@ -33,6 +33,11 @@ export declare abstract class RedisClient extends EventEmitter {
     abstract unsubscribe(channel: string): void;
     abstract zrangebyscore(key: string, min: number | string, max: number | string, cb: ICallback<string[]>): void;
     abstract smembers(key: string, cb: ICallback<string[]>): void;
+    abstract sscan(key: string, options: {
+        MATCH?: string;
+        COUNT?: number;
+    }, cb: ICallback<string[]>): void;
+    sscanFallback(key: string, cb: ICallback<string[]>): void;
     abstract sadd(key: string, member: string, cb: ICallback<number>): void;
     abstract hgetall(key: string, cb: ICallback<Record<string, string>>): void;
     abstract hget(key: string, field: string, cb: ICallback<string | null>): void;

package/dist/src/redis-client/redis-client.js

@@ -25,6 +25,12 @@ class RedisClient extends events_1.EventEmitter {
                 RedisClient.redisServerVersion[1] >= feature &&
                 RedisClient.redisServerVersion[2] >= minor));
     }
+    sscanFallback(key, cb) {
+        if (this.validateRedisVersion(2, 8))
+            this.sscan(key, {}, cb);
+        else
+            this.smembers(key, cb);
+    }
     zpophgetrpush(source, sourceHash, destination, cb) {
         this.runScript(ELuaScriptName.ZPOPHGETRPUSH, [source, sourceHash, destination], [], (err, res) => {
             if (err)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-common",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "RedisSMQ shared components that may be used by integrated applications and extensions.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",