axe-api 1.0.0-rc24 → 1.0.0-rc25

package/build/src/Handlers/Helpers.d.ts

@@ -17,7 +17,10 @@ export declare const getRelatedData: (version: IVersion, data: any[], withArray:
 export declare const isBoolean: (value: any) => boolean;
 export declare const getModelCacheConfiguration: (model: IModelService, apiConfig: ICacheConfiguration, versionConfig: ICacheConfiguration | null, handler: string) => ICacheConfiguration;
 export declare const defaultCacheKeyFunction: (req: AxeRequest) => string;
+export declare const toCacheTagKey: (model: IModelService, primaryKeyValue: string, config?: ICacheConfiguration | null) => string;
 export declare const toCacheKey: (context: IContext) => string;
 export declare const putCache: (context: IContext, data: any) => Promise<void>;
+export declare const deleteCacheTagMembers: (key: string) => Promise<void>;
+export declare const cleanRelatedCachedObjectByModel: (model: IModelService, config?: ICacheConfiguration | null) => Promise<void>;
 export declare const clearCacheTags: (tag: string) => Promise<void>;
 export declare const toCachePrefix: (value: string | undefined | null) => string;

package/build/src/Handlers/Helpers.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toCachePrefix = exports.clearCacheTags = exports.putCache = exports.toCacheKey = exports.defaultCacheKeyFunction = exports.getModelCacheConfiguration = exports.isBoolean = exports.getRelatedData = exports.addSoftDeleteQuery = exports.filterHiddenFields = exports.serializeData = exports.addForeignKeyQuery = exports.checkPrimaryKeyValueType = exports.getParentColumn = exports.callHooks = exports.getMergedFormData = exports.bindTimestampValues = void 0;
+exports.toCachePrefix = exports.clearCacheTags = exports.cleanRelatedCachedObjectByModel = exports.deleteCacheTagMembers = exports.putCache = exports.toCacheKey = exports.toCacheTagKey = exports.defaultCacheKeyFunction = exports.getModelCacheConfiguration = exports.isBoolean = exports.getRelatedData = exports.addSoftDeleteQuery = exports.filterHiddenFields = exports.serializeData = exports.addForeignKeyQuery = exports.checkPrimaryKeyValueType = exports.getParentColumn = exports.callHooks = exports.getMergedFormData = exports.bindTimestampValues = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const change_case_1 = require("change-case");
 const Enums_1 = require("../Enums");
@@ -225,10 +225,7 @@ const getRelatedData = (version, data, withArray, model, modelList, database, ha
         // Adding related data source to the request tags to set cache tag values
         const { primaryKey } = foreignModel.instance;
         const cacheConfig = foreignModel.getCacheConfiguration(handler);
-        const tagPrefix = (cacheConfig === null || cacheConfig === void 0 ? void 0 : cacheConfig.tagPrefix)
-            ? `${cacheConfig === null || cacheConfig === void 0 ? void 0 : cacheConfig.tagPrefix}:`
-            : "";
-        request.original.tags.push(...relatedRecords.map((i) => `${tagPrefix}${foreignModel.name}:${i[primaryKey]}`));
+        request.original.tags.push(...relatedRecords.map((i) => (0, exports.toCacheTagKey)(foreignModel, i[primaryKey], cacheConfig)));
         // We should serialize related data if there is any serialization function
         relatedRecords = yield (0, exports.serializeData)(version, relatedRecords, foreignModel.serialize, handler, request);
         // We should hide hidden fields if there is any
@@ -301,6 +298,13 @@ const defaultCacheKeyFunction = (req) => {
     });
 };
 exports.defaultCacheKeyFunction = defaultCacheKeyFunction;
