[Refactor] API 호출 오류 핸들링 개선 #391

PeraSite · 2025-10-09T07:15:28Z

Summary

ApiResult sealed class와 retrofit의 CallAdapter를 활용해 오류에 대응하는 새로운 구조로 변경합니다

Describe your changes

Service: BaseResponse 를 ApiResult로 변경
Repository: Flow<BaseResponse를 T?로 변경
- Flow 완전 제거. ViewModel과 UseCase에서 로딩, 오류 상태 대응
- Void 반환을 Success했는지 여부를 의미하는 Boolean으로 변경
- 실패했다면 null을, 성공했다면 T를 반환
ViewModel, UseCase:
- Repository의 반환 값이 T?로 변함에 따라 모든 use-case와 repository 호출 코드 개선

Issue

Resolves 500대 에러 대응 페이지 추가 #295

To reviewers

local.properties 에서 백엔드 서버 도메인을 임의로 변경하고 앱을 켜보면
로그인이 되어있던 경우) 토큰 값이 유효한지 확인하지 못해 로그인 창으로 이동 > 로그인 시도하면 "로그인이 실패했습니다"
로그인이 안되어있던 경우) 로그인 창에서 로그인 시도하면 "로그인이 실패했습니다"
앱이 죽지는 않지만 ApiResult.NetworkError인 경우에는 어떻게 할 것인지 대응이 필요해요!
제 생각에 서버가 아예 죽었을 때 서버 오류 스플래시로 이동하는 걸 구현하는 제일 깔끔한 구조는 역시 health check용 use-case를 만들고, IntroActivity에서 + 정기적으로 실행하는거에요.
이 use-case는 ApiResult를 매핑하지 않고 NetworkError를 그대로 반환해서 Presentation 레이어에서 ErrorActivity로 이동시키기만 하면 될 것 같습니다.

EDIT: 20251010 ServerErrorActivity 추가했습니다!

Repository에서 ApiResult를 완전히 가리고 결과값만 던져주는 구조와, ApiResult의 data만 도메인 객체로 바꾸고 반환해주는 구조 중 무엇이 더 좋을까요? 호출하는 입장에서 '어떤 오류'가 발생했는가를 상세히 알아야할 필요가 있는지에 따라 결정하면 될 것 같습니다.
Presentation 레이어에서 Loading 상태 변경 > API 호출 > 결과의 null 여부에 따라 Error 상태, Success 상태 변경하고 있는 구조로 변경했습니다.
그러나 상당히 반복적인 부분이 많아서 UiState를 모두 사용하게 리팩토링한 후, 자동으로 Loading과 Error 상태를 관리해주는 유틸 함수를 만들어서 쓰면 좋을 것 같아요.

    fun <T> networkRequest(
        uiState: MutableStateFlow<UiState<T>>,
        request: suspend () -> T,
        onSuccess: (T) -> Unit,
        onError: (Throwable) -> Unit = {},
    ) {
        viewModelScope.launch {
            uiState.value = UiState.Loading
            try {
                val result = request()
                uiState.value = UiState.Success(result)
                onSuccess(result)
            } catch (e: Exception) {
                uiState.value = UiState.Error
                onError(e)
            }
        }
    }

Copilot

Pull Request Overview

This PR refactors the API error handling structure by introducing an ApiResult sealed class and Retrofit CallAdapter to replace the existing BaseResponse<T> pattern with Flow. The changes simplify error handling by having repositories return nullable types or Boolean success indicators instead of wrapped Flow responses.

Key changes:

Introduced ApiResult<T> sealed class with CallAdapter pattern for centralized API response handling
Replaced repository Flow patterns with direct nullable/Boolean return types
Updated all ViewModels to handle new repository return patterns directly

Reviewed Changes

