@tsed/platform-cache 7.0.0-alpha.2 → 7.0.0-beta.11

package/jest.config.js

@@ -0,0 +1,14 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  ...require("@tsed/jest-config")(__dirname, "platform-cache"),
+  coverageThreshold: {
+    global: {
+      branches: 94.12,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  }
+};

package/lib/cjs/decorators/useCache.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseCache = void 0;
+const core_1 = require("@tsed/core");
+const di_1 = require("@tsed/di");
+const PlatformCacheInterceptor_1 = require("../interceptors/PlatformCacheInterceptor");
+function UseCache(options = {}) {
+    return (0, core_1.useDecorators)((0, di_1.Intercept)(PlatformCacheInterceptor_1.PlatformCacheInterceptor, options));
+}
+exports.UseCache = UseCache;
+//# sourceMappingURL=useCache.js.map

package/lib/cjs/decorators/useCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCache.js","sourceRoot":"","sources":["../../../src/decorators/useCache.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AACzC,iCAAmC;AACnC,uFAAkF;AAGlF,SAAgB,QAAQ,CAAC,UAAgC,EAAE;IACzD,OAAO,IAAA,oBAAa,EAAC,IAAA,cAAS,EAAC,mDAAwB,EAAE,OAAO,CAAC,CAAC,CAAC;AACrE,CAAC;AAFD,4BAEC","sourcesContent":["import {useDecorators} from \"@tsed/core\";\nimport {Intercept} from \"@tsed/di\";\nimport {PlatformCacheInterceptor} from \"../interceptors/PlatformCacheInterceptor\";\nimport {PlatformCacheOptions} from \"../interfaces/PlatformCacheOptions\";\n\nexport function UseCache(options: PlatformCacheOptions = {}) {\n  return useDecorators(Intercept(PlatformCacheInterceptor, options));\n}\n"]}

package/lib/cjs/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./decorators/useCache"), exports);
+tslib_1.__exportStar(require("./interceptors/PlatformCacheInterceptor"), exports);
+tslib_1.__exportStar(require("./interfaces/PlatformCacheOptions"), exports);
+tslib_1.__exportStar(require("./interfaces/PlatformCachedObject"), exports);
+tslib_1.__exportStar(require("./interfaces/interfaces"), exports);
+tslib_1.__exportStar(require("./services/PlatformCache"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gEAAsC;AACtC,kFAAwD;AACxD,4EAAkD;AAClD,4EAAkD;AAClD,kEAAwC;AACxC,mEAAyC","sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from \"./decorators/useCache\";\nexport * from \"./interceptors/PlatformCacheInterceptor\";\nexport * from \"./interfaces/PlatformCacheOptions\";\nexport * from \"./interfaces/PlatformCachedObject\";\nexport * from \"./interfaces/interfaces\";\nexport * from \"./services/PlatformCache\";\n"]}

