@naturalcycles/backend-lib 9.22.1 → 9.24.0

package/dist/validation/ajv/ajvValidateRequest.d.ts

@@ -5,6 +5,14 @@ declare class AjvValidateRequest {
     body<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     query<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     params<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    /**
+     * Does NOT mutate `req.headers`,
+     * but returns validated/transformed headers.
+     *
+     * For headers we have a different behavior compared to body/query/params.
+     * We want to non-mutate the `req.headers`, because we anticipate that
+     * there may be additional consumers for `req.headers` (e.g middlewares, etc).
+     */
     headers<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     private validate;
 }

package/dist/validation/ajv/ajvValidateRequest.js

@@ -1,3 +1,4 @@
+import { _deepCopy } from '@naturalcycles/js-lib/object';
 import { handleValidationError } from '../validateRequest.util.js';
 class AjvValidateRequest {
     body(req, schema, opt = {}) {
@@ -9,14 +10,23 @@ class AjvValidateRequest {
     params(req, schema, opt = {}) {
         return this.validate(req, 'params', schema, opt);
     }
+    /**
+     * Does NOT mutate `req.headers`,
+     * but returns validated/transformed headers.
+     *
+     * For headers we have a different behavior compared to body/query/params.
+     * We want to non-mutate the `req.headers`, because we anticipate that
+     * there may be additional consumers for `req.headers` (e.g middlewares, etc).
+     */
     headers(req, schema, opt = {}) {
-        return this.validate(req, 'headers', schema, opt);
+        const originalHeaders = _deepCopy(req.headers);
+        const headers = this.validate(req, 'headers', schema, opt);
+        req.headers = originalHeaders;
+        return headers;
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutateInput = true } = opt;
         const input = req[reqProperty] || {};
         const [error, output] = schema.getValidationResult(input, {
-            mutateInput,
             inputName: `request ${reqProperty}`,
         });
         if (error) {

package/dist/validation/joi/joiValidateRequest.js

@@ -23,7 +23,6 @@ class ValidateRequest {
         return this.validate(req, 'headers', schema, opt);
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutateInput } = opt;
         const originalProperty = req[reqProperty] || {};
         // Joi does not mutate the input
         const [error, value] = getValidationResult(originalProperty, schema, `request ${reqProperty}`);
@@ -34,9 +33,8 @@ class ValidateRequest {
             }
             handleValidationError(error, originalProperty, opt);
         }
-        if (mutateInput) {
-            req[reqProperty] = value;
-        }
+        // Kirill: decide to not do it, let's see
+        // req[reqProperty] = value
         return value;
     }
 }

package/dist/validation/validateRequest.util.d.ts

@@ -11,11 +11,4 @@ export interface ReqValidationOptions<ERR extends AppError> {
      * If true - `genericErrorHandler` will report it to errorReporter (aka Sentry).
      */
     report?: boolean | ((err: ERR) => boolean);
-    /**
-     * Defaults to true.
-     *
-     * When set to true, input (body, query, headers or params) will be mutated.
-     * So, e.g req.body will already contain mutated data post-validation.
-     */
-    mutateInput?: boolean;
 }

package/dist/validation/zod/zodValidateRequest.js

@@ -23,16 +23,14 @@ class ZodValidateRequest {
         return this.validate(req, 'headers', schema, opt);
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutateInput } = opt;
         const originalProperty = req[reqProperty] || {};
         // Zod does not mutate the input
         const [error, data] = zSafeValidate(originalProperty, schema);
         if (error) {
             handleValidationError(error, originalProperty, opt);
         }
-        if (mutateInput) {
-            req[reqProperty] = data;
-        }
+        // Kirill: decide to not do it, let's see
+        // req[reqProperty] = data
         return data;
     }
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.22.1",
+  "version": "9.24.0",
   "peerDependencies": {
-    "@sentry/node": "^9"
+    "@sentry/node": "^10"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^10",
@@ -26,7 +26,7 @@
     "tslib": "^2"
   },
   "devDependencies": {
-    "@sentry/node": "^9",
+    "@sentry/node": "^10",
     "@types/ejs": "^3",
     "fastify": "^5",
     "@naturalcycles/dev-lib": "18.4.2"

package/src/validation/ajv/ajvValidateRequest.ts

@@ -1,3 +1,4 @@
+import { _deepCopy } from '@naturalcycles/js-lib/object'
 import type { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib/ajv'
 import type { BackendRequest } from '../../server/server.model.js'
 import { handleValidationError, type ReqValidationOptions } from '../validateRequest.util.js'
@@ -27,12 +28,23 @@ class AjvValidateRequest {
     return this.validate(req, 'params', schema, opt)
   }
 
+  /**
+   * Does NOT mutate `req.headers`,
+   * but returns validated/transformed headers.
+   *
+   * For headers we have a different behavior compared to body/query/params.
+   * We want to non-mutate the `req.headers`, because we anticipate that
+   * there may be additional consumers for `req.headers` (e.g middlewares, etc).
+   */
   headers<T>(
     req: BackendRequest,
     schema: AjvSchema<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
-    return this.validate(req, 'headers', schema, opt)
+    const originalHeaders = _deepCopy(req.headers)
+    const headers = this.validate(req, 'headers', schema, opt)
+    req.headers = originalHeaders
+    return headers
   }
 
   private validate<T>(
@@ -41,11 +53,9 @@ class AjvValidateRequest {
     schema: AjvSchema<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
-    const { mutateInput = true } = opt
     const input: T = req[reqProperty] || {}
 
     const [error, output] = schema.getValidationResult(input, {
-      mutateInput,
       inputName: `request ${reqProperty}`,
     })
 

package/src/validation/joi/joiValidateRequest.ts

@@ -51,7 +51,6 @@ class ValidateRequest {
     schema: AnySchema<T>,
     opt: ReqValidationOptions<JoiValidationError> = {},
   ): T {
-    const { mutateInput } = opt
     const originalProperty = req[reqProperty] || {}
 
     // Joi does not mutate the input
@@ -66,9 +65,8 @@ class ValidateRequest {
       handleValidationError(error, originalProperty, opt)
     }
 
-    if (mutateInput) {
-      req[reqProperty] = value
-    }
+    // Kirill: decide to not do it, let's see
+    // req[reqProperty] = value
 
     return value
   }

package/src/validation/validateRequest.util.ts

@@ -50,12 +50,4 @@ export interface ReqValidationOptions<ERR extends AppError> {
    * If true - `genericErrorHandler` will report it to errorReporter (aka Sentry).
    */
   report?: boolean | ((err: ERR) => boolean)
-
-  /**
-   * Defaults to true.
-   *
-   * When set to true, input (body, query, headers or params) will be mutated.
-   * So, e.g req.body will already contain mutated data post-validation.
-   */
-  mutateInput?: boolean
 }

package/src/validation/zod/zodValidateRequest.ts

@@ -50,7 +50,6 @@ class ZodValidateRequest {
     schema: ZodType<T>,
     opt: ReqValidationOptions<ZodValidationError> = {},
   ): T {
-    const { mutateInput } = opt
     const originalProperty = req[reqProperty] || {}
 
     // Zod does not mutate the input
@@ -64,9 +63,8 @@ class ZodValidateRequest {
       handleValidationError(error, originalProperty, opt)
     }
 
-    if (mutateInput) {
-      req[reqProperty] = data
-    }
+    // Kirill: decide to not do it, let's see
+    // req[reqProperty] = data
 
     return data
   }