+const toCacheTagKey = (model, primaryKeyValue, config) => {
+    const prefix = (0, exports.toCachePrefix)(config === null || config === void 0 ? void 0 : config.cachePrefix);
+    const tagPrefix = (config === null || config === void 0 ? void 0 : config.tagPrefix) ? config === null || config === void 0 ? void 0 : config.tagPrefix : "";
+    const modelName = model.name.toLowerCase();
+    return `${prefix}:${tagPrefix}:${modelName}:${primaryKeyValue}`;
+};
+exports.toCacheTagKey = toCacheTagKey;
 const toCacheKey = (context) => {
     const { model, handlerType } = context;
     const config = model.getCacheConfiguration(handlerType);
@@ -308,7 +312,9 @@ const toCacheKey = (context) => {
         ? config.cacheKey(context.req)
         : (0, exports.defaultCacheKeyFunction)(context.req);
     const key = crypto_1.default.createHash("sha256").update(keyData).digest("hex");
-    return (0, exports.toCachePrefix)(config === null || config === void 0 ? void 0 : config.cachePrefix) + key;
+    const prefix = (0, exports.toCachePrefix)(config === null || config === void 0 ? void 0 : config.cachePrefix);
+    const modelName = model.name.toLowerCase();
+    return `${prefix}:${modelName}:${key}`;
 };
 exports.toCacheKey = toCacheKey;
 const putCache = (context, data) => __awaiter(void 0, void 0, void 0, function* () {
@@ -316,27 +322,45 @@ const putCache = (context, data) => __awaiter(void 0, void 0, void 0, function*
     const { model, handlerType } = context;
     const config = model.getCacheConfiguration(handlerType);
     // Check if the cache enable for this handler
-    if (config === null || config === void 0 ? void 0 : config.enable) {
-        // Getting the redis service
-        const redis = yield Services_1.IoCService.use("Redis");
-        // Generating the cache key
-        const key = (0, exports.toCacheKey)(context);
-        // Setting the tags if the cache configuration of the model has been set as
-        // tag-based cache invalidation strategy. Which means, the key cached value
-        // can be deleted if the tagged items updated/delete
-        if (config.invalidation === Enums_1.CacheStrategies.TagBased) {
-            redis.tags(context.req.original.tags, key);
-        }
-        // Putting the cache data
-        redis.set(key, JSON.stringify(data), config.ttl || 1000);
-        if (config.responseHeader) {
-            context.res.header(config.responseHeader, "Missed");
-        }
-        // Logging
-        Services_1.LogService.debug(`\t🔄 redis.cache(${key},${config.ttl})`);
+    if (!(config === null || config === void 0 ? void 0 : config.enable)) {
+        return;
+    }
+    // Getting the redis service
+    const redis = yield Services_1.IoCService.use("Redis");
+    // Generating the cache key
+    const key = (0, exports.toCacheKey)(context);
+    // Setting the tags if the cache configuration of the model has been set as
+    // tag-based cache invalidation strategy. Which means, the key cached value
+    // can be deleted if the tagged items updated/delete
+    if (config.invalidation === Enums_1.CacheStrategies.TagBased) {
+        redis.tags(context.req.original.tags, key);
     }
+    // Putting the cache data
+    redis.set(key, JSON.stringify(data), config.ttl || 1000);
+    if (config.responseHeader) {
+        context.res.header(config.responseHeader, "Missed");
+    }
+    // Logging
+    Services_1.LogService.debug(`\t🔄 redis.cache(${key},${config.ttl})`);
 });
 exports.putCache = putCache;
+const deleteCacheTagMembers = (key) => __awaiter(void 0, void 0, void 0, function* () {
+    const redis = yield Services_1.IoCService.use("Redis");
+    const members = yield redis.getTagMemebers(key);
+    yield redis.delete(members);
+});
+exports.deleteCacheTagMembers = deleteCacheTagMembers;
+const cleanRelatedCachedObjectByModel = (model, config) => __awaiter(void 0, void 0, void 0, function* () {
+    const redis = yield Services_1.IoCService.use("Redis");
+    const prefix = (0, exports.toCachePrefix)(config === null || config === void 0 ? void 0 : config.cachePrefix);
+    const tagPrefix = (config === null || config === void 0 ? void 0 : config.tagPrefix) ? config === null || config === void 0 ? void 0 : config.tagPrefix : "";
+    const modelName = model.name.toLowerCase();
+    const searchKey = `${prefix}:${tagPrefix}:${modelName}:*`;
+    const { keys } = yield redis.searchTags(searchKey);
+    const tasks = keys.map((key) => (0, exports.deleteCacheTagMembers)(key));
+    Promise.all(tasks);
+});
+exports.cleanRelatedCachedObjectByModel = cleanRelatedCachedObjectByModel;
 const clearCacheTags = (tag) => __awaiter(void 0, void 0, void 0, function* () {
     const redis = yield Services_1.IoCService.use("Redis");
     const members = yield redis.getTagMemebers(tag);
@@ -346,6 +370,6 @@ const clearCacheTags = (tag) => __awaiter(void 0, void 0, void 0, function* () {
 });
 exports.clearCacheTags = clearCacheTags;
 const toCachePrefix = (value) => {
-    return value ? `${value}:` : "";
+    return value ? value : "";
 };
 exports.toCachePrefix = toCachePrefix;

package/build/src/Middlewares/RateLimit/RedisAdaptor.d.ts

@@ -11,5 +11,9 @@ declare class RedisAdaptor implements ICacheAdaptor {
     getTagMemebers(tag: string): Promise<string[]>;
     delete(keys: string[]): Promise<number>;
     decr(key: string): Promise<void>;
+    searchTags(pattern: string): Promise<{
+        cursor: number;
+        keys: string[];
+    }>;
 }
 export default RedisAdaptor;

package/build/src/Middlewares/RateLimit/RedisAdaptor.js

@@ -48,5 +48,12 @@ class RedisAdaptor {
             yield this.client.decr(`${this.prefix}${key}`);
         });
     }
+    searchTags(pattern) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.scan(0, {
+                MATCH: pattern,
+            });
+        });
+    }
 }
 exports.default = RedisAdaptor;

