not-node 4.0.10 → 4.0.15

package/.eslintrc.json

@@ -18,7 +18,8 @@
   "extends": [
     "eslint:recommended",
     "plugin:node/recommended",
-		"plugin:sonarjs/recommended"
+		"plugin:sonarjs/recommended",
+    "plugin:promise/recommended"
   ],
 	"plugins": ["promise"],
   "rules": {

package/index.js

@@ -30,7 +30,9 @@ module.exports.Common = require('./src/common');
 /** Fields library manager */
 module.exports.Fields = require('./src/fields');
 /** Form validation template **/
-module.exports.Form = require('./src/form');
+module.exports.Form = require('./src/form').Form;
+/** Form validation template fabric **/
+module.exports.FormFabric = require('./src/form').FormFabric;
 /** Application initialization procedures */
 module.exports.Init = require('./src/init').Init;
 /** Application object */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "not-node",
-  "version": "4.0.10",
+  "version": "4.0.15",
   "description": "node complimentary part for client side notFramework.",
   "main": "index.js",
   "scripts": {
@@ -53,36 +53,36 @@
     "mongoose": "*",
     "mongoose-validator": "*",
     "nconf": "*",
-    "not-config": "^0.1.3",
-    "not-error": "^0.2.0",
+    "not-config": "^0.1.4",
+    "not-error": "^0.2.1",
     "not-filter": "*",
     "not-inform": "^0.0.27",
     "not-locale": "*",
     "not-log": "^0.0.20",
     "not-monitor": "^0.0.13",
     "not-path": "*",
-    "rate-limiter-flexible": "^2.3.3",
-    "redis": "^3.1.2",
+    "rate-limiter-flexible": "^2.3.6",
+    "redis": "^4.0.0",
     "rmdir": "^1.2.0",
     "serve-static": "*",
     "simple-git": "*",
     "yargs": "*"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.15.8",
+    "@babel/eslint-parser": "^7.16.3",
     "babel-eslint": "^10.1.0",
     "chai": "*",
     "chai-as-promised": "*",
-    "eslint": "^7.32.0",
+    "eslint": "^8.3.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.1",
-    "eslint-plugin-sonarjs": "^0.10.0",
+    "eslint-plugin-promise": "^5.2.0",
+    "eslint-plugin-sonarjs": "^0.11.0",
     "ink-docstrap": "^1.3.2",
-    "ioredis": "^4.28.1",
+    "ioredis": "^4.28.2",
     "jsdoc": "^3.6.7",
     "mocha": "*",
     "mocha-suppress-logs": "^0.3.1",
-    "mongodb-memory-server": "^7.5.1",
+    "mongodb-memory-server": "^8.0.4",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "retire": "^3.0.3"

package/src/common.js

@@ -92,6 +92,21 @@ module.exports.copyObj = (obj) => {
   return JSON.parse(JSON.stringify(obj));
 };
 
+/**
+* Copies object to secure it from changes
+* @param {object}   obj     original object
+* @return {object}          copy of object
+**/
+module.exports.partCopyObj = (obj, list) => {
+  let partObj =  Object.keys(obj).reduce((prev, curr)=>{
+    if(list.includes(curr)){
+      prev[curr] = obj[curr];
+    }
+    return prev;
+  }, {});
+  return JSON.parse(JSON.stringify(partObj));
+};
+
 
 /**
 * Test argument type to be 'function'

package/src/form/fabric.js

@@ -0,0 +1,28 @@
+const Form = require('./form');
+
+module.exports = class FormFabric {
+  static create({
+    FIELDS,
+    MODULE_NAME,
+    FORM_NAME,
+    extractor
+  }) {
+    return class extends Form {
+      constructor() {
+        super({
+          FIELDS,
+          FORM_NAME: `${MODULE_NAME}:${FORM_NAME}`
+        });
+      }
+
+      /**
+       * Extracts data
+       * @param {ExpressRequest} req expressjs request object
+       * @return {Object}        forma data
+       **/
+      extract(req) {
+        return extractor(req);
+      }
+    };
+  }
+};

