class-validator: feat: @IsOptional should works only for undefined values

This code:

import { IsNotEmpty, IsOptional, IsString, validate } from 'class-validator';
import { plainToClass } from 'class-transformer';

const PATCH = 'patch';
const POST = 'post';

export class Test {
  @IsOptional({ groups: [PATCH] })
  @IsNotEmpty({ always: true })
  @IsString()
  name: string;
}

async function getValidationErrors(obj, group) {
  return await validate(plainToClass(Test, obj), { groups: [group] });
}

describe('Test', () => {
  it('should fail on post without name', async () => {
    const errors = await getValidationErrors({}, POST);
    expect(errors).not.toEqual([]);
  });
  it('should fail on post when name is undefined', async () => {
    const errors = await getValidationErrors({ name: undefined }, POST);
    expect(errors).not.toEqual([]);
  });
  it('should fail on post when name is null', async () => {
    const errors = await getValidationErrors({ name: null }, POST);
    expect(errors).not.toEqual([]);
  });
  it('should fail on post when name is empty', async () => {
    const errors = await getValidationErrors({ name: '' }, POST);
    expect(errors).not.toEqual([]);
  });
  it('should succeed on patch without name property', async () => {
    const errors = await getValidationErrors({}, PATCH);
    expect(errors).toEqual([]);
  });
  it('should fail on patch when name is undefined', async () => {
    const errors = await getValidationErrors({ name: undefined }, PATCH);
    expect(errors).not.toEqual([]);
  });
  it('should fail on patch when name is null', async () => {
    const errors = await getValidationErrors({ name: null }, PATCH);
    expect(errors).not.toEqual([]);
  });
  it('should fail on patch when name is empty', async () => {
    const errors = await getValidationErrors({ name: '' }, PATCH);
    expect(errors).not.toEqual([]);
  });
});

gives the following results: Screen Shot 2019-12-19 at 18 15 43 Am I missing something here?

Looking at the code of @IsOptional I see that it checks that the property is not undefined or null, that’s why the test for empty string is not failing, but in theory shouldn’t it check that this property exists on the object?

About this issue

  • Original URL
  • State: open
  • Created 7 years ago
  • Reactions: 34
  • Comments: 24 (7 by maintainers)

Most upvoted comments

@vlapo How about something like an extra config option? The implementation I’ve got in my fork doesn’t break backwards compatibility (as the option defaults to true, which is the default behaviour):

@isOptional({ nullable: false }) // object.hasOwnProperty(property);
@isOptional({ nullable: true }) // value !== undefined && value !== null
@isOptional() // value !== undefined && value !== null

The commit on the fork that adds this behaviour: https://github.com/se-internal/class-validator/commit/5ac9fa0c17ad43ecb0e8642675447b380a54139e

/**
 * Skips validation if the target is null
 *
 * @example
 * ```typescript
 * class TestModel {
 *     @IsNullable({ always: true })
 *     big: string | null;
 * }
 * ```
 */
export function IsNullable(options?: ValidationOptions): PropertyDecorator {
    return function IsNullableDecorator(prototype: object, propertyKey: string | symbol): void {
        ValidateIf((obj): boolean => null !== obj[propertyKey], options)(prototype, propertyKey);
    };
}
/**
 * Skips validation if the target is undefined
 *
 * @example
 * ```typescript
 * class TestModel {
 *     @IsUndefinable({ always: true })
 *     big?: string;
 * }
 * ```
 */
export function IsUndefinable(options?: ValidationOptions): PropertyDecorator {
    return function IsUndefinableDecorator(prototype: object, propertyKey: string | symbol): void {
        ValidateIf((obj): boolean => undefined !== obj[propertyKey], options)(prototype, propertyKey);
    };
}

I use nestjs to validate a DTO from my controller


I have this

class MyDTO {
  @IsOptional()
  @IsNotEmpty()
  locale?: string
}

I send this body json

{
  "locale": null
}

The expected behaviour:

  • ERROR 400, locale should not be empty

The actual behaviour:

  • CODE 200, locale null is ignored.

If I have this DTO

class MyDTO {
  @IsNotEmpty()
  locale?: string
}

Then null value throws CODE 400 which is expected.


@IsOptional() should ignores only when the key is not passed in the request (aka. undefined) or an option to not ignores null value.

We would love this as well, ether with a nullable flag, or as a separate set of decorators (although naming them can be difficult). @sam3d, your fork looks good to me, would you mind creating a PR?

I understand now. But as it is a breaking change I want to have more feedback from community.

any update on this one? And what about PartialType which is making all props optional? Can we somehow pass this nullable param to PartialType as well? 🤔

Any update for this? really want to see this feature in next release @sam3d

I don’t understand why they haven’t had any updates on this issue for 5 years now.

But @IsOptional() accept null value is weird behavior and make me crazy when using NestJs PartialType.

How about keeping @IsOptional as-is and adding new decorators @IsNullable and @IsUndefinable. Any support for this?

I solved this myself and posted on StackOverflow , I am happy to make a PR amending IsOptional or adding this to the library.

import { IsOptional, ValidateIf, ValidationOptions } from 'class-validator'

export function IsOptionalNonNullable(data?: {
  nullable: boolean
  validationOptions?: ValidationOptions
}) {
  const { nullable = false, validationOptions = undefined } = data || {}

  if (nullable) {
    // IsOptional allows null
    return IsOptional(validationOptions)
  }

  return ValidateIf((ob: any, v: any) => {
    return v !== undefined
  }, validationOptions)
}

// Example usage 
export class SomeUpdateDTO {
  @IsInt()
  // Param can be undefined, but not null 
  @IsOptionalNonNullable()
  nbOfViews?: number
}

// Example of why IsOptional is a problem
export class SomeOtherUpdateDTO {
  @IsInt()
  @IsOptional()
  // Null is not specified, but IsOptional will allow it! 
  // Could end up nulling a required field in the db
  nbOfViews?: number
}

@renatocron,

unfortunately not, I consider that out of scope for that library.

In case anyone is interested, I’ve had the exact same issue and implemented this (alongside quite a few more decorators) in class-validator-extended, specifically Optional() and Nullable().

For other parts of TypeScript, “optional” means either the property is not set, or it is set to undefined. In no other places does “optional” imply “nullable”, whereas “nullable” itself can sometimes imply “optional” (c.f. NonNullable utility type). The naming of IsOptional is really confusing.

I suggest the following changes to align with the terminology of TypeScript:

  1. @IsOptional() taking a new strict parameter, defaulting to false which allows null for back-compat, and true for denying null. The strict parameter should default to true at some later version and possibly throw if it is set to false.
  2. @IsNullable with a strict parameter defaulting to true which only allows null, and false for also allowing undefined.