@tsed/platform-cache 7.0.0-beta.2 → 7.0.0-beta.20

package/lib/esm/interceptors/PlatformCacheInterceptor.js

@@ -2,9 +2,10 @@ import { __decorate, __metadata } from "tslib";
 import { isClass, isString, nameOf, Store } from "@tsed/core";
 import { DIContext, Inject, Interceptor } from "@tsed/di";
 import { deserialize, serialize } from "@tsed/json-mapper";
+import { Logger } from "@tsed/logger";
 import { JsonEntityStore } from "@tsed/schema";
 import { IncomingMessage, ServerResponse } from "http";
-import { PlatformCache } from "../services/PlatformCache";
+import { PlatformCache } from "../services/PlatformCache.js";
 const cleanHeaders = (headers) => {
     return Object.entries(headers)
         .filter(([key]) => !["content-length", "x-request-id", "cache-control"].includes(key))
@@ -19,6 +20,8 @@ const cleanHeaders = (headers) => {
  * @platform
  */
 let PlatformCacheInterceptor = class PlatformCacheInterceptor {
+    cache;
+    logger;
     async intercept(context, next) {
         if (this.cache.disabled()) {
             return next();
@@ -28,44 +31,42 @@ let PlatformCacheInterceptor = class PlatformCacheInterceptor {
         }
         return this.cacheResponse(context, next);
     }
-    getArgs(context) {
-        return context.args.reduce((args, arg) => {
-            if (arg instanceof DIContext || arg instanceof IncomingMessage || arg instanceof ServerResponse) {
-                return args;
+    async canRefreshInBackground(key, { refreshThreshold, ttl }, next) {
+        const inQueue = await this.hasKeyInQueue(key);
+        if (refreshThreshold && !inQueue) {
+            await this.addKeyToQueue(key);
+            const currentTTL = await this.cache.ttl(key);
+            const calculatedTTL = this.cache.calculateTTL(currentTTL, ttl);
+            if (currentTTL < calculatedTTL - refreshThreshold) {
+                await next();
             }
-            if (isClass(arg)) {
-                return args.concat(serialize(arg));
-            }
-            return args.concat(arg);
-        }, []);
-    }
-    getOptions(context) {
-        const { ttl, type, collectionType, key: k = this.cache.defaultKeyResolver() } = context.options || {};
-        const args = this.getArgs(context);
-        const keyArgs = isString(k) ? k : k(args);
-        return { ttl, type, args, collectionType, keyArgs };
-    }
-    isEndpoint({ target, propertyKey }) {
-        return Store.fromMethod(target, propertyKey).has(JsonEntityStore);
+            await this.deleteKeyFromQueue(key);
+        }
     }
     async cacheMethod(context, next) {
-        const { ttl, type, collectionType, keyArgs, args } = this.getOptions(context);
+        const { type, ttl, collectionType, refreshThreshold, keyArgs, args } = this.getOptions(context);
         const key = [nameOf(context.target), context.propertyKey, keyArgs].join(":");
-        const cachedObject = await this.cache.get(key);
-        if (cachedObject) {
-            const { data } = cachedObject;
-            return deserialize(JSON.parse(data), { collectionType, type });
+        const set = (result) => {
+            const calculatedTTL = this.cache.calculateTTL(result, ttl);
+            const data = serialize(result, { type, collectionType });
+            this.cache.setCachedObject(key, data, { args, ttl: calculatedTTL });
+        };
+        const cachedObject = await this.cache.getCachedObject(key);
+        if (!cachedObject) {
+            const result = await next();
+            set(result);
+            return result;
         }
-        const result = await next();
-        const calculatedTtl = this.cache.ttl(result, ttl);
-        await this.cache.set(key, {
-            ttl: calculatedTtl,
-            args,
-            data: JSON.stringify(serialize(result, { type, collectionType }))
-        }, {
-            ttl: calculatedTtl
-        });
-        return result;
+        this.canRefreshInBackground(key, { refreshThreshold, ttl }, async () => {
+            const result = await next();
+            await set(result);
+        }).catch((er) => this.logger.error({
+            event: "CACHE_ERROR",
+            method: "cacheMethod",
+            error: er
+        }));
+        const { data } = cachedObject;
+        return deserialize(JSON.parse(data), { collectionType, type });
     }
     async cacheResponse(context, next) {
         const $ctx = context.args[context.args.length - 1];
@@ -75,32 +76,54 @@ let PlatformCacheInterceptor = class PlatformCacheInterceptor {
         }
         const { ttl, args, keyArgs } = this.getOptions(context);
         const key = [request.method, request.url, keyArgs].join(":");
-        const cachedObject = await this.cache.get(key);
-        if (cachedObject && !(response.get("cache-control") === "no-cache")) {
+        const cachedObject = await this.cache.getCachedObject(key);
+        if (cachedObject && !(request.get("cache-control") === "no-cache")) {
             return this.sendResponse(cachedObject, $ctx);
         }
         const result = await next();
-        const calculatedTtl = this.cache.ttl(result, ttl);
-        const expires = calculatedTtl + Date.now() / 1000;
+        const calculatedTTL = this.cache.calculateTTL(result, ttl);
         $ctx.response.setHeaders({
-            "cache-control": `max-age=${calculatedTtl}`
+            "cache-control": `max-age=${calculatedTTL}`
         });
         // cache final response with his headers and body
         response.onEnd(async () => {
-            const data = JSON.stringify(response.getBody());
-            const headers = cleanHeaders(response.getHeaders());
-            await this.cache.set(key, {
-                ttl: calculatedTtl,
+            this.cache.setCachedObject(key, response.getBody(), {
+                ttl: calculatedTTL,
                 args,
-                data,
-                expires,
-                headers
-            }, {
-                ttl: calculatedTtl
+                headers: cleanHeaders(response.getHeaders())
             });
         });
         return result;
     }
+    getArgs(context) {
+        return context.args.reduce((args, arg) => {
+            if (arg instanceof DIContext || arg instanceof IncomingMessage || arg instanceof ServerResponse) {
+                return args;
+            }
+            if (isClass(arg)) {
+                return args.concat(serialize(arg));
+            }
+            return args.concat(arg);
+        }, []);
+    }
+    getOptions(context) {
+        const { ttl, type, collectionType, key: k = this.cache.defaultKeyResolver(), refreshThreshold } = context.options || {};
+        const args = this.getArgs(context);
+        const keyArgs = isString(k) ? k : k(args);
+        return { refreshThreshold, ttl, type, args, collectionType, keyArgs };
+    }
+    isEndpoint({ target, propertyKey }) {
+        return Store.fromMethod(target, propertyKey).has(JsonEntityStore);
+    }
+    async hasKeyInQueue(key) {
+        return !!(await this.cache.get(`$$queue:${key}`));
+    }
+    async addKeyToQueue(key) {
+        await this.cache.set(`$$queue:${key}`, true, { ttl: 120 });
+    }
+    async deleteKeyFromQueue(key) {
+        await this.cache.del(`$$queue:${key}`);
+    }
     sendResponse(cachedObject, $ctx) {
         const { headers, ttl } = cachedObject;
         const { request, response } = $ctx;
@@ -124,6 +147,10 @@ __decorate([
     Inject(),
     __metadata("design:type", PlatformCache)
 ], PlatformCacheInterceptor.prototype, "cache", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", Logger)
+], PlatformCacheInterceptor.prototype, "logger", void 0);
 PlatformCacheInterceptor = __decorate([
     Interceptor()
 ], PlatformCacheInterceptor);

package/lib/esm/interceptors/PlatformCacheInterceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformCacheInterceptor.js","sourceRoot":"","sources":["../../../src/interceptors/PlatformCacheInterceptor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,SAAS,EAAE,MAAM,EAAE,WAAW,EAA0D,MAAM,UAAU,CAAC;AAC9H,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,MAAM,CAAC;AAGrD,OAAO,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAC;AAExD,MAAM,YAAY,GAAG,CAAC,OAAgC,EAAE,EAAE;IACxD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC3B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACrF,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAChC,OAAO;YACL,GAAG,OAAO;YACV,CAAC,GAAG,CAAC,EAAE,KAAK;SACb,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;GAEG;AAEH,IAAa,wBAAwB,GAArC,MAAa,wBAAwB;IAInC,KAAK,CAAC,SAAS,CAAC,OAAsD,EAAE,IAAqB;QAC3F,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACxC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAES,OAAO,CAAC,OAA0D;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACvC,IAAI,GAAG,YAAY,SAAS,IAAI,GAAG,YAAY,eAAe,IAAI,GAAG,YAAY,cAAc,EAAE;gBAC/F,OAAO,IAAI,CAAC;aACb;YAED,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE;gBAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;aACpC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAES,UAAU,CAAC,OAAsD;QACzE,MAAM,EAAC,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAC,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QAEpG,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE1C,OAAO,EAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAC,CAAC;IACpD,CAAC;IAES,UAAU,CAAC,EAAC,MAAM,EAAE,WAAW,EAAgD;QACvF,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACpE,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,OAAsD,EAAE,IAAqB;QACvG,MAAM,EAAC,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5E,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7E,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAuB,GAAG,CAAC,CAAC;QAErE,IAAI,YAAY,EAAE;YAChB,MAAM,EAAC,IAAI,EAAC,GAAG,YAAY,CAAC;YAE5B,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC,CAAC;SAC9D;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAElD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAClB,GAAG,EACH;YACE,GAAG,EAAE,aAAa;YAClB,IAAI;YACJ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,cAAc,EAAC,CAAC,CAAC;SAChE,EACD;YACE,GAAG,EAAE,aAAa;SACnB,CACF,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,OAAsD,EAAE,IAAqB;QACzG,MAAM,IAAI,GAAgB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAEjC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE;YAC5B,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,EAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAuB,GAAG,CAAC,CAAC;QAErE,IAAI,YAAY,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,UAAU,CAAC,EAAE;YACnE,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SAC9C;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAE5B,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QAClD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YACvB,eAAe,EAAE,WAAW,aAAa,EAAE;SAC5C,CAAC,CAAC;QAEH,iDAAiD;QACjD,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YAChD,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YAEpD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAClB,GAAG,EACH;gBACE,GAAG,EAAE,aAAa;gBAClB,IAAI;gBACJ,IAAI;gBACJ,OAAO;gBACP,OAAO;aACR,EACD;gBACE,GAAG,EAAE,aAAa;aACnB,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,YAAY,CAAC,YAAkC,EAAE,IAAiB;QAC1E,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,YAAY,CAAC;QACpC,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEjD,IAAI,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;YAC/C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEzD,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,QAAQ;aACV,UAAU,CAAC;YACV,GAAG,OAAO;YACV,UAAU,EAAE,MAAM;YAClB,eAAe,EAAE,WAAW,GAAG,EAAE;SAClC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAhJC;IADC,MAAM,EAAE;8BACQ,aAAa;uDAAC;AAFpB,wBAAwB;IADpC,WAAW,EAAE;GACD,wBAAwB,CAkJpC;SAlJY,wBAAwB","sourcesContent":["import {isClass, isString, nameOf, Store} from \"@tsed/core\";\nimport {BaseContext, DIContext, Inject, Interceptor, InterceptorContext, InterceptorMethods, InterceptorNext} from \"@tsed/di\";\nimport {deserialize, serialize} from \"@tsed/json-mapper\";\nimport {JsonEntityStore} from \"@tsed/schema\";\nimport {IncomingMessage, ServerResponse} from \"http\";\nimport {PlatformCachedObject} from \"../interfaces/PlatformCachedObject\";\nimport {PlatformCacheOptions} from \"../interfaces/PlatformCacheOptions\";\nimport {PlatformCache} from \"../services/PlatformCache\";\n\nconst cleanHeaders = (headers: Record<string, unknown>) => {\n  return Object.entries(headers)\n    .filter(([key]) => ![\"content-length\", \"x-request-id\", \"cache-control\"].includes(key))\n    .reduce((headers, [key, value]) => {\n      return {\n        ...headers,\n        [key]: value\n      };\n    }, {});\n};\n\n/**\n * @platform\n */\n@Interceptor()\nexport class PlatformCacheInterceptor implements InterceptorMethods {\n  @Inject()\n  protected cache: PlatformCache;\n\n  async intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    if (this.cache.disabled()) {\n      return next();\n    }\n\n    if (!this.isEndpoint(context)) {\n      return this.cacheMethod(context, next);\n    }\n\n    return this.cacheResponse(context, next);\n  }\n\n  protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>) {\n    return context.args.reduce((args, arg) => {\n      if (arg instanceof DIContext || arg instanceof IncomingMessage || arg instanceof ServerResponse) {\n        return args;\n      }\n\n      if (isClass(arg)) {\n        return args.concat(serialize(arg));\n      }\n\n      return args.concat(arg);\n    }, []);\n  }\n\n  protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>) {\n    const {ttl, type, collectionType, key: k = this.cache.defaultKeyResolver()} = context.options || {};\n\n    const args = this.getArgs(context);\n    const keyArgs = isString(k) ? k : k(args);\n\n    return {ttl, type, args, collectionType, keyArgs};\n  }\n\n  protected isEndpoint({target, propertyKey}: InterceptorContext<any, PlatformCacheOptions>) {\n    return Store.fromMethod(target, propertyKey).has(JsonEntityStore);\n  }\n\n  protected async cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    const {ttl, type, collectionType, keyArgs, args} = this.getOptions(context);\n    const key = [nameOf(context.target), context.propertyKey, keyArgs].join(\":\");\n\n    const cachedObject = await this.cache.get<PlatformCachedObject>(key);\n\n    if (cachedObject) {\n      const {data} = cachedObject;\n\n      return deserialize(JSON.parse(data), {collectionType, type});\n    }\n\n    const result = await next();\n    const calculatedTtl = this.cache.ttl(result, ttl);\n\n    await this.cache.set<PlatformCachedObject>(\n      key,\n      {\n        ttl: calculatedTtl,\n        args,\n        data: JSON.stringify(serialize(result, {type, collectionType}))\n      },\n      {\n        ttl: calculatedTtl\n      }\n    );\n\n    return result;\n  }\n\n  protected async cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    const $ctx: BaseContext = context.args[context.args.length - 1];\n    const {request, response} = $ctx;\n\n    if (request.method !== \"GET\") {\n      return next();\n    }\n\n    const {ttl, args, keyArgs} = this.getOptions(context);\n\n    const key = [request.method, request.url, keyArgs].join(\":\");\n\n    const cachedObject = await this.cache.get<PlatformCachedObject>(key);\n\n    if (cachedObject && !(response.get(\"cache-control\") === \"no-cache\")) {\n      return this.sendResponse(cachedObject, $ctx);\n    }\n\n    const result = await next();\n\n    const calculatedTtl = this.cache.ttl(result, ttl);\n    const expires = calculatedTtl + Date.now() / 1000;\n    $ctx.response.setHeaders({\n      \"cache-control\": `max-age=${calculatedTtl}`\n    });\n\n    // cache final response with his headers and body\n    response.onEnd(async () => {\n      const data = JSON.stringify(response.getBody());\n      const headers = cleanHeaders(response.getHeaders());\n\n      await this.cache.set<PlatformCachedObject>(\n        key,\n        {\n          ttl: calculatedTtl,\n          args,\n          data,\n          expires,\n          headers\n        },\n        {\n          ttl: calculatedTtl\n        }\n      );\n    });\n\n    return result;\n  }\n\n  protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext) {\n    const {headers, ttl} = cachedObject;\n    const {request, response} = $ctx;\n\n    const requestEtag = request.get(\"if-none-match\");\n\n    if (requestEtag && headers.etag === requestEtag) {\n      response.status(304).setHeaders(headers).body(undefined);\n\n      return undefined;\n    }\n\n    const data = JSON.parse(cachedObject.data);\n\n    $ctx.response\n      .setHeaders({\n        ...headers,\n        \"x-cached\": \"true\",\n        \"cache-control\": `max-age=${ttl}`\n      })\n      .body(data);\n\n    return data;\n  }\n}\n"]}
+{"version":3,"file":"PlatformCacheInterceptor.js","sourceRoot":"","sources":["../../../src/interceptors/PlatformCacheInterceptor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,SAAS,EAAE,MAAM,EAAE,WAAW,EAA0D,MAAM,UAAU,CAAC;AAC9H,OAAO,EAAC,WAAW,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAC;AACpC,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,MAAM,CAAC;AAGrD,OAAO,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAC;AAExD,MAAM,YAAY,GAAG,CAAC,OAAgC,EAAE,EAAE;IACxD,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;SAC3B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACrF,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAChC,OAAO;YACL,GAAG,OAAO;YACV,CAAC,GAAG,CAAC,EAAE,KAAK;SACb,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;GAEG;AAEH,IAAa,wBAAwB,GAArC,MAAa,wBAAwB;IAEzB,KAAK,CAAgB;IAGrB,MAAM,CAAS;IAEzB,KAAK,CAAC,SAAS,CAAC,OAAsD,EAAE,IAAqB;QAC3F,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;YACzB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACxC;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,GAAW,EAAE,EAAC,gBAAgB,EAAE,GAAG,EAAwC,EAAE,IAAc;QACtH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAE9C,IAAI,gBAAgB,IAAI,CAAC,OAAO,EAAE;YAChC,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;YAE/D,IAAI,UAAU,GAAG,aAAa,GAAG,gBAAgB,EAAE;gBACjD,MAAM,IAAI,EAAE,CAAC;aACd;YAED,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;SACpC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAsD,EAAE,IAAqB;QAC7F,MAAM,EAAC,IAAI,EAAE,GAAG,EAAE,cAAc,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC9F,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7E,MAAM,GAAG,GAAG,CAAC,MAAW,EAAE,EAAE;YAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC3D,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,cAAc,EAAC,CAAC,CAAC;YACvD,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,EAAC,IAAI,EAAE,GAAG,EAAE,aAAa,EAAC,CAAC,CAAC;QACpE,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAE3D,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAE5B,GAAG,CAAC,MAAM,CAAC,CAAC;YAEZ,OAAO,MAAM,CAAC;SACf;QAED,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,EAAC,gBAAgB,EAAE,GAAG,EAAC,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAChB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,EAAE;SACV,CAAC,CACH,CAAC;QAEF,MAAM,EAAC,IAAI,EAAC,GAAG,YAAY,CAAC;QAE5B,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAsD,EAAE,IAAqB;QAC/F,MAAM,IAAI,GAAgB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAEjC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE;YAC5B,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,EAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAE3D,IAAI,YAAY,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,UAAU,CAAC,EAAE;YAClE,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SAC9C;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAE5B,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE3D,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YACvB,eAAe,EAAE,WAAW,aAAa,EAAE;SAC5C,CAAC,CAAC;QAEH,iDAAiD;QACjD,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,EAAE;gBAClD,GAAG,EAAE,aAAa;gBAClB,IAAI;gBACJ,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;aAC7C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,OAAO,CAAC,OAA0D;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACvC,IAAI,GAAG,YAAY,SAAS,IAAI,GAAG,YAAY,eAAe,IAAI,GAAG,YAAY,cAAc,EAAE;gBAC/F,OAAO,IAAI,CAAC;aACb;YAED,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE;gBAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;aACpC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAES,UAAU,CAAC,OAAsD;QACzE,MAAM,EAAC,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,gBAAgB,EAAC,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QAEtH,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE1C,OAAO,EAAC,gBAAgB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAC,CAAC;IACtE,CAAC;IAES,UAAU,CAAC,EAAC,MAAM,EAAE,WAAW,EAAgD;QACvF,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACpE,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,GAAW;QACvC,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,GAAW;QACvC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,GAAG,EAAE,EAAE,IAAI,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,CAAC,CAAC;IAC3D,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,GAAW;QAC5C,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC;IACzC,CAAC;IAES,YAAY,CAAC,YAAkC,EAAE,IAAiB;QAC1E,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,YAAY,CAAC;QACpC,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,IAAI,CAAC;QAEjC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAEjD,IAAI,WAAW,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;YAC/C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEzD,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,QAAQ;aACV,UAAU,CAAC;YACV,GAAG,OAAO;YACV,UAAU,EAAE,MAAM;YAClB,eAAe,EAAE,WAAW,GAAG,EAAE;SAClC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AA1KC;IADC,MAAM,EAAE;8BACQ,aAAa;uDAAC;AAG/B;IADC,MAAM,EAAE;8BACS,MAAM;wDAAC;AALd,wBAAwB;IADpC,WAAW,EAAE;GACD,wBAAwB,CA4KpC;SA5KY,wBAAwB","sourcesContent":["import {isClass, isString, nameOf, Store} from \"@tsed/core\";\nimport {BaseContext, DIContext, Inject, Interceptor, InterceptorContext, InterceptorMethods, InterceptorNext} from \"@tsed/di\";\nimport {deserialize, serialize} from \"@tsed/json-mapper\";\nimport {Logger} from \"@tsed/logger\";\nimport {JsonEntityStore} from \"@tsed/schema\";\nimport {IncomingMessage, ServerResponse} from \"http\";\nimport {PlatformCachedObject} from \"../interfaces/PlatformCachedObject\";\nimport {PlatformCacheOptions} from \"../interfaces/PlatformCacheOptions\";\nimport {PlatformCache} from \"../services/PlatformCache\";\n\nconst cleanHeaders = (headers: Record<string, unknown>) => {\n  return Object.entries(headers)\n    .filter(([key]) => ![\"content-length\", \"x-request-id\", \"cache-control\"].includes(key))\n    .reduce((headers, [key, value]) => {\n      return {\n        ...headers,\n        [key]: value\n      };\n    }, {});\n};\n\n/**\n * @platform\n */\n@Interceptor()\nexport class PlatformCacheInterceptor implements InterceptorMethods {\n  @Inject()\n  protected cache: PlatformCache;\n\n  @Inject()\n  protected logger: Logger;\n\n  async intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    if (this.cache.disabled()) {\n      return next();\n    }\n\n    if (!this.isEndpoint(context)) {\n      return this.cacheMethod(context, next);\n    }\n\n    return this.cacheResponse(context, next);\n  }\n\n  async canRefreshInBackground(key: string, {refreshThreshold, ttl}: {refreshThreshold?: number; ttl: any}, next: Function) {\n    const inQueue = await this.hasKeyInQueue(key);\n\n    if (refreshThreshold && !inQueue) {\n      await this.addKeyToQueue(key);\n\n      const currentTTL = await this.cache.ttl(key);\n      const calculatedTTL = this.cache.calculateTTL(currentTTL, ttl);\n\n      if (currentTTL < calculatedTTL - refreshThreshold) {\n        await next();\n      }\n\n      await this.deleteKeyFromQueue(key);\n    }\n  }\n\n  async cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    const {type, ttl, collectionType, refreshThreshold, keyArgs, args} = this.getOptions(context);\n    const key = [nameOf(context.target), context.propertyKey, keyArgs].join(\":\");\n\n    const set = (result: any) => {\n      const calculatedTTL = this.cache.calculateTTL(result, ttl);\n      const data = serialize(result, {type, collectionType});\n      this.cache.setCachedObject(key, data, {args, ttl: calculatedTTL});\n    };\n\n    const cachedObject = await this.cache.getCachedObject(key);\n\n    if (!cachedObject) {\n      const result = await next();\n\n      set(result);\n\n      return result;\n    }\n\n    this.canRefreshInBackground(key, {refreshThreshold, ttl}, async () => {\n      const result = await next();\n      await set(result);\n    }).catch((er) =>\n      this.logger.error({\n        event: \"CACHE_ERROR\",\n        method: \"cacheMethod\",\n        error: er\n      })\n    );\n\n    const {data} = cachedObject;\n\n    return deserialize(JSON.parse(data), {collectionType, type});\n  }\n\n  async cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext) {\n    const $ctx: BaseContext = context.args[context.args.length - 1];\n    const {request, response} = $ctx;\n\n    if (request.method !== \"GET\") {\n      return next();\n    }\n\n    const {ttl, args, keyArgs} = this.getOptions(context);\n    const key = [request.method, request.url, keyArgs].join(\":\");\n\n    const cachedObject = await this.cache.getCachedObject(key);\n\n    if (cachedObject && !(request.get(\"cache-control\") === \"no-cache\")) {\n      return this.sendResponse(cachedObject, $ctx);\n    }\n\n    const result = await next();\n\n    const calculatedTTL = this.cache.calculateTTL(result, ttl);\n\n    $ctx.response.setHeaders({\n      \"cache-control\": `max-age=${calculatedTTL}`\n    });\n\n    // cache final response with his headers and body\n    response.onEnd(async () => {\n      this.cache.setCachedObject(key, response.getBody(), {\n        ttl: calculatedTTL,\n        args,\n        headers: cleanHeaders(response.getHeaders())\n      });\n    });\n\n    return result;\n  }\n\n  protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>) {\n    return context.args.reduce((args, arg) => {\n      if (arg instanceof DIContext || arg instanceof IncomingMessage || arg instanceof ServerResponse) {\n        return args;\n      }\n\n      if (isClass(arg)) {\n        return args.concat(serialize(arg));\n      }\n\n      return args.concat(arg);\n    }, []);\n  }\n\n  protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>) {\n    const {ttl, type, collectionType, key: k = this.cache.defaultKeyResolver(), refreshThreshold} = context.options || {};\n\n    const args = this.getArgs(context);\n    const keyArgs = isString(k) ? k : k(args);\n\n    return {refreshThreshold, ttl, type, args, collectionType, keyArgs};\n  }\n\n  protected isEndpoint({target, propertyKey}: InterceptorContext<any, PlatformCacheOptions>) {\n    return Store.fromMethod(target, propertyKey).has(JsonEntityStore);\n  }\n\n  protected async hasKeyInQueue(key: string) {\n    return !!(await this.cache.get(`$$queue:${key}`));\n  }\n\n  protected async addKeyToQueue(key: string) {\n    await this.cache.set(`$$queue:${key}`, true, {ttl: 120});\n  }\n\n  protected async deleteKeyFromQueue(key: string) {\n    await this.cache.del(`$$queue:${key}`);\n  }\n\n  protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext) {\n    const {headers, ttl} = cachedObject;\n    const {request, response} = $ctx;\n\n    const requestEtag = request.get(\"if-none-match\");\n\n    if (requestEtag && headers.etag === requestEtag) {\n      response.status(304).setHeaders(headers).body(undefined);\n\n      return undefined;\n    }\n\n    const data = JSON.parse(cachedObject.data);\n\n    $ctx.response\n      .setHeaders({\n        ...headers,\n        \"x-cached\": \"true\",\n        \"cache-control\": `max-age=${ttl}`\n      })\n      .body(data);\n\n    return data;\n  }\n}\n"]}

package/lib/esm/interfaces/PlatformCacheOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformCacheOptions.js","sourceRoot":"","sources":["../../../src/interfaces/PlatformCacheOptions.ts"],"names":[],"mappings":"","sourcesContent":["import {MetadataTypes} from \"@tsed/core\";\nimport {BaseContext} from \"@tsed/di\";\nimport type {TtlFunction} from \"cache-manager\";\n\nexport interface PlatformCacheOptions extends MetadataTypes {\n  ttl?: number | TtlFunction;\n  key?: string | ((args: any[], ctx?: BaseContext) => string);\n}\n"]}
+{"version":3,"file":"PlatformCacheOptions.js","sourceRoot":"","sources":["../../../src/interfaces/PlatformCacheOptions.ts"],"names":[],"mappings":"","sourcesContent":["import {MetadataTypes} from \"@tsed/core\";\nimport {BaseContext} from \"@tsed/di\";\nimport type {TtlFunction} from \"cache-manager\";\n\nexport interface PlatformCacheOptions extends MetadataTypes {\n  ttl?: number | TtlFunction;\n  key?: string | ((args: any[], ctx?: BaseContext) => string);\n  refreshThreshold?: number;\n}\n"]}

package/lib/esm/interfaces/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interfaces.js.map

package/lib/esm/interfaces/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/interfaces/interfaces.ts"],"names":[],"mappings":"","sourcesContent":["import type {BaseContext} from \"@tsed/di\";\nimport type {Cache, CacheOptions, CachingConfig, Store} from \"cache-manager\";\nimport type {CacheManager} from \"../services/PlatformCache\";\n\nexport interface PlatformCacheSettings extends CacheOptions, CachingConfig {\n  caches?: Cache[];\n  store?:\n    | \"memory\"\n    | \"none\"\n    | Store\n    | {\n        create(...args: any[]): Store;\n      }\n    | (() => any);\n  max?: number;\n  keyResolver?: (args: any[], ctx: BaseContext) => string;\n\n  /**\n   * You may pass in any other arguments these will be passed on to the `create` method of your store,\n   * otherwise they will be ignored.\n   */\n  [key: string]: any;\n}\n\ndeclare global {\n  // eslint-disable-next-line @typescript-eslint/no-namespace\n  namespace TsED {\n    interface Configuration {\n      cache?: PlatformCacheSettings | false;\n    }\n  }\n}\n\nexport interface OnCreateCacheManager {\n  $onCreateCacheManager(cache: CacheManager): void | Promise<void>;\n}\n"]}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/lib/esm/services/PlatformCache.js

@@ -1,7 +1,8 @@
 import { __decorate, __metadata } from "tslib";
 import { isClass, isFunction } from "@tsed/core";
-import { Configuration, Module } from "@tsed/di";
+import { Configuration, Inject, InjectorService, Module } from "@tsed/di";
 import { deserialize, serialize } from "@tsed/json-mapper";
+import { Logger } from "@tsed/logger";
 const defaultKeyResolver = (args) => {
     return args.map((arg) => (isClass(arg) ? JSON.stringify(serialize(arg)) : arg)).join(":");
 };
@@ -9,53 +10,89 @@ const defaultKeyResolver = (args) => {
  * @platform
  */
 let PlatformCache = class PlatformCache {
-    disabled() {
-        return !this.settings.get("cache");
+    settings;
+    injector;
+    logger;
+    #cache;
+    get cache() {
+        return this.#cache;
     }
     async $onInit() {
         const settings = this.settings.get("cache");
         if (settings) {
-            this.cache = await this.createCacheManager(settings);
+            this.#cache = await this.createCacheManager(settings);
+            await this.injector.emit("$onCreateCacheManager", this.#cache);
         }
     }
+    disabled() {
+        return !this.settings.get("cache");
+    }
     defaultKeyResolver() {
         return this.settings.get("cache.keyResolver", defaultKeyResolver);
     }
     defaultTtl() {
         return this.settings.get("cache.ttl");
     }
-    ttl(result, currentTtl) {
+    calculateTTL(result, currentTtl) {
         const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;
         return isFunction(ttl) ? ttl(result) : ttl;
     }
+    async ttl(key) {
+        if (this.cache && "store" in this.cache && this.cache.store.ttl) {
+            return this.cache.store.ttl(key);
+        }
+    }
     wrap(key, fetch, options) {
-        var _a;
         if (!this.cache) {
             return fetch();
         }
-        return (_a = this.cache) === null || _a === void 0 ? void 0 : _a.wrap(key, fetch, options);
+        return this.cache?.wrap(key, fetch, options);
     }
     async get(key, options = {}) {
-        var _a;
-        return deserialize((_a = this.cache) === null || _a === void 0 ? void 0 : _a.get(key), options);
+        return deserialize(this.cache?.get(key), options);
     }
     async set(key, value, options) {
-        var _a;
-        return (_a = this.cache) === null || _a === void 0 ? void 0 : _a.set(key, value, options);
+        return this.cache?.set(key, value, options);
+    }
+    async getCachedObject(key) {
+        try {
+            return await this.get(key);
+        }
+        catch (er) {
+            this.logger.error({
+                event: "CACHE_ERROR",
+                method: "getCachedObject",
+                error: er
+            });
+        }
+    }
+    async setCachedObject(key, data, opts) {
+        try {
+            await this.set(key, {
+                ...opts,
+                data: JSON.stringify(data)
+            }, {
+                ttl: opts.ttl
+            });
+        }
+        catch (er) {
+            this.logger.error({
+                event: "CACHE_ERROR",
+                method: "setCachedObject",
+                error: er
+            });
+        }
     }
     async del(key) {
-        var _a;
-        await ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.del(key));
+        await this.cache?.del(key);
     }
     async reset() {
-        var _a;
         // @ts-ignore
-        await ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.reset());
+        await this.cache?.reset();
     }
-    async keys() {
-        var _a;
-        if ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.keys) {
-            return this.cache.keys();
+    async keys(...args) {
+        if (this.cache && "store" in this.cache && this.cache.store.keys) {
+            return this.cache.store.keys(...args);
         }
         // istanbul ignore next
         return [];
@@ -73,7 +110,7 @@ let PlatformCache = class PlatformCache {
         const { caches, store = "memory", ttl, ...props } = settings;
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const { default: cacheManager } = await import("cache-manager");
-        return (caches === null || caches === void 0 ? void 0 : caches.length)
+        return caches?.length
             ? cacheManager.multiCaching(caches, { ...props })
             : cacheManager.caching({
                 ...props,
@@ -86,6 +123,14 @@ __decorate([
     Configuration(),
     __metadata("design:type", Object)
 ], PlatformCache.prototype, "settings", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", InjectorService)
+], PlatformCache.prototype, "injector", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", Logger)
+], PlatformCache.prototype, "logger", void 0);
 PlatformCache = __decorate([
     Module()
 ], PlatformCache);

package/lib/esm/services/PlatformCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformCache.js","sourceRoot":"","sources":["../../../src/services/PlatformCache.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,OAAO,EAAE,UAAU,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,aAAa,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,WAAW,EAA2B,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAIlF,MAAM,kBAAkB,GAAG,CAAC,IAAW,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjG,CAAC,CAAC;AAMF;;GAEG;AAEH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAMxB,QAAQ;QACN,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;QAEnE,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;SACtD;IACH,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAqC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;IACxG,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAuB,WAAW,CAAC,CAAC;IAC9D,CAAC;IAED,GAAG,CAAC,MAAY,EAAE,UAAiC;QACjD,MAAM,GAAG,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED,IAAI,CAAI,GAAW,EAAE,KAAuB,EAAE,OAAuB;;QACnE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO,KAAK,EAAE,CAAC;SAChB;QAED,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,CAAI,GAAG,EAAE,KAAK,EAAE,OAAc,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,UAAmC,EAAE;;QAC7D,OAAO,WAAW,CAAC,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAI,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAU,EAAE,OAAuB;;QAC3D,OAAO,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAI,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;;QACnB,MAAM,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,GAAG,CAAC,GAAG,CAAC,CAAA,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,aAAa;QACb,MAAM,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,KAAK,EAAE,CAAA,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI;;QACR,IAAI,MAAA,IAAI,CAAC,KAAK,0CAAE,IAAI,EAAE;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAgB;QACpC,MAAM,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,UAAU,EAAC,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE7F,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,QAAgB;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAElD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,QAA+B;QAChE,MAAM,EAAC,MAAM,EAAE,KAAK,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,KAAK,EAAC,GAAG,QAAQ,CAAC;QAC3D,6DAA6D;QAC7D,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;QAE9D,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM;YACnB,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,GAAG,KAAK,EAAC,CAAC;YAC/C,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;gBACnB,GAAG,KAAK;gBACR,GAAG;gBACH,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK;aACjD,CAAC,CAAC;IACT,CAAC;CACF,CAAA;AA1FC;IADC,aAAa,EAAE;;+CACQ;AAFb,aAAa;IADzB,MAAM,EAAE;GACI,aAAa,CA4FzB;SA5FY,aAAa","sourcesContent":["import {isClass, isFunction} from \"@tsed/core\";\nimport {Configuration, Module} from \"@tsed/di\";\nimport {deserialize, JsonDeserializerOptions, serialize} from \"@tsed/json-mapper\";\nimport type {Cache, CachingConfig, MultiCache, TtlFunction} from \"cache-manager\";\nimport {PlatformCacheSettings} from \"../interfaces\";\n\nconst defaultKeyResolver = (args: any[]) => {\n  return args.map((arg: any) => (isClass(arg) ? JSON.stringify(serialize(arg)) : arg)).join(\":\");\n};\n\nexport type CacheManager = (Cache | MultiCache) & {\n  keys?(): Promise<string[]>;\n};\n\n/**\n * @platform\n */\n@Module()\nexport class PlatformCache {\n  @Configuration()\n  settings: Configuration;\n\n  cache: CacheManager | undefined;\n\n  disabled(): boolean {\n    return !this.settings.get<PlatformCacheSettings>(\"cache\");\n  }\n\n  async $onInit() {\n    const settings = this.settings.get<PlatformCacheSettings>(\"cache\");\n\n    if (settings) {\n      this.cache = await this.createCacheManager(settings);\n    }\n  }\n\n  defaultKeyResolver() {\n    return this.settings.get<(args: any[], ctx?: any) => string>(\"cache.keyResolver\", defaultKeyResolver);\n  }\n\n  defaultTtl() {\n    return this.settings.get<number | TtlFunction>(\"cache.ttl\");\n  }\n\n  ttl(result?: any, currentTtl?: number | TtlFunction) {\n    const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;\n\n    return isFunction(ttl) ? ttl(result) : ttl;\n  }\n\n  wrap<T>(key: string, fetch: () => Promise<T>, options?: CachingConfig): Promise<T> {\n    if (!this.cache) {\n      return fetch();\n    }\n\n    return this.cache?.wrap<T>(key, fetch, options as any);\n  }\n\n  async get<T>(key: string, options: JsonDeserializerOptions = {}): Promise<T | undefined> {\n    return deserialize(this.cache?.get<T>(key), options);\n  }\n\n  async set<T>(key: string, value: any, options?: CachingConfig): Promise<T | undefined> {\n    return this.cache?.set<T>(key, value, options);\n  }\n\n  async del(key: string): Promise<void> {\n    await this.cache?.del(key);\n  }\n\n  async reset(): Promise<void> {\n    // @ts-ignore\n    await this.cache?.reset();\n  }\n\n  async keys(): Promise<string[]> {\n    if (this.cache?.keys) {\n      return this.cache.keys();\n    }\n    // istanbul ignore next\n    return [];\n  }\n\n  async getMatchingKeys(patterns: string): Promise<string[]> {\n    const [keys, {default: micromatch}] = await Promise.all([this.keys(), import(\"micromatch\")]);\n\n    return micromatch(keys, patterns);\n  }\n\n  async deleteMatchingKeys(patterns: string): Promise<string[]> {\n    const keys = await this.getMatchingKeys(patterns);\n\n    await Promise.all(keys.map((key: string) => this.del(key)));\n\n    return keys;\n  }\n\n  protected async createCacheManager(settings: PlatformCacheSettings) {\n    const {caches, store = \"memory\", ttl, ...props} = settings;\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const {default: cacheManager} = await import(\"cache-manager\");\n\n    return caches?.length\n      ? cacheManager.multiCaching(caches, {...props})\n      : cacheManager.caching({\n          ...props,\n          ttl,\n          store: isFunction(store) ? await store() : store\n        });\n  }\n}\n"]}
+{"version":3,"file":"PlatformCache.js","sourceRoot":"","sources":["../../../src/services/PlatformCache.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,OAAO,EAAE,UAAU,EAAC,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAC,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AACxE,OAAO,EAAC,WAAW,EAA2B,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAIlF,OAAO,EAAC,MAAM,EAAC,MAAM,cAAc,CAAC;AAEpC,MAAM,kBAAkB,GAAG,CAAC,IAAW,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjG,CAAC,CAAC;AAIF;;GAEG;AAEH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAEd,QAAQ,CAAgB;IAGxB,QAAQ,CAAkB;IAG1B,MAAM,CAAS;IAEzB,MAAM,CAA2B;IAEjC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;QAEnE,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YAEtD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAChE;IACH,CAAC;IAED,QAAQ;QACN,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAqC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;IACxG,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAuB,WAAW,CAAC,CAAC;IAC9D,CAAC;IAED,YAAY,CAAC,MAAY,EAAE,UAAiC;QAC1D,MAAM,GAAG,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;QAEtE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAClC;IACH,CAAC;IAED,IAAI,CAAI,GAAW,EAAE,KAAuB,EAAE,OAAuB;QACnE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,OAAO,KAAK,EAAE,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,IAAI,CAAI,GAAG,EAAE,KAAK,EAAE,OAAc,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,UAAmC,EAAE;QAC7D,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAI,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAU,EAAE,OAAuB;QAC3D,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,CAAI,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW;QAC/B,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,GAAG,CAAuB,GAAG,CAAC,CAAC;SAClD;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,aAAa;gBACpB,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,EAAE;aACV,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW,EAAE,IAAS,EAAE,IAAyC;QACrF,IAAI;YACF,MAAM,IAAI,CAAC,GAAG,CACZ,GAAG,EACH;gBACE,GAAG,IAAI;gBACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,EACD;gBACE,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CACF,CAAC;SACH;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,KAAK,EAAE,aAAa;gBACpB,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,EAAE;aACV,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,KAAK;QACT,aAAa;QACb,MAAM,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAG,IAAW;QACvB,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;YAChE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;SACvC;QAED,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAgB;QACpC,MAAM,CAAC,IAAI,EAAE,EAAC,OAAO,EAAE,UAAU,EAAC,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE7F,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,QAAgB;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAElD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE5D,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,QAA+B;QAChE,MAAM,EAAC,MAAM,EAAE,KAAK,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,KAAK,EAAC,GAAG,QAAQ,CAAC;QAC3D,6DAA6D;QAC7D,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC;QAE9D,OAAO,MAAM,EAAE,MAAM;YACnB,CAAC,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,GAAG,KAAK,EAAC,CAAC;YAC/C,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC;gBACnB,GAAG,KAAK;gBACR,GAAG;gBACH,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK;aACjD,CAAC,CAAC;IACT,CAAC;CACF,CAAA;AA9IC;IADC,aAAa,EAAE;;+CACkB;AAGlC;IADC,MAAM,EAAE;8BACW,eAAe;+CAAC;AAGpC;IADC,MAAM,EAAE;8BACS,MAAM;6CAAC;AARd,aAAa;IADzB,MAAM,EAAE;GACI,aAAa,CAgJzB;SAhJY,aAAa","sourcesContent":["import {isClass, isFunction} from \"@tsed/core\";\nimport {Configuration, Inject, InjectorService, Module} from \"@tsed/di\";\nimport {deserialize, JsonDeserializerOptions, serialize} from \"@tsed/json-mapper\";\nimport type {Cache, CachingConfig, MultiCache, TtlFunction} from \"cache-manager\";\nimport {PlatformCachedObject} from \"../interfaces/PlatformCachedObject\";\nimport {PlatformCacheSettings} from \"../interfaces/interfaces\";\nimport {Logger} from \"@tsed/logger\";\n\nconst defaultKeyResolver = (args: any[]) => {\n  return args.map((arg: any) => (isClass(arg) ? JSON.stringify(serialize(arg)) : arg)).join(\":\");\n};\n\nexport type CacheManager = Cache | MultiCache;\n\n/**\n * @platform\n */\n@Module()\nexport class PlatformCache {\n  @Configuration()\n  protected settings: Configuration;\n\n  @Inject()\n  protected injector: InjectorService;\n\n  @Inject()\n  protected logger: Logger;\n\n  #cache: CacheManager | undefined;\n\n  get cache() {\n    return this.#cache;\n  }\n\n  async $onInit() {\n    const settings = this.settings.get<PlatformCacheSettings>(\"cache\");\n\n    if (settings) {\n      this.#cache = await this.createCacheManager(settings);\n\n      await this.injector.emit(\"$onCreateCacheManager\", this.#cache);\n    }\n  }\n\n  disabled(): boolean {\n    return !this.settings.get<PlatformCacheSettings>(\"cache\");\n  }\n\n  defaultKeyResolver() {\n    return this.settings.get<(args: any[], ctx?: any) => string>(\"cache.keyResolver\", defaultKeyResolver);\n  }\n\n  defaultTtl() {\n    return this.settings.get<number | TtlFunction>(\"cache.ttl\");\n  }\n\n  calculateTTL(result?: any, currentTtl?: number | TtlFunction) {\n    const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;\n\n    return isFunction(ttl) ? ttl(result) : ttl;\n  }\n\n  async ttl(key: string) {\n    if (this.cache && \"store\" in this.cache && this.cache.store.ttl) {\n      return this.cache.store.ttl(key);\n    }\n  }\n\n  wrap<T>(key: string, fetch: () => Promise<T>, options?: CachingConfig): Promise<T> {\n    if (!this.cache) {\n      return fetch();\n    }\n\n    return this.cache?.wrap<T>(key, fetch, options as any);\n  }\n\n  async get<T>(key: string, options: JsonDeserializerOptions = {}): Promise<T | undefined> {\n    return deserialize(this.cache?.get<T>(key), options);\n  }\n\n  async set<T>(key: string, value: any, options?: CachingConfig): Promise<T | undefined> {\n    return this.cache?.set<T>(key, value, options);\n  }\n\n  async getCachedObject(key: string) {\n    try {\n      return await this.get<PlatformCachedObject>(key);\n    } catch (er) {\n      this.logger.error({\n        event: \"CACHE_ERROR\",\n        method: \"getCachedObject\",\n        error: er\n      });\n    }\n  }\n\n  async setCachedObject(key: string, data: any, opts: {ttl: number} & Record<string, any>) {\n    try {\n      await this.set<PlatformCachedObject>(\n        key,\n        {\n          ...opts,\n          data: JSON.stringify(data)\n        },\n        {\n          ttl: opts.ttl\n        }\n      );\n    } catch (er) {\n      this.logger.error({\n        event: \"CACHE_ERROR\",\n        method: \"setCachedObject\",\n        error: er\n      });\n    }\n  }\n\n  async del(key: string): Promise<void> {\n    await this.cache?.del(key);\n  }\n\n  async reset(): Promise<void> {\n    // @ts-ignore\n    await this.cache?.reset();\n  }\n\n  async keys(...args: any[]): Promise<string[]> {\n    if (this.cache && \"store\" in this.cache && this.cache.store.keys) {\n      return this.cache.store.keys(...args);\n    }\n\n    // istanbul ignore next\n    return [];\n  }\n\n  async getMatchingKeys(patterns: string): Promise<string[]> {\n    const [keys, {default: micromatch}] = await Promise.all([this.keys(), import(\"micromatch\")]);\n\n    return micromatch(keys, patterns);\n  }\n\n  async deleteMatchingKeys(patterns: string): Promise<string[]> {\n    const keys = await this.getMatchingKeys(patterns);\n\n    await Promise.all(keys.map((key: string) => this.del(key)));\n\n    return keys;\n  }\n\n  protected async createCacheManager(settings: PlatformCacheSettings) {\n    const {caches, store = \"memory\", ttl, ...props} = settings;\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const {default: cacheManager} = await import(\"cache-manager\");\n\n    return caches?.length\n      ? cacheManager.multiCaching(caches, {...props})\n      : cacheManager.caching({\n          ...props,\n          ttl,\n          store: isFunction(store) ? await store() : store\n        });\n  }\n}\n"]}

package/lib/types/index.d.ts

@@ -1,3 +1,9 @@
-export * from "./interfaces";
-export * from "./services/PlatformCache";
+/**
+ * @file Automatically generated by barrelsby.
+ */
 export * from "./decorators/useCache";
+export * from "./interceptors/PlatformCacheInterceptor";
+export * from "./interfaces/PlatformCacheOptions";
+export * from "./interfaces/PlatformCachedObject";
+export * from "./interfaces/interfaces";
+export * from "./services/PlatformCache";

package/lib/types/interceptors/PlatformCacheInterceptor.d.ts

@@ -1,4 +1,5 @@
 import { BaseContext, InterceptorContext, InterceptorMethods, InterceptorNext } from "@tsed/di";
+import { Logger } from "@tsed/logger";
 import { PlatformCachedObject } from "../interfaces/PlatformCachedObject";
 import { PlatformCacheOptions } from "../interfaces/PlatformCacheOptions";
 import { PlatformCache } from "../services/PlatformCache";
@@ -7,9 +8,17 @@ import { PlatformCache } from "../services/PlatformCache";
  */
 export declare class PlatformCacheInterceptor implements InterceptorMethods {
     protected cache: PlatformCache;
+    protected logger: Logger;
     intercept(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    canRefreshInBackground(key: string, { refreshThreshold, ttl }: {
+        refreshThreshold?: number;
+        ttl: any;
+    }, next: Function): Promise<void>;
+    cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
     protected getArgs(context: InterceptorContext<unknown, PlatformCacheOptions>): any;
     protected getOptions(context: InterceptorContext<any, PlatformCacheOptions>): {
+        refreshThreshold: number | undefined;
         ttl: number | import("cache-manager").TtlFunction | undefined;
         type: any;
         args: any;
@@ -17,7 +26,8 @@ export declare class PlatformCacheInterceptor implements InterceptorMethods {
         keyArgs: string;
     };
     protected isEndpoint({ target, propertyKey }: InterceptorContext<any, PlatformCacheOptions>): boolean;
-    protected cacheMethod(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
-    protected cacheResponse(context: InterceptorContext<any, PlatformCacheOptions>, next: InterceptorNext): Promise<any>;
+    protected hasKeyInQueue(key: string): Promise<boolean>;
+    protected addKeyToQueue(key: string): Promise<void>;
+    protected deleteKeyFromQueue(key: string): Promise<void>;
     protected sendResponse(cachedObject: PlatformCachedObject, $ctx: BaseContext): any;
 }

package/lib/types/interfaces/PlatformCacheOptions.d.ts

@@ -4,4 +4,5 @@ import type { TtlFunction } from "cache-manager";
 export interface PlatformCacheOptions extends MetadataTypes {
     ttl?: number | TtlFunction;
     key?: string | ((args: any[], ctx?: BaseContext) => string);
+    refreshThreshold?: number;
 }

package/lib/types/interfaces/{index.d.ts → interfaces.d.ts}

@@ -1,6 +1,6 @@
 import type { BaseContext } from "@tsed/di";
 import type { Cache, CacheOptions, CachingConfig, Store } from "cache-manager";
-export * from "./PlatformCachedObject";
+import type { CacheManager } from "../services/PlatformCache";
 export interface PlatformCacheSettings extends CacheOptions, CachingConfig {
     caches?: Cache[];
     store?: "memory" | "none" | Store | {
@@ -21,3 +21,6 @@ declare global {
         }
     }
 }
+export interface OnCreateCacheManager {
+    $onCreateCacheManager(cache: CacheManager): void | Promise<void>;
+}

package/lib/types/services/PlatformCache.d.ts

@@ -1,27 +1,35 @@
-import { Configuration } from "@tsed/di";
+import { Configuration, InjectorService } from "@tsed/di";
 import { JsonDeserializerOptions } from "@tsed/json-mapper";
 import type { Cache, CachingConfig, MultiCache, TtlFunction } from "cache-manager";
-import { PlatformCacheSettings } from "../interfaces";
-export declare type CacheManager = (Cache | MultiCache) & {
-    keys?(): Promise<string[]>;
-};
+import { PlatformCachedObject } from "../interfaces/PlatformCachedObject";
+import { PlatformCacheSettings } from "../interfaces/interfaces";
+import { Logger } from "@tsed/logger";
+export declare type CacheManager = Cache | MultiCache;
 /**
  * @platform
  */
 export declare class PlatformCache {
-    settings: Configuration;
-    cache: CacheManager | undefined;
-    disabled(): boolean;
+    #private;
+    protected settings: Configuration;
+    protected injector: InjectorService;
+    protected logger: Logger;
+    get cache(): CacheManager | undefined;
     $onInit(): Promise<void>;
+    disabled(): boolean;
     defaultKeyResolver(): (args: any[], ctx?: any) => string;
     defaultTtl(): number | TtlFunction;
-    ttl(result?: any, currentTtl?: number | TtlFunction): number;
+    calculateTTL(result?: any, currentTtl?: number | TtlFunction): number;
+    ttl(key: string): Promise<any>;
     wrap<T>(key: string, fetch: () => Promise<T>, options?: CachingConfig): Promise<T>;
     get<T>(key: string, options?: JsonDeserializerOptions): Promise<T | undefined>;
     set<T>(key: string, value: any, options?: CachingConfig): Promise<T | undefined>;
+    getCachedObject(key: string): Promise<PlatformCachedObject | undefined>;
+    setCachedObject(key: string, data: any, opts: {
+        ttl: number;
+    } & Record<string, any>): Promise<void>;
     del(key: string): Promise<void>;
     reset(): Promise<void>;
-    keys(): Promise<string[]>;
+    keys(...args: any[]): Promise<string[]>;
     getMatchingKeys(patterns: string): Promise<string[]>;
     deleteMatchingKeys(patterns: string): Promise<string[]>;
     protected createCacheManager(settings: PlatformCacheSettings): Promise<MultiCache>;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tsed/platform-cache",
-  "version": "7.0.0-beta.2",
+  "version": "7.0.0-beta.20",
   "description": "Platform cache module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     "types": "./lib/types/index.d.ts",
@@ -13,37 +14,53 @@
     "default": "./lib/esm/index.js"
   },
   "scripts": {
-    "build": "yarn run build:esm && yarn run build:cjs",
+    "build": "yarn barrels && yarn run build:esm && yarn run build:cjs",
     "build:cjs": "tsc --build tsconfig.compile.json",
-    "build:esm": "tsc --build tsconfig.compile.esm.json"
+    "build:esm": "tsc --build tsconfig.compile.esm.json",
+    "test": "cross-env NODE_ENV=test yarn jest --max-workers=2",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\""
   },
   "dependencies": {
-    "@types/cache-manager": "^3.4.2",
-    "cache-manager": "^3.4.1",
-    "micromatch": "^4.0.2",
-    "tslib": "2.2.0"
+    "@types/cache-manager": "^4.0.1",
+    "cache-manager": "^4.1.0",
+    "micromatch": "4.0.5",
+    "tslib": "2.4.0"
   },
   "devDependencies": {
-    "@tsed/core": "7.0.0-beta.2",
-    "@tsed/di": "7.0.0-beta.2",
-    "@tsed/exceptions": "7.0.0-beta.2",
-    "@tsed/json-mapper": "7.0.0-beta.2",
-    "@tsed/schema": "7.0.0-beta.2",
-    "@types/cache-manager": "^3.4.2",
+    "@tsed/core": "7.0.0-beta.20",
+    "@tsed/di": "7.0.0-beta.20",
+    "@tsed/json-mapper": "7.0.0-beta.20",
+    "@tsed/schema": "7.0.0-beta.20",
     "@types/micromatch": "^4.0.1"
   },
   "peerDependencies": {
-    "@tsed/core": "^7.0.0-beta.2",
-    "@tsed/di": "^7.0.0-beta.2",
-    "@tsed/exceptions": "^7.0.0-beta.2",
-    "@tsed/json-mapper": "^7.0.0-beta.2",
-    "@tsed/schema": "^7.0.0-beta.2"
+    "@tsed/core": "^7.0.0-beta.20",
+    "@tsed/di": "^7.0.0-beta.20",
+    "@tsed/json-mapper": "^7.0.0-beta.20",
+    "@tsed/schema": "^7.0.0-beta.20"
+  },
+  "peerDependenciesMeta": {
+    "@tsed/core": {
+      "optional": false
+    },
+    "@tsed/di": {
+      "optional": false
+    },
+    "@tsed/json-mapper": {
+      "optional": false
+    },
+    "@tsed/schema": {
+      "optional": false
+    }
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {
     "url": "https://github.com/tsedio/tsed/issues"
   },
-  "homepage": "https://github.com/tsedio/tsed/tree/alpha/packages/platform/platform-cache",
+  "homepage": "https://github.com/tsedio/tsed/tree/beta/packages/platform/platform-cache",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "beta"
+  }
 }