Merge remote-tracking branch 'upstream/master'

Author: watersRand

.github/workflows/tests.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version: ["18", "20", "22"]
-        redis-version: ["rs-7.4.0-v1", "8.0.2", "8.2"]
+        redis-version: ["rs-7.4.0-v1", "8.0.2", "8.2", "8.2.1-pre"]
     steps:
       - uses: actions/checkout@v4
         with:

README.md

@@ -143,6 +143,8 @@ await client.sendCommand(["SET", "key", "value", "NX"]); // 'OK'
 await client.sendCommand(["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']
 ```
 
+_Note: the [API is different when using a cluster](https://github.com/redis/node-redis/blob/master/docs/clustering.md#unsupported-redis-commands)._
+
 ### Transactions (Multi/Exec)
 
 Start a [transaction](https://redis.io/topics/transactions) by calling `.multi()`, then chaining your commands. When
@@ -196,9 +198,8 @@ See the [Pub/Sub overview](https://github.com/redis/node-redis/blob/master/docs/
 using [async iterators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator):
 
 ```typescript
-for await (const key of client.scanIterator()) {
-  // use the key!
-  await client.get(key);
+for await (const keys of client.scanIterator()) {
+  console.log(keys, await client.mGet(keys));
 }
 ```
 

docs/clustering.md

@@ -38,6 +38,25 @@ await cluster.close();
 | scripts                |         | Script definitions (see [Lua Scripts](./programmability.md#lua-scripts))                                                                                                                                                                                                                                                    |
 | functions              |         | Function definitions (see [Functions](./programmability.md#functions))                                                                                                                                                                                                                                                      |
 
+## Usage
+
+Most redis commands are the same as with individual clients.
+
+### Unsupported Redis Commands
+
+If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`.
+
+When clustering, `sendCommand` takes 3 arguments to help with routing to the correct redis node:
+* `firstKey`: the key that is being operated on, or `undefined` to route to a random node.
+* `isReadOnly`: determines if the command needs to go to the master or may go to a replica.
+*  `args`: the command and all arguments (including the key), as an array of strings.
+
+```javascript
+await cluster.sendCommand("key", false, ["SET", "key", "value", "NX"]); // 'OK'
+
+await cluster.sendCommand("key", true, ["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']
+```
+
 ## Auth with password and username
 
 Specifying the password in the URL or a root node will only affect the connection to that specific node. In case you want to set the password for all the connections being created from a cluster instance, use the `defaults` option.
@@ -114,3 +133,4 @@ Admin commands such as `MEMORY STATS`, `FLUSHALL`, etc. are not attached to the
 ### "Forwarded Commands"
 
 Certain commands (e.g. `PUBLISH`) are forwarded to other cluster nodes by the Redis server. The client sends these commands to a random node in order to spread the load across the cluster.
+

package-lock.json

@@ -4,7 +4,7 @@ import RedisBloomModules from '.';
 export default  TestUtils.createFromConfig({
   dockerImageName: 'redislabs/client-libs-test',
   dockerImageVersionArgument: 'redis-version',
-  defaultDockerVersion: '8.2'
+  defaultDockerVersion: '8.2.1-pre'
 });
 
 export const GLOBAL = {

packages/bloom/lib/test-utils.ts

@@ -1,6 +1,6 @@
 {
   "name": "@redis/bloom",
-  "version": "5.8.1",
+  "version": "5.8.2",
   "license": "MIT",
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/index.d.ts",
@@ -13,7 +13,7 @@
     "release": "release-it"
   },
   "peerDependencies": {
-    "@redis/client": "^5.8.1"
+    "@redis/client": "^5.8.2"
   },
   "devDependencies": {
     "@redis/test-utils": "*"

packages/bloom/package.json

@@ -146,14 +146,14 @@ export interface RedisClientOptions<
   clientInfoTag?: string;
 }
 
-type WithCommands<
+export type WithCommands<
   RESP extends RespVersions,
   TYPE_MAPPING extends TypeMapping
 > = {
     [P in keyof typeof COMMANDS]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>;
   };
 
-type WithModules<
+export type WithModules<
   M extends RedisModules,
   RESP extends RespVersions,
   TYPE_MAPPING extends TypeMapping
@@ -163,7 +163,7 @@ type WithModules<
     };
   };
 
-type WithFunctions<
+export type WithFunctions<
   F extends RedisFunctions,
   RESP extends RespVersions,
   TYPE_MAPPING extends TypeMapping
@@ -173,7 +173,7 @@ type WithFunctions<
     };
   };
 
-type WithScripts<
+export type WithScripts<
   S extends RedisScripts,
   RESP extends RespVersions,
   TYPE_MAPPING extends TypeMapping
