Merge pull request #398 from superwall/develop

4.10.7

Author: yusuftor

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 The changelog for `SuperwallKit`. Also see the [releases](https://github.com/superwall/Superwall-iOS/releases) on GitHub.
 
+## 4.10.7
+
+### Enhancements
+
+- Adds support for `Set user attributes` action.
+- Adds new `SuperwallDelegate` method called `userAttributesDidChange` that notifies you when user attributes change from an external source.
+
+### Fixes
+
+- Fixes a crash caused by a race condition when accessing JSON dictionaries concurrently.
+- Fixes issue returning the `PurchaseResult` from `Superwall.shared.purchase(_:)` when using StoreKit 1 inside a `PurchaseController`.
+- Fixes `handleDeepLink` returning true for non-Superwall URLs when called before configuration completes.
+
 ## 4.10.6
 
 ### Fixes

Examples/Advanced/Advanced/SuperwallAdvancedApp.swift

@@ -22,7 +22,7 @@ struct SuperwallAdvancedApp: App {
 
     // MARK: - Option 1: Let Superwall handle everything
     Superwall.configure(apiKey: apiKey)
-    
+
     // MARK: - Option 2: Use a Purchase Controller with StoreKit
     /*
     // Step 1 - Create your Purchase Controller

Sources/SuperwallKit/Config/Models/FeatureFlags.swift

@@ -22,6 +22,7 @@ struct FeatureFlags: Codable, Equatable {
   var enableMultiplePaywallUrls: Bool
   var enableConfigRefresh: Bool
   var enableTextInteraction: Bool
+  var enableIframeNavigation: Bool
 
   enum CodingKeys: String, CodingKey {
     case toggles
@@ -43,6 +44,7 @@ struct FeatureFlags: Codable, Equatable {
     enableMultiplePaywallUrls = rawFeatureFlags.value(forKey: "enable_multiple_paywall_urls", default: false)
     enableConfigRefresh = rawFeatureFlags.value(forKey: "enable_config_refresh_v2", default: false)
     enableTextInteraction = rawFeatureFlags.value(forKey: "enable_text_interaction", default: false)
+    enableIframeNavigation = rawFeatureFlags.value(forKey: "enable_iframe_navigation", default: false)
   }
 
   func encode(to encoder: Encoder) throws {
@@ -57,7 +59,8 @@ struct FeatureFlags: Codable, Equatable {
       RawFeatureFlag(key: "enable_none_scheduling_policy", enabled: enableNoneSchedulingPolicy),
       RawFeatureFlag(key: "enable_multiple_paywall_urls", enabled: enableMultiplePaywallUrls),
       RawFeatureFlag(key: "enable_config_refresh_v2", enabled: enableConfigRefresh),
-      RawFeatureFlag(key: "enable_text_interaction", enabled: enableTextInteraction)
+      RawFeatureFlag(key: "enable_text_interaction", enabled: enableTextInteraction),
+      RawFeatureFlag(key: "enable_iframe_navigation", enabled: enableIframeNavigation)
     ]
 
     try container.encode(rawFeatureFlags, forKey: .toggles)
@@ -73,7 +76,8 @@ struct FeatureFlags: Codable, Equatable {
     enableMultiplePaywallUrls: Bool,
     enableConfigRefresh: Bool,
     enableTextInteraction: Bool,
-    enableCELLogging: Bool
+    enableCELLogging: Bool,
+    enableIframeNavigation: Bool
   ) {
     self.enableExpressionParameters = enableExpressionParameters
     self.enableUserIdSeed = enableUserIdSeed
@@ -84,6 +88,7 @@ struct FeatureFlags: Codable, Equatable {
     self.enableMultiplePaywallUrls = enableMultiplePaywallUrls
     self.enableConfigRefresh = enableConfigRefresh
     self.enableTextInteraction = enableTextInteraction
+    self.enableIframeNavigation = enableIframeNavigation
   }
 }
 
@@ -111,7 +116,8 @@ extension FeatureFlags: Stubbable {
       enableMultiplePaywallUrls: true,
       enableConfigRefresh: true,
       enableTextInteraction: true,
-      enableCELLogging: true
+      enableCELLogging: true,
+      enableIframeNavigation: true
     )
   }
 }

Sources/SuperwallKit/DeepLinkRouter.swift

@@ -38,7 +38,9 @@ final class DeepLinkRouter {
     }
 
     let deepLinkUrl: URL
-    if url.isSuperwallDeepLink {
+    let isSuperwallDeepLink = url.isSuperwallDeepLink
+
+    if isSuperwallDeepLink {
       deepLinkUrl = url.superwallDeepLinkMappedURL
 
       Task { @MainActor in
@@ -52,11 +54,26 @@ final class DeepLinkRouter {
       deepLinkUrl = url
     }
 
-
     Task {
       await Superwall.shared.track(InternalSuperwallEvent.DeepLink(url: deepLinkUrl))
     }
-    return debugManager.handle(deepLinkUrl: deepLinkUrl)
+
+    // Check if this is a debug URL
+    if debugManager.handle(deepLinkUrl: deepLinkUrl) {
+      return true
+    }
+
+    // Return true for Superwall deep links (we handled it above)
+    if isSuperwallDeepLink {
+      return true
+    }
+
+    // Return true if there's a deepLink_open trigger configured
+    if configManager.triggersByPlacementName[SuperwallEventObjc.deepLink.description] != nil {
+      return true
+    }
+
+    return false
   }
 
   private func listenToConfig() {
@@ -80,9 +97,54 @@ final class DeepLinkRouter {
   }
 
   /// Stores the deep link until it can be handled.
+  ///
+  /// Called when `handleDeepLink` is invoked before Superwall configuration completes.
+  /// The URL is always stored so it can be processed once config loads, but the return
+  /// value indicates whether Superwall will definitely handle this URL.
+  ///
+  /// - Note: The URL is always stored regardless of return value because the fresh config
+  ///   might have a `deepLink_open` trigger even if cached config doesn't. This ensures
+  ///   deep links aren't lost during app launch. If the URL isn't a Superwall URL,
+  ///   returning `false` allows other handlers in a handler chain to process it.
+  ///
+  /// - Parameter url: The deep link URL to store.
+  /// - Returns: `true` if the URL is a Superwall URL that will be handled, `false` otherwise.
   static func storeDeepLink(_ url: URL) -> Bool {
+    // Always store the URL - the fresh config might have deepLink_open trigger
+    // even if cached config doesn't
     pendingDeepLink = url
-    return true
+
+    // Only return true if we're confident Superwall will handle this URL
+    return isSuperwallURL(url)
+  }
+
+  /// Checks if the URL is one that Superwall will handle.
+  private static func isSuperwallURL(_ url: URL) -> Bool {
+    // Superwall universal links (*.superwall.app/app-link/*)
+    if url.isSuperwallDeepLink {
+      return true
+    }
+
+    // Redemption codes
+    if url.redeemableCode != nil {
+      return true
+    }
+
+    // Debug/preview URLs
+    if DebugManager.outcomeForDeepLink(url: url) != nil {
+      return true
+    }
+
+    // Check cached config for deepLink_open trigger
+    let cache = Cache()
+    if let config = cache.read(LatestConfig.self) {
+      let triggers = ConfigLogic.getTriggersByPlacementName(from: config.triggers)
+      if triggers[SuperwallEventObjc.deepLink.description] != nil {
+        return true
+      }
+    }
+
+    return false
   }
 }
 

Sources/SuperwallKit/Delegate/SuperwallDelegate.swift

@@ -153,6 +153,15 @@ public protocol SuperwallDelegate: AnyObject {
     from oldValue: CustomerInfo,
     to newValue: CustomerInfo
   )
+
+  /// Called when user attributes change due to a paywall action.
+  ///
+  /// This is triggered by user interactions within the paywall that update
+  /// user attributes.
+  ///
+  /// - Parameter newAttributes: The new merged user attributes after the update.
+  @MainActor
+  func userAttributesDidChange(newAttributes: [String: Any])
 }
 
 extension SuperwallDelegate {
@@ -202,4 +211,6 @@ extension SuperwallDelegate {
     from oldValue: CustomerInfo,
     to newValue: CustomerInfo
   ) {}
+
+  public func userAttributesDidChange(newAttributes: [String: Any]) {}
 }

Sources/SuperwallKit/Delegate/SuperwallDelegateAdapter.swift

@@ -189,4 +189,13 @@ final class SuperwallDelegateAdapter {
       )
     }
   }
+
+  @MainActor
+  func userAttributesDidChange(newAttributes: [String: Any]) {
+    if let swiftDelegate = swiftDelegate {
+      swiftDelegate.userAttributesDidChange(newAttributes: newAttributes)
+    } else if let objcDelegate = objcDelegate {
+      objcDelegate.userAttributesDidChange?(newAttributes: newAttributes)
+    }
+  }
 }

Sources/SuperwallKit/Delegate/SuperwallDelegateObjc.swift

@@ -154,4 +154,13 @@ public protocol SuperwallDelegateObjc: AnyObject {
     from oldValue: CustomerInfo,
     to newValue: CustomerInfo
   )
+
+  /// Called when user attributes change due to a paywall action.
+  ///
+  /// This is triggered by user interactions within the paywall that update
+  /// user attributes.
+  ///
+  /// - Parameter newAttributes: The new merged user attributes after the update.
+  @MainActor
+  @objc optional func userAttributesDidChange(newAttributes: [String: Any])
 }

Sources/SuperwallKit/Dependencies/DependencyContainer.swift

@@ -141,7 +141,13 @@ final class DependencyContainer {
       deviceHelper: deviceHelper,
       storage: storage,
       configManager: configManager,
-      webEntitlementRedeemer: webEntitlementRedeemer
+      webEntitlementRedeemer: webEntitlementRedeemer,
+      // swiftlint:disable:next trailing_closure
+      notifyUserChange: { [weak self] newAttributes in
+        Task { @MainActor in
+          self?.delegateAdapter.userAttributesDidChange(newAttributes: newAttributes)
+        }
+      }
     )
 
     appSessionManager = AppSessionManager(

Sources/SuperwallKit/Identity/IdentityManager.swift

@@ -118,17 +118,20 @@ class IdentityManager {
   private unowned let storage: Storage
   private unowned let configManager: ConfigManager
   private unowned let webEntitlementRedeemer: WebEntitlementRedeemer
+  private let notifyUserChange: (([String: Any]) -> Void)?
 
   init(
     deviceHelper: DeviceHelper,
     storage: Storage,
     configManager: ConfigManager,
-    webEntitlementRedeemer: WebEntitlementRedeemer
+    webEntitlementRedeemer: WebEntitlementRedeemer,
+    notifyUserChange: (([String: Any]) -> Void)? = nil
   ) {
     self.deviceHelper = deviceHelper
     self.storage = storage
     self.configManager = configManager
     self.webEntitlementRedeemer = webEntitlementRedeemer
+    self.notifyUserChange = notifyUserChange
     self._appUserId = storage.get(AppUserId.self)
 
     var extraAttributes: [String: Any] = [:]
@@ -373,17 +376,36 @@ extension IdentityManager {
     queue.async { [weak self] in
       self?._mergeUserAttributes(
         newUserAttributes,
-        shouldTrackMerge: shouldTrackMerge
+        shouldTrackMerge: shouldTrackMerge,
+        shouldNotify: false
+      )
+    }
+  }
+
+  /// Merges the attributes and notifies the delegate.
+  /// This is used when attributes are updated from the paywall.
+  func mergeUserAttributesAndNotify(
+    _ newUserAttributes: [String: Any?],
+    shouldTrackMerge: Bool = true
+  ) {
+    queue.async { [weak self] in
+      self?._mergeUserAttributes(
+        newUserAttributes,
+        shouldTrackMerge: shouldTrackMerge,
+        shouldNotify: true
       )
     }
   }
 
   /// Merges the provided user attributes with existing attributes then saves them.
   ///
-  /// - Parameter shouldTrackMerge: A boolean indicated whether the merge should be tracked in analytics.
+  /// - Parameters:
+  ///   - shouldTrackMerge: A boolean indicated whether the merge should be tracked in analytics.
+  ///   - shouldNotify: A boolean indicating whether to notify the delegate of the change.
   private func _mergeUserAttributes(
     _ newUserAttributes: [String: Any?],
-    shouldTrackMerge: Bool = true
+    shouldTrackMerge: Bool = true,
+    shouldNotify: Bool = false
   ) {
     let mergedAttributes = IdentityLogic.mergeAttributes(
       newUserAttributes,
@@ -403,5 +425,9 @@ extension IdentityManager {
 
     storage.save(mergedAttributes, forType: UserAttributes.self)
     _userAttributes = mergedAttributes
+
+    if shouldNotify {
+      notifyUserChange?(mergedAttributes)
+    }
   }
 }

Sources/SuperwallKit/Misc/Constants.swift

@@ -18,5 +18,5 @@ let sdkVersion = """
 */
 
 let sdkVersion = """
-4.10.6
+4.10.7
 """