Merge branch 'trunk' into issue/6487-coupon-details-update

Author: itsmeichigo

WooCommerce/Classes/Analytics/WooAnalyticsEvent.swift

@@ -817,5 +817,28 @@ extension WooAnalyticsEvent {
                               ]
             )
         }
+
+        /// Tracked when the "learn more" button in the In-Person Payments onboarding is tapped.
+        ///
+        /// - Parameter countryCode: the country code of the store.
+        ///
+        static func cardPresentOnboardingLearnMoreTapped(countryCode: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .cardPresentOnboardingLearnMoreTapped,
+                              properties: [Keys.countryCode: countryCode])
+        }
+
+        /// Tracked when the In-Person Payments onboarding cannot be completed for some reason.
+        ///
+        /// - Parameters:
+        ///   - reason: the reason why the onboarding is not completed.
+        ///   - countryCode: the country code of the store.
+        ///
+        static func cardPresentOnboardingNotCompleted(reason: String, countryCode: String) -> WooAnalyticsEvent {
+            WooAnalyticsEvent(statName: .cardPresentOnboardingNotCompleted,
+                              properties: [
+                                Keys.countryCode: countryCode,
+                                "reason": reason
+                              ])
+        }
     }
 }

WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalReaderIsReady.swift

@@ -41,17 +41,26 @@ final class CardPresentModalReaderIsReady: CardPresentPaymentsModalViewModel {
         return topTitle + bottomTitle
     }
 
