redis
diff --git a/‎.github/workflows/documentation.yml
Lines changed: 8 additions & 5 deletions b/‎.github/workflows/documentation.yml
Lines changed: 8 additions & 5 deletions
diff --git a/‎.github/workflows/tests.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/tests.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎.gitignore
Lines changed: 1 addition & 0 deletions b/‎.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎README.md
Lines changed: 26 additions & 10 deletions b/‎README.md
Lines changed: 26 additions & 10 deletions
diff --git a/‎benchmark/.gitignore
Lines changed: 1 addition & 0 deletions b/‎benchmark/.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎benchmark/lib/defaults.yml
Lines changed: 32 additions & 0 deletions b/‎benchmark/lib/defaults.yml
Lines changed: 32 additions & 0 deletions
diff --git a/‎benchmark/lib/index.js
Lines changed: 66 additions & 0 deletions b/‎benchmark/lib/index.js
Lines changed: 66 additions & 0 deletions
diff --git a/‎benchmark/lib/ping/ioredis.js
Lines changed: 19 additions & 0 deletions b/‎benchmark/lib/ping/ioredis.js
Lines changed: 19 additions & 0 deletions
diff --git a/‎benchmark/lib/ping/ping.yml
Lines changed: 9 additions & 0 deletions b/‎benchmark/lib/ping/ping.yml
Lines changed: 9 additions & 0 deletions
diff --git a/‎benchmark/lib/ping/v3.js
Lines changed: 21 additions & 0 deletions b/‎benchmark/lib/ping/v3.js
Lines changed: 21 additions & 0 deletions
diff --git a/‎benchmark/lib/ping/v4.js
Lines changed: 20 additions & 0 deletions b/‎benchmark/lib/ping/v4.js
Lines changed: 20 additions & 0 deletions
diff --git a/‎benchmark/lib/runner.js
Lines changed: 86 additions & 0 deletions b/‎benchmark/lib/runner.js
Lines changed: 86 additions & 0 deletions
diff --git a/‎benchmark/lib/set-get-delete-string/1KB.yml
Lines changed: 9 additions & 0 deletions b/‎benchmark/lib/set-get-delete-string/1KB.yml
Lines changed: 9 additions & 0 deletions
diff --git a/‎benchmark/lib/set-get-delete-string/1MB.yml
Lines changed: 9 additions & 0 deletions b/‎benchmark/lib/set-get-delete-string/1MB.yml
Lines changed: 9 additions & 0 deletions
diff --git a/‎benchmark/lib/set-get-delete-string/8B.yml
Lines changed: 9 additions & 0 deletions b/‎benchmark/lib/set-get-delete-string/8B.yml
Lines changed: 9 additions & 0 deletions
@@ -17,11 +17,14 @@ jobs:
         uses: actions/[email protected]
       - name: Install Packages
         run: npm ci
+      - name: Build tests tools
+        run: npm run build:tests-tools
       - name: Generate Documentation
         run: npm run documentation
-      - name: Upload Documentation to Wiki
-        uses: SwiftDocOrg/github-wiki-publish-action@v1
-        with:
-          path: documentation
+      - name: Upload
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          npm run gh-pages
         env:
-          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
@@ -34,7 +34,7 @@ jobs:
       - name: Build tests tools
         run: npm run build:tests-tools
       - name: Run Tests
-        run: npm run test -- --forbid-only --redis-version=${{ matrix.redis-version }}
+        run: npm run test -- -- --forbid-only --redis-version=${{ matrix.redis-version }}
       - name: Upload to Codecov
         run: |
           curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --keyring trustedkeys.gpg --import
 
@@ -6,3 +6,4 @@ dist/
 node_modules/
 .DS_Store
 dump.rdb
+documentation/
@@ -1,9 +1,10 @@
 # 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)
