@adaptivestone/framework 3.0.20 → 3.0.22

package/.env.example

@@ -13,3 +13,6 @@ EMAIL_PASSWORD=""
 LOGGER_SENTRY_ENABLE=""
 SENTRY_DSN=
 LOGGER_CONSOLE_LEVEL=
+
+REDIS_NAMESPACE=""
+REDIS_URI=""

package/CHANGELOG.md

@@ -1,6 +1,17 @@
 ### 3.1.0 // NEXT
 
 [NEW] new comand to generate open API documentation (wip)
+[NEW] coverage report
+
+### 3.0.22
+
+[UPDATE] updated deps
+[UPDATE] cast function now can be ASYNC too
+
+### 3.0.21
+
+[UPDATE] updated redis to v4
+[NEW] updates tests to have own namespace on redis
 
 ### 3.0.20
 

package/commands/GetOpenApiJson.js

@@ -21,7 +21,7 @@ class GetOpenApiJson extends AbstractCommand {
         {
           url: myDomain,
           description: 'Domain from config',
-        }
+        },
       ],
     };
 

package/config/redis.js

@@ -1,3 +1,4 @@
 module.exports = {
   url: process.env.REDIS_URI || 'redis://localhost',
+  namespace: process.env.REDIS_NAMESPACE || 'main',
 };

package/helpers/redis/clearNamespace.js

@@ -0,0 +1,14 @@
+async function clearNamespace(redisClient, namespace) {
+  const deletedKeys = [];
+
+  const keys = await redisClient.sendCommand(['keys', `*${namespace}*`]);
+
+  if (keys && keys.length > 0) {
+    for (const key of keys) {
+      deletedKeys.push(redisClient.sendCommand(['del', key]));
+    }
+    await Promise.all(deletedKeys);
+  }
+}
+
+module.exports = clearNamespace;

package/modules/AbstractController.js

@@ -110,8 +110,6 @@ class AbstractController extends Base {
 
     const middlewaresInfo = parseMiddlewares(this.constructor.middleware);
     const routesInfo = [];
-    let routeObjectClone = {};
-    const routeObjests = [];
 
     /**
      *  Register controller middleware
@@ -240,9 +238,12 @@ class AbstractController extends Base {
                   errors: errorAnswer,
                 });
               }
-              req.appInfo.request = routeObject.request.cast(bodyAndQuery, {
-                stripUnknown: true,
-              });
+              req.appInfo.request = await routeObject.request.cast(
+                bodyAndQuery,
+                {
+                  stripUnknown: true,
+                },
+              );
             }
             req.body = new Proxy(req.body, {
               get: (target, prop) => {
@@ -280,8 +281,6 @@ class AbstractController extends Base {
             });
           },
         );
-
-        routeObjectClone = merge({}, routeObject);
       }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "3.0.20",
+  "version": "3.0.22",
   "description": "Adaptive stone node js framework",
   "main": "src/index.js",
   "engines": {
@@ -14,7 +14,7 @@
   "scripts": {
     "dev": "nodemon ./index.js",
     "prod": "nodemon ./cluster.js",
-    "test": "jest",
+    "test": "jest --coverage=true",
     "codestyle": "prettier --check '**/*.(js|jsx|ts|tsx|json|css|scss|md)'",
     "prepare": "husky install",
     "cli": "node cliCommand"
@@ -24,7 +24,12 @@
       "./tests/setup.js"
     ],
     "testEnvironment": "node",
-    "verbose": true
+    "verbose": true,
+    "collectCoverage": true,
+    "coverageReporters": [
+      "text",
+      "text-summary"
+    ]
   },
   "author": "Andrey Logunov",
   "license": "MIT",
@@ -47,7 +52,7 @@
     "prettier": "^2.3.2",
     "pug": "^3.0.2",
     "rate-limiter-flexible": "^2.2.4",
-    "redis": "^3.1.2",
+    "redis": "^4.3.1",
     "winston": "^3.3.3",
     "winston-transport-sentry-node": "^2.0.0",
     "yup": "^0.32.9"

package/services/cache/Cache.js

@@ -1,5 +1,4 @@
 const redis = require('redis');
