FPTI Updates (#208)

* Update component from ppcpmobilesdk to ppcpclientsdk
* Update AnalyticsService to accept an optional correlationID parameter
* Collect correlationID & send in analytics for PayPalNativeCheckoutClient when present

Co-authored-by: Justin Warmkessel <jwarmkessel@gmail.com>

CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # PayPal iOS SDK Release Notes
 
+## unreleased
+* CorePayments
+  * Analytics
+    * Update `component` from `ppcpmobilesdk` to `ppcpclientsdk`
+    * Send `correlation_id`, when possible, in PayPal Native Checkout analytic events
+
 ## 1.0.0 (2023-10-02)
 * Breaking Changes
   * Require Xcode 14.3+ and Swift 5.8+

Sources/CardPayments/APIRequests/CheckoutOrdersAPI.swift

@@ -7,9 +7,9 @@ import CorePayments
 ///
 /// Details on this PayPal API can be found in PPaaS under Merchant > Checkout > Orders > v2.
 class CheckoutOrdersAPI {
-    
-    // MARK: - Private Propertires
-    
+
+    // MARK: - Private Properties
+
     private let coreConfig: CoreConfig
     private let networkingClient: NetworkingClient
 

Sources/CorePayments/AnalyticsEventData.swift

@@ -17,6 +17,7 @@ struct AnalyticsEventData: Encodable {
         case clientSDKVersion = "c_sdk_ver"
         case clientOS = "client_os"
         case component = "comp"
+        case correlationID = "correlation_id"
         case deviceManufacturer = "device_manufacturer"
         case environment = "merchant_sdk_env"
         case eventName = "event_name"
@@ -41,7 +42,9 @@ struct AnalyticsEventData: Encodable {
 
     let clientOS: String = UIDevice.current.systemName + " " + UIDevice.current.systemVersion
 
-    let component = "ppcpmobilesdk"
+    let component = "ppcpclientsdk"
+
+    let correlationID: String?
 
     let deviceManufacturer = "Apple"
 
@@ -90,11 +93,12 @@ struct AnalyticsEventData: Encodable {
 
     let tenantName = "PayPal"
 
-    init(environment: String, eventName: String, clientID: String, orderID: String) {
+    init(environment: String, eventName: String, clientID: String, orderID: String, correlationID: String?) {
         self.environment = environment
         self.eventName = eventName
         self.clientID = clientID
         self.orderID = orderID
+        self.correlationID = correlationID
     }
 
     func encode(to encoder: Encoder) throws {
@@ -108,6 +112,7 @@ struct AnalyticsEventData: Encodable {
         try eventParameters.encode(clientSDKVersion, forKey: .clientSDKVersion)
         try eventParameters.encode(clientOS, forKey: .clientOS)
         try eventParameters.encode(component, forKey: .component)
+        try eventParameters.encode(correlationID, forKey: .correlationID)
         try eventParameters.encode(deviceManufacturer, forKey: .deviceManufacturer)
         try eventParameters.encode(environment, forKey: .environment)
         try eventParameters.encode(eventName, forKey: .eventName)

Sources/CorePayments/Networking/AnalyticsService.swift

@@ -30,27 +30,31 @@ public struct AnalyticsService {
     // MARK: - Public Methods
 
     /// This method is exposed for internal PayPal use only. Do not use. It is not covered by Semantic Versioning and may change or be removed at any time.
-    ///
     /// Sends analytics event to https://api.paypal.com/v1/tracking/events/ via a background task.
     /// - Parameter name: Event name string used to identify this unique event in FPTI.
-    public func sendEvent(_ name: String) {
+    /// - Parameter correlationID: correlation ID associated with the request
+    public func sendEvent(_ name: String, correlationID: String? = nil) {
         Task(priority: .background) {
-            await performEventRequest(name)
+            await performEventRequest(name, correlationID: correlationID)
         }
     }
 
     // MARK: - Internal Methods
 
     /// Exposed to be able to execute this function synchronously in unit tests
-    func performEventRequest(_ name: String) async {
+    /// - Parameters:
+    ///   - name: Event name string used to identify this unique event in FPTI
+    ///   - correlationID: correlation ID associated with the request
+    func performEventRequest(_ name: String, correlationID: String? = nil) async {
         do {
             let clientID = coreConfig.clientID
 
             let eventData = AnalyticsEventData(
                 environment: coreConfig.environment.toString,
                 eventName: name,
                 clientID: clientID,
-                orderID: orderID
+                orderID: orderID,
+                correlationID: correlationID
             )
 
             let (_) = try await trackingEventsAPI.sendEvent(with: eventData)

Sources/CorePayments/Networking/HTTPResponse.swift

@@ -5,6 +5,6 @@ public struct HTTPResponse {
 
     let status: Int
     let body: Data?
-    
+
     var isSuccessful: Bool { (200..<300).contains(status) }
 }

Sources/PayPalNativePayments/NativeCheckoutProvider.swift

@@ -7,6 +7,9 @@ import CorePayments
 
 class NativeCheckoutProvider: NativeCheckoutStartable {
 
+    /// Used in POST body for FPTI analytics.
+    var correlationID: String?
+
     private let checkout: CheckoutProtocol.Type
 
     init(_ mxo: CheckoutProtocol.Type = Checkout.self) {
@@ -32,6 +35,7 @@ class NativeCheckoutProvider: NativeCheckoutStartable {
                     createOrderAction.set(orderId: orderID)
                 },
                 onApprove: { approval in
+                    self.correlationID = approval.data.correlationIDs.riskCorrelationID
                     onStartableApprove(approval.data.ecToken, approval.data.payerID)
                 },
                 onShippingChange: { shippingChangeData, shippingChangeActions in
@@ -46,6 +50,7 @@ class NativeCheckoutProvider: NativeCheckoutStartable {
                 },
                 onCancel: { onStartableCancel() },
                 onError: { error in
+                    self.correlationID = error.correlationIDs.riskCorrelationID
                     onStartableError(error.reason)
                 }
             )

Sources/PayPalNativePayments/NativeCheckoutStartable.swift

@@ -6,7 +6,10 @@ import CorePayments
 #endif
 
 protocol NativeCheckoutStartable {
-
+
+    /// Used in POST body for FPTI analytics.
+    var correlationID: String? { get set }
+
     typealias StartableApproveCallback = (String, String) -> Void
     typealias StartableShippingCallback = (
         ShippingChangeType,
@@ -17,7 +20,6 @@ protocol NativeCheckoutStartable {
     typealias StartableCancelCallback = () -> Void
     typealias StartableErrorCallback = (String) -> Void
 
-
     // swiftlint:disable:next function_parameter_count
     func start(
         presentingViewController: UIViewController?,

Sources/PayPalNativePayments/PayPalNativeCheckoutClient.swift

@@ -10,6 +10,9 @@ public class PayPalNativeCheckoutClient {
 
     public weak var delegate: PayPalNativeCheckoutDelegate?
     public weak var shippingDelegate: PayPalNativeShippingDelegate?
+
+    /// Used in POST body for FPTI analytics.
+    private var correlationID: String?
     private let nativeCheckoutProvider: NativeCheckoutStartable
     private let networkingClient: NetworkingClient
     private let config: CoreConfig
@@ -40,6 +43,7 @@ public class PayPalNativeCheckoutClient {
         request: PayPalNativeCheckoutRequest,
         presentingViewController: UIViewController? = nil
     ) async {
+        correlationID = State.correlationIDs.riskCorrelationID
         analyticsService = AnalyticsService(coreConfig: config, orderID: request.orderID)
 
         let nxoConfig = CheckoutConfig(
@@ -62,6 +66,7 @@ public class PayPalNativeCheckoutClient {
                     orderID: ecToken,
                     payerID: payerID
                 )
+
                 self.notifySuccess(for: result)
             },
             onStartableShippingChange: { shippingType, shippingAction, shippingAddress, shippingMethod in
@@ -91,19 +96,19 @@ public class PayPalNativeCheckoutClient {
     }
 
     private func notifySuccess(for result: PayPalNativeCheckoutResult) {
-        analyticsService?.sendEvent("paypal-native-payments:succeeded")
+        analyticsService?.sendEvent("paypal-native-payments:succeeded", correlationID: nativeCheckoutProvider.correlationID)
         delegate?.paypal(self, didFinishWithResult: result)
     }
 
     private func notifyFailure(with errorDescription: String) {
-        analyticsService?.sendEvent("paypal-native-payments:failed")
-        
+        analyticsService?.sendEvent("paypal-native-payments:failed", correlationID: nativeCheckoutProvider.correlationID)
+
         let error = PayPalNativePaymentsError.nativeCheckoutSDKError(errorDescription)
         delegate?.paypal(self, didFinishWithError: error)
     }
 
     private func notifyCancellation() {
-        analyticsService?.sendEvent("paypal-native-payments:canceled")
+        analyticsService?.sendEvent("paypal-native-payments:canceled", correlationID: correlationID)
         delegate?.paypalDidCancel(self)
     }
 

UnitTests/PayPalNativePaymentsTests/MockNativeCheckoutProvider.swift

@@ -7,15 +7,15 @@ import PayPalCheckout
 import XCTest
 
 class MockNativeCheckoutProvider: NativeCheckoutStartable {
-
-    required init(nxoConfig: CheckoutConfig) {
-    }
-
+
+    var correlationID: String?
     var onCancel: StartableCancelCallback?
     var onError: StartableErrorCallback?
     var onApprove: StartableApproveCallback?
     var onShippingChange: StartableShippingCallback?
 
+    required init(nxoConfig: CheckoutConfig) { }
+
     // todo: implemenet cases for other callbacks
     func start(
         presentingViewController: UIViewController?,

UnitTests/PaymentsCoreTests/AnalyticsEventData_Tests.swift

@@ -14,7 +14,8 @@ class AnalyticsEventData_Tests: XCTestCase {
             environment: "fake-env",
             eventName: "fake-name",
             clientID: "fake-client-id",
-            orderID: "fake-order"
+            orderID: "fake-order",
+            correlationID: "fake-correlation-id"
         )
     }
 
@@ -31,7 +32,8 @@ class AnalyticsEventData_Tests: XCTestCase {
         XCTAssertEqual(eventParams["app_name"] as? String, "xctest")
         XCTAssertTrue((eventParams["c_sdk_ver"] as! String).matches("^\\d+\\.\\d+\\.\\d+(-[0-9a-zA-Z-]+)?$"))
         XCTAssertTrue((eventParams["client_os"] as! String).matches("iOS \\d+\\.\\d+|iPadOS \\d+\\.\\d+"))
-        XCTAssertEqual(eventParams["comp"] as? String, "ppcpmobilesdk")
+        XCTAssertEqual(eventParams["comp"] as? String, "ppcpclientsdk")
+        XCTAssertEqual(eventParams["correlation_id"] as! String, "fake-correlation-id")
         XCTAssertEqual(eventParams["device_manufacturer"] as? String, "Apple")
         XCTAssertEqual(eventParams["merchant_sdk_env"] as? String, "fake-env")
         XCTAssertEqual(eventParams["event_name"] as? String, "fake-name")

UnitTests/PaymentsCoreTests/AnalyticsService_Tests.swift

@@ -22,11 +22,12 @@ class AnalyticsService_Tests: XCTestCase {
     // MARK: - sendEvent()
 
     func testSendEvent_sendsAppropriateAnalyticsEventData() async {
-        await sut.performEventRequest("some-event")
-        
+        await sut.performEventRequest("some-event", correlationID: "fake-correlation-id")
+
         XCTAssertEqual(mockTrackingEventsAPI.capturedAnalyticsEventData?.eventName, "some-event")
         XCTAssertEqual(mockTrackingEventsAPI.capturedAnalyticsEventData?.clientID, "some-client-id")
         XCTAssertEqual(mockTrackingEventsAPI.capturedAnalyticsEventData?.orderID, "some-order-id")
+        XCTAssertEqual(mockTrackingEventsAPI.capturedAnalyticsEventData?.correlationID, "fake-correlation-id")
     }
 
     func testSendEvent_whenLive_sendsAppropriateEnvName() async {

UnitTests/PaymentsCoreTests/TrackingEventsAPI_Tests.swift

@@ -15,7 +15,8 @@ class TrackingEventsAPI_Tests: XCTestCase {
         environment: "my-env",
         eventName: "my-event-name",
         clientID: "my-id",
-        orderID: "my-order"
+        orderID: "my-order",
+        correlationID: nil
     )
 
     // MARK: - Test Lifecycle
@@ -41,7 +42,8 @@ class TrackingEventsAPI_Tests: XCTestCase {
             environment: "my-env",
             eventName: "my-event-name",
             clientID: "my-id",
-            orderID: "my-order"
+            orderID: "my-order",
+            correlationID: "fake-correlation-id"
         )
         _ = try await sut.sendEvent(with: fakeAnalyticsEventData)
 
@@ -54,6 +56,7 @@ class TrackingEventsAPI_Tests: XCTestCase {
         XCTAssertEqual(postData.eventName, "my-event-name")
         XCTAssertEqual(postData.clientID, "my-id")
         XCTAssertEqual(postData.orderID, "my-order")
+        XCTAssertEqual(postData.correlationID, "fake-correlation-id")
     }
 
     func testSendEvent_whenSuccess_bubblesHTTPResponse() async throws {