Move notice display logic into hosting controller

Author: rachelmcr

WooCommerce/Classes/ViewRelated/Reviews/ReviewReply.swift

@@ -1,25 +1,70 @@
 import Foundation
 import SwiftUI
+import Combine
 
 /// Hosting controller that wraps a `ReviewDetailsReply` view.
 ///
 final class ReviewReplyHostingController: UIHostingController<ReviewReply>, UIAdaptivePresentationControllerDelegate {
 
     private let viewModel: ReviewReplyViewModel
 
-    init(viewModel: ReviewReplyViewModel) {
+    /// Presents notices in the tab bar context.
+    ///
+    private let systemNoticePresenter: NoticePresenter
+
+    /// Presents notices in the current modal presentation context.
+    ///
+    private lazy var modalNoticePresenter: NoticePresenter = {
+        let presenter = DefaultNoticePresenter()
+        presenter.presentingViewController = self
+        return presenter
+    }()
+
+    /// Emits the intent to present a `ReviewReplyNotice`
+    ///
+    private lazy var presentNoticePublisher = {
+        viewModel.presentNoticeSubject.eraseToAnyPublisher()
+    }()
+
+    /// References to keep the Combine subscriptions alive within the lifecycle of the object.
+    ///
+    private var subscriptions: Set<AnyCancellable> = []
+
+    init(viewModel: ReviewReplyViewModel,
+         noticePresenter: NoticePresenter = ServiceLocator.noticePresenter) {
         self.viewModel = viewModel
+        self.systemNoticePresenter = noticePresenter
         super.init(rootView: ReviewReply(viewModel: viewModel))
 
         // Needed because a `SwiftUI` cannot be dismissed when being presented by a UIHostingController
         rootView.dismiss = { [weak self] in
             self?.dismiss(animated: true, completion: nil)
         }
 
-        // This notice presenter is needed to display an error notice without closing the modal if the network request fails.
-        let errorNoticePresenter = DefaultNoticePresenter()
-        errorNoticePresenter.presentingViewController = self
-        viewModel.modalNoticePresenter = errorNoticePresenter
+        // Observe the present notice intent.
+        presentNoticePublisher
+            .compactMap { $0 }
+            .sink { [weak self] notice in
+                switch notice {
+                case .success:
+                    self?.systemNoticePresenter.enqueue(notice: Notice(title: Localization.success, feedbackType: .success))
+                case .error:
+                    let noticeIdentifier = UUID().uuidString
+                    let notice = Notice(title: Localization.error,
+                                        feedbackType: .error,
+                                        notificationInfo: NoticeNotificationInfo(identifier: noticeIdentifier),
+                                        actionTitle: Localization.retry) { [weak self] in
+                        self?.viewModel.sendReply(onCompletion: { [weak self] success in
+                            if success {
+                                self?.dismiss(animated: true, completion: nil)
+                            }
+                        })
+                    }
+
+                    self?.modalNoticePresenter.enqueue(notice: notice)
+                }
+            }
+            .store(in: &subscriptions)
 
         // Set presentation delegate to track the user dismiss flow event
         presentationController?.delegate = self
@@ -83,9 +128,19 @@ struct ReviewReply: View {
     }
 }
 
+enum ReviewReplyNotice: Equatable {
+    case success
+    case error
+}
+
 // MARK: Constants
 private enum Localization {
     static let title = NSLocalizedString("Reply to Product Review", comment: "Title for the product review reply screen")
     static let send = NSLocalizedString("Send", comment: "Text for the send button in the product review reply screen")
     static let cancel = NSLocalizedString("Cancel", comment: "Text for the cancel button in the product review reply screen")
+
+    // Notice strings
+    static let success = NSLocalizedString("Reply sent!", comment: "Notice text after sending a reply to a product review successfully")
+    static let error = NSLocalizedString("There was an error sending the reply", comment: "Notice text after failing to send a reply to a product review")
+    static let retry = NSLocalizedString("Retry", comment: "Retry Action")
 }

WooCommerce/Classes/ViewRelated/Reviews/ReviewReplyViewModel.swift

@@ -28,22 +28,16 @@ final class ReviewReplyViewModel: ObservableObject {
     ///
     private let stores: StoresManager
 
-    /// Presents a success notice in the tab bar context.
+    /// Trigger to present a `ReviewReplyNotice`
     ///
-    private let noticePresenter: NoticePresenter
-
-    /// Presents an error notice in the current modal presentation context.
-    ///
-    var modalNoticePresenter: NoticePresenter?
+    let presentNoticeSubject = PassthroughSubject<ReviewReplyNotice, Never>()
 
     init(siteID: Int64,
          reviewID: Int64,
-         stores: StoresManager = ServiceLocator.stores,
-         noticePresenter: NoticePresenter = ServiceLocator.noticePresenter) {
+         stores: StoresManager = ServiceLocator.stores) {
         self.siteID = siteID
         self.reviewID = reviewID
         self.stores = stores
-        self.noticePresenter = noticePresenter
         bindNavigationTrailingItemPublisher()
     }
 
@@ -68,10 +62,10 @@ final class ReviewReplyViewModel: ObservableObject {
                     DDLogInfo("Reply to product review succeeded with comment status: \(status)")
                 }
 
-                self.displayReplySuccessNotice()
+                self.presentNoticeSubject.send(.success)
                 onCompletion(true)
             case .failure(let error):
-                self.displayReplyErrorNotice(onCompletion: onCompletion)
+                self.presentNoticeSubject.send(.error)
                 DDLogError("⛔️ Error replying to product review: \(error)")
                 onCompletion(false)
             }
@@ -96,35 +90,6 @@ private extension ReviewReplyViewModel {
             }
             .assign(to: &$navigationTrailingItem)
     }
-
-    /// Enqueues the `Reply sent` success notice.
-    ///
-    func displayReplySuccessNotice() {
-        noticePresenter.enqueue(notice: Notice(title: Localization.success, feedbackType: .success))
-    }
-
-    /// Enqueues the `Error sending reply` notice.
-    ///
-    func displayReplyErrorNotice(onCompletion: @escaping (Bool) -> Void) {
-        let noticeIdentifier = UUID().uuidString
-        let notice = Notice(title: Localization.error,
-                            feedbackType: .error,
-                            notificationInfo: NoticeNotificationInfo(identifier: noticeIdentifier),
-                            actionTitle: Localization.retry) { [weak self] in
-            self?.sendReply(onCompletion: onCompletion)
-        }
-
-        modalNoticePresenter?.enqueue(notice: notice)
-    }
-}
-
-// MARK: Localization
-private extension ReviewReplyViewModel {
-    enum Localization {
-        static let success = NSLocalizedString("Reply sent!", comment: "Notice text after sending a reply to a product review successfully")
-        static let error = NSLocalizedString("There was an error sending the reply", comment: "Notice text after failing to send a reply to a product review")
-        static let retry = NSLocalizedString("Retry", comment: "Retry Action")
-    }
 }
 
 /// Representation of possible navigation bar trailing buttons

