Bugfix - send analytics even when BTAPIClient deallocated

Braintree.xcodeproj/project.pbxproj

@@ -121,6 +121,7 @@
 		8075CBEE2B1B735200CA6265 /* BTAPIRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8075CBED2B1B735200CA6265 /* BTAPIRequest.swift */; };
 		80842DA72B8E49EF00A5CD92 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = 80842DA62B8E49EF00A5CD92 /* PrivacyInfo.xcprivacy */; };
 		8087C10F2BFBACCA0020FC2E /* TokenizationKey_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8087C10E2BFBACCA0020FC2E /* TokenizationKey_Tests.swift */; };
+		808E4A162C581CD40006A737 /* AnalyticsSendable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 808E4A152C581CD40006A737 /* AnalyticsSendable.swift */; };
 		80A6C6192B21205900416D50 /* UIApplication+URLOpener.swift in Sources */ = {isa = PBXBuildFile; fileRef = 80A6C6182B21205900416D50 /* UIApplication+URLOpener.swift */; };
 		80AB424F2B27CAC200249218 /* BraintreeTestShared.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = A903E1A624F9D34000C314E1 /* BraintreeTestShared.framework */; platformFilter = ios; };
 		80AB42542B27DF5B00249218 /* BraintreeCore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 570B93AC285397520041BAFE /* BraintreeCore.framework */; platformFilter = ios; };
