[Diagnostics] Refactor diagnostics track methods to handle background…

… work automatically (#4270) * Refactor diagnostics track methods to handle background work automaticaly * fix swiftlint
RevenueCat · Oct 1, 2024 · f47dc6f · f47dc6f
1 parent 86edabb
commit f47dc6f
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 101 deletions.
diff --git a/Sources/Diagnostics/DiagnosticsTracker.swift b/Sources/Diagnostics/DiagnosticsTracker.swift
@@ -16,10 +16,10 @@ import Foundation
 protocol DiagnosticsTrackerType {
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
-    func track(_ event: DiagnosticsEvent) async
+    func track(_ event: DiagnosticsEvent)
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
-    func trackCustomerInfoVerificationResultIfNeeded(_ customerInfo: CustomerInfo) async
+    func trackCustomerInfoVerificationResultIfNeeded(_ customerInfo: CustomerInfo)
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     // swiftlint:disable:next function_parameter_count
@@ -28,7 +28,7 @@ protocol DiagnosticsTrackerType {
                               errorMessage: String?,
                               errorCode: Int?,
                               storeKitErrorDescription: String?,
-                              responseTime: TimeInterval) async
+                              responseTime: TimeInterval)
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     // swiftlint:disable:next function_parameter_count
@@ -38,37 +38,42 @@ protocol DiagnosticsTrackerType {
                                    responseCode: Int,
                                    backendErrorCode: Int?,
                                    resultOrigin: HTTPResponseOrigin?,
-                                   verificationResult: VerificationResult) async
+                                   verificationResult: VerificationResult)
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func trackPurchaseRequest(wasSuccessful: Bool,
                               storeKitVersion: StoreKitVersion,
                               errorMessage: String?,
                               errorCode: Int?,
-                              storeKitErrorDescription: String?) async
+                              storeKitErrorDescription: String?)
 
 }
 
 @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
