Merge pull request #69 from exceptionless/main

Fixed Class Validator using development debug messages

Author: decs

packages/class-validator/src/__tests__/class-validator.test.ts

@@ -6,15 +6,24 @@ import {
   IsEmail,
   IsInt,
   IsNotEmpty,
+  IsOptional,
+  IsString,
   IsUUID,
   Min,
+  ValidateNested,
 } from 'class-validator';
 import {expectTypeOf} from 'expect-type';
 import {describe, expect, test} from 'vitest';
 
 import {assert, validate, wrap} from '..';
 
 describe('class-validator', () => {
+  class NestedSchema {
+    @IsString()
+    @IsNotEmpty()
+    value!: string;
+  }
+
   class Schema {
     @IsInt()
     @Min(0)
@@ -34,6 +43,12 @@ describe('class-validator', () => {
 
     @IsDateString()
     updatedAt!: string;
+
+    @ValidateNested()
+    nested!: NestedSchema;
+    @IsOptional()
+    @ValidateNested()
+    nestedArray?: NestedSchema[];
   }
   const schema = Schema;
 
@@ -44,14 +59,26 @@ describe('class-validator', () => {
     id: 'c4a760a8-dbcf-4e14-9f39-645a8e933d74',
     name: 'John Doe',
     updatedAt: '2021-01-01T00:00:00.000Z',
-  };
+  } as Schema;
+
   const badData = {
     age: '123',
     createdAt: '2021-01-01T00:00:00.000Z',
     email: '[email protected]',
     id: 'c4a760a8-dbcf-4e14-9f39-645a8e933d74',
     name: 'John Doe',
+    updatedAt: '2021-01-01T00:00:00.000Z'
+  };
+
+  const badNestedData = {
+    age: 123,
+    createdAt: '2021-01-01T00:00:00.000Z',
+    email: '[email protected]',
+    id: 'c4a760a8-dbcf-4e14-9f39-645a8e933d74',
+    name: 'John Doe',
     updatedAt: '2021-01-01T00:00:00.000Z',
+    nested: new NestedSchema(),
+    nestedArray: [new NestedSchema()],
   };
 
   test('infer', () => {
@@ -67,11 +94,35 @@ describe('class-validator', () => {
     expect(await validate(schema, badData)).toStrictEqual({
       issues: [
         {
-          message: `An instance of Schema has failed the validation:
- - property age has failed the following constraints: min, isInt 
-`,
+          message: 'age must not be less than 0',
           path: ['age'],
         },
+        {
+          message: 'age must be an integer number',
+          path: ['age'],
+        }
+      ],
+      success: false,
+    });
+
+    expect(await validate(schema, badNestedData)).toStrictEqual({
+      issues: [
+        {
+          message: 'value should not be empty',
+          path: ['nested.value'],
+        },
+        {
+          message: 'value must be a string',
+          path: ['nested.value'],
+        },
+        {
+          message: 'value should not be empty',
+          path: ['nestedArray[0].value'],
+        },
+        {
+          message: 'value must be a string',
+          path: ['nestedArray[0].value'],
+        }
       ],
       success: false,
     });

packages/class-validator/src/validation.ts

@@ -1,7 +1,9 @@
+/* eslint-disable prettier/prettier */
 import type {AdapterResolver} from './resolver';
-import type {ValidationAdapter} from '@typeschema/core';
+import type {ValidationAdapter, ValidationIssue} from '@typeschema/core';
 
 import {memoize} from '@typeschema/core';
+import { ValidationError } from "class-validator";
 
 const importValidationModule = memoize(async () => {
   const {validate} = await import('class-validator');
@@ -13,6 +15,22 @@ export const validationAdapter: ValidationAdapter<
 > = async schema => {
   const {validate} = await importValidationModule();
   return async data => {
+    function getIssues(error: ValidationError, parentPath = ""): ValidationIssue[] {
+      const currentPath = parentPath
+        ? Number.isInteger(+error.property) ? `${parentPath}[${error.property}]` : `${parentPath}.${error.property}`
+        : error.property;
+      const constraints = error.constraints ? Object.values(error.constraints) : [];
+      const childIssues = error.children ? error.children.flatMap(childError => getIssues(childError, currentPath)) : [];
+
+      return [
+          ...constraints.map((message) => ({
+              message: message,
+              path: [currentPath],
+          })),
+          ...childIssues
+      ];
+    }
+
     const errors = await validate(Object.assign(new schema(), data));
     if (errors.length === 0) {
       return {
@@ -22,10 +40,7 @@ export const validationAdapter: ValidationAdapter<
       };
     }
     return {
-      issues: errors.map(error => ({
-        message: error.toString(),
-        path: [error.property],
-      })),
+      issues: errors.flatMap(error => getIssues(error)),
       success: false,
     };
   };