Directly send delegate customer info when delegate is set (always sends cached CustomerInfo value)

[joshdholtz]

Motivation

Fixes TRIAGE-55

Issue

Delegate would not always/reliably call didReceiveUpdatedCustomerInfo.

customerInfoManager.sendCachedCustomerInfoIfAvailable would only call the delegate when the latest customer info object was already sent.

☝️ This, according to a customer bug report, appears to be a breaking change between v3 and v4. It also appears to be a difference in behavior with Purchases.shared.customerInfoStream as this gets the initial customer value.

Example

@main
struct PurchaseTesterApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    @State private var revenueCatCustomerData = RevenueCatCustomerData()
    
    var body: some Scene {
        WindowGroup {
            ContentView()
                .environmentObject(revenueCatCustomerData)
                .task {
                    for await customerInfo in Purchases.shared.customerInfoStream {
                        // ✅ This worked fine before and after change
                        // This will get the initial customerInfo as soon as its set
                        self.revenueCatCustomerData.customerInfo = customerInfo
                        self.revenueCatCustomerData.appUserID = Purchases.shared.appUserID
                    }
                }
        }
    }
}

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {

        Purchases.logLevel = .debug
        Purchases.configure(with: Configuration
            .builder(withAPIKey: Constants.apiKey)
            .with(usesStoreKit2IfAvailable: true)
            .build())

        // ❌ This is one way that delegate would not be called right away with customer info
        // There might be other cases too
        // The customerInfo would already have been sent to an async stream and not be forced sent
        // to the new delegate
        DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
            Purchases.shared.delegate = self
        }

        return true
    }
}

extension AppDelegate: PurchasesDelegate {
    func purchases(_ purchases: Purchases, receivedUpdated customerInfo: CustomerInfo) {
        print("New customer info: \(customerInfo)")
    }
}

Bonus Fix

The logs would show CusomterInfo was set to delegate before delegate was set.

2022-08-15 05:19:28.062200-0500 PurchaseTester[10812:71706] [Purchases] - DEBUG: ℹ️ SDK Version - 4.11.0-SNAPSHOT
2022-08-15 05:19:28.062249-0500 PurchaseTester[10812:71706] [Purchases] - DEBUG: 👤 No initial App User ID
2022-08-15 05:19:28.067297-0500 PurchaseTester[10812:71706] [Purchases] - DEBUG: ℹ️ Sending latest CustomerInfo to delegate.
2022-08-15 05:19:30.484881-0500 PurchaseTester[10812:71706] [Purchases] - DEBUG: ℹ️ Delegate set

Description

• No longer relying on customerInfoManager.sendCachedCustomerInfoIfAvailable to call send a value to the delegate when delegate is being sent
  • Instead, sending initial cached customer info directly to the delegate
• Moved log of delegate set before potentially sending CustomerInfo (which will also log)

[aboedo]

talked about it on a call, the fix is solid.
We should:

• write a ticket to make a failing test (Josh will open that ticket up)
• clean up a little bit, adding comments to explain why we're doing this force-update when setting the delegate

[joshdholtz]

@aboedo Updated with new method comments! Do you mind taking another look to make sure they make sense? 😇

[NachoSoto]

This makes sense. I agree with @aboedo that a failing test would be nice.

[NachoSoto]

Tests: #1830