fix(DEV-123): Improve error thrown by failed validations (#395)

* fix(DEV-123): Improve error thrown by failed validations

* fix(DEV-123): Replace map with forEach in MapAndValidatePipe

Author: NicoKaempf

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "10.8.8",
+  "version": "10.8.9",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",

package.json

@@ -11,7 +11,7 @@ servers:
 info:
   title: lT Nest Server
   description: Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).
-  version: 10.8.8
+  version: 10.8.9
   contact:
     name: lenne.Tech GmbH
     url: https://lenne.tech

spectaql.yml

@@ -19,10 +19,32 @@ export const commonErrorSchema = {
   type: 'object',
 };
 
+export const badRequestSchema = {
+  properties: {
+    message: { type: 'string' },
+    name: { type: 'string' },
+    options: {
+      additionalProperties: true,
+      type: 'object',
+    },
+    response: {
+      additionalProperties: {
+        additionalProperties: {
+          type: 'string',
+        },
+        type: 'object',
+      },
+      type: 'object',
+    },
+    status: { type: 'number' },
+  },
+  type: 'object',
+};
+
 export function ApiCommonErrorResponses() {
   return applyDecorators(
     ApiUnauthorizedResponse({ schema: commonErrorSchema }),
     ApiNotFoundResponse({ schema: commonErrorSchema }),
-    ApiBadRequestResponse({ schema: commonErrorSchema }),
+    ApiBadRequestResponse({ schema: badRequestSchema }),
   );
 }

src/core/common/decorators/common-error.decorator.ts

@@ -25,7 +25,11 @@ export class MapAndValidatePipe implements PipeTransform {
     // Validate
     const errors = await validate(value, { forbidUnknownValues: false });
     if (errors.length > 0) {
-      throw new BadRequestException(`Input validation failed:${errors.join('; ')}`);
+      const result = {};
+      errors.forEach((e) => {
+        result[e.property] = e.constraints;
+      });
+      throw new BadRequestException(result);
     }
 
     return value;

src/core/common/pipes/map-and-validate.pipe.ts

@@ -239,28 +239,32 @@ describe('Project (e2e)', () => {
       name: expect.any(String),
       options: expect.any(Object),
       response: {
-        error: expect.any(String),
-        message: expect.any(String),
-        statusCode: expect.any(Number),
+        email: {
+          isEmail: expect.any(String),
+          isNotEmpty: expect.any(String),
+        },
+        password: {
+          isNotEmpty: expect.any(String),
+          isString: expect.any(String),
+        },
       },
       status: expect.any(Number),
     });
 
     // Test for concrete values
     expect(res).toMatchObject({
-      message: 'Input validation failed:An instance of CoreAuthSignInInput has failed the validation:\n'
-        + ' - property email has failed the following constraints: isNotEmpty, isEmail \n'
-        + '; An instance of CoreAuthSignInInput has failed the validation:\n'
-        + ' - property password has failed the following constraints: isString, isNotEmpty \n',
+      message: 'Bad Request Exception',
       name: 'BadRequestException',
       options: {},
       response: {
-        error: 'Bad Request',
-        message: 'Input validation failed:An instance of CoreAuthSignInInput has failed the validation:\n'
-          + ' - property email has failed the following constraints: isNotEmpty, isEmail \n'
-          + '; An instance of CoreAuthSignInInput has failed the validation:\n'
-          + ' - property password has failed the following constraints: isString, isNotEmpty \n',
-        statusCode: 400,
+        email: {
+          isEmail: 'email must be an email',
+          isNotEmpty: 'email should not be empty',
+        },
+        password: {
+          isNotEmpty: 'password should not be empty',
+          isString: 'password must be a string',
+        },
       },
       status: 400,
     });