TypeGraphQL 을 잘못 쓰고 있는 걸 깨달았을 때 (aka. @ObjectType 생성자 금지 조항)

배경

한동안 Nest.js 프레임워크를 사용하며 API 응답 클래스를 세팅할 때, 클래스의 생성자 쪽에서 데이터 세팅 작업을 했다

클래스 생김새는 다음과 같다

export class NeighborItemsResponse {
  @Exclude() private readonly _previous: NeighborItemResponse | null;
  @Exclude() private readonly _next: NeighborItemResponse | null;

  constructor(
    previous: NeighborItemResponse | null,
    next: NeighborItemResponse | null,
  ) {
    this._previous = previous;
    this._next = next;
  }
  
  // (생략) 클라이언트에 expose 할 필드들 기술..
}

 

 

 

문제의 시작

그러다 새로 맡게된 프로젝트는 graphql + typegraphql 기반이었는데

nest.js 프로젝트에서 사용했던 클래스 방식에 익숙해져서

여기서도 API 응답 클래스의 생성자 쪽에서 세팅 작업을 해주었다

 

뭐 이래도 될 지 안 될 지에 대한 의심도 없이 말이다

 

코드는 다음과 같다

nest.js 에서 사용하던 방식과 굉장히 비슷한 걸 볼 수 있다

constructor 내에서 필드 세팅해주는 방식 말이다

import { ObjectType, Field } from 'type-graphql';

@ObjectType()
export class NeighborItemsResponse {
  @Field(() => NeighborItemResponse, { nullable: true })
  previous: NeighborItemResponse | null;

  @Field(() => NeighborItemResponse, { nullable: true })
  next: NeighborItemResponse | null;

  constructor(previous: NeighborItemResponse | null, next: NeighborItemResponse | null) {
    this.previous = previous;
    this.next = next;
  }
}

 

 

 

문제 상황

TypeGraphQL 문서를 구경하다 이런 글을 발견했다

 

"Be aware that defining constructors is strictly forbidden and we shouldn't use them there, as TypeGraphQL creates instances of object type classes under the hood by itself." (문서)

 

@ObjectType 같은 타입 어노테이션 선언된 클래스에 대해

TypeGraphQL 라이브러리에서 내부적으로 인스턴스를 생성하고 있으니까 constructor 를 정의하지 말라는 글이었다

 

 

하지 말라는 짓 하고 있었다 ^-^ ...

여태까지 개발 단계에서는 딱히 문제가 드러나진 않았는데

단순히 운이 좋아서 아직 문제가 안 된거겠G..

 

 

해결 방법

TypeGraphQL 에서 제공해주는 example 코드를 보면 

 리졸버 메소드 쪽에서 응답 클래스 세팅하고 리턴해준다. 요 방식으로 고쳐줘야겠다

  @Mutation(_returns => Recipe)
  async addRecipe(@Arg("recipe") recipeInput: RecipeInput): Promise<Recipe> {
    const recipe = Object.assign(new Recipe(), { // 응답 클래스 세팅
      description: recipeInput.description,
      title: recipeInput.title,
      ratings: [],
      creationDate: new Date(),
    });
    await this.items.push(recipe);

    return recipe;
  }