Copilot reviewed 53 out of 53 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`app/src/main/res/values/strings.xml`	Removed trailing newline from login_failed string
`app/src/main/java/com/eatssu/android/presentation/*/`	Updated ViewModels to handle new nullable/Boolean repository patterns
`app/src/main/java/com/eatssu/android/domain/usecase/*/`	Modified use cases to return nullable/Boolean types instead of Flow
`app/src/main/java/com/eatssu/android/domain/repository/*/`	Updated repository interfaces to return nullable/Boolean types
`app/src/main/java/com/eatssu/android/data/service/*/`	Modified service interfaces to use `ApiResult<T>`
`app/src/main/java/com/eatssu/android/data/repository/*/`	Implemented new repository patterns using `ApiResult` extensions
`app/src/main/java/com/eatssu/android/di/network/*/`	Added `ApiResult` CallAdapter infrastructure
`app/src/main/java/com/eatssu/android/data/model/ApiResult.kt`	New sealed class for API response handling

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...src/main/java/com/eatssu/android/presentation/cafeteria/review/write/ReviewWriteViewModel.kt

app/src/main/java/com/eatssu/android/presentation/mypage/myreview/MyReviewViewModel.kt

app/src/main/java/com/eatssu/android/data/service/MealService.kt

app/src/main/java/com/eatssu/android/di/network/TokenAuthenticator.kt

PeraSite · 2025-10-10T07:28:10Z

IntroActivity에서 최초 시작될 때, BaseActivity.onResume 때 Health Check 한 뒤
네트워크 오류가 발생했으면 or JSON Response가 {"status": "UP"}가 아니라면 ServerErrorActivity로 이동시키는 기능 추가했습니다!

Copilot

Pull Request Overview

Copilot reviewed 67 out of 67 changed files in this pull request and generated 6 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

app/src/main/java/com/eatssu/android/presentation/mypage/myreview/MyReviewViewModel.kt

...in/java/com/eatssu/android/presentation/cafeteria/review/write/menu/VariableMenuViewModel.kt

app/src/main/java/com/eatssu/android/presentation/login/LoginViewModel.kt

app/src/main/java/com/eatssu/android/presentation/MainViewModel.kt

app/src/main/java/com/eatssu/android/di/network/ApiResultCall.kt

app/src/main/java/com/eatssu/android/data/repository/MealRepositoryImpl.kt

HI-JIN2

동작 관련해서 체크해보아야할게 있어보여서 코멘트 달았습니다!!

app/src/main/java/com/eatssu/android/data/repository/PartnershipRepositoryImpl.kt

HI-JIN2 · 2025-10-20T07:15:39Z

app/src/main/java/com/eatssu/android/presentation/intro/IntroActivity.kt

+                    is UiEvent.NavigateToServerError -> {
+                        val intent =
+                            Intent(this@IntroActivity, ServerErrorActivity::class.java).apply {
+                                putExtra(ServerErrorActivity.EXTRA_TITLE, event.title)
+                                putExtra(ServerErrorActivity.EXTRA_MESSAGE, event.message)
+                            }
+                        startActivity(intent)
+                        finish()
+                    }


지금 도메인을 바꾸지 않은채로 빌드를 해보면, UnknownHostException이 뜨죠.
intro 에서 UiEvent.NavigateToServerError으로 떨궈주지도 않고 baseActivity를 상속하는것도 아니어서
intro -> login 화면으로 갑니다 (intro > error 화면으로 가는게 적합하겟쬬?)

문제점을 해결해주지 못하고 있어요.. 요부분 개선이 필요할 것 같아요

이 부분 캐치 못했네요 감사합니다!
UiEvent.NavigateToServerError 자체가 필요하지 않은 것 같아서 삭제하고, IntroActivity에서 NetworkErrorEventBus를 쓰게끔 수정할게요!

HI-JIN2 · 2025-10-20T07:17:53Z

app/src/main/java/com/eatssu/android/presentation/cafeteria/menu/MenuViewModel.kt