-const { promisify } = require('util');
 const Base = require('../../modules/Base');
 
 class Cache extends Base {
@@ -10,7 +9,12 @@ class Cache extends Base {
     // we should support multiple cashe same time
     super(app);
     const conf = this.app.getConfig('redis');
-    this.redisClient = redis.createClient(conf.url);
+    this.redisClient = redis.createClient({
+      url: conf.url,
+    });
+
+    this.redisNamespace = conf.namespace;
+
     this.redisClient.on('error', (error, b, c) => {
       this.logger.error(error, b, c);
     });
@@ -20,11 +24,15 @@ class Cache extends Base {
     this.app.events.on('shutdown', () => {
       this.redisClient.quit();
     });
-    this.redisGetAsync = promisify(this.redisClient.get).bind(this.redisClient);
+
     this.promiseMapping = new Map();
   }
 
-  async getSetValue(key, onNotFound, storeTime = 60 * 5) {
+  async getSetValue(keyValue, onNotFound, storeTime = 60 * 5) {
+    if (!this.redisClient.isOpen) {
+      await this.redisClient.connect();
+    }
+    const key = `${this.redisNamespace}-${keyValue}`;
     // 5 mins default
     let resolve = null;
     if (this.promiseMapping.has(key)) {
@@ -38,11 +46,11 @@ class Cache extends Base {
       }),
     );
 
-    let result = await this.redisGetAsync(key);
+    let result = await this.redisClient.get(key);
     if (!result) {
       this.logger.verbose(`getSetValueFromCache not found for key ${key}`);
       result = await onNotFound();
-      this.redisClient.set(key, JSON.stringify(result), 'EX', storeTime);
+      this.redisClient.setEx(key, storeTime, JSON.stringify(result));
     } else {
       this.logger.verbose(
         `getSetValueFromCache FROM CACHE key ${key}, value ${result}`,

package/services/http/middleware/RateLimiter.js

@@ -16,9 +16,10 @@ class RateLimiter extends AbstractMiddleware {
 
   constructor(app, params) {
     super(app, params);
+    const routeParams = params;
     const limiterOptions = this.app.getConfig('rateLimiter');
-    this.finalOptions = merge(limiterOptions, params);
 
+    this.finalOptions = merge(limiterOptions, routeParams);
     this.limiter = null;
 
     switch (this.finalOptions.driver) {
@@ -47,7 +48,16 @@ class RateLimiter extends AbstractMiddleware {
 
   initRedisLimiter() {
     const redisConfig = this.app.getConfig('redis');
-    const redisClient = redis.createClient(redisConfig.url);
+    const redisClient = redis.createClient({
+      url: redisConfig.url,
+      legacyMode: true,
+    });
+
+    // TODO: change it
+    (async () => {
+      await redisClient.connect();
+    })();
+
     redisClient.on('error', (error, b, c) => {
       this.logger.error(error, b, c);
     });
@@ -55,8 +65,8 @@ class RateLimiter extends AbstractMiddleware {
       this.logger.info('Redis connection success');
     });
 
-    this.app.events.on('shutdown', () => {
-      redisClient.quit();
+    this.app.events.on('shutdown', async () => {
+      await redisClient.disconnect();
     });
 
     return new RateLimiterRedis({
@@ -100,7 +110,9 @@ class RateLimiter extends AbstractMiddleware {
       );
     }
 
-    const consumeKey = this.gerenateConsumeKey(req);
+    const { namespace } = this.app.getConfig('redis');
+
+    const consumeKey = `${namespace}-${this.gerenateConsumeKey(req)}`;
 
     const consumeResult = await this.limiter
       .consume(consumeKey, this.finalOptions.consumePoints)

package/tests/setup.js

@@ -4,8 +4,11 @@ const mongoose = require('mongoose');
 
 let mongoMemoryServerInstance;
 const path = require('path');
+const redis = require('redis');
 const Server = require('../server');
 
+const clearRadisNamespace = require('../helpers/redis/clearNamespace');
+
 jest.setTimeout(1000000);
 beforeAll(async () => {
   mongoMemoryServerInstance = await MongoMemoryReplSet.create({
@@ -63,6 +66,27 @@ beforeAll(async () => {
   }
   await global.server.startServer();
 });
+
+beforeEach(() => {
+  if (global.server) {
+    const key = `test-${Math.random().toString(36).substring(7)}`;
+    global.server.app.updateConfig('redis', {
+      namespace: key,
+    });
+  }
+});
+
+afterEach(async () => {
+  if (global.server) {
+    const { url, namespace } = global.server.getConfig('redis');
+    const redisClient = redis.createClient({ url });
+
+    await redisClient.connect();
+    await clearRadisNamespace(redisClient, namespace);
+    await redisClient.disconnect();
+  }
+});
+
 afterAll(async () => {
   if (global.server) {
     global.server.app.httpServer.shutdown();
@@ -72,7 +96,9 @@ afterAll(async () => {
   if (typeof global.testSetup.afterAll === 'function') {
     await global.testSetup.afterAll();
   }
+
   await mongoose.disconnect();
   await mongoMemoryServerInstance.stop();
+
   // }, 2000);
 });