package/lib/cjs/interceptors/PlatformCacheInterceptor.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformCacheInterceptor = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@tsed/core");
+const di_1 = require("@tsed/di");
+const json_mapper_1 = require("@tsed/json-mapper");
+const schema_1 = require("@tsed/schema");
+const logger_1 = require("@tsed/logger");
+const http_1 = require("http");
+const PlatformCache_1 = require("../services/PlatformCache");
+const cleanHeaders = (headers) => {
+    return Object.entries(headers)
+        .filter(([key]) => !["content-length", "x-request-id", "cache-control"].includes(key))
+        .reduce((headers, [key, value]) => {
+        return {
+            ...headers,
+            [key]: value
+        };
+    }, {});
+};
+/**
+ * @platform
+ */
+let PlatformCacheInterceptor = class PlatformCacheInterceptor {
+    async intercept(context, next) {
+        if (this.cache.disabled()) {
+            return next();
+        }
+        if (!this.isEndpoint(context)) {
+            return this.cacheMethod(context, next);
+        }
+        return this.cacheResponse(context, next);
+    }
+    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();
+            }
+            await this.deleteKeyFromQueue(key);
+        }
+    }
+    async cacheMethod(context, next) {
+        const { type, ttl, collectionType, refreshThreshold, keyArgs, args } = this.getOptions(context);
+        const key = [(0, core_1.nameOf)(context.target), context.propertyKey, keyArgs].join(":");
+        const cachedObject = await this.cache.getCachedObject(key);
+        const set = (result) => {
+            const calculatedTTL = this.cache.calculateTTL(result, ttl);
+            const data = (0, json_mapper_1.serialize)(result, { type, collectionType });
+            this.cache.setCachedObject(key, data, { args, ttl: calculatedTTL });
+        };
+        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
+        }));
+        if (cachedObject) {
+            const { data } = cachedObject;
+            return (0, json_mapper_1.deserialize)(JSON.parse(data), { collectionType, type });
+        }
+        const result = await next();
+        set(result);
+        return result;
+    }
+    async cacheResponse(context, next) {
+        const $ctx = context.args[context.args.length - 1];
+        const { request, response } = $ctx;
+        if (request.method !== "GET") {
+            return next();
+        }
+        const { ttl, args, keyArgs } = this.getOptions(context);
+        const key = [request.method, request.url, keyArgs].join(":");
+        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.calculateTTL(result, ttl);
+        $ctx.response.setHeaders({
+            "cache-control": `max-age=${calculatedTTL}`
+        });
+        // cache final response with his headers and body
+        response.onEnd(async () => {
+            this.cache.setCachedObject(key, response.getBody(), {
+                ttl: calculatedTTL,
+                args,
+                headers: cleanHeaders(response.getHeaders())
+            });
+        });
+        return result;
+    }
+    getArgs(context) {
+        return context.args.reduce((args, arg) => {
+            if (arg instanceof di_1.DIContext || arg instanceof http_1.IncomingMessage || arg instanceof http_1.ServerResponse) {
+                return args;
+            }
+            if ((0, core_1.isClass)(arg)) {
+                return args.concat((0, json_mapper_1.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 = (0, core_1.isString)(k) ? k : k(args);
+        return { refreshThreshold, ttl, type, args, collectionType, keyArgs };
+    }
+    isEndpoint({ target, propertyKey }) {
+        return core_1.Store.fromMethod(target, propertyKey).has(schema_1.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;
+        const requestEtag = request.get("if-none-match");
+        if (requestEtag && headers.etag === requestEtag) {
+            response.status(304).setHeaders(headers).body(undefined);
+            return undefined;
+        }
+        const data = JSON.parse(cachedObject.data);
+        $ctx.response
+            .setHeaders({
+            ...headers,
+            "x-cached": "true",
+            "cache-control": `max-age=${ttl}`
+        })
+            .body(data);
+        return data;
+    }
+};
+tslib_1.__decorate([
+    (0, di_1.Inject)(),
+    tslib_1.__metadata("design:type", PlatformCache_1.PlatformCache)
+], PlatformCacheInterceptor.prototype, "cache", void 0);
+tslib_1.__decorate([
+    (0, di_1.Inject)(),
+    tslib_1.__metadata("design:type", logger_1.Logger)
+], PlatformCacheInterceptor.prototype, "logger", void 0);
+PlatformCacheInterceptor = tslib_1.__decorate([
+    (0, di_1.Interceptor)()
+], PlatformCacheInterceptor);
+exports.PlatformCacheInterceptor = PlatformCacheInterceptor;
+//# sourceMappingURL=PlatformCacheInterceptor.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformCacheInterceptor.js","sourceRoot":"","sources":["../../../src/interceptors/PlatformCacheInterceptor.ts"],"names":[],"mappings":";;;;AAAA,qCAA4D;AAC5D,iCAA8H;AAC9H,mDAAyD;AACzD,yCAA6C;AAC7C,yCAAoC;AACpC,+BAAqD;AAGrD,6DAAwD;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;IAOnC,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,IAAA,aAAM,EAAC,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,eAAe,CAAC,GAAG,CAAC,CAAC;QAE3D,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,IAAA,uBAAS,EAAC,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,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,IAAI,YAAY,EAAE;YAChB,MAAM,EAAC,IAAI,EAAC,GAAG,YAAY,CAAC;YAE5B,OAAO,IAAA,yBAAW,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC,CAAC;SAC9D;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAE5B,GAAG,CAAC,MAAM,CAAC,CAAC;QAEZ,OAAO,MAAM,CAAC;IAChB,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,cAAS,IAAI,GAAG,YAAY,sBAAe,IAAI,GAAG,YAAY,qBAAc,EAAE;gBAC/F,OAAO,IAAI,CAAC;aACb;YAED,IAAI,IAAA,cAAO,EAAC,GAAG,CAAC,EAAE;gBAChB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAA,uBAAS,EAAC,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,IAAA,eAAQ,EAAC,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,YAAK,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,wBAAe,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,IAAA,WAAM,GAAE;sCACQ,6BAAa;uDAAC;AAG/B;IADC,IAAA,WAAM,GAAE;sCACS,eAAM;wDAAC;AALd,wBAAwB;IADpC,IAAA,gBAAW,GAAE;GACD,wBAAwB,CA4KpC;AA5KY,4DAAwB","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 {Logger} from \"@tsed/logger\";\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 cachedObject = await this.cache.getCachedObject(key);\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    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    if (cachedObject) {\n      const {data} = cachedObject;\n\n      return deserialize(JSON.parse(data), {collectionType, type});\n    }\n\n    const result = await next();\n\n    set(result);\n\n    return result;\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/cjs/interfaces/PlatformCacheOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PlatformCacheOptions.js.map

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

@@ -0,0 +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  refreshThreshold?: number;\n}\n"]}

package/lib/cjs/interfaces/PlatformCachedObject.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PlatformCachedObject.js.map

package/lib/cjs/interfaces/PlatformCachedObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformCachedObject.js","sourceRoot":"","sources":["../../../src/interfaces/PlatformCachedObject.ts"],"names":[],"mappings":"","sourcesContent":["export interface PlatformCachedObject {\n  ttl: number;\n  args: any[];\n  data: any;\n  expires: number;\n  headers: Record<string, number | string | string[]>;\n}\n"]}

package/lib/cjs/interfaces/interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interfaces.js.map

package/lib/cjs/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/cjs/package.json

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

package/lib/cjs/services/PlatformCache.js

@@ -0,0 +1,147 @@
+"use strict";
+var _PlatformCache_cache;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformCache = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@tsed/core");
+const di_1 = require("@tsed/di");
+const json_mapper_1 = require("@tsed/json-mapper");
+const logger_1 = require("@tsed/logger");
+const defaultKeyResolver = (args) => {
+    return args.map((arg) => ((0, core_1.isClass)(arg) ? JSON.stringify((0, json_mapper_1.serialize)(arg)) : arg)).join(":");
+};
+/**
+ * @platform
+ */
+let PlatformCache = class PlatformCache {
+    constructor() {
+        _PlatformCache_cache.set(this, void 0);
+    }
+    get cache() {
+        return tslib_1.__classPrivateFieldGet(this, _PlatformCache_cache, "f");
+    }
+    async $onInit() {
+        const settings = this.settings.get("cache");
+        if (settings) {
+            tslib_1.__classPrivateFieldSet(this, _PlatformCache_cache, await this.createCacheManager(settings), "f");
+            await this.injector.emit("$onCreateCacheManager", tslib_1.__classPrivateFieldGet(this, _PlatformCache_cache, "f"));
+        }
+    }
+    disabled() {
+        return !this.settings.get("cache");
+    }
+    defaultKeyResolver() {
+        return this.settings.get("cache.keyResolver", defaultKeyResolver);
+    }
+    defaultTtl() {
+        return this.settings.get("cache.ttl");
+    }
+    calculateTTL(result, currentTtl) {
+        const ttl = currentTtl === undefined ? this.defaultTtl() : currentTtl;
+        return (0, core_1.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);
+    }
+    async get(key, options = {}) {
+        var _a;
+        return (0, json_mapper_1.deserialize)((_a = this.cache) === null || _a === void 0 ? void 0 : _a.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);
+    }
+    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));
+    }
+    async reset() {
+        var _a;
+        // @ts-ignore
+        await ((_a = this.cache) === null || _a === void 0 ? void 0 : _a.reset());
+    }
+    async keys(...args) {
+        if (this.cache && "store" in this.cache && this.cache.store.keys) {
+            return this.cache.store.keys(...args);
+        }
+        // istanbul ignore next
+        return [];
+    }
+    async getMatchingKeys(patterns) {
+        const [keys, { default: micromatch }] = await Promise.all([this.keys(), Promise.resolve().then(() => tslib_1.__importStar(require("micromatch")))]);
+        return micromatch(keys, patterns);
+    }
+    async deleteMatchingKeys(patterns) {
+        const keys = await this.getMatchingKeys(patterns);
+        await Promise.all(keys.map((key) => this.del(key)));
+        return keys;
+    }
+    async createCacheManager(settings) {
+        const { caches, store = "memory", ttl, ...props } = settings;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { default: cacheManager } = await Promise.resolve().then(() => tslib_1.__importStar(require("cache-manager")));
+        return (caches === null || caches === void 0 ? void 0 : caches.length)
+            ? cacheManager.multiCaching(caches, { ...props })
+            : cacheManager.caching({
+                ...props,
+                ttl,
+                store: (0, core_1.isFunction)(store) ? await store() : store
+            });
+    }
+};
+_PlatformCache_cache = new WeakMap();
+tslib_1.__decorate([
+    (0, di_1.Configuration)(),
+    tslib_1.__metadata("design:type", Object)
+], PlatformCache.prototype, "settings", void 0);
+tslib_1.__decorate([
+    (0, di_1.Inject)(),
+    tslib_1.__metadata("design:type", di_1.InjectorService)
+], PlatformCache.prototype, "injector", void 0);
+tslib_1.__decorate([
+    (0, di_1.Inject)(),
+    tslib_1.__metadata("design:type", logger_1.Logger)
+], PlatformCache.prototype, "logger", void 0);
+PlatformCache = tslib_1.__decorate([
+    (0, di_1.Module)()
+], PlatformCache);
+exports.PlatformCache = PlatformCache;
+//# sourceMappingURL=PlatformCache.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformCache.js","sourceRoot":"","sources":["../../../src/services/PlatformCache.ts"],"names":[],"mappings":";;;;;AAAA,qCAA+C;AAC/C,iCAAwE;AACxE,mDAAkF;AAIlF,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,CAAC,IAAW,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,IAAA,cAAO,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAA,uBAAS,EAAC,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;IAA1B;QAUE,uCAAiC;IAsInC,CAAC;IApIC,IAAI,KAAK;QACP,OAAO,+BAAA,IAAI,4BAAO,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,+BAAA,IAAI,wBAAU,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;YAEtD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,+BAAA,IAAI,4BAAO,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,IAAA,iBAAU,EAAC,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,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,IAAA,yBAAW,EAAC,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,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,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,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,4DAAS,YAAY,IAAE,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,gEAAa,eAAe,GAAC,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,IAAA,iBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK;aACjD,CAAC,CAAC;IACT,CAAC;CACF,CAAA;;AA9IC;IADC,IAAA,kBAAa,GAAE;;+CACkB;AAGlC;IADC,IAAA,WAAM,GAAE;sCACW,oBAAe;+CAAC;AAGpC;IADC,IAAA,WAAM,GAAE;sCACS,eAAM;6CAAC;AARd,aAAa;IADzB,IAAA,WAAM,GAAE;GACI,aAAa,CAgJzB;AAhJY,sCAAa","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/esm/decorators/useCache.js

@@ -0,0 +1,7 @@
+import { useDecorators } from "@tsed/core";
+import { Intercept } from "@tsed/di";
+import { PlatformCacheInterceptor } from "../interceptors/PlatformCacheInterceptor.js";
+export function UseCache(options = {}) {
+    return useDecorators(Intercept(PlatformCacheInterceptor, options));
+}
+//# sourceMappingURL=useCache.js.map

package/lib/esm/decorators/useCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCache.js","sourceRoot":"","sources":["../../../src/decorators/useCache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,YAAY,CAAC;AACzC,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AACnC,OAAO,EAAC,wBAAwB,EAAC,MAAM,0CAA0C,CAAC;AAGlF,MAAM,UAAU,QAAQ,CAAC,UAAgC,EAAE;IACzD,OAAO,aAAa,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC,CAAC;AACrE,CAAC","sourcesContent":["import {useDecorators} from \"@tsed/core\";\nimport {Intercept} from \"@tsed/di\";\nimport {PlatformCacheInterceptor} from \"../interceptors/PlatformCacheInterceptor\";\nimport {PlatformCacheOptions} from \"../interfaces/PlatformCacheOptions\";\n\nexport function UseCache(options: PlatformCacheOptions = {}) {\n  return useDecorators(Intercept(PlatformCacheInterceptor, options));\n}\n"]}

