not-node 6.3.22 → 6.3.24

package/package.json

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

package/src/exceptions/form.js

@@ -1,8 +1,9 @@
 const notRequestError = require("not-error/src/request.error.node.cjs");
+const { HttpExceptionTooManyRequests } = require("./http");
 class FormExceptionExtractorForFieldIsUndefined extends notRequestError {
     constructor(fieldName) {
         super("not-node:form_exception_field_extractor_is_undefined", {
-            fieldName,
+            params: { fieldName },
         });
     }
 }
@@ -13,11 +14,23 @@ module.exports.FormExceptionExtractorForFieldIsUndefined =
 class FormExceptionTransformerForFieldIsUndefined extends notRequestError {
     constructor(fieldName, instruction) {
         super("not-node:form_exception_field_transformer_is_undefined", {
-            fieldName,
-            instruction,
+            params: {
+                fieldName,
+                instruction,
+            },
         });
     }
 }
 
 module.exports.FormExceptionTransformerForFieldIsUndefined =
     FormExceptionTransformerForFieldIsUndefined;
+
+class FormExceptionTooManyRequests extends HttpExceptionTooManyRequests {
+    constructor(formData) {
+        super({
+            ip: formData.identity.ip,
+        });
+    }
+}
+
+module.exports.FormExceptionTooManyRequests = FormExceptionTooManyRequests;

package/src/exceptions/http.js

@@ -1,4 +1,4 @@
-const { notRequestError } = require("not-error");
+const notRequestError = require("not-error/src/request.error.node.cjs");
 
 //https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#client_error_responses
 
@@ -41,3 +41,10 @@ class HttpExceptionNotFound extends notRequestError {
     }
 }
 module.exports.HttpExceptionNotFound = HttpExceptionNotFound;
+
+class HttpExceptionTooManyRequests extends notRequestError {
+    constructor(params) {
+        super("Too many requests", { code: 429, ...params });
+    }
+}
+module.exports.HttpExceptionTooManyRequests = HttpExceptionTooManyRequests;

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,7 +8,10 @@ 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 { FormExceptionTooManyRequests } = require("../exceptions/form.js");
 
 const {
     FormExceptionExtractorForFieldIsUndefined,
@@ -53,6 +54,10 @@ class Form {
         ...DEFAULT_TRANSFORMERS,
     };
 
+    #rateLimiter = null;
+    #rateLimiterIdGetter = (data) => data.identity.sid;
+    #rateLimiterException = FormExceptionTooManyRequests;
+
     constructor({
         FIELDS,
         FORM_NAME,
@@ -62,6 +67,7 @@ class Form {
         EXTRACTORS = {},
         ENV_EXTRACTORS = {},
         TRANSFORMERS = {},
+        rate = null,
     }) {
         this.#FORM_NAME = FORM_NAME;
         this.#MODEL_NAME = MODEL_NAME;
@@ -72,6 +78,7 @@ class Form {
         this.#addExtractors(EXTRACTORS);
         this.#addEnvExtractors(ENV_EXTRACTORS);
         this.#addTransformers(TRANSFORMERS);
+        this.#createRateLimiter(rate);
     }
 
     /**
@@ -109,6 +116,7 @@ class Form {
      **/
     async run(req) {
         let data = await this.extract(req);
+        this.#checkRate(data);
         await this.#_validate(data);
         return data;
     }
@@ -460,6 +468,38 @@ class Form {
             this.#TRANSFORMERS = { ...this.#TRANSFORMERS, ...transformers };
         }
     }
+
+    #createRateLimiter(rate) {
+        if (rate) {
+            if (typeof rate.idGetter === "function") {
+                this.#rateLimiterIdGetter = rate.idGetter;
+            }
+            if (rate.exception) {
+                this.#rateLimiterException = rate.exception;
+            }
+            if (
+                rate.options &&
+                typeof rate.options == "object" &&
+                typeof rate.client === "string"
+            ) {
+                this.#rateLimiter = InitRateLimiter.initCustom(
+                    rate.options,
+                    rate.client
+                );
+            }
+        }
+    }
+
+    async #checkRate(envs) {
+        try {
+            this.#rateLimiter &&
+                (await this.#rateLimiter.consume(
+                    this.#rateLimiterIdGetter(envs)
+                ));
+        } catch (_) {
+            throw new this.#rateLimiterException(envs);
+        }
+    }
 }
 
 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

@@ -18,7 +18,7 @@ module.exports = class InitRateLimiter {
                 .consume(req.ip)
                 .then(() => next())
                 .catch(() => {
-                    log.error("Too many requests by " + req.ip);
+                    log?.error("Too many requests by " + req.ip);
                     res.status(429).send("Too Many Requests");
                 });
         };
@@ -28,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);
@@ -60,7 +59,7 @@ module.exports = class InitRateLimiter {
      *  Returns redis client name in "db.*" of notEnv
      *
      * @static
-     * @param {object} { config }
+     * @param {object}  params={ config }
      * @return {string}
      */
     static getClientName({ config }) {