@zenweb/cache 4.2.1 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.3.0] - 2023-12-14
+normalKey 改名为 cacheKey
+retryCount 参数说明，并修改默认值为 10
+
+## [4.2.2] - 2023-8-23
+修改: 除了 Buffer 类型意外全部都使用 JSON 序列化
+
 ## [4.2.1] - 2023-8-23
 fix: 内容未压缩，客户端支持压缩内容时却标识为压缩内容
 

package/dist/cache.d.ts

@@ -34,10 +34,10 @@ export declare class Cache {
     /**
      * 缓存对象
      * @param key 缓存key
-     * @param value 缓存值，对象会经过 JSON 序列化
+     * @param value 缓存值，除了 `Buffer` 以外的值会经过 JSON 序列化
      * @param ttlopt 缓存有效时长 (秒)，不设置取默认设置 | 缓存选项
      */
-    set(key: string, value: object | number | string | Buffer, ttlopt?: number | SetOption): Promise<SetResult>;
+    set(key: string, value: any, ttlopt?: number | SetOption): Promise<SetResult>;
     /**
      * 直接取得缓存
      */
@@ -46,7 +46,7 @@ export declare class Cache {
      * 取得缓存对象
      * @param key 缓存key
      */
-    get<T>(key: string, opt: {
+    get(key: string, opt: {
         parse: false;
     } & GetOption): Promise<CacheResult | undefined>;
     get<T = unknown>(key: string, opt?: {
@@ -59,10 +59,10 @@ export declare class Cache {
      * @param key 缓存KEY
      * @param fetch 缓存设置方法回调
      */
-    lockGet<T extends {} | string>(key: string, fetch: () => Promise<T> | T, _opt: {
+    lockGet<T = unknown>(key: string, fetch: () => Promise<T> | T, _opt: {
         parse: false;
     } & LockGetOption): Promise<CacheResult>;
-    lockGet<T extends {} | string>(key: string, fetch: () => Promise<T> | T, _opt?: {
+    lockGet<T = unknown>(key: string, fetch: () => Promise<T> | T, _opt?: {
         parse?: true;
     } & LockGetOption): Promise<T>;
     /**

package/dist/cache.js

@@ -54,13 +54,13 @@ class Cache {
     /**
      * 缓存对象
      * @param key 缓存key
-     * @param value 缓存值，对象会经过 JSON 序列化
+     * @param value 缓存值，除了 `Buffer` 以外的值会经过 JSON 序列化
      * @param ttlopt 缓存有效时长 (秒)，不设置取默认设置 | 缓存选项
      */
     async set(key, value, ttlopt) {
         var _a;
         let compressed;
-        let data = Buffer.isBuffer(value) ? value : typeof value === 'object' ? JSON.stringify(value) : String(value);
+        let data = Buffer.isBuffer(value) ? value : JSON.stringify(value);
         const opt = Object.assign({
             ttl: 60,
             compressMinLength: 1024,
@@ -138,7 +138,7 @@ class Cache {
         // 使用锁设置缓存
         let locker;
         let refresh = opt.refresh || false; // 强制刷新
-        let retryCount = typeof opt.retryCount === 'number' ? opt.retryCount : 100;
+        let retryCount = typeof opt.retryCount === 'number' ? opt.retryCount : 10;
         while (true) {
             if (!refresh) {
                 // 尝试从 redis 中获取

package/dist/middleware.js

@@ -19,14 +19,15 @@ function cached(key, opt) {
         const decompress = ctx.acceptsEncodings('gzip') === false;
         const _opt = Object.assign({
             type: 'json'
-        }, opt, {
+        }, opt);
+        const result = await ctx.core.cache2.lockGet(_key, async function () {
+            await next();
+            return Buffer.isBuffer(ctx.body) ? ctx.body : Buffer.from(ctx.body);
+        }, {
+            ..._opt,
             parse: false,
             decompress,
         });
-        const result = await ctx.core.cache2.lockGet(_key, async function () {
-            await next();
-            return ctx.body;
-        }, _opt);
         if (result.compressed) {
             ctx.set('Content-Encoding', 'gzip');
         }

package/dist/types.d.ts

@@ -89,7 +89,9 @@ export interface LockOption {
     lockTimeout?: number;
     /**
      * 锁获取失败重试次数
-     * @default 100
+     * - 0 不进行重试
+     * - lockGet 默认为 10
+     * - singleRunner 默认为 0
      */
     retryCount?: number;
     /**

package/dist/utils.d.ts

@@ -21,4 +21,4 @@ export declare function runRedisScript(redis: Redis, hash: string, script: strin
  * 生成一个参数缓存key
  * - 多个元素用 : 连接
  */
-export declare function normalKey(...key: (string | number | object)[]): string;
+export declare function cacheKey(...key: (string | number | object)[]): string;

package/dist/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalKey = exports.runRedisScript = exports.sleep = exports.debug = void 0;
+exports.cacheKey = exports.runRedisScript = exports.sleep = exports.debug = void 0;
 const debug_1 = require("debug");
 const crypto = require("crypto");
 exports.debug = (0, debug_1.default)('zenweb:cache');
@@ -69,11 +69,11 @@ function plainifyOrHash(obj) {
  * 生成一个参数缓存key
  * - 多个元素用 : 连接
  */
-function normalKey(...key) {
+function cacheKey(...key) {
     return key.map(i => {
         if (typeof i === 'string')
             return i;
         return plainifyOrHash(i);
     }).join(':');
 }
-exports.normalKey = normalKey;
+exports.cacheKey = cacheKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenweb/cache",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",