@@ -498,7 +498,7 @@ export default class RedisClient<
 
     if (options?.url) {
       const parsedOptions = RedisClient.parseOptions(options);
-    
+
       if (parsedOptions?.database) {
         this._self.#selectedDB = parsedOptions.database;
       }

packages/client/lib/client/index.ts

@@ -1,6 +1,6 @@
 import { RedisClientOptions, RedisClientType } from '../client';
 import { CommandOptions } from '../client/commands-queue';
-import { Command, CommandArguments, CommanderConfig, CommandSignature, /*CommandPolicies, CommandWithPoliciesSignature,*/ TypeMapping, RedisArgument, RedisFunction, RedisFunctions, RedisModules, RedisScript, RedisScripts, ReplyUnion, RespVersions } from '../RESP/types';
+import { Command, CommandArguments, CommanderConfig, TypeMapping, RedisArgument, RedisFunction, RedisFunctions, RedisModules, RedisScript, RedisScripts, ReplyUnion, RespVersions } from '../RESP/types';
 import COMMANDS from '../commands';
 import { EventEmitter } from 'node:events';
 import { attachConfig, functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander';
@@ -13,6 +13,8 @@ import { ClientSideCacheConfig, PooledClientSideCacheProvider } from '../client/
 import { BasicCommandParser } from '../client/parser';
 import { ASKING_CMD } from '../commands/ASKING';
 import SingleEntryCache from '../single-entry-cache'
+import { WithCommands, WithFunctions, WithModules, WithScripts } from '../client';
+
 interface ClusterCommander<
   M extends RedisModules,
   F extends RedisFunctions,
@@ -103,50 +105,6 @@ export interface RedisClusterOptions<
   clientSideCache?: PooledClientSideCacheProvider | ClientSideCacheConfig;
 }
 
-// remove once request & response policies are ready
-type ClusterCommand<
-  NAME extends PropertyKey,
-  COMMAND extends Command
-> = COMMAND['NOT_KEYED_COMMAND'] extends true ? (
-  COMMAND['IS_FORWARD_COMMAND'] extends true ? NAME : never
-) : NAME;
-
-// CommandWithPoliciesSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING, POLICIES>
-type WithCommands<
-  RESP extends RespVersions,
-  TYPE_MAPPING extends TypeMapping
-> = {
-  [P in keyof typeof COMMANDS as ClusterCommand<P, (typeof COMMANDS)[P]>]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>;
-};
-
-type WithModules<
-  M extends RedisModules,
-  RESP extends RespVersions,
-  TYPE_MAPPING extends TypeMapping
-> = {
-  [P in keyof M]: {
-    [C in keyof M[P] as ClusterCommand<C, M[P][C]>]: CommandSignature<M[P][C], RESP, TYPE_MAPPING>;
-  };
-};
-
-type WithFunctions<
-  F extends RedisFunctions,
-  RESP extends RespVersions,
-  TYPE_MAPPING extends TypeMapping
-> = {
-  [L in keyof F]: {
-    [C in keyof F[L] as ClusterCommand<C, F[L][C]>]: CommandSignature<F[L][C], RESP, TYPE_MAPPING>;
-  };
-};
-
-type WithScripts<
-  S extends RedisScripts,
-  RESP extends RespVersions,
-  TYPE_MAPPING extends TypeMapping
-> = {
-  [P in keyof S as ClusterCommand<P, S[P]>]: CommandSignature<S[P], RESP, TYPE_MAPPING>;
-};
-
 export type RedisClusterType<
   M extends RedisModules = {},
   F extends RedisFunctions = {},

packages/client/lib/cluster/index.ts

@@ -18,6 +18,11 @@ describe('XTRIM', () => {
         parseArgs(XTRIM, 'key', 'MINID', 123),
         ['XTRIM', 'key', 'MINID', '123']
       );
+
+      assert.deepEqual(
+        parseArgs(XTRIM, 'key', 'MINID', '0-0'),
+        ['XTRIM', 'key', 'MINID', '0-0']
+      );
     });
 
     it('with strategyModifier', () => {
@@ -89,6 +94,16 @@ describe('XTRIM', () => {
     cluster: GLOBAL.CLUSTERS.OPEN,
   });
 
+  testUtils.testAll('xTrim with string MINID', async client => {
+    assert.equal(
+      typeof await client.xTrim('key', 'MINID', '0-0'),
+      'number'
+    );
+  }, {
+    client: GLOBAL.SERVERS.OPEN,
+    cluster: GLOBAL.CLUSTERS.OPEN,
+  });
+
   testUtils.testAll(
     'xTrim with LIMIT',
     async (client) => {

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

@@ -37,7 +37,7 @@ export default {
     parser: CommandParser,
     key: RedisArgument,
     strategy: 'MAXLEN' | 'MINID',
-    threshold: number,
+    threshold: number | string,
     options?: XTrimOptions
   ) {
     parser.push('XTRIM')