Merge remote-tracking branch 'origin/feature/enrichment' into web2app-and-enrichment

Author: jakemor

CHANGELOG.md

@@ -55,6 +55,7 @@ The changelog for `SuperwallKit`. Also see the [releases](https://github.com/sup
 
 ### Enhancements
 
+- Adds `demandScore` and `demandTier` to device attributes. A user is assigned these based on a variety of factors to determine whether they're more or less likely to pay higher prices and can be used within audience filters.
 - Updates Superscript to 0.2.4.
 
 ## 4.0.6

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

@@ -40,7 +40,7 @@ enum InternalSuperwallEvent {
     func getSuperwallParameters() async -> [String: Any] {
       return [
         "application_installed_at": appInstalledAtString,
-        "using_purchase_controller": hasExternalPurchaseController
+        "using_purchase_controller": hasExternalPurchaseController,
       ]
     }
   }
@@ -70,7 +70,7 @@ enum InternalSuperwallEvent {
       let output = paywallInfo.audienceFilterParams()
       return output + [
         "survey_selected_option_title": selectedOption.title,
-        "survey_custom_response": customResponse as Any
+        "survey_custom_response": customResponse as Any,
       ]
     }
     let survey: Survey
@@ -82,7 +82,7 @@ enum InternalSuperwallEvent {
       let params: [String: Any] = [
         "survey_id": survey.id,
         "survey_assignment_key": survey.assignmentKey,
-        "survey_selected_option_id": selectedOption.id
+        "survey_selected_option_id": selectedOption.id,
       ]
 
       return await paywallInfo.placementParams(otherParams: params)
@@ -128,7 +128,7 @@ enum InternalSuperwallEvent {
         "lastPathComponent": url.lastPathComponent,
         "host": url.host ?? "",
         "query": url.query ?? "",
-        "fragment": url.fragment ?? ""
+        "fragment": url.fragment ?? "",
       ]
     }
 
@@ -207,7 +207,7 @@ enum InternalSuperwallEvent {
       var params = options.toDictionary()
       params += [
         "using_purchase_controller": hasExternalPurchaseController,
-        "has_delegate": hasDelegate
+        "has_delegate": hasDelegate,
       ]
       return params
     }
@@ -323,14 +323,14 @@ enum InternalSuperwallEvent {
         return params + [
           "variant_id": experiment.variant.id as Any,
           "experiment_id": experiment.id as Any,
-          "result": "holdout"
+          "result": "holdout",
         ]
       case let .paywall(experiment):
         return params + [
           "variant_id": experiment.variant.id as Any,
           "experiment_id": experiment.id as Any,
           "paywall_identifier": experiment.variant.paywallId as Any,
-          "result": "present"
+          "result": "present",
         ]
       case .placementNotFound:
         return params + [
@@ -364,19 +364,21 @@ enum InternalSuperwallEvent {
         "source_event_name": placementData?.name ?? "",
         "pipeline_type": type.description,
         "status": status.rawValue,
-        "status_reason": statusReason?.description ?? ""
+        "status_reason": statusReason?.description ?? "",
       ]
 
       if let featureFlags = factory.makeFeatureFlags(),
-        featureFlags.enableExpressionParameters {
+        featureFlags.enableExpressionParameters
+      {
         let computedPropertyRequests = factory.makeComputedPropertyRequests()
         let audienceFilters = await factory.makeAudienceFilterAttributes(
           forPlacement: placementData,
           withComputedProperties: computedPropertyRequests
         )
 
         if let jsonData = try? JSONSerialization.data(withJSONObject: audienceFilters),
-          let decoded = String(data: jsonData, encoding: .utf8) {
+          let decoded = String(data: jsonData, encoding: .utf8)
+        {
           params += [
             "expression_params": decoded
           ]
@@ -582,7 +584,7 @@ enum InternalSuperwallEvent {
       var placementParams: [String: Any] = [
         "store": "APP_STORE",
         "source": source.rawValue,
-        "storekit_version": storeKitVersion.description
+        "storekit_version": storeKitVersion.description,
       ]
 
       switch state {
@@ -597,9 +599,11 @@ enum InternalSuperwallEvent {
         placementParams += [
           "storefront_countryCode": storefrontCountryCode,
           "storefront_id": storefrontId,
-          "transaction_type": type.description
+          "transaction_type": type.description,
         ]
-        let appleSearchAttributes = Superwall.shared.userAttributes.filter { $0.key.hasPrefix("apple_search_ads_") }
+        let appleSearchAttributes = Superwall.shared.userAttributes.filter {
+          $0.key.hasPrefix("apple_search_ads_")
+        }
         placementParams += appleSearchAttributes
         fallthrough
       case .start,
@@ -801,7 +805,7 @@ enum InternalSuperwallEvent {
         "config_build_id": buildId,
         "retry_count": retryCount,
         "cache_status": cacheStatus.rawValue,
-        "fetch_duration": fetchDuration
+        "fetch_duration": fetchDuration,
       ]
     }
   }
@@ -905,4 +909,44 @@ enum InternalSuperwallEvent {
     let audienceFilterParams: [String: Any] = [:]
     func getSuperwallParameters() async -> [String: Any] { return [:] }
   }
+
+  struct EnrichmentLoad: TrackableSuperwallEvent {
+    enum State {
+      case start
+      case complete(Enrichment)
+      case fail
+    }
+    let state: State
+
+    var superwallEvent: SuperwallEvent {
+      switch state {
+        case .start:
+          return .enrichmentStart
+        case .complete(let enrichment):
+          return .enrichmentComplete(
+            userEnrichment: enrichment.user.dictionaryObject,
+            deviceEnrichment: enrichment.device.dictionaryObject
+          )
+        case .fail:
+          return .enrichmentFail
+      }
+    }
+    let audienceFilterParams: [String: Any] = [:]
+
+    func getSuperwallParameters() async -> [String: Any] {
+      var output: [String: Any] = [:]
+      switch state {
+        case .complete(let enrichment):
+          for (key, value) in enrichment.user {
+            output["user_\(key)"] = value
+          }
+          for (key, value) in enrichment.device {
+            output["device_\(key)"] = value
+          }
+          return output
+        default:
+          return [:]
+      }
+    }
+  }
 }

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

@@ -216,6 +216,15 @@ public enum SuperwallEvent {
   /// When the redemption of a code fails.
   case redemptionFail
 
+  /// When the enrichment request starts.
+  case enrichmentStart
+
+  /// When the enrichment request completes.
+  case enrichmentComplete(userEnrichment: [String: Any]?, deviceEnrichment: [String: Any]?)
+
+  /// When the enrichment request fails.
+  case enrichmentFail
+
   var canImplicitlyTriggerPaywall: Bool {
     switch self {
     case .appInstall,
@@ -373,6 +382,12 @@ extension SuperwallEvent {
       return .init(objcEvent: .redemptionComplete)
     case .redemptionFail:
       return .init(objcEvent: .redemptionFail)
+    case .enrichmentFail:
+      return .init(objcEvent: .enrichmentFail)
+    case .enrichmentStart:
+      return .init(objcEvent: .enrichmentStart)
+    case .enrichmentComplete:
+      return .init(objcEvent: .enrichmentComplete)
     }
   }
 }

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

@@ -196,6 +196,15 @@ public enum SuperwallEventObjc: Int, CaseIterable {
   /// When the redemption of a code fails.
   case redemptionFail
 
+  /// When the enrichment request starts.
+  case enrichmentStart
+
+  /// When the enrichment request completes.
+  case enrichmentComplete
+
+  /// When the enrichment request fails.
+  case enrichmentFail
+
   public init(event: SuperwallEvent) {
     self = event.backingData.objcEvent
   }
@@ -318,6 +327,13 @@ public enum SuperwallEventObjc: Int, CaseIterable {
       return "redemption_complete"
     case .redemptionFail:
       return "redemption_fail"
+    case .enrichmentStart:
+      return "enrichment_start"
+    case .enrichmentFail:
+      return "enrichment_fail"
+    case .enrichmentComplete:
+      return "enrichment_complete"
+
     }
   }
 }

Sources/SuperwallKit/Config/ConfigManager.swift

@@ -93,6 +93,9 @@ class ConfigManager {
     }
 
     do {
+      Task {
+        try? await deviceHelper.getEnrichment()
+      }
       let startAt = Date()
       let newConfig = try await network.getConfig { [weak self] attempt in
         self?.configRetryCount = attempt
@@ -146,10 +149,7 @@ class ConfigManager {
         if let cachedConfig = cachedConfig,
           enableConfigRefresh {
           do {
-            let result = try await self.fetchWithTimeout({
-              try await self.network.getConfig(maxRetry: 0)
-            },
-            timeout: timeout)
+            let result = try await self.network.getConfig(maxRetry: 0, timeout: timeout)
             return (result, false)
           } catch {
             // Return the cached config and set isUsingCached to true
@@ -164,34 +164,31 @@ class ConfigManager {
         }
       }()
 
-      async let isUsingCachedGeo: Bool = { [weak self] in
+      async let isUsingCachedEnrichment: Bool = { [weak self] in
         guard let self = self else {
           return false
         }
-        let cachedGeoInfo = self.storage.get(LatestGeoInfo.self)
+        let cachedEnrichment = self.storage.get(LatestEnrichment.self)
 
-        if let cachedGeoInfo = cachedGeoInfo,
+        if let cachedEnrichment = cachedEnrichment,
           enableConfigRefresh {
           do {
-            let geoInfo = try await self.fetchWithTimeout({
-              try await self.network.getGeoInfo(maxRetry: 0)
-            },
-            timeout: timeout)
-            self.deviceHelper.geoInfo = geoInfo
+            let enrichment = try await self.deviceHelper.getEnrichment(maxRetry: 0, timeout: timeout)
+            self.deviceHelper.enrichment = enrichment
             return false
           } catch {
-            self.deviceHelper.geoInfo = cachedGeoInfo
+            self.deviceHelper.enrichment = cachedEnrichment
             return true
           }
         } else {
-          await self.deviceHelper.getGeoInfo()
+          _ = try? await self.deviceHelper.getEnrichment()
           return false
         }
       }()
 
       let (config, isUsingCachedConfig) = try await configResult
       let configFetchDuration = Date().timeIntervalSince(startAt)
-      let isUsingCachedGeoInfo = await isUsingCachedGeo
+      let usingCachedEnrichment = await isUsingCachedEnrichment
 
       let cacheStatus: InternalSuperwallEvent.ConfigCacheStatus =
         isUsingCachedConfig ? .cached : .notCached
@@ -217,9 +214,9 @@ class ConfigManager {
       Task {
         await preloadPaywalls()
       }
-      if isUsingCachedGeoInfo {
+      if usingCachedEnrichment {
         Task {
-          await deviceHelper.getGeoInfo()
+          try? await deviceHelper.getEnrichment()
         }
       }
       if isUsingCachedConfig {
@@ -245,35 +242,6 @@ class ConfigManager {
     }
   }
 
-  private func fetchWithTimeout<T>(
-    _ task: @escaping () async throws -> T,
-    timeout: TimeInterval
-  ) async throws -> T {
-    try await withThrowingTaskGroup(of: T.self) { group in
-      group.addTask {
-        try await task()
-      }
-
-      group.addTask {
-        try await Task.sleep(nanoseconds: UInt64(timeout * 1_000_000_000))
-        throw CancellationError()
-      }
-
-      do {
-        let result = try await group.next()
-        group.cancelAll()
-        if let result = result {
-          return result
-        } else {
-          throw CancellationError()
-        }
-      } catch {
-        group.cancelAll()
-        throw error
-      }
-    }
-  }
-
   private func processConfig(
     _ config: Config,
     isFirstTime: Bool

Sources/SuperwallKit/Config/Options/SuperwallOptions.swift

@@ -126,8 +126,8 @@ public final class SuperwallOptions: NSObject, Encodable {
       }
     }
 
-    var geoHost: String {
-      "geo-api.superwall.com"
+    var enrichmentHost: String {
+      "enrichment-api.superwall.com"
     }
 
     var adServicesHost: String {

Sources/SuperwallKit/Dependencies/DependencyContainer.swift

@@ -170,14 +170,18 @@ final class DependencyContainer {
   }
 }
 
-// MARK: - IdentityInfoFactory
-extension DependencyContainer: IdentityInfoFactory {
+// MARK: - IdentityFactory
+extension DependencyContainer: IdentityFactory {
   func makeIdentityInfo() -> IdentityInfo {
     return IdentityInfo(
       aliasId: identityManager.aliasId,
       appUserId: identityManager.appUserId
     )
   }
+
+  func makeIdentityManager() -> IdentityManager {
+    return identityManager
+  }
 }
 
 extension DependencyContainer: TransactionManagerFactory {

Sources/SuperwallKit/Dependencies/FactoryProtocols.swift

@@ -80,8 +80,9 @@ protocol ConfigManagerFactory: AnyObject {
   ) -> Paywall?
 }
 
-protocol IdentityInfoFactory: AnyObject {
+protocol IdentityFactory: AnyObject {
   func makeIdentityInfo() async -> IdentityInfo
+  func makeIdentityManager() -> IdentityManager
 }
 
 protocol TransactionManagerFactory: AnyObject {