koatty_store 1.8.0 → 1.9.0

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-06-09 12:32:48
+* @Date: 2025-11-02 08:37:33
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -9,6 +9,7 @@ import { flatten, isNil, union, isUndefined } from 'lodash';
 import * as helper from 'koatty_lib';
 import { EventEmitter } from 'events';
 import { LRUCache } from 'lru-cache';
+import AsyncLock from 'async-lock';
 import { DefaultLogger } from 'koatty_logger';
 import { Cluster, Redis } from 'ioredis';
 import genericPool from 'generic-pool';
@@ -50,15 +51,6 @@ var messages;
     messages["mutuallyExclusiveNXXX"] = "ERR XX and NX options at the same time are not compatible";
 })(messages || (messages = {}));
 class MemoryCache extends EventEmitter {
-    databases = new Map();
-    options;
-    currentDBIndex;
-    connected;
-    lastSave;
-    multiMode;
-    cache;
-    responseMessages;
-    ttlCheckTimer = null;
     /**
      * Creates an instance of MemoryCache.
      * @param {MemoryCacheOptions} options
@@ -66,6 +58,8 @@ class MemoryCache extends EventEmitter {
      */
     constructor(options) {
         super();
+        this.databases = new Map();
+        this.ttlCheckTimer = null;
         this.options = {
             database: 0,
             maxKeys: 1000,
@@ -79,6 +73,7 @@ class MemoryCache extends EventEmitter {
         this.lastSave = Date.now();
         this.multiMode = false;
         this.responseMessages = [];
+        this.lock = new AsyncLock();
         // 初始化数据库和缓存
         if (!this.databases.has(this.currentDBIndex)) {
             this.databases.set(this.currentDBIndex, this.createLRUCache());
@@ -142,6 +137,15 @@ class MemoryCache extends EventEmitter {
             this.ttlCheckTimer = null;
         }
     }
+    /**
+     * 清理所有资源
+     * @private
+     */
+    cleanup() {
+        this.stopTTLCheck();
+        this.databases.clear();
+        this.removeAllListeners();
+    }
     /**
      *
      *
@@ -167,8 +171,8 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     quit() {
+        this.cleanup(); // 调用清理方法
         this.connected = false;
-        this.stopTTLCheck();
         // exit multi mode if we are in it
         this.discard(null, true);
         this.emit('end');
@@ -431,14 +435,18 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     incr(key, callback) {
-        let retVal = null;
-        try {
-            retVal = this._addToKey(key, 1);
-        }
-        catch (err) {
-            return this._handleCallback(callback, null, err);
-        }
-        return this._handleCallback(callback, retVal);
+        // 使用锁保护原子操作
+        const lockKey = `incr:${key}`;
+        return this.lock.acquire(lockKey, () => {
+            let retVal = null;
+            try {
+                retVal = this._addToKey(key, 1);
+            }
+            catch (err) {
+                return this._handleCallback(callback, null, err);
+            }
+            return this._handleCallback(callback, retVal);
+        });
     }
     /**
      *
@@ -450,14 +458,18 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     incrby(key, amount, callback) {
-        let retVal = null;
-        try {
-            retVal = this._addToKey(key, amount);
-        }
-        catch (err) {
-            return this._handleCallback(callback, null, err);
-        }
-        return this._handleCallback(callback, retVal);
+        // 使用锁保护原子操作
+        const lockKey = `incrby:${key}`;
+        return this.lock.acquire(lockKey, () => {
+            let retVal = null;
+            try {
+                retVal = this._addToKey(key, amount);
+            }
+            catch (err) {
+                return this._handleCallback(callback, null, err);
+            }
+            return this._handleCallback(callback, retVal);
+        });
     }
     /**
      *
@@ -468,14 +480,18 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     decr(key, callback) {
-        let retVal = null;
-        try {
-            retVal = this._addToKey(key, -1);
-        }
-        catch (err) {
-            return this._handleCallback(callback, null, err);
-        }
-        return this._handleCallback(callback, retVal);
+        // 使用锁保护原子操作
+        const lockKey = `decr:${key}`;
+        return this.lock.acquire(lockKey, () => {
+            let retVal = null;
+            try {
+                retVal = this._addToKey(key, -1);
+            }
+            catch (err) {
+                return this._handleCallback(callback, null, err);
+            }
+            return this._handleCallback(callback, retVal);
+        });
     }
     /**
      *
@@ -487,19 +503,23 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     decrby(key, amount, callback) {
-        let retVal = null;
-        try {
-            retVal = this._addToKey(key, 0 - amount);
-        }
-        catch (err) {
-            return this._handleCallback(callback, null, err);
-        }
-        return this._handleCallback(callback, retVal);
+        // 使用锁保护原子操作
+        const lockKey = `decrby:${key}`;
+        return this.lock.acquire(lockKey, () => {
+            let retVal = null;
+            try {
+                retVal = this._addToKey(key, 0 - amount);
+            }
+            catch (err) {
+                return this._handleCallback(callback, null, err);
+            }
+            return this._handleCallback(callback, retVal);
+        });
     }
     // ---------------------------------------
     // ## Hash ##
     // ---------------------------------------
-    hset(key, field, value, callback) {
+    hset(key, field, value, timeout, callback) {
         let retVal = 0;
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
@@ -511,6 +531,14 @@ class MemoryCache extends EventEmitter {
             retVal = 1;
         }
         this._setField(key, field, value.toString());
+        // 如果指定了 timeout，存储字段级别的过期时间
+        if (typeof timeout === 'number') {
+            const hashObj = this.cache.get(key).value;
+            if (!hashObj._fieldTTL) {
+                hashObj._fieldTTL = {};
+            }
+            hashObj._fieldTTL[field] = Date.now() + (timeout * 1000);
+        }
         this.persist(key);
         return this._handleCallback(callback, retVal);
     }
@@ -527,8 +555,17 @@ class MemoryCache extends EventEmitter {
         let retVal = null;
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
+            // 检查字段级别的过期时间
+            const hashObj = this._getKey(key);
+            if (hashObj && hashObj._fieldTTL && hashObj._fieldTTL[field]) {
+                if (hashObj._fieldTTL[field] <= Date.now()) {
+                    // 过期，删除字段
+                    this.hdel(key, field);
+                    return this._handleCallback(callback, null);
+                }
+            }
             if (this._hasField(key, field)) {
-                retVal = this._getKey(key)[field];
+                retVal = hashObj[field];
             }
         }
         return this._handleCallback(callback, retVal);
@@ -546,6 +583,15 @@ class MemoryCache extends EventEmitter {
         let retVal = 0;
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
+            // 检查字段级别的过期时间
+            const hashObj = this._getKey(key);
+            if (hashObj && hashObj._fieldTTL && hashObj._fieldTTL[field]) {
+                if (hashObj._fieldTTL[field] <= Date.now()) {
+                    // 过期，删除字段
+                    this.hdel(key, field);
+                    return this._handleCallback(callback, 0);
+                }
+            }
             if (this._hasField(key, field)) {
                 retVal = 1;
             }
@@ -565,10 +611,15 @@ class MemoryCache extends EventEmitter {
         const callback = this._retrieveCallback(fields);
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
+            const hashObj = this.cache.get(key).value;
             for (let itr = 0; itr < fields.length; itr++) {
                 const field = fields[itr];
                 if (this._hasField(key, field)) {
-                    delete this.cache.get(key).value[field];
+                    delete hashObj[field];
+                    // 清理过期时间记录
+                    if (hashObj._fieldTTL && hashObj._fieldTTL[field]) {
+                        delete hashObj._fieldTTL[field];
+                    }
                     retVal++;
                 }
             }
@@ -598,14 +649,18 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     hincrby(key, field, value, callback) {
-        let retVal;
-        try {
-            retVal = this._addToField(key, field, value, false);
-        }
-        catch (err) {
-            return this._handleCallback(callback, null, err);
-        }
-        return this._handleCallback(callback, retVal);
+        // 使用锁保护原子操作，使用组合 key
+        const lockKey = `hincrby:${key}:${field}`;
+        return this.lock.acquire(lockKey, () => {
+            let retVal;
+            try {
+                retVal = this._addToField(key, field, value, false);
+            }
+            catch (err) {
+                return this._handleCallback(callback, null, err);
+            }
+            return this._handleCallback(callback, retVal);
+        });
     }
     /**
      *
@@ -619,7 +674,11 @@ class MemoryCache extends EventEmitter {
         let retVals = {};
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
-            retVals = this._getKey(key);
+            const hashObj = this._getKey(key);
+            // 排除内部属性 _fieldTTL
+            retVals = Object.entries(hashObj)
+                .filter(([k]) => k !== '_fieldTTL')
+                .reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {});
         }
         return this._handleCallback(callback, retVals);
     }
@@ -635,7 +694,9 @@ class MemoryCache extends EventEmitter {
         let retVals = [];
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
-            retVals = Object.keys(this._getKey(key));
+            const hashObj = this._getKey(key);
+            // 排除内部属性 _fieldTTL
+            retVals = Object.keys(hashObj).filter(k => k !== '_fieldTTL');
         }
         return this._handleCallback(callback, retVals);
     }
@@ -651,7 +712,11 @@ class MemoryCache extends EventEmitter {
         let retVals = [];
         if (this._hasKey(key)) {
             this._testType(key, 'hash', true, callback);
-            retVals = Object.values(this._getKey(key));
+            const hashObj = this._getKey(key);
+            // 排除内部属性 _fieldTTL 的值
+            retVals = Object.entries(hashObj)
+                .filter(([k]) => k !== '_fieldTTL')
+                .map(([, v]) => v);
         }
         return this._handleCallback(callback, retVals);
     }
@@ -802,8 +867,7 @@ class MemoryCache extends EventEmitter {
                 stop = length - 1;
             }
             if (stop >= 0 && stop >= start) {
-                const size = stop - start + 1;
-                for (let itr = start; itr < size; itr++) {
+                for (let itr = start; itr <= stop; itr++) {
                     retVal.push(list[itr]);
                 }
             }
@@ -1010,9 +1074,10 @@ class MemoryCache extends EventEmitter {
      * @memberof MemoryCache
      */
     pttl(key, _callback) {
+        var _a;
         let retVal = -2;
         if (this._hasKey(key)) {
-            if (!isNil(this.cache.get(key)?.timeout)) {
+            if (!isNil((_a = this.cache.get(key)) === null || _a === void 0 ? void 0 : _a.timeout)) {
                 retVal = this.cache.get(key).timeout - Date.now();
                 // Prevent unexpected errors if the actual ttl just happens to be -2 or -1
                 if (retVal < 0 && retVal > -3) {
@@ -1221,7 +1286,8 @@ class MemoryCache extends EventEmitter {
         if (key && field) {
             const ky = this._getKey(key);
             if (ky) {
-                retVal = ky.hasOwnProperty(field);
+                // 排除内部属性 _fieldTTL
+                retVal = field !== '_fieldTTL' && ky.hasOwnProperty(field);
             }
         }
         return retVal;
@@ -1630,9 +1696,6 @@ class MemoryCache extends EventEmitter {
  * @LastEditTime: 2023-02-18 23:52:47
  */
 class MemoryStore {
-    client;
-    pool;
-    options;
     /**
      * Creates an instance of MemoryStore.
      * @param {MemoryStoreOpt} options
@@ -1645,7 +1708,15 @@ class MemoryStore {
             ttlCheckInterval: 60000, // 1分钟
             ...options
         };
-        this.client = null;
+        // 直接创建 MemoryCache 实例
+        this.client = new MemoryCache({
+            database: this.options.db || 0,
+            maxKeys: this.options.maxKeys,
+            maxMemory: this.options.maxMemory,
+            evictionPolicy: this.options.evictionPolicy,
+            ttlCheckInterval: this.options.ttlCheckInterval
+        });
+        this.client.createClient();
     }
     /**
      * getConnection
@@ -1654,19 +1725,7 @@ class MemoryStore {
      * @memberof MemoryStore
      */
     getConnection() {
-        if (!this.pool) {
-            this.pool = new MemoryCache({
-                database: this.options.db || 0,
-                maxKeys: this.options.maxKeys,
-                maxMemory: this.options.maxMemory,
-                evictionPolicy: this.options.evictionPolicy,
-                ttlCheckInterval: this.options.ttlCheckInterval
-            });
-        }
-        if (!this.client) {
-            this.client = this.pool.createClient();
-            this.client.status = "ready";
-        }
+        // 直接返回 MemoryCache 实例
         return this.client;
     }
     /**
@@ -1689,7 +1748,8 @@ class MemoryStore {
      * @memberof MemoryStore
      */
     async release(_conn) {
-        return;
+        // 对于内存存储，不需要释放连接
+        return Promise.resolve();
     }
     /**
      * defineCommand
@@ -1753,18 +1813,15 @@ class MemoryStore {
  * @class RedisStore
  */
 class RedisStore {
-    options;
-    pool;
-    client;
-    reconnectAttempts = 0;
-    maxReconnectAttempts = 5;
-    reconnectDelay = 1000; // 初始重连延迟1秒
     /**
      * Creates an instance of RedisStore.
      * @param {RedisStoreOpt} options
      * @memberof RedisStore
      */
     constructor(options) {
+        this.reconnectAttempts = 0;
+        this.maxReconnectAttempts = 5;
+        this.reconnectDelay = 1000; // 初始重连延迟1秒
         this.options = this.parseOpt(options);
         this.pool = null;
     }
@@ -2051,9 +2108,6 @@ const defaultOptions = {
  * @class Store
  */
 class CacheStore {
-    client;
-    options;
-    static instances = new Map();
     /**
      * Creates an instance of CacheStore.
      * @param {StoreOptions} options
@@ -2171,10 +2225,22 @@ class CacheStore {
             return res;
         }
         catch (err) {
-            throw err;
+            // 添加详细的错误信息
+            const error = new Error(`Cache operation failed: ${name}(${data.slice(0, 2).join(', ')}${data.length > 2 ? '...' : ''}) - ${err.message}`);
+            error.stack = err.stack;
+            throw error;
         }
         finally {
-            this.release(conn);
+            // 安全地释放连接
+            if (conn) {
+                try {
+                    await this.release(conn);
+                }
+                catch (releaseErr) {
+                    // 记录但不抛出，避免掩盖原始错误
+                    DefaultLogger.Error(`Failed to release connection: ${releaseErr.message}`);
+                }
+            }
         }
     }
     /**
@@ -2270,15 +2336,8 @@ class CacheStore {
      * @param timeout
      */
     async hset(name, key, value, timeout) {
-        const result = await this.wrap('hset', [`${this.options.keyPrefix || ""}${name}`, key, value]);
-        if (typeof timeout === 'number') {
-            await this.set(`${name}:${key}_ex`, 1, timeout);
-        }
-        else {
-            // 如果没有指定timeout，设置一个永久标记，避免hget时误删
-            await this.set(`${name}:${key}_ex`, 1);
-        }
-        return result;
+        // MemoryStore 直接支持字段级 TTL，传递 timeout 参数
+        return this.wrap('hset', [`${this.options.keyPrefix || ""}${name}`, key, value, timeout]);
     }
     /**
      * 哈希获取
@@ -2287,15 +2346,8 @@ class CacheStore {
      * @returns {*}
      */
     hget(name, key) {
-        const setP = [this.get(`${name}:${key}_ex`)];
-        setP.push(this.wrap('hget', [`${this.options.keyPrefix || ""}${name}`, key]));
-        return Promise.all(setP).then(dataArr => {
-            if (dataArr[0] === null) {
-                this.hdel(name, key);
-                return null;
-            }
-            return dataArr[1] || null;
-        });
+        // 直接调用底层实现，TTL 检查在 MemoryCache 中处理
+        return this.wrap('hget', [`${this.options.keyPrefix || ""}${name}`, key]);
     }
     /**
      * 查看哈希表 hashKey 中，给定域 key 是否存在
@@ -2304,15 +2356,8 @@ class CacheStore {
      * @returns {*}
      */
     hexists(name, key) {
-        const setP = [this.get(`${name}:${key}_ex`)];
-        setP.push(this.wrap('hexists', [`${this.options.keyPrefix || ""}${name}`, key]));
-        return Promise.all(setP).then(dataArr => {
-            if (dataArr[0] === null) {
-                this.hdel(name, key);
-                return 0;
-            }
-            return Number(dataArr[1]) || 0;
-        });
+        // 直接调用底层实现，TTL 检查在 MemoryCache 中处理
+        return this.wrap('hexists', [`${this.options.keyPrefix || ""}${name}`, key]);
     }
     /**
      * 哈希删除
@@ -2321,9 +2366,8 @@ class CacheStore {
      * @returns {*}
      */
     async hdel(name, key) {
-        await this.del(`${name}:${key}_ex`);
-        const result = await this.wrap('hdel', [`${this.options.keyPrefix || ""}${name}`, key]);
-        return result;
+        // 直接调用底层实现，TTL 清理在 MemoryCache 中处理
+        return this.wrap('hdel', [`${this.options.keyPrefix || ""}${name}`, key]);
     }
     /**
      * 返回哈希表 key 中域的数量
@@ -2490,5 +2534,6 @@ class CacheStore {
         return this.wrap('smove', [`${this.options.keyPrefix || ""}${source}`, `${this.options.keyPrefix || ""}${destination}`, member]);
     }
 }
+CacheStore.instances = new Map();
 
 export { CacheStore };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_store",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Cache store for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
@@ -65,6 +65,7 @@
     "@rollup/plugin-commonjs": "^28.x.x",
     "@rollup/plugin-json": "^6.x.x",
     "@rollup/plugin-node-resolve": "^15.x.x",
+    "@types/async-lock": "^1.4.2",
     "@types/jest": "^29.x.x",
     "@types/koa": "^2.x.x",
     "@types/lodash": "^4.x.x",
@@ -91,12 +92,13 @@
     "typescript": "^5.x.x"
   },
   "dependencies": {
+    "async-lock": "^1.4.1",
     "generic-pool": "^3.9.0",
-    "ioredis": "^5.4.2",
+    "ioredis": "^5.8.2",
     "koatty_lib": "^1.x.x",
     "koatty_logger": "^2.x.x",
     "lodash": "^4.17.21",
-    "lru-cache": "^11.1.0"
+    "lru-cache": "^11.2.2"
   },
   "peerDependencies": {
     "koatty_lib": "^1.x.x",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_store",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Cache store for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",
@@ -65,6 +65,7 @@
     "@rollup/plugin-commonjs": "^28.x.x",
     "@rollup/plugin-json": "^6.x.x",
     "@rollup/plugin-node-resolve": "^15.x.x",
+    "@types/async-lock": "^1.4.2",
     "@types/jest": "^29.x.x",
     "@types/koa": "^2.x.x",
     "@types/lodash": "^4.x.x",
@@ -91,12 +92,13 @@
     "typescript": "^5.x.x"
   },
   "dependencies": {
+    "async-lock": "^1.4.1",
     "generic-pool": "^3.9.0",
-    "ioredis": "^5.4.2",
+    "ioredis": "^5.8.2",
     "koatty_lib": "^1.x.x",
     "koatty_logger": "^2.x.x",
     "lodash": "^4.17.21",
-    "lru-cache": "^11.1.0"
+    "lru-cache": "^11.2.2"
   },
   "peerDependencies": {
     "koatty_lib": "^1.x.x",

package/.vscode/launch.json

@@ -1,25 +0,0 @@
-{
-    // 使用 IntelliSense 了解相关属性。 
-    // 悬停以查看现有属性的描述。
-    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Launch Typescript Project",
-            "type": "node",
-            "request": "launch",
-            "args": [
-                "${workspaceRoot}/test/test.ts"
-            ],
-            "runtimeArgs": [
-                "--nolazy",
-                "-r",
-                "ts-node/register"
-            ],
-            "sourceMaps": true,
-            "cwd": "${workspaceRoot}",
-            "protocol": "inspector",
-            "internalConsoleOptions": "neverOpen"
-        }
-    ]
-}