🧼 clean: 코드 일관성 개선

[Jo-Minseok]

🔨 테스크

Redis Scan 반환을 정수로 바꾸면 안 되나?

• Redis에 어느 정도의 데이터가 저장되어있는 지 애플리케이션 단에서 미리 파악할 수 없다.
• JS의 최대 숫자 범위를 벗어나버리면 서비스 예외가 발생한다.
• JS의 최대 숫자 범위 9007199254740991 만큼 개수 범위가 크지는 않겠지만 시스템 안정성을 위해 문자열로 반환하도록 처리

다음 작업 수행 목록 (PR룰에 따라 분리)

1. Repository 함수 재사용하게 변경
2. Swagger 처리 부분 변경
   • Swagger Request Example api-docs.ts -> DTO로 변경
     • 작업 사유: 현재 새로운 API 생성시 api-docs.ts에 수동으로 API Request DTO의 속성들을 등록하는 몇몇 부분들이 있음. Request DTO를 생성할 때, ApiProperty를 사용해서 자동으로 연동되도록 하는 게 편할듯 함
   • Swagger Response Example DTO로 변경 하능 하다면 변경
     • 작업 사유: 위와 동일

작업 사유

• 코드는 여러 명이 적었다 한들 하나의 프로젝트 내부라면 코드 형식이 모두 동일해야 한다고 판단했다.
• 추상적으로 작성되어 있는 코드들이 많아 다시 코드를 읽을 때 이해 안 되는 부분이 상당히 많았다.
• 눈에 거슬리는 코드도 너무 많았기에 작업을 수행했다.
• 정규 프로젝트 기간에는 마감 일자로 인해 촉박해져 막 작업한 부분이 꽤 많았다.

📋 작업 내용

• 파라미터 DTO 적용 하여 값 검증하게 변경

  • 특정 코드는 파라미터를 직접 추출하는 방식이라 값 검증이 안 되는 문제가 있었음. 코드 통일성을 위해 DTO 추가

  @Params('feedId') params: Params

  변경

  @Params('feedId') params: FeedPaginationRequestDto

• Validation 코드 정리, 제거

  • 필요없는 Validation 발견하여 정리함, 라인도 정리

• Controller 별도 data 변수 없애서 코드 통일

  • 몇몇 Controller 코드에서 일관성이 맞지 않음을 확인

  const data = 서비스 함수();
  return ApiResponse.responseWithData('메세지',data);

  변경

  return ApiResponse.responseWithData('메세지',서비스 함수());

• 파라미터 별도 변수 제거

  const { id } = params
  서비스 함수(id);

  불필요하게 id 변수를 생성하는 구문 제거

  서비스 함수(params.id);

• Request Example 더미 데이터로 변경
  더미 데이터(ex. test)가 아닌 임시 데이터(ex. seok3765)가 들어가 있는 부분 변경

• 변수 이름 result, item, data 처럼 추상적인 부분 구체화
  map, filter 같이 고차 함수에서 result, item, data와 같이 추상적인 변수명으로 가독성이 불편했던 부분 구체화를 통해 개선

• Validation Pipe Global로 변경
  추후 컨트롤러에 함수를 추가할 때마다 UsePipe로 Validation을 수행하도록 적어야 한다.
  코드 중복이 발생한다고 생각했고, 번거로움이 느껴졌다. 간결하게 표현이 가능할 것 같았다.
  어짜피 모든 Request를 DTO로 사용하자고 얘기가 나왔기 때문에 Global Pipe로 처리해도 문제없을 것 같다고 생각했다.

[CodeVac513]

LGTM!

특히 DTO에 스웨거가 연동되도록 해서 문서가 2번 수정되는 걸 예방하는 게 인상적이었습니다.
전체적으로 무심코 지나갔던 부분도 캐치해서 잘 작업해주신 것 같아요.

수고 많으셨습니다!

[asn6878]

item, data 이런거 대부분 제가 썼을텐데 반성해야겠군요 ㅠㅠㅠ

고생 많으셨습니다! 👍