Merge branch 'trunk' into feat/15198-update-reader-update-colors

jaclync · jaclync · commit a1459b0e479a · 2025-02-20T16:27:53.000+08:00
diff --git a/Experiments/Experiments/DefaultFeatureFlagService.swift b/Experiments/Experiments/DefaultFeatureFlagService.swift
@@ -87,8 +87,6 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return true
         case .productGlobalUniqueIdentifierSupport:
             return true
-        case .sendReceiptsForPointOfSale:
-            return true
         case .hideSitesInStorePicker:
             return true
         case .filterHistoryOnOrderAndProductLists:
diff --git a/Experiments/Experiments/FeatureFlag.swift b/Experiments/Experiments/FeatureFlag.swift
@@ -189,10 +189,6 @@ public enum FeatureFlag: Int {
     ///
     case productGlobalUniqueIdentifierSupport
 
-    /// Adds support for  sending receipts after the payment for POS
-    ///
-    case sendReceiptsForPointOfSale
-
     /// Supports hiding sites from the store picker
     ///
     case hideSitesInStorePicker
diff --git a/WooCommerce/Classes/Analytics/TracksProvider.swift b/WooCommerce/Classes/Analytics/TracksProvider.swift
@@ -110,25 +110,95 @@ private extension TracksProvider {
     }
 
     private func decorateEventNameForPOSIfNeeded(_ eventName: String) -> String {
-        // We do not want to track some events that might happen in POS mode as `pos_` events,
-        // for example, when backgrounding the app or finishing async work from the app side.
-        // Ref: https://github.com/woocommerce/woocommerce-ios/pull/15006#issuecomment-2622001706
-        let exemptedEvents: Set<String> = [
-            "application_opened",
-            "application_closed",
-            "orders_add_new",
-            "support_new_request_viewed",
-            "dynamic_dashboard_card_data_loading_completed"
-        ]
-        if exemptedEvents.contains(eventName) {
+        guard let event = WooAnalyticsStat(rawValue: eventName) else {
+            DDLogWarn("⚠️ Event not found in WooAnalyticsStat list")
             return eventName
         }
 
-        if Self.isPOSModeActive {
-            let prefix = "pos_"
-            return "\(prefix)\(eventName)"
+        let pointOfSaleEventList: Set<WooAnalyticsStat> = [
+            // POS-specific events
+            WooAnalyticsStat.pointOfSaleLoaded,
+            WooAnalyticsStat.pointOfSaleProductsPullToRefresh,
+            WooAnalyticsStat.pointOfSaleVariationsPullToRefresh,
+            WooAnalyticsStat.pointOfSaleAddItemToCart,
+            WooAnalyticsStat.pointOfSaleItemRemovedFromCart,
+            WooAnalyticsStat.pointOfSaleCheckoutTapped,
+            WooAnalyticsStat.pointOfSaleBackToCartTapped,
+            WooAnalyticsStat.pointOfSaleBackToCheckoutFromCashTapped,
+            WooAnalyticsStat.pointOfSaleClearCartTapped,
+            WooAnalyticsStat.pointOfSaleExitMenuItemTapped,
+            WooAnalyticsStat.pointOfSaleExitConfirmed,
+            WooAnalyticsStat.pointOfSaleGetSupportTapped,
+            WooAnalyticsStat.pointOfSaleSimpleProductsExplanationDialogShown,
+            WooAnalyticsStat.pointOfSaleCreateNewOrderTapped,
+            WooAnalyticsStat.pointOfSaleReceiptEmailSendTapped,
+            WooAnalyticsStat.pointOfSalePaymentsOnboardingShown,
+            WooAnalyticsStat.pointOfSalePaymentsOnboardingDismissed,
+            WooAnalyticsStat.pointOfSaleCardReaderConnectionTapped,
+            WooAnalyticsStat.pointOfSaleInteractionWithCustomerStarted,
+            WooAnalyticsStat.pointOfSaleViewDocsTapped,
+            WooAnalyticsStat.pointOfSaleReaderReadyForCardPayment,
+            WooAnalyticsStat.pointOfSaleCashCollectPaymentSuccess,
+
+            // Order
+            WooAnalyticsStat.orderCreationSuccess,
+            WooAnalyticsStat.orderCreationFailed,
+
+            // Card Reader Connection
+            WooAnalyticsStat.cardReaderSelectTypeShown,
+            WooAnalyticsStat.cardReaderSelectTypeBuiltInTapped,
+            WooAnalyticsStat.cardReaderSelectTypeBluetoothTapped,
+            WooAnalyticsStat.cardReaderDiscoveryFailed,
+            WooAnalyticsStat.cardReaderConnectionFailed,
+            WooAnalyticsStat.cardReaderConnectionSuccess,
+            WooAnalyticsStat.cardReaderDisconnectTapped,
+            WooAnalyticsStat.manageCardReadersBuiltInReaderAutoDisconnect,
+            WooAnalyticsStat.cardReaderAutomaticDisconnect,
+            WooAnalyticsStat.cardReaderLocationPermissionPreAlertShown,
+            WooAnalyticsStat.cardReaderLocationPermissionRequiredShown,
+
+            // Card Reader Software Update
+            WooAnalyticsStat.cardReaderSoftwareUpdateTapped,
+            WooAnalyticsStat.cardReaderSoftwareUpdateStarted,
+            WooAnalyticsStat.cardReaderSoftwareUpdateSuccess,
+            WooAnalyticsStat.cardReaderSoftwareUpdateFailed,
+            WooAnalyticsStat.cardReaderSoftwareUpdateCancelTapped,
+            WooAnalyticsStat.cardReaderSoftwareUpdateCanceled,
+
+            // Card-Present Payments Onboarding
+            WooAnalyticsStat.cardPresentOnboardingLearnMoreTapped,
+            WooAnalyticsStat.cardPresentOnboardingCompleted,
+            WooAnalyticsStat.cardPresentOnboardingNotCompleted,
+            WooAnalyticsStat.cardPresentOnboardingStepSkipped,
+            WooAnalyticsStat.cardPresentOnboardingCtaTapped,
+            WooAnalyticsStat.cardPresentOnboardingCtaFailed,
+
+            // Receipts
+            WooAnalyticsStat.receiptEmailTapped,
+            WooAnalyticsStat.receiptEmailSuccess,
+            WooAnalyticsStat.receiptEmailFailed,
+
+            // Payments
+            WooAnalyticsStat.collectPaymentCanceled,
+            WooAnalyticsStat.collectPaymentFailed,
+            WooAnalyticsStat.collectPaymentSuccess,
+            WooAnalyticsStat.collectInteracPaymentSuccess,
+            WooAnalyticsStat.interacRefundSuccess,
+            WooAnalyticsStat.interacRefundFailed,
+            WooAnalyticsStat.interacRefundCanceled,
+
+            // Payment Methods
+            WooAnalyticsStat.paymentsFlowCompleted,
+            WooAnalyticsStat.paymentsFlowCanceled,
+            WooAnalyticsStat.paymentsFlowFailed,
+            WooAnalyticsStat.paymentsFlowCollect,
+        ]
+
+        guard Self.isPOSModeActive, pointOfSaleEventList.contains(event) else {
+            return eventName
         }
-        return eventName
+        let prefix = "pos_"
+        return "\(prefix)\(eventName)"
     }
 
     func refreshTracksMetadata() {
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift b/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift
@@ -1283,8 +1283,7 @@ enum WooAnalyticsStat: String {
     case pointOfSaleGetSupportTapped = "get_support_tapped"
     case pointOfSaleSimpleProductsExplanationDialogShown = "simple_products_explanation_dialog_shown"
     case pointOfSaleCreateNewOrderTapped = "create_new_order_tapped"
-    case pointOfSaleEmailReceiptTapped = "email_receipt_tapped"
-    case pointOfSaleEmailReceiptSendTapped = "email_receipt_send_tapped"
+    case pointOfSaleReceiptEmailSendTapped = "receipt_email_send_tapped"
     case pointOfSalePaymentsOnboardingShown = "payments_onboarding_shown"
     case pointOfSalePaymentsOnboardingDismissed = "payments_onboarding_dismissed"
     case pointOfSaleCardReaderConnectionTapped = "card_reader_connection_tapped"
diff --git a/WooCommerce/Classes/POS/Models/PointOfSaleAggregateModel.swift b/WooCommerce/Classes/POS/Models/PointOfSaleAggregateModel.swift
@@ -278,7 +278,14 @@ extension PointOfSaleAggregateModel {
 
     @MainActor
     func sendReceipt(to emailAddress: String) async throws {
-        try await orderController.sendReceipt(recipientEmail: emailAddress)
+        do {
+            try await orderController.sendReceipt(recipientEmail: emailAddress)
+            analytics.track(.receiptEmailSuccess)
+        } catch {
+            // Catch and re-throw in order to capture the error event, but still allow the UI to handle the error state.
+            analytics.track(.receiptEmailFailed)
+            throw error
+        }
     }
 
     @MainActor
diff --git a/WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentProcessingMessageViewModel.swift b/WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentProcessingMessageViewModel.swift
@@ -14,7 +14,7 @@ private extension PointOfSaleCardPresentPaymentProcessingMessageViewModel {
         )
 
         static let pleaseWait = NSLocalizedString(
-            "pointOfSale.cardPresent.paymentProcessing.message",
+            "pointOfSale.cardPresent.waitForPaymentProcessing.message",
             value: "Please wait",
             comment: "Indicates to wait while payment is processing. Presented to users when payment collection starts"
         )
diff --git a/WooCommerce/Classes/POS/Presentation/POSFloatingControlView.swift b/WooCommerce/Classes/POS/Presentation/POSFloatingControlView.swift
@@ -88,7 +88,12 @@ private extension POSFloatingControlView {
     }
 
     var fontColor: Color {
-        .posOnSurface
+        switch backgroundAppearance {
+        case .primary:
+            .posOnSurface
+        case .secondary:
+            Self.secondaryFontColor
+        }
     }
 }
 
diff --git a/WooCommerce/Classes/POS/Presentation/PaymentButtons.swift b/WooCommerce/Classes/POS/Presentation/PaymentButtons.swift
@@ -8,16 +8,11 @@ struct PaymentsActionButtons: View {
 
     private let receiptEligibilityUseCase = ReceiptEligibilityUseCase()
 
-    private var shouldShowSendReceiptButton: Bool {
-        ServiceLocator.featureFlagService.isFeatureFlagEnabled(.sendReceiptsForPointOfSale)
-    }
-
     var body: some View {
         ZStack {
             VStack {
                 newOrderButton
                 sendReceiptButton
-                    .renderedIf(shouldShowSendReceiptButton)
             }
         }
     }
@@ -28,7 +23,7 @@ private extension PaymentsActionButtons {
     var sendReceiptButton: some View {
         Button(action: {
             Task { @MainActor in
-                ServiceLocator.analytics.track(.pointOfSaleEmailReceiptTapped)
+                ServiceLocator.analytics.track(.receiptEmailTapped)
                 await handleSendReceiptAction()
             }
         }, label: {
diff --git a/WooCommerce/Classes/POS/Presentation/Reusable Views/POSSendReceiptView.swift b/WooCommerce/Classes/POS/Presentation/Reusable Views/POSSendReceiptView.swift
@@ -74,7 +74,7 @@ struct POSSendReceiptView: View {
     }
 
     private func sendReceipt() {
-        ServiceLocator.analytics.track(.pointOfSaleEmailReceiptSendTapped)
+        ServiceLocator.analytics.track(.pointOfSaleReceiptEmailSendTapped)
         Task { @MainActor in
             guard isEmailValid else {
                 errorMessage = Localization.emailValidationErrorText
diff --git a/WooCommerce/Classes/ViewModels/Order Details/Receipts/ReceiptEligibilityUseCase.swift b/WooCommerce/Classes/ViewModels/Order Details/Receipts/ReceiptEligibilityUseCase.swift
@@ -44,11 +44,6 @@ final class ReceiptEligibilityUseCase: ReceiptEligibilityUseCaseProtocol {
     /// WooCommerce 9.5 allows to attach a customer email after payment is made and send email receipt via the API.
     ///
     func isEligibleForPointOfSaleReceipts(onCompletion: @escaping (Bool) -> Void) {
-        guard featureFlagService.isFeatureFlagEnabled(.sendReceiptsForPointOfSale) else {
-            onCompletion(false)
-            return
-        }
-
         Task { @MainActor in
             let isWooCommerceSupported = await isPluginSupported(Constants.wcPluginName,
                                                                  minimumVersion: Constants.PointOfSaleReceipts.wcPluginMinimumVersion)
diff --git a/WooCommerce/WooCommerceTests/Mocks/MockFeatureFlagService.swift b/WooCommerce/WooCommerceTests/Mocks/MockFeatureFlagService.swift
@@ -22,7 +22,6 @@ final class MockFeatureFlagService: FeatureFlagService {
     var viewEditCustomFieldsInProductsAndOrders: Bool
     var favoriteProducts: Bool
     var isProductGlobalUniqueIdentifierSupported: Bool
-    var receiptsForPOS: Bool
     var hideSitesInStorePicker: Bool
 
     init(isInboxOn: Bool = false,
@@ -45,7 +44,6 @@ final class MockFeatureFlagService: FeatureFlagService {
          viewEditCustomFieldsInProductsAndOrders: Bool = false,
          favoriteProducts: Bool = false,
          isProductGlobalUniqueIdentifierSupported: Bool = false,
-         receiptsForPOS: Bool = false,
          hideSitesInStorePicker: Bool = false) {
         self.isInboxOn = isInboxOn
         self.isShowInboxCTAEnabled = isShowInboxCTAEnabled
@@ -67,7 +65,6 @@ final class MockFeatureFlagService: FeatureFlagService {
         self.viewEditCustomFieldsInProductsAndOrders = viewEditCustomFieldsInProductsAndOrders
         self.favoriteProducts = favoriteProducts
         self.isProductGlobalUniqueIdentifierSupported = isProductGlobalUniqueIdentifierSupported
-        self.receiptsForPOS = receiptsForPOS
         self.hideSitesInStorePicker = hideSitesInStorePicker
     }
 
@@ -113,8 +110,6 @@ final class MockFeatureFlagService: FeatureFlagService {
             return favoriteProducts
         case .productGlobalUniqueIdentifierSupport:
             return isProductGlobalUniqueIdentifierSupported
-        case .sendReceiptsForPointOfSale:
-            return receiptsForPOS
         case .hideSitesInStorePicker:
             return hideSitesInStorePicker
         default:
diff --git a/WooCommerce/WooCommerceTests/POS/Mocks/MockPointOfSaleOrderController.swift b/WooCommerce/WooCommerceTests/POS/Mocks/MockPointOfSaleOrderController.swift
@@ -41,5 +41,12 @@ final class MockPointOfSaleOrderController: PointOfSaleOrderControllerProtocol {
         clearOrderWasCalled = true
     }
 
-    func sendReceipt(recipientEmail: String) async { }
+    var shouldThrowReceiptError: Bool = false
+    var sendReceiptWasCalled: Bool = false
+    func sendReceipt(recipientEmail: String) async throws {
+        sendReceiptWasCalled = true
+        if shouldThrowReceiptError {
+            throw NSError(domain: "some error", code: -1)
+        }
+    }
 }
diff --git a/WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift b/WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift
@@ -298,6 +298,45 @@ struct PointOfSaleAggregateModelTests {
             // Then
             #expect(cardPresentPaymentService.collectPaymentChannel == .pos)
         }
+
+        @available(iOS 17.0, *)
+        @Test func sendReceipt_when_invoked_then_calls_controller() async throws {
+            // Given
+            let orderController = MockPointOfSaleOrderController()
+            let sut = PointOfSaleAggregateModel(itemsController: MockPointOfSaleItemsController(),
+                                                cardPresentPaymentService: MockCardPresentPaymentService(),
+                                                orderController: orderController,
+                                                collectOrderPaymentAnalyticsTracker: MockCollectOrderPaymentAnalyticsTracker())
+
+            // When
+            try await sut.sendReceipt(to: "")
+
+            // Then
+            #expect(orderController.sendReceiptWasCalled == true)
+        }
+
+        @available(iOS 17.0, *)
+        @Test func sendReceipt_when_invoked_with_error_then_returns_error() async throws {
+            // Given
+            let orderController = MockPointOfSaleOrderController()
+            orderController.shouldThrowReceiptError = true
+            let expectedError = NSError(domain: "some error", code: -1)
+
+            let sut = PointOfSaleAggregateModel(itemsController: MockPointOfSaleItemsController(),
+                                                cardPresentPaymentService: MockCardPresentPaymentService(),
+                                                orderController: orderController,
+                                                collectOrderPaymentAnalyticsTracker: MockCollectOrderPaymentAnalyticsTracker())
+
+            do {
+                // When
+                try await sut.sendReceipt(to: "")
+            } catch {
+                // Then
+                let nsError = error as NSError
+                #expect(nsError.domain == expectedError.domain)
+                #expect(nsError.code == expectedError.code)
+            }
+        }
     }
 
     struct PaymentTests {
diff --git a/WooCommerce/WooCommerceTests/ViewModels/Receipts/ReceiptEligibilityUseCaseTests.swift b/WooCommerce/WooCommerceTests/ViewModels/Receipts/ReceiptEligibilityUseCaseTests.swift
@@ -88,64 +88,6 @@ final class ReceiptEligibilityUseCaseTests: XCTestCase {
         XCTAssertFalse(isEligible)
     }
 
-    func test_isEligibleForPOSReceipts_when_WooCommerce_version_is_correct_version_then_returns_true() {
-        // Given
-        let featureFlag = MockFeatureFlagService(receiptsForPOS: true)
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
-        let plugin = SystemPlugin.fake().copy(name: "WooCommerce",
-                                              version: "9.5",
-                                              active: true)
-
-        stores.whenReceivingAction(ofType: SystemStatusAction.self) { action in
-            switch action {
-            case let .fetchSystemPlugin(_, _, onCompletion):
-                onCompletion(plugin)
-            default:
-                XCTFail("Unexpected action")
-            }
-        }
-        let sut = ReceiptEligibilityUseCase(stores: stores, featureFlagService: featureFlag)
-
-        // When
-        let isEligible: Bool = waitFor { promise in
-            sut.isEligibleForPointOfSaleReceipts(onCompletion: { result in
-                promise(result)
-            })
-        }
-
-        // Then
-        XCTAssertTrue(isEligible)
-    }
-
-    func test_isEligibleForPOSReceipts_when_WooCommerce_version_is_incorrect_version_then_returns_false() {
-        // Given
-        let featureFlag = MockFeatureFlagService(receiptsForPOS: true)
-        let stores = MockStoresManager(sessionManager: .makeForTesting())
-        let plugin = SystemPlugin.fake().copy(name: "WooCommerce",
-                                              version: "9.4",
-                                              active: true)
-
-        stores.whenReceivingAction(ofType: SystemStatusAction.self) { action in
-            switch action {
-            case let .fetchSystemPlugin(_, _, onCompletion):
-                onCompletion(plugin)
-            default:
-                XCTFail("Unexpected action")
-            }
-        }
-        let sut = ReceiptEligibilityUseCase(stores: stores, featureFlagService: featureFlag)
-
-        // When
-        let isEligible: Bool = waitFor { promise in
-            sut.isEligibleForPointOfSaleReceipts(onCompletion: { result in
-                promise(result)
-            })
-        }
-
-        // Then
-        XCTAssertFalse(isEligible)
-    }
-
     func test_when_WooCommerce_version_is_equal_or_above_minimum_then_returns_true() {
         // Given
         let stores = MockStoresManager(sessionManager: .makeForTesting())

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ private extension PointOfSaleCardPresentPaymentProcessingMessageViewModel {`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`static let pleaseWait = NSLocalizedString(`
`17`		`- "pointOfSale.cardPresent.paymentProcessing.message",`
	`17`	`+ "pointOfSale.cardPresent.waitForPaymentProcessing.message",`
`18`	`18`	`value: "Please wait",`
`19`	`19`	`comment: "Indicates to wait while payment is processing. Presented to users when payment collection starts"`
`20`	`20`	`)`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,12 @@ private extension POSFloatingControlView {`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`var fontColor: Color {`
`91`		`- .posOnSurface`
	`91`	`+ switch backgroundAppearance {`
	`92`	`+ case .primary:`
	`93`	`+ .posOnSurface`
	`94`	`+ case .secondary:`
	`95`	`+ Self.secondaryFontColor`
	`96`	`+ }`
`92`	`97`	`}`
`93`	`98`	`}`
`94`	`99`
Original file line number	Diff line number	Diff line change
`@@ -8,16 +8,11 @@ struct PaymentsActionButtons: View {`
`8`	`8`
`9`	`9`	`private let receiptEligibilityUseCase = ReceiptEligibilityUseCase()`
`10`	`10`
`11`		`- private var shouldShowSendReceiptButton: Bool {`
`12`		`- ServiceLocator.featureFlagService.isFeatureFlagEnabled(.sendReceiptsForPointOfSale)`
`13`		`- }`
`14`		`-`
`15`	`11`	`var body: some View {`
`16`	`12`	`ZStack {`
`17`	`13`	`VStack {`
`18`	`14`	`newOrderButton`
`19`	`15`	`sendReceiptButton`
`20`		`- .renderedIf(shouldShowSendReceiptButton)`
`21`	`16`	`}`
`22`	`17`	`}`
`23`	`18`	`}`
`@@ -28,7 +23,7 @@ private extension PaymentsActionButtons {`
`28`	`23`	`var sendReceiptButton: some View {`
`29`	`24`	`Button(action: {`
`30`	`25`	`Task { @MainActor in`
`31`		`- ServiceLocator.analytics.track(.pointOfSaleEmailReceiptTapped)`
	`26`	`+ ServiceLocator.analytics.track(.receiptEmailTapped)`
`32`	`27`	`await handleSendReceiptAction()`
`33`	`28`	`}`
`34`	`29`	`}, label: {`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ struct POSSendReceiptView: View {`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`private func sendReceipt() {`
`77`		`- ServiceLocator.analytics.track(.pointOfSaleEmailReceiptSendTapped)`
	`77`	`+ ServiceLocator.analytics.track(.pointOfSaleReceiptEmailSendTapped)`
`78`	`78`	`Task { @MainActor in`
`79`	`79`	`guard isEmailValid else {`
`80`	`80`	`errorMessage = Localization.emailValidationErrorText`