[SCRUM-50] ErrorFeature: 네트워크 에러뷰, 서버통신 에러뷰 UI

Plugins/DependencyPlugin/ProjectDescriptionHelpers/Module/Core.swift

@@ -16,4 +16,5 @@ public enum Core: String, Modulable {
   case UserDefaultsClient
   case FeedbackGeneratorClient
   case NetworkTracking
+  case StreamListener
 }

Plugins/DependencyPlugin/ProjectDescriptionHelpers/Module/Feature.swift

@@ -15,4 +15,5 @@ public enum Feature: String, Modulable {
   case MyPageFeature
   case PomodoroFeature
   case CatFeature
+  case ErrorFeature
 }

Projects/Core/APIClient/Interface/Model/NetworkError.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-public enum NetworkError: Error {
+public enum NetworkError: Error, Equatable {
   case requestError(_ description: String)
   case apiError(_ description: String)
   case noResponseError

Projects/Core/StreamListener/Interface/StreamListenerInterface.swift

@@ -0,0 +1,35 @@
+//
+//  StreamListenerInterface.swift
+//  StreamListener
+//
+//  Created by jihyun247 on 11/21/24.
+//
+
+import Foundation
+
+import Dependencies
+import DependenciesMacros
+
+/*
+ TODO:
+ StreamListener를 토스트나 다이얼로그, 에러뷰 등 다양한 상황의 스트림을 만들 수 있도록 둘 것인지, serverState 추적만을 하도록 둘 것인지 정해야함 (네이밍 다시 해야함)
+ ++ NetworkTracking도 그 목적이 StreamListener와 유사함
+ */
+
+@DependencyClient
+public struct StreamListener {
+  public var sendServerState: @Sendable (_ state: ServerState) async -> Void
+  public var updateServerState: @Sendable () -> AsyncStream<ServerState> = { .never }
+}
+
+extension StreamListener: TestDependencyKey {
+  public static let previewValue = Self()
+  public static let testValue = Self()
+}
+
+public enum ServerState {
+  case requestStarted
+  case requestCompleted
+  case errorOccured
+  case networkDisabled
+}

Projects/Core/StreamListener/Project.swift

@@ -0,0 +1,22 @@
+import ProjectDescription
+import ProjectDescriptionHelpers
+
+@_spi(Core)
+@_spi(Shared)
+import DependencyPlugin
+
+let project: Project = .makeTMABasedProject(
+  module: Core.StreamListener,
+  scripts: [],
+  targets: [
+    .sources,
+    .interface,
+    .tests,
+    .testing
+  ],
+  dependencies: [
+    .interface: [
+      .dependency(rootModule: Shared.self)
+    ]
+  ]
+)

Projects/Core/StreamListener/Sources/StreamListener.swift

@@ -0,0 +1,46 @@
+//
+//  StreamListener.swift
+//  StreamListener
+//
+//  Created by jihyun247 on 11/21/24.
+//
+
+import Foundation
+
+import StreamListenerInterface
+
+import Dependencies
+
+extension StreamListener: DependencyKey {
+  public static let liveValue: StreamListener = .live()
+
+  public static func live() -> StreamListener {
+
+    // 네이밍 추천 plz .,
+    actor ContinuationActor {
+      var continuation: AsyncStream<ServerState>.Continuation?
+
+      func set(_ newContinuation: AsyncStream<ServerState>.Continuation) {
+        continuation = newContinuation
+      }
+
+      func yield(_ state: ServerState) {
+        continuation?.yield(state)
+      }
+    }
+
+    let continuationActor = ContinuationActor()
+    let asyncStream = AsyncStream<ServerState> { continuation in
+      Task { await continuationActor.set(continuation) }
+    }
+
+    return StreamListener(
+      sendServerState: { state in
+        await continuationActor.yield(state)
+      },
+      updateServerState: {
+        return asyncStream
+      }
+    )
+  }
+}

Projects/Core/StreamListener/Testing/StreamListenerTesting.swift

@@ -0,0 +1,12 @@
+//
+//  StreamListenerTesting.swift
+//  StreamListener
+//
+//  Created by <#T##Author name#> on 11/21/24.
+//
+
+import Foundation
+
+public struct StreamListenerTesting {
+  public init() {}
+}

Projects/Core/StreamListener/Tests/StreamListenerTests.swift

@@ -0,0 +1,33 @@
+//
+//  StreamListenerTests.swift
+//  StreamListener
+//
+//  Created by <#T##Author name#> on 11/21/24.
+//
+
+import XCTest
+
+final class StreamListenerTests: XCTestCase {
+  override func setUpWithError() throws {
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+  }
+
+  override func tearDownWithError() throws {
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+  }
+
+  func testExample() throws {
+    // This is an example of a functional test case.
+    // Use XCTAssert and related functions to verify your tests produce the correct results.
+    // Any test you write for XCTest can be annotated as throws and async.
+    // Mark your test throws to produce an unexpected failure when your test encounters an uncaught error.
+    // Mark your test async to allow awaiting for asynchronous code to complete. Check the results with assertions afterwards.
+  }
+
+  func testPerformanceExample() throws {
+    // This is an example of a performance test case.
+    self.measure {
+      // Put the code you want to measure the time of here.
+    }
+  }
+}

Projects/Feature/CatFeature/Sources/NamingCat/NamingCatCore.swift

@@ -12,6 +12,7 @@ import CatServiceInterface
 import DesignSystem
 import UserServiceInterface
 import DatabaseClientInterface
+import StreamListenerInterface
 
 import ComposableArchitecture
 import RiveRuntime
@@ -41,6 +42,8 @@ public struct NamingCatCore {
     case setTooltip(DownDirectionTooltip?)
     case saveChangedCat(SomeCat)
     case _setNextAction
+    case _postNamedCatRequest(ChangeCatNameRequest)
+    case _postNamedCatResponse(Result<Void, Error>)
     case binding(BindingAction<State>)
   }
 
@@ -54,6 +57,7 @@ public struct NamingCatCore {
   @Dependency(CatService.self) var catService
   @Dependency(UserService.self) var userService
   @Dependency(DatabaseClient.self) var databaseClient
+  @Dependency(StreamListener.self) var streamListener
   let isOnboardedKey = "mohanyang_userdefaults_isOnboarded"
 
   public init() {}
@@ -81,12 +85,7 @@ public struct NamingCatCore {
       let catName = state.text == "" ? selectedCat.baseInfo.name : state.text
       let request = ChangeCatNameRequest(name: catName)
       return .run { send in
-        try await catService.changeCatName(
-          apiClient: apiClient,
-          request: request
-        )
-        try await self.userService.syncUserInfo(apiClient: self.apiClient, databaseClient: self.databaseClient)
-        await send(._setNextAction)
+        await send(._postNamedCatRequest(request))
       }
 
     case .catSetInput:
@@ -107,7 +106,7 @@ public struct NamingCatCore {
     case ._setNextAction:
       return .run { [state] send in
         if state.route == .onboarding {
-          await userDefaultsClient.setBool(true, key: isOnboardedKey)
+          await self.userDefaultsClient.setBool(true, key: isOnboardedKey)
           await send(.moveToHome)
         } else {
           if let selectedCat = state.selectedCat {
@@ -116,6 +115,24 @@ public struct NamingCatCore {
         }
       }
 
+    case let ._postNamedCatRequest(request):
+      return .run { send in
+        await self.streamListener.sendServerState(state: .requestStarted)
+        await send(._postNamedCatResponse(Result {
+          try await self.catService.changeCatName(apiClient: apiClient, request: request)
+        }))
+      }
+
+    case ._postNamedCatResponse(.success(_)):
+      return .run { send in
+        try await self.userService.syncUserInfo(apiClient: self.apiClient, databaseClient: self.databaseClient)
+        await self.streamListener.sendServerState(state: .requestCompleted)
+        await send(._setNextAction)
+      }
+
+    case let ._postNamedCatResponse(.failure(error)):
+      return self.handleError(error: error)
+
     case .binding(\.text):
       state.inputFieldError = setError(state.text)
       if state.text == "" && state.route == .myPage {
@@ -148,3 +165,24 @@ public struct NamingCatCore {
     return error
   }
 }
+
+extension NamingCatCore {
+  private func handleError(error: any Error) -> EffectOf<NamingCatCore> {
+    if let networkError = error as? URLError,
+       networkError.code == .networkConnectionLost ||
+       networkError.code == .notConnectedToInternet {
+      return .run { send in
+        await streamListener.sendServerState(state: .networkDisabled)
+      }
+    }
+    guard let error = error as? NetworkError else { return .none }
+    switch error {
+    case .apiError(_):
+      return .run { send in
+        await streamListener.sendServerState(state: .errorOccured)
+      }
+    default:
+      return .none
+    }
+  }
+}

Projects/Feature/CatFeature/Sources/SelectCat/SelectCatCore.swift

@@ -11,6 +11,7 @@ import UserServiceInterface
 import CatServiceInterface
 import UserNotificationClientInterface
 import DatabaseClientInterface
+import StreamListenerInterface
 import DesignSystem
 
 import RiveRuntime
@@ -41,6 +42,8 @@ public struct SelectCatCore {
     case _moveToNamingCat
     case _fetchCatListRequest
     case _fetchCatListResponse(Result<[Cat], Error>)
+    case _postSelectedCatRequest(SelectCatRequest)
+    case _postSelectedCatResponse(Result<Void, Error>)
     case binding(BindingAction<State>)
     case namingCat(PresentationAction<NamingCatCore.Action>)
   }
@@ -57,6 +60,7 @@ public struct SelectCatCore {
   @Dependency(CatService.self) var catService
   @Dependency(UserNotificationClient.self) var userNotificationClient
   @Dependency(DatabaseClient.self) var databaseClient
+  @Dependency(StreamListener.self) var streamListener
 
   public var body: some ReducerOf<Self> {
     BindingReducer()
@@ -95,9 +99,7 @@ public struct SelectCatCore {
       guard let selectedCat = state.selectedCat else { return .none }
       let request = SelectCatRequest(catNo: selectedCat.baseInfo.no)
       return .run { send in
-        try await userService.selectCat(apiClient: self.apiClient, request: request)
-        try await userService.syncUserInfo(apiClient: self.apiClient, databaseClient: self.databaseClient)
-        await send(._setNextAction)
+        await send(._postSelectedCatRequest(request))
       }
 
     case .saveChangedCat:
@@ -123,21 +125,38 @@ public struct SelectCatCore {
 
     case ._fetchCatListRequest:
       return .run { send in
-        await send(
-          ._fetchCatListResponse(
-            Result {
-              try await catService.getCatList(apiClient)
-            }
-          )
-        )
+        await streamListener.sendServerState(state: .requestStarted)
+        await send(._fetchCatListResponse(Result {
+          try await catService.getCatList(apiClient)
+        }))
       }
 
     case let ._fetchCatListResponse(.success(response)):
       state.catList = response.map { SomeCat(baseInfo: $0) }
-      return .none
-
-    case ._fetchCatListResponse(.failure):
-      return .none
+      return .run { send in
+        await streamListener.sendServerState(state: .requestCompleted)
+      }
+
+    case let ._fetchCatListResponse(.failure(error)):
+      return handleError(error: error)
+
+    case let ._postSelectedCatRequest(request):
+      return .run { send in
+        await streamListener.sendServerState(state: .requestStarted)
+        await send(._postSelectedCatResponse(Result {
+          try await userService.selectCat(apiClient: self.apiClient, request: request)
+        }))
+      }
+
+    case ._postSelectedCatResponse(.success(_)):
+      return .run { send in
+        try await userService.syncUserInfo(apiClient: self.apiClient, databaseClient: self.databaseClient)
+        await streamListener.sendServerState(state: .requestCompleted)
+        await send(._setNextAction)
+      }
+
+    case let ._postSelectedCatResponse(.failure(error)):
+      return handleError(error: error)
 
     case .binding:
       return .none
@@ -147,3 +166,25 @@ public struct SelectCatCore {
     }
   }
 }
+
+extension SelectCatCore {
+  // TODO: 다른 곳에서도 사용될 코드인데 따로 뺄 방법 ..
+  private func handleError(error: any Error) -> EffectOf<SelectCatCore> {
+    if let networkError = error as? URLError,
+       networkError.code == .networkConnectionLost ||
+       networkError.code == .notConnectedToInternet {
+      return .run { send in
+        await streamListener.sendServerState(state: .networkDisabled)
+      }
+    }
+    guard let error = error as? NetworkError else { return .none }
+    switch error {
+    case .apiError(_):
+      return .run { send in
+        await streamListener.sendServerState(state: .errorOccured)
+      }
+    default:
+      return .none
+    }
+  }
+}

Projects/Feature/ErrorFeature/Example/Resources/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,14 @@
+{
+  "images" : [
+    {
+      "filename" : "ICON_DEMO.png",
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}