v4.0.0-rc.4 (#1723)

* update workflows & README

* add .deepsource.toml

* fix client.quit, add error events on cluster, fix some "deepsource.io" warnings

* Release 4.0.0-rc.1

* add cluster.duplicate, add some tests

* fix #1650 - add support for Buffer in some commands, add GET_BUFFER command

* fix GET and GET_BUFFER return type

* update FAQ

* Update invalid code example in README.md (#1654)

* Update invalid code example in README.md

* Update README.md

Co-authored-by: Leibale Eidelman <leibale1998@gmail.com>

* fix #1652

* ref #1653 - better types

* better types

* fix 54124793ad

* Update GEOSEARCHSTORE.spec.ts

* fix #1660 - add support for client.HSET('key', 'field', 'value')

* upgrade dependencies, update README

* fix #1659 - add support for db-number in client options url

* fix README, remove unused import, downgrade typedoc & typedoc-plugin-markdown

* update client-configurations.md

* fix README

* add CLUSTER_SLOTS, add some tests

* fix "createClient with url" test with redis 5

* remove unused imports

* Release 4.0.0-rc.2

* add missing semicolon

* replace empty "transformReply" functions with typescript "declare"

* fix EVAL & EVALSHA, add some tests, npm update

* fix #1665 - add ZRANGEBYLEX, ZRANGEBYSCORE, ZRANGEBYSCORE_WITHSCORES

* new issue templates

* add all COMMAND commands

* run COMMAND & COMMAND INFO tests only on redis >6

* Create SECURITY.md

* fix #1671 - add support for all client configurations in cluster

* ref #1671 - add support for defaults

* remove some commands from cluster, npm update, clean code,

* lock benny version

* fix #1674 - remove `isolationPoolOptions` when creating isolated connection

* increase test coverage

* update .npmignore

* Release 4.0.0-rc.3

* fix README

* remove whitespace from LICENSE

* use "export { x as y }" instead of import & const

* move from "NodeRedis" to "Redis"

* fix #1676

* update comments

* Auth before select database (#1679)

* Auth before select database

* fix #1681

Co-authored-by: leibale <leibale1998@gmail.com>

* Adds connect-as-acl-user example. (#1684)

* Adds connect-as-acl-user example.

* Adds blank line at end.

* Set to private.

* Adds examples folder to npmignore.

* Adds Apple .DS_Store file to .gitignore (#1685)

* Adds Apple .DS_Store file.

* Add .DS_Store to .npmignore too

Co-authored-by: Leibale Eidelman <leibale1998@gmail.com>

* move examples

* clean some tests

* clean code

* Adds examples table of contents and contribution guidelines. (#1686)

* Updated examples to use named functions. (#1687)

* Updated examples to user named functions.

* Update README.md

Co-authored-by: Leibale Eidelman <leibale1998@gmail.com>

* update docs, add 6.0.x to the tests matrix, add eslint, npm update, fix some commands, fix some types

Co-authored-by: Simon Prickett <simon@crudworks.org>

* fix tests with redis 6.0.x

* fix ACL GETUSER test

* fix client.quit and client.disconnect

* fix ACL GETUSER

* Adds TypeScript note and corrects a typo.

* Fixes a bug in the Scan Iterator section. (#1694)

* Made examples use local version.

* Add `lua-multi-incr.js` example (#1692)

Also fix syntax error in the lua example in the README

Closes #1689.

* Add(examples): Create an example for blPop & lPush (#1696)

* Add(examples): Create an example for blPop & lPush

Signed-off-by: Aditya Rastogi <adit.rastogi2014@gmail.com>

* Update(examples): fix case, add timeout, update readme

Signed-off-by: Aditya Rastogi <adit.rastogi2014@gmail.com>

Closes #1693.

* Add command-with-modifiers.js example (#1695)

* Adds TypeScript note and corrects a typo.

* Adds command-with-modifiers example. (redis#1688)

* Adds command-with-modifiers example. (redis#1688)

* Adds command-with-modifiers example. (redis#1688)

* Removed callbacks.

Co-authored-by: Simon Prickett <simon@redislabs.com>

Closes #1688.

* Issue # 1697 FIX - creates an example script that shows how to use the SSCAN iterator (#1699)

* #1697 fix for set scan example

* adds the js file

* adds comment

* Minor layout and comment adjustment.

Co-authored-by: srawat2 <shashank19aug>
Co-authored-by: Simon Prickett <simon@redislabs.com>

Closes #1697.

* fix #1706 - HSET return type should be number

* use dockers for tests, fix some bugs

* increase dockers timeout to 30s

* release drafter (#1683)

* release drafter

* fixing contributors

* use dockers for tests, use npm workspaces, add rejson & redisearch modules, fix some bugs

* fix #1712 - fix LINDEX return type

* uncomment TIME tests

* use codecov

* fix tests.yml

* uncomment "should handle live resharding" test

* fix #1714 - update README(s)

* add package-lock.json

* update CONTRIBUTING.md

* update examples

* uncomment some tests

* fix test-utils

* move "all-in-one" to root folder

* fix tests workflow

* fix bug in cluster slots, enhance live resharding test

* fix live resharding test

* fix #1707 - handle number arguments in legacy mode

* Add rejectedUnauthorized and other TLS options (#1708)

* Update socket.ts

* fix #1716 - decode username and password from url

* fix some Z (sorted list) commands, increase commands test coverage

* remove empty lines

* fix 'Scenario' typo (#1720)

* update readmes, add createCluster to the `redis` package

* add .release-it.json files, update some md files

* run tests on pull requests too

* Support esModuleInterop set to false. (#1717)

* Support esModuleInterop set to false.

When testing the upcoming 4.x release, we got a bunch of typescript
errors emitted from this project.

We quickly realized this is because the library uses the esModuleInterop
flag. This makes some imports _slightly_ easier to write, but it comes
at a cost: it forces any application or library using this library to
*also* have esModuleInterop on.

The `esModuleInterop` flag is a bit of a holdover from an earlier time,
and I would not recommend using it in libraries. The main issue is that
if it's set to true, you are forcing any users of the library to also
have `esModuleInterop`, where if you keep have it set to `false` (the
default), you leave the decision to the user.

This change should have no rammifications to users with
`esModuleInterop` on, but it will enable support for those that have it
off.

This is especially good for library authors such as myself, because I
would also like to keep this flag off to not force *my* users into this
feature.

* All tests now pass!

* Move @types/redis-parser into client sub-package

and removed a comma

* npm update, remove html from readme

* add tests and licence badges

* update changelog.md

* update .npmignore and .release-it.json

* update .release-it.json

* Release client@1.0.0-rc.0

* revert d32f1edf8a

* fix .npmignore

* replace @redis with @node-redis

* Release client@1.0.0-rc.0

* update json & search version

* Release json@1.0.0-rc.0

* Release search@1.0.0-rc.0

* update dependencies

* Release redis@4.0.0-rc.4

Co-authored-by: Richard Samuelsson <noobtoothfairy@gmail.com>
Co-authored-by: mustard <mhqnwt@gmail.com>
Co-authored-by: Simon Prickett <simon@redislabs.com>
Co-authored-by: Simon Prickett <simon@crudworks.org>
Co-authored-by: Suze Shardlow <SuzeShardlow@users.noreply.github.com>
Co-authored-by: Joshua T <buildingsomethingfun@gmail.com>
Co-authored-by: Aditya Rastogi <adit.rastogi2014@gmail.com>
Co-authored-by: Rohan Kumar <rohan.kr20@gmail.com>
Co-authored-by: Kalki <shashank.kviit@gmail.com>
Co-authored-by: Chayim <chayim@users.noreply.github.com>
Co-authored-by: Da-Jin Chu <dajinchu@gmail.com>
Co-authored-by: Henrique Corrêa <75134774+HeCorr@users.noreply.github.com>
Co-authored-by: Evert Pot <me@evertpot.com>

examples/.gitignore

@@ -0,0 +1 @@
+package-lock.json

examples/README.md

@@ -0,0 +1,76 @@
+# Node Redis: Examples
+
+This folder contains example scripts showing how to use Node Redis in different scenarios.
+
+| File Name                   | Description                                                                        |
+|-----------------------------|------------------------------------------------------------------------------------|
+| `blocking-list-pop.js`      | Block until an element is pushed to a list                                         |
+| `command-with-modifiers.js` | Define a script that allows to run a command with several modifiers                |
+| `connect-as-acl-user.js`    | Connect to Redis 6 using an ACL user                                               |
+| `lua-multi-incr.js`         | Define a custom lua script that allows you to perform INCRBY on multiple keys      |
+| `search+json.js`            | Use [Redis Search](https://redisearch.io/) and [Redis JSON](https://redisjson.io/) |
+| `set-scan.js`               | An example script that shows how to use the SSCAN iterator functionality           |
+
+## Contributing
+
+We'd love to see more examples here. If you have an idea that you'd like to see included here, submit a Pull Request and we'll be sure to review it!  Don't forget to check out our [contributing guide](../CONTRIBUTING.md).
+
+## Setup
+
+To set up the examples folder so that you can run an example / develop one of your own:
+
+```
+$ git clone https://github.com/redis/node-redis.git
+$ cd node-redis
+$ npm install -ws && npm run build
+$ cd examples
+$ npm install
+```
+
+### Coding Guidelines for Examples
+
+When adding a new example, please follow these guidelines:
+
+* Add your code in a single JavaScript or TypeScript file per example, directly in the `examples` folder
+* Do not introduce other dependencies in your example
+* Give your `.js` file a meaningful name using `-` separators e.g. `adding-to-a-stream.js` / `adding-to-a-stream.ts`
+* Indent your code using 2 spaces
+* Use the single line `//` comment style and comment your code
+* Add a comment at the top of your `.js` / `.ts` file describing what your example does
+* Add a comment at the top of your `.js` / `.ts` file describing any Redis commands that need to be run to set up data for your example (try and keep this minimal)
+* Use semicolons
+* Use `async` and `await`
+* Use single quotes, `'hello'` not `"hello"`
+* Place your example code in a single `async` function where possible, named according to the file name e.g. `add-to-stream.js` would contain `const addtoStream = async () => { ... };`, and call this function at the end of the file e.g. `addToStream();`
+* Unless your example requires a connection string, assume Redis is on the default localhost port 6379 with no password
+* Use meaningful example data, let's not use `foo`, `bar`, `baz` etc!
+* Leave an empty line at the end of your `.js` file
+* Update this `README.md` file to add your example to the table
+
+Use [connect-as-acl-user.js](./connect-as-acl-user.js) as a guide to develop a well formatted example script.
+
+### Example Template
+
+Here's a starter template for adding a new example, imagine this is stored in `do-something.js`:
+
+```javascript
+// This comment should describe what the example does
+// and can extend to multiple lines.
+
+// Set up the data in redis-cli using these commands:
+//   <add your command(s) here, one per line>
+
+import { createClient } from 'redis';
+
+async function doSomething() {
+    const client = createClient();
+
+    await client.connect();
+
+    // Add your example code here...
+
+    await client.quit();
+}
+
+doSomething();
+```

examples/blocking-list-pop.js

@@ -0,0 +1,32 @@
+// This example shows how to use the blocking LPUSH command.
+
+// This code shows how to run with isolation the blPop Command to block the script while waiting for a value to be pushed to the list.
+// The script will be blocked until the LPUSH command is executed.
+// After which we log the list and quit the client.
+
+import { createClient, commandOptions } from 'redis';
+
+async function blockingListPop() {
+	const client = createClient();
+
+	await client.connect();
+
+	const keyName = 'keyName';
+
+	const blpopPromise = client.blPop(
+		commandOptions({ isolated: true }),
+		keyName,
+		0
+	);
+
+	await client.lPush(keyName, 'value');
+
+	await blpopPromise;
+
+	console.log('blpopPromise resolved');
+	console.log(keyName);
+
+	await client.quit();
+}
+
+blockingListPop();

examples/command-with-modifiers.js

@@ -0,0 +1,31 @@
+// Define a custom script that shows example of SET command
+// with several modifiers.
+
+import { createClient } from 'redis';
+
+async function commandWithModifiers() {
+  const client = createClient();
+
+  await client.connect();
+  await client.del('mykey');
+
+  let result = await client.set('mykey', 'myvalue', {
+    EX: 60,
+    GET: true
+  });
+
+  console.log(result); //nil
+
+  result = await client.set('mykey', 'newvalue', {
+    EX: 60,
+    GET: true
+  }
+  );
+
+  console.log(result); //myvalue
+
+  await client.quit();
+}
+
+commandWithModifiers();
+

examples/connect-as-acl-user.js

@@ -0,0 +1,30 @@
+// Connect to Redis 6.x as an ACL user.  Attempt to run a command
+// that the user is allowed to execute, and a command that the 
+// user is not allowed to execute.
+
+// Create the test user in redis-cli with this command:
+//   acl setuser testuser on >testpassword +ping
+
+import { createClient } from 'redis';
+
+async function connectWithACLUser() {
+  const client = createClient({
+    url: 'redis://testuser:testpassword@127.0.0.1:6379'
+  });
+
+  await client.connect();
+
+  // Returns PONG
+  console.log(`Response from PING command: ${await client.ping()}`);
+
+  try {
+    // This will error as this user is not allowed to run this command...
+    console.log(`Response from GET command: ${await client.get('somekey')}`);
+  } catch (e) {
+    console.log(`GET command failed: ${e.message}`);
+  }
+
+  await client.quit();
+}
+
+connectWithACLUser();

examples/lua-multi-incr.js

@@ -0,0 +1,31 @@
+// Define a custome lua script that accepts two keys and an amount to
+// increment each of them by
+
+import { createClient, defineScript } from 'redis';
+
+async function luaMultiIncr() {
+  const client = createClient({
+    scripts: {
+      mincr: defineScript({
+        NUMBER_OF_KEYS: 2,
+        SCRIPT:
+          'return {' +
+          'redis.pcall("INCRBY", KEYS[1], ARGV[1]),' +
+          'redis.pcall("INCRBY", KEYS[2], ARGV[1])' +
+          '}',
+        transformArguments(key1, key2, increment) {
+          return [key1, key2, increment.toString()];
+        },
+      }),
+    },
+  });
+
+  await client.connect();
+
+  await client.set('mykey', '5');
+  console.log(await client.mincr('mykey', 'myotherkey', 10)); // [ 15, 10 ]
+
+  await client.quit();
+}
+
+luaMultiIncr();

examples/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "node-redis-examples",
+  "version": "1.0.0",
+  "description": "node-redis 4 example script",
+  "main": "index.js",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "redis": "../"
+  }
+}
+

examples/search+json.js

@@ -0,0 +1,74 @@
+// Use Redis Search and Redis JSON
+
+import { createClient, SchemaFieldTypes, AggregateGroupByReducers, AggregateSteps } from 'redis';
+
+async function searchPlusJson() {
+  const client = createClient();
+
+  await client.connect();
+
+  // Create an index
+  await client.ft.create('users', {
+    '$.name': {
+      type: SchemaFieldTypes.TEXT,
+      SORTABLE: 'UNF'
+    },
+    '$.age': SchemaFieldTypes.NUMERIC,
+    '$.coins': SchemaFieldTypes.NUMERIC
+  }, {
+    ON: 'JSON'
+  });
+
+  // Add some users
+  await Promise.all([
+    client.json.set('users:1', '$', {
+      name: 'Alice',
+      age: 32,
+      coins: 100
+    }),
+    client.json.set('users:2', '$', {
+      name: 'Bob',
+      age: 23,
+      coins: 15
+    })
+  ]);
+
+  // Search all users under 30
+  // TODO: why "$.age:[-inf, 30]" does not work?
+  console.log(
+    await client.ft.search('users', '*')
+  );
+  // {
+  //   total: 1,
+  //   documents: [...]
+  // }
+
+  // Some aggrigrations
+  console.log(
+    await client.ft.aggregate('users', '*', {
+      STEPS: [{
+        type: AggregateSteps.GROUPBY,
+        REDUCE: [{
+          type: AggregateGroupByReducers.AVG,
+          property: '$.age',
+          AS: 'avarageAge'
+        }, {
+          type: AggregateGroupByReducers.SUM,
+          property: '$.coins',
+          AS: 'totalCoins'
+        }]
+      }]
+    })
+  );
+  // {
+  //   total: 2,
+  //   results: [{
+  //     avarageAvg: '27.5',
+  //     totalCoins: '115'
+  //   }]
+  // }
+
+  await client.quit();
+}
+
+searchPlusJson();

examples/set-scan.js

@@ -0,0 +1,19 @@
+// An example script that shows how to use the SSCAN iterator functionality to retrieve the contents of a Redis set.
+// Create the set in redis-cli with this command:
+//     sadd setName a b c d e f g h i j k l m n o p q
+
+import { createClient } from 'redis';
+
+async function setScan() {
+  const client = createClient();
+  await client.connect();
+
+  const setName = 'setName';
+  for await (const member of client.sScanIterator(setName)) {
+    console.log(member);
+  }
+
+  await client.quit();
+}
+
+setScan();