Feature/3.4.0 (#118)

* various bug fixes and internal improvements

Author: ren6

ApphudSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '3.3.8'
+  s.version          = '3.4.0'
   s.summary          = 'Build and Measure In-App Subscriptions on iOS.'
   s.description      = 'Apphud covers every aspect when it comes to In-App Subscriptions from integration to analytics on iOS and Android.'
   s.homepage         = 'https://github.com/apphud/ApphudSDK'

Examples/ApphudDemoSwift/ApphudSDKDemo/AppDelegate.swift

@@ -22,8 +22,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterD
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
 
-        Apphud.start(apiKey: "app_4sY9cLggXpMDDQMmvc5wXUPGReMp8G")
-//        Apphud.setDeviceIdentifiers(idfa: nil, idfv: UIDevice.current.identifierForVendor?.uuidString)
+        Apphud.start(apiKey: "YOUR_API_KEY")
+        Apphud.setDeviceIdentifiers(idfa: nil, idfv: UIDevice.current.identifierForVendor?.uuidString)
         fetchIDFA()
 
         /** Custom User Properties Examples */

Sources/Internal/ApphudAsyncStoreKit.swift

@@ -90,7 +90,7 @@ internal class ApphudAsyncStoreKit {
 
         do {
 
-            ApphudLoggerService.shared.paywallCheckoutInitiated(paywallId: apphudProduct?.paywallId, placementId: apphudProduct?.placementId, productId: product.id)
+            ApphudLoggerService.shared.paywallCheckoutInitiated(apphudProduct: apphudProduct, productId: product.id)
             #if os(iOS) || os(tvOS) || os(macOS) || os(watchOS)
             let result = try await product.purchase(options: options)
             #else

Sources/Internal/ApphudHttpClient.swift

@@ -25,8 +25,8 @@ internal struct ApphudAPIArrayResponse<T: Decodable>: Decodable {
 }
 
 typealias ApphudParsedResponse = (Bool, [String: Any]?, Data?, Error?, Int)
-typealias ApphudHTTPResponse = (Bool, [String: Any]?, Data?, Error?, Int, Double)
-typealias ApphudHTTPResponseCallback = (Bool, [String: Any]?, Data?, Error?, Int, Double) -> Void
+typealias ApphudHTTPResponse = (Bool, [String: Any]?, Data?, Error?, Int, Double, Int)
+typealias ApphudHTTPResponseCallback = (Bool, [String: Any]?, Data?, Error?, Int, Double, Int) -> Void
 typealias ApphudStringCallback = (String?, Error?) -> Void
 /**
  This is Apphud's internal class.
@@ -111,8 +111,8 @@ public class ApphudHttpClient {
         return URLSession.init(configuration: config)
     }()
 
-    private let GET_TIMEOUT: TimeInterval = 10.0
-    public var POST_CUSTOMERS_TIMEOUT: TimeInterval = 10.0
+    private let GET_TIMEOUT: TimeInterval = 7.0
+    public var POST_CUSTOMERS_TIMEOUT: TimeInterval = 7.0
     private let POST_TIMEOUT: TimeInterval = 20.0
 
     internal func requestInstance(url: URL) -> URLRequest? {
@@ -129,11 +129,11 @@ public class ApphudHttpClient {
         }
     }
 
-    internal func startRequest(path: ApphudEndpoint, apiVersion: ApphudApiVersion = .APIV1, params: [String: Any]?, method: ApphudHttpMethod, useDecoder: Bool = false, retry: Bool = false, callback: ApphudHTTPResponseCallback?) {
+    internal func startRequest(path: ApphudEndpoint, apiVersion: ApphudApiVersion = .APIV1, params: [String: Any]?, method: ApphudHttpMethod, useDecoder: Bool = false, retry: Bool = false, requestID: String? = nil, callback: ApphudHTTPResponseCallback?) {
 
         let timeout = path == .customers ? POST_CUSTOMERS_TIMEOUT : nil
 
-        if let request = makeRequest(path: path.value, apiVersion: apiVersion, params: params, method: method, defaultTimeout: timeout), !suspended {
+        if let request = makeRequest(path: path.value, apiVersion: apiVersion, params: params, method: method, defaultTimeout: timeout, requestID: requestID), !suspended {
             Task(priority: .userInitiated) {
 
                 let retries: Int
@@ -150,7 +150,7 @@ public class ApphudHttpClient {
                 let response = await start(request: request, useDecoder: useDecoder, retries: retries, delay: retryDelay)
 
                 Task { @MainActor in
-                    callback?(response.0, response.1, response.2, response.3, response.4, response.5)
+                    callback?(response.0, response.1, response.2, response.3, response.4, response.5, response.6)
                 }
             }
         } else {
@@ -226,11 +226,7 @@ public class ApphudHttpClient {
         return nil
     }
 
-    private var requestID: String {
-        UUID().uuidString.lowercased().replacingOccurrences(of: "-", with: "") + "_" + String(Date().timeIntervalSince1970)
-    }
-
-    private func makeRequest(path: String, apiVersion: ApphudApiVersion, params: [String: Any]?, method: ApphudHttpMethod, defaultTimeout: TimeInterval? = nil) -> URLRequest? {
+    private func makeRequest(path: String, apiVersion: ApphudApiVersion, params: [String: Any]?, method: ApphudHttpMethod, defaultTimeout: TimeInterval? = nil, requestID: String? = nil) -> URLRequest? {
 
         var request: URLRequest?
 
@@ -240,7 +236,7 @@ public class ApphudHttpClient {
 
         if method == .get {
             var components = URLComponents(string: urlString)
-            var items: [URLQueryItem] = [URLQueryItem(name: "api_key", value: apiKey), URLQueryItem(name: "request_id", value: requestID)]
+            var items: [URLQueryItem] = [URLQueryItem(name: "api_key", value: apiKey)]
             if let requestParams = params {
                 for key in requestParams.keys {
                     items.append(URLQueryItem(name: key, value: (requestParams[key] as? LosslessStringConvertible)?.description))
@@ -266,13 +262,14 @@ public class ApphudHttpClient {
         request?.setValue("application/json; charset=utf-8", forHTTPHeaderField: "Accept")
         request?.setValue(platform, forHTTPHeaderField: "X-Platform")
         request?.setValue(self.sdkType, forHTTPHeaderField: "X-SDK")
+        request?.setValue(requestID ?? UUID().uuidString, forHTTPHeaderField: "Idempotency-Key")
         request?.setValue(sdkVersion, forHTTPHeaderField: "X-SDK-VERSION")
         request?.setValue("Apphud \(platform) (\(self.sdkType) \(sdkVersion))", forHTTPHeaderField: "User-Agent")
 
         request?.timeoutInterval = defaultTimeout ?? (method == .get ? GET_TIMEOUT : POST_TIMEOUT)
 
         if method != .get {
-            var finalParams: [String: Any] = ["api_key": apiKey, "request_id": requestID]
+            var finalParams: [String: Any] = ["api_key": apiKey]
             if params != nil {
                 finalParams.merge(params!, uniquingKeysWith: {$1})
             }
@@ -313,32 +310,40 @@ public class ApphudHttpClient {
         let method = request.httpMethod ?? ""
 
         do {
-            let (data, response) = retries > 0 ? try await URLSession.shared.data(for: request, retries: retries, delay: delay) : try await URLSession.shared.data(for: request)
+            let result: (Data, URLResponse, Int)
+            if retries > 0 {
+                result = try await URLSession.shared.data(for: request, retries: retries, delay: delay)
+            } else {
+                let resp = try await URLSession.shared.data(for: request)
+                result = (resp.0, resp.1, 1)
+            }
 
-            guard let httpResponse = response as? HTTPURLResponse else {
-                return (false, nil, nil, nil, NSURLErrorUnknown, 0)
+            guard let httpResponse = result.1 as? HTTPURLResponse else {
+                return (false, nil, nil, nil, NSURLErrorUnknown, 0, 1)
             }
 
-            let apphudResponse: ApphudParsedResponse = parseResponse(request: request, httpResponse: httpResponse, data: data, parseJson: !useDecoder || apphudIsSandbox())
+            let apphudResponse: ApphudParsedResponse = parseResponse(request: request, httpResponse: httpResponse, data: result.0, parseJson: !useDecoder || apphudIsSandbox())
 
             let requestDuration = Date().timeIntervalSince(startDate)
 
-            let finalHttpResponse: ApphudHTTPResponse = (apphudResponse.0, apphudResponse.1, apphudResponse.2, apphudResponse.3, apphudResponse.4, requestDuration)
+            let finalHttpResponse: ApphudHTTPResponse = (apphudResponse.0, apphudResponse.1, apphudResponse.2, apphudResponse.3, apphudResponse.4, requestDuration, result.2)
 
             return finalHttpResponse
 
         } catch {
+            let apphudError = error as? ApphudError
+            let attempts = apphudError?.attempts ?? retries
 
             let code = (error as NSError?)?.code ?? NSURLErrorUnknown
 
             if ApphudUtils.shared.logLevel == .all {
-                apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code: \(code) after: \(retries) retries error: \(error.localizedDescription)", logLevel: .all)
+                apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code: \(code) after: \(attempts) attempts error: \(error.localizedDescription)", logLevel: .all)
             } else {
-                apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code: \(code) after: \(retries) retries error: \(error.localizedDescription)")
+                apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code: \(code) after: \(attempts) attempts error: \(error.localizedDescription)")
             }
 
             // Handle any errors that occurred during the request
-            return (false, nil, nil, error, code, 0)
+            return (false, nil, nil, error, code, 0, attempts)
         }
     }
 

Sources/Internal/ApphudInternal+Attribution.swift

@@ -134,7 +134,7 @@ extension ApphudInternal {
     }
 
     func startAttributionRequest(params: [String: Any], provider: ApphudAttributionProvider, identifer: String?, callback: ((Bool) -> Void)?) {
-        self.httpClient?.startRequest(path: .attribution, params: params, method: .post, retry: true) { (result, _, _, _, _, _) in
+        self.httpClient?.startRequest(path: .attribution, params: params, method: .post, retry: true) { (result, _, _, _, _, _, _) in
             switch provider {
             case .adjust:
                 // to avoid sending the same data several times in a row

Sources/Internal/ApphudInternal+Currency.swift

@@ -41,14 +41,19 @@ extension ApphudInternal {
     private func fetchCurrencyWithMaxTimeout(_ completion: @escaping () -> Void) {
 
         Task {
-            let result = await Storefront.current
+            let result: Storefront? = nil //await Storefront.current
             if let store = result, await currentUser?.currency?.countryCodeAlpha3 != store.countryCode {
 
                 storefrontCurrency = ApphudCurrency(countryCode: store.countryCode,
                                                     code: nil,
                                                     storeId: store.id,
                                                     countryCodeAlpha3: store.countryCode)
                 setNeedsToUpdateUser = true
+            } else if result == nil {
+                apphudLog("Failed to get Storefront, fetching currency from SKProducts")
+                Task.detached {
+                    await self.fetchCurrencyLegacy()
+                }
             }
             if !currencyTaskFinished {
                 completion()
@@ -66,7 +71,7 @@ extension ApphudInternal {
 
     private func fetchCurrencyLegacy() async {
 
-        let skProducts: [SKProduct] = ApphudStoreKitWrapper.shared.products
+        var skProducts: [SKProduct] = ApphudStoreKitWrapper.shared.products
 
         if skProducts.isEmpty {
             let groups: [ApphudGroup]?
@@ -83,6 +88,13 @@ extension ApphudInternal {
             })
 
             await continueToFetchStoreKitProducts(maxAttempts: APPHUD_DEFAULT_RETRIES)
+            skProducts = await withCheckedContinuation { continuation in
+                Task { @MainActor in
+                    performWhenStoreKitProductFetched(maxAttempts: 3) { _ in
+                        continuation.resume(returning: ApphudStoreKitWrapper.shared.products)
+                    }
+                }
+            }
         }
 
         let priceLocale = skProducts.first?.priceLocale
@@ -104,5 +116,6 @@ extension ApphudInternal {
                                             countryCodeAlpha3: nil)
 
         setNeedsToUpdateUser = true
+        apphudLog("Did prepare legacy currency \(countryCode)/\(currencyCode)")
     }
 }

Sources/Internal/ApphudInternal+Product.swift

@@ -66,6 +66,10 @@ extension ApphudInternal {
         paywalls.forEach { p in
             productIDs.append(contentsOf: p.products.map { $0.productId })
         }
+        
+        placements.forEach { pl in
+            productIDs.append(contentsOf: pl.paywall?.products.map{ $0.productId } ?? [])
+        }
 
         permissionGroups?.forEach({ group in
             productIDs.append(contentsOf: group.products.map { $0.productId })
@@ -177,7 +181,7 @@ extension ApphudInternal {
             return
         }
 
-        httpClient?.startRequest(path: .products, apiVersion: .APIV3, params: ["observer_mode": ApphudUtils.shared.storeKitObserverMode, "device_id": currentDeviceID], method: .get, useDecoder: true, retry: true) { _, _, data, error, code, duration in
+        httpClient?.startRequest(path: .products, apiVersion: .APIV3, params: ["observer_mode": ApphudUtils.shared.storeKitObserverMode, "device_id": currentDeviceID], method: .get, useDecoder: true, retry: true) { _, _, data, error, code, duration, attempts in
 
             if error == nil {
                 ApphudLoggerService.shared.add(key: .products, value: duration, retryLog: self.productsFetchRetries)

Sources/Internal/ApphudInternal+Purchase.swift

@@ -299,6 +299,12 @@ extension ApphudInternal {
             params["product_bundle_id"] = purchasedApphudProduct.id
             params["paywall_id"] = purchasedApphudProduct.paywallId
             params["placement_id"] = purchasedApphudProduct.placementId
+            if let varID = purchasedApphudProduct.variationIdentifier {
+                params["variation_identifier"] = varID
+            }
+            if let expID = purchasedApphudProduct.experimentId {
+                params["experiment_id"] = expID
+            }
         }
 
         purchasingProduct = nil
@@ -318,6 +324,13 @@ extension ApphudInternal {
             }
 
             params["paywall_id"] = paywall?.id
+            if let varID = paywall?.variationIdentifier {
+                params["variation_identifier"] = varID
+            }
+            if let expID = paywall?.experimentId {
+                params["experiment_id"] = expID
+            }
+            
             let apphudP = paywall?.products.first(where: { $0.productId == transactionProductIdentifier })
             apphudP?.id.map { params["product_bundle_id"] = $0 }
         }
@@ -340,7 +353,7 @@ extension ApphudInternal {
 
         apphudLog("Uploading App Store Receipt...")
 
-        httpClient?.startRequest(path: .subscriptions, params: params, method: .post, useDecoder: true, retry: (hasMadePurchase && !fallbackMode)) { (result, _, data, error, errorCode, duration) in
+        httpClient?.startRequest(path: .subscriptions, params: params, method: .post, useDecoder: true, retry: (hasMadePurchase && !fallbackMode)) { (result, _, data, error, errorCode, duration, attempts) in
             Task { @MainActor in
                 if !result && hasMadePurchase && self.fallbackMode {
                     self.requiresReceiptSubmission = true
@@ -463,7 +476,7 @@ extension ApphudInternal {
     // MARK: - Private purchase methods
 
     private func purchase(product: SKProduct, apphudProduct: ApphudProduct?, validate: Bool, value: Double? = nil, callback: ((ApphudPurchaseResult) -> Void)?) {
-        ApphudLoggerService.shared.paywallCheckoutInitiated(paywallId: apphudProduct?.paywallId, placementId: apphudProduct?.placementId, productId: product.productIdentifier)
+        ApphudLoggerService.shared.paywallCheckoutInitiated(apphudProduct: apphudProduct, productId: product.productIdentifier)
 
         purchasingProduct = apphudProduct
 
@@ -565,7 +578,7 @@ extension ApphudInternal {
 
     private func signPromoOffer(productID: String, discountID: String, callback: ((SKPaymentDiscount?, Error?) -> Void)?) {
         let params: [String: Any] = ["product_id": productID, "offer_id": discountID, "application_username": ApphudStoreKitWrapper.shared.appropriateApplicationUsername() ?? "", "device_id": currentDeviceID, "user_id": currentUserID ]
-        httpClient?.startRequest(path: .signOffer, params: params, method: .post) { (result, dict, _, error, _, _) in
+        httpClient?.startRequest(path: .signOffer, params: params, method: .post) { (result, dict, _, error, _, _, _) in
             if result, let responseDict = dict, let dataDict = responseDict["data"] as? [String: Any], let resultsDict = dataDict["results"] as? [String: Any] {
 
                 let signatureData = resultsDict["data"] as? [String: Any]

Sources/Internal/ApphudInternal+UserUpdate.swift

@@ -92,7 +92,7 @@ extension ApphudInternal {
         let fields = initialCall ? ["user_id": self.currentUserID, "initial_call": true] : [:]
 
         return await withCheckedContinuation { continuation in
-            updateUser(fields: fields, delay: delay) { (result, _, data, error, code, duration) in
+            updateUser(fields: fields, delay: delay) { (result, _, data, error, code, duration, attempts) in
 
                 Task {
                     let hasChanges = await self.parseUser(data: data)
@@ -132,7 +132,7 @@ extension ApphudInternal {
                 return
             }
 
-            self.updateUser(fields: ["user_id": userID]) { (result, _, data, _, _, _) in
+            self.updateUser(fields: ["user_id": userID]) { (result, _, data, _, _, _, attempts) in
                 if result {
                     Task {
                         await self.parseUser(data: data)
@@ -144,7 +144,7 @@ extension ApphudInternal {
 
     internal func grantPromotional(_ duration: Int, _ permissionGroup: ApphudGroup?, productId: String?, callback: ApphudBoolCallback?) {
         performWhenUserRegistered {
-            self.grantPromotional(duration, permissionGroup, productId: productId) { (result, _, data, _, _, _) in
+            self.grantPromotional(duration, permissionGroup, productId: productId) { (result, _, data, _, _, _, _) in
                 if result {
                     Task {
                         let hasChanges = await self.parseUser(data: data)
@@ -212,15 +212,15 @@ extension ApphudInternal {
         }
 
         // retry on http level only if setNeedsToUpdateUser = true, otherwise let retry on initial launch level
-        let needsHTTPLevelRetries = params["initial_call"] == nil
+        let initialCall = params["initial_call"] != nil
         setNeedsToUpdateUser = false
 
         appInstallationDate.map { params["first_seen"] = $0 }
         Bundle.main.bundleIdentifier.map { params["bundle_id"] = $0 }
         // do not automatically pass currentUserID here,because we have separate method updateUserID
 
         DispatchQueue.main.asyncAfter(deadline: .now() + delay) { [self] in
-            httpClient?.startRequest(path: .customers, params: params, method: .post, useDecoder: true, retry: needsHTTPLevelRetries) { done, response, data, error, errorCode, duration in
+            httpClient?.startRequest(path: .customers, params: params, method: .post, useDecoder: true, retry: !initialCall, requestID: initialCall ? initialRequestID : nil) { done, response, data, error, errorCode, duration, attempts in
                 if  errorCode == 403 {
                     apphudLog("Unable to perform API requests, because your account has been suspended.", forceDisplay: true)
                     ApphudHttpClient.shared.unauthorized = true
@@ -230,7 +230,7 @@ extension ApphudInternal {
                     apphudLog("Unable to perform API requests, because your API Key is invalid.", forceDisplay: true)
                     ApphudHttpClient.shared.invalidAPiKey = true
                 }
-                callback(done, response, data, error, errorCode, duration)
+                callback(done, response, data, error, errorCode, duration, attempts)
             }
         }
     }
@@ -331,7 +331,7 @@ extension ApphudInternal {
 
             let canSaveToCache = values.2
 
-            httpClient?.startRequest(path: .properties, params: params, method: .post, retry: true) { (result, _, _, error, code, _) in
+            httpClient?.startRequest(path: .properties, params: params, method: .post, retry: true) { (result, _, _, error, code, _, _) in
                 if result {
                     if canSaveToCache {
                         Task {