package/build/src/Phases/CacheTagCleanPhase.js

@@ -14,6 +14,5 @@ exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
     const { item, model, handlerType } = context;
     const { primaryKey } = model.instance;
     const config = model.getCacheConfiguration(handlerType);
-    const prefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
-    (0, Helpers_1.clearCacheTags)(`${prefix}${model.name}:${item[primaryKey]}`);
+    (0, Helpers_1.clearCacheTags)((0, Helpers_1.toCacheTagKey)(model, item[primaryKey], config));
 });

package/build/src/Phases/List/ResultPhase.js

@@ -15,8 +15,7 @@ exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
     // Adding cache tags
     const { primaryKey } = model.instance;
     const config = model.getCacheConfiguration(handlerType);
-    const tagPrefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
-    context.req.original.tags.push(...result.data.map((i) => `${tagPrefix}${model.name}:${i[primaryKey]}`));
+    context.req.original.tags.push(...result.data.map((i) => (0, Helpers_1.toCacheTagKey)(model, i[primaryKey], config)));
     // Caching the results
     yield (0, Helpers_1.putCache)(context, result);
     res.json(result);

package/build/src/Phases/Single/ResultPhase.js

@@ -15,8 +15,7 @@ exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
     // Adding cache tags
     const { primaryKey } = model.instance;
     const config = model.getCacheConfiguration(handlerType);
-    const tagPrefix = (0, Helpers_1.toCachePrefix)(config === null || config === void 0 ? void 0 : config.tagPrefix);
-    context.req.original.tags.push(`${tagPrefix}${model.name}:${item[primaryKey]}`);
+    context.req.original.tags.push((0, Helpers_1.toCacheTagKey)(model, item[primaryKey], config));
     // Caching the results
     yield (0, Helpers_1.putCache)(context, item);
     res.json(item);

package/build/src/Phases/Store/ResultPhase.d.ts

@@ -0,0 +1,3 @@
+import { IContext } from "../../Interfaces";
+declare const _default: (context: IContext) => Promise<void>;
+export default _default;

package/build/src/Phases/Store/ResultPhase.js

@@ -0,0 +1,20 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Helpers_1 = require("../../Handlers/Helpers");
+exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
+    const { item, res, model, handlerType } = context;
+    // Deleting all cached result for the model
+    const config = model.getCacheConfiguration(handlerType);
+    (0, Helpers_1.cleanRelatedCachedObjectByModel)(model, config);
+    // Preparing the json response
+    res.json(item);
+});

package/build/src/Phases/Store/index.d.ts

