axe-api 1.0.0 → 1.0.2

package/build/src/Handlers/Helpers.js

@@ -338,6 +338,9 @@ const putCache = (context, data) => __awaiter(void 0, void 0, void 0, function*
     }
     // Getting the redis service
     const redis = yield Services_1.IoCService.use("Redis");
+    if (!redis.isReady()) {
+        return;
+    }
     // Generating the cache key
     const key = (0, exports.toCacheKey)(context);
     // Setting the tags if the cache configuration of the model has been set as
@@ -357,12 +360,18 @@ const putCache = (context, data) => __awaiter(void 0, void 0, void 0, function*
 exports.putCache = putCache;
 const deleteCacheTagMembers = (key) => __awaiter(void 0, void 0, void 0, function* () {
     const redis = yield Services_1.IoCService.use("Redis");
+    if (!redis.isReady()) {
+        return;
+    }
     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");
+    if (!redis.isReady()) {
+        return;
+    }
     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();
@@ -376,6 +385,9 @@ const cleanRelatedCachedObjectByModel = (model, config) => __awaiter(void 0, voi
 exports.cleanRelatedCachedObjectByModel = cleanRelatedCachedObjectByModel;
 const clearCacheTags = (tag) => __awaiter(void 0, void 0, void 0, function* () {
     const redis = yield Services_1.IoCService.use("Redis");
+    if (!redis.isReady()) {
+        return;
+    }
     const members = yield redis.getTagMemebers(tag);
     if (members.length > 0) {
         yield redis.delete(members);

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

@@ -4,7 +4,10 @@ type RedisClientOptions = Parameters<typeof createClient>[0];
 declare class RedisAdaptor implements ICacheAdaptor {
     private client;
     private prefix;
+    private isConnected;
     constructor(options: RedisClientOptions | undefined, prefix: string);
+    isReady(): boolean;
+    connect(): Promise<void>;
     get(key: string): Promise<string | null>;
     set(key: string, value: string, ttl: number): Promise<void>;
     tags(keys: string[], value: string): Promise<void>;

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

@@ -10,11 +10,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const redis_1 = require("redis");
+const Services_1 = require("../../Services");
 class RedisAdaptor {
     constructor(options, prefix) {
         this.client = (0, redis_1.createClient)(options);
         this.prefix = prefix;
-        this.client.connect();
+        this.isConnected = false;
+    }
+    isReady() {
+        return this.isConnected;
+    }
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.client.connect();
+                this.isConnected = true;
+            }
+            catch (error) {
+                Services_1.LogService.error(`Redis Connection Error: ${error.message}`);
+            }
+        });
     }
     get(key) {
         return __awaiter(this, void 0, void 0, function* () {

package/build/src/Phases/GetCachePhase.js

@@ -19,6 +19,9 @@ exports.default = (context) => __awaiter(void 0, void 0, void 0, function* () {
     if (config === null || config === void 0 ? void 0 : config.enable) {
         // Getting the redis service
         const redis = yield Services_1.IoCService.use("Redis");
+        if (!redis.isReady()) {
+            return;
+        }
         // Generating the cache key
         const key = (0, Helpers_1.toCacheKey)(context);
         // Try to fetch the value via Redis

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

@@ -15,7 +15,7 @@ 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);
-    if ((config === null || config === void 0 ? void 0 : config.invalidation) === Enums_1.CacheStrategies.TagBased) {
+    if ((config === null || config === void 0 ? void 0 : config.enable) && (config === null || config === void 0 ? void 0 : config.invalidation) === Enums_1.CacheStrategies.TagBased) {
         (0, Helpers_1.cleanRelatedCachedObjectByModel)(model, config);
     }
     // Preparing the json response

package/build/src/Resolvers/ModelResolver.js

@@ -49,6 +49,7 @@ class ModelResolver {
     setCacheOptions(modelList) {
         return __awaiter(this, void 0, void 0, function* () {
             const api = Services_1.APIService.getInstance();
+            let needRedisConnection = false;
             // For each model should be analyzed
             for (const model of modelList.get()) {
                 // For each cachable handler, developers are able to set a different
@@ -57,10 +58,18 @@ class ModelResolver {
                     // API configuration, version configuration and the handler type are in
                     // order. The following function gets the correct configuration
                     const configuration = (0, Helpers_1.getModelCacheConfiguration)(model, api.config.cache, this.version.config.cache, handler);
+                    // We should try to connect to Redis
+                    if (configuration.enable) {
+                        needRedisConnection = true;
+                    }
                     // We need to set this to use late in action
                     model.setCacheConfiguration(handler, configuration);
                 }
             }
+            if (needRedisConnection) {
+                const redis = yield Services_1.IoCService.use("Redis");
+                redis.connect();
+            }
         });
     }
     setModelRelations(modelList) {

package/build/src/constants.js

@@ -299,7 +299,9 @@ exports.DEFAULT_APP_CONFIG = {
         },
     },
     errorHandler: ErrorHandler_1.default,
-    redis: {},
+    redis: {
+        url: "redis://127.0.0.1:6379",
+    },
     cache: Object.assign({}, exports.DEFAULT_CACHE_CONFIGURATION),
     elasticSearch: {
         node: "http://localhost:9200",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "AXE API is a simple tool to create Rest APIs quickly.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -52,7 +52,11 @@
     "test:sqlite": "sh ./scripts/test-sqlite.sh",
     "prettier:check": "prettier --check .",
     "prettier:write": "prettier --write .",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "benchmark": "k6 run benchmark/run.js"
+  },
+  "engines" : { 
+    "node" : ">=18.0.0"
   },
   "dependencies": {
     "body-parser": "^1.20.2",
@@ -103,7 +107,7 @@
     "nodemon": "^3.0.2",
     "open-swagger-ui": "^1.2.0",
     "pg": "^8.11.3",
-    "prettier": "^3.1.0",
+    "prettier": "^3.1.1",
     "redis": "^4.6.11",
     "set-value": ">=4.1.0",
     "sqlite3": "^5.1.6",

package/build/dev-kit.d.ts

@@ -1 +0,0 @@
-export {};

package/build/dev-kit.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_color_log_1 = __importDefault(require("node-color-log"));
-const dotenv_1 = __importDefault(require("dotenv"));
-const path_1 = __importDefault(require("path"));
-const index_1 = require("./index");
-node_color_log_1.default.bgColor("yellow").color("black").log("Axe API dev-kit (1.0.1)");
-node_color_log_1.default
-    .color("blue")
-    .log("Docs: https://axe-api.com/contribution/fundamentals.html \n");
-dotenv_1.default.config();
-const server = new index_1.Server();
-server.start(path_1.default.join(__dirname, "dev-kit"));