Merge pull request #5908 from selanthiraiyan/issue/5907-simple-payments-flaky-tests

Fix flaky unit tests in `SimplePaymentsSummaryViewModelTests`

Author: itsmeichigo

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

@@ -40,8 +40,24 @@ final class SimplePaymentsSummaryViewModelTests: XCTestCase {
 
     func test_provided_amount_gets_properly_formatted() {
         // Given
+        let mockStores = MockStoresManager(sessionManager: .testingInstance)
+        mockStores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
+            switch action {
+            case let .getSimplePaymentsTaxesToggleState(_, onCompletion):
+                onCompletion(.success(false)) // Keep the taxes toggle turned off
+            case .setSimplePaymentsTaxesToggleState:
+                break // No op
+            default:
+                XCTFail("Unexpected action: \(action)")
+            }
+        }
+
         let currencyFormatter = CurrencyFormatter(currencySettings: CurrencySettings()) // Default is US.
-        let viewModel = SimplePaymentsSummaryViewModel(providedAmount: "100", totalWithTaxes: "104.30", taxAmount: "$4.3", currencyFormatter: currencyFormatter)
+        let viewModel = SimplePaymentsSummaryViewModel(providedAmount: "100",
+                                                       totalWithTaxes: "104.30",
+                                                       taxAmount: "$4.3",
+                                                       currencyFormatter: currencyFormatter,
+                                                       stores: mockStores)
 
         // When & Then
         XCTAssertEqual(viewModel.providedAmount, "$100.00")
@@ -215,26 +231,55 @@ final class SimplePaymentsSummaryViewModelTests: XCTestCase {
 
     func test_noteAdded_event_is_tracked_after_editing_note() {
         // Given
+        let mockStores = MockStoresManager(sessionManager: .testingInstance)
+        mockStores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
+            switch action {
+            case let .getSimplePaymentsTaxesToggleState(_, onCompletion):
+                onCompletion(.success(true))
+            case .setSimplePaymentsTaxesToggleState:
+                break // No op
+            default:
+                XCTFail("Unexpected action: \(action)")
+            }
+        }
+
         let mockAnalytics = MockAnalyticsProvider()
         let viewModel = SimplePaymentsSummaryViewModel(providedAmount: "1.0",
                                                        totalWithTaxes: "1.0",
                                                        taxAmount: "0.0",
+                                                       stores: mockStores,
                                                        analytics: WooAnalytics(analyticsProvider: mockAnalytics))
 
         // When
         viewModel.noteViewModel.newNote = "content"
         viewModel.noteViewModel.updateNote(onFinish: { _ in })
 
         // Then
-        assertEqual(mockAnalytics.receivedEvents, [WooAnalyticsStat.simplePaymentsFlowNoteAdded.rawValue])
+        assertEqual(mockAnalytics.receivedEvents, [
+            WooAnalyticsStat.simplePaymentsFlowTaxesToggled.rawValue, // Event triggered when view model loads the toggle state during initialization
+            WooAnalyticsStat.simplePaymentsFlowNoteAdded.rawValue
+        ])
     }
 
     func test_taxesToggled_event_is_tracked_after_switching_taxes_toggle() {
         // Given
+        let mockStores = MockStoresManager(sessionManager: .testingInstance)
+        mockStores.whenReceivingAction(ofType: AppSettingsAction.self) { action in
+            switch action {
+            case let .getSimplePaymentsTaxesToggleState(_, onCompletion):
+                onCompletion(.success(false))
+            case .setSimplePaymentsTaxesToggleState:
+                break // No op
+            default:
+                XCTFail("Unexpected action: \(action)")
+            }
+        }
+
         let mockAnalytics = MockAnalyticsProvider()
         let viewModel = SimplePaymentsSummaryViewModel(providedAmount: "1.0",
                                                        totalWithTaxes: "1.0",
                                                        taxAmount: "0.0",
+                                                       stores: mockStores,
                                                        analytics: WooAnalytics(analyticsProvider: mockAnalytics))
 
         // When
@@ -243,12 +288,15 @@ final class SimplePaymentsSummaryViewModelTests: XCTestCase {
 
         // Then
         assertEqual(mockAnalytics.receivedEvents, [
+            WooAnalyticsStat.simplePaymentsFlowTaxesToggled.rawValue,  // Event triggered when view model loads the toggle state during initialization
             WooAnalyticsStat.simplePaymentsFlowTaxesToggled.rawValue,  // Taxes enabled
             WooAnalyticsStat.simplePaymentsFlowTaxesToggled.rawValue   // Taxes disabled
         ])
 
-        assertEqual(mockAnalytics.receivedProperties[0]["state"] as? String, "on")  // Taxes enabled
-        assertEqual(mockAnalytics.receivedProperties[1]["state"] as? String, "off") // Taxes disabled
+        assertEqual(mockAnalytics.receivedProperties[0]["state"] as? String,
+                    "off")  // Taxes disabled when view model loads the toggle state during initialization
+        assertEqual(mockAnalytics.receivedProperties[1]["state"] as? String, "on")  // Taxes enabled due to setting `enableTaxes` as true
+        assertEqual(mockAnalytics.receivedProperties[2]["state"] as? String, "off") // Taxes disabled due to setting `enableTaxes` as false
     }
 
     func test_failing_event_is_tracked_when_order_fails_to_update() {