@zenweb/cache 4.6.0 → 4.7.0

package/dist/index.js

@@ -34,6 +34,7 @@ Object.defineProperty(exports, "cached", { enumerable: true, get: function () {
  */
 function setup(option) {
     return async function cache(setup) {
+        setup.assertModuleExists('result', 'need setup @zenweb/result');
         const opt = Object.assign({}, options_1.defaultSetupOption, option);
         setup.debug('option: %o', opt);
         const redis = opt.redis instanceof ioredis_1.Redis ? opt.redis : new ioredis_1.Redis(opt.redis);

package/dist/middleware.d.ts

@@ -1,17 +1,10 @@
 import { Context, Middleware } from "@zenweb/core";
 import { LockGetOption } from "./types";
-interface CachedMiddlewareOption extends Omit<LockGetOption, 'parse' | 'decompress'> {
-    /**
-     * 输出内容类型
-     * - 默认 json
-     * - 需要指定输出类型，因为缓存的是 body 主体，并不包含类型
-     */
-    type?: string;
-}
+type CachedMiddlewareOption = Omit<LockGetOption, 'parse' | 'decompress'>;
 /**
  * 缓存中间件
- * - 缓存中间件缓存的是 `ctx.body` 最终结果，所以可以缓存任何返回类型
- * - 会根据客户端请求头判断是否需要解压
+ * - 缓存 ctx.success() 结果
+ * - fail() 时不缓存
  * @param key 不指定 `key` 则默认使用 `ctx.path`，`key: null` 不适用使用缓存
  */
 export declare function cached(key?: string | null | ((ctx: Context) => string | null | Promise<string | null>), opt?: CachedMiddlewareOption): Middleware;

package/dist/middleware.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cached = void 0;
 /**
  * 缓存中间件
- * - 缓存中间件缓存的是 `ctx.body` 最终结果，所以可以缓存任何返回类型
- * - 会根据客户端请求头判断是否需要解压
+ * - 缓存 ctx.success() 结果
+ * - fail() 时不缓存
  * @param key 不指定 `key` 则默认使用 `ctx.path`，`key: null` 不适用使用缓存
  */
 function cached(key, opt) {
@@ -16,25 +16,11 @@ function cached(key, opt) {
         if (!_key) {
             return next();
         }
-        const decompress = ctx.acceptsEncodings('gzip') === false;
-        const _opt = Object.assign({
-            type: 'json'
-        }, 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,
-        });
-        if (result.compressed) {
-            ctx.set('Content-Encoding', 'gzip');
-        }
-        if (_opt.type) {
-            ctx.type = _opt.type;
-        }
-        ctx.body = result.data;
+            return ctx.successData;
+        }, opt);
+        ctx.success(result);
     };
 }
 exports.cached = cached;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenweb/cache",
   "packageManager": "yarn@4.0.2",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -45,6 +45,7 @@
   },
   "dependencies": {
     "@zenweb/core": "^4.2.3",
+    "@zenweb/result": "^4.1.2",
     "ioredis": "^5.3.2"
   }
 }