javascript - NestJS: How to access both Body and Param in custom validator? - Stack Overflow

admin管理员组

文章数量:1352057

I've a scenario where I need values from both values in the param and body to perform custom validation. For example, I've a route /:photoId/tag that adds a tag to a photo.

However, before it can add a tag to a photo, it has to validate whether there is already an existing tag of the same name with the photo.

I have the following route in my controller:

@Post(':photoId/tag')
@UsePipes(new ValidationPipe())
async addTag(
    @Param() params: AddTagParams,
    @Body() addTagDto: AddTagDto
) {
    // ...
}

Since the :photoId is provided as a param and the tag is provided in the body of the request, they can't access each other in the custom validator and I can't use both pieces of information to do a check against the database:

export class IsPhotoTagExistValidator implements ValidatorConstraintInterface {

    async validate(val: any, args: ValidationArguments) {
        // supposed to check whether a tag of the same name already exists on photo
        // val only has the value of photoId but not the name of the tag from AddTagDto in Body
    }
}   


export class AddTagParams{
   @IsInt()
   @Validate(IsPhotoTagExistValidator)   // this doesn't work because IsPhotoTagExistValidator can't access tag in AddTagDto
   photoId: number
}

export class AddTagDto{
   @IsString()
   tag: string
}

As in the example above, the val in IsPhotoTagExistValidator is only the photoId. But I need both the photoId in Param and tag name in the Body to check whether the particular photoId already has that tag.

How should I access both the Body and Param in the custom validator function? If not, how should I approach this problem?

I've a scenario where I need values from both values in the param and body to perform custom validation. For example, I've a route /:photoId/tag that adds a tag to a photo.

However, before it can add a tag to a photo, it has to validate whether there is already an existing tag of the same name with the photo.

I have the following route in my controller:

@Post(':photoId/tag')
@UsePipes(new ValidationPipe())
async addTag(
    @Param() params: AddTagParams,
    @Body() addTagDto: AddTagDto
) {
    // ...
}

Since the :photoId is provided as a param and the tag is provided in the body of the request, they can't access each other in the custom validator and I can't use both pieces of information to do a check against the database:

export class IsPhotoTagExistValidator implements ValidatorConstraintInterface {

    async validate(val: any, args: ValidationArguments) {
        // supposed to check whether a tag of the same name already exists on photo
        // val only has the value of photoId but not the name of the tag from AddTagDto in Body
    }
}   


export class AddTagParams{
   @IsInt()
   @Validate(IsPhotoTagExistValidator)   // this doesn't work because IsPhotoTagExistValidator can't access tag in AddTagDto
   photoId: number
}

export class AddTagDto{
   @IsString()
   tag: string
}

As in the example above, the val in IsPhotoTagExistValidator is only the photoId. But I need both the photoId in Param and tag name in the Body to check whether the particular photoId already has that tag.

How should I access both the Body and Param in the custom validator function? If not, how should I approach this problem?

• javascript
• node.js
• typescript
• validation
• nestjs

Share Improve this question Follow edited Apr 2, 2019 at 18:24 Carven asked Apr 2, 2019 at 18:19 CarvenCarven 15.7k3030 gold badges124124 silver badges185185 bronze badges 3

• 3 I'd use pipes only for the validation of the form (type, length etc.) of the requests but not for the validation of business requirements (image tags must be unique), especially when the database is involved. In my opinion, this should be part of the corresponding service. (Of course it's unclear where to draw the line.) – Kim Kern Commented Apr 2, 2019 at 21:50
• @KimKern I think you got a point. One of the reason I thought I would use a validator for unique image tags instead of implementing it in the service is because when throwing an exception from the service, the error response is very different from the error response from what the class-validation provides. So I thought if I had the validation done as a validator, I would get similar error details in the error response. – Carven Commented Apr 3, 2019 at 3:22
• I added a solution for graphQL here. I hope I could help you! – Jan Bürling Commented Apr 5, 2023 at 10:26

Add a ment  | 

1 Answer 1

Sorted by: Reset to default 7

The only solution I have found so far was derived from this ment https://github./nestjs/nest/issues/528#issuement-497020970

context.interceptor.ts

import { CallHandler, ExecutionContext, Injectable, NestInterceptor } from '@nestjs/mon'
import { Observable } from 'rxjs'

/**
 * Injects request data into the context, so that the ValidationPipe can use it.
 */
@Injectable()
export class ContextInterceptor implements NestInterceptor {
  intercept(
    context: ExecutionContext,
    next: CallHandler
  ): Observable<any> {
    const request = context.switchToHttp().getRequest();

    request.body.context = {
      params: request.params,
      query: request.query,
      user: request.user,
    };

    return next.handle()
  }
}

main.ts

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalInterceptors(new ContextInterceptor());
  // ...
}

If you use {whitelist: true} in ValidationPipe params you will need to allow context in your Dto objects.

this can be done by extending such Dto:

context-aware.dto.ts

import { Allow } from 'class-validator';

export class ContextAwareDto {
  @Allow()
  context?: {
    params: any,
    query: any,
    user: any,
  }
}

After this, you will be able to access request data when validating body in custom validator via validationArguments.object.context

You can easily adjust the above to access the context when validating params or query, although I find it sufficient to have this only during body validation.

本文标签： javascriptNestJS How to access both Body and Param in custom validatorStack Overflow