@eggjs/redis 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,248 @@
+# @eggjs/redis
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/redis/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/redis/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/redis.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/redis)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/redis.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/redis
+[codecov-image]: https://codecov.io/gh/eggjs/redis/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/eggjs/redis
+[snyk-image]: https://snyk.io/test/npm/@eggjs/redis/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/redis
+[download-image]: https://img.shields.io/npm/dm/@eggjs/redis.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/redis
+
+Valkey / Redis client (support [redis protocol](https://redis.io/docs/latest/develop/reference/protocol-spec/)) based on iovalkey for egg framework
+
+## Install
+
+```bash
+npm i @eggjs/redis
+```
+
+Valkey / Redis Plugin for egg, support egg application access to Valkey / Redis Service.
+
+This plugin based on [ioredis](https://github.com/redis/ioredis).
+If you want to know specific usage, you should refer to the document of [ioredis](https://github.com/redis/ioredis).
+
+## Configuration
+
+Change `${app_root}/config/plugin.js` to enable redis plugin:
+
+```js
+exports.redis = {
+  enable: true,
+  package: '@eggjs/redis',
+};
+```
+
+Configure redis information in `${app_root}/config/config.default.js`:
+
+**Single Client**
+
+```javascript
+config.redis = {
+  client: {
+    port: 6379,          // Redis port
+    host: '127.0.0.1',   // Redis host
+    password: 'auth',
+    db: 0,
+  },
+}
+```
+
+**Multi Clients**
+
+```javascript
+config.redis = {
+  clients: {
+    foo: {                 // instanceName. See below
+      port: 6379,          // Redis port
+      host: '127.0.0.1',   // Redis host
+      password: 'auth',
+      db: 0,
+    },
+    bar: {
+      port: 6379,
+      host: '127.0.0.1',
+      password: 'auth',
+      db: 1,
+    },
+  }
+}
+```
+
+**Sentinel**
+
+```javascript
+config.redis = {
+  client: {
+    // Sentinel instances
+    sentinels: [
+      {
+        port: 26379,         // Sentinel port
+        host: '127.0.0.1',   // Sentinel host
+      },
+      // other sentinel instance config
+    ],
+    name: 'mymaster',      // Master name
+    password: 'auth',
+    db: 0
+  },
+}
+```
+
+**No password**
+
+Redis support no authentication access, but we are highly recommend you to use redis `requirepass` in `redis.conf`.
+
+```bash
+$vim /etc/redis/redis.conf
+
+requirepass xxxxxxxxxx  // xxxxxxxxxx is your password
+```
+
+Because it may be cause security risk, refer:
+
+- <https://ruby-china.org/topics/28094>
+- <https://zhuoroger.github.io/2016/07/29/redis-sec/>
+
+If you want to access redis with no password, use `password: null`.
+
+See [ioredis API Documentation](https://github.com/redis/ioredis#basic-usage) for all available options.
+
+### Customize `ioredis` version
+
+`@eggjs/redis` using `ioredis@5` now, if you want to use other version of iovalkey or ioredis,
+you can pass the instance by `config.redis.Redis`:
+
+```js
+// config/config.default.js
+config.redis = {
+  Redis: require('ioredis'), // customize ioredis version, only set when you needed
+  client: {
+    port: 6379,          // Redis port
+    host: '127.0.0.1',   // Redis host
+    password: 'auth',
+    db: 0,
+  },
+}
+```
+
+**weakDependent**
+
+```javascript
+config.redis = {
+  client: {
+    port: 6379,          // Redis port
+    host: '127.0.0.1',   // Redis host
+    password: 'auth',
+    db: 0,
+    weakDependent: true, // the redis instance won't block app start
+  },
+}
+```
+
+## Usage
+
+In controller, you can use `app.redis` to get the redis instance, check [ioredis](https://github.com/redis/ioredis#basic-usage) to see how to use.
+
+```js
+// app/controller/home.js
+
+module.exports = app => {
+  return class HomeController extends app.Controller {
+    async index() {
+      const { ctx, app } = this;
+      // set
+      await app.redis.set('foo', 'bar');
+      // get
+      ctx.body = await app.redis.get('foo');
+    }
+  };
+};
+```
+
+### Multi Clients
+
+If your Configure with multi clients, you can use `app.redis.get(instanceName)` to get the specific redis instance and use it like above.
+
+```js
+// app/controller/home.js
+
+module.exports = app => {
+  return class HomeController extends app.Controller {
+    async index() {
+      const { ctx, app } = this;
+      // set
+      await app.redis.get('instance1').set('foo', 'bar');
+      // get
+      ctx.body = await app.redis.get('instance1').get('foo');
+    }
+  };
+};
+```
+
+### Clients Depend on Redis Cluster
+
+Before you start to use Redis Cluster, please checkout the [document](https://redis.io/topics/cluster-tutorial) first, especially confirm `cluster-enabled yes` in Redis Cluster configuration file.
+
+In controller, you also can use `app.redis` to get the redis instance based on Redis Cluster.
+
+```js
+// app/config/config.default.js
+exports.redis = {
+  client: {
+    cluster: true,
+    nodes: [
+      {
+        host: '127.0.0.1',
+        port: '6379',
+        family: 'user',
+        password: 'password',
+        db: 'db',
+      },
+      {
+        host: '127.0.0.1',
+        port: '6380',
+        family: 'user',
+        password: 'password',
+        db: 'db',
+      },
+    ],
+  },
+};
+
+// app/controller/home.js
+module.exports = app => {
+  return class HomeController extends app.Controller {
+    async index() {
+      const { ctx, app } = this;
+      // set
+      await app.redis.set('foo', 'bar');
+      // get
+      ctx.body = await app.redis.get('foo');
+    }
+  };
+};
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/redis)](https://github.com/eggjs/redis/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;

package/dist/commonjs/agent.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const redis_js_1 = require("./lib/redis.js");
+exports.default = redis_js_1.RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSw2Q0FBMkM7QUFFM0Msa0JBQWUsb0JBQVMsQ0FBQyJ9

package/dist/commonjs/app.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;

package/dist/commonjs/app.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const redis_js_1 = require("./lib/redis.js");
+exports.default = redis_js_1.RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDZDQUEyQztBQUUzQyxrQkFBZSxvQkFBUyxDQUFDIn0=

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,59 @@
+import type { RedisOptions, ClusterOptions } from 'ioredis';
+export interface RedisClientOptions extends RedisOptions {
+    /**
+     * Whether to enable weakDependent mode, the redis client start will not block the application start
+     *
+     * Default to `undefined`
+     */
+    weakDependent?: boolean;
+}
+export interface RedisClusterOptions extends ClusterOptions {
+    cluster: true;
+    nodes: RedisClientOptions[];
+}
+export interface RedisConfig {
+    /**
+     * Default redis client config
+     *
+     * Default to `{}`
+     */
+    default: RedisClientOptions;
+    /**
+     * Single Redis or Cluster Redis config
+     */
+    client?: RedisClientOptions | RedisClusterOptions;
+    /**
+     * Multi Redis config
+     */
+    clients?: Record<string, RedisClientOptions>;
+    /**
+     * redis client will try to use TIME command to detect client is ready or not
+     * if your redis server not support TIME command, please set this config to false
+     * see https://redis.io/commands/time
+     *
+     * Default to `true`
+     */
+    supportTimeCommand: boolean;
+    /**
+     * Whether to enable redis for `app`
+     *
+     * Default to `true`
+     */
+    app: boolean;
+    /**
+     * Whether to enable redis for `agent`
+     *
+     * Default to `false`
+     */
+    agent: boolean;
+    /**
+     * Customize iovalkey version, only set when you needed
+     *
+     * Default to `undefined`, which means using the built-in ioredis
+     */
+    Redis?: any;
+}
+declare const _default: {
+    redis: RedisConfig;
+};
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    redis: {
+        default: {},
+        app: true,
+        agent: false,
+        supportTimeCommand: true,
+        // Single Redis
+        // client: {
+        //   host: 'host',
+        //   port: 'port',
+        //   family: 'user',
+        //   password: 'password',
+        //   db: 'db',
+        // },
+        //
+        // Cluster Redis
+        // client: {
+        //   cluster: true,
+        //   nodes: [{
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   }, {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        // ]},
+        //
+        // Multi Redis
+        // clients: {
+        //   instance1: {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        //   instance2: {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        // },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBMkRBLGtCQUFlO0lBQ2IsS0FBSyxFQUFFO1FBQ0wsT0FBTyxFQUFFLEVBQUU7UUFDWCxHQUFHLEVBQUUsSUFBSTtRQUNULEtBQUssRUFBRSxLQUFLO1FBQ1osa0JBQWtCLEVBQUUsSUFBSTtRQUN4QixlQUFlO1FBQ2YsWUFBWTtRQUNaLGtCQUFrQjtRQUNsQixrQkFBa0I7UUFDbEIsb0JBQW9CO1FBQ3BCLDBCQUEwQjtRQUMxQixjQUFjO1FBQ2QsS0FBSztRQUNMLEVBQUU7UUFDRixnQkFBZ0I7UUFDaEIsWUFBWTtRQUNaLG1CQUFtQjtRQUNuQixjQUFjO1FBQ2Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixTQUFTO1FBQ1Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsTUFBTTtRQUNOLEVBQUU7UUFDRixjQUFjO1FBQ2QsYUFBYTtRQUNiLGlCQUFpQjtRQUNqQixvQkFBb0I7UUFDcEIsb0JBQW9CO1FBQ3BCLHNCQUFzQjtRQUN0Qiw0QkFBNEI7UUFDNUIsZ0JBQWdCO1FBQ2hCLE9BQU87UUFDUCxpQkFBaUI7UUFDakIsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsS0FBSztLQUNTO0NBQ2pCLENBQUMifQ==

package/dist/commonjs/index.d.ts

@@ -0,0 +1 @@
+import './types.js';

package/dist/commonjs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./types.js");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzQkFBb0IifQ==

package/dist/commonjs/lib/redis.d.ts

@@ -0,0 +1,6 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export declare class RedisBoot implements ILifecycleBoot {
+    private readonly app;
+    constructor(app: EggCore);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/lib/redis.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisBoot = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_events_1 = require("node:events");
+const ioredis_1 = require("ioredis");
+class RedisBoot {
+    app;
+    constructor(app) {
+        this.app = app;
+        // empty
+    }
+    async didLoad() {
+        const app = this.app;
+        if (app.type === 'application' && app.config.redis.app) {
+            app.addSingleton('redis', createClient);
+        }
+        else if (app.type === 'agent' && app.config.redis.agent) {
+            app.addSingleton('redis', createClient);
+        }
+    }
+}
+exports.RedisBoot = RedisBoot;
+let count = 0;
+function createClient(options, app) {
+    const RedisClass = app.config.redis.Redis ?? ioredis_1.Redis;
+    let client;
+    if ('cluster' in options && options.cluster === true) {
+        const config = options;
+        (0, node_assert_1.default)(config.nodes && config.nodes.length !== 0, '[@eggjs/redis] cluster nodes configuration is required when use cluster redis');
+        config.nodes.forEach(client => {
+            (0, node_assert_1.default)(client.host && client.port, `[@eggjs/redis] 'host: ${client.host}', 'port: ${client.port}' are required on config`);
+        });
+        app.coreLogger.info('[@eggjs/redis] cluster connecting');
+        client = new RedisClass.Cluster(config.nodes, config);
+    }
+    else if ('sentinels' in options && options.sentinels) {
+        const config = options;
+        (0, node_assert_1.default)(config.sentinels && config.sentinels.length !== 0, '[@eggjs/redis] sentinels configuration is required when use redis sentinel');
+        config.sentinels.forEach(sentinel => {
+            (0, node_assert_1.default)(sentinel.host && sentinel.port, `[@eggjs/redis] 'host: ${sentinel.host}', 'port: ${sentinel.port}' are required on config`);
+        });
+        const mask = config.password ? '***' : config.password;
+        (0, node_assert_1.default)(config.name && config.password !== undefined && config.db !== undefined, `[@eggjs/redis] 'name of master: ${config.name}', 'password: ${mask}', 'db: ${config.db}' are required on config`);
+        app.coreLogger.info('[@eggjs/redis] sentinel connecting start');
+        client = new RedisClass(config);
+    }
+    else {
+        const config = options;
+        const mask = config.password ? '***' : config.password;
+        (0, node_assert_1.default)((config.host && config.port && config.password !== undefined && config.db !== undefined) || config.path, `[@eggjs/redis] 'host: ${config.host}', 'port: ${config.port}', 'password: ${mask}', 'db: ${config.db}' or 'path:${config.path}' are required on config`);
+        if (config.host) {
+            app.coreLogger.info('[@eggjs/redis] server connecting redis://:***@%s:%s/%s', config.host, config.port, config.db);
+        }
+        else {
+            app.coreLogger.info('[@eggjs/redis] server connecting %s', config.path || config);
+        }
+        client = new RedisClass(config);
+    }
+    client.on('connect', () => {
+        app.coreLogger.info('[@eggjs/redis] client connect success');
+    });
+    client.on('error', err => {
+        app.coreLogger.error('[@eggjs/redis] client error: %s', err);
+        app.coreLogger.error(err);
+    });
+    const index = count++;
+    app.lifecycle.registerBeforeStart(async () => {
+        if ('weakDependent' in options && options.weakDependent) {
+            app.coreLogger.info(`[@eggjs/redis] instance[${index}] is weak dependent and won't block app start`);
+            client.once('ready', () => {
+                app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK`);
+            });
+            return;
+        }
+        await Promise.race([
+            (0, node_events_1.once)(client, 'ready'),
+            (0, node_events_1.once)(client, 'error'),
+        ]);
+        app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK, client ready`);
+    }, `[@eggjs/redis] instance[${index}] start check`);
+    return client;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkaXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3JlZGlzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLDhEQUFpQztBQUNqQyw2Q0FBbUM7QUFDbkMscUNBQWdDO0FBSWhDLE1BQWEsU0FBUztJQUNTO0lBQTdCLFlBQTZCLEdBQVk7UUFBWixRQUFHLEdBQUgsR0FBRyxDQUFTO1FBQ3ZDLFFBQVE7SUFDVixDQUFDO0lBQ0QsS0FBSyxDQUFDLE9BQU87UUFDWCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDO1FBQ3JCLElBQUksR0FBRyxDQUFDLElBQUksS0FBSyxhQUFhLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLENBQUM7WUFDdkQsR0FBRyxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsWUFBWSxDQUFDLENBQUM7UUFDMUMsQ0FBQzthQUFNLElBQUksR0FBRyxDQUFDLElBQUksS0FBSyxPQUFPLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFLENBQUM7WUFDMUQsR0FBRyxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsWUFBWSxDQUFDLENBQUM7UUFDMUMsQ0FBQztJQUNILENBQUM7Q0FDRjtBQVpELDhCQVlDO0FBRUQsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDO0FBQ2QsU0FBUyxZQUFZLENBQUMsT0FBaUQsRUFBRSxHQUFZO0lBQ25GLE1BQU0sVUFBVSxHQUFpQixHQUFHLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxLQUFLLElBQUksZUFBSyxDQUFDO0lBQ2pFLElBQUksTUFBTSxDQUFDO0lBRVgsSUFBSSxTQUFTLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxPQUFPLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDckQsTUFBTSxNQUFNLEdBQUcsT0FBOEIsQ0FBQztRQUM5QyxJQUFBLHFCQUFNLEVBQUMsTUFBTSxDQUFDLEtBQUssSUFBSSxNQUFNLENBQUMsS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsK0VBQStFLENBQUMsQ0FBQztRQUVuSSxNQUFNLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsRUFBRTtZQUM1QixJQUFBLHFCQUFNLEVBQUMsTUFBTSxDQUFDLElBQUksSUFBSSxNQUFNLENBQUMsSUFBSSxFQUFFLHlCQUF5QixNQUFNLENBQUMsSUFBSSxhQUFhLE1BQU0sQ0FBQyxJQUFJLDBCQUEwQixDQUFDLENBQUM7UUFDN0gsQ0FBQyxDQUFDLENBQUM7UUFDSCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxtQ0FBbUMsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sR0FBRyxJQUFJLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFhLENBQUMsQ0FBQztJQUMvRCxDQUFDO1NBQU0sSUFBSSxXQUFXLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUN2RCxNQUFNLE1BQU0sR0FBRyxPQUE2QixDQUFDO1FBQzdDLElBQUEscUJBQU0sRUFBQyxNQUFNLENBQUMsU0FBUyxJQUFJLE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSw0RUFBNEUsQ0FBQyxDQUFDO1FBRXhJLE1BQU0sQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1lBQ2xDLElBQUEscUJBQU0sRUFBQyxRQUFRLENBQUMsSUFBSSxJQUFJLFFBQVEsQ0FBQyxJQUFJLEVBQ25DLHlCQUF5QixRQUFRLENBQUMsSUFBSSxhQUFhLFFBQVEsQ0FBQyxJQUFJLDBCQUEwQixDQUFDLENBQUM7UUFDaEcsQ0FBQyxDQUFDLENBQUM7UUFFSCxNQUFNLElBQUksR0FBRyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUM7UUFDdkQsSUFBQSxxQkFBTSxFQUFDLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxTQUFTLElBQUksTUFBTSxDQUFDLEVBQUUsS0FBSyxTQUFTLEVBQzVFLG1DQUFtQyxNQUFNLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxXQUFXLE1BQU0sQ0FBQyxFQUFFLDBCQUEwQixDQUFDLENBQUM7UUFFckgsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMENBQTBDLENBQUMsQ0FBQztRQUNoRSxNQUFNLEdBQUcsSUFBSSxVQUFVLENBQUMsTUFBYSxDQUFDLENBQUM7SUFDekMsQ0FBQztTQUFNLENBQUM7UUFDTixNQUFNLE1BQU0sR0FBRyxPQUE2QixDQUFDO1FBQzdDLE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQztRQUN2RCxJQUFBLHFCQUFNLEVBQUMsQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLFFBQVEsS0FBSyxTQUFTLElBQUksTUFBTSxDQUFDLEVBQUUsS0FBSyxTQUFTLENBQUMsSUFBSSxNQUFNLENBQUMsSUFBSSxFQUM1Ryx5QkFBeUIsTUFBTSxDQUFDLElBQUksYUFBYSxNQUFNLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxXQUFXLE1BQU0sQ0FBQyxFQUFFLGNBQWMsTUFBTSxDQUFDLElBQUksMEJBQTBCLENBQUMsQ0FBQztRQUM1SixJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUNoQixHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyx3REFBd0QsRUFDMUUsTUFBTSxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUN6QyxDQUFDO2FBQU0sQ0FBQztZQUNOLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHFDQUFxQyxFQUN2RCxNQUFNLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxDQUFDO1FBQzNCLENBQUM7UUFFRCxNQUFNLEdBQUcsSUFBSSxVQUFVLENBQUMsTUFBYSxDQUFDLENBQUM7SUFDekMsQ0FBQztJQUVELE1BQU0sQ0FBQyxFQUFFLENBQUMsU0FBUyxFQUFFLEdBQUcsRUFBRTtRQUN4QixHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyx1Q0FBdUMsQ0FBQyxDQUFDO0lBQy9ELENBQUMsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxDQUFDLEVBQUU7UUFDdkIsR0FBRyxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsaUNBQWlDLEVBQUUsR0FBRyxDQUFDLENBQUM7UUFDN0QsR0FBRyxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDNUIsQ0FBQyxDQUFDLENBQUM7SUFFSCxNQUFNLEtBQUssR0FBRyxLQUFLLEVBQUUsQ0FBQztJQUN0QixHQUFHLENBQUMsU0FBUyxDQUFDLG1CQUFtQixDQUFDLEtBQUssSUFBSSxFQUFFO1FBQzNDLElBQUksZUFBZSxJQUFJLE9BQU8sSUFBSSxPQUFPLENBQUMsYUFBYSxFQUFFLENBQUM7WUFDeEQsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEtBQUssK0NBQStDLENBQUMsQ0FBQztZQUNyRyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxHQUFHLEVBQUU7Z0JBQ3hCLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLDJCQUEyQixLQUFLLGFBQWEsQ0FBQyxDQUFDO1lBQ3JFLENBQUMsQ0FBQyxDQUFDO1lBQ0gsT0FBTztRQUNULENBQUM7UUFFRCxNQUFNLE9BQU8sQ0FBQyxJQUFJLENBQUM7WUFDakIsSUFBQSxrQkFBSSxFQUFDLE1BQU0sRUFBRSxPQUFPLENBQUM7WUFDckIsSUFBQSxrQkFBSSxFQUFDLE1BQU0sRUFBRSxPQUFPLENBQUM7U0FDdEIsQ0FBQyxDQUFDO1FBQ0gsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEtBQUssMkJBQTJCLENBQUMsQ0FBQztJQUNuRixDQUFDLEVBQUUsMkJBQTJCLEtBQUssZUFBZSxDQUFDLENBQUM7SUFFcEQsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyJ9

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/types.d.ts

@@ -0,0 +1,11 @@
+import type { Singleton } from '@eggjs/core';
+import type { Redis } from 'ioredis';
+import type { RedisConfig } from './config/config.default.js';
+declare module '@eggjs/core' {
+    interface EggAppConfig {
+        redis: RedisConfig;
+    }
+    interface EggCore {
+        redis: Redis & Singleton<Redis>;
+    }
+}

package/dist/commonjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/esm/agent.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;

package/dist/esm/agent.js

@@ -0,0 +1,3 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRTNDLGVBQWUsU0FBUyxDQUFDIn0=

package/dist/esm/app.d.ts

@@ -0,0 +1,2 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;

package/dist/esm/app.js

@@ -0,0 +1,3 @@
+import { RedisBoot } from './lib/redis.js';
+export default RedisBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFFM0MsZUFBZSxTQUFTLENBQUMifQ==

package/dist/esm/config/config.default.d.ts

@@ -0,0 +1,59 @@
+import type { RedisOptions, ClusterOptions } from 'ioredis';
+export interface RedisClientOptions extends RedisOptions {
+    /**
+     * Whether to enable weakDependent mode, the redis client start will not block the application start
+     *
+     * Default to `undefined`
+     */
+    weakDependent?: boolean;
+}
+export interface RedisClusterOptions extends ClusterOptions {
+    cluster: true;
+    nodes: RedisClientOptions[];
+}
+export interface RedisConfig {
+    /**
+     * Default redis client config
+     *
+     * Default to `{}`
+     */
+    default: RedisClientOptions;
+    /**
+     * Single Redis or Cluster Redis config
+     */
+    client?: RedisClientOptions | RedisClusterOptions;
+    /**
+     * Multi Redis config
+     */
+    clients?: Record<string, RedisClientOptions>;
+    /**
+     * redis client will try to use TIME command to detect client is ready or not
+     * if your redis server not support TIME command, please set this config to false
+     * see https://redis.io/commands/time
+     *
+     * Default to `true`
+     */
+    supportTimeCommand: boolean;
+    /**
+     * Whether to enable redis for `app`
+     *
+     * Default to `true`
+     */
+    app: boolean;
+    /**
+     * Whether to enable redis for `agent`
+     *
+     * Default to `false`
+     */
+    agent: boolean;
+    /**
+     * Customize iovalkey version, only set when you needed
+     *
+     * Default to `undefined`, which means using the built-in ioredis
+     */
+    Redis?: any;
+}
+declare const _default: {
+    redis: RedisConfig;
+};
+export default _default;

package/dist/esm/config/config.default.js

@@ -0,0 +1,53 @@
+export default {
+    redis: {
+        default: {},
+        app: true,
+        agent: false,
+        supportTimeCommand: true,
+        // Single Redis
+        // client: {
+        //   host: 'host',
+        //   port: 'port',
+        //   family: 'user',
+        //   password: 'password',
+        //   db: 'db',
+        // },
+        //
+        // Cluster Redis
+        // client: {
+        //   cluster: true,
+        //   nodes: [{
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   }, {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        // ]},
+        //
+        // Multi Redis
+        // clients: {
+        //   instance1: {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        //   instance2: {
+        //     host: 'host',
+        //     port: 'port',
+        //     family: 'user',
+        //     password: 'password',
+        //     db: 'db',
+        //   },
+        // },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQTJEQSxlQUFlO0lBQ2IsS0FBSyxFQUFFO1FBQ0wsT0FBTyxFQUFFLEVBQUU7UUFDWCxHQUFHLEVBQUUsSUFBSTtRQUNULEtBQUssRUFBRSxLQUFLO1FBQ1osa0JBQWtCLEVBQUUsSUFBSTtRQUN4QixlQUFlO1FBQ2YsWUFBWTtRQUNaLGtCQUFrQjtRQUNsQixrQkFBa0I7UUFDbEIsb0JBQW9CO1FBQ3BCLDBCQUEwQjtRQUMxQixjQUFjO1FBQ2QsS0FBSztRQUNMLEVBQUU7UUFDRixnQkFBZ0I7UUFDaEIsWUFBWTtRQUNaLG1CQUFtQjtRQUNuQixjQUFjO1FBQ2Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixTQUFTO1FBQ1Qsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsTUFBTTtRQUNOLEVBQUU7UUFDRixjQUFjO1FBQ2QsYUFBYTtRQUNiLGlCQUFpQjtRQUNqQixvQkFBb0I7UUFDcEIsb0JBQW9CO1FBQ3BCLHNCQUFzQjtRQUN0Qiw0QkFBNEI7UUFDNUIsZ0JBQWdCO1FBQ2hCLE9BQU87UUFDUCxpQkFBaUI7UUFDakIsb0JBQW9CO1FBQ3BCLG9CQUFvQjtRQUNwQixzQkFBc0I7UUFDdEIsNEJBQTRCO1FBQzVCLGdCQUFnQjtRQUNoQixPQUFPO1FBQ1AsS0FBSztLQUNTO0NBQ2pCLENBQUMifQ==

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+import './types.js';

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+import './types.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxZQUFZLENBQUMifQ==

package/dist/esm/lib/redis.d.ts

@@ -0,0 +1,6 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export declare class RedisBoot implements ILifecycleBoot {
+    private readonly app;
+    constructor(app: EggCore);
+    didLoad(): Promise<void>;
+}

package/dist/esm/lib/redis.js

@@ -0,0 +1,80 @@
+import assert from 'node:assert';
+import { once } from 'node:events';
+import { Redis } from 'ioredis';
+export class RedisBoot {
+    app;
+    constructor(app) {
+        this.app = app;
+        // empty
+    }
+    async didLoad() {
+        const app = this.app;
+        if (app.type === 'application' && app.config.redis.app) {
+            app.addSingleton('redis', createClient);
+        }
+        else if (app.type === 'agent' && app.config.redis.agent) {
+            app.addSingleton('redis', createClient);
+        }
+    }
+}
+let count = 0;
+function createClient(options, app) {
+    const RedisClass = app.config.redis.Redis ?? Redis;
+    let client;
+    if ('cluster' in options && options.cluster === true) {
+        const config = options;
+        assert(config.nodes && config.nodes.length !== 0, '[@eggjs/redis] cluster nodes configuration is required when use cluster redis');
+        config.nodes.forEach(client => {
+            assert(client.host && client.port, `[@eggjs/redis] 'host: ${client.host}', 'port: ${client.port}' are required on config`);
+        });
+        app.coreLogger.info('[@eggjs/redis] cluster connecting');
+        client = new RedisClass.Cluster(config.nodes, config);
+    }
+    else if ('sentinels' in options && options.sentinels) {
+        const config = options;
+        assert(config.sentinels && config.sentinels.length !== 0, '[@eggjs/redis] sentinels configuration is required when use redis sentinel');
+        config.sentinels.forEach(sentinel => {
+            assert(sentinel.host && sentinel.port, `[@eggjs/redis] 'host: ${sentinel.host}', 'port: ${sentinel.port}' are required on config`);
+        });
+        const mask = config.password ? '***' : config.password;
+        assert(config.name && config.password !== undefined && config.db !== undefined, `[@eggjs/redis] 'name of master: ${config.name}', 'password: ${mask}', 'db: ${config.db}' are required on config`);
+        app.coreLogger.info('[@eggjs/redis] sentinel connecting start');
+        client = new RedisClass(config);
+    }
+    else {
+        const config = options;
+        const mask = config.password ? '***' : config.password;
+        assert((config.host && config.port && config.password !== undefined && config.db !== undefined) || config.path, `[@eggjs/redis] 'host: ${config.host}', 'port: ${config.port}', 'password: ${mask}', 'db: ${config.db}' or 'path:${config.path}' are required on config`);
+        if (config.host) {
+            app.coreLogger.info('[@eggjs/redis] server connecting redis://:***@%s:%s/%s', config.host, config.port, config.db);
+        }
+        else {
+            app.coreLogger.info('[@eggjs/redis] server connecting %s', config.path || config);
+        }
+        client = new RedisClass(config);
+    }
+    client.on('connect', () => {
+        app.coreLogger.info('[@eggjs/redis] client connect success');
+    });
+    client.on('error', err => {
+        app.coreLogger.error('[@eggjs/redis] client error: %s', err);
+        app.coreLogger.error(err);
+    });
+    const index = count++;
+    app.lifecycle.registerBeforeStart(async () => {
+        if ('weakDependent' in options && options.weakDependent) {
+            app.coreLogger.info(`[@eggjs/redis] instance[${index}] is weak dependent and won't block app start`);
+            client.once('ready', () => {
+                app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK`);
+            });
+            return;
+        }
+        await Promise.race([
+            once(client, 'ready'),
+            once(client, 'error'),
+        ]);
+        app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK, client ready`);
+    }, `[@eggjs/redis] instance[${index}] start check`);
+    return client;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkaXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3JlZGlzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sTUFBTSxNQUFNLGFBQWEsQ0FBQztBQUNqQyxPQUFPLEVBQUUsSUFBSSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQ25DLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxTQUFTLENBQUM7QUFJaEMsTUFBTSxPQUFPLFNBQVM7SUFDUztJQUE3QixZQUE2QixHQUFZO1FBQVosUUFBRyxHQUFILEdBQUcsQ0FBUztRQUN2QyxRQUFRO0lBQ1YsQ0FBQztJQUNELEtBQUssQ0FBQyxPQUFPO1FBQ1gsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQztRQUNyQixJQUFJLEdBQUcsQ0FBQyxJQUFJLEtBQUssYUFBYSxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBQ3ZELEdBQUcsQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQyxDQUFDO1FBQzFDLENBQUM7YUFBTSxJQUFJLEdBQUcsQ0FBQyxJQUFJLEtBQUssT0FBTyxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzFELEdBQUcsQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQyxDQUFDO1FBQzFDLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUFFRCxJQUFJLEtBQUssR0FBRyxDQUFDLENBQUM7QUFDZCxTQUFTLFlBQVksQ0FBQyxPQUFpRCxFQUFFLEdBQVk7SUFDbkYsTUFBTSxVQUFVLEdBQWlCLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEtBQUssSUFBSSxLQUFLLENBQUM7SUFDakUsSUFBSSxNQUFNLENBQUM7SUFFWCxJQUFJLFNBQVMsSUFBSSxPQUFPLElBQUksT0FBTyxDQUFDLE9BQU8sS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUNyRCxNQUFNLE1BQU0sR0FBRyxPQUE4QixDQUFDO1FBQzlDLE1BQU0sQ0FBQyxNQUFNLENBQUMsS0FBSyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRSwrRUFBK0UsQ0FBQyxDQUFDO1FBRW5JLE1BQU0sQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFO1lBQzVCLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUseUJBQXlCLE1BQU0sQ0FBQyxJQUFJLGFBQWEsTUFBTSxDQUFDLElBQUksMEJBQTBCLENBQUMsQ0FBQztRQUM3SCxDQUFDLENBQUMsQ0FBQztRQUNILEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLG1DQUFtQyxDQUFDLENBQUM7UUFDekQsTUFBTSxHQUFHLElBQUksVUFBVSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUFFLE1BQWEsQ0FBQyxDQUFDO0lBQy9ELENBQUM7U0FBTSxJQUFJLFdBQVcsSUFBSSxPQUFPLElBQUksT0FBTyxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3ZELE1BQU0sTUFBTSxHQUFHLE9BQTZCLENBQUM7UUFDN0MsTUFBTSxDQUFDLE1BQU0sQ0FBQyxTQUFTLElBQUksTUFBTSxDQUFDLFNBQVMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLDRFQUE0RSxDQUFDLENBQUM7UUFFeEksTUFBTSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLEVBQUU7WUFDbEMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLElBQUksUUFBUSxDQUFDLElBQUksRUFDbkMseUJBQXlCLFFBQVEsQ0FBQyxJQUFJLGFBQWEsUUFBUSxDQUFDLElBQUksMEJBQTBCLENBQUMsQ0FBQztRQUNoRyxDQUFDLENBQUMsQ0FBQztRQUVILE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQztRQUN2RCxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksSUFBSSxNQUFNLENBQUMsUUFBUSxLQUFLLFNBQVMsSUFBSSxNQUFNLENBQUMsRUFBRSxLQUFLLFNBQVMsRUFDNUUsbUNBQW1DLE1BQU0sQ0FBQyxJQUFJLGlCQUFpQixJQUFJLFdBQVcsTUFBTSxDQUFDLEVBQUUsMEJBQTBCLENBQUMsQ0FBQztRQUVySCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQywwQ0FBMEMsQ0FBQyxDQUFDO1FBQ2hFLE1BQU0sR0FBRyxJQUFJLFVBQVUsQ0FBQyxNQUFhLENBQUMsQ0FBQztJQUN6QyxDQUFDO1NBQU0sQ0FBQztRQUNOLE1BQU0sTUFBTSxHQUFHLE9BQTZCLENBQUM7UUFDN0MsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDO1FBQ3ZELE1BQU0sQ0FBQyxDQUFDLE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLElBQUksSUFBSSxNQUFNLENBQUMsUUFBUSxLQUFLLFNBQVMsSUFBSSxNQUFNLENBQUMsRUFBRSxLQUFLLFNBQVMsQ0FBQyxJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQzVHLHlCQUF5QixNQUFNLENBQUMsSUFBSSxhQUFhLE1BQU0sQ0FBQyxJQUFJLGlCQUFpQixJQUFJLFdBQVcsTUFBTSxDQUFDLEVBQUUsY0FBYyxNQUFNLENBQUMsSUFBSSwwQkFBMEIsQ0FBQyxDQUFDO1FBQzVKLElBQUksTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ2hCLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHdEQUF3RCxFQUMxRSxNQUFNLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQ3pDLENBQUM7YUFBTSxDQUFDO1lBQ04sR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMscUNBQXFDLEVBQ3ZELE1BQU0sQ0FBQyxJQUFJLElBQUksTUFBTSxDQUFDLENBQUM7UUFDM0IsQ0FBQztRQUVELE1BQU0sR0FBRyxJQUFJLFVBQVUsQ0FBQyxNQUFhLENBQUMsQ0FBQztJQUN6QyxDQUFDO0lBRUQsTUFBTSxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFO1FBQ3hCLEdBQUcsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHVDQUF1QyxDQUFDLENBQUM7SUFDL0QsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsRUFBRTtRQUN2QixHQUFHLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxpQ0FBaUMsRUFBRSxHQUFHLENBQUMsQ0FBQztRQUM3RCxHQUFHLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUM1QixDQUFDLENBQUMsQ0FBQztJQUVILE1BQU0sS0FBSyxHQUFHLEtBQUssRUFBRSxDQUFDO0lBQ3RCLEdBQUcsQ0FBQyxTQUFTLENBQUMsbUJBQW1CLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDM0MsSUFBSSxlQUFlLElBQUksT0FBTyxJQUFJLE9BQU8sQ0FBQyxhQUFhLEVBQUUsQ0FBQztZQUN4RCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQywyQkFBMkIsS0FBSywrQ0FBK0MsQ0FBQyxDQUFDO1lBQ3JHLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRTtnQkFDeEIsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEtBQUssYUFBYSxDQUFDLENBQUM7WUFDckUsQ0FBQyxDQUFDLENBQUM7WUFDSCxPQUFPO1FBQ1QsQ0FBQztRQUVELE1BQU0sT0FBTyxDQUFDLElBQUksQ0FBQztZQUNqQixJQUFJLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQztZQUNyQixJQUFJLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQztTQUN0QixDQUFDLENBQUM7UUFDSCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQywyQkFBMkIsS0FBSywyQkFBMkIsQ0FBQyxDQUFDO0lBQ25GLENBQUMsRUFBRSwyQkFBMkIsS0FBSyxlQUFlLENBQUMsQ0FBQztJQUVwRCxPQUFPLE1BQU0sQ0FBQztBQUNoQixDQUFDIn0=

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/types.d.ts

@@ -0,0 +1,11 @@
+import type { Singleton } from '@eggjs/core';
+import type { Redis } from 'ioredis';
+import type { RedisConfig } from './config/config.default.js';
+declare module '@eggjs/core' {
+    interface EggAppConfig {
+        redis: RedisConfig;
+    }
+    interface EggCore {
+        redis: Redis & Singleton<Redis>;
+    }
+}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@eggjs/redis",
+  "version": "3.0.0"
+}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@eggjs/redis",
+  "version": "3.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Valkey / Redis plugin for egg",
+  "eggPlugin": {
+    "name": "redis",
+    "exports": {
+      "import": "./dist/esm",
+      "require": "./dist/commonjs",
+      "typescript": "./src"
+    }
+  },
+  "keywords": [
+    "egg",
+    "eggPlugin",
+    "egg-plugin",
+    "redis",
+    "Valkey",
+    "database"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eggjs/redis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eggjs/egg/issues"
+  },
+  "homepage": "https://github.com/eggjs/redis#readme",
+  "author": "jtyjty99999",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 18.19.0"
+  },
+  "dependencies": {
+    "@eggjs/core": "^6.3.0",
+    "ioredis": "^5.4.2"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.1",
+    "@eggjs/bin": "7",
+    "@eggjs/mock": "^6.0.5",
+    "@eggjs/tsconfig": "1",
+    "@types/mocha": "10",
+    "@types/node": "22",
+    "egg": "^4.0.3",
+    "eslint": "8",
+    "eslint-config-egg": "14",
+    "rimraf": "6",
+    "snap-shot-it": "^7.9.10",
+    "tshy": "3",
+    "tshy-after": "1",
+    "typescript": "5"
+  },
+  "scripts": {
+    "lint": "eslint --cache src test --ext .ts",
+    "pretest": "npm run clean && npm run lint -- --fix",
+    "test": "egg-bin test",
+    "preci": "npm run clean &&  npm run lint",
+    "ci": "egg-bin cov",
+    "postci": "npm run prepublishOnly && npm run clean",
+    "clean": "rimraf dist",
+    "prepublishOnly": "tshy && tshy-after && attw --pack"
+  },
+  "type": "module",
+  "tshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "types": "./dist/commonjs/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/esm/index.js"
+}

package/src/agent.ts

@@ -0,0 +1,3 @@
+import { RedisBoot } from './lib/redis.js';
+
+export default RedisBoot;

package/src/app.ts

@@ -0,0 +1,3 @@
+import { RedisBoot } from './lib/redis.js';
+
+export default RedisBoot;

package/src/config/config.default.ts

@@ -0,0 +1,111 @@
+import type { RedisOptions, ClusterOptions } from 'ioredis';
+
+export interface RedisClientOptions extends RedisOptions {
+  /**
+   * Whether to enable weakDependent mode, the redis client start will not block the application start
+   *
+   * Default to `undefined`
+   */
+  weakDependent?: boolean;
+}
+
+export interface RedisClusterOptions extends ClusterOptions {
+  cluster: true;
+  nodes: RedisClientOptions[];
+}
+
+export interface RedisConfig {
+  /**
+   * Default redis client config
+   *
+   * Default to `{}`
+   */
+  default: RedisClientOptions;
+  /**
+   * Single Redis or Cluster Redis config
+   */
+  client?: RedisClientOptions | RedisClusterOptions;
+  /**
+   * Multi Redis config
+   */
+  clients?: Record<string, RedisClientOptions>;
+  /**
+   * redis client will try to use TIME command to detect client is ready or not
+   * if your redis server not support TIME command, please set this config to false
+   * see https://redis.io/commands/time
+   *
+   * Default to `true`
+   */
+  supportTimeCommand: boolean;
+  /**
+   * Whether to enable redis for `app`
+   *
+   * Default to `true`
+   */
+  app: boolean;
+  /**
+   * Whether to enable redis for `agent`
+   *
+   * Default to `false`
+   */
+  agent: boolean;
+  /**
+   * Customize iovalkey version, only set when you needed
+   *
+   * Default to `undefined`, which means using the built-in ioredis
+   */
+  Redis?: any;
+}
+
+export default {
+  redis: {
+    default: {},
+    app: true,
+    agent: false,
+    supportTimeCommand: true,
+    // Single Redis
+    // client: {
+    //   host: 'host',
+    //   port: 'port',
+    //   family: 'user',
+    //   password: 'password',
+    //   db: 'db',
+    // },
+    //
+    // Cluster Redis
+    // client: {
+    //   cluster: true,
+    //   nodes: [{
+    //     host: 'host',
+    //     port: 'port',
+    //     family: 'user',
+    //     password: 'password',
+    //     db: 'db',
+    //   }, {
+    //     host: 'host',
+    //     port: 'port',
+    //     family: 'user',
+    //     password: 'password',
+    //     db: 'db',
+    //   },
+    // ]},
+    //
+    // Multi Redis
+    // clients: {
+    //   instance1: {
+    //     host: 'host',
+    //     port: 'port',
+    //     family: 'user',
+    //     password: 'password',
+    //     db: 'db',
+    //   },
+    //   instance2: {
+    //     host: 'host',
+    //     port: 'port',
+    //     family: 'user',
+    //     password: 'password',
+    //     db: 'db',
+    //   },
+    // },
+  } as RedisConfig,
+};

package/src/index.ts

@@ -0,0 +1 @@
+import './types.js';

package/src/lib/redis.ts

@@ -0,0 +1,92 @@
+import assert from 'node:assert';
+import { once } from 'node:events';
+import { Redis } from 'ioredis';
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+import type { RedisClusterOptions, RedisClientOptions } from '../config/config.default.js';
+
+export class RedisBoot implements ILifecycleBoot {
+  constructor(private readonly app: EggCore) {
+    // empty
+  }
+  async didLoad() {
+    const app = this.app;
+    if (app.type === 'application' && app.config.redis.app) {
+      app.addSingleton('redis', createClient);
+    } else if (app.type === 'agent' && app.config.redis.agent) {
+      app.addSingleton('redis', createClient);
+    }
+  }
+}
+
+let count = 0;
+function createClient(options: RedisClusterOptions | RedisClientOptions, app: EggCore) {
+  const RedisClass: typeof Redis = app.config.redis.Redis ?? Redis;
+  let client;
+
+  if ('cluster' in options && options.cluster === true) {
+    const config = options as RedisClusterOptions;
+    assert(config.nodes && config.nodes.length !== 0, '[@eggjs/redis] cluster nodes configuration is required when use cluster redis');
+
+    config.nodes.forEach(client => {
+      assert(client.host && client.port, `[@eggjs/redis] 'host: ${client.host}', 'port: ${client.port}' are required on config`);
+    });
+    app.coreLogger.info('[@eggjs/redis] cluster connecting');
+    client = new RedisClass.Cluster(config.nodes, config as any);
+  } else if ('sentinels' in options && options.sentinels) {
+    const config = options as RedisClientOptions;
+    assert(config.sentinels && config.sentinels.length !== 0, '[@eggjs/redis] sentinels configuration is required when use redis sentinel');
+
+    config.sentinels.forEach(sentinel => {
+      assert(sentinel.host && sentinel.port,
+        `[@eggjs/redis] 'host: ${sentinel.host}', 'port: ${sentinel.port}' are required on config`);
+    });
+
+    const mask = config.password ? '***' : config.password;
+    assert(config.name && config.password !== undefined && config.db !== undefined,
+      `[@eggjs/redis] 'name of master: ${config.name}', 'password: ${mask}', 'db: ${config.db}' are required on config`);
+
+    app.coreLogger.info('[@eggjs/redis] sentinel connecting start');
+    client = new RedisClass(config as any);
+  } else {
+    const config = options as RedisClientOptions;
+    const mask = config.password ? '***' : config.password;
+    assert((config.host && config.port && config.password !== undefined && config.db !== undefined) || config.path,
+      `[@eggjs/redis] 'host: ${config.host}', 'port: ${config.port}', 'password: ${mask}', 'db: ${config.db}' or 'path:${config.path}' are required on config`);
+    if (config.host) {
+      app.coreLogger.info('[@eggjs/redis] server connecting redis://:***@%s:%s/%s',
+        config.host, config.port, config.db);
+    } else {
+      app.coreLogger.info('[@eggjs/redis] server connecting %s',
+        config.path || config);
+    }
+
+    client = new RedisClass(config as any);
+  }
+
+  client.on('connect', () => {
+    app.coreLogger.info('[@eggjs/redis] client connect success');
+  });
+  client.on('error', err => {
+    app.coreLogger.error('[@eggjs/redis] client error: %s', err);
+    app.coreLogger.error(err);
+  });
+
+  const index = count++;
+  app.lifecycle.registerBeforeStart(async () => {
+    if ('weakDependent' in options && options.weakDependent) {
+      app.coreLogger.info(`[@eggjs/redis] instance[${index}] is weak dependent and won't block app start`);
+      client.once('ready', () => {
+        app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK`);
+      });
+      return;
+    }
+
+    await Promise.race([
+      once(client, 'ready'),
+      once(client, 'error'),
+    ]);
+    app.coreLogger.info(`[@eggjs/redis] instance[${index}] status OK, client ready`);
+  }, `[@eggjs/redis] instance[${index}] start check`);
+
+  return client;
+}

package/src/types.ts

@@ -0,0 +1,14 @@
+import type { Singleton } from '@eggjs/core';
+import type { Redis } from 'ioredis';
+import type { RedisConfig } from './config/config.default.js';
+
+declare module '@eggjs/core' {
+  // add EggAppConfig overrides types
+  interface EggAppConfig {
+    redis: RedisConfig;
+  }
+
+  interface EggCore {
+    redis: Redis & Singleton<Redis>;
+  }
+}

package/src/typings/index.d.ts

@@ -0,0 +1,4 @@
+// make sure to import egg typings and let typescript know about it
+// @see https://github.com/whxaxes/blog/issues/11
+// and https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+import 'egg';