Merge pull request #7858 from woocommerce/issue/7856-utm-params-on-card-reader-links

[Just In Time Messages] Send UTM params on card reader purchase links

Author: joshheald

RELEASE-NOTES.txt

@@ -3,6 +3,7 @@
 10.8
 -----
 - [***] Stats: Now you can add a Today's Stats Widget to your lock screen (iOS 16 only) to monitor your sales. [https://github.com/woocommerce/woocommerce-ios/pull/7839]
+- [internal] In-Person Payments: add UTM parameters to card reader purchase URLs to allow attribution [https://github.com/woocommerce/woocommerce-ios/pull/7858]
 
 10.7
 -----

WooCommerce/Classes/Authentication/AuthenticatedWebViewController.swift

@@ -128,6 +128,7 @@ private extension AuthenticatedWebViewController {
         guard let url = viewModel.initialURL else {
             return
         }
+
         if let credentials = ServiceLocator.stores.sessionManager.defaultCredentials {
             webView.authenticateForWPComAndRedirect(to: url, credentials: credentials)
         } else {

WooCommerce/Classes/ViewModels/Feature Announcement Cards/FeatureAnnouncementCardViewModel.swift

@@ -1,6 +1,7 @@
 import Foundation
 import UIKit
 import Yosemite
+import WooFoundation
 
 private typealias FeatureCardEvent = WooAnalyticsEvent.FeatureCard
 

WooCommerce/Classes/ViewModels/Feature Announcement Cards/UpsellCardReadersCampaign.swift

@@ -1,4 +1,5 @@
 import Foundation
+import WooFoundation
 
 struct UpsellCardReadersCampaign {
     let source: WooAnalyticsEvent.FeatureCard.Source
@@ -52,3 +53,17 @@ extension UpsellCardReadersCampaign {
             comment: "Message for a dismissal alert on the upsell card reader feature announcement banner")
     }
 }
+
+extension UpsellCardReadersCampaign {
+    var utmProvider: WooCommerceComUTMProvider {
+        WooCommerceComUTMProvider(
+            campaign: Constants.utmCampaign,
+            source: source.rawValue,
+            content: configuration.campaign.rawValue,
+            siteID: ServiceLocator.stores.sessionManager.defaultStoreID)
+    }
+}
+
+private enum Constants {
+    static let utmCampaign = "feature_announcement_card"
+}

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

@@ -1,5 +1,6 @@
 import Foundation
 import Yosemite
+import WooFoundation
 
 final class InPersonPaymentsMenuViewModel {
     // MARK: - Dependencies
@@ -52,8 +53,18 @@ final class InPersonPaymentsMenuViewModel {
     func orderCardReaderPressed() {
         analytics.track(.paymentsMenuOrderCardReaderTapped)
         showWebView = PurchaseCardReaderWebViewViewModel(configuration: cardPresentPaymentsConfiguration,
+                                                         utmProvider: WooCommerceComUTMProvider(
+                                                            campaign: Constants.utmCampaign,
+                                                            source: Constants.utmSource,
+                                                            content: nil,
+                                                            siteID: siteID),
                                                          onDismiss: { [weak self] in
             self?.showWebView = nil
         })
     }
 }
+
+private enum Constants {
+    static let utmCampaign = "payments_menu_item"
+    static let utmSource = "payments_menu"
+}

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

@@ -1,6 +1,7 @@
 import Foundation
 import Yosemite
 import WebKit
+import WooFoundation
 
 struct PurchaseCardReaderWebViewViewModel: AuthenticatedWebViewModel {
     var title: String
@@ -10,9 +11,10 @@ struct PurchaseCardReaderWebViewViewModel: AuthenticatedWebViewModel {
     let onDismiss: () -> Void
 
     init(configuration: CardPresentPaymentsConfiguration = CardPresentConfigurationLoader().configuration,
+         utmProvider: UTMParametersProviding,
          onDismiss: @escaping () -> Void) {
         self.title = Localization.title
-        self.initialURL = configuration.purchaseCardReaderUrl()
+        self.initialURL = configuration.purchaseCardReaderUrl(utmProvider: utmProvider)
         self.onDismiss = onDismiss
     }
 

WooCommerce/Classes/ViewRelated/Orders/OrderListViewController.swift

@@ -4,8 +4,8 @@ import Gridicons
 import Yosemite
 import WordPressUI
 import SafariServices
-import StoreKit
 import SwiftUI
+import WooFoundation
 
 // Used for protocol conformance of IndicatorInfoProvider only.
 import XLPagerTabStrip
@@ -418,7 +418,10 @@ extension OrderListViewController: SyncingCoordinatorDelegate {
             self?.viewModel.dismissUpsellCardReadersBanner()
         }, callToAction: {
             let configuration = CardPresentConfigurationLoader().configuration
-            WebviewHelper.launch(configuration.purchaseCardReaderUrl(), with: self)
+            WebviewHelper.launch(
+                configuration.purchaseCardReaderUrl(
+                    utmProvider: self.viewModel.upsellCardReadersCampaign.utmProvider),
+                with: self)
         })
             .background(Color(.listForeground))
 

WooCommerce/Classes/ViewRelated/Orders/OrderListViewModel.swift

@@ -26,7 +26,7 @@ final class OrderListViewModel {
 
     /// Used to show the upsell card readers banner and discern its visibility
     /// 
-    private let upsellCardReadersCampaign = UpsellCardReadersCampaign(source: .orderList)
+    let upsellCardReadersCampaign = UpsellCardReadersCampaign(source: .orderList)
     let upsellCardReadersAnnouncementViewModel: FeatureAnnouncementCardViewModel
 
     /// Used for cancelling the observer for Remote Notifications when `self` is deallocated.

WooCommerce/Classes/ViewRelated/Orders/Payment Methods/PaymentMethodsViewModel.swift

@@ -1,8 +1,8 @@
-//import Experiments
 import Foundation
 import Yosemite
 import Combine
 import UIKit
+import WooFoundation
 
 import protocol Storage.StorageManagerType
 
@@ -51,7 +51,7 @@ final class PaymentMethodsViewModel: ObservableObject {
     /// Returns the URL where the merchant can purchase a card reader based on store country code
     ///
     var purchaseCardReaderUrl: URL {
-        cardPresentPaymentsConfiguration.purchaseCardReaderUrl()
+        cardPresentPaymentsConfiguration.purchaseCardReaderUrl(utmProvider: upsellCardReadersCampaign.utmProvider)
     }
 
     /// Store's ID.
@@ -103,7 +103,7 @@ final class PaymentMethodsViewModel: ObservableObject {
 
     private let cardPresentPaymentsConfiguration: CardPresentPaymentsConfiguration
 
-    private let upsellCardReadersCampaign =  UpsellCardReadersCampaign(source: .paymentMethods)
+    private let upsellCardReadersCampaign = UpsellCardReadersCampaign(source: .paymentMethods)
 
     var upsellCardReadersAnnouncementViewModel: FeatureAnnouncementCardViewModel {
         .init(analytics: analytics,

WooCommerce/WooCommerceTests/ViewRelated/Dashboard/Settings/In-Person Payments/InPersonPaymentsMenuViewModelTests.swift

@@ -66,7 +66,13 @@ class InPersonPaymentsMenuViewModelTests: XCTestCase {
         sut.orderCardReaderPressed()
 
         // Then
-        let cardReaderViewModel = try XCTUnwrap(sut.showWebView)
-        assertEqual(configuration.purchaseCardReaderUrl(), cardReaderViewModel.initialURL)
+        let cardReaderPurchaseURL = try XCTUnwrap(sut.showWebView?.initialURL)
+        assertEqual("https", cardReaderPurchaseURL.scheme)
+        assertEqual("woocommerce.com", cardReaderPurchaseURL.host)
+        assertEqual("/products/hardware/US", cardReaderPurchaseURL.path)
+        let query = try XCTUnwrap(cardReaderPurchaseURL.query)
+        XCTAssert(query.contains("utm_medium=woo_ios"))
+        XCTAssert(query.contains("utm_campaign=payments_menu_item"))
+        XCTAssert(query.contains("utm_source=payments_menu"))
     }
 }