not-node 6.3.21 → 6.3.23

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "not-node",
-	"version": "6.3.21",
+	"version": "6.3.23",
 	"description": "node complimentary part for client side notFramework.",
 	"main": "index.js",
 	"scripts": {

package/src/env.js

@@ -22,7 +22,7 @@ module.exports = class notEnv {
      *  Setting application environment variable
      *  @param   {string}      key  name of var
      *  @param   {object}      val  value
-     *  @return {notDomain}      chainable
+     *  @return     {notEnv}      chainable
      */
     static setEnv(key, val) {
         ENVS[key] = val;

package/src/form/form.js

@@ -1,7 +1,5 @@
 const validator = require("validator");
-
 const FormFabric = require("./fabric");
-
 const { createSchemaFromFields } = require("../fields");
 
 const { objHas, isFunc, firstLetterToUpper } = require("../common");
@@ -10,6 +8,8 @@ const ValidationBuilder = require("not-validation").Builder;
 const ValidationSession = require("not-validation").Session;
 
 const notValidationError = require("not-error/src/validation.error.node.cjs");
+const InitRateLimiter = require("../init/lib/rateLimiter");
+
 const notError = require("not-error/src/error.node.cjs");
 
 const {
@@ -53,6 +53,10 @@ class Form {
         ...DEFAULT_TRANSFORMERS,
     };
 
+    #rateLimiter = null;
+    #rateLimiterIdGetter = null;
+    #rateLimiterException = null;
+
     constructor({
         FIELDS,
         FORM_NAME,
@@ -62,6 +66,7 @@ class Form {
         EXTRACTORS = {},
         ENV_EXTRACTORS = {},
         TRANSFORMERS = {},
+        rate = null,
     }) {
         this.#FORM_NAME = FORM_NAME;
         this.#MODEL_NAME = MODEL_NAME;
@@ -72,6 +77,7 @@ class Form {
         this.#addExtractors(EXTRACTORS);
         this.#addEnvExtractors(ENV_EXTRACTORS);
         this.#addTransformers(TRANSFORMERS);
+        this.#createRateLimiter(rate);
     }
 
     /**
@@ -109,6 +115,7 @@ class Form {
      **/
     async run(req) {
         let data = await this.extract(req);
+        this.#checkRate(data);
         await this.#_validate(data);
         return data;
     }
@@ -460,6 +467,33 @@ class Form {
             this.#TRANSFORMERS = { ...this.#TRANSFORMERS, ...transformers };
         }
     }
+
+    #createRateLimiter(rate) {
+        if (rate) {
+            this.#rateLimiterIdGetter = rate.idGetter;
+            this.#rateLimiterException = rate.exception;
+            this.#rateLimiter = InitRateLimiter.initCustom(
+                rate.options,
+                rate.client
+            );
+        }
+    }
+
+    async #checkRate(envs) {
+        try {
+            this.#rateLimiter &&
+                typeof this.#rateLimiterIdGetter === "function" &&
+                (await this.#rateLimiter.consume(
+                    this.#rateLimiterIdGetter(envs)
+                ));
+        } catch (e) {
+            if (this.#rateLimiterException) {
+                throw new this.#rateLimiterException(envs);
+            } else {
+                throw e;
+            }
+        }
+    }
 }
 
 module.exports = Form;

package/src/generic/form.authorizedAction.js