-final class DiagnosticsTracker: DiagnosticsTrackerType {
+final class DiagnosticsTracker: DiagnosticsTrackerType, Sendable {
 
     private let diagnosticsFileHandler: DiagnosticsFileHandlerType
+    private let diagnosticsDispatcher: OperationDispatcher
     private let dateProvider: DateProvider
 
     init(diagnosticsFileHandler: DiagnosticsFileHandlerType,
+         diagnosticsDispatcher: OperationDispatcher = .default,
          dateProvider: DateProvider = DateProvider()) {
         self.diagnosticsFileHandler = diagnosticsFileHandler
+        self.diagnosticsDispatcher = diagnosticsDispatcher
         self.dateProvider = dateProvider
     }
 
-    func track(_ event: DiagnosticsEvent) async {
-        await self.clearDiagnosticsFileIfTooBig()
-        await self.diagnosticsFileHandler.appendEvent(diagnosticsEvent: event)
+    func track(_ event: DiagnosticsEvent) {
+        self.diagnosticsDispatcher.dispatchOnWorkerThread {
+            await self.clearDiagnosticsFileIfTooBig()
+            await self.diagnosticsFileHandler.appendEvent(diagnosticsEvent: event)
+        }
     }
 
     func trackCustomerInfoVerificationResultIfNeeded(
         _ customerInfo: CustomerInfo
-    ) async {
+    ) {
         let verificationResult = customerInfo.entitlements.verification
         if verificationResult == .notRequested {
             return
@@ -79,7 +84,7 @@ final class DiagnosticsTracker: DiagnosticsTrackerType {
             properties: [.verificationResultKey: AnyEncodable(verificationResult.name)],
             timestamp: self.dateProvider.now()
         )
-        await track(event)
+        self.track(event)
     }
 
     // swiftlint:disable:next function_parameter_count
@@ -88,8 +93,8 @@ final class DiagnosticsTracker: DiagnosticsTrackerType {
                               errorMessage: String?,
                               errorCode: Int?,
                               storeKitErrorDescription: String?,
-                              responseTime: TimeInterval) async {
-        await track(
+                              responseTime: TimeInterval) {
+        self.track(
             DiagnosticsEvent(eventType: .appleProductsRequest,
                              properties: [
                                 .successfulKey: AnyEncodable(wasSuccessful),
@@ -110,8 +115,8 @@ final class DiagnosticsTracker: DiagnosticsTrackerType {
                                    responseCode: Int,
                                    backendErrorCode: Int?,
                                    resultOrigin: HTTPResponseOrigin?,
-                                   verificationResult: VerificationResult) async {
-        await track(
+                                   verificationResult: VerificationResult) {
+        self.track(
             DiagnosticsEvent(
                 eventType: DiagnosticsEvent.EventType.httpRequestPerformed,
                 properties: [
@@ -132,8 +137,8 @@ final class DiagnosticsTracker: DiagnosticsTrackerType {
                               storeKitVersion: StoreKitVersion,
                               errorMessage: String?,
                               errorCode: Int?,
-                              storeKitErrorDescription: String?) async {
-        await track(
+                              storeKitErrorDescription: String?) {
+        self.track(
             DiagnosticsEvent(eventType: .applePurchaseAttempt,
                              properties: [
                                 .successfulKey: AnyEncodable(wasSuccessful),
@@ -154,14 +159,14 @@ private extension DiagnosticsTracker {
     func clearDiagnosticsFileIfTooBig() async {
         if await self.diagnosticsFileHandler.isDiagnosticsFileTooBig() {
             await self.diagnosticsFileHandler.emptyDiagnosticsFile()
-            await self.trackMaxEventsStoredLimitReached()
+            self.trackMaxEventsStoredLimitReached()
         }
     }
 
-    func trackMaxEventsStoredLimitReached() async {
-        await self.track(.init(eventType: .maxEventsStoredLimitReached,
-                               properties: [:],
-                               timestamp: self.dateProvider.now()))
+    func trackMaxEventsStoredLimitReached() {
+        self.track(.init(eventType: .maxEventsStoredLimitReached,
+                         properties: [:],
+                         timestamp: self.dateProvider.now()))
     }
 
 }
diff --git a/Sources/Identity/CustomerInfoManager.swift b/Sources/Identity/CustomerInfoManager.swift
@@ -284,9 +284,7 @@ class CustomerInfoManager {
 
             if #available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *) {
                 if let tracker = self.diagnosticsTracker, lastSentCustomerInfo != customerInfo {
-                    Task(priority: .background) {
-                        await tracker.trackCustomerInfoVerificationResultIfNeeded(customerInfo)
-                    }
+                    tracker.trackCustomerInfoVerificationResultIfNeeded(customerInfo)
                 }
             }
 

diff --git a/Sources/Networking/HTTPClient/HTTPClient.swift b/Sources/Networking/HTTPClient/HTTPClient.swift
@@ -582,33 +582,31 @@ private extension HTTPClient {
             guard let diagnosticsTracker = self.diagnosticsTracker, let result else { return }
             let responseTime = self.dateProvider.now().timeIntervalSince(requestStartTime)
             let requestPathName = request.httpRequest.path.name
-            Task(priority: .background) {
-                switch result {
-                case let .success(response):
-                    let httpStatusCode = response.httpStatusCode.rawValue
-                    let verificationResult = response.verificationResult
-                    await diagnosticsTracker.trackHttpRequestPerformed(endpointName: requestPathName,
-                                                                       responseTime: responseTime,
-                                                                       wasSuccessful: true,
-                                                                       responseCode: httpStatusCode,
-                                                                       backendErrorCode: nil,
-                                                                       resultOrigin: response.origin,
-                                                                       verificationResult: verificationResult)
-                case let .failure(error):
-                    var responseCode = -1
-                    var backendErrorCode: Int?
-                    if case let .errorResponse(errorResponse, code, _) = error {
-                        responseCode = code.rawValue
-                        backendErrorCode = errorResponse.code.rawValue
-                    }
-                    await diagnosticsTracker.trackHttpRequestPerformed(endpointName: requestPathName,
-                                                                       responseTime: responseTime,
-                                                                       wasSuccessful: false,
-                                                                       responseCode: responseCode,
-                                                                       backendErrorCode: backendErrorCode,
-                                                                       resultOrigin: nil,
-                                                                       verificationResult: .notRequested)
+            switch result {
+            case let .success(response):
+                let httpStatusCode = response.httpStatusCode.rawValue
+                let verificationResult = response.verificationResult
+                diagnosticsTracker.trackHttpRequestPerformed(endpointName: requestPathName,
+                                                             responseTime: responseTime,
+                                                             wasSuccessful: true,
+                                                             responseCode: httpStatusCode,
+                                                             backendErrorCode: nil,
+                                                             resultOrigin: response.origin,
+                                                             verificationResult: verificationResult)
+            case let .failure(error):
+                var responseCode = -1
+                var backendErrorCode: Int?
+                if case let .errorResponse(errorResponse, code, _) = error {
+                    responseCode = code.rawValue
+                    backendErrorCode = errorResponse.code.rawValue
                 }
+                diagnosticsTracker.trackHttpRequestPerformed(endpointName: requestPathName,
+                                                             responseTime: responseTime,
+                                                             wasSuccessful: false,
+                                                             responseCode: responseCode,
+                                                             backendErrorCode: backendErrorCode,
+                                                             resultOrigin: nil,
+                                                             verificationResult: .notRequested)
             }
         }
     }

diff --git a/Sources/Purchasing/ProductsManager.swift b/Sources/Purchasing/ProductsManager.swift
@@ -145,14 +145,12 @@ private extension ProductsManager {
                 ?? error?.localizedDescription
             let errorCode = error?.errorCode
             let storeKitErrorDescription = StoreKitErrorUtils.extractStoreKitErrorDescription(from: error)
-            Task(priority: .background) {
-                await diagnosticsTracker.trackProductsRequest(wasSuccessful: error == nil,
-                                                              storeKitVersion: storeKitVersion,
-                                                              errorMessage: errorMessage,
-                                                              errorCode: errorCode,
-                                                              storeKitErrorDescription: storeKitErrorDescription,
-                                                              responseTime: responseTime)
-            }
+            diagnosticsTracker.trackProductsRequest(wasSuccessful: error == nil,
+                                                    storeKitVersion: storeKitVersion,
+                                                    errorMessage: errorMessage,
+                                                    errorCode: errorCode,
+                                                    storeKitErrorDescription: storeKitErrorDescription,
+                                                    responseTime: responseTime)
         }
     }
 

diff --git a/Sources/Purchasing/Purchases/PurchasesOrchestrator.swift b/Sources/Purchasing/Purchases/PurchasesOrchestrator.swift
@@ -895,18 +895,15 @@ private extension PurchasesOrchestrator {
                                     error: PublicError?) {
         if #available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *),
         let diagnosticsTracker = self.diagnosticsTracker {
-            Task(priority: .background) {
-                let errorMessage =
-                (error?.userInfo[NSUnderlyingErrorKey] as? Error)?.localizedDescription ?? error?.localizedDescription
-                let errorCode = error?.code
-                let storeKitErrorDescription = StoreKitErrorUtils.extractStoreKitErrorDescription(from: error)
-
-                await diagnosticsTracker.trackPurchaseRequest(wasSuccessful: error == nil,
-                                                              storeKitVersion: storeKitVersion,
-                                                              errorMessage: errorMessage,
-                                                              errorCode: errorCode,
-                                                              storeKitErrorDescription: storeKitErrorDescription)
-            }
+            let errorMessage = (error?.userInfo[NSUnderlyingErrorKey] as? Error)?.localizedDescription
+                ?? error?.localizedDescription
+            let errorCode = error?.code
+            let storeKitErrorDescription = StoreKitErrorUtils.extractStoreKitErrorDescription(from: error)
+            diagnosticsTracker.trackPurchaseRequest(wasSuccessful: error == nil,
+                                                    storeKitVersion: storeKitVersion,
+                                                    errorMessage: errorMessage,
+                                                    errorCode: errorCode,
+                                                    storeKitErrorDescription: storeKitErrorDescription)
         }
     }