Track paywall started loading + load error via EventsListener

Author: ajpallares

RevenueCatUI/Data/PaywallViewConfiguration.swift

@@ -54,6 +54,17 @@ extension PaywallViewConfiguration {
         case offering(Offering)
         case offeringIdentifier(String, presentedOfferingContext: PresentedOfferingContext?)
 
+        /// Empty for the default offering.
+        var offeringIdentifier: String {
+            switch self {
+            case .defaultOffering:
+                return ""
+            case .offering(let offering):
+                return offering.identifier
+            case .offeringIdentifier(let identifier, _):
+                return identifier
+            }
+        }
     }
 
 }

RevenueCatUI/PaywallView.swift

@@ -241,6 +241,9 @@ public struct PaywallView: View {
                         .transition(Self.transition)
                         .task {
                             do {
+                                self.purchaseHandler.trackPaywallStartedLoading(
+                                    offeringIdentifier: self.contentToDisplay.offeringIdentifier
+                                )
                                 guard Purchases.isConfigured else {
                                     throw PaywallError.purchasesNotConfigured
                                 }
@@ -253,6 +256,10 @@ public struct PaywallView: View {
                                     self.customerInfo = try await Purchases.shared.customerInfo()
                                 }
                             } catch let error as NSError {
+                                self.purchaseHandler.trackPaywallFailedToLoad(
+                                    offeringIdentifier: self.contentToDisplay.offeringIdentifier,
+                                    error: error
+                                )
                                 self.error = error
                             }
                         }

RevenueCatUI/Purchasing/MockPurchases.swift

@@ -77,6 +77,10 @@ final class MockPurchases: PaywallPurchasesType {
         await self.trackEventBlock(paywallEvent)
     }
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) async {}
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async {}
+
 #if !ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION
     func invalidateCustomerInfoCache() {
         // No-op, this is a mock implementation.

RevenueCatUI/Purchasing/PaywallPurchasesType.swift

@@ -44,6 +44,12 @@ protocol PaywallPurchasesType: Sendable {
     @Sendable
     func track(paywallEvent: PaywallEvent) async
 
+    @Sendable
+    func trackPaywallStartedLoading(offeringIdentifier: String) async
+
+    @Sendable
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async
+
 #if !ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION
     func invalidateCustomerInfoCache()
 #endif

RevenueCatUI/Purchasing/PurchaseHandler.swift

@@ -400,6 +400,18 @@ extension PurchaseHandler {
         self.track(.impression(.init(), eventData))
     }
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) {
+        Task {
+            await purchases.trackPaywallStartedLoading(offeringIdentifier: offeringIdentifier)
+        }
+    }
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) {
+        Task {
+            await purchases.trackPaywallFailedToLoad(offeringIdentifier: offeringIdentifier, error: error)
+        }
+    }
+
     /// - Returns: whether the event was tracked
     @discardableResult
     func trackPaywallClose() -> Bool {
@@ -523,6 +535,10 @@ private final class NotConfiguredPurchases: PaywallPurchasesType {
 
     func track(paywallEvent: PaywallEvent) async {}
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) async {}
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async {}
+
 #if !ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION
     func invalidateCustomerInfoCache() {}
 #endif

RevenueCatUI/Views/LoadingPaywallView.swift

@@ -191,6 +191,10 @@ private final class LoadingPaywallPurchases: PaywallPurchasesType {
         // Ignoring font loading errors from paywall view
     }
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) async {}
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async {}
+
 }
 
 // MARK: - Shimmer

Sources/Events/EventsManager.swift

@@ -34,13 +34,24 @@ import UIKit
     ///  - error: The JSON encoding error that occurred when encoding `featureEvent`, `nil` if the failure was when
     ///  trying to initialize a `String` with the JSON encoded data using UTF-8.
     func failedToTrackFeatureEvent(_ featureEvent: FeatureEvent, error: Error?)
+
+    /// Called whenever the EventsManager failed to be created.
+    func failedToCreateEventsManager(error: Error)
+
+    func trackPaywallStartedLoading(offeringIdentifier: String)
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error)
 }
 
 protocol EventsManagerType {
 
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func track(featureEvent: FeatureEvent) async
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) async
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async
+
     #if ENABLE_AD_EVENTS_TRACKING
     @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *)
     func track(adEvent: AdEvent) async
@@ -136,6 +147,14 @@ actor EventsManager: EventsManagerType {
         }
     }
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) {
+        self.eventsListener?.trackPaywallStartedLoading(offeringIdentifier: offeringIdentifier)
+    }
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) {
+        self.eventsListener?.trackPaywallFailedToLoad(offeringIdentifier: offeringIdentifier, error: error)
+    }
+
     #if ENABLE_AD_EVENTS_TRACKING
     func track(adEvent: AdEvent) async {
         guard let store = self.adEventStore else {

Sources/Paywalls/Events/Networking/EventsRequest+Paywall.swift

@@ -36,7 +36,8 @@ extension FeatureEventsRequest {
 extension FeatureEventsRequest.PaywallEvent {
 
     enum EventType: String {
-
+        case startLoading = "start_loading"
+        case failedToLoad = "failed_to_load"
         case impression = "paywall_impression"
         case cancel = "paywall_cancel"
         case close = "paywall_close"

Sources/Purchasing/Purchases/Purchases.swift

@@ -508,6 +508,7 @@ public typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
             }
         } catch {
             Logger.verbose(Strings.paywalls.event_manager_failed_to_initialize(error))
+            eventsListener?.failedToCreateEventsManager(error: error)
             eventsManager = nil
         }
 
@@ -1443,6 +1444,14 @@ public extension Purchases {
         await self.eventsManager?.track(featureEvent: paywallEvent)
     }
 
+    func trackPaywallStartedLoading(offeringIdentifier: String) async {
+        await self.eventsManager?.trackPaywallStartedLoading(offeringIdentifier: offeringIdentifier)
+    }
+
+    func trackPaywallFailedToLoad(offeringIdentifier: String, error: Error) async {
+        await self.eventsManager?.trackPaywallFailedToLoad(offeringIdentifier: offeringIdentifier, error: error)
+    }
+
     /// Used by `RevenueCatUI` to keep track of ``CustomerCenterEvent``s.
     @_spi(Internal) func track(customerCenterEvent: any CustomerCenterEventType) {
         operationDispatcher.dispatchOnWorkerThread {