-    init(name: String, amount: String) {
+    private let paymentGatewayAccountID: String?
+    private let countryCode: String
+    private let analytics: Analytics
+
+    init(name: String, amount: String, paymentGatewayAccountID: String?, countryCode: String, analytics: Analytics = ServiceLocator.analytics) {
         self.name = name
         self.amount = amount
+        self.paymentGatewayAccountID = paymentGatewayAccountID
+        self.countryCode = countryCode
+        self.analytics = analytics
     }
 
     func didTapPrimaryButton(in viewController: UIViewController?) {
         //
     }
 
     func didTapSecondaryButton(in viewController: UIViewController?) {
-        ServiceLocator.analytics.track(.collectPaymentCanceled)
+        analytics.track(event: WooAnalyticsEvent.InPersonPayments
+                                        .collectPaymentCanceled(forGatewayID: paymentGatewayAccountID,
+                                                                countryCode: countryCode))
 
         let action = CardPresentPaymentAction.cancelPayment(onCompletion: nil)
 

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsPaymentAlerts.swift

@@ -24,8 +24,13 @@ final class OrderDetailsPaymentAlerts {
     private var name: String = ""
     private var amount: String = ""
 
-    init(presentingController: UIViewController) {
+    private let paymentGatewayAccountID: String?
+    private let countryCode: String
+
+    init(presentingController: UIViewController, paymentGatewayAccountID: String?, countryCode: String) {
         self.presentingController = presentingController
+        self.paymentGatewayAccountID = paymentGatewayAccountID
+        self.countryCode = countryCode
     }
 
     func presentViewModel(viewModel: CardPresentPaymentsModalViewModel) {
@@ -89,7 +94,7 @@ final class OrderDetailsPaymentAlerts {
 
 private extension OrderDetailsPaymentAlerts {
     func readerIsReady() -> CardPresentPaymentsModalViewModel {
-        CardPresentModalReaderIsReady(name: name, amount: amount)
+        CardPresentModalReaderIsReady(name: name, amount: amount, paymentGatewayAccountID: paymentGatewayAccountID, countryCode: countryCode)
     }
 
     func tapOrInsert(onCancel: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/AddEditCoupon.swift

@@ -41,6 +41,7 @@ private extension AddEditCoupon {
     }
 }
 
+#if DEBUG
 struct AddEditCoupon_Previews: PreviewProvider {
     static var previews: some View {
 
@@ -50,3 +51,4 @@ struct AddEditCoupon_Previews: PreviewProvider {
         AddEditCoupon(editingViewModel)
     }
 }
+#endif

WooCommerce/Classes/ViewRelated/Dashboard/Settings/CardReadersV2/CardReaderSettingsConnectedViewController.swift

@@ -21,7 +21,9 @@ final class CardReaderSettingsConnectedViewController: UIViewController, CardRea
 
     /// Card Present Payments alerts
     private lazy var paymentAlerts: OrderDetailsPaymentAlerts = {
-        OrderDetailsPaymentAlerts(presentingController: self)
+        OrderDetailsPaymentAlerts(presentingController: self,
+                                  paymentGatewayAccountID: viewModel?.dataSource.cardPresentPaymentGatewayID(),
+                                  countryCode: CardPresentConfigurationLoader().configuration.countryCode)
     }()
 
     private let settingsAlerts = CardReaderSettingsAlerts()

WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/InPersonPaymentsLearnMore.swift

@@ -4,6 +4,8 @@ struct InPersonPaymentsLearnMore: View {
     static let learnMoreURL = URL(string: "woocommerce://in-person-payments/learn-more")!
     @Environment(\.customOpenURL) var customOpenURL
 
+    private let cardPresentConfiguration = CardPresentConfigurationLoader().configuration
+
     var body: some View {
         HStack(spacing: 16) {
             Image(uiImage: .infoOutlineImage)
@@ -15,7 +17,8 @@ struct InPersonPaymentsLearnMore: View {
         }
             .padding(.vertical, Constants.verticalPadding)
             .onTapGesture {
-                ServiceLocator.analytics.track(.cardPresentOnboardingLearnMoreTapped)
+                ServiceLocator.analytics.track(event: WooAnalyticsEvent.InPersonPayments
+                                                .cardPresentOnboardingLearnMoreTapped(countryCode: cardPresentConfiguration.countryCode))
                 customOpenURL?(InPersonPaymentsLearnMore.learnMoreURL)
             }
     }

WooCommerce/Classes/ViewRelated/Dashboard/Settings/In-Person Payments/InPersonPaymentsViewModel.swift

@@ -74,12 +74,14 @@ final class InPersonPaymentsViewModel: ObservableObject {
     }
 }
 
-private func trackState(_ state: CardPresentPaymentOnboardingState) {
-    guard let reason = state.reasonForAnalytics else {
-        return
+private extension InPersonPaymentsViewModel {
+    func trackState(_ state: CardPresentPaymentOnboardingState) {
+        guard let reason = state.reasonForAnalytics else {
+            return
+        }
+        ServiceLocator.analytics
+            .track(event: .InPersonPayments
+                    .cardPresentOnboardingNotCompleted(reason: reason,
+                                                       countryCode: useCase.configurationLoader.configuration.countryCode))
     }
-    let properties = [
-        "reason": reason
-    ]
-    ServiceLocator.analytics.track(.cardPresentOnboardingNotCompleted, withProperties: properties)
 }

WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift

@@ -60,7 +60,9 @@ final class CollectOrderPaymentUseCase: NSObject, CollectOrderPaymentProtocol {
 
     /// Alert manager to inform merchants about reader & card actions.
     ///
-    private lazy var alerts = OrderDetailsPaymentAlerts(presentingController: rootViewController)
+    private lazy var alerts = OrderDetailsPaymentAlerts(presentingController: rootViewController,
+                                                        paymentGatewayAccountID: paymentGatewayAccount.gatewayID,
+                                                        countryCode: configurationLoader.configuration.countryCode)
 
     /// IPP payments collector.
     ///

WooCommerce/WooCommerceTests/ViewModels/CardPresentPayments/CardPresentModalReaderIsReadyTests.swift

@@ -6,13 +6,24 @@ import TestKit
 final class CardPresentModalReaderIsReadyTests: XCTestCase {
     private var viewModel: CardPresentModalReaderIsReady!
 
+    private var analyticsProvider: MockAnalyticsProvider!
+    private var analytics: WooAnalytics!
+
     override func setUp() {
         super.setUp()
-        viewModel = CardPresentModalReaderIsReady(name: Expectations.name, amount: Expectations.amount)
+        analyticsProvider = MockAnalyticsProvider()
+        analytics = WooAnalytics(analyticsProvider: analyticsProvider)
+        viewModel = CardPresentModalReaderIsReady(name: Expectations.name,
+                                                  amount: Expectations.amount,
+                                                  paymentGatewayAccountID: Expectations.paymentGatewayAccountID,
+                                                  countryCode: Expectations.countryCode,
+                                                  analytics: analytics)
     }
 
     override func tearDown() {
         viewModel = nil
+        analytics = nil
+        analyticsProvider = nil
         super.tearDown()
     }
 
@@ -68,13 +79,31 @@ final class CardPresentModalReaderIsReadyTests: XCTestCase {
             XCTFail("Primary button failed to dispatch .cancelPayment action")
         }
     }
+
+    func test_tapping_secondary_button_tracks_cancel_event() throws {
+        // Given
+        assertEmpty(analyticsProvider.receivedEvents)
+
+        // When
+        viewModel.didTapSecondaryButton(in: nil)
+
+        // Then
+        XCTAssertEqual(analyticsProvider.receivedEvents.count, 1)
+        XCTAssertEqual(analyticsProvider.receivedEvents.first, "card_present_collect_payment_canceled")
+
+        let firstPropertiesBatch = try XCTUnwrap(analyticsProvider.receivedProperties.first)
+        XCTAssertEqual(firstPropertiesBatch["country"] as? String, Expectations.countryCode)
+        XCTAssertEqual(firstPropertiesBatch["plugin_slug"] as? String, Expectations.paymentGatewayAccountID)
+    }
 }
 
 
 private extension CardPresentModalReaderIsReadyTests {
     enum Expectations {
-        static var name = "name"
-        static var amount = "amount"
-        static var image = UIImage.cardPresentImage
+        static let name = "name"
+        static let amount = "amount"
+        static let image = UIImage.cardPresentImage
+        static let countryCode = "CA"
+        static let paymentGatewayAccountID = "woocommerce-payments"
     }
 }