Merge pull request #5597 from woocommerce/issue/5581-collect-payment-completion

Author: Ecarrion

WooCommerce/Classes/ViewRelated/Orders/Simple Payments/Amount/SimplePaymentsAmount.swift

@@ -18,7 +18,14 @@ final class SimplePaymentsAmountHostingController: UIHostingController<SimplePay
         return presenter
     }()
 
-    init(viewModel: SimplePaymentsAmountViewModel, presentNoticePublisher: AnyPublisher<SimplePaymentsNotice, Never>) {
+    /// Presents notices at the system level, currently uses the main tab-bar as source view controller.
+    ///
+    private let systemNoticePresenter: NoticePresenter
+
+    init(viewModel: SimplePaymentsAmountViewModel,
+         presentNoticePublisher: AnyPublisher<SimplePaymentsNotice, Never>,
+         systemNoticePresenter: NoticePresenter = ServiceLocator.noticePresenter) {
+        self.systemNoticePresenter = systemNoticePresenter
         super.init(rootView: SimplePaymentsAmount(viewModel: viewModel))
 
         // Needed because a `SwiftUI` cannot be dismissed when being presented by a UIHostingController
@@ -32,6 +39,8 @@ final class SimplePaymentsAmountHostingController: UIHostingController<SimplePay
             .sink { [weak self] notice in
 
                 switch notice {
+                case .completed:
+                    self?.systemNoticePresenter.enqueue(notice: .init(title: SimplePaymentsAmount.Localization.completed, feedbackType: .success))
                 case .error(let description):
                     self?.modalNoticePresenter.enqueue(notice: .init(title: description, feedbackType: .error))
                 }
@@ -154,6 +163,7 @@ private extension SimplePaymentsAmount {
         static let title = NSLocalizedString("Take Payment", comment: "Title for the simple payments screen")
         static let instructions = NSLocalizedString("Enter Amount", comment: "Short instructions label in the simple payments screen")
         static let cancelTitle = NSLocalizedString("Cancel", comment: "Title for the button to cancel the simple payments screen")
+        static let completed = NSLocalizedString("🎉 Order completed", comment: "Title for the button to cancel the simple payments screen")
 
         static func buttonTitle() -> String {
             if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.simplePaymentsPrototype) {
@@ -175,5 +185,6 @@ private extension SimplePaymentsAmount {
 /// Representation of possible notices that can be displayed
 ///
 enum SimplePaymentsNotice: Equatable {
+    case completed
     case error(String)
 }

WooCommerce/Classes/ViewRelated/Orders/Simple Payments/Method/SimplePaymentsMethodsViewModel.swift

@@ -105,6 +105,7 @@ final class SimplePaymentsMethodsViewModel: ObservableObject {
 
             if error == nil {
                 onSuccess()
+                self.presentNoticeSubject.send(.completed)
             } else {
                 self.presentNoticeSubject.send(.error(Localization.markAsPaidError))
             }
@@ -137,13 +138,14 @@ final class SimplePaymentsMethodsViewModel: ObservableObject {
                                                             paymentGatewayAccount: paymentGateway,
                                                             rootViewController: rootViewController)
         collectPaymentsUseCase?.collectPayment(onCollect: { _ in
-            print("On collect does nothing for now...")
+            /* No op. */
         }, onCompleted: { [weak self] in
-            // TODO: Show success notice
-
             // Inform success to consumer
             onSuccess()
 
+            // Sent notice request
+            self?.presentNoticeSubject.send(.completed)
+
             // Make sure we free all the resources
             self?.collectPaymentsUseCase = nil
         })

WooCommerce/WooCommerceTests/ViewRelated/Orders/Simple Payments/SimplePaymentsAmountViewModelTests.swift

@@ -300,6 +300,8 @@ final class SimplePaymentsAmountViewModelTests: XCTestCase {
                 switch intent {
                 case .error:
                     promise(true)
+                case .completed:
+                    promise(false)
                 }
             }
             .store(in: &self.subscriptions)

WooCommerce/WooCommerceTests/ViewRelated/Orders/Simple Payments/SimplePaymentsMethodsViewModelTests.swift

@@ -88,6 +88,38 @@ final class SimplePaymentsMethodsViewModelTests: XCTestCase {
         XCTAssertTrue(onSuccessInvoked)
     }
 
+    func test_view_model_attempts_completed_notice_presentation_when_marking_an_order_as_paid() {
+        // Given
+        let stores = MockStoresManager(sessionManager: .testingInstance)
+        let noticeSubject = PassthroughSubject<SimplePaymentsNotice, Never>()
+        let viewModel = SimplePaymentsMethodsViewModel(formattedTotal: "$12.00", presentNoticeSubject: noticeSubject, stores: stores)
+        stores.whenReceivingAction(ofType: OrderAction.self) { action in
+            switch action {
+            case let .updateOrderStatus(_, _, _, onCompletion):
+                onCompletion(nil)
+            default:
+                XCTFail("Unexpected action: \(action)")
+            }
+        }
+
+        // When
+        let receivedCompleted: Bool = waitFor { promise in
+            noticeSubject.sink { intent in
+                switch intent {
+                case .error:
+                    promise(false)
+                case .completed:
+                    promise(true)
+                }
+            }
+            .store(in: &self.subscriptions)
+            viewModel.markOrderAsPaid(onSuccess: {})
+        }
+
+        // Then
+        XCTAssertTrue(receivedCompleted)
+    }
+
     func test_view_model_attempts_error_notice_presentation_when_failing_to_mark_order_as_paid() {
         // Given
         let stores = MockStoresManager(sessionManager: .testingInstance)
@@ -108,6 +140,8 @@ final class SimplePaymentsMethodsViewModelTests: XCTestCase {
                 switch intent {
                 case .error:
                     promise(true)
+                case .completed:
+                    promise(false)
                 }
             }
             .store(in: &self.subscriptions)

WooCommerce/WooCommerceTests/ViewRelated/Orders/Simple Payments/SimplePaymentsSummaryViewModelTests.swift

@@ -133,6 +133,8 @@ final class SimplePaymentsSummaryViewModelTests: XCTestCase {
                 switch intent {
                 case .error:
                     promise(true)
+                case .completed:
+                    promise(false)
                 }
             }
             .store(in: &self.subscriptions)