210817 개발기록: nestjs dto (feat. whitelist:true)

📗  whitelist:true 일 때 DTO의 어노테이션이 미치는 영향

이런 DTO에 맞게 데이터가 들어오는지 테스트를 해봤는데, 값이 제대로 들어오지 않았다.

export class CreateStudyDto{

    title: string;

    subtitle: string;

    purpose: string;

    dateTime: string;

    curriculum: string;

    noti: string;

    apply: string;
    
}

이유는 @IsString() 어노테이션을 붙여주지 않았기 때문이다. 이유는 main.ts 에서 validator, 그중에서도 whitelist : true 를 사용했기 때문이다.

 app.useGlobalPipes(new ValidationPipe({
    whitelist: true,
    transform: true
  }))

whitelist 는 entity 에 존재하지 않는 프로퍼티 값을 제외하고,

transform 은 controller 에서 정의한 타입으로 형변환 시킨다.

 

공식 문서에 의하면, whitelist 를 true 로 설정하면, validation class 에서 decorator 가 없는 프로퍼티를 non-whitelisted 로 간주하여 자동 삭제시킨다. 이 때문에 @IsString() 어노테이션을 붙여주지 않은 위의 DTO 는 제대로 기능을 발휘하지 못한다.

When set to true, this will automatically remove non-whitelisted properties (those without any decorator in the validation class). - docs.nestjs.com

 

아래처럼 적절한 어노테이션을 붙여주면, whitelist 에 포함된 프로퍼티로 간주되어 정상적으로 데이터를 등록할 수 있다.

export class CreateStudyDto{
    @IsString()
    title: string;

    @IsOptional()
    @IsString()
    subtitle: string;

    @IsOptional()
    @IsString()
    purpose: string;

    @IsOptional()
    @IsString()
    dateTime: string;

    @IsOptional()
    @IsString()
    curriculum: string;

    @IsOptional()
    @IsString()
    noti: string;

    @IsOptional()
    @IsString()
    apply: string;
}