@@ -1,5 +1,6 @@
 declare const _default: {
     PreparePhase: (context: import("../../Interfaces").IContext) => Promise<void>;
     ActionPhase: (context: import("../../Interfaces").IContext) => Promise<void>;
+    ResultPhase: (context: import("../../Interfaces").IContext) => Promise<void>;
 };
 export default _default;

package/build/src/Phases/Store/index.js

@@ -5,7 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const PreparePhase_1 = __importDefault(require("./PreparePhase"));
 const ActionPhase_1 = __importDefault(require("./ActionPhase"));
+const ResultPhase_1 = __importDefault(require("./ResultPhase"));
 exports.default = {
     PreparePhase: PreparePhase_1.default,
     ActionPhase: ActionPhase_1.default,
+    ResultPhase: ResultPhase_1.default,
 };

package/build/src/Server.js

@@ -51,6 +51,7 @@ const RequestHandler_1 = __importDefault(require("./Handlers/RequestHandler"));
 const App_1 = __importDefault(require("./Services/App"));
 const constants_1 = require("./constants");
 const RedisAdaptor_1 = __importDefault(require("./Middlewares/RateLimit/RedisAdaptor"));
+const RateLimit_1 = __importDefault(require("./Middlewares/RateLimit"));
 class Server {
     /**
      * Start the application with the rootFolder.
@@ -126,6 +127,7 @@ class Server {
         });
     }
     listen() {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const app = yield Services_1.IoCService.use("App");
             const api = Services_1.APIService.getInstance();
@@ -142,6 +144,11 @@ class Server {
                 app.get("/docs", DocsHandler_1.default);
                 app.get("/routes", RoutesHandler_1.default);
             }
+            // Rate limitting should be added after init() functions.
+            if ((_a = api.config.rateLimit) === null || _a === void 0 ? void 0 : _a.enabled) {
+                Services_1.LogService.debug("New middleware: rateLimit()");
+                app.use(RateLimit_1.default);
+            }
             server.listen(api.config.port);
             Services_1.LogService.info(`Axe API listens requests on http://localhost:${api.config.port}`);
         });

package/build/src/Services/App.js

@@ -1,27 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -30,14 +7,13 @@ const connect_1 = __importDefault(require("connect"));
 const body_parser_1 = __importDefault(require("body-parser"));
 const URLService_1 = __importDefault(require("./URLService"));
 const LogService_1 = __importDefault(require("./LogService"));
-const RateLimit_1 = __importStar(require("../Middlewares/RateLimit"));
+const RateLimit_1 = require("../Middlewares/RateLimit");
 const APIService_1 = __importDefault(require("./APIService"));
 const ConverterService_1 = require("./ConverterService");
 const DocumentationService_1 = __importDefault(require("./DocumentationService"));
 const Enums_1 = require("../Enums");
 class App {
     constructor() {
-        var _a;
         this.docs = DocumentationService_1.default.getInstance();
         this.connect = (0, connect_1.default)();
         LogService_1.default.debug("Created a new connect() instance");
@@ -47,10 +23,6 @@ class App {
         // Activate the Rate Limit middleware
         const api = APIService_1.default.getInstance();
         (0, RateLimit_1.setupRateLimitAdaptors)(api.config);
-        if ((_a = api.config.rateLimit) === null || _a === void 0 ? void 0 : _a.enabled) {
-            LogService_1.default.debug("New middleware: rateLimit()");
-            this.connect.use(RateLimit_1.default);
-        }
     }
     /**
      * Get the `connect` instance

package/build/src/constants.js

@@ -136,7 +136,7 @@ exports.HANDLER_CYLES = {
         new Hook_1.default(Enums_1.HookFunctionTypes.onAfterInsert),
         new Event_1.default(Enums_1.HookFunctionTypes.onAfterInsert),
         new Phase_1.default("insert.serialize", Single_1.default.SerializePhase),
-        new Phase_1.default("insert.response", Single_1.default.ResultPhase),
+        new Phase_1.default("insert.response", Store_1.default.ResultPhase),
     ],
     [Enums_1.HandlerTypes.PAGINATE]: [
         new Phase_1.default("paginate.cache", GetCachePhase_1.default),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.0.0-rc24",
+  "version": "1.0.0-rc25",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",