@digitalwalletcorp/redis-pooling 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 digitalwalletcorp
+
+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,156 @@
+# Redis Pooling
+
+[![NPM Version](https://img.shields.io/npm/v/%40digitalwalletcorp%2Fredis-pooling)](https://www.npmjs.com/package/@digitalwalletcorp/redis-pooling) [![License](https://img.shields.io/npm/l/%40digitalwalletcorp%2Fredis-pooling)](https://opensource.org/licenses/MIT) [![Build Status](https://img.shields.io/github/actions/workflow/status/digitalwalletcorp/redis-pooling/ci.yml?branch=main)](https://github.com/digitalwalletcorp/redis-pooling/actions) [![Test Coverage](https://img.shields.io/codecov/c/github/digitalwalletcorp/redis-pooling.svg)](https://codecov.io/gh/digitalwalletcorp/redis-pooling)
+
+A lightweight TypeScript/JavaScript library for managing Redis connections with pooling support.
+Designed for both server-side Node.js applications and cron-style background jobs, it wraps ioredis clients in a pool with safe acquire/release methods, connection validation, and optional custom utility functions like getKeys and deleteKeys.
+
+#### ✨ Features
+
+* **Connection Pooling**: Efficiently manage multiple Redis connections with `min` and `max` pool size configuration.
+* **Safe Acquire/Release**: Guaranteed handling of Redis client lifecycle with optional database selection (`SELECT dbIndex`).
+* **Custom Utilities**: Built-in helper methods like `getKeys(pattern)` and `deleteKeys(pattern)` for convenient Redis key operations.
+* **Connection Validation**: PING-based validation before borrowing from the pool.
+* **TLS Support**: Optional TLS configuration for secure Redis connections.
+
+#### 📦 Instllation
+
+```bash
+npm install @digitalwalletcorp/redis-pooling
+# or
+yarn add @digitalwalletcorp/redis-pooling
+```
+
+#### 📖 Usage
+
+##### Example 1: Pure NodeJS Style Instantiation
+
+This pattern is ideal for short-lived Node.js scripts, such as cron jobs, where a pool is created, used, and destroyed within a single run.
+
+```typescript
+import { createRedisPool, ManagedRedisClient } from '@digitalwalletcorp/redis-pooling';
+
+const redisPool = createRedisPool({
+  url: 'redis://localhost:6379',
+  db: 0,
+  max: 10,
+  min: 2,
+  connectTimeout: 5000,
+  enableTls: false
+});
+
+async function main() {
+  const client: ManagedRedisClient = await redisPool.acquire();
+  try {
+    await client.set('key', 'value');
+    const value = await client.get('key');
+    console.log('Redis value:', value);
+  } finally {
+    await redisPool.release(client);
+  }
+}
+
+main().catch(console.error);
+```
+
+##### Example 2: Singleton Pool Instantiation using Web-App
+
+For long-running web applications, a singleton Redis pool ensures efficient reuse of connections across requests.
+
+
+`@/server/singleton/redis-pooling`
+```typescript
+import { createRedisPool, ManagedRedisClient } from '@digitalwalletcorp/redis-pooling';
+
+export const redisPool = createRedisPool({
+  url: 'redis://localhost:6379',
+  db: 0,
+  max: 20,
+  min: 5,
+  connectTimeout: 5000,
+  enableTls: false
+});
+```
+
+`@/server/api/some-rest-api`
+```typescript
+import { redisPool } from '@/server/singleton/redis-pooling';
+
+async function handleRequest() {
+  const client: ManagedRedisClient = await redisPool.acquire();
+  try {
+    const value = await client.get('session:1234');
+    console.log('Session value:', value);
+  } finally {
+    await redisPool.release(client);
+  }
+}
+```
+
+##### Example 3: Using Custom Methods (`getKeys`, `deleteKeys`)
+
+`ManagedRedisClient` extends the standard `ioredis` client with convenient helper methods.
+`getKeys` and `deleteKeys` use `SCAN` and `UNLINK` internally to avoid blocking Redis with large datasets (unlike `KEYS`).
+All other standard Redis commands remain available.
+
+```typescript
+import { redisPool } from '@/server/singleton/redis-pooling';
+
+async function manageCache() {
+  const client = await redisPool.acquire();
+
+  try {
+    // Get all keys matching a pattern using SCAN (avoids blocking Redis like KEYS does)
+    const keys = await client.getKeys('user:*');
+    console.log('Matching keys:', keys);
+
+    // Delete all matching keys using UNLINK
+    const deleted = await client.deleteKeys('cache:*');
+    console.log(`Deleted ${deleted} keys`);
+  } finally {
+    await redisPool.release(client);
+  }
+}
+```
+
+#### 📚 API Reference
+
+##### `createRedisPool(config: RedisConfig): ManagedRedisPool`
+
+Creates a managed Redis pool.
+
+| Property         | Type    | Default  | Description                            |
+| ---------------- | ------- | -------- | -------------------------------------- |
+| `url`            | string  | required | Redis connection URL.                  |
+| `db`             | number  | 0        | Default Redis database index.          |
+| `connectTimeout` | number  | 5000     | Connection timeout in milliseconds.    |
+| `max`            | number  | 10       | Maximum number of clients in the pool. |
+| `min`            | number  | 0        | Minimum number of clients in the pool. |
+| `enableTls`      | boolean | false    | Enable TLS for Redis connection.       |
+
+##### `ManagedRedisPool` Methods
+
+| Method                                | Signature                     | Description                                                                            |
+| ------------------------------------- | ----------------------------- | -------------------------------------------------------------------------------------- |
+| `acquire(dbIndex?: number)`           | `Promise<ManagedRedisClient>` | Acquire a Redis client from the pool. Optionally switch to a different database index. |
+| `release(client: ManagedRedisClient)` | `Promise<void>`               | Release the Redis client back to the pool.                                             |
+| `destroy()`                           | `Promise<void>`               | Drain and clear all connections in the pool.                                           |
+
+##### `ManagedRedisClient` Methods
+
+Extends the standard `ioredis` `Redis` client with additional helpers:
+
+| Method                        | Signature           | Description                                                                                     |
+| ----------------------------- | ------------------- | ----------------------------------------------------------------------------------------------- |
+| `getKeys(pattern: string)`    | `Promise<string[]>` | Scan and return all keys matching a pattern.                                                    |
+| `deleteKeys(pattern: string)` | `Promise<number>`   | Scan and delete all keys matching a pattern using `UNLINK`. Returns the number of deleted keys. |
+
+---
+#### 💡 Notes
+
+* Always release clients back to the pool using `release(client)` to avoid connection leaks.
+* Use `acquire()` and `release()` inside `try/finally` blocks for safe resource management.
+
+#### 📜 License
+
+This project is licensed under the MIT License. See the [LICENSE](https://opensource.org/licenses/MIT) file for details.

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './redis-pooling';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./redis-pooling"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}

package/lib/redis-pooling.d.ts

@@ -0,0 +1,27 @@
+import { Redis } from 'ioredis';
+export interface RedisConfig {
+    url: string;
+    db?: number;
+    connectTimeout?: number;
+    max?: number;
+    min?: number;
+    testOnBorrow?: boolean;
+    enableTls?: boolean;
+}
+export interface ManagedRedisPool {
+    acquire(dbIndex?: number): Promise<Redis>;
+    release(client?: Redis): Promise<void>;
+    destroy(timeoutMs?: number): Promise<void>;
+}
+export interface ManagedRedisClient extends Redis {
+    getKeys(pattern: string): Promise<string[]>;
+    deleteKeys(pattern: string): Promise<number>;
+    _originalDbIndex?: number;
+}
+/**
+ * Redisコネクションプーリングを生成する
+ *
+ * @param {RedisConfig} config
+ * @returns {ManagedRedisPool}
+ */
+export declare const createRedisPool: (config: RedisConfig) => ManagedRedisPool;

package/lib/redis-pooling.js

@@ -0,0 +1,287 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRedisPool = void 0;
+const ioredis_1 = require("ioredis");
+const genericPool = __importStar(require("generic-pool"));
+const logHeader = '[RedisPooling]';
+const DEFAULT_CONNECT_TIMEOUT = 5000;
+const DEFAULT_MAX_POOLING_SIZE = 10;
+const DEFAULT_MIN_POOLING_SIZE = 0;
+const REDIS_PING_TIMEOUT_MS = 3000; // 3秒
+/**
+ * Redisコネクションプーリングを生成する
+ *
+ * @param {RedisConfig} config
+ * @returns {ManagedRedisPool}
+ */
+const createRedisPool = (config) => {
+    const url = config.url;
+    const db = config.db ?? 0;
+    const connectTimeout = config.connectTimeout ?? DEFAULT_CONNECT_TIMEOUT;
+    const max = config.max ?? DEFAULT_MAX_POOLING_SIZE;
+    const min = config.min ?? DEFAULT_MIN_POOLING_SIZE;
+    const testOnBorrow = config.testOnBorrow ?? true;
+    if (!url) {
+        throw new Error(`${logHeader} Redis connection url is required.`);
+    }
+    // dbIndexごとのプール管理
+    const poolMap = new Map();
+    const createSingleDbPool = (dbIndex) => {
+        const factory = {
+            create: async () => {
+                let client;
+                try {
+                    client = new ioredis_1.Redis(url, {
+                        db: dbIndex,
+                        connectTimeout: connectTimeout,
+                        keepAlive: 1,
+                        enableOfflineQueue: true,
+                        tls: config.enableTls ? { rejectUnauthorized: false } : undefined,
+                        retryStrategy: (times) => {
+                            const delay = Math.min(times * 50, 1000);
+                            if (process.env.NODE_ENV !== 'test') {
+                                console.debug(logHeader, `retry strategy called ${times} times. delaying ${delay}ms`);
+                            }
+                            return delay;
+                        },
+                        reconnectOnError: (error) => {
+                            process.emitWarning(`${logHeader} detected error (on reconnect). ${error.message}`);
+                            return true;
+                        }
+                    });
+                }
+                catch (error) {
+                    console.error(error);
+                    throw error;
+                }
+                client._originalDbIndex = dbIndex;
+                client.on('error', error => {
+                    process.emitWarning(`${logHeader} detected error (on error). ${error.message}`);
+                });
+                // カスタムメソッド START
+                /**
+                 * 指定されたパターンに一致するキーを Redis から全て取得する
+                 *
+                 * @param {string} pattern
+                 * @returns {Promise<string[]>}
+                 */
+                client.getKeys = async function (pattern) {
+                    const allKeys = [];
+                    const stream = this.scanStream({
+                        match: pattern,
+                        count: 1000 // ioredisが1度にスキャンする件数の目安。1000件を超えるデータがあっても全件返却される
+                    });
+                    return new Promise((resolve, reject) => {
+                        stream.on('data', (keys) => {
+                            if (keys.length) {
+                                allKeys.push(...keys);
+                            }
+                        });
+                        stream.on('end', () => resolve(allKeys));
+                        stream.on('error', (err) => {
+                            console.error(logHeader, `Error during getKeys scan for pattern '${pattern}'.`, err);
+                            reject(err);
+                        });
+                    });
+                };
+                /**
+                 * 指定されたパターンに一致するキーを Redis から全て削除する (UNLINKを使用)
+                 *
+                 * @param {string} pattern
+                 * @returns {Promise<number>}
+                 */
+                client.deleteKeys = async function (pattern) {
+                    let deletedCount = 0;
+                    const stream = this.scanStream({
+                        match: pattern,
+                        count: 1000 // 1度にスキャンする件数
+                    });
+                    return new Promise((resolve, reject) => {
+                        const tasks = [];
+                        stream.on('data', async (keys) => {
+                            if (keys.length) {
+                                tasks.push((async () => {
+                                    try {
+                                        // UNLINK を使用し、現在のインスタンス (this) で実行
+                                        const unlinkResult = await this.unlink(...keys);
+                                        deletedCount += unlinkResult;
+                                        console.debug(logHeader, `Deleted ${unlinkResult} keys in a batch for pattern '${pattern}'. Total: ${deletedCount}`);
+                                    }
+                                    catch (error) {
+                                        process.emitWarning(`${logHeader} Error during UNLINK for pattern '${pattern}'. ${error.message}`);
+                                    }
+                                })());
+                            }
+                        });
+                        stream.on('end', async () => {
+                            await Promise.all(tasks);
+                            resolve(deletedCount);
+                        });
+                        stream.on('error', (err) => {
+                            console.error(logHeader, `Error during deleteKeys scan for pattern '${pattern}'.`, err);
+                            reject(err);
+                        });
+                    });
+                };
+                // カスタムメソッド END
+                // 接続が不安定な場合は以下のロジックが生きるかもしれないので残しておく
+                // 動作確認した限りでは以下のロジックはなくても問題なく動作する
+                // await new Promise<void>((resolve, reject) => {
+                //   const onReady = () => {
+                //     cleanup();
+                //     resolve();
+                //   };
+                //   const onError = (error: Error) => {
+                //     cleanup();
+                //     reject(error);
+                //   };
+                //   const cleanup = () => {
+                //     client.off('ready', onReady);
+                //     client.off('error', onError);
+                //   };
+                //   client.once('ready', onReady);
+                //   client.once('error', onError);
+                // });
+                return client;
+            },
+            destroy: async (client) => {
+                try {
+                    await client.quit();
+                    console.debug(logHeader, 'client quit');
+                }
+                catch (error) {
+                    client.disconnect();
+                    console.debug(logHeader, 'client disconnected');
+                }
+            },
+            validate: async (client) => {
+                try {
+                    console.debug(logHeader, 'start validate');
+                    const timeout = new Promise((_, reject) => {
+                        setTimeout(() => reject(new Error(`Redis PING timeout after ${REDIS_PING_TIMEOUT_MS}ms`)), REDIS_PING_TIMEOUT_MS);
+                    });
+                    await Promise.race([
+                        client.ping(),
+                        timeout
+                    ]);
+                    console.debug(logHeader, 'ping succeeded');
+                    return client.status === 'ready';
+                }
+                catch (error) {
+                    console.debug(logHeader, 'ping failed');
+                    return false;
+                }
+            }
+        };
+        return genericPool.createPool(factory, {
+            max,
+            min,
+            testOnBorrow
+        });
+    };
+    const getPool = (dbIndex) => {
+        let pool = poolMap.get(dbIndex);
+        if (!pool) {
+            pool = createSingleDbPool(dbIndex);
+            poolMap.set(dbIndex, pool);
+        }
+        return pool;
+    };
+    return {
+        acquire: async (dbIndex) => {
+            const index = dbIndex ?? 0;
+            const pool = getPool(index);
+            const client = await pool.acquire();
+            console.debug(logHeader, `Redis client ${index} has been acquired.`);
+            return client;
+        },
+        release: async (client) => {
+            if (client) {
+                const dbIndex = client._originalDbIndex ?? db;
+                let needDestroy = false;
+                switch (true) {
+                    case client.status === 'end':
+                    case client.status === 'close':
+                        // Redisクライアントの状態が再利用できない場合はプールから破棄
+                        needDestroy = true;
+                        break;
+                    case client.status === 'ready':
+                        try {
+                            // 元のDBインデックスに戻す
+                            await client.select(dbIndex);
+                        }
+                        catch (error) {
+                            // selectに失敗する→Redisクライアントが不正な状態にあると判断できるのでプールから破棄
+                            needDestroy = true;
+                        }
+                        break;
+                    default:
+                }
+                const pool = poolMap.get(dbIndex);
+                if (pool) {
+                    if (needDestroy) {
+                        // Redisクライアントの破棄
+                        await pool.destroy(client);
+                        console.debug(logHeader, `Redis client ${dbIndex} destroyed due to invalid status.`);
+                    }
+                    else {
+                        // Redisクライアントの返却
+                        await pool.release(client);
+                        console.debug(logHeader, `Redis client ${dbIndex} released.`);
+                    }
+                }
+            }
+        },
+        destroy: async (timeoutMs = 5000) => {
+            for (const [dbIndex, pool] of poolMap.entries()) {
+                console.debug(logHeader, `Destroying Redis pool for DB index ${dbIndex}...`);
+                await Promise.race([
+                    (async () => {
+                        await pool.drain();
+                        await pool.clear();
+                    })(),
+                    new Promise((_, reject) => {
+                        setTimeout(() => reject(new Error(`${logHeader} Timeout while draining Redis pool for DB index ${dbIndex}`)), timeoutMs);
+                    })
+                ]);
+                console.debug(logHeader, `Redis pool for DB index ${dbIndex} destroyed.`);
+                poolMap.delete(dbIndex);
+            }
+        }
+    };
+};
+exports.createRedisPool = createRedisPool;
+//# sourceMappingURL=redis-pooling.js.map

package/lib/redis-pooling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-pooling.js","sourceRoot":"","sources":["../src/redis-pooling.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAgC;AAChC,0DAA4C;AAwB5C,MAAM,SAAS,GAAG,gBAAgB,CAAC;AACnC,MAAM,uBAAuB,GAAG,IAAI,CAAC;AACrC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AACnC,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,KAAK;AAEzC;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,MAAmB,EAAoB,EAAE;IAEvE,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;IACvB,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1B,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,uBAAuB,CAAC;IACxE,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,wBAAwB,CAAC;IACnD,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,wBAAwB,CAAC;IACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC;IAEjD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,oCAAoC,CAAC,CAAC;IACpE,CAAC;IAED,kBAAkB;IAClB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAgD,CAAC;IAExE,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAwC,EAAE;QACnF,MAAM,OAAO,GAA4C;YACvD,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,IAAI,MAAM,CAAC;gBACX,IAAI,CAAC;oBACH,MAAM,GAAG,IAAI,eAAK,CAAC,GAAG,EAAE;wBACtB,EAAE,EAAE,OAAO;wBACX,cAAc,EAAE,cAAc;wBAC9B,SAAS,EAAE,CAAC;wBACZ,kBAAkB,EAAE,IAAI;wBACxB,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;wBACjE,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;4BACvB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;4BACzC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;gCACpC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,yBAAyB,KAAK,oBAAoB,KAAK,IAAI,CAAC,CAAC;4BACxF,CAAC;4BACD,OAAO,KAAK,CAAC;wBACf,CAAC;wBACD,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE;4BAC1B,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;4BACpF,OAAO,IAAI,CAAC;wBACd,CAAC;qBACF,CAAuB,CAAC;gBAC3B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBACrB,MAAM,KAAK,CAAC;gBACd,CAAC;gBAED,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC;gBAClC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;oBACzB,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,+BAA+B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAClF,CAAC,CAAC,CAAC;gBAEH,iBAAiB;gBAEjB;;;;;mBAKG;gBACH,MAAM,CAAC,OAAO,GAAG,KAAK,WAAU,OAAe;oBAC7C,MAAM,OAAO,GAAa,EAAE,CAAC;oBAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;wBAC7B,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,IAAI,CAAC,kDAAkD;qBAC/D,CAAC,CAAC;oBAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;wBACrC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAc,EAAE,EAAE;4BACnC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gCAChB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;4BACxB,CAAC;wBACH,CAAC,CAAC,CAAC;wBACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;wBACzC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;4BAChC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,0CAA0C,OAAO,IAAI,EAAE,GAAG,CAAC,CAAC;4BACrF,MAAM,CAAC,GAAG,CAAC,CAAC;wBACd,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBACF;;;;;mBAKG;gBACH,MAAM,CAAC,UAAU,GAAG,KAAK,WAAU,OAAe;oBAChD,IAAI,YAAY,GAAG,CAAC,CAAC;oBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;wBAC7B,KAAK,EAAE,OAAO;wBACd,KAAK,EAAE,IAAI,CAAC,cAAc;qBAC3B,CAAC,CAAC;oBAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;wBACrC,MAAM,KAAK,GAAoB,EAAE,CAAC;wBAClC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAc,EAAE,EAAE;4BACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gCAChB,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE;oCACrB,IAAI,CAAC;wCACH,mCAAmC;wCACnC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;wCAChD,YAAY,IAAI,YAAY,CAAC;wCAC7B,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,WAAW,YAAY,iCAAiC,OAAO,aAAa,YAAY,EAAE,CAAC,CAAC;oCACvH,CAAC;oCAAC,OAAO,KAAU,EAAE,CAAC;wCACpB,OAAO,CAAC,WAAW,CAAC,GAAG,SAAS,qCAAqC,OAAO,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oCACrG,CAAC;gCACH,CAAC,CAAC,EAAE,CAAC,CAAC;4BACR,CAAC;wBACH,CAAC,CAAC,CAAC;wBACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE;4BAC1B,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;4BACzB,OAAO,CAAC,YAAY,CAAC,CAAC;wBACxB,CAAC,CAAC,CAAC;wBACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;4BAChC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,6CAA6C,OAAO,IAAI,EAAE,GAAG,CAAC,CAAC;4BACxF,MAAM,CAAC,GAAG,CAAC,CAAC;wBACd,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC;gBACF,eAAe;gBAEf,qCAAqC;gBACrC,iCAAiC;gBACjC,iDAAiD;gBACjD,4BAA4B;gBAC5B,iBAAiB;gBACjB,iBAAiB;gBACjB,OAAO;gBACP,wCAAwC;gBACxC,iBAAiB;gBACjB,qBAAqB;gBACrB,OAAO;gBACP,4BAA4B;gBAC5B,oCAAoC;gBACpC,oCAAoC;gBACpC,OAAO;gBACP,mCAAmC;gBACnC,mCAAmC;gBACnC,MAAM;gBAEN,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,MAAa,EAAE,EAAE;gBAC/B,IAAI,CAAC;oBACH,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;gBAC1C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,UAAU,EAAE,CAAC;oBACpB,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC;YACD,QAAQ,EAAE,KAAK,EAAE,MAAa,EAAE,EAAE;gBAChC,IAAI,CAAC;oBACH,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;oBAC3C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;wBAC9C,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,4BAA4B,qBAAqB,IAAI,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;oBACpH,CAAC,CAAC,CAAC;oBACH,MAAM,OAAO,CAAC,IAAI,CAAC;wBACjB,MAAM,CAAC,IAAI,EAAE;wBACb,OAAO;qBACR,CAAC,CAAC;oBACH,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;oBAC3C,OAAO,MAAM,CAAC,MAAM,KAAK,OAAO,CAAC;gBACnC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;oBACxC,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;SACF,CAAC;QAEF,OAAO,WAAW,CAAC,UAAU,CAAC,OAAO,EAAE;YACrC,GAAG;YACH,GAAG;YACH,YAAY;SACb,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,EAAE;QAClC,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,KAAK,EAAE,OAAgB,EAA+B,EAAE;YAC/D,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,CAAC;YAC3B,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,gBAAgB,KAAK,qBAAqB,CAAC,CAAC;YACrE,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,MAA2B,EAAiB,EAAE;YAC5D,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,OAAO,GAAG,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC;gBAC9C,IAAI,WAAW,GAAG,KAAK,CAAC;gBACxB,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC;oBAC7B,KAAK,MAAM,CAAC,MAAM,KAAK,OAAO;wBAC5B,mCAAmC;wBACnC,WAAW,GAAG,IAAI,CAAC;wBACnB,MAAM;oBACR,KAAK,MAAM,CAAC,MAAM,KAAK,OAAO;wBAC5B,IAAI,CAAC;4BACH,gBAAgB;4BAChB,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAC/B,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,kDAAkD;4BAClD,WAAW,GAAG,IAAI,CAAC;wBACrB,CAAC;wBACD,MAAM;oBACR,QAAQ;gBACV,CAAC;gBACD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAClC,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,WAAW,EAAE,CAAC;wBAChB,iBAAiB;wBACjB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAC3B,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,gBAAgB,OAAO,mCAAmC,CAAC,CAAC;oBACvF,CAAC;yBAAM,CAAC;wBACN,iBAAiB;wBACjB,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAC3B,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,gBAAgB,OAAO,YAAY,CAAC,CAAC;oBAChE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI,EAAiB,EAAE;YACjD,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;gBAChD,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,sCAAsC,OAAO,KAAK,CAAC,CAAC;gBAC7E,MAAM,OAAO,CAAC,IAAI,CAAC;oBACjB,CAAC,KAAK,IAAI,EAAE;wBACV,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;wBACnB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;oBACrB,CAAC,CAAC,EAAE;oBACJ,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;wBAC9B,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,SAAS,mDAAmD,OAAO,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;oBAC3H,CAAC,CAAC;iBACH,CAAC,CAAC;gBACH,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE,2BAA2B,OAAO,aAAa,CAAC,CAAC;gBAC1E,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC,CAAC;AAnPW,QAAA,eAAe,mBAmP1B"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@digitalwalletcorp/redis-pooling",
+  "version": "1.0.0",
+  "description": "This is a library for redis connection pooling",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major",
+    "prepack": "rm -rf lib && npm run build",
+    "pack": "rm -rf dest && mkdir -p dest && npm pack --pack-destination=dest",
+    "publish:npm": "bash ../bin/publish.sh",
+    "test:unit": "NODE_OPTIONS=--max-old-space-size=2048 npx jest --runInBand --logHeapUsage --detectOpenHandles --forceExit --errorOnDeprecated --coverage --silent --unhandled-rejections=strict"
+  },
+  "keywords": [
+    "redis",
+    "pooling"
+  ],
+  "author": "satoshi kotaki",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/digitalwalletcorp/redis-pooling.git"
+  },
+  "homepage": "https://github.com/digitalwalletcorp/redis-pooling",
+  "bugs": {
+    "url": "https://github.com/digitalwalletcorp/redis-pooling/issues"
+  },
+  "files": [
+    "lib/**/*",
+    "src/**/*"
+  ],
+  "devDependencies": {
+    "@types/ioredis-mock": "^8.2.6",
+    "@types/jest": "^29.5.14",
+    "ioredis-mock": "^8.13.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "generic-pool": "^3.9.0",
+    "ioredis": "^5.9.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './redis-pooling';

package/src/redis-pooling.ts

@@ -0,0 +1,281 @@
+import { Redis } from 'ioredis';
+import * as genericPool from 'generic-pool';
+
+export interface RedisConfig {
+  url: string;
+  db?: number;
+  connectTimeout?: number;
+  max?: number;
+  min?: number;
+  testOnBorrow?: boolean;
+  enableTls?: boolean;
+}
+
+export interface ManagedRedisPool {
+  acquire(dbIndex?: number): Promise<Redis>;
+  release(client?: Redis): Promise<void>;
+  destroy(timeoutMs?: number): Promise<void>;
+}
+
+export interface ManagedRedisClient extends Redis {
+  getKeys(pattern: string): Promise<string[]>;
+  deleteKeys(pattern: string): Promise<number>;
+  _originalDbIndex?: number; // 内部状態管理用変数
+}
+
+const logHeader = '[RedisPooling]';
+const DEFAULT_CONNECT_TIMEOUT = 5000;
+const DEFAULT_MAX_POOLING_SIZE = 10;
+const DEFAULT_MIN_POOLING_SIZE = 0;
+const REDIS_PING_TIMEOUT_MS = 3000; // 3秒
+
+/**
+ * Redisコネクションプーリングを生成する
+ *
+ * @param {RedisConfig} config
+ * @returns {ManagedRedisPool}
+ */
+export const createRedisPool = (config: RedisConfig): ManagedRedisPool => {
+
+  const url = config.url;
+  const db = config.db ?? 0;
+  const connectTimeout = config.connectTimeout ?? DEFAULT_CONNECT_TIMEOUT;
+  const max = config.max ?? DEFAULT_MAX_POOLING_SIZE;
+  const min = config.min ?? DEFAULT_MIN_POOLING_SIZE;
+  const testOnBorrow = config.testOnBorrow ?? true;
+
+  if (!url) {
+    throw new Error(`${logHeader} Redis connection url is required.`);
+  }
+
+  // dbIndexごとのプール管理
+  const poolMap = new Map<number, genericPool.Pool<ManagedRedisClient>>();
+
+  const createSingleDbPool = (dbIndex: number): genericPool.Pool<ManagedRedisClient> => {
+    const factory: genericPool.Factory<ManagedRedisClient> = {
+      create: async () => {
+        let client;
+        try {
+          client = new Redis(url, {
+            db: dbIndex,
+            connectTimeout: connectTimeout,
+            keepAlive: 1,
+            enableOfflineQueue: true,
+            tls: config.enableTls ? { rejectUnauthorized: false } : undefined,
+            retryStrategy: (times) => {
+              const delay = Math.min(times * 50, 1000);
+              if (process.env.NODE_ENV !== 'test') {
+                console.debug(logHeader, `retry strategy called ${times} times. delaying ${delay}ms`);
+              }
+              return delay;
+            },
+            reconnectOnError: (error) => {
+              process.emitWarning(`${logHeader} detected error (on reconnect). ${error.message}`);
+              return true;
+            }
+          }) as ManagedRedisClient;
+        } catch (error) {
+          console.error(error);
+          throw error;
+        }
+
+        client._originalDbIndex = dbIndex;
+        client.on('error', error => {
+          process.emitWarning(`${logHeader} detected error (on error). ${error.message}`);
+        });
+
+        // カスタムメソッド START
+
+        /**
+         * 指定されたパターンに一致するキーを Redis から全て取得する
+         *
+         * @param {string} pattern
+         * @returns {Promise<string[]>}
+         */
+        client.getKeys = async function(pattern: string): Promise<string[]> {
+          const allKeys: string[] = [];
+          const stream = this.scanStream({
+            match: pattern,
+            count: 1000 // ioredisが1度にスキャンする件数の目安。1000件を超えるデータがあっても全件返却される
+          });
+
+          return new Promise((resolve, reject) => {
+            stream.on('data', (keys: string[]) => {
+              if (keys.length) {
+                allKeys.push(...keys);
+              }
+            });
+            stream.on('end', () => resolve(allKeys));
+            stream.on('error', (err: Error) => {
+              console.error(logHeader, `Error during getKeys scan for pattern '${pattern}'.`, err);
+              reject(err);
+            });
+          });
+        };
+        /**
+         * 指定されたパターンに一致するキーを Redis から全て削除する (UNLINKを使用)
+         *
+         * @param {string} pattern
+         * @returns {Promise<number>}
+         */
+        client.deleteKeys = async function(pattern: string): Promise<number> {
+          let deletedCount = 0;
+          const stream = this.scanStream({
+            match: pattern,
+            count: 1000 // 1度にスキャンする件数
+          });
+
+          return new Promise((resolve, reject) => {
+            const tasks: Promise<void>[] = [];
+            stream.on('data', async (keys: string[]) => {
+              if (keys.length) {
+                tasks.push((async () => {
+                  try {
+                    // UNLINK を使用し、現在のインスタンス (this) で実行
+                    const unlinkResult = await this.unlink(...keys);
+                    deletedCount += unlinkResult;
+                    console.debug(logHeader, `Deleted ${unlinkResult} keys in a batch for pattern '${pattern}'. Total: ${deletedCount}`);
+                  } catch (error: any) {
+                    process.emitWarning(`${logHeader} Error during UNLINK for pattern '${pattern}'. ${error.message}`);
+                  }
+                })());
+              }
+            });
+            stream.on('end', async () => {
+              await Promise.all(tasks);
+              resolve(deletedCount);
+            });
+            stream.on('error', (err: Error) => {
+              console.error(logHeader, `Error during deleteKeys scan for pattern '${pattern}'.`, err);
+              reject(err);
+            });
+          });
+        };
+        // カスタムメソッド END
+
+        // 接続が不安定な場合は以下のロジックが生きるかもしれないので残しておく
+        // 動作確認した限りでは以下のロジックはなくても問題なく動作する
+        // await new Promise<void>((resolve, reject) => {
+        //   const onReady = () => {
+        //     cleanup();
+        //     resolve();
+        //   };
+        //   const onError = (error: Error) => {
+        //     cleanup();
+        //     reject(error);
+        //   };
+        //   const cleanup = () => {
+        //     client.off('ready', onReady);
+        //     client.off('error', onError);
+        //   };
+        //   client.once('ready', onReady);
+        //   client.once('error', onError);
+        // });
+
+        return client;
+      },
+      destroy: async (client: Redis) => {
+        try {
+          await client.quit();
+          console.debug(logHeader, 'client quit');
+        } catch (error) {
+          client.disconnect();
+          console.debug(logHeader, 'client disconnected');
+        }
+      },
+      validate: async (client: Redis) => {
+        try {
+          console.debug(logHeader, 'start validate');
+          const timeout = new Promise<void>((_, reject) => {
+            setTimeout(() => reject(new Error(`Redis PING timeout after ${REDIS_PING_TIMEOUT_MS}ms`)), REDIS_PING_TIMEOUT_MS);
+          });
+          await Promise.race([
+            client.ping(),
+            timeout
+          ]);
+          console.debug(logHeader, 'ping succeeded');
+          return client.status === 'ready';
+        } catch (error) {
+          console.debug(logHeader, 'ping failed');
+          return false;
+        }
+      }
+    };
+
+    return genericPool.createPool(factory, {
+      max,
+      min,
+      testOnBorrow
+    });
+  };
+
+  const getPool = (dbIndex: number) => {
+    let pool = poolMap.get(dbIndex);
+    if (!pool) {
+      pool = createSingleDbPool(dbIndex);
+      poolMap.set(dbIndex, pool);
+    }
+    return pool;
+  };
+
+  return {
+    acquire: async (dbIndex?: number): Promise<ManagedRedisClient> => {
+      const index = dbIndex ?? 0;
+      const pool = getPool(index);
+      const client = await pool.acquire();
+      console.debug(logHeader, `Redis client ${index} has been acquired.`);
+      return client;
+    },
+    release: async (client?: ManagedRedisClient): Promise<void> => {
+      if (client) {
+        const dbIndex = client._originalDbIndex ?? db;
+        let needDestroy = false;
+        switch (true) {
+          case client.status === 'end':
+          case client.status === 'close':
+            // Redisクライアントの状態が再利用できない場合はプールから破棄
+            needDestroy = true;
+            break;
+          case client.status === 'ready':
+            try {
+              // 元のDBインデックスに戻す
+              await client.select(dbIndex);
+            } catch (error) {
+              // selectに失敗する→Redisクライアントが不正な状態にあると判断できるのでプールから破棄
+              needDestroy = true;
+            }
+            break;
+          default:
+        }
+        const pool = poolMap.get(dbIndex);
+        if (pool) {
+          if (needDestroy) {
+            // Redisクライアントの破棄
+            await pool.destroy(client);
+            console.debug(logHeader, `Redis client ${dbIndex} destroyed due to invalid status.`);
+          } else {
+            // Redisクライアントの返却
+            await pool.release(client);
+            console.debug(logHeader, `Redis client ${dbIndex} released.`);
+          }
+        }
+      }
+    },
+    destroy: async (timeoutMs = 5000): Promise<void> => {
+      for (const [dbIndex, pool] of poolMap.entries()) {
+        console.debug(logHeader, `Destroying Redis pool for DB index ${dbIndex}...`);
+        await Promise.race([
+          (async () => {
+            await pool.drain();
+            await pool.clear();
+          })(),
+          new Promise<void>((_, reject) => {
+            setTimeout(() => reject(new Error(`${logHeader} Timeout while draining Redis pool for DB index ${dbIndex}`)), timeoutMs);
+          })
+        ]);
+        console.debug(logHeader, `Redis pool for DB index ${dbIndex} destroyed.`);
+        poolMap.delete(dbIndex);
+      }
+    }
+  }
+};