koatty_cacheable 1.4.2 → 1.5.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.5.0](https://github.com/thinkkoa/koatty_cacheable/compare/v1.4.3...v1.5.0) (2024-04-01)
+
+
+### Features
+
+* delayedDoubleDeletion ([532f735](https://github.com/thinkkoa/koatty_cacheable/commit/532f735818fc66fa144023cd24282efe350833ba))
+
+### [1.4.3](https://github.com/thinkkoa/koatty_cacheable/compare/v1.4.2...v1.4.3) (2024-01-17)
+
+
+### Bug Fixes
+
+* 缓存key拼装 ([5d0b924](https://github.com/thinkkoa/koatty_cacheable/commit/5d0b9248064d353046bd7287d3a3ee5229e88c23))
+
 ### [1.4.2](https://github.com/thinkkoa/koatty_cacheable/compare/v1.4.1...v1.4.2) (2023-12-20)
 
 ### [1.4.1](https://github.com/thinkkoa/koatty_cacheable/compare/v1.4.0...v1.4.1) (2023-08-04)

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-20 19:24:59
+* @Date: 2024-04-01 15:47:51
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -9,9 +9,11 @@ import { Application } from 'koatty_container';
 import { CacheStore } from 'koatty_store';
 
 /**
- * Decorate this method to support caching. Redis server config from db.ts.
- * The cache method returns a value to ensure that the next time the method is executed with the same parameters,
- * the results can be obtained directly from the cache without the need to execute the method again.
+ * Decorate this method to support caching.
+ * The cache method returns a value to ensure that the next time
+ * the method is executed with the same parameters, the results can be obtained
+ * directly from the cache without the need to execute the method again.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cache name
@@ -36,7 +38,8 @@ export declare interface CacheAbleOpt {
 }
 
 /**
- * Decorating the execution of this method will trigger a cache clear operation. Redis server config from db.ts.
+ * Decorating the execution of this method will trigger a cache clear operation.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cacheName cache name
@@ -44,9 +47,10 @@ export declare interface CacheAbleOpt {
  * e.g:
  * {
  *  params: ["id"],
- *  eventTime: "Before"
+ *  delayedDoubleDeletion: true
  * }
- * Use the 'id' parameters of the method as cache subkeys, and clear the cache before the method executed
+ * Use the 'id' parameters of the method as cache subkeys,
+ *  and clear the cache after the method executed
  * @returns
  */
 export declare function CacheEvict(cacheName: string, opt?: CacheEvictOpt): (target: any, methodName: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
@@ -57,14 +61,9 @@ export declare function CacheEvict(cacheName: string, opt?: CacheEvictOpt): (tar
  */
 export declare interface CacheEvictOpt {
     params?: string[];
-    eventTime?: "Before";
+    delayedDoubleDeletion?: boolean;
 }
 
-/**
- *
- */
-export declare type eventTimes = "Before" | "After";
-
 /**
  * get instances of storeCache
  *

package/dist/index.js

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-20 19:24:38
+* @Date: 2024-04-01 15:47:40
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -15,11 +15,11 @@ var koatty_container = require('koatty_container');
 /*
  * @Author: richen
  * @Date: 2020-07-06 19:53:43
- * @LastEditTime: 2023-08-04 14:33:58
+ * @LastEditTime: 2024-04-01 15:44:15
  * @Description:
  * @Copyright (c) - <richenlin(at)gmail.com>
  */
-const PreKey = "k";
+const longKey = 128;
 // storeCache
 const storeCache = {
     store: null
@@ -61,9 +61,11 @@ async function InitCacheStore() {
     });
 }
 /**
- * Decorate this method to support caching. Redis server config from db.ts.
- * The cache method returns a value to ensure that the next time the method is executed with the same parameters,
- * the results can be obtained directly from the cache without the need to execute the method again.
+ * Decorate this method to support caching.
+ * The cache method returns a value to ensure that the next time
+ * the method is executed with the same parameters, the results can be obtained
+ * directly from the cache without the need to execute the method again.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cache name
@@ -78,7 +80,7 @@ async function InitCacheStore() {
  */
 function CacheAble(cacheName, opt = {
     params: [],
-    timeout: 3600,
+    timeout: 300,
 }) {
     return (target, methodName, descriptor) => {
         const componentType = koatty_container.IOCContainer.getType(target);
@@ -89,11 +91,11 @@ function CacheAble(cacheName, opt = {
         opt = {
             ...{
                 params: [],
-                timeout: 3600,
+                timeout: 300,
             }, ...opt
         };
         // 获取定义的参数位置
-        const paramIndexes = getParamIndex(opt.params, getArgs(value));
+        const paramIndexes = getParamIndex(opt.params);
         descriptor = {
             configurable,
             enumerable,
@@ -107,35 +109,31 @@ function CacheAble(cacheName, opt = {
                 });
                 if (cacheFlag) {
                     // tslint:disable-next-line: one-variable-per-declaration
-                    let key = PreKey;
+                    let key = cacheName;
                     if (props && props.length > 0) {
                         for (const item of paramIndexes) {
                             if (props[item] !== undefined) {
                                 const value = koatty_lib.Helper.toString(props[item]);
-                                key += `:${value}`;
+                                key += `:${opt.params[item]}:${value}`;
                             }
                         }
                         // 防止key超长
-                        if (key.length > 32) {
+                        if (key.length > longKey) {
                             key = koatty_lib.Helper.murmurHash(key);
                         }
                     }
-                    let res = await store.get(`${cacheName}:${key}`).catch(() => null);
+                    let res = await store.get(key).catch(() => null);
                     if (!koatty_lib.Helper.isEmpty(res)) {
                         return JSON.parse(res);
                     }
                     // tslint:disable-next-line: no-invalid-this
                     res = await value.apply(this, props);
                     // prevent cache penetration
-                    if (koatty_lib.Helper.isEmpty(res)) {
+                    if (koatty_lib.Helper.isTrueEmpty(res)) {
                         res = "";
-                        opt.timeout = 5;
-                    }
-                    if (!opt.timeout) {
-                        opt.timeout = 3600;
                     }
                     // async set store
-                    store.set(`${cacheName}:${key}`, JSON.stringify(res), opt.timeout).catch(() => null);
+                    store.set(key, JSON.stringify(res), opt.timeout).catch(() => null);
                     return res;
                 }
                 else {
@@ -150,7 +148,8 @@ function CacheAble(cacheName, opt = {
     };
 }
 /**
- * Decorating the execution of this method will trigger a cache clear operation. Redis server config from db.ts.
+ * Decorating the execution of this method will trigger a cache clear operation.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cacheName cache name
@@ -158,13 +157,14 @@ function CacheAble(cacheName, opt = {
  * e.g:
  * {
  *  params: ["id"],
- *  eventTime: "Before"
+ *  delayedDoubleDeletion: true
  * }
- * Use the 'id' parameters of the method as cache subkeys, and clear the cache before the method executed
+ * Use the 'id' parameters of the method as cache subkeys,
+ *  and clear the cache after the method executed
  * @returns
  */
 function CacheEvict(cacheName, opt = {
-    eventTime: "Before",
+    delayedDoubleDeletion: true,
 }) {
     return (target, methodName, descriptor) => {
         const componentType = koatty_container.IOCContainer.getType(target);
@@ -178,7 +178,7 @@ function CacheEvict(cacheName, opt = {
                 eventTime: "Before",
             }, ...opt
         };
-        const paramIndexes = getParamIndex(opt.params, getArgs(value));
+        const paramIndexes = getParamIndex(opt.params);
         descriptor = {
             configurable,
             enumerable,
@@ -191,30 +191,28 @@ function CacheEvict(cacheName, opt = {
                     return null;
                 });
                 if (cacheFlag) {
-                    let key = PreKey;
+                    let key = cacheName;
                     if (props && props.length > 0) {
                         for (const item of paramIndexes) {
                             if (props[item] !== undefined) {
                                 const value = koatty_lib.Helper.toString(props[item]);
-                                key += `:${value}`;
+                                key += `:${opt.params[item]}:${value}`;
                             }
                         }
                         // 防止key超长
-                        if (key.length > 32) {
+                        if (key.length > longKey) {
                             key = koatty_lib.Helper.murmurHash(key);
                         }
                     }
-                    if (opt.eventTime === "Before") {
-                        await store.del(`${cacheName}:${key}`).catch(() => null);
-                        // tslint:disable-next-line: no-invalid-this
-                        return value.apply(this, props);
-                    }
-                    else {
-                        // tslint:disable-next-line: no-invalid-this
-                        const res = await value.apply(this, props);
-                        store.del(`${cacheName}:${key}`).catch(() => null);
-                        return res;
+                    // tslint:disable-next-line: no-invalid-this
+                    const res = await value.apply(this, props);
+                    store.del(key).catch(() => null);
+                    if (opt.delayedDoubleDeletion) {
+                        asyncDelayedExecution(2000, () => {
+                            store.del(key).catch(() => null);
+                        });
                     }
+                    return res;
                 }
                 else {
                     // tslint:disable-next-line: no-invalid-this
@@ -229,31 +227,10 @@ function CacheEvict(cacheName, opt = {
 }
 /**
  * @description:
- * @param {*} func
- * @return {*}
- */
-function getArgs(func) {
-    // 首先匹配函数括弧里的参数
-    const args = func.toString().match(/.*?\(([^)]*)\)/);
-    if (args.length > 1) {
-        // 分解参数成数组
-        return args[1].split(",").map(function (a) {
-            // 去空格和内联注释
-            return a.replace(/\/\*.*\*\//, "").trim();
-        }).filter(function (ae) {
-            // 确保没有undefineds
-            return ae;
-        });
-    }
-    return [];
-}
-/**
- * @description:
- * @param {string} params
- * @param {string} args
+ * @param {string[]} params
  * @return {*}
  */
-function getParamIndex(params, args) {
+function getParamIndex(params) {
     const res = [];
     for (let i = 0; i < params.length; i++) {
         if (params.includes(params[i])) {
@@ -261,6 +238,24 @@ function getParamIndex(params, args) {
         }
     }
     return res;
+}
+/**
+ *
+ * @param ms
+ * @returns
+ */
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+/**
+ * async delayed execution func
+ * @param ms
+ * @param fn
+ * @returns
+ */
+async function asyncDelayedExecution(ms, fn) {
+    await delay(ms); // delay ms second
+    return fn();
 }
 
 exports.CacheAble = CacheAble;

package/dist/index.mjs

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2023-12-20 19:24:38
+* @Date: 2024-04-01 15:47:40
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -13,11 +13,11 @@ import { IOCContainer } from 'koatty_container';
 /*
  * @Author: richen
  * @Date: 2020-07-06 19:53:43
- * @LastEditTime: 2023-08-04 14:33:58
+ * @LastEditTime: 2024-04-01 15:44:15
  * @Description:
  * @Copyright (c) - <richenlin(at)gmail.com>
  */
-const PreKey = "k";
+const longKey = 128;
 // storeCache
 const storeCache = {
     store: null
@@ -59,9 +59,11 @@ async function InitCacheStore() {
     });
 }
 /**
- * Decorate this method to support caching. Redis server config from db.ts.
- * The cache method returns a value to ensure that the next time the method is executed with the same parameters,
- * the results can be obtained directly from the cache without the need to execute the method again.
+ * Decorate this method to support caching.
+ * The cache method returns a value to ensure that the next time
+ * the method is executed with the same parameters, the results can be obtained
+ * directly from the cache without the need to execute the method again.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cache name
@@ -76,7 +78,7 @@ async function InitCacheStore() {
  */
 function CacheAble(cacheName, opt = {
     params: [],
-    timeout: 3600,
+    timeout: 300,
 }) {
     return (target, methodName, descriptor) => {
         const componentType = IOCContainer.getType(target);
@@ -87,11 +89,11 @@ function CacheAble(cacheName, opt = {
         opt = {
             ...{
                 params: [],
-                timeout: 3600,
+                timeout: 300,
             }, ...opt
         };
         // 获取定义的参数位置
-        const paramIndexes = getParamIndex(opt.params, getArgs(value));
+        const paramIndexes = getParamIndex(opt.params);
         descriptor = {
             configurable,
             enumerable,
@@ -105,35 +107,31 @@ function CacheAble(cacheName, opt = {
                 });
                 if (cacheFlag) {
                     // tslint:disable-next-line: one-variable-per-declaration
-                    let key = PreKey;
+                    let key = cacheName;
                     if (props && props.length > 0) {
                         for (const item of paramIndexes) {
                             if (props[item] !== undefined) {
                                 const value = Helper.toString(props[item]);
-                                key += `:${value}`;
+                                key += `:${opt.params[item]}:${value}`;
                             }
                         }
                         // 防止key超长
-                        if (key.length > 32) {
+                        if (key.length > longKey) {
                             key = Helper.murmurHash(key);
                         }
                     }
-                    let res = await store.get(`${cacheName}:${key}`).catch(() => null);
+                    let res = await store.get(key).catch(() => null);
                     if (!Helper.isEmpty(res)) {
                         return JSON.parse(res);
                     }
                     // tslint:disable-next-line: no-invalid-this
                     res = await value.apply(this, props);
                     // prevent cache penetration
-                    if (Helper.isEmpty(res)) {
+                    if (Helper.isTrueEmpty(res)) {
                         res = "";
-                        opt.timeout = 5;
-                    }
-                    if (!opt.timeout) {
-                        opt.timeout = 3600;
                     }
                     // async set store
-                    store.set(`${cacheName}:${key}`, JSON.stringify(res), opt.timeout).catch(() => null);
+                    store.set(key, JSON.stringify(res), opt.timeout).catch(() => null);
                     return res;
                 }
                 else {
@@ -148,7 +146,8 @@ function CacheAble(cacheName, opt = {
     };
 }
 /**
- * Decorating the execution of this method will trigger a cache clear operation. Redis server config from db.ts.
+ * Decorating the execution of this method will trigger a cache clear operation.
+ * CacheStore server config defined in db.ts.
  *
  * @export
  * @param {string} cacheName cacheName cache name
@@ -156,13 +155,14 @@ function CacheAble(cacheName, opt = {
  * e.g:
  * {
  *  params: ["id"],
- *  eventTime: "Before"
+ *  delayedDoubleDeletion: true
  * }
- * Use the 'id' parameters of the method as cache subkeys, and clear the cache before the method executed
+ * Use the 'id' parameters of the method as cache subkeys,
+ *  and clear the cache after the method executed
  * @returns
  */
 function CacheEvict(cacheName, opt = {
-    eventTime: "Before",
+    delayedDoubleDeletion: true,
 }) {
     return (target, methodName, descriptor) => {
         const componentType = IOCContainer.getType(target);
@@ -176,7 +176,7 @@ function CacheEvict(cacheName, opt = {
                 eventTime: "Before",
             }, ...opt
         };
-        const paramIndexes = getParamIndex(opt.params, getArgs(value));
+        const paramIndexes = getParamIndex(opt.params);
         descriptor = {
             configurable,
             enumerable,
@@ -189,30 +189,28 @@ function CacheEvict(cacheName, opt = {
                     return null;
                 });
                 if (cacheFlag) {
-                    let key = PreKey;
+                    let key = cacheName;
                     if (props && props.length > 0) {
                         for (const item of paramIndexes) {
                             if (props[item] !== undefined) {
                                 const value = Helper.toString(props[item]);
-                                key += `:${value}`;
+                                key += `:${opt.params[item]}:${value}`;
                             }
                         }
                         // 防止key超长
-                        if (key.length > 32) {
+                        if (key.length > longKey) {
                             key = Helper.murmurHash(key);
                         }
                     }
-                    if (opt.eventTime === "Before") {
-                        await store.del(`${cacheName}:${key}`).catch(() => null);
-                        // tslint:disable-next-line: no-invalid-this
-                        return value.apply(this, props);
-                    }
-                    else {
-                        // tslint:disable-next-line: no-invalid-this
-                        const res = await value.apply(this, props);
-                        store.del(`${cacheName}:${key}`).catch(() => null);
-                        return res;
+                    // tslint:disable-next-line: no-invalid-this
+                    const res = await value.apply(this, props);
+                    store.del(key).catch(() => null);
+                    if (opt.delayedDoubleDeletion) {
+                        asyncDelayedExecution(2000, () => {
+                            store.del(key).catch(() => null);
+                        });
                     }
+                    return res;
                 }
                 else {
                     // tslint:disable-next-line: no-invalid-this
@@ -227,31 +225,10 @@ function CacheEvict(cacheName, opt = {
 }
 /**
  * @description:
- * @param {*} func
- * @return {*}
- */
-function getArgs(func) {
-    // 首先匹配函数括弧里的参数
-    const args = func.toString().match(/.*?\(([^)]*)\)/);
-    if (args.length > 1) {
-        // 分解参数成数组
-        return args[1].split(",").map(function (a) {
-            // 去空格和内联注释
-            return a.replace(/\/\*.*\*\//, "").trim();
-        }).filter(function (ae) {
-            // 确保没有undefineds
-            return ae;
-        });
-    }
-    return [];
-}
-/**
- * @description:
- * @param {string} params
- * @param {string} args
+ * @param {string[]} params
  * @return {*}
  */
-function getParamIndex(params, args) {
+function getParamIndex(params) {
     const res = [];
     for (let i = 0; i < params.length; i++) {
         if (params.includes(params[i])) {
@@ -259,6 +236,24 @@ function getParamIndex(params, args) {
         }
     }
     return res;
+}
+/**
+ *
+ * @param ms
+ * @returns
+ */
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+/**
+ * async delayed execution func
+ * @param ms
+ * @param fn
+ * @returns
+ */
+async function asyncDelayedExecution(ms, fn) {
+    await delay(ms); // delay ms second
+    return fn();
 }
 
 export { CacheAble, CacheEvict, GetCacheStore };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_cacheable",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Cacheable for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koatty_cacheable",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Cacheable for koatty.",
   "scripts": {
     "build": "npm run build:js && npm run build:dts && npm run build:doc && npm run build:cp",