Update storefront apis

RevenueCat.xcodeproj/project.pbxproj

@@ -4163,7 +4163,6 @@
 		354235D624C11160008C84EE /* Purchasing */ = {
 			isa = PBXGroup;
 			children = (
-				4D2A00672CD1EED2008318CA /* PurchaseParamsTests.swift */,
 				57E0474B27729A1E0082FE91 /* __Snapshots__ */,
 				2D1015DF275A67560086173F /* StoreKitAbstractions */,
 				5766AABB283E809D00FA6091 /* Purchases */,
@@ -4188,6 +4187,7 @@
 				57554C61282ABFD9009A7E58 /* StoreTests.swift */,
 				57554C83282AC273009A7E58 /* PeriodTypeTests.swift */,
 				57554C87282AC293009A7E58 /* PurchaseOwnershipTypeTests.swift */,
+				4D2A00672CD1EED2008318CA /* PurchaseParamsTests.swift */,
 				57BA943028330ACA00CD5FC5 /* ConfigurationTests.swift */,
 				57BB071528D282A4007F5DF0 /* CachingProductsManagerTests.swift */,
 				57E9CF10290B2ADC00EE12D1 /* CachingTrialOrIntroPriceEligibilityCheckerTests.swift */,

Sources/Attribution/AttributionNetwork.swift

@@ -17,7 +17,7 @@ import Foundation
 /**
  Enum of supported attribution networks
  */
-@objc(RCAttributionNetwork) public enum AttributionNetwork: Int {
+@objc(RCAttributionNetwork) public enum AttributionNetwork: Int, Sendable {
 
     /**
      Apple's search ads

Sources/Misc/SystemInfo.swift

@@ -90,7 +90,15 @@ class SystemInfo {
     }
 
     var storefront: StorefrontType? {
-        return self.storefrontProvider.currentStorefront
+        get async {
+            return await self.storefrontProvider.currentStorefront
+        }
+    }
+
+    /// - Important: This is a synchronous API that uses StoreKit 1, and may block the current thread.
+    /// The preferred way to access the current storefront is via `storefront`.
+    var syncStorefront: StorefrontType? {
+        return self.storefrontProvider.syncStorefront
     }
 
     static var frameworkVersion: String {

Sources/Networking/HTTPClient/HTTPClient.swift

@@ -137,7 +137,7 @@ class HTTPClient {
             "X-Is-Debug-Build": "\(self.systemInfo.isDebugBuild)"
         ]
 
-        if let storefront = self.systemInfo.storefront {
+        if let storefront = self.getStorefrontSynchronously() {
             headers["X-Storefront"] = storefront.countryCode
         }
 
@@ -160,6 +160,24 @@ class HTTPClient {
         return headers
     }
 
+    /// Returns the current storefront synchronously.
+    ///
+    /// Because this method is synchronous, it should be used only from a background thread to avoid blocking
+    /// the main thread.
+    private func getStorefrontSynchronously() -> StorefrontType? {
+        let storefront: Atomic<StorefrontType?> = .init(nil)
+        let semaphore = DispatchSemaphore(value: 0)
+
+        Task.detached(priority: .high) {
+            storefront.value = await self.systemInfo.storefront
+            semaphore.signal()
+        }
+
+        semaphore.wait()
+
+        return storefront.value
+    }
+
 }
 
 extension HTTPClient {

Sources/Purchasing/ProductsManager.swift

@@ -128,15 +128,17 @@ private extension ProductsManager {
                 ?? error?.localizedDescription
             let errorCode = error?.errorCode
             let storeKitErrorDescription = StoreKitErrorUtils.extractStoreKitErrorDescription(from: error)
-            diagnosticsTracker.trackProductsRequest(wasSuccessful: error == nil,
-                                                    storeKitVersion: storeKitVersion,
-                                                    errorMessage: errorMessage,
-                                                    errorCode: errorCode,
-                                                    storeKitErrorDescription: storeKitErrorDescription,
-                                                    storefront: self.systemInfo.storefront?.countryCode,
-                                                    requestedProductIds: requestedProductIds,
-                                                    notFoundProductIds: notFoundProductIds,
-                                                    responseTime: responseTime)
+            Task {
+                diagnosticsTracker.trackProductsRequest(wasSuccessful: error == nil,
+                                                        storeKitVersion: storeKitVersion,
+                                                        errorMessage: errorMessage,
+                                                        errorCode: errorCode,
+                                                        storeKitErrorDescription: storeKitErrorDescription,
+                                                        storefront: await self.systemInfo.storefront?.countryCode,
+                                                        requestedProductIds: requestedProductIds,
+                                                        notFoundProductIds: notFoundProductIds,
+                                                        responseTime: responseTime)
+            }
         }
     }
 

Sources/Purchasing/Purchases/Purchases.swift

@@ -248,7 +248,7 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
     }
 
     @objc public var storeFrontCountryCode: String? {
-        systemInfo.storefront?.countryCode
+        systemInfo.syncStorefront?.countryCode
     }
 
     private let attributionFetcher: AttributionFetcher

Sources/Purchasing/Purchases/PurchasesOrchestrator.swift

@@ -1152,17 +1152,19 @@ private extension PurchasesOrchestrator {
                 ?? error?.localizedDescription
             let errorCode = error?.code
             let storeKitErrorDescription = StoreKitErrorUtils.extractStoreKitErrorDescription(from: error)
-            diagnosticsTracker.trackPurchaseAttempt(wasSuccessful: successful,
-                                                    storeKitVersion: storeKitVersion,
-                                                    errorMessage: errorMessage,
-                                                    errorCode: errorCode,
-                                                    storeKitErrorDescription: storeKitErrorDescription,
-                                                    storefront: self.systemInfo.storefront?.countryCode,
-                                                    productId: productId,
-                                                    promotionalOfferId: promotionalOfferId,
-                                                    winBackOfferApplied: winBackOfferApplied,
-                                                    purchaseResult: purchaseResult,
-                                                    responseTime: responseTime)
+            Task {
+                diagnosticsTracker.trackPurchaseAttempt(wasSuccessful: successful,
+                                                        storeKitVersion: storeKitVersion,
+                                                        errorMessage: errorMessage,
+                                                        errorCode: errorCode,
+                                                        storeKitErrorDescription: storeKitErrorDescription,
+                                                        storefront: await self.systemInfo.storefront?.countryCode,
+                                                        productId: productId,
+                                                        promotionalOfferId: promotionalOfferId,
+                                                        winBackOfferApplied: winBackOfferApplied,
+                                                        purchaseResult: purchaseResult,
+                                                        responseTime: responseTime)
+            }
         }
     }
 
@@ -1861,11 +1863,14 @@ private extension PurchasesOrchestrator {
         completion: @escaping (ProductRequestData?) -> Void
     ) {
         self.productsManager.products(withIdentifiers: [productIdentifier]) { products in
-            let result = products.value?.first.map {
-                ProductRequestData(with: $0, storefront: self.systemInfo.storefront)
-            }
+            Task {
+                let storefront = await self.systemInfo.storefront
+                let result = products.value?.first.map {
+                    ProductRequestData(with: $0, storefront: storefront)
+                }
 
-            completion(result)
+                completion(result)
+            }
         }
     }
 

Sources/Purchasing/StoreKitAbstractions/Storefront.swift

@@ -74,19 +74,23 @@ extension Storefront: Sendable {}
 public extension Storefront {
 
     @available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.2, macCatalyst 13.1, *)
-    private static var currentStorefrontType: StorefrontType? {
+    internal static var currentStorefrontType: StorefrontType? {
         get async {
             if #available(iOS 15.0, tvOS 15.0, watchOS 8.0, macOS 12.0, *) {
                 let sk2Storefront = await StoreKit.Storefront.current
                 return sk2Storefront.map(SK2Storefront.init)
             } else {
-                return Self.sk1CurrentStorefrontType
+                return await Task.detached {
+                    return Self.sk1CurrentStorefrontType
+                }.value
             }
         }
     }
 
     @available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.2, macCatalyst 13.1, *)
     internal static var sk1CurrentStorefrontType: StorefrontType? {
+        // As stated in the documentation, SKPaymentQueue's storefront is a synchronous API that may take significant
+        // time to return. Please, use `currentStorefrontType` instead, if possible.
         return SKPaymentQueue.default().storefront.map(SK1Storefront.init)
     }
 

Sources/Purchasing/StoreKitAbstractions/StorefrontProvider.swift

@@ -16,7 +16,18 @@ import Foundation
 /// A type that can determine the current `Storefront`.
 protocol StorefrontProviderType {
 
-    var currentStorefront: StorefrontType? { get }
+    /// The current `StorefrontType`, if available.
+    ///
+    /// In iOS 15+, it uses StoreKit 2's async API to retrieve the current storefront.
+    ///
+    /// This is the preferred way to access the current storefront, as it prevents blocking the current thread.
+    var currentStorefront: StorefrontType? { get async }
+
+    /// The current `StorefrontType`, if available.
+    ///
+    /// - Important: This is a synchronous API that uses StoreKit 1, and may block the current thread.
+    /// The preferred way to access the current storefront is via `currentStorefront`.
+    var syncStorefront: StorefrontType? { get }
 
 }
 
@@ -25,11 +36,12 @@ protocol StorefrontProviderType {
 final class DefaultStorefrontProvider: StorefrontProviderType {
 
     var currentStorefront: StorefrontType? {
-        if #available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.2, macCatalyst 13.1, *) {
-            return Storefront.sk1CurrentStorefrontType
-        } else {
-            return nil
+        get async {
+            return await Storefront.currentStorefrontType
         }
     }
 
+    var syncStorefront: StorefrontType? {
+        return Storefront.sk1CurrentStorefrontType
+    }
 }

Sources/Purchasing/TrialOrIntroPriceEligibilityChecker.swift

@@ -302,17 +302,17 @@ extension TrialOrIntroPriceEligibilityChecker: @unchecked Sendable {}
 
 private extension TrialOrIntroPriceEligibilityChecker {
 
+    // swiftlint:disable:next function_body_length
     func trackTrialOrIntroEligibilityRequestIfNeeded(startTime: Date,
                                                      requestedProductIds: Set<String>,
                                                      result: [String: IntroEligibility],
                                                      error: Error?,
                                                      storeKitVersion: StoreKitVersion) {
-        guard #available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *),
-              let diagnosticsTracker = self.diagnosticsTracker else {
+        guard #available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *), let diagnosticsTracker else {
             return
         }
 
-        var unknownCount, ineligibleCount, eligibleCount, noIntroOfferCount: Int?
+        let unknownCount, ineligibleCount, eligibleCount, noIntroOfferCount: Int?
         if !result.isEmpty {
             (unknownCount, ineligibleCount, eligibleCount, noIntroOfferCount) = result.reduce(into: (0, 0, 0, 0)) {
                 switch $1.value.status {
@@ -326,6 +326,8 @@ private extension TrialOrIntroPriceEligibilityChecker {
                     $0.3 += 1
                 }
             }
+        } else {
+            (unknownCount, ineligibleCount, eligibleCount, noIntroOfferCount) = (nil, nil, nil, nil)
         }
 
         let errorCode: Int?
@@ -348,16 +350,19 @@ private extension TrialOrIntroPriceEligibilityChecker {
 
         let responseTime = self.dateProvider.now().timeIntervalSince(startTime)
 
-        diagnosticsTracker.trackAppleTrialOrIntroEligibilityRequest(storeKitVersion: storeKitVersion,
-                                                                    requestedProductIds: requestedProductIds,
-                                                                    eligibilityUnknownCount: unknownCount,
-                                                                    eligibilityIneligibleCount: ineligibleCount,
-                                                                    eligibilityEligibleCount: eligibleCount,
-                                                                    eligibilityNoIntroOfferCount: noIntroOfferCount,
-                                                                    errorMessage: errorMessage,
-                                                                    errorCode: errorCode,
-                                                                    storefront: self.systemInfo.storefront?.countryCode,
-                                                                    responseTime: responseTime)
+        Task {
+            let storefront = await self.systemInfo.storefront?.countryCode
+            diagnosticsTracker.trackAppleTrialOrIntroEligibilityRequest(storeKitVersion: storeKitVersion,
+                                                                        requestedProductIds: requestedProductIds,
+                                                                        eligibilityUnknownCount: unknownCount,
+                                                                        eligibilityIneligibleCount: ineligibleCount,
+                                                                        eligibilityEligibleCount: eligibleCount,
+                                                                        eligibilityNoIntroOfferCount: noIntroOfferCount,
+                                                                        errorMessage: errorMessage,
+                                                                        errorCode: errorCode,
+                                                                        storefront: storefront,
+                                                                        responseTime: responseTime)
+        }
     }
 
 }

Tests/StoreKitUnitTests/StorefrontTests.swift

@@ -52,9 +52,9 @@ class StorefrontTests: StoreKitConfigTestCase {
         let systemInfo = SystemInfo(platformInfo: nil,
                                     finishTransactions: false,
                                     preferredLocalesProvider: .mock())
-        let storefront = try XCTUnwrap(systemInfo.storefront)
+        let storefront = await systemInfo.storefront
 
-        expect(storefront.countryCode) == expected
+        expect(storefront?.countryCode) == expected
     }
 
 }

Tests/UnitTests/Mocks/MockSystemInfo.swift

@@ -97,7 +97,9 @@ class MockSystemInfo: SystemInfo {
     }
 
     override var storefront: StorefrontType? {
-        return self.stubbedStorefront
+        get async {
+            return self.stubbedStorefront
+        }
     }
 }
 

Tests/UnitTests/Networking/Backend/BaseBackendTest.swift

@@ -171,11 +171,11 @@ final class MockStorefrontProvider: StorefrontProviderType {
 
     var currentStorefront: StorefrontType? {
         // Simulate `DefaultStorefrontProvider` availability.
-        if #available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.2, macCatalyst 13.1, *) {
-            return MockStorefront(countryCode: "USA")
-        } else {
-            return nil
-        }
+        return MockStorefront(countryCode: "USA")
+    }
+
+    var syncStorefront: StorefrontType? {
+        return currentStorefront
     }
 
 }

Tests/UnitTests/Purchasing/Purchases/PurchasesRestoreTests.swift

@@ -170,6 +170,7 @@ class PurchasesRestoreTests: BasePurchasesTests {
 
         expect(self.receiptFetcher.receiptDataTimesCalled) == 1
 
+        expect(self.backend.postReceiptDataCalled).toEventually(beTrue())
         expect(self.backend.postedReceiptData) == EncodedAppleReceipt.receipt(self.receiptFetcher.mockReceiptData)
         expect(self.backend.postedProductID) == productIdentifier
         expect(self.backend.postedPrice) == product.price as Decimal