package/src/form/form.js

@@ -0,0 +1,93 @@
+//DB related validation tools
+const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
+//not-node
+const initFields = require('../fields').initFields;
+
+const FormFabric = require('./fabric');
+
+const {
+  byFieldsValidators
+} = require('../model/enrich');
+
+const {
+  notValidationError,
+  notError
+} = require('not-error');
+
+
+/**
+ * Generic form validation class
+ **/
+class Form {
+  constructor({
+    FIELDS,
+    FORM_NAME
+  }) {
+    this.FORM_NAME = FORM_NAME;
+    this.FIELDS = FIELDS;
+    this.SCHEMA = byFieldsValidators(initFields(FIELDS, 'model'));
+    if (mongoose.modelNames().indexOf(FORM_NAME)===-1){
+      this.MODEL = mongoose.model(FORM_NAME, Schema(this.SCHEMA));
+    }else{
+      this.MODEL = mongoose.connection.model(FORM_NAME);
+    }
+  }
+
+  /**
+   * Extract data from ExpressRequest object and validates it
+   * returns it or throws
+   * @param {ExpressRequest} req expressjs request object
+   * @return {Promise<Object>} form data
+   * @throws {notValidationError}
+   **/
+  async run(req) {
+    let data = await this.extract(req);
+    await this.validate(data);
+    return data;
+  }
+
+  /**
+   * Extracts data, should be overriden
+   * @param {ExpressRequest} req expressjs request object
+   * @return {Object}        forma data
+   **/
+  async extract( /*req*/ ) {
+    return {};
+  }
+
+  /**
+   * Validates form data or throws
+   * @param {Object} data    form data
+   * @return {Object}
+   * @throws {notValidationError}
+   **/
+  async validate(data) {
+    try {
+      await this.MODEL.validate(data, this.FIELDS);
+    } catch (e) {
+      let fields = {};
+      if (e instanceof mongoose.Error.ValidationError) {
+        Object.keys(e.errors).forEach(name => {
+          fields[name] = [e.errors[name].message];
+        });
+        throw new notValidationError(e.message, fields, e, data);
+      } else {
+        throw new notError(
+          'core:form_validation_error', {
+            FORM_NAME: this.FORM_NAME,
+            FIELDS: this.FIELDS,
+            data
+          },
+          e
+        );
+      }
+    }
+  }
+
+  static fabric(){
+    return FormFabric;
+  }
+}
+
+module.exports = Form;

package/src/form/index.js

