rename unstableResp3SearchModule cofnig + xread/group support

Author: sjpotter

packages/client/lib/RESP/types.ts

@@ -283,7 +283,7 @@ export type Command = {
   transformArguments(this: void, ...args: Array<any>): CommandArguments;
   TRANSFORM_LEGACY_REPLY?: boolean;
   transformReply: TransformReply | Record<RespVersions, TransformReply>;
-  unstableResp3SearchModule?: boolean;
+  unstableResp3?: boolean;
 };
 
 export type RedisCommands = Record<string, Command>;
@@ -317,7 +317,7 @@ export interface CommanderConfig<
   /**
    * TODO
    */
-  unstableResp3SearchModule?: boolean;
+  unstableResp3?: boolean;
 }
 
 type Resp2Array<T> = (

packages/client/lib/cluster/index.ts

@@ -63,10 +63,6 @@ export interface RedisClusterOptions<
    * Useful when the cluster is running on another network
    */
   nodeAddressMap?: NodeAddressMap;
-  /**
-   * TODO
-   */
-  unstableResp3SearchModule?: boolean;
 }
 
 // remove once request & response policies are ready

packages/client/lib/commander.ts

@@ -45,7 +45,7 @@ export function attachConfig<
     for (const [moduleName, module] of Object.entries(config.modules)) {
       const fns = Object.create(null);
       for (const [name, command] of Object.entries(module)) {
-        if (config.RESP == 3 && command.unstableResp3SearchModule && !config.unstableResp3SearchModule) {
+        if (config.RESP == 3 && command.unstableResp3 && !config.unstableResp3) {
           fns[name] = throwResp3SearchModuleUnstableError;
         } else {
           fns[name] = createModuleCommand(command, RESP);

packages/client/lib/commands/XREAD.spec.ts

@@ -101,6 +101,14 @@ describe('XREAD', () => {
       }),
     ])
 
+    const arr = ['key', [{
+      'id': id,
+      'message': [
+        'field',
+        'value',
+      ]
+    }]];
+
     const obj = Object.assign(Object.create(null), {
       'key': [{
         id: id,
@@ -114,7 +122,7 @@ describe('XREAD', () => {
       }]
     });
 
-    assert.deepStrictEqual(reply, obj);
+    assert.deepStrictEqual(reply, arr);
   }, {
     client: GLOBAL.SERVERS.OPEN,
     cluster: GLOBAL.CLUSTERS.OPEN

packages/client/lib/commands/XREAD.ts

@@ -1,5 +1,5 @@
-import { Command, RedisArgument } from '../RESP/types';
-import { transformStreamsMessagesReplyResp2, transformStreamsMessagesReplyResp3 } from './generic-transformers';
+import { Command, RedisArgument, ReplyUnion } from '../RESP/types';
+import { transformStreamsMessagesReplyResp2 } from './generic-transformers';
 
 export interface XReadStream {
   key: RedisArgument;
@@ -51,7 +51,8 @@ export default {
   },
   transformReply: {
     2: transformStreamsMessagesReplyResp2,
-    3: transformStreamsMessagesReplyResp3
-  }
+    3: undefined as unknown as () => ReplyUnion
+  },
+  unstableResp3: true
 } as const satisfies Command;
 

packages/client/lib/commands/XREADGROUP.spec.ts

@@ -123,6 +123,14 @@ describe('XREADGROUP', () => {
       })
     ]);
 
+    const arr = ['key', [{
+      'id': id,
+      'message': [
+        'field',
+        'value',
+      ]
+    }]];    
+
     const obj = Object.assign(Object.create(null), {
       'key': [{
         id: id,
@@ -136,7 +144,7 @@ describe('XREADGROUP', () => {
       }]
     });
 
-    assert.deepStrictEqual(readGroupReply, obj);
+    assert.deepStrictEqual(readGroupReply, arr);
   }, {
     client: GLOBAL.SERVERS.OPEN,
     cluster: GLOBAL.CLUSTERS.OPEN

packages/client/lib/commands/XREADGROUP.ts

@@ -1,5 +1,5 @@
-import { Command, RedisArgument } from '../RESP/types';
-import { transformStreamsMessagesReplyResp2, transformStreamsMessagesReplyResp3 } from './generic-transformers';
+import { Command, RedisArgument, ReplyUnion } from '../RESP/types';
+import { transformStreamsMessagesReplyResp2 } from './generic-transformers';
 import XREAD, { XReadStreams, pushXReadStreams } from './XREAD';
 
 export interface XReadGroupOptions {
@@ -43,6 +43,7 @@ export default {
   },
   transformReply: {
     2: transformStreamsMessagesReplyResp2,
-    3: transformStreamsMessagesReplyResp3
-  }
+    3: undefined as unknown as () => ReplyUnion
+  },
+  unstableResp3: true,
 } as const satisfies Command;

packages/client/lib/commands/generic-transformers.ts

@@ -534,6 +534,7 @@ export function transformStreamsMessagesReplyResp2(
   if (reply === null) return null as unknown as NullReply;
 
   switch (typeMapping? typeMapping[RESP_TYPES.MAP] : undefined) {
+/*    
     case Map: {
       const ret = new Map<string, StreamMessagesReply>();
 
@@ -548,6 +549,14 @@ export function transformStreamsMessagesReplyResp2(
     
       return ret as unknown as MapReply<string, StreamMessagesReply>;
     }
+*/
+    /* work around for now */
+    default:
+      if (!typeMapping) {
+        typeMapping = {};
+      }
+      // console.log("forcing map type map to array");
+      // typeMapping[RESP_TYPES.MAP] = Array;
     case Array: {
       const ret: Array<BlobStringReply | StreamMessagesReply> = [];
 
@@ -558,11 +567,12 @@ export function transformStreamsMessagesReplyResp2(
         const rawMessages = stream[1];
 
         ret.push(name); 
-        ret.push(transformStreamMessagesReply(rawMessages));
+        ret.push(transformStreamMessagesReply(rawMessages, typeMapping));
       }
 
       return ret as unknown as MapReply<string, StreamMessagesReply>;
     }
+/*    
     default: {
       const ret: Record<string, StreamMessagesReply> = Object.create(null);
 
@@ -577,6 +587,7 @@ export function transformStreamsMessagesReplyResp2(
     
       return ret as unknown as MapReply<string, StreamMessagesReply>;
     }
+*/
   }
 }
 

packages/client/lib/sentinel/types.ts

@@ -59,10 +59,6 @@ export interface RedisSentinelOptions<
    * When `false`, the sentinel object will wait for the first available client from the pool.
    */
   reserveClient?: boolean;
-  /**
-   * TODO
-   */
-  unstableResp3SearchModule?: boolean;
 }
 
 export interface SentinelCommander<

packages/search/lib/commands/AGGREGATE.ts

@@ -159,7 +159,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 export function pushAggregateOptions(args: Array<RedisArgument>, options?: FtAggregateOptions) {

packages/search/lib/commands/AGGREGATE_WITHCURSOR.ts

@@ -42,6 +42,6 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 

packages/search/lib/commands/CURSOR_READ.ts

@@ -18,5 +18,5 @@ export default {
     return args;
   },
   transformReply: AGGREGATE_WITHCURSOR.transformReply,
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;

packages/search/lib/commands/INFO.ts

@@ -12,7 +12,7 @@ export default {
     2: transformV2Reply,
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 type InfoRawReply = [

packages/search/lib/commands/PROFILE_AGGREGATE.ts

@@ -32,7 +32,7 @@ export default {
       },
       3: undefined as unknown as () => ReplyUnion
     },
-    unstableResp3SearchModule: true
+    unstableResp3: true
   } as const satisfies Command;
 
   type ProfileAggeregateRawReply = ProfileRawReply<AggregateRawReply>;

packages/search/lib/commands/PROFILE_SEARCH.ts

@@ -53,7 +53,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 export interface ProfileReply {

packages/search/lib/commands/SEARCH.ts

@@ -182,7 +182,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 export type SearchRawReply = Array<any>;

packages/search/lib/commands/SEARCH_NOCONTENT.ts

@@ -18,7 +18,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 export interface SearchNoContentReply {

packages/search/lib/commands/SPELLCHECK.ts

@@ -49,7 +49,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion,
   },
-  unstableResp3SearchModule: true
+  unstableResp3: true
 } as const satisfies Command;
 
 type SpellCheckRawReply = Array<[