Merge pull request #188 from superwall-me/develop

v3.4.5

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 The changelog for `SuperwallKit`. Also see the [releases](https://github.com/superwall-me/Superwall-iOS/releases) on GitHub.
 
+## 3.4.5
+
+### Enhancements
+
+- Adds internal feature flag to disable verbose events like `paywallResponseLoad_start`.
+- Tracks a Superwall Event `reset` whenever `Superwall.shared.reset()` is called.
+
+### Fixes
+
+- Fixes issue where holdouts were still matching even if the limit set for their corresponding rules were exceeded.
+- Fixes potential crash if the free trial notification delay was set to zero seconds.
+
 ## 3.4.4
 
 ### Enhancements

Sources/SuperwallKit/Analytics/Internal Tracking/Trackable Events/TrackableSuperwallEvent.swift

@@ -170,6 +170,12 @@ enum InternalSuperwallEvent {
     func getSuperwallParameters() async -> [String: Any] { [:] }
   }
 
+  struct Reset: TrackableSuperwallEvent {
+    let superwallEvent: SuperwallEvent = .reset
+    var customParameters: [String: Any] = [:]
+    func getSuperwallParameters() async -> [String: Any] { [:] }
+  }
+
   struct AppClose: TrackableSuperwallEvent {
     let superwallEvent: SuperwallEvent = .appClose
     var customParameters: [String: Any] = [:]
@@ -258,6 +264,7 @@ enum InternalSuperwallEvent {
 
   struct TriggerFire: TrackableSuperwallEvent {
     let triggerResult: InternalTriggerResult
+    let sessionId: String
     var superwallEvent: SuperwallEvent {
       return .triggerFire(
         eventName: triggerName,
@@ -266,16 +273,13 @@ enum InternalSuperwallEvent {
     }
     let triggerName: String
     var customParameters: [String: Any] = [:]
-    unowned let sessionEventsManager: SessionEventsManager
 
     func getSuperwallParameters() async -> [String: Any] {
       var params: [String: Any] = [
         "trigger_name": triggerName
       ]
 
-      if let triggerSession = await sessionEventsManager.triggerSession.activeTriggerSession {
-        params["trigger_session_id"] = triggerSession.id
-      }
+      params["trigger_session_id"] = sessionId
 
       switch triggerResult {
       case .noRuleMatch(let unmatchedRules):

Sources/SuperwallKit/Analytics/Internal Tracking/Tracking.swift

@@ -40,12 +40,26 @@ extension Superwall {
       )
     }
 
-		let eventData = EventData(
+    let eventData = EventData(
       name: event.rawName,
       parameters: JSON(parameters.eventParams),
       createdAt: eventCreatedAt
     )
-    await dependencyContainer.queue.enqueue(event: eventData.jsonData)
+
+    // If config doesn't exist yet we rely on previous saved feature flag
+    // to determine whether to disable verbose events.
+    let existingDisableVerboseEvents = dependencyContainer.configManager.config?.featureFlags.disableVerboseEvents
+    let previousDisableVerboseEvents = dependencyContainer.storage.get(DisableVerboseEvents.self)
+
+    let verboseEvents = existingDisableVerboseEvents ?? previousDisableVerboseEvents
+
+    if TrackingLogic.isNotDisabledVerboseEvent(
+      event,
+      disableVerboseEvents: verboseEvents,
+      isSandbox: dependencyContainer.makeIsSandbox()
+    ) {
+      await dependencyContainer.queue.enqueue(event: eventData.jsonData)
+    }
     dependencyContainer.storage.coreDataManager.saveEventData(eventData)
 
     if event.canImplicitlyTriggerPaywall {

Sources/SuperwallKit/Analytics/Internal Tracking/TrackingLogic.swift

@@ -83,6 +83,52 @@ enum TrackingLogic {
     )
   }
 
+  static func isNotDisabledVerboseEvent(
+    _ event: Trackable,
+    disableVerboseEvents: Bool?,
+    isSandbox: Bool
+  ) -> Bool {
+    guard let disableVerboseEvents = disableVerboseEvents else {
+      return true
+    }
+    if isSandbox {
+      return true
+    }
+
+    if event is InternalSuperwallEvent.PresentationRequest {
+      return !disableVerboseEvents
+    }
+
+    if let event = event as? InternalSuperwallEvent.PaywallLoad {
+      switch event.state {
+      case .start, .complete:
+        return !disableVerboseEvents
+      default:
+        return true
+      }
+    }
+
+    if let event = event as? InternalSuperwallEvent.PaywallProductsLoad {
+      switch event.state {
+      case .start, .complete:
+        return !disableVerboseEvents
+      default:
+        return true
+      }
+    }
+
+    if let event = event as? InternalSuperwallEvent.PaywallWebviewLoad {
+      switch event.state {
+      case .start, .complete:
+        return !disableVerboseEvents
+      default:
+        return true
+      }
+    }
+
+    return true
+  }
+
   /// Makes optional variables non-optional. Removes `nil`, `NSArray`, `NSDictionary`, and anything that can't be `JSON`, `Date` or `URL`.
   private static func clean(input: Any?) -> Any? {
     guard let input = input else {

Sources/SuperwallKit/Analytics/Superwall Event/SuperwallEvent.swift

@@ -149,6 +149,9 @@ public enum SuperwallEvent {
   /// When the user chose the close button on a survey instead of responding.
   case surveyClose
 
+  /// When ``Superwall/reset()`` is called.
+  case reset
+
   var canImplicitlyTriggerPaywall: Bool {
     switch self {
     case .appInstall,
@@ -265,6 +268,8 @@ extension SuperwallEvent {
       return .init(objcEvent: .touchesBegan)
     case .surveyClose:
       return .init(objcEvent: .surveyClose)
+    case .reset:
+      return .init(objcEvent: .reset)
     }
   }
 }

Sources/SuperwallKit/Analytics/Superwall Event/SuperwallEventObjc.swift

@@ -136,6 +136,9 @@ public enum SuperwallEventObjc: Int, CaseIterable {
   /// When the user taps the close button to skip the survey without recording a response.
   case surveyClose
 
+  /// When ``Superwall/reset()`` is called.
+  case reset
+
   public init(event: SuperwallEvent) {
     self = event.backingData.objcEvent
   }
@@ -218,6 +221,8 @@ public enum SuperwallEventObjc: Int, CaseIterable {
       return "touches_began"
     case .surveyClose:
       return "survey_close"
+    case .reset:
+      return "reset"
     }
   }
 }

Sources/SuperwallKit/Analytics/Trigger Session Manager/Model/Transaction/Product/TriggerSessionProduct.swift

@@ -91,7 +91,7 @@ extension TriggerSession.Transaction {
           type: introductoryPrice.type
         )
 
-        self.introductoryRedeemable = await Superwall.shared.dependencyContainer.storeKitManager.isFreeTrialAvailable(for: product)
+        self.introductoryRedeemable = await Superwall.shared.dependencyContainer.receiptManager.isFreeTrialAvailable(for: product)
         self.hasIntroductoryOffer = true
       } else {
         self.hasIntroductoryOffer = false

Sources/SuperwallKit/Analytics/Trigger Session Manager/TriggerSessionManager.swift

@@ -175,8 +175,8 @@ actor TriggerSessionManager {
     if let triggerResult = triggerResult {
       let trackedEvent = InternalSuperwallEvent.TriggerFire(
         triggerResult: triggerResult,
-        triggerName: eventName,
-        sessionEventsManager: sessionEventsManager
+        sessionId: session.id,
+        triggerName: eventName
       )
       _ = await trackEvent(trackedEvent)
     }

Sources/SuperwallKit/Config/ConfigManager.swift

@@ -46,15 +46,15 @@ class ConfigManager {
   /// A task that is non-`nil` when preloading all paywalls.
   private var currentPreloadingTask: Task<Void, Never>?
 
-  private let factory: RequestFactory & RuleAttributesFactory
+  private let factory: RequestFactory & RuleAttributesFactory & ReceiptFactory
 
   init(
     options: SuperwallOptions?,
     storeKitManager: StoreKitManager,
     storage: Storage,
     network: Network,
     paywallManager: PaywallManager,
-    factory: RequestFactory & RuleAttributesFactory
+    factory: RequestFactory & RuleAttributesFactory & ReceiptFactory
   ) {
     if let options = options {
       self.options = options
@@ -68,17 +68,16 @@ class ConfigManager {
 
   func fetchConfiguration() async {
     do {
-      await storeKitManager.loadPurchasedProducts()
+      _ = await factory.loadPurchasedProducts()
 
       let config = try await network.getConfig { [weak self] in
         self?.configState.send(.retrying)
       }
 
       Task { await sendProductsBack(from: config) }
 
-      triggersByEventName = ConfigLogic.getTriggersByEventName(from: config.triggers)
-      choosePaywallVariants(from: config.triggers)
-      await checkForTouchesBeganTrigger(in: config.triggers)
+      await processConfig(config)
+
       configState.send(.retrieved(config))
 
       Task { await preloadPaywalls() }
@@ -94,6 +93,13 @@ class ConfigManager {
     }
   }
 
+  private func processConfig(_ config: Config) async {
+    storage.save(config.featureFlags.disableVerboseEvents, forType: DisableVerboseEvents.self)
+    triggersByEventName = ConfigLogic.getTriggersByEventName(from: config.triggers)
+    choosePaywallVariants(from: config.triggers)
+    await checkForTouchesBeganTrigger(in: config.triggers)
+  }
+
   /// Reassigns variants and preloads paywalls again.
   func reset() {
     guard let config = configState.value.getConfig() else {

Sources/SuperwallKit/Config/Models/FeatureFlags.swift

@@ -17,6 +17,7 @@ struct FeatureFlags: Decodable {
   var enablePostback: Bool
   var enableExpressionParameters: Bool
   var enableUserIdSeed: Bool
+  var disableVerboseEvents: Bool
 
   enum CodingKeys: String, CodingKey {
     case toggles
@@ -30,18 +31,21 @@ struct FeatureFlags: Decodable {
     enableExpressionParameters = rawFeatureFlags.value(forKey: "enable_expression_params", default: false)
     enablePostback = rawFeatureFlags.value(forKey: "enable_postback", default: false)
     enableUserIdSeed = rawFeatureFlags.value(forKey: "enable_userid_seed", default: false)
+    disableVerboseEvents = rawFeatureFlags.value(forKey: "disable_verbose_events", default: false)
   }
 
   init(
     enableSessionEvents: Bool,
     enablePostback: Bool,
     enableExpressionParameters: Bool,
-    enableUserIdSeed: Bool
+    enableUserIdSeed: Bool,
+    disableVerboseEvents: Bool
   ) {
     self.enableSessionEvents = enableSessionEvents
     self.enablePostback = enablePostback
     self.enableExpressionParameters = enableExpressionParameters
     self.enableUserIdSeed = enableUserIdSeed
+    self.disableVerboseEvents = disableVerboseEvents
   }
 }
 
@@ -63,7 +67,8 @@ extension FeatureFlags: Stubbable {
       enableSessionEvents: true,
       enablePostback: true,
       enableExpressionParameters: true,
-      enableUserIdSeed: true
+      enableUserIdSeed: true,
+      disableVerboseEvents: true
     )
   }
 }

Sources/SuperwallKit/Debug/SWBounceButton.swift

@@ -23,9 +23,7 @@ final class SWBounceButton: UIButton {
   var toggleKey = "key"
   var isOn = false
   var canToggle = false
-
   var oldTitle: String = ""
-
   var showLoading = false {
     didSet {
       if showLoading {
@@ -53,15 +51,6 @@ final class SWBounceButton: UIButton {
     return view
   }()
 
-  var customTint: UIColor? {
-    didSet {
-      if let customTint = customTint {
-        backgroundColor = customTint.withAlphaComponent(0.15)
-        setTitleColor(customTint, for: .normal)
-      }
-    }
-  }
-
   var onBackgroundColor: UIColor = primaryButtonBackgroundColor
   var offBackgroundColor: UIColor = secondaryButtonBackgroundColor
 
@@ -94,14 +83,6 @@ final class SWBounceButton: UIButton {
     }
   }
 
-  private var _borderColor: UIColor?
-  var borderColor: UIColor? {
-    didSet {
-      _borderColor = borderColor
-      self.layer.borderColor = (borderColor ?? UIColor.clear).cgColor
-    }
-  }
-
   // MARK: - Initializers
   convenience init() {
     self.init(frame: CGRect())
@@ -201,10 +182,6 @@ final class SWBounceButton: UIButton {
     }
   }
 
-  override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
-    self.borderColor = _borderColor
-  }
-
   override func didMoveToSuperview() {
     super.didMoveToSuperview()
     if canToggle {