@@ -1,82 +1,4 @@
-//DB related validation tools
-const mongoose = require('mongoose');
-const Schema = mongoose.Schema;
-//not-node
-const initFields = require('../fields').initFields;
-const {
-  byFieldsValidators
-} = require('../model/enrich');
-const {
-  notValidationError,
-  notError
-} = require('not-error');
-
-/**
- * Generic form validation class
- **/
-module.exports = class Form {
-  constructor({
-    FIELDS,
-    FORM_NAME
-  }) {
-    this.FORM_NAME = FORM_NAME;
-    this.FIELDS = FIELDS;
-    this.SCHEMA = byFieldsValidators(initFields(FIELDS, 'model'));
-    if (mongoose.modelNames().indexOf(FORM_NAME)===-1){
-      this.MODEL = mongoose.model(FORM_NAME, Schema(this.SCHEMA));
-    }else{
-      this.MODEL = mongoose.connection.model(FORM_NAME);
-    }
-  }
-
-  /**
-   * Extract data from ExpressRequest object and validates it
-   * returns it or throws
-   * @param {ExpressRequest} req expressjs request object
-   * @return {Promise<Object>} form data
-   * @throws {notValidationError}
-   **/
-  async run(req) {
-    let data = await this.extract(req);
-    await this.validate(data);
-    return data;
-  }
-
-  /**
-   * Extracts data, should be overriden
-   * @param {ExpressRequest} req expressjs request object
-   * @return {Object}        forma data
-   **/
-  async extract( /*req*/ ) {
-    return {};
-  }
-
-  /**
-   * Validates form data or throws
-   * @param {Object} data    form data
-   * @return {Object}
-   * @throws {notValidationError}
-   **/
-  async validate(data) {
-    try {
-      await this.MODEL.validate(data, this.FIELDS);
-    } catch (e) {
-      let fields = {};
-      if (e instanceof mongoose.Error.ValidationError) {
-        Object.keys(e.errors).forEach(name => {
-          fields[name] = [e.errors[name].message];
-        });
-        throw new notValidationError(e.message, fields, e, data);
-      } else {
-        throw new notError(
-          'core:form_validation_error', {
-            FORM_NAME: this.FORM_NAME,
-            FIELDS: this.FIELDS,
-            data
-          },
-          e
-        );
-      }
-    }
-  }
+module.exports = {
+  Form: require('./form'),
+  FormFabric: require('./fabric'),
 };

package/src/init/rateLimiter.js

@@ -1,14 +1,21 @@
 const emit = require('./additional').run;
 const log = require('not-log')(module, 'RateLimiter');
+const {partCopyObj} = require('../common');
+
+const DEFAULT_OPTIONS = {
+  keyPrefix: 'rateLimiterMiddleware',
+  points: 20,
+  duration: 1
+};
+
+const DEFAULT_CLIENT = 'ioredis';
 
 module.exports = class InitRateLimiter{
 
   static createMiddleware({rateLimiter}){
     return (req, res, next) => {
       rateLimiter.consume(req.ip)
-        .then(() => {
-          next();
-        })
+        .then(() =>  next())
         .catch(() => {
           log.error('Too many requests by ' + req.ip);
           res.status(429).send('Too Many Requests');
@@ -24,13 +31,21 @@ module.exports = class InitRateLimiter{
     await emit('rateLimiter.post', { config, master});
   }
 
-  static createRateLimiter({master}){
+
+  static getOptions({config}){
+    const opts = partCopyObj(config.get('modules.rateLimiter', {}), Object.keys(DEFAULT_OPTIONS));
+    return {
+      ...DEFAULT_OPTIONS,
+      ...opts
+    };
+  }
+
+  static createRateLimiter({master, config}){
     const {RateLimiterRedis} = require('rate-limiter-flexible');
+    const storeClient = config.get('modules.rateLimiter.client', DEFAULT_CLIENT);
     return new RateLimiterRedis({
-      storeClient:  master.getEnv('db.redis'),
-      keyPrefix:    'middleware',
-      points:       100,     // 10 requests
-      duration:     1,    // per 1 second by IP
+      storeClient:  master.getEnv(`db.${storeClient}`),
+      ...InitRateLimiter.getOptions({master, config})
     });
   }
 };

package/src/init/sessions/redis.js

@@ -1,17 +1,20 @@
 const log = require('not-log')(module, 'not-node//init');
 const ADDS = require('../additional');
 
+const DEFAULT_CLIENT = 'ioredis';
+
 module.exports = class InitSessionsRedis{
   async run({config, options, master}) {
     log.info('Setting up user sessions handler(redis)...');
     await ADDS.run('sessions.pre', {config, options, master});
     const expressSession = require('express-session');
-    const redisClient = master.getEnv('db.redis');
+    const storeClient = config.get('session.client', DEFAULT_CLIENT);
+    const redisClient = master.getEnv(`db.${storeClient}`);
     const redisStore = require('connect-redis')(expressSession);
     master.getServer().use(expressSession({
-      secret:             config.get('session:secret'),
-      key:                config.get('session:key'),
-      cookie:             config.get('session:cookie'),
+      secret:             config.get('session.secret'),
+      key:                config.get('session.key'),
+      cookie:             config.get('session.cookie'),
       resave:             false,
       saveUninitialized:  true,
       store: new redisStore({