feat(common): adding the fieldname to validation errors

packages/common/pipes/parse-array.pipe.ts

@@ -10,7 +10,6 @@ import { HttpErrorByCode } from '../utils/http-error-by-code.util';
 import { isNil, isUndefined, isString } from '../utils/shared.utils';
 import { ValidationPipe, ValidationPipeOptions } from './validation.pipe';
 
-const VALIDATION_ERROR_MESSAGE = 'Validation failed (parsable array expected)';
 const DEFAULT_ARRAY_SEPARATOR = ',';
 
 /**
@@ -62,21 +61,27 @@ export class ParseArrayPipe implements PipeTransform {
  */
  async transform(value: any, metadata: ArgumentMetadata): Promise<any> {
  if (!value && !this.options.optional) {
- throw this.exceptionFactory(VALIDATION_ERROR_MESSAGE);
+ throw this.exceptionFactory(
+ this.getValidationErrorMessage(metadata.data),
+ );
  } else if (isNil(value) && this.options.optional) {
  return value;
  }
 
  if (!Array.isArray(value)) {
  if (!isString(value)) {
- throw this.exceptionFactory(VALIDATION_ERROR_MESSAGE);
+ throw this.exceptionFactory(
+ this.getValidationErrorMessage(metadata.data),
+ );
  } else {
  try {
  value = value
  .trim()
  .split(this.options.separator || DEFAULT_ARRAY_SEPARATOR);
  } catch {
- throw this.exceptionFactory(VALIDATION_ERROR_MESSAGE);
+ throw this.exceptionFactory(
+ this.getValidationErrorMessage(metadata.data),
+ );
  }
  }
  }
@@ -135,6 +140,10 @@ export class ParseArrayPipe implements PipeTransform {
  return value;
  }
 
+ protected getValidationErrorMessage(field: string) {
+ return `Validation failed (parsable array expected in "${field}")`;
+ }
+
  protected isExpectedTypePrimitive(): boolean {
  return [Boolean, Number, String].includes(this.options.items as any);
  }

packages/common/pipes/parse-bool.pipe.ts

@@ -63,7 +63,7 @@ export class ParseBoolPipe
  return false;
  }
  throw this.exceptionFactory(
- 'Validation failed (boolean string is expected)',
+ `Validation failed (boolean string is expected in "${metadata.data}")`,
  );
  }
 

packages/common/pipes/parse-enum.pipe.ts

@@ -57,7 +57,7 @@ export class ParseEnumPipe<T = any> implements PipeTransform<T> {
  }
  if (!this.isEnum(value)) {
  throw this.exceptionFactory(
- 'Validation failed (enum string is expected)',
+ `Validation failed (enum string is expected in "${metadata.data}")`,
  );
  }
  return value;

packages/common/pipes/parse-float.pipe.ts

@@ -50,7 +50,7 @@ export class ParseFloatPipe implements PipeTransform<string> {
  }
  if (!this.isNumeric(value)) {
  throw this.exceptionFactory(
- 'Validation failed (numeric string is expected)',
+ `Validation failed (numeric string is expected in "${metadata.data}")`,
  );
  }
  return parseFloat(value);

packages/common/pipes/parse-int.pipe.ts

@@ -54,7 +54,7 @@ export class ParseIntPipe implements PipeTransform<string> {
  }
  if (!this.isNumeric(value)) {
  throw this.exceptionFactory(
- 'Validation failed (numeric string is expected)',
+ `Validation failed (numeric string is expected in "${metadata.data}")`,
  );
  }
  return parseInt(value, 10);

packages/common/pipes/parse-uuid.pipe.ts