package/lib/esm/index.js

@@ -0,0 +1,10 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./decorators/useCache.js";
+export * from "./interceptors/PlatformCacheInterceptor.js";
+export * from "./interfaces/PlatformCacheOptions.js";
+export * from "./interfaces/PlatformCachedObject.js";
+export * from "./interfaces/interfaces.js";
+export * from "./services/PlatformCache.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,yCAAyC,CAAC;AACxD,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC","sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from \"./decorators/useCache\";\nexport * from \"./interceptors/PlatformCacheInterceptor\";\nexport * from \"./interfaces/PlatformCacheOptions\";\nexport * from \"./interfaces/PlatformCachedObject\";\nexport * from \"./interfaces/interfaces\";\nexport * from \"./services/PlatformCache\";\n"]}

package/lib/esm/interceptors/PlatformCacheInterceptor.js

@@ -0,0 +1,156 @@
+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 { JsonEntityStore } from "@tsed/schema";
+import { Logger } from "@tsed/logger";
+import { IncomingMessage, ServerResponse } from "http";
+import { PlatformCache } from "../services/PlatformCache.js";
+const cleanHeaders = (headers) => {
+    return Object.entries(headers)
+        .filter(([key]) => !["content-length", "x-request-id", "cache-control"].includes(key))
+        .reduce((headers, [key, value]) => {
+        return {
+            ...headers,
+            [key]: value
+        };
+    }, {});
+};
+/**
+ * @platform
+ */
+let PlatformCacheInterceptor = class PlatformCacheInterceptor {
+    async intercept(context, next) {
+        if (this.cache.disabled()) {
+            return next();
+        }
+        if (!this.isEndpoint(context)) {
+            return this.cacheMethod(context, next);
+        }
+        return this.cacheResponse(context, next);
+    }
+    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();
+            }
+            await this.deleteKeyFromQueue(key);
+        }
+    }
+    async cacheMethod(context, next) {
+        const { type, ttl, collectionType, refreshThreshold, keyArgs, args } = this.getOptions(context);
+        const key = [nameOf(context.target), context.propertyKey, keyArgs].join(":");
+        const cachedObject = await this.cache.getCachedObject(key);
+        const set = (result) => {
+            const calculatedTTL = this.cache.calculateTTL(result, ttl);
+            const data = serialize(result, { type, collectionType });
+            this.cache.setCachedObject(key, data, { args, ttl: calculatedTTL });
+        };
+        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
+        }));
+        if (cachedObject) {
+            const { data } = cachedObject;
+            return deserialize(JSON.parse(data), { collectionType, type });
+        }
+        const result = await next();
+        set(result);
+        return result;
+    }
+    async cacheResponse(context, next) {
+        const $ctx = context.args[context.args.length - 1];
+        const { request, response } = $ctx;
+        if (request.method !== "GET") {
+            return next();
+        }
+        const { ttl, args, keyArgs } = this.getOptions(context);
+        const key = [request.method, request.url, keyArgs].join(":");
+        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.calculateTTL(result, ttl);
+        $ctx.response.setHeaders({
+            "cache-control": `max-age=${calculatedTTL}`
+        });
+        // cache final response with his headers and body
+        response.onEnd(async () => {
+            this.cache.setCachedObject(key, response.getBody(), {
+                ttl: calculatedTTL,
+                args,
+                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;
+        const requestEtag = request.get("if-none-match");
+        if (requestEtag && headers.etag === requestEtag) {
+            response.status(304).setHeaders(headers).body(undefined);
+            return undefined;
+        }
+        const data = JSON.parse(cachedObject.data);
+        $ctx.response
+            .setHeaders({
+            ...headers,
+            "x-cached": "true",
+            "cache-control": `max-age=${ttl}`
+        })
+            .body(data);
+        return data;
+    }
+};
+__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);
+export { PlatformCacheInterceptor };
+//# sourceMappingURL=PlatformCacheInterceptor.js.map