Moya 및 Combine을 사용한 Network 리펙토링 #163

minsangKang · 2024-08-11T14:31:24Z

리뷰 요청

🙋 꼭 리뷰를 받고 싶어요!
리뷰 긴급도: D-28 (10/13)

개요

참고 : 너무 변경사항이 많아서... 추후 PR 내용에 반영 후 다시 공유드리겠습니다..! 🥲

변경사항

작업 요약

Combine 스트림 기반의 Network 흐름으로 개선되었습니다.
Moya 라이브러리를 사용한 Network 흐름으로 개선되었습니다.
TTProvider 를 통해 Error 디코딩 작업을 한 곳에서 관리하게 되었습니다.
필요한 API 요청마다 UseCase, Request, Response, Info, Repository, API 등이 생성되었습니다.

특이 사항

앞으로 새로 생성되는 API의 경우 에러 발생시 TTErrorResponse 로 디코딩되어 NetworkError 로 전달됩니다.
그 외의 경우 statusCode 를 토대로 NetworkError 로 전달됩니다.
ViewModel 단 까지 NetworkError 가 전달되어 에러 상황에 따른 비즈니스 로직을 구현할 수 있습니다.

Network Layer 흐름도

새로운 Moya API 및 TTProvider 를 사용한 Network Layer 흐름도 입니다.
ViewModel -> UseCase -> Repository -> MoyaAPI -> TTProvider 순으로 요청됩니다.
- PostBody 생성을 위한 Request 구조체를 Repository로 전달합니다.
ViewModel <- UseCase <- Repository <- MoyaAPI <- TTProvider 순으로 전달됩니다.
- TTProvider 내에서 요청에 실패한 경우 NetworkError를 반환하는 작업이 수행됩니다.
  - 신규 API의 경우 공통 형태인 TTErrorResponse 로 디코딩하여 NetworkError 로 전달됩니다.
  - 신규 API가 아닌 경우 statusCode 에 따른 NetworkError 로 전달됩니다.
- Repository 내에서 Response 로 Decode 를 거쳐 Info 구조체가 되어 UseCase로 전달됩니다.
최종적으로, AnyPublisher<Info, NetworkError> 형태로 ViewModel 까지 전달됩니다.

추가 및 변경된 API 요청 UseCase

각 API 에 따라 UseCase, Request, Response, Info, Repository, API 등이 생성되었습니다.

GetAppVersionUseCase 생성 & 반영
GetServerURLUseCasee 생성 & 반영
GetTiTiFunctionsUseCase 생성 & 반영
GetUpdateHistorysUseCase 생성 & 반영
GetYoutubeLinkUseCase 생성 & 반영
GetSurveysUseCase 생성 & 반영
GetNotificationUseCase 생성 & 반영
SignupUseCase 생성 & 반영
SigninUseCase 생성 & 반영
CheckUsernameExitUseCsae 생성 & 반영
CheckEmailExitUseCase 생성 & 반영
UpdatePasswordUseCase 생성 & 반영
GetDailysUseCase 생성 & 반영
PostDailysUseCase 생성 & 반영
PostRecordTimeUseCase 생성 & 반영
GetRecordTimeUseCase 생성 & 반영
GetSyncLogUseCase 생성 & 반영

예시 코드

GetDailysUseCase (SyncDailysVM)

DI

// TODO: DI 수정
let api = TTProvider<DailysAPI>(session: Session(interceptor: NetworkInterceptor.shared))
let repository = DailysRepository(api: api)
let getDailysUseCase = GetDailysUseCase(repository: repository)

execute