+                async {
+                    when (restaurant.menuType) {
+                        MenuType.FIXED -> {
+                            when (val result = menuService.getFixMenu(restaurant.toString())) {


옴... 제가 말한 클린아키텍쳐 리팩토링은 뷰모델에서 바로 서비스를 호출하는걸 레이어를 나눠서 repository > usecase로 나누어달라는 거였는데..!

이번 PR에서 작업해야할 부분은 아닌것 같아서 넘길게유

클린 코드만 생각하다보니 구조만 갈아엎고 service 호출 분리를 깜빡했네요!
이미 건드려서 커밋이 올라간 이상 어차피 하긴 해야하니 같이 작업해서 올리겠습니다!

…독하도록 수정

Copilot

Pull Request Overview

Copilot reviewed 77 out of 77 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

app/src/main/java/com/eatssu/android/presentation/login/LoginViewModel.kt

app/src/main/java/com/eatssu/android/presentation/intro/IntroViewModel.kt

app/src/main/java/com/eatssu/android/data/model/ApiResult.kt

PeraSite · 2025-10-20T08:33:01Z

MenuViewModel, MenuActivity에 클린 코드 적용해 Repository, UseCase 추가했습니다!
IntroActivity와 BaseActivity 두 곳에서 NetworkErrorEventBus에 구독하게 수정했습니다.
IntroViewModel에서 Health Check 수행하게끔 수정했습니다! 진님께서 말씀해주신 Intro > Login > ServerError 흐름에서 Intro > ServerError로 바로 이동합니다.

kangyuri1114

Repository가 ApiResult를 리턴하는 구조로 모두 변경되면서 viewmodel 단의 runcatching도 웬만하면 필요가 없어졌네요! 이부분도 차차 필요없어진 부분은 걷어내면 좋을 것 같습니다

PeraSite · 2025-10-21T10:04:22Z

Repository가 ApiResult를 리턴하는 구조로 모두 변경되면서 viewmodel 단의 runcatching도 웬만하면 필요가 없어졌네요! 이부분도 차차 필요없어진 부분은 걷어내면 좋을 것 같습니다

저도 후다닥 만들다보니 Repository 호출하는 부분만 바꾸고 그 위아래 주변 코드 자체는 아직 기존 형태인데가 꽤 있더라구요. 말씀해주신대로 추후에 수정하겠습니다!

PeraSite · 2025-10-21T10:21:42Z

유리님께서 말씀해주셔서 runCatching 쪽을 한번 훑어봤는데 throw가 안됨 = onFailure가 절대 호출 안됨 = 오류를 값으로 반환했지만 UI는 오류로 인식 안될 것 같아서 전부 리팩토링 하겠습니다 하하

Copilot

Pull Request Overview

Copilot reviewed 80 out of 80 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-21T10:36:16Z

app/src/main/java/com/eatssu/android/presentation/cafeteria/review/list/ReviewViewModel.kt

+            val menuReviewInfo = getMenuReviewInfoUseCase(menuId)
+            _uiState.update {
+                it.copy(
+                    loading = false,
+                    error = false,
+                    reviewInfo = menuReviewInfo,
+                    isEmpty = menuReviewInfo == null,
+                )
            }


Setting error = false unconditionally is incorrect when menuReviewInfo is null. A null result could indicate an API failure, not just an empty state. The error flag should be set to true when the API call fails, distinguishing between 'no reviews exist' and 'failed to fetch reviews'.

Copilot · 2025-10-21T10:36:17Z

app/src/main/java/com/eatssu/android/presentation/cafeteria/review/list/ReviewViewModel.kt

+            val mealReviewInfo = getMealReviewInfoUseCase(mealId)
+            _uiState.update {
+                it.copy(
+                    loading = false,
+                    error = false,
+                    reviewInfo = mealReviewInfo,
+                    isEmpty = mealReviewInfo == null,
+                )
            }


Setting error = false unconditionally is incorrect when mealReviewInfo is null. A null result could indicate an API failure, not just an empty state. The error flag should be set to true when the API call fails, distinguishing between 'no reviews exist' and 'failed to fetch reviews'.

PeraSite added 11 commits October 9, 2025 15:24

feat: ApiResult 추가

9096ecc

refactor: Repository 시그니처 정리

a68d0bd

feat: RepositoryImpl ApiResult 사용

9e2a51d

feat: Service ApiResult 사용

05159c6

feat: Presentation 레이어 ApiResult 적용

1877369

feat: ApiResult 처리 CallAdapter 추가

a3362fe

fix: getFixMenu만 크래시가 발생하던 문제 수정

c09b185

refactor: ArrayList를 List로 정리

63f4a0e

chore: BaseResponseConverter 삭제

6cc8dec

fix: 런타임 발생 오류 해결

dd60769

chore: 로그인 실패 줄바꿈 삭제

f587b8c

PeraSite self-assigned this Oct 9, 2025

PeraSite requested review from HI-JIN2, Copilot and kangyuri1114 and removed request for HI-JIN2 October 10, 2025 00:08

Copilot AI reviewed Oct 10, 2025

View reviewed changes

PeraSite added 9 commits October 10, 2025 09:52

fix: early return 추가

d140199

refactor: 로그아웃 로직 병합

ab61862

chore: List로 타입 통일화

886200a

feat: NetworkError 대응 Activity 추가

019859d

feat: HealthCheck 모듈 추가

8281771

fix: ApiResult의 함수를 외부 확장 함수로 변경

7701831

feat: NetworkError 발생 시 ServerErrorActivity 이동 추가

d09d4b7

refactor: IntroActivity 함수화

b77cbf5

refactor: HealthCheck use-case가 boolean을 사용하게 수정, autoLogin 로직 리팩토링

2c91d5c

PeraSite requested a review from Copilot October 12, 2025 10:27

Copilot AI reviewed Oct 12, 2025

View reviewed changes

PeraSite added 4 commits October 17, 2025 16:16

refactor: Deprecate된 arguments.getSerializable 개선

d08ea51

chore: 불필요한 out 삭제

bc9208d

chore: 불필요한 context 삭제

60ffc27

fix: Deprecate된 fragmentManager 접근 수정

d12a307

HI-JIN2 reviewed Oct 20, 2025

View reviewed changes

PeraSite added 6 commits October 20, 2025 16:27

docs: 누락된 주석 추가

be68944

refactor: BaseActivity, IntroActivity에서 공통적으로 NetworkErrorEventBus에 구…

1bdf871

…독하도록 수정

Merge branch 'develop' into refactor/error-handling

73c652a

feat: HealthCheck 관련 Service, Repository, UseCase 추가

dd79dde

feat: IntroViewModel에서 최초 실행 시 health check하게끔 수정

4503516

refactor: MenuViewModel 클린 아키텍처 적용

265a86b

PeraSite requested review from HI-JIN2, Copilot and kangyuri1114 October 20, 2025 08:30

Copilot AI reviewed Oct 20, 2025

View reviewed changes

chore: 오타 수정

3c525bd

kangyuri1114 approved these changes Oct 21, 2025

View reviewed changes

PeraSite added 5 commits October 21, 2025 19:30

refactor: MapViewModel runCatching 리팩토링

f206d82

refactor: UserInfoViewModel try-catch 리팩토링

fcb7647

refactor: MyPageViewModel runCatching 리팩토링

2c86c4f

refactor: SignOutViewModel try-catch 리팩토링

7397c53

refactor: MainViewModel runCatching 리팩토링

9ff0cb8

PeraSite requested review from Copilot and kangyuri1114 October 21, 2025 10:35

Copilot AI reviewed Oct 21, 2025

View reviewed changes

PeraSite merged commit 3896444 into develop Oct 23, 2025
1 check passed

PeraSite deleted the refactor/error-handling branch October 23, 2025 08:19

[Refactor] API 호출 오류 핸들링 개선 #391

[Refactor] API 호출 오류 핸들링 개선 #391

Uh oh!

Conversation

PeraSite commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Describe your changes

Issue

To reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PeraSite commented Oct 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HI-JIN2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HI-JIN2 Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PeraSite Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

HI-JIN2 Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

PeraSite Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PeraSite commented Oct 20, 2025

Uh oh!

kangyuri1114 left a comment

Choose a reason for hiding this comment

Uh oh!

PeraSite commented Oct 21, 2025

Uh oh!

PeraSite commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

PeraSite commented Oct 9, 2025 •

edited

Loading

HI-JIN2 Oct 20, 2025 •

edited

Loading

PeraSite commented Oct 21, 2025 •

edited

Loading