refactor: CallAdapter 적용 및 검증 테스트 작성 #558

[hxeyexn]

⭐️ Issue Number

• refactor: CallAdapter 적용 #558

🚩 Summary

CallAdapter 적용

CallAdapter 적용을 위해 Call, CallAdapter, CallAdapterFactory 객체를 구현했습니다.

CallAdapter 테스트 작성

MockWebServer를 활용해 CallAdapter가 정상 동작하는 지 검증했습니다.

ApiResult 처리 확장 함수 구현 및 Repository에 적용

Repository의 네트워크 응답 중복 로직을 최소화했습니다.

🛠️ Technical Concerns

CallAdapter

CallAdapter는 Retrofit2에서 지원하는 기능입니다. Retrofit은 HTTP 요청 및 응답을 처리하기 위해 기본적으로 Call 타입을 사용합니다.
CallAdapter는 이 기본 타입(Call)을 다른 타입으로 변환할 수 있도록 도와주는 역할을 합니다.

아래 4가지 클래스는 CallAdapter 구현을 위한 클래스입니다.

• ApiResult(전 ResponseResult)
  • 사용자 정의 응답 결과 sealed interfece(Success, ServerError, Exception)
• ApiResultCall
  • 웹 서버에 요청을 보내고 응답을 반환하는 객체
  • Api 요청 결과를 ApiResult 객체로 반환할 수 있도록 구현한 Custom Call
• ApiResultCallAdapter
  • CallAdapter<R, T>는 Call<R>을 T로 반환해주는 interface
  • CallAdapter 인스턴스는 Retrofit 인스턴스 안에 설치된 factory에 의해 생성
• ApiResultCallAdapterFactory
  • CallAdapter의 인스턴스를 생성하는 역할

ApiResult 처리 확장 함수 구현 및 Repository에 적용

• Respository의 대부분의 메서드에 ApiResult 처리를 위한 보일러 플레이트 코드가 불편하게 느껴졌습니다.
• 따라서 ApiResult 처리 확장 함수를 구현해 보일러 플레이트 코드를 감소시켰습니다.

inline fun <T : Any, R : Any> ApiResult<T>.handle(convert: (T) -> R): ApiResult<R> {
    return when (this) {
        is Exception -> Exception(e)
        is ServerError -> ServerError(status, message)
        is Success -> Success(convert(data))
    }
}

테스트

• JUnit5, AssertJ, MockWebServer, kotlinx coroutines test를 활용했습니다.
• 서버의 응답을 CallAdapter가 올바르게 처리하는지만 확인하면 되기 때문에 실제 서버에 요청을 보낼 필요는 없다고 판단했습니다.
• MockWebServer를 이용해 응답을 가상으로 설정한 후에 ApiService 메서드의 반환값이 응답 결과에 따라 올바르게 반환 되는지 검증했습니다.
• 테스트는 HTTP status code 시나리오별로 작성했습니다.

⭐️⭐️ CallAdapter와 관련된 자세한 내용은 PR에 작성하기 양이 너무 많아서 Wiki [AN] CallAdapter 적용 및 테스트에 정리해뒀습니다.
아직 초안이라 부족한 부분이 많습니다. 틈틈히 퇴고하겠습니다..!

🙂 To Reviewer

• ApiService의 모든 메서드들의 반환값이 ApiResult가 맞는 지 확인 부탁드리겠습니다.
• CallAdapter를 처음 접한다면 원리를 이해하는 데 시간이 조금 걸릴 수도 있을 것 같습니다. 🥹
  이해가 되지 않는 부분이 있으시다면 언제든 질문 주세요!
• CI가 터지는 데 리뷰 주시는 동안 해결해보겠습니다..! ➡️ 해결완료!

📋 To Do

• CI에서 발생하는 문제 해결

[linirini]

안드의 꼼꼼함에 놀라고,,,,배워갑니다.....👍👍👍👍

[Junyoung-WON]

ExceptionState를 만들고, handler 메서드가 ExceptionState를 반환해주도록 구현했네요!
data 레이어에서 사용자에게 보여줄 에러 메시지를 결정하는 로직을 잘 제거한 것 같습니다!! 완전 짱짱!! 😁