tweak unstable search module flag name + add proper error message

Author: sjpotter

packages/client/lib/RESP/types.ts

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

packages/client/lib/cluster/index.ts

@@ -66,7 +66,7 @@ export interface RedisClusterOptions<
   /**
    * TODO
    */
-  unstableResp3Modules?: boolean;
+  unstableResp3SearchModule?: boolean;
 }
 
 // remove once request & response policies are ready

packages/client/lib/commander.ts

@@ -16,8 +16,8 @@ interface AttachConfigOptions<
 }
 
 /* FIXME: better error message / link */
-function throwResp3ModuleUnstableError() {
-  throw new Error("unstable resp3 module, client not configured with proper flag");
+function throwResp3SearchModuleUnstableError() {
+  throw new Error('Some RESP3 results for Redis Query Engine responses may change. Refer to the readme for guidance');
 }
 
 export function attachConfig<
@@ -45,8 +45,8 @@ 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.unstableResp3Module && !config.unstableResp3Modules) {
-          fns[name] = throwResp3ModuleUnstableError;
+        if (config.RESP == 3 && command.unstableResp3SearchModule && !config.unstableResp3SearchModule) {
+          fns[name] = throwResp3SearchModuleUnstableError;
         } else {
           fns[name] = createModuleCommand(command, RESP);
         }

packages/client/lib/sentinel/multi-commands.ts

@@ -2,7 +2,7 @@ import COMMANDS from '../commands';
 import RedisMultiCommand, { MULTI_REPLY, MultiReply, MultiReplyType } from '../multi-command';
 import { ReplyWithTypeMapping, CommandReply, Command, CommandArguments, CommanderConfig, RedisFunctions, RedisModules, RedisScripts, RespVersions, TransformReply, RedisScript, RedisFunction, TypeMapping } from '../RESP/types';
 import { attachConfig, functionArgumentsPrefix, getTransformReply } from '../commander';
-import { RedisSentinelOptions, RedisSentinelType } from './types';
+import { RedisSentinelType } from './types';
 
 type CommandSignature<
   REPLIES extends Array<unknown>,
@@ -100,9 +100,6 @@ export default class RedisSentinelMultiCommand<REPLIES = []> {
   private static _createModuleCommand(command: Command, resp: RespVersions) {
     const transformReply = getTransformReply(command, resp);
     return function (this: { _self: RedisSentinelMultiCommand }, ...args: Array<unknown>) {
-      if (command.unstableResp3Module && resp == 3 && !this._self.#options?.unstableResp3Modules) {
-        throw new Error("unstable resp3 module, client not configured with proper flag");
-      }
       const redisArgs = command.transformArguments(...args);
       return this._self.addCommand(
         command.IS_READ_ONLY,
@@ -163,11 +160,9 @@ export default class RedisSentinelMultiCommand<REPLIES = []> {
   private readonly _multi = new RedisMultiCommand();
   private readonly _sentinel: RedisSentinelType
   private _isReadonly: boolean | undefined = true;
-  readonly #options?: RedisSentinelOptions;
 
-  constructor(sentinel: RedisSentinelType, options?: RedisSentinelOptions) {
+  constructor(sentinel: RedisSentinelType) {
     this._sentinel = sentinel;
-    this.#options = options;
   }
 
   private _setState(

packages/client/lib/sentinel/types.ts

@@ -62,7 +62,7 @@ export interface RedisSentinelOptions<
   /**
    * TODO
    */
-  unstableResp3Modules?: boolean;
+  unstableResp3SearchModule?: boolean;
 }
 
 export interface SentinelCommander<

packages/search/lib/commands/AGGREGATE.ts

@@ -159,7 +159,7 @@ export default {
     },
     3: undefined as unknown as () => ReplyUnion
   },
-  unstableResp3Module: true
+  unstableResp3SearchModule: 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
   },
-  unstableResp3Module: true
+  unstableResp3SearchModule: true
 } as const satisfies Command;
 

packages/search/lib/commands/CURSOR_READ.ts

@@ -18,5 +18,5 @@ export default {
     return args;
   },
   transformReply: AGGREGATE_WITHCURSOR.transformReply,
-  unstableResp3Module: true
+  unstableResp3SearchModule: 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
   },
-  unstableResp3Module: true
+  unstableResp3SearchModule: 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
     },
-    unstableResp3Module: true
+    unstableResp3SearchModule: true
   } as const satisfies Command;
 
   type ProfileAggeregateRawReply = ProfileRawReply<AggregateRawReply>;