@@ -860,6 +861,7 @@
 		8075CBED2B1B735200CA6265 /* BTAPIRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTAPIRequest.swift; sourceTree = "<group>"; };
 		80842DA62B8E49EF00A5CD92 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		8087C10E2BFBACCA0020FC2E /* TokenizationKey_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TokenizationKey_Tests.swift; sourceTree = "<group>"; };
+		808E4A152C581CD40006A737 /* AnalyticsSendable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnalyticsSendable.swift; sourceTree = "<group>"; };
 		80A1EE3D2236AAC600F6218B /* BTThreeDSecureAdditionalInformation_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureAdditionalInformation_Tests.swift; sourceTree = "<group>"; };
 		80A6C6182B21205900416D50 /* UIApplication+URLOpener.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UIApplication+URLOpener.swift"; sourceTree = "<group>"; };
 		80AD35F12BFBB1DD00BF890E /* TokenizationKeyError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TokenizationKeyError.swift; sourceTree = "<group>"; };
@@ -1591,6 +1593,7 @@
 		80F4F4D529F8A628003EACB1 /* Analytics */ = {
 			isa = PBXGroup;
 			children = (
+				808E4A152C581CD40006A737 /* AnalyticsSendable.swift */,
 				BE549F132BF6576300B6F441 /* BTAnalyticsEventsStorage.swift */,
 				BEE2E4E329007FF100C03FDD /* BTAnalyticsService.swift */,
 				BEE2E4E5290080BD00C03FDD /* BTAnalyticsServiceError.swift */,
@@ -3318,6 +3321,7 @@
 				574891E9286F7D300020DA36 /* BTClientMetadataSource.swift in Sources */,
 				BED7493628579BAC0074C818 /* BTURLUtils.swift in Sources */,
 				BEBD05222A1FE8BE0003C15C /* BTWebAuthenticationSession.swift in Sources */,
+				808E4A162C581CD40006A737 /* AnalyticsSendable.swift in Sources */,
 				BE698EA028AA8DCB001D9B10 /* BTHTTP.swift in Sources */,
 				BC17F9B428D23C5C004B18CC /* BTGraphQLMultiErrorNode.swift in Sources */,
 				5708E0A828809BC6007946B9 /* BTJSONError.swift in Sources */,

CHANGELOG.md

@@ -1,12 +1,16 @@
 # Braintree iOS SDK Release Notes
 
+## unreleased
+* BraintreeCore
+  * Fix bug where analytics wouldn't send on `BTAPIClient` instantiation on button click
+  * Update `endpoint` syntax sent to FPTI for 3D Secure and Venmo flows
+
 ## 6.23.1 (2024-07-24)
 * BraintreeThreeDSecure
   * Add error code and error message for `exceededTimeoutLimit`  
 * BraintreeCore
   * Prevent duplicate outbound `v1/configuration` requests
   * Add network timeout of 30 seconds
-  * Update `endpoint` syntax sent to FPTI for 3D Secure and Venmo flows
 
 ## 6.23.0 (2024-07-15)
 * BraintreeShopperInsights (BETA)

Sources/BraintreeCore/Analytics/AnalyticsSendable.swift

@@ -0,0 +1,7 @@
+/// Describes a class that batches and sends analytics events.
+/// - Note: Specifically created to mock the `BTAnalyticsService` singleton.
+protocol AnalyticsSendable: AnyObject {
+
+    func sendAnalyticsEvent(_ event: FPTIBatchData.Event)
+    func setAPIClient(_ apiClient: BTAPIClient)
+}

Sources/BraintreeCore/Analytics/BTAnalyticsService.swift

@@ -1,8 +1,10 @@
 import Foundation
 
-class BTAnalyticsService: Equatable {
+class BTAnalyticsService: AnalyticsSendable {
 
     // MARK: - Internal Properties
+
+    static let shared = BTAnalyticsService()
 
     // swiftlint:disable force_unwrapping
     /// The FPTI URL to post all analytic events.
@@ -17,110 +19,52 @@ class BTAnalyticsService: Equatable {
 
     // MARK: - Private Properties
 
-    private static let events = BTAnalyticsEventsStorage()
+    private let events = BTAnalyticsEventsStorage()
 
     /// Amount of time, in seconds, between batch API requests sent to FPTI
     private static let timeInterval = 15
 
-    private static let timer = RepeatingTimer(timeInterval: timeInterval)
+    private let timer = RepeatingTimer(timeInterval: timeInterval)
 
-    private let apiClient: BTAPIClient
-
+    private var apiClient: BTAPIClient?
+            
     // MARK: - Initializer
-
-    init(apiClient: BTAPIClient) {
+
+    private init() { }
+
+    /// Used to inject `BTAPIClient` dependency into `BTAnalyticsService` singleton
+    func setAPIClient(_ apiClient: BTAPIClient) {
         self.apiClient = apiClient
         self.http = BTHTTP(authorization: apiClient.authorization, customBaseURL: Self.url)
 
-        Self.timer.eventHandler = { [weak self] in
+        self.timer.eventHandler = { [weak self] in
             guard let self else { return }
             Task {
                 await self.sendQueuedAnalyticsEvents()
             }
         }
-        Self.timer.resume()
+        self.timer.resume()
     }
 
     // MARK: - Deinit
 
     deinit {
-        Self.timer.suspend()
+        self.timer.suspend()
     }
 
     // MARK: - Internal Methods
 
     /// Sends analytics event to https://api.paypal.com/v1/tracking/batch/events/ via a background task.
-    /// - Parameters:
-    ///   - eventName: Name of analytic event.
-    ///   - correlationID: Optional. CorrelationID associated with the checkout session.
-    ///   - endpoint: Optional. The endpoint of the API request send during networking requests.
-    ///   - endTime: Optional. The end time of the roundtrip networking request.
-    ///   - errorDescription: Optional. Full error description returned to merchant.
-    ///   - isVaultRequest: Optional. If the Venmo or PayPal request is being vaulted.
-    ///   - linkType: Optional. The type of link the SDK will be handling, currently deeplink or universal.
-    ///   - payPalContextID: Optional. PayPal Context ID associated with the checkout session.
-    ///   - startTime: Optional. The start time of the networking request.
-    func sendAnalyticsEvent(
-        _ eventName: String,
-        connectionStartTime: Int? = nil,
-        correlationID: String? = nil,
-        endpoint: String? = nil,
-        endTime: Int? = nil,
-        errorDescription: String? = nil,
-        isVaultRequest: Bool? = nil,
-        linkType: String? = nil,
-        payPalContextID: String? = nil,
-        requestStartTime: Int? = nil,
-        startTime: Int? = nil
-    ) {
+    /// - Parameter event: A single `FPTIBatchData.Event`
+    func sendAnalyticsEvent(_ event: FPTIBatchData.Event) {
         Task(priority: .background) {
-            await performEventRequest(
-                eventName,
-                connectionStartTime: connectionStartTime,
-                correlationID: correlationID,
-                endpoint: endpoint,
-                endTime: endTime,
-                errorDescription: errorDescription,
-                isVaultRequest: isVaultRequest,
-                linkType: linkType,
-                payPalContextID: payPalContextID,
-                requestStartTime: requestStartTime,
-                startTime: startTime
-            )
+            await performEventRequest(event)
         }
     }
 
     /// Exposed to be able to execute this function synchronously in unit tests
-    func performEventRequest(
-        _ eventName: String,
-        connectionStartTime: Int? = nil,
-        correlationID: String? = nil,
-        endpoint: String? = nil,
-        endTime: Int? = nil,
-        errorDescription: String? = nil,
-        isVaultRequest: Bool? = nil,
-        linkType: String? = nil,
-        payPalContextID: String? = nil,
-        requestStartTime: Int? = nil,
-        startTime: Int? = nil
-    ) async {
-        let timestampInMilliseconds = Date().utcTimestampMilliseconds
-        let event = FPTIBatchData.Event(
-            connectionStartTime: connectionStartTime,
-            correlationID: correlationID,
-            endpoint: endpoint,
-            endTime: endTime,
-            errorDescription: errorDescription,
-            eventName: eventName,
-            isVaultRequest: isVaultRequest,
-            linkType: linkType,
-            payPalContextID: payPalContextID,
-            requestStartTime: requestStartTime,
-            startTime: startTime,
-            timestamp: String(timestampInMilliseconds)
-        )
-
-        await BTAnalyticsService.events.append(event)
+    func performEventRequest(_ event: FPTIBatchData.Event) async {
+        await events.append(event)
 
         if shouldBypassTimerQueue {
             await self.sendQueuedAnalyticsEvents()
@@ -130,16 +74,16 @@ class BTAnalyticsService: Equatable {
     // MARK: - Helpers
 
     func sendQueuedAnalyticsEvents() async {
-        if await !BTAnalyticsService.events.isEmpty {
+        if await !events.isEmpty, let apiClient {
             do {
                 let configuration = try await apiClient.fetchConfiguration()
                 let postParameters = await createAnalyticsEvent(
                     config: configuration,
                     sessionID: apiClient.metadata.sessionID,
-                    events: Self.events.allValues
+                    events: events.allValues
                 )
                 http?.post("v1/tracking/batch/events", parameters: postParameters) { _, _, _ in }
-                await Self.events.removeAll()
+                await events.removeAll()
             } catch {
                 return
             }
@@ -149,20 +93,14 @@ class BTAnalyticsService: Equatable {
     /// Constructs POST params to be sent to FPTI
     func createAnalyticsEvent(config: BTConfiguration, sessionID: String, events: [FPTIBatchData.Event]) -> Codable {
         let batchMetadata = FPTIBatchData.Metadata(
-            authorizationFingerprint: apiClient.authorization.type == .clientToken ? apiClient.authorization.bearer : nil,
+            authorizationFingerprint: apiClient?.authorization.type == .clientToken ? apiClient?.authorization.bearer : nil,
             environment: config.fptiEnvironment,
-            integrationType: apiClient.metadata.integration.stringValue,
+            integrationType: apiClient?.metadata.integration.stringValue ?? BTClientMetadataIntegration.custom.stringValue,
             merchantID: config.merchantID,
             sessionID: sessionID,
-            tokenizationKey: apiClient.authorization.type == .tokenizationKey ? apiClient.authorization.originalValue : nil
+            tokenizationKey: apiClient?.authorization.type == .tokenizationKey ? apiClient?.authorization.originalValue : nil
         )
 
         return FPTIBatchData(metadata: batchMetadata, events: events)
     }
-
-    // MARK: Equitable Protocol Conformance
-
-    static func == (lhs: BTAnalyticsService, rhs: BTAnalyticsService) -> Bool {
-        lhs.http == rhs.http && lhs.apiClient == rhs.apiClient
-    }
 }

Sources/BraintreeCore/Analytics/FPTIBatchData.swift

@@ -53,9 +53,35 @@ struct FPTIBatchData: Codable {
         let requestStartTime: Int?
         /// UTC millisecond timestamp when a networking task initiated.
         let startTime: Int?
-        let timestamp: String
+        let timestamp = String(Date().utcTimestampMilliseconds)
         let tenantName: String = "Braintree"
         let venmoInstalled: Bool = application.isVenmoAppInstalled()
+
+        init(
+            connectionStartTime: Int? = nil,
+            correlationID: String? = nil,
+            endpoint: String? = nil,
+            endTime: Int? = nil,
+            errorDescription: String? = nil,
+            eventName: String,
+            isVaultRequest: Bool? = nil,
+            linkType: String? = nil,
+            payPalContextID: String? = nil,
+            requestStartTime: Int? = nil,
+            startTime: Int? = nil
+        ) {
+            self.connectionStartTime = connectionStartTime
+            self.correlationID = correlationID
+            self.endpoint = endpoint
+            self.endTime = endTime
+            self.errorDescription = errorDescription
+            self.eventName = eventName
+            self.isVaultRequest = isVaultRequest
+            self.linkType = linkType
+            self.payPalContextID = payPalContextID
+            self.requestStartTime = requestStartTime
+            self.startTime = startTime
+        }
 
         enum CodingKeys: String, CodingKey {
             case connectionStartTime = "connect_start_time"

Sources/BraintreeCore/BTAPIClient.swift

@@ -25,14 +25,7 @@ import Foundation
     var configurationLoader: ConfigurationLoader
 
     /// Exposed for testing analytics
-    /// By default, the `BTAnalyticsService` instance is static/shared so that only one queue of events exists.
-    /// The "singleton" is managed here because the analytics service depends on `BTAPIClient`.
-    weak var analyticsService: BTAnalyticsService? {
-        get { BTAPIClient._analyticsService }
-        set { BTAPIClient._analyticsService = newValue }
-    }
-
-    private static var _analyticsService: BTAnalyticsService?
+    weak var analyticsService: AnalyticsSendable? = BTAnalyticsService.shared
 
     // MARK: - Initializers
 
@@ -65,7 +58,7 @@ import Foundation
         configurationLoader = ConfigurationLoader(http: btHttp)
 
         super.init()
-        BTAPIClient._analyticsService = BTAnalyticsService(apiClient: self)
+        analyticsService?.setAPIClient(self)
         http?.networkTimingDelegate = self
 
         // Kickoff the background request to fetch the config
@@ -319,14 +312,14 @@ import Foundation
         linkType: String? = nil,
         payPalContextID: String? = nil
     ) {
-        analyticsService?.sendAnalyticsEvent(
-            eventName,
+        analyticsService?.sendAnalyticsEvent(FPTIBatchData.Event(
             correlationID: correlationID,
             errorDescription: errorDescription,
+            eventName: eventName,
             isVaultRequest: isVaultRequest,
             linkType: linkType,
             payPalContextID: payPalContextID
-        )
+        ))
     }
 
     // MARK: Analytics Internal Methods
@@ -409,14 +402,14 @@ import Foundation
         )
 
         if cleanedPath != "/v1/tracking/batch/events" {
-            analyticsService?.sendAnalyticsEvent(
-                BTCoreAnalytics.apiRequestLatency,
+            analyticsService?.sendAnalyticsEvent(FPTIBatchData.Event(
                 connectionStartTime: connectionStartTime,
                 endpoint: cleanedPath,
                 endTime: endTime,
+                eventName: BTCoreAnalytics.apiRequestLatency,
                 requestStartTime: requestStartTime,
                 startTime: startTime
-            )
+            ))
         }
     }
 }

UnitTests/BraintreeCoreTests/Analytics/BTAnalyticsService_Tests.swift

@@ -15,23 +15,25 @@ final class BTAnalyticsService_Tests: XCTestCase {
 
     func testSendAnalyticsEvent_whenConfigFetchCompletes_setsUpAnalyticsHTTPToUseBaseURL() async {
         let stubAPIClient: MockAPIClient = stubbedAPIClientWithAnalyticsURL("test://do-not-send.url")
-        let analyticsService = BTAnalyticsService(apiClient: stubAPIClient)
+        let sut = BTAnalyticsService.shared
+        sut.setAPIClient(stubAPIClient)
 
-        await analyticsService.performEventRequest("any.analytics.event")
+        await sut.performEventRequest(FPTIBatchData.Event(eventName: "any.analytics.event"))
 
-        XCTAssertEqual(analyticsService.http?.customBaseURL?.absoluteString, "https://api.paypal.com")
+        XCTAssertEqual(sut.http?.customBaseURL?.absoluteString, "https://api.paypal.com")
     }
 
     func testSendAnalyticsEvent_sendsAnalyticsEvent() async {
         let stubAPIClient: MockAPIClient = stubbedAPIClientWithAnalyticsURL("test://do-not-send.url")
         let mockAnalyticsHTTP = FakeHTTP.fakeHTTP()
-        let analyticsService = BTAnalyticsService(apiClient: stubAPIClient)
-        analyticsService.shouldBypassTimerQueue = true
+        let sut = BTAnalyticsService.shared
+        sut.setAPIClient(stubAPIClient)
+        sut.shouldBypassTimerQueue = true
 
-        analyticsService.http = mockAnalyticsHTTP
-
-        await analyticsService.performEventRequest("any.analytics.event")
+        sut.http = mockAnalyticsHTTP
 
+        await sut.performEventRequest(FPTIBatchData.Event(eventName: "any.analytics.event"))
+
         XCTAssertEqual(mockAnalyticsHTTP.lastRequestEndpoint, "v1/tracking/batch/events")
 
         let timestamp = parseTimestamp(mockAnalyticsHTTP.lastRequestParameters)!