not-node 6.3.23 → 6.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "not-node",
-	"version": "6.3.23",
+	"version": "6.3.25",
 	"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

@@ -11,6 +11,7 @@ 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,
@@ -54,8 +55,9 @@ class Form {
     };
 
     #rateLimiter = null;
-    #rateLimiterIdGetter = null;
-    #rateLimiterException = null;
+    #rateLimiterIdGetter = (data) => data.identity.sid;
+    #rateLimiterException = FormExceptionTooManyRequests;
+    #rateLimiterClientName = InitRateLimiter.DEFAULT_CLIENT;
 
     constructor({
         FIELDS,
@@ -470,28 +472,36 @@ class Form {
 
     #createRateLimiter(rate) {
         if (rate) {
-            this.#rateLimiterIdGetter = rate.idGetter;
-            this.#rateLimiterException = rate.exception;
-            this.#rateLimiter = InitRateLimiter.initCustom(
-                rate.options,
-                rate.client
-            );
+            if (typeof rate.idGetter === "function") {
+                this.#rateLimiterIdGetter = rate.idGetter;
+            }
+            if (rate.exception) {
+                this.#rateLimiterException = rate.exception;
+            }
+            if (rate.client && typeof rate.client === "string") {
+                this.#rateLimiterClientName = rate.client;
+            }
+            if (
+                rate.options &&
+                typeof rate.options == "object" &&
+                typeof rate.client === "string"
+            ) {
+                this.#rateLimiter = InitRateLimiter.initCustom(
+                    rate.options,
+                    this.#rateLimiterClientName
+                );
+            }
         }
     }
 
     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;
-            }
+        } catch (_) {
+            throw new this.#rateLimiterException(envs);
         }
     }
 }

package/src/init/lib/rateLimiter.js

@@ -12,13 +12,17 @@ const DEFAULT_OPTIONS = {
 const DEFAULT_CLIENT = "ioredis";
 
 module.exports = class InitRateLimiter {
+    static get DEFAULT_CLIENT() {
+        return DEFAULT_CLIENT;
+    }
+
     static createMiddleware({ rateLimiter }) {
         return (req, res, next) => {
             rateLimiter
                 .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");
                 });
         };
@@ -59,7 +63,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 }) {