NestJS Interceptor

Interceptor

interceptor란 client와 sever에서 통신할 떄 중간에 가로채셔 공통된 어떤 로직을 수행할 때 주로 사용한다.

interceptor 사용예시

• bind extra logic before / after method execution
• transform the result returned from a function
• transform the exception thrown from a function
• extend the basic function behavior
• completely override a function depending on specific conditions (e.g., for caching purposes)

Execution Context

1. middleware - HTTP 요청이 들어오면 가장 먼저 처리된다. Express에서 사용하는 미들웨어처럼, 요청을 가로채서 로깅을 하거나, 요청 데이터를 변경하거나, 인증 토큰을 검증하는 데 사용된다.
2. guard - 요청이 해당 경로에 접근할 수 있는지 권한을 검사한다. 인증(authentication)과 인가(authorization) 등의 역할을 주로 처리한다.
3. pipe - 요청 데이터를 변환하거나 검증하는 데 사용된다. 주로 DTO와 함께 사용하여, 요청이 유효한지 체크하거나, 데이터를 원하는 형식으로 변환한다.
4. interceptor - 요청과 응답의 흐름을 가로채서 추가적인 로직을 처리한다. 주로 로깅, 캐싱, 응답 변환 등에 사용되며, 컨트롤러가 요청을 처리한 후 응답을 가로채 변환하거나 가공할 수 있다.
5. exception filter - 컨트롤러에서 발생한 예외를 처리하여 클라이언트에게 에러 응답을 보낸다. 기본적으로 NestJS는 예외 처리 메커니즘을 제공하지만, 커스텀 필터를 통해 특정 에러 형식을 일관되게 처리할 수 있다.

import {
    Injectable,
    NestInterceptor,
    ExecutionContext,
    CallHandler,
} from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import {
    IDeleteResponse,
    IResponseInterceptor,
} from '../types/interceptor.interface';

@Injectable()
export class TransformInterceptor<T>
    implements NestInterceptor<T, IResponseInterceptor<T> | IDeleteResponse>
{
    constructor(private readonly reflector: Reflector) {}

    intercept(
        context: ExecutionContext,
        next: CallHandler<any>,
    ): Observable<IResponseInterceptor<T> | IDeleteResponse> {
        const message = this.reflector.get<string>(
            'response-message',
            context.getHandler(),
        );
        const statusCode = context.switchToHttp().getResponse().statusCode;

        return next.handle().pipe(
            map((data) => {
                if (data && typeof data === 'object' && data._id) {
                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
                    const { _id, ...rest } = data;
                    return { message, statusCode, data: rest };
                }

                return { message, statusCode };
            }),
        );
    }
}