+[![Tests](https://img.shields.io/github/workflow/status/redis/node-redis/Tests/master.svg?label=tests)](https://github.com/redis/node-redis/actions/workflows/tests.yml)
 [![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)
+[![License](https://img.shields.io/github/license/redis/node-redis.svg)](https://github.com/redis/node-redis/blob/master/LICENSE)
+[![LGTM alerts](https://img.shields.io/lgtm/alerts/g/redis/node-redis.svg?logo=LGTM)](https://lgtm.com/projects/g/redis/node-redis/alerts)
+[![Chat](https://img.shields.io/discord/697882427875393627.svg)](https://discord.gg/redis)
 
 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).
 
@@ -180,7 +181,7 @@ 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')) {}
+for await (const { score, value } of client.zScanIterator('sorted-set')) {}
 ```
 
 You can override the default options by providing a configuration object:
@@ -277,6 +278,20 @@ await Promise.all([
 
 Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
 
+### Events
+
+The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
+
+| Event name   | Scenes                                                                                                            | Parameters                                                                                                                         |
+|--------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| connect      | The client is initiating a connection to the server.                                                              | _undefined_                                                                                                                        |
+| ready        | The client successfully initiated the connection to the server.                                                   | _undefined_                                                                                                                        |
+| end          | The client disconnected the connection to the server via `.quit()` or `.disconnect()`.                            | _undefined_                                                                                                                        |
+| error        | When a network error has occurred, such as unable to connect to the server or the connection closed unexpectedly. | The error object, such as `SocketClosedUnexpectedlyError: Socket closed unexpectedly` or `Error: connect ECONNREFUSED [IP]:[PORT]` |
+| reconnecting | The client is trying to reconnect to the server.                                                                  | _undefined_                                                                                                                        |
+
+The client will not emit any other events beyond those listed above.
+
 ## Supported Redis versions
 
 Node Redis is supported with the following versions of Redis:
@@ -292,12 +307,13 @@ Node Redis is supported with the following versions of Redis:
 
 ## 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 |
+| -----------------------------------------         | -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------                                  |
+|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [redis](./)                                       | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis) [![Version](https://img.shields.io/npm/v/redis.svg)](https://www.npmjs.com/package/redis)                                                                                                                                                                                                                                                             |
+| [@node-redis/client](./packages/client)           | [![Downloads](https://img.shields.io/npm/dm/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Version](https://img.shields.io/npm/v/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/client/)                                                                                               |
+| [@node-redis/json](./packages/json)               | [![Downloads](https://img.shields.io/npm/dm/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Version](https://img.shields.io/npm/v/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/json/) [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) [![Version](https://img.shields.io/npm/v/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/search/) [Redis Search](https://oss.redis.com/redisearch/) commands                                    |
+| [@node-redis/time-series](./packages/time-series) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/time-series.svg)](https://www.npmjs.com/package/@node-redis/time-series) [![Version](https://img.shields.io/npm/v/@node-redis/time-series.svg)](https://www.npmjs.com/package/@node-redis/time-series) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/time-series/) [Redis Time-Series](https://oss.redis.com/redistimeseries/) commands |
 
 ## Contributing
 
 
@@ -0,0 +1 @@
+*.js.json
@@ -0,0 +1,32 @@
+version: 0.1
+
+remote:
+  - type: oss-standalone
+  - setup: redis-small
+
+setups:
+  - oss-standalone
+
+spec:
+  setups:
+  - name: oss-standalone
+    type: oss-standalone
+    redis_topology:
+      primaries: 1
+      replicas: 0
+    resources:
+      requests:
+        cpus: "1"
+        memory: "10g"
+
+exporter:
+  output_path: "./*.js.json"
+  redistimeseries:
+    timemetric: "$.timestamp"
+    metrics:
+      - "$.p0"
+      - "$.p50"
+      - "$.p95"
+      - "$.p99"
+      - "$.p100"
+      - "$.operationsPerSecond"
@@ -0,0 +1,66 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { promises as fs } from 'fs';
+import { fork } from 'child_process';
+import { URL, fileURLToPath } from 'url';
+import { once } from 'events';
+import { extname } from 'path';
+
+async function getPathChoices() {
+    const dirents = await fs.readdir(new URL('.', import.meta.url), {
+        withFileTypes: true
+    });
+
+    const choices = [];
+    for (const dirent of dirents) {
+        if (!dirent.isDirectory()) continue;
+
+        choices.push(dirent.name);
+    }
+
+    return choices;
+}
+
+const argv = hideBin(process.argv);
+
+async function getName() {
+    return yargs(argv)
+        .option('name', {
+            demandOption: true,
+            choices: await getPathChoices()
+        })
+        .parseSync().name;
+}
+
+const runnerPath = fileURLToPath(new URL('runner.js', import.meta.url)),
+    path = new URL(`${await getName()}/`, import.meta.url);
+
+async function getMetadata() {
+    try {
+        return await import(new URL('index.js', path));
+    } catch (err) {
+        if (err.code === 'ERR_MODULE_NOT_FOUND') return;
+
+        throw err;
+    }
+}
+
+const metadata = await getMetadata(),
+    timestamp = Date.now();
+
+for (const file of await fs.readdir(path)) {
+    if (file === 'index.js' || extname(file) !== '.js') continue;
+
+    const benchmarkProcess = fork(runnerPath, [
+        ...argv,
+        '--path',
+        fileURLToPath(path) + file
+    ]);
+
+    await once(benchmarkProcess, 'message');
+    benchmarkProcess.send({
+        metadata,
+        timestamp
+    });
+    await once(benchmarkProcess, 'close');
+}
@@ -0,0 +1,19 @@
+import Redis from 'ioredis';
+
+export default async (host) => {
+    const client = new Redis({
+        host,
+        lazyConnect: true
+    });
+
+    await client.connect();
+
+    return {
+        benchmark() {
+            return client.ping();
+        },
+        teardown() {
+            return client.disconnect();
+        }
+    }
+};
@@ -0,0 +1,9 @@
+name: "ping"
+
+clientconfig:
+  - command: |
+      npm install -ws
+      npm run build:tests-tools
+      cd benchmark
+      npm install
+      npm run start -- --name ping --redis-server-host ${server_private_ip}
@@ -0,0 +1,21 @@
+import { createClient } from 'redis-v3';
+import { once } from 'events';
+import { promisify } from 'util';
+
+export default async (host) => {
+    const client = createClient({ host }),
+        pingAsync = promisify(client.ping).bind(client),
+        quitAsync = promisify(client.quit).bind(client);
+
+    await once(client, 'connect');
+
+    return {
+        benchmark() {
+            return pingAsync();
+        },
+        teardown() {
+            return quitAsync();
+        }
+    };
+
+};
@@ -0,0 +1,20 @@
+import { createClient } from '@node-redis/client';
+
+export default async (host) => {
+    const client = createClient({
+        socket: {
+            host
+        }
+    });
+
+    await client.connect();
+
+    return {
+        benchmark() {
+            return client.ping();
+        },
+        teardown() {
+            return client.disconnect();
+        }
+    };
+};
@@ -0,0 +1,86 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { basename } from 'path';
+import { promises as fs } from 'fs';
+import * as hdr from 'hdr-histogram-js';
+hdr.initWebAssemblySync();
+
+const { path, times, concurrency, 'redis-server-host': host } = yargs(hideBin(process.argv))
+    .option('path', {
+        type: 'string',
+        demandOption: true
+    })
+    .option('times', {
+        type: 'number',
+        default: 1_000_000,
+        demandOption: true
+    })
+    .option('concurrency', {
+        type: 'number',
+        default: 100,
+        demandOption: true
+    })
+    .option('redis-server-host', {
+        type: 'string'
+    })
+    .parseSync();
+
+const [ { metadata, timestamp }, module ] = await Promise.all([
+        new Promise(resolve => {
+            process.once('message', resolve);
+            process.send('ready');
+        }),
+        import(path)
+    ]),
+    { benchmark, teardown } = await module.default(host, metadata);
+
+async function run(times) {
+    return new Promise(resolve => {
+        const histogram = hdr.build({ useWebAssembly: true });
+        let num = 0,
+            inProgress = 0;
+
+        async function run() {
+            ++inProgress;
+            ++num;
+
+            const start = process.hrtime.bigint();
+            await benchmark(metadata);
+            histogram.recordValue(Number(process.hrtime.bigint() - start));
+            --inProgress;
+
+            if (num < times) {
+                run();
+            } else if (inProgress === 0) {
+                resolve(histogram);
+            }
+        }
+
+        const toInitiate = Math.min(concurrency, times);
+        for (let i = 0; i < toInitiate; i++) {
+            run();
+        }
+    });
+}
+
+// warmup
+await run(Math.min(times * 0.1, 10_000));
+
+// benchmark
+const benchmarkStart = process.hrtime.bigint(),
+    histogram = await run(times),
+    benchmarkNanoseconds = process.hrtime.bigint() - benchmarkStart,
+    json = {
+        timestamp,
+        operationsPerSecond: times / Number(benchmarkNanoseconds) * 1_000_000_000,
+        p0: histogram.getValueAtPercentile(0),
+        p50: histogram.getValueAtPercentile(50),
+        p95: histogram.getValueAtPercentile(95),
+        p99: histogram.getValueAtPercentile(99),
+        p100: histogram.getValueAtPercentile(100)
+    };
+console.log(`[${basename(path)}]:`);
+console.table(json);
+await fs.writeFile(`${path}.json`, JSON.stringify(json));
+
+await teardown();
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-1KB"
+
+clientconfig:
+  - command: |
+      npm install -ws
+      npm run build:tests-tools
+      cd benchmark
+      npm install
+      npm run start -- --name set-get-delete-string --size 1024 --redis-server-host ${server_private_ip}
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-1MB"
+
+clientconfig:
+  - command: |
+      npm install -ws
+      npm run build:tests-tools
+      cd benchmark
+      npm install
+      npm run start -- --name set-get-delete-string --size 1048576 --redis-server-host ${server_private_ip}
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-8B"
+
+clientconfig:
+  - command: |
+      npm install -ws
+      npm run build:tests-tools
+      cd benchmark
+      npm install
+      npm run start -- --name set-get-delete-string --size 8 --redis-server-host ${server_private_ip}