redis 4.0.0-rc.4 → 4.0.0

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/node-redis.iml" filepath="$PROJECT_DIR$/.idea/node-redis.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/node-redis.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,2 +1,312 @@
-# redis
-The sources and docs for this package are in the main [node-redis](https://github.com/redis/node-redis) repo.
+# Node-Redis
+
+[![Tests](https://img.shields.io/github/workflow/status/redis/node-redis/Tests/master.svg?label=tests)](https://codecov.io/gh/redis/node-redis)
+[![Coverage](https://codecov.io/gh/redis/node-redis/branch/master/graph/badge.svg?token=xcfqHhJC37)](https://codecov.io/gh/redis/node-redis)
+[![License](https://img.shields.io/github/license/redis/node-redis.svg)](https://codecov.io/gh/redis/node-redis)
+[![Chat](https://img.shields.io/discord/697882427875393627.svg)](https://discord.gg/XMMVgxUm)
+
+node-redis is a modern, high performance [Redis](https://redis.io) client for Node.js with built-in support for Redis 6.2 commands and modules including [RediSearch](https://redisearch.io) and [RedisJSON](https://redisjson.io).
+
+## Installation
+
+```bash
+npm install redis
+```
+
+> :warning: The new interface is clean and cool, but if you have an existing codebase, you'll want to read the [migration guide](./docs/v3-to-v4.md).
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { createClient } from 'redis';
+
+(async () => {
+  const client = createClient();
+
+  client.on('error', (err) => console.log('Redis Client Error', err));
+
+  await client.connect();
+
+  await client.set('key', 'value');
+  const value = await client.get('key');
+})();
+```
+
+The above code connects to localhost on port 6379. To connect to a different host or port, use a connection string in the format `redis[s]://[[username][:password]@][host][:port][/db-number]`:
+
+```typescript
+createClient({
+  url: 'redis://alice:foobared@awesome.redis.server:6380'
+});
+```
+
+You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](./docs/client-configuration.md).
+
+### Redis Commands
+
+There is built-in support for all of the [out-of-the-box Redis commands](https://redis.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) and a friendlier camel-cased version (`hSet`, `hGetAll`, etc.):
+
+```typescript
+// raw Redis commands
+await client.HSET('key', 'field', 'value');
+await client.HGETALL('key');
+
+// friendly JavaScript commands
+await client.hSet('key', 'field', 'value');
+await client.hGetAll('key');
+```
+
+Modifiers to commands are specified using a JavaScript object:
+
+```typescript
+await client.set('key', 'value', {
+  EX: 10,
+  NX: true
+});
+```
+
+Replies will be transformed into useful data structures:
+
+```typescript
+await client.hGetAll('key'); // { field1: 'value1', field2: 'value2' }
+await client.hVals('key'); // ['value1', 'value2']
+```
+
+### Unsupported Redis Commands
+
+If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`:
+
+```typescript
+await client.sendCommand(['SET', 'key', 'value', 'NX']); // 'OK'
+
+await client.sendCommand(['HGETALL', 'key']); // ['key1', 'field1', 'key2', 'field2']
+```
+
+### Transactions (Multi/Exec)
+
+Start a [transaction](https://redis.io/topics/transactions) by calling `.multi()`, then chaining your commands. When you're done, call `.exec()` and you'll get an array back with your results:
+
+```typescript
+await client.set('another-key', 'another-value');
+
+const [setKeyReply, otherKeyValue] = await client
+  .multi()
+  .set('key', 'value')
+  .get('another-key')
+  .exec(); // ['OK', 'another-value']
+```
+
+You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling `.watch()`. Your transaction will abort if any of the watched keys change.
+
+To dig deeper into transactions, check out the [Isolated Execution Guide](./docs/isolated-execution.md).
+
+### Blocking Commands
+
+Any command can be run on a new connection by specifying the `isolated` option. The newly created connection is closed when the command's `Promise` is fulfilled.
+
+This pattern works especially well for blocking commands—such as `BLPOP` and `BLMOVE`:
+
+```typescript
+import { commandOptions } from 'redis';
+
+const blPopPromise = client.blPop(commandOptions({ isolated: true }), 'key', 0);
+
+await client.lPush('key', ['1', '2']);
+
+await blPopPromise; // '2'
+```
+
+To learn more about isolated execution, check out the [guide](./docs/isolated-execution.md).
+
+### Pub/Sub
+
+Subscribing to a channel requires a dedicated stand-alone connection. You can easily get one by `.duplicate()`ing an existing Redis connection.
+
+```typescript
+const subscriber = client.duplicate();
+
+await subscriber.connect();
+```
+
+Once you have one, simply subscribe and unsubscribe as needed:
+
+```typescript
+await subscriber.subscribe('channel', (message) => {
+  console.log(message); // 'message'
+});
+
+await subscriber.pSubscribe('channe*', (message, channel) => {
+  console.log(message, channel); // 'message', 'channel'
+});
+
+await subscriber.unsubscribe('channel');
+
+await subscriber.pUnsubscribe('channe*');
+```
+
+Publish a message on a channel:
+
+```typescript
+await publisher.publish('channel', 'message');
+```
+
+There is support for buffers as well:
+
+```typescript
+await subscriber.subscribe('channel', (message) => {
+  console.log(message); // <Buffer 6d 65 73 73 61 67 65>
+}, true);
+
+await subscriber.pSubscribe('channe*', (message, channel) => {
+  console.log(message, channel); // <Buffer 6d 65 73 73 61 67 65>, <Buffer 63 68 61 6e 6e 65 6c>
+}, true);
+```
+
+### Scan Iterator
+
+[`SCAN`](https://redis.io/commands/scan) results can be looped over 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);
+}
+```
+
+This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
+
+```typescript
+for await (const { field, value } of client.hScanIterator('hash')) {}
+for await (const member of client.sScanIterator('set')) {}
+for await (const { score, member } of client.zScanIterator('sorted-set')) {}
+```
+
+You can override the default options by providing a configuration object:
+
+```typescript
+client.scanIterator({
+  TYPE: 'string', // `SCAN` only
+  MATCH: 'patter*',
+  COUNT: 100
+});
+```
+
+### Lua Scripts
+
+Define new functions using [Lua scripts](https://redis.io/commands/eval) which execute on the Redis server:
+
+```typescript
+import { createClient, defineScript } from 'redis';
+
+(async () => {
+  const client = createClient({
+    scripts: {
+      add: defineScript({
+        NUMBER_OF_KEYS: 1,
+        SCRIPT:
+          'local val = redis.pcall("GET", KEYS[1]);' +
+          'return val + ARGV[1];',
+        transformArguments(key: string, toAdd: number): Array<string> {
+          return [key, toAdd.toString()];
+        },
+        transformReply(reply: number): number {
+          return reply;
+        }
+      })
+    }
+  });
+
+  await client.connect();
+
+  await client.set('key', '1');
+  await client.add('key', 2); // 3
+})();
+```
+
+### Disconnecting
+
+There are two functions that disconnect a client from the Redis server. In most scenarios you should use `.quit()` to ensure that pending commands are sent to Redis before closing a connection.
+
+#### `.QUIT()`/`.quit()`
+
+Gracefully close a client's connection to Redis, by sending the [`QUIT`](https://redis.io/commands/quit) command to the server. Before quitting, the client executes any remaining commands in its queue, and will receive replies from Redis for each of them.
+
+```typescript
+const [ping, get, quit] = await Promise.all([
+  client.ping(),
+  client.get('key'),
+  client.quit()
+]); // ['PONG', null, 'OK']
+
+try {
+  await client.get('key');
+} catch (err) {
+  // ClosedClient Error
+}
+```
+
+#### `.disconnect()`
+
+Forcibly close a client's connection to Redis immediately. Calling `disconnect` will not send further pending commands to the Redis server, or wait for or parse outstanding responses.
+
+```typescript
+await client.disconnect();
+```
+
+### Auto-Pipelining
+
+Node Redis will automatically pipeline requests that are made during the same "tick".
+
+```typescript
+client.set('Tm9kZSBSZWRpcw==', 'users:1');
+client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==');
+```
+
+Of course, if you don't do something with your Promises you're certain to get [unhandled Promise exceptions](https://nodejs.org/api/process.html#process_event_unhandledrejection). To take advantage of auto-pipelining and handle your Promises, use `Promise.all()`.
+
+```typescript
+await Promise.all([
+  client.set('Tm9kZSBSZWRpcw==', 'users:1'),
+  client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==')
+]);
+```
+
+### Clustering
+
+Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
+
+## Supported Redis versions
+
+Node Redis is supported with the following versions of Redis:
+
+| Version | Supported          |
+|---------|--------------------|
+| 6.2.z   | :heavy_check_mark: |
+| 6.0.z   | :heavy_check_mark: |
+| 5.y.z   | :heavy_check_mark: |
+| < 5.0   | :x:                |
+
+> Node Redis should work with older versions of Redis, but it is not fully tested and we cannot offer support.
+
+## Packages
+
+| Name                                    | Description                                                                                                                                                                                                                                                                                                              |
+|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [redis](./)                             | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis/v/next) [![Version](https://img.shields.io/npm/v/redis/next.svg)](https://www.npmjs.com/package/redis/v/next)                                                                                                                |
+| [@node-redis/client](./packages/client) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client/v/next) [![Version](https://img.shields.io/npm/v/@node-redis/client/next.svg)](https://www.npmjs.com/package/@node-redis/client/v/next)                                                            |
+| [@node-redis/json](./packages/json)     | [![Downloads](https://img.shields.io/npm/dm/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json/v/next) [![Version](https://img.shields.io/npm/v/@node-redis/json/next.svg)](https://www.npmjs.com/package/@node-redis/json/v/next) [Redis JSON](https://oss.redis.com/redisjson/) commands            |
+| [@node-redis/search](./packages/search) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search/v/next) [![Version](https://img.shields.io/npm/v/@node-redis/search/next.svg)](https://www.npmjs.com/package/@node-redis/search/v/next) [Redis Search](https://oss.redis.com/redisearch/) commands |
+
+## Contributing
+
+If you'd like to contribute, check out the [contributing guide](CONTRIBUTING.md).
+
+Thank you to all the people who already contributed to Node Redis!
+
+[![Contributors](https://contrib.rocks/image?repo=redis/node-redis)](https://github.com/redis/node-redis/graphs/contributors)
+
+## License
+
+This repository is licensed under the "MIT" license. See [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis",
-  "version": "4.0.0-rc.4",
+  "version": "4.0.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -17,14 +17,14 @@
     "build-all": "npm run build:client && npm run build:test-utils && npm run build:modules && npm run build"
   },
   "dependencies": {
-    "@node-redis/client": "^1.0.0-rc.0",
-    "@node-redis/json": "^1.0.0-rc.0",
-    "@node-redis/search": "^1.0.0-rc.0"
+    "@node-redis/client": "^1.0.0",
+    "@node-redis/json": "^1.0.0",
+    "@node-redis/search": "^1.0.0"
   },
   "devDependencies": {
     "@tsconfig/node12": "^1.0.9",
-    "release-it": "^14.11.7",
-    "typescript": "^4.4.4"
+    "release-it": "^14.11.8",
+    "typescript": "^4.5.2"
   },
   "repository": {
     "type": "git",

package/scripts/cluster-stress-test.js

@@ -0,0 +1,72 @@
+import { createCluster } from 'redis';
+import { strict as assert } from 'assert';
+import { promises as fs } from 'fs';
+
+const cluster = createCluster({
+    rootNodes: [{
+        socket: {
+            host: 'redis-14416.ned.shahar.demo.redislabs.com',
+            port: 14416
+        }
+    }],
+    defaults: {
+        password: 'osscluster'
+    }
+});
+
+cluster.on('error', err => console.error('Redis Cluster Error', err));
+
+try {
+    await cluster.connect();
+
+    await Promise.all([
+        ...cluster.getMasters().map(({ client }) => client.flushAll()),
+        fs.writeFile('./error.log', '')
+    ]);
+
+    await promiseConcurrency(setAndGet, { end: 500000, concurrency: 1000 });
+} finally {
+    await cluster.disconnect();
+}
+
+async function setAndGet(i) {
+    const str = i.toString();
+
+    await cluster.set(str, str);
+
+    assert.equal(
+        await cluster.get(str),
+        str
+    );
+}
+
+function promiseConcurrency(fn, { start = 0, end, concurrency }) {
+    return new Promise(resolve => {
+        let num = start,
+            inProgress = 0;
+
+        function run() {
+            ++inProgress;
+
+            const i = num++;
+            if (i % 1000 === 0) {
+                console.log('!!!', i);
+            }
+
+            fn(i)
+                .finally(() => --inProgress)
+                .then(() => {
+                    if (num < end) {
+                        run();
+                    } else if (inProgress === 0) {
+                        resolve();
+                    }
+                })
+                .catch(err => fs.appendFile('./error.log', `${i.toString()} - ${err.toString()}\n\n-------\n\n`));
+        }
+
+        for (let i = 0; i < concurrency; i++) {
+            run();
+        }
+    });
+}

package/scripts/node_modules/.package-lock.json

@@ -0,0 +1,28 @@
+{
+  "name": "node-redis-scripts",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "..": {
+      "version": "4.0.0-rc.4",
+      "license": "MIT",
+      "workspaces": [
+        "./packages/*"
+      ],
+      "dependencies": {
+        "@node-redis/client": "^1.0.0-rc.0",
+        "@node-redis/json": "^1.0.0-rc.0",
+        "@node-redis/search": "^1.0.0-rc.0"
+      },
+      "devDependencies": {
+        "@tsconfig/node12": "^1.0.9",
+        "release-it": "^14.11.7",
+        "typescript": "^4.4.4"
+      }
+    },
+    "node_modules/redis": {
+      "resolved": "..",
+      "link": true
+    }
+  }
+}

package/scripts/package-lock.json

@@ -0,0 +1,47 @@
+{
+  "name": "node-redis-scripts",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "node-redis-scripts",
+      "dependencies": {
+        "redis": "../"
+      }
+    },
+    "..": {
+      "version": "4.0.0-rc.4",
+      "license": "MIT",
+      "workspaces": [
+        "./packages/*"
+      ],
+      "dependencies": {
+        "@node-redis/client": "^1.0.0-rc.0",
+        "@node-redis/json": "^1.0.0-rc.0",
+        "@node-redis/search": "^1.0.0-rc.0"
+      },
+      "devDependencies": {
+        "@tsconfig/node12": "^1.0.9",
+        "release-it": "^14.11.7",
+        "typescript": "^4.4.4"
+      }
+    },
+    "node_modules/redis": {
+      "resolved": "..",
+      "link": true
+    }
+  },
+  "dependencies": {
+    "redis": {
+      "version": "file:..",
+      "requires": {
+        "@node-redis/client": "^1.0.0-rc.0",
+        "@node-redis/json": "^1.0.0-rc.0",
+        "@node-redis/search": "^1.0.0-rc.0",
+        "@tsconfig/node12": "^1.0.9",
+        "release-it": "^14.11.7",
+        "typescript": "^4.4.4"
+      }
+    }
+  }
+}

package/scripts/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "node-redis-scripts",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "redis": "../"
+  }
+}
+