@eggjs/redis 4.0.2-beta.1 → 4.0.2-beta.3

package/README.md

@@ -277,6 +277,49 @@ Stop test redis service
 docker compose -f docker-compose.yml down
 ```
 
+## Using ioredis-mock for Unit Tests
+
+You can use [ioredis-mock](https://github.com/stipsan/ioredis-mock) to replace the real Redis client in unit tests. This eliminates the need for a running Redis server during testing, making your CI faster and local development simpler.
+
+### Install
+
+```bash
+npm i --save-dev ioredis-mock @types/ioredis-mock
+```
+
+### Configure
+
+In your test config (e.g., `config/config.unittest.ts`), override the `Redis` class:
+
+```ts
+import RedisMock from 'ioredis-mock';
+import type { EggAppInfo, PartialEggConfig } from 'egg';
+
+export default function (_appInfo: EggAppInfo): PartialEggConfig {
+  return {
+    redis: {
+      Redis: RedisMock,
+      client: {
+        host: '127.0.0.1',
+        port: 6379,
+        password: '',
+        db: 0,
+        weakDependent: true,
+      },
+    },
+  };
+}
+```
+
+> **Important**: You must set `weakDependent: true` when using `ioredis-mock`. Mock clients emit the `ready` event synchronously during construction, before the plugin's listener is attached. Without `weakDependent: true`, the app will hang on startup waiting for a `ready` event that was already emitted.
+
+### Notes
+
+- `ioredis-mock` provides an in-memory Redis implementation that supports most common commands (`get`, `set`, `setex`, `del`, `incr`, `zadd`, `zpopmin`, `zcount`, etc.)
+- Each test worker gets an isolated in-memory Redis instance
+- For production deployment testing, you should still use a real Redis server
+- You can remove `redis` service containers from your CI workflow when using `ioredis-mock` for unit tests
+
 ## Questions & Suggestions
 
 Please open an issue [here](https://github.com/eggjs/egg/issues).

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

@@ -49,7 +49,28 @@ interface RedisConfig {
   */
   agent: boolean;
   /**
-  * Customize iovalkey version, only set when you needed
+  * Customize Redis client class. Use this to replace ioredis with a compatible
+  * alternative, such as iovalkey or ioredis-mock for unit testing.
+  *
+  * When using ioredis-mock, you must also set `weakDependent: true` in the
+  * client config to avoid startup hangs (mock clients emit 'ready' synchronously
+  * before the plugin's listener is attached).
+  *
+  * @example
+  * ```ts
+  * // config/config.unittest.ts
+  * import RedisMock from 'ioredis-mock';
+  * import type { EggAppInfo, PartialEggConfig } from 'egg';
+  *
+  * export default function (_appInfo: EggAppInfo): PartialEggConfig {
+  *   return {
+  *     redis: {
+  *       Redis: RedisMock,
+  *       client: { host: '127.0.0.1', port: 6379, password: '', db: 0, weakDependent: true },
+  *     },
+  *   };
+  * }
+  * ```
   *
   * Default to `undefined`, which means using the built-in ioredis
   */

package/dist/lib/redis.js

@@ -1,6 +1,6 @@
 import assert from "node:assert";
 import { once } from "node:events";
-import { Redis } from "ioredis";
+import IoRedis from "ioredis";
 
 //#region src/lib/redis.ts
 var RedisBoot = class {
@@ -16,7 +16,7 @@ var RedisBoot = class {
 };
 let count = 0;
 function createClient(options, app) {
-	const RedisClass = app.config.redis.Redis ?? Redis;
+	const RedisClass = app.config.redis.Redis ?? IoRedis;
 	let client;
 	if ("cluster" in options && options.cluster === true) {
 		const config = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/redis",
-  "version": "4.0.2-beta.1",
+  "version": "4.0.2-beta.3",
   "description": "Valkey / Redis plugin for egg",
   "keywords": [
     "Valkey",
@@ -46,13 +46,14 @@
   "devDependencies": {
     "@types/node": "^24.10.2",
     "detect-port": "^2.1.0",
+    "ioredis-mock": "^8.13.1",
     "typescript": "^5.9.3",
-    "@eggjs/mock": "7.0.2-beta.1",
-    "@eggjs/tsconfig": "3.1.2-beta.1",
-    "egg": "4.1.2-beta.1"
+    "@eggjs/mock": "7.0.2-beta.3",
+    "egg": "4.1.2-beta.3",
+    "@eggjs/tsconfig": "3.1.2-beta.3"
   },
   "peerDependencies": {
-    "egg": "4.1.2-beta.1"
+    "egg": "4.1.2-beta.3"
   },
   "engines": {
     "node": ">= 22.18.0"