self.getDailysUseCase.execute()
    .sink { [weak self] completion in
        if case .failure(let networkError) = completion {
            print("ERROR", #function, networkError)
            self?.loading = false
            switch networkError {
            case .CLIENTERROR(let message):
                if let message = message {
                    print("[get Dailys ERROR] \(message)")
                }
                self?.alert = (title: Localized.string(.Server_Error_DownloadError), text: Localized.string(.Server_Error_DecodeError))
            default:
                self?.alert = networkError.alertMessage
            }
        }
    } receiveValue: { [weak self] dailys in
        self?.saveDailys(dailys)
        self?.loading = false
        self?.checkRecordTimes()
    }
    .store(in: &self.cancellables)

리뷰 받고 싶은 내용

sladuf · 2024-10-13T08:24:11Z

Project_Timer/AppDelegate.swift

+        getAppVersionUseCase.execute()
+            .sink { completion in
+                if case .failure(let networkError) = completion {
+                    print("ERROR", #function, networkError)
+                }


(질문) 버전 불러오지 못했을 때 앱에 접근 가능하도록 하는것 같은데,
강제 업뎃이 필요한 상황과 맞지 않는것 같아서 이유가 궁금하네요!

24.10.28 (iOS 회의 결과)

print문 외에 사용자에게 노출되는 팝업 추가하기 (ex. 버전 불러오기에 실패 했다)

sladuf · 2024-10-13T08:29:29Z

Project_Timer/Data/API/API.swift

+    static func parameters(from encodable: Encodable) -> [String: Any] {
+        let encoder = JSONEncoder()
+        guard let data = try? encoder.encode(encodable),
+              let dictionary = try? JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [String: Any] else {
+            return [:]
+        }
+
+        return dictionary
+    }
+}


(의견)
요 함수는 TargetType 내부에서 Self.로 접근하는것 같은데, static이 아닌 private func으로 구현해도 될 것 같네요?

24.10.28 (iOS 회의 결과)

static 제거

sladuf · 2024-10-13T08:33:11Z

Project_Timer/Data/API/AuthAPI.swift

+        case .postSignup:
+            return "/auth/signup"
+        case .postSignin:
+            return "/auth/login"
+        case .getCheckUsername, .getCheckEmail:
+            return "/auth/users"
+        case .postUpdatePassword:
+            return "/auth/users/password"


(의견)
AuthAPI로 첫 path명과 동일하게 API 라우터 만들어 주신건 너무 좋은것 같습니다!
개인적인 추가 의견으로 API case와 path를 통일하면 좋겠다는 의견입니다,
API가 많아지다 보면 호출하는곳(사용하는곳)이 아닌 해당 파일의 path까지 와서 확인해야만 어떤 api인지 알 수 있어 이슈 디버깅하는 속도가 느려질것 같아요

회의때 의견 나누면 좋을것 같아서 코멘트 남깁니당

24.10.28 (iOS 회의 결과)

API path에 대한 컨벤션(?)을 백엔드와 논의해보자

우리가 path를 따라서 네이밍을 하고 있다는것 정도만 언급하기

sladuf · 2024-10-13T08:35:52Z

Project_Timer/Data/NetworkError.swift

@@ -17,19 +19,9 @@ enum NetworkError: Error {
    case NOTFOUND(String?) // 404
    case CONFLICT(String?) // 409
    case SERVERERROR(String?) // 500
+    case ERRORRESPONSE(TTErrorResponse) // TiTi ErrorResponse


(질문)
API case를 uppercase로 작성하신 이유가 있을까요?
swift의 네이밍 컨벤션과 맞지 않는것 같아서 질문 드립니당

개인적으론 ERRORRESPONSE의 경우 uppercase가 직관적이지 않은것 같아요,,
(의견) -> errorResponse

sladuf

전체적으로 훑어 봤습니다! 궁금증과 의견 남깁니다
// TODO: DI 수정
요거는 라이브러리 반영 예정이라는건지, DI 방식 변경을 의미하는건지 ?

추가로 위 DI를 VC에서 직접 하고 그러는것 같은데,, 그래서 TODO를 써두신것 같다는 생각이 드네용
불필요ㅏㄴ dependency가 너무 강해지는 것 같아서 어디다 빼서 작성하는 로직을 한 번 같이 고민해보시죵!

sladuf · 2024-10-13T12:55:35Z

Project_Timer/Data/Repository/AuthRepository.swift

+final class AuthRepository {
+    private let api: TTProvider<AuthAPI>

-    func signup(signupInfo: TestUserSignupInfo, completion: @escaping (Result<AuthInfo, NetworkError>) -> Void) {
-        api.signup(signupInfo: signupInfo) { result in
-            switch result.status {
-            case .SUCCESS:
-                guard let data = result.data,
-                      let dto = try? JSONDecoder().decode(AuthDTO.self, from: data) else {
-                    completion(.failure(.DECODEERROR))
-                    return
-                }
-
-                let info = dto.toDomain()
-                completion(.success(info))
-
-            default:
-                completion(.failure(.error(result)))
-            }
-        }
+    init(api: TTProvider<AuthAPI>) {


(의견)
모든 Repository에 api를 주입 해주는것 같아요,
근데 api가 추상화가 아니라 구현체라 굳이 주입을 받아야 하는지 의문이 들어요
추상화 또는 내부에서 생성하는 방향을 잡으면 좋을듯 합니당

sladuf · 2024-10-13T12:57:40Z

Project_Timer/Data/TTProvider.swift

+                    print("\nTTProvider success", token, "\(token.baseURL)\(token.path)")
+//                    print("-->", String(data: response.data, encoding: .utf8), "\n")
+                    if (200...299).contains(response.statusCode) {


요 주석은 특별히 남겨 주신 이유가 없다면 제거 부탁드립니다〰️

sladuf · 2024-10-13T12:57:47Z

Project_Timer/Data/TTProvider.swift

+                    print("\nTTProvider failure", token, "\(token.baseURL)\(token.path)")
+//                    print("-->", error.localizedDescription, "\n")


요 주석은 특별히 남겨 주신 이유가 없다면 제거 부탁드립니다〰️

sladuf · 2024-10-13T13:01:25Z

Project_Timer/Domain/UseCase/Auth/CheckEmailExitUseCase.swift

+    private let repository: AuthRepository // TODO: 프로토콜로 수정
+


(질문)
요거 Repository 전체적으로 TODO 상태인것 같은데 아직 반영 안되는 이유가 있을까여?

minsangKang added 30 commits April 30, 2024 15:59

feat #144: FirebaseAPI 생성

2675fd8

feat #144: AuthAPI 생성

6072374

feat #144: DailysAPI 생성

234bec5

update #144: AuthAPI: task 수정

0d80edf

feat #144: getAppVersion RxMoya 방식 구현

f554462

feat #144: getServerURL RxMoya 방식 구현

8c90a07

feat #144: postSignup RxMoya 방식 구현

1bdfc68

feat #144: CombineMoya 방식으로 수정 & AuthRepository 구현

c6aa580

feat #144: 200대 statusCode가 아닌 경우 ErrorResponse 값 반환 구현

f80e638

rename #144: Info -> Request 명칭 수정

3435112

feat #144: DailysRepository 구현

51f480a

feat #144: RecordTimesRepository 구현

4dfe1af

feat #144: SyncLogRepository 구현

516c02d

feat #144: NotificationRepository 구현

115b640

feat #144: NetworkController 내 func들 FirebaseAPI 내 반영

82539ac

refact #144: DTO 폴더 삭제, Response 및 info로 분리

dccb6d2

chore #144: 디렉토리 리펙토링

c8bb161

chore #144: 기존 UseCase들 lagacy 폴더로 이동

138d552

feat #144: NetworkController 내 함수들 FirebaseRepository 내 반영

1a7e0db

feat #144: FirebaseUseCase 생성

60b8304

feat #144: Firebase 관련 UseCase 생성

c367b9c

feat #144: GetAppVersionUseCase 반영

e83bd72

delete #144: 불필요파일 제거

ec27002

feat #144: GetServerURLUseCase 반영

a1531f5

delete #144: 불필요파일 제거

b77f417

Merge branch 'master' into feature/network_tony

5437678

feat #144: GetTiTiFunctionsUseCase 반영

ebb5afa

fix #144: TTProvider의 request를 사용하도록 수정, map operator 생성

9c517cb

feat #144: GetUpdateHistorysUseCase 반영

89c5ef3

feat #144: GetSurveysUseCase 반영

fd8ef4d

minsangKang added 11 commits July 6, 2024 14:29

feat #144: AuthRepository 관련 UseCase들 생성

e550310

feat #144: SignupUseCase, SigninUseCase 반영

9238ebc

feat #144: CheckUsernameExitUseCase 반영

0a65a67

feat #144: GetDailysUseCase 셍성 & 반영

d4e899f

feat #144: 나머지 UseCase들 생성

2c2ca7a

fix #144: statusCode에 따른 NetworkError가 그대로 전달되도록 수정

3091d08

feat #144: UploadDailys 동작 구현, header 를 통해 gmt 전달 구현

9e8cd74

feat #144: GetNotificationUseCase 반영

4d76aa8

feat #144: CheckEmailExitUseCase, UpdatePasswordUseCase 반영

c98a398

feat #144: Post & GetRecordTimeUseCase, GetSyncLogUseCase 반영

c0d0892

feat #144: Network 클래스 제거, 리펙토링 완료

7a357a2

minsangKang added refactor 코드 리펙토링 feature 기능 추가/변경/삭제 priority: medium 우선순위 보통 작업 labels Aug 11, 2024

minsangKang requested a review from sladuf August 11, 2024 14:31

minsangKang self-assigned this Aug 11, 2024

minsangKang linked an issue Aug 11, 2024 that may be closed by this pull request

Data / Network 리펙토링 #144

Open

42 tasks

Merge branch 'master' into feature/network_tony

072325a

sladuf reviewed Oct 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Moya 및 Combine을 사용한 Network 리펙토링 #163

Moya 및 Combine을 사용한 Network 리펙토링 #163

minsangKang commented Aug 11, 2024 •

edited

Loading

sladuf Oct 13, 2024

sladuf Oct 28, 2024

sladuf Oct 13, 2024

sladuf Oct 28, 2024

sladuf Oct 13, 2024 •

edited

Loading

sladuf Oct 28, 2024 •

edited

Loading

sladuf Oct 13, 2024 •

edited

Loading

sladuf left a comment

sladuf Oct 13, 2024

sladuf Oct 13, 2024

sladuf Oct 13, 2024

sladuf Oct 13, 2024

		print("\nTTProvider failure", token, "\(token.baseURL)\(token.path)")
		// print("-->", error.localizedDescription, "\n")

		private let repository: AuthRepository // TODO: 프로토콜로 수정

Moya 및 Combine을 사용한 Network 리펙토링 #163

Are you sure you want to change the base?

Moya 및 Combine을 사용한 Network 리펙토링 #163

Conversation

minsangKang commented Aug 11, 2024 • edited Loading

리뷰 요청

개요

변경사항

작업 요약

특이 사항

Network Layer 흐름도

추가 및 변경된 API 요청 UseCase

예시 코드

리뷰 받고 싶은 내용

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sladuf Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

sladuf Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

sladuf Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

sladuf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minsangKang commented Aug 11, 2024 •

edited

Loading

sladuf Oct 13, 2024 •

edited

Loading

sladuf Oct 28, 2024 •

edited

Loading

sladuf Oct 13, 2024 •

edited

Loading