@@ -9,8 +9,8 @@ module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
         actionName
     )}Form`;
     return class extends Form {
-        constructor({ app }) {
-            super({ MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME, app });
+        constructor(params) {
+            super({ ...params, MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME });
         }
 
         async extract(req) {

package/src/generic/form.getByID.js

@@ -13,8 +13,8 @@ module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
         actionName
     )}Form`;
     return class extends Form {
-        constructor({ app }) {
-            super({ MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME, app });
+        constructor(params) {
+            super({ ...params, MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME });
         }
 
         async extract(req) {

package/src/generic/form.getById.js

@@ -13,8 +13,8 @@ module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
         actionName
     )}Form`;
     return class extends Form {
-        constructor({ app }) {
-            super({ MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME, app });
+        constructor(params) {
+            super({ ...params, MODULE_NAME, MODEL_NAME, FIELDS, FORM_NAME });
         }
 
         async extract(req) {

package/src/generic/form.list.js

@@ -23,8 +23,14 @@ const FactoryFormList = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
     )}Form`;
 
     return class extends Form {
-        constructor({ app }) {
-            super({ FIELDS, FORM_NAME, app, MODULE_NAME, MODEL_NAME });
+        constructor(params) {
+            super({
+                ...params,
+                FIELDS,
+                FORM_NAME,
+                MODULE_NAME,
+                MODEL_NAME,
+            });
         }
 
         /**

package/src/generic/form.listAndCount.js

@@ -23,8 +23,14 @@ const FactoryFormListAndCount = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
     )}Form`;
 
     return class extends Form {
-        constructor({ app }) {
-            super({ FIELDS, FORM_NAME, app, MODULE_NAME, MODEL_NAME });
+        constructor(params) {
+            super({
+                ...params,
+                FIELDS,
+                FORM_NAME,
+                MODULE_NAME,
+                MODEL_NAME,
+            });
         }
 
         /**

package/src/init/lib/rateLimiter.js

@@ -1,5 +1,7 @@
 const log = require("not-log")(module, "RateLimiter");
 const { partCopyObj } = require("../../common");
+const notEnv = require("../../env");
+const { RateLimiterRedis } = require("rate-limiter-flexible");
 
 const DEFAULT_OPTIONS = {
     keyPrefix: "rateLimiterMiddleware",
@@ -26,7 +28,6 @@ module.exports = class InitRateLimiter {
         await emit("rateLimiter.pre", { config, master });
         const rateLimiter = InitRateLimiter.createRateLimiter({
             config,
-            master,
         });
         const middleware = InitRateLimiter.createMiddleware({ rateLimiter });
         master.getServer().use(middleware);
@@ -44,15 +45,43 @@ module.exports = class InitRateLimiter {
         };
     }
 
-    static createRateLimiter({ master, config }) {
-        const { RateLimiterRedis } = require("rate-limiter-flexible");
-        const storeClient = config.get(
-            "modules.rateLimiter.client",
-            DEFAULT_CLIENT
+    static createRateLimiter({ config }) {
+        const storeClient = InitRateLimiter.getClient(
+            InitRateLimiter.getClientName({ config })
         );
         return new RateLimiterRedis({
-            storeClient: master.getEnv(`db.${storeClient}`),
-            ...InitRateLimiter.getOptions({ master, config }),
+            storeClient,
+            ...InitRateLimiter.getOptions({ config }),
+        });
+    }
+
+    /**
+     *  Returns redis client name in "db.*" of notEnv
+     *
+     * @static
+     * @param {object} { config }
+     * @return {string}
+     */
+    static getClientName({ config }) {
+        return config.get("modules.rateLimiter.client", DEFAULT_CLIENT);
+    }
+
+    static getClient(storeClient) {
+        return notEnv.getEnv(`db.${storeClient}`);
+    }
+
+    static initCustom(
+        options = {
+            keyPrefix: "rateLimiterCustom",
+            points: 20,
+            duration: 1,
+        },
+        storeName = DEFAULT_CLIENT
+    ) {
+        const storeClient = InitRateLimiter.getClient(storeName);
+        return new RateLimiterRedis({
+            storeClient,
+            ...options,
         });
     }
 };

package/src/manifest/route.js

@@ -71,7 +71,7 @@ class notRoute {
 
     /**
      *	Select rule from available or return null
-     *	@param	{import('../types').ExtendedExpressRequest}	req 	Express Request Object
+     *	@param	{import('../types').notNodeExpressRequest}	req 	Express Request Object
      *	@return	{import('../types').notRouteRule | null}	rule or null
      */
     selectRule(req) {
@@ -85,7 +85,7 @@ class notRoute {
     /**
      *
      *
-     * @param {import('../types').ExtendedExpressRequest}       req
+     * @param {import('../types').notNodeExpressRequest}       req
      * @param {import('../types').notRouteData} notRouteData
      * @memberof notRoute
      */
@@ -112,7 +112,7 @@ class notRoute {
 
     /**
      *	Executes route action if such exist
-     *	@param	{import('../types').ExtendedExpressRequest}	req 	Express Request Object
+     *	@param	{import('../types').notNodeExpressRequest}	req 	Express Request Object
      *	@param	{import('express').Response}	res		Express Response Object
      *	@param	{function}	next
      *	@return {object}	result of execution or HttpError