NestJs Chapter 2

🔷 Modules

모듈은 @Module() 데코레이터로 주석이 달린 클래스입니다.
@Module() 데코레이터는 Nest가 애플리케이션 구조를 구성하는 데 사용하는 메타데이터를 제공합니다.
https://docs.nestjs.com/modules

Static Module

어떠한 설정도 적용되어 있지 않은 모듈

Dynamic Module

설정이 적용되어 있거나 설정을 적용할 수 있는 모듈

Global modules

즉시 사용할 수 있는 모든 제공자 세트(예: 도우미, 데이터베이스 연결 등)를 제공하려면 @Global() 데코레이터를 사용하여 모듈을 전역적으로 만들 수 있다.

또는 forRoot안에서 global: true를 통해서도 전역 모듈로 만들 수 있다.

return {
	global:true,
	module: JwtModule,
	providers: [JwtService],
	exports: [JwtService],
};

🔷 Standard providers

아래 코드는 providers: [CatsService]의 축약형입니다.

providers: [
{ provide: CatsService, useClass: CatsService },
];

useClass (Class providers)

provider의 타입 (주입되야 할 인스턴스 클래스 이름)
프로바이더로 사용할 클래스

useValue (Value providers)

주입한 provider의 인스턴스

🔷 MiddleWare

MiddleWare 선언

Nestjs에서의 middleware는 기본적으로 express의 middleware와 동일하다.
NestMiddleware를 implements한 후 use 함수를 사용해 class로 구현하거나 함수로 구현할 수 있으며 express에서와 같이, 끝에는 항상 next를 호출 해야한다.

import { NextFunction, Request, Response } from 'express';

export function jwtMiddleware(req: Request, res: Response, next: NextFunction) {
  console.log(req.headers);
  next();
}

MiddleWare 적용

1. 라우터 특정 적용

forRoutes 메서드를 사용해 라우터와 RequestMethod를 특정한다.
exclude 메서드를 사용해 특정 라우터와 RequestMethod를 제외시킬 수 있다.

export class AppModule implements NestModule{
  configure(consumer: MiddlewareConsumer) {
    consumer.apply(jwtMiddleware).forRoutes({
      path: '/graphql',
      method: RequestMethod.POST,
    });
  }
}

2. 전체 적용

main.ts 파일에서 app.use(jwtMiddleware)를 선언하면 앱 전체에 적용시킬 수 있다. 이 것은 middleware를 function으로 선언했을 경우에만 가능하다. class로 선언했을 경우 1번 방법만 사용 가능

🔷 Context

각 request에 대해 request context를 사용할 수 있다. context가 함수로 정의되면 각 request마다 호출되고 req 속성에 request 객체를 받는다.

context: ({ req }) => ({ user: req['user'] }),
  //app.module에 graphQlModule의 인자로 할당

- Resolver에서의 사용방법

@Query((returns) => User)
  me(@Context() context) {
    if (!context.user) {
      return;
    } else {
      return context.user;
    }
  }

🔷 Guard

Authentication을 위해 필요한 클래스이다.
(로그인하지 않은 사람은 post를 보낼 수 없도록!!)
CanActivate를 implements하며 Boolean 형식을 리턴한다.

※ 이 과정에서 rest context와 gql context의 형식이 다르기 때문에 GqlExecutionContext를 사용해 gql context로 변환시켜준다.

❓ resolver에서 바로 @Context로 context 받아서 gql context로 바꾸고 return true, false 선언하는 것과의 차이점?

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(context: ExecutionContext) {
    const gqlContext = GqlExecutionContext.create(context).getContext();
    const user = gqlContext['user'];
    if (!user) {
      return false;
    }
    return true;
  }
}

적용방법

@Query((returns) => User)
  @UseGuards(AuthGuard)
  me() {}

🔷 Custom decorators

선언방법

createParamDecorator를 사용해 변수를 선언한다.

// auth.decorator.ts 파일
export const AuthUser = createParamDecorator(
  (data: unknown, context: ExecutionContext) => {
    const gqlContext = GqlExecutionContext.create(context).getContext();
    const user = gqlContext['user'];
    return user;
  },
);

적용방법

• @Context를 사용한 context.user을 간단하게 해준다.
• @Context를 불러 올 때마다 gqlContext로 변환해주어야하는 번거로움을 덜어준다.

@Query((returns) => User)
  @UseGuards(AuthGuard)
  me(@AuthUser() authUser: User) {
    return authUser;
  }

🔶 QnA

Dynamic module을 정의할 때 providers의 provide가 의미하는 것은?

@Module({})
@Global()
export class JwtModule {
  static forRoot(options: JwtModuleOptions): DynamicModule {
    return {
      module: JwtModule,
      exports: [JwtService],
      providers: [
        {
          provide: CONFIG_OPTIONS,
          useValue: options,
        },
        JwtService,
      ],
    };
  }
}

⛔ Error

- JsonWebTokenError: jwt malformed

verify 할 수 없는 잘못된 token을 줬을 경우 발생하는 에러

실제 프로그램 상에서는 이미 프로그램에서 가지고 있는 token을 사용해서 verify하기 때문에 발생할 수 없는 에러이다.
/playground에서 test할 때만 발생하는 에러