@@ -61,7 +61,7 @@ export class ParseUUIDPipe implements PipeTransform<string> {
  throw this.exceptionFactory(
  `Validation failed (uuid${
  this.version ? ` v ${this.version}` : ''
- } is expected)`,
+ } is expected in "${metadata.data}")`,
  );
  }
  return value;

packages/common/test/pipes/parse-array.pipe.spec.ts

@@ -43,6 +43,11 @@ describe('ParseArrayPipe', () => {
  beforeEach(() => {
  target = new ParseArrayPipe();
  });
+ it('should mention the field name in the error', async () => {
+ return expect(
+ target.transform(true, { data: 'foo' } as ArgumentMetadata),
+ ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+ });
  it('should throw an exception (boolean)', async () => {
  return expect(
  target.transform(true, {} as ArgumentMetadata),

packages/common/test/pipes/parse-bool.pipe.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseBoolPipe } from '../../pipes/parse-bool.pipe';
+import { BadRequestException } from '../../exceptions';
 
 describe('ParseBoolPipe', () => {
  let target: ParseBoolPipe;
@@ -27,8 +28,14 @@ describe('ParseBoolPipe', () => {
  });
  describe('when validation fails', () => {
  it('should throw an error', async () => {
- return expect(target.transform('123abc', {} as ArgumentMetadata)).to.be
- .rejected;
+ return expect(
+ target.transform('123abc', {} as ArgumentMetadata),
+ ).to.be.rejectedWith(BadRequestException);
+ });
+ it('should mention the field name in the error', async () => {
+ return expect(
+ target.transform('123abc', { data: 'foo' } as ArgumentMetadata),
+ ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
  });
  });
  });

packages/common/test/pipes/parse-float.pipe.spec.ts

@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseFloatPipe } from '../../pipes/parse-float.pipe';
-import { HttpException } from '../../exceptions';
+import { BadRequestException, HttpException } from '../../exceptions';
 
 class CustomTestError extends HttpException {
  constructor() {
@@ -13,9 +13,7 @@ class CustomTestError extends HttpException {
 describe('ParseFloatPipe', () => {
  let target: ParseFloatPipe;
  beforeEach(() => {
- target = new ParseFloatPipe({
- exceptionFactory: (error: any) => new CustomTestError(),
- });
+ target = new ParseFloatPipe();
  });
  describe('transform', () => {
  describe('when validation passes', () => {
@@ -35,6 +33,23 @@ describe('ParseFloatPipe', () => {
  it('should throw an error', async () => {
  return expect(
  target.transform('123.123abc', {} as ArgumentMetadata),
+ ).to.be.rejectedWith(BadRequestException);
+ });
+ it('should mention the field name in the error', async () => {
+ return expect(
+ target.transform('123.123abc', { data: 'foo' } as ArgumentMetadata),
+ ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+ });
+ });
+ describe('with an exceptionFactory', () => {
+ beforeEach(() => {
+ target = new ParseFloatPipe({
+ exceptionFactory: (error: any) => new CustomTestError(),
+ });
+ });
+ it('uses it when the validation fails', async () => {
+ return expect(
+ target.transform('123abc', {} as ArgumentMetadata),
  ).to.be.rejectedWith(CustomTestError);
  });
  });

packages/common/test/pipes/parse-int.pipe.spec.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { ArgumentMetadata } from '../../interfaces';
 import { ParseIntPipe } from '../../pipes/parse-int.pipe';
-import { HttpException } from '../../exceptions';
+import { BadRequestException, HttpException } from '../../exceptions';
 
 class CustomTestError extends HttpException {
  constructor() {
@@ -12,9 +12,7 @@ class CustomTestError extends HttpException {
 describe('ParseIntPipe', () => {
  let target: ParseIntPipe;
  beforeEach(() => {
- target = new ParseIntPipe({
- exceptionFactory: (error: any) => new CustomTestError(),
- });
+ target = new ParseIntPipe();
  });
  describe('transform', () => {
  describe('when validation passes', () => {
@@ -37,14 +35,31 @@ describe('ParseIntPipe', () => {
  });
  });
  describe('when validation fails', () => {
+ it('should mention the field name in the error', async () => {
+ return expect(
+ target.transform('123abc', { data: 'foo' } as ArgumentMetadata),
+ ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+ });
  it('should throw an error', async () => {
  return expect(
  target.transform('123abc', {} as ArgumentMetadata),
- ).to.be.rejectedWith(CustomTestError);
+ ).to.be.rejectedWith(BadRequestException);
  });
  it('should throw an error when number has wrong number encoding', async () => {
  return expect(
  target.transform('0xFF', {} as ArgumentMetadata),
+ ).to.be.rejectedWith(BadRequestException);
+ });
+ });
+ describe('with an exceptionFactory', () => {
+ beforeEach(() => {
+ target = new ParseIntPipe({
+ exceptionFactory: (error: any) => new CustomTestError(),
+ });
+ });
+ it('uses it when the validation fails', async () => {
+ return expect(
+ target.transform('123abc', {} as ArgumentMetadata),
  ).to.be.rejectedWith(CustomTestError);
  });
  });

packages/common/test/pipes/parse-uuid.pipe.spec.ts

@@ -56,6 +56,13 @@ describe('ParseUUIDPipe', () => {
  ).to.be.rejectedWith(TestException);
  });
 
+ it('should mention the field name in the error', async () => {
+ target = new ParseUUIDPipe();
+ await expect(
+ target.transform('123a', { data: 'foo' } as ArgumentMetadata),
+ ).to.be.rejectedWith(/.*Validation failed.*"foo".*/);
+ });
+
  it('should throw an error - not a string', async () => {
  target = new ParseUUIDPipe({ exceptionFactory });
  await expect(