WooCommerce/WooCommerceTests/ViewRelated/Reviews/ReviewReplyViewModelTests.swift

@@ -1,4 +1,5 @@
 import XCTest
+import Combine
 @testable import WooCommerce
 @testable import Yosemite
 
@@ -8,6 +9,8 @@ class ReviewReplyViewModelTests: XCTestCase {
 
     private let sampleReviewID: Int64 = 7
 
+    private var subscriptions: [AnyCancellable] = []
+
     func test_send_button_is_disabled_when_reply_content_is_empty() {
         // Given
         let viewModel = ReviewReplyViewModel(siteID: sampleSiteID, reviewID: sampleReviewID)
@@ -128,11 +131,10 @@ class ReviewReplyViewModelTests: XCTestCase {
         XCTAssertFalse(successResponse)
     }
 
-    func test_view_model_enqueues_success_notice_after_reply_is_sent_successfully() {
+    func test_view_model_triggers_success_notice_after_reply_is_sent_successfully() {
         // Given
         let stores = MockStoresManager(sessionManager: .testingInstance)
-        let noticePresenter = MockNoticePresenter()
-        let viewModel = ReviewReplyViewModel(siteID: sampleSiteID, reviewID: sampleReviewID, stores: stores, noticePresenter: noticePresenter)
+        let viewModel = ReviewReplyViewModel(siteID: sampleSiteID, reviewID: sampleReviewID, stores: stores)
         stores.whenReceivingAction(ofType: CommentAction.self) { action in
             switch action {
             case let .replyToComment(_, _, _, onCompletion):
@@ -142,25 +144,23 @@ class ReviewReplyViewModelTests: XCTestCase {
             }
         }
 
+        var noticeTypes: [ReviewReplyNotice] = []
+        viewModel.presentNoticeSubject.sink { notice in
+            noticeTypes.append(notice)
+        }.store(in: &subscriptions)
+
         // When
         viewModel.newReply = "New reply"
-        let noticeType: UINotificationFeedbackGenerator.FeedbackType? = waitFor { promise in
-            viewModel.sendReply { _ in
-                promise(noticePresenter.queuedNotices.first?.feedbackType)
-            }
-        }
+        viewModel.sendReply { _ in }
 
         // Then
-        XCTAssertEqual(noticeType, .success)
+        XCTAssertEqual(noticeTypes, [.success])
     }
 
-    func test_view_model_enqueues_error_notice_using_modal_notice_presenter_after_reply_fails() {
+    func test_view_model_triggers_error_notice_using_modal_notice_presenter_after_reply_fails() {
         // Given
         let stores = MockStoresManager(sessionManager: .testingInstance)
-        let noticePresenter = MockNoticePresenter()
-        let modalNoticePresenter = MockNoticePresenter()
-        let viewModel = ReviewReplyViewModel(siteID: sampleSiteID, reviewID: sampleReviewID, stores: stores, noticePresenter: noticePresenter)
-        viewModel.modalNoticePresenter = modalNoticePresenter
+        let viewModel = ReviewReplyViewModel(siteID: sampleSiteID, reviewID: sampleReviewID, stores: stores)
         stores.whenReceivingAction(ofType: CommentAction.self) { action in
             switch action {
             case let .replyToComment(_, _, _, onCompletion):
@@ -170,15 +170,16 @@ class ReviewReplyViewModelTests: XCTestCase {
             }
         }
 
+        var noticeTypes: [ReviewReplyNotice] = []
+        viewModel.presentNoticeSubject.sink { notice in
+            noticeTypes.append(notice)
+        }.store(in: &subscriptions)
+
         // When
         viewModel.newReply = "New reply"
-        let noticeType: UINotificationFeedbackGenerator.FeedbackType? = waitFor { promise in
-            viewModel.sendReply { _ in
-                promise(modalNoticePresenter.queuedNotices.first?.feedbackType)
-            }
-        }
+        viewModel.sendReply { _ in }
 
         // Then
-        XCTAssertEqual(noticeType, .error)
+        XCTAssertEqual(noticeTypes, [.error])
     }
 }