Add audience property logic (#119)

* Added support for real-time audiences segmentation in placements based on user properties
* Fixed a bug that appeared only in 3.4.0 and could lead to incorrect audiences segmentation in placements based on store country.

Author: vlr-code

ApphudSDK.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '3.4.0'
+  s.version          = '3.5.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'

Sources/Internal/ApphudInternal+Currency.swift

@@ -41,7 +41,7 @@ extension ApphudInternal {
     private func fetchCurrencyWithMaxTimeout(_ completion: @escaping () -> Void) {
 
         Task {
-            let result: Storefront? = nil //await Storefront.current
+            let result: Storefront? = await Storefront.current
             if let store = result, await currentUser?.currency?.countryCodeAlpha3 != store.countryCode {
 
                 storefrontCurrency = ApphudCurrency(countryCode: store.countryCode,
@@ -62,7 +62,7 @@ extension ApphudInternal {
 
         // Task for the timeout
         Task {
-            try? await Task.sleep(nanoseconds: 200_000_000) // 0.2 seconds
+            try? await Task.sleep(nanoseconds: 300_000_000) // 0.3 seconds
             if !currencyTaskFinished {
                 completion()
             }

Sources/Internal/ApphudInternal+Product.swift

@@ -150,12 +150,16 @@ extension ApphudInternal {
                     callback?([], error)
                 }
             } else {
-                ApphudStoreKitWrapper.shared.status = .none
-                Task.detached { @MainActor in
-                    self.performWhenStoreKitProductFetched(maxAttempts: maxAttempts) { error in
-                        apphudPerformOnMainThread { callback?(ApphudStoreKitWrapper.shared.products, error) }
-                    }
-                }
+                refreshStoreKitProductsOnly(maxAttempts: maxAttempts, callback: callback)
+            }
+        }
+    }
+    
+    internal func refreshStoreKitProductsOnly(maxAttempts: Int, callback: (([SKProduct], Error?) -> Void)?) {
+        ApphudStoreKitWrapper.shared.status = .none
+        Task.detached { @MainActor in
+            self.performWhenStoreKitProductFetched(maxAttempts: maxAttempts) { error in
+                apphudPerformOnMainThread { callback?(ApphudStoreKitWrapper.shared.products, error) }
             }
         }
     }
@@ -253,18 +257,31 @@ extension ApphudInternal {
     internal func fetchOfferingsFull(maxAttempts: Int = APPHUD_DEFAULT_RETRIES, callback: @escaping (ApphudError?) -> Void) {
         let preparedAttempts = min(max(1, maxAttempts), 10)
         self.customRegistrationAttemptsCount = preparedAttempts
-        performWhenUserRegistered(allowFailure: true) {
-            if (self.currentUser == nil) {
-                apphudLog("Failed to register user with error: \(self.userRegisterRetries.errorCode)", forceDisplay: true)
+        
+        if deferPlacements {
+            deferPlacements = false
+            didPreparePaywalls = false
+            refreshCurrentUser {
+                self.refreshStoreKitProductsOnly(maxAttempts: maxAttempts) { _, error in
+                    callback(error != nil ? ApphudError(error: error!) : nil)
+                }
             }
-            self.performWhenStoreKitProductFetched(maxAttempts: preparedAttempts) { error in
-                if self.paywallsLoadTime == 0 {
-                    self.paywallsLoadTime = Date().timeIntervalSince(self.initDate)
+        } else {
+            performWhenUserRegistered(allowFailure: true) {
+                if (self.currentUser == nil) {
+                    apphudLog("Failed to register user with error: \(self.userRegisterRetries.errorCode)", forceDisplay: true)
+                }
+                self.performWhenStoreKitProductFetched(maxAttempts: preparedAttempts) { error in
+                    if self.paywallsLoadTime == 0 {
+                        self.paywallsLoadTime = Date().timeIntervalSince(self.initDate)
+                    }
+                    callback(error)
                 }
-                callback(error)
             }
         }
     }
+    
+    
 
     // MARK: - Product Groups Helper Methods
 

Sources/Internal/ApphudInternal+Purchase.swift

@@ -318,7 +318,7 @@ extension ApphudInternal {
                 if params["placement_id"] == nil && placement != nil {
                     params["placement_id"] = placement?.id
                 }
-                paywall = placement?.paywalls.first(where: {$0.identifier == observerModePurchaseIdentifiers?.paywall})
+                paywall = placement?.paywalls.first
             } else {
                 paywall = await paywalls.first(where: {$0.identifier == observerModePurchaseIdentifiers?.paywall})
             }

Sources/Internal/ApphudInternal+UserUpdate.swift

@@ -192,8 +192,8 @@ extension ApphudInternal {
         params["device_id"] = self.currentDeviceID
         params["is_debug"] = apphudIsSandbox()
         params["is_new"] = isFreshInstall && currentUser == nil
-        params["need_paywalls"] = !didPreparePaywalls
-        params["need_placements"] = !didPreparePaywalls
+        params["need_paywalls"] = !didPreparePaywalls && !deferPlacements
+        params["need_placements"] = !didPreparePaywalls && !deferPlacements
         params["opt_out"] = ApphudUtils.shared.optOutOfTracking
 
         if params["user_id"] == nil, let userId = currentUser?.userId {
@@ -236,8 +236,13 @@ extension ApphudInternal {
     }
 
     @objc internal func updateCurrentUser() {
+        refreshCurrentUser {}
+    }
+    
+    @objc internal func refreshCurrentUser(completion: @escaping () -> Void) {
         Task.detached(priority: .userInitiated) {
-            await self.createOrGetUser(initialCall: false)
+            _ = await self.createOrGetUser(initialCall: false)
+            completion()
         }
     }
 
@@ -312,19 +317,26 @@ extension ApphudInternal {
             apphudLog("Invalid increment property type: (\(givenType)). Must be one of: [Int, Float, Double]", forceDisplay: true)
             return
         }
+        
+        Task { @MainActor in
+            let property = ApphudUserProperty(key: key.key, value: value, increment: increment, setOnce: setOnce, type: typeString)
+            await ApphudDataActor.shared.addPendingUserProperty(property)
+        }
 
         performWhenUserRegistered {
             Task { @MainActor in
-                let property = ApphudUserProperty(key: key.key, value: value, increment: increment, setOnce: setOnce, type: typeString)
-                await ApphudDataActor.shared.addPendingUserProperty(property)
                 self.setNeedsToUpdateUserProperties = true
             }
         }
     }
 
     @objc internal func updateUserProperties() {
+        flushUserProperties(force: false, completion: nil)
+    }
+    
+    internal func flushUserProperties(force: Bool, completion: ((Bool) -> Void)? = nil) {
         Task {
-            let values = await self.preparePropertiesParams()
+            let values = await self.preparePropertiesParams(isAudience: force)
             guard let params = values.0, let properties = values.1 else {
                 return
             }
@@ -342,15 +354,18 @@ extension ApphudInternal {
                 } else {
                     apphudLog("User Properties update failed: \(error?.localizedDescription ?? "") with code: \(code)")
                 }
+                
+                completion?(result)
             }
         }
     }
 
-    private func preparePropertiesParams() async -> ([String: Any]?, [[String: Any?]]?, Bool) {
+    private func preparePropertiesParams(isAudience:Bool = false) async -> ([String: Any]?, [[String: Any?]]?, Bool) {
         setNeedsToUpdateUserProperties = false
         guard await ApphudDataActor.shared.pendingUserProps.count > 0 else { return (nil, nil, false) }
         var params = [String: Any]()
         params["device_id"] = self.currentDeviceID
+        params["force"] = isAudience
 
         var canSaveToCache = true
         var properties = [[String: Any?]]()

Sources/Internal/ApphudInternal.swift

@@ -112,6 +112,7 @@ final class ApphudInternal: NSObject {
     internal var productsFetchRetries: ApphudRetryLog = (0, 0)
     internal let maxNumberOfProductsFetchRetries: Int = 25
     internal var didPreparePaywalls: Bool = false
+    internal var deferPlacements: Bool = false
     internal var initDate = Date()
     internal var paywallsLoadTime: TimeInterval = 0
     internal var isRegisteringUser = false {

Sources/Public/Apphud.swift

@@ -14,7 +14,7 @@ import Foundation
 import UserNotifications
 import SwiftUI
 
-internal let apphud_sdk_version = "3.4.0"
+internal let apphud_sdk_version = "3.5.0"
 
 // MARK: - Initialization
 
@@ -189,61 +189,25 @@ final public class Apphud: NSObject {
             callback(ApphudInternal.shared.placements, error)
         }
     }
-
+    
     /**
-     Asynchronously retrieves the paywalls configured in Product Hub > Paywalls, potentially altered based on the user's involvement in A/B testing, if any. Awaits until the inner `SKProduct`s are loaded from the App Store.
-
-     - Important: In case of network issues this method may return empty array. To get the possible error use `paywallsDidLoadCallback` method instead.
+     Disables automatic paywall and placement requests during the SDK's initial setup. Developers must explicitly call `fetchPlacements` or `await placements()` methods at a later point in the app's lifecycle to fetch placements with inner paywalls.
 
-     For immediate access without awaiting `SKProduct`s, use `rawPaywalls()` method.
-     - parameter maxAttempts: Number of request attempts before throwing an error. Must be between 1 and 10. Default value is 3.
+     Example:
 
-     - Important: This is deprecated method. Retrieve paywalls from within placements instead. See documentation for details: https://docs.apphud.com/docs/paywalls
-
-     - Returns: An array of `ApphudPaywall` objects, representing the configured paywalls.
-     */
-    @available(*, deprecated, message: "Deprecated in favor of placements()")
-    @MainActor
-    @objc public static func paywalls(maxAttempts: Int = APPHUD_DEFAULT_RETRIES) async -> [ApphudPaywall] {
-        await withCheckedContinuation { continuation in
-            ApphudInternal.shared.fetchOfferingsFull(maxAttempts: maxAttempts) { error in
-                continuation.resume(returning: ApphudInternal.shared.paywalls)
-            }
+        ```swift
+        Apphud.start(apiKey: "your_api_key")
+        Apphud.deferPlacements()
+        ...
+        Apphud.fetchPlacements { placements in
+           // Handle fetched placements
         }
-    }
-
-    /**
-    A list of paywalls, potentially altered based on the user's involvement in A/B testing, if any.
-
-    - Important: This function doesn't await until inner `SKProduct`s are loaded from the App Store. That means paywalls may or may not have inner StoreKit products at the time you call this function.
-
-    - Important: This function will return empty array if user is not yet loaded, or placements are not set up in the Product Hub.
-
-    To get paywalls with awaiting for StoreKit products, use await Apphud.paywalls() or
-     Apphud.paywallsDidLoadCallback(...) functions.
-
-    - Returns: An array of `ApphudPaywall` objects, representing the configured paywalls.
-    */
-    @MainActor public static func rawPaywalls() -> [ApphudPaywall] {
-        ApphudInternal.shared.paywalls
-    }
-
-    /**
-     Asynchronously retrieve a specific paywall by identifier configured in Product Hub > Paywalls, potentially altered based on the user's involvement in A/B testing, if any. Awaits until the inner `SKProduct`s are loaded from the App Store.
-
-     For immediate access without awaiting `SKProduct`s, use `ApphudDelegate`'s `userDidLoad` method or the callback in `Apphud.start(...)`.
+        ```
 
-     - Important: In case of network issues this method may return empty array. To get the possible error use `paywallsDidLoadCallback` method instead.
-
-     - Important: This is deprecated method. Retrieve paywalls from within placements instead. See documentation for details: https://docs.apphud.com/docs/placements
-
-     - parameter identifier: The unique identifier for the desired paywall.
-     - Returns: An optional `ApphudPaywall` object if found, or `nil` if no matching paywall is found.
+     Note: You can use this method alongside `forceFlushUserProperties` to achieve real-time user segmentation based on custom user properties.
      */
-    @available(*, deprecated, message: "Deprecated in favor of placement(_ identifier: String)")
-    @MainActor
-    @objc public static func paywall(_ identifier: String) async -> ApphudPaywall? {
-        await paywalls().first(where: { $0.identifier == identifier })
+    public static func deferPlacements() {
+        ApphudInternal.shared.deferPlacements = true
     }
 
     /**
@@ -677,6 +641,30 @@ final public class Apphud: NSObject {
     @objc public static func setUserProperty(key: ApphudUserPropertyKey, value: Any?, setOnce: Bool = false) {
         ApphudInternal.shared.setUserProperty(key: key, value: value, setOnce: setOnce, increment: false)
     }
+    
+    /**
+     This method sends all user properties immediately to Apphud. Should be used for audience segmentation in placements based on user properties.
+    
+     Example:
+     ````swift
+     Apphud.start(apiKey: "api_key")
+     Apphud.deferPlacements()
+     
+     Apphud.setUserProperty(key: .init("key_name"), value: "key_value")
+     
+     Apphud.forceFlushUserProperties { done in
+        // now placements will respect user properties that have been sent previously
+         Apphud.fetchPlacements { placements, error in
+         }
+     }
+     ```
+     */
+    
+    public static func forceFlushUserProperties(completion: @escaping (Bool) -> Void) {
+        ApphudInternal.shared.performWhenUserRegistered {
+            ApphudInternal.shared.flushUserProperties(force: true, completion: completion)
+        }
+    }
 
     /**