`Purchases`: don't clear intro eligibility / purchased products cache on first launch #3067

NachoSoto · 2023-08-23T20:34:08Z

These caches are important, especially for RevenueCatUI.
Without this fix, launching the app was doing this:

Pre-warming cache
Pre-warming cache a second time (to be fixed by a separate PR)
Clearing cache

Which meant that the cache wasn't really warm when launching paywalls.

To fix that, this only clears the cache after receiving an actual change.

I've also removed CustomerInfoManager.sendCachedCustomerInfoIfAvailable because it wasn't used.

NachoSoto · 2023-08-24T18:27:19Z

Sources/Identity/CustomerInfoManager.swift

@@ -100,14 +98,6 @@ class CustomerInfoManager {
        }
    }

-    func sendCachedCustomerInfoIfAvailable(appUserID: String) {


This wasn't being used by anything other than in tests.

interesting! I guess it's a holder from this: #1828

NachoSoto · 2023-08-24T18:27:28Z

Sources/Identity/CustomerInfoManager.swift

@@ -19,8 +19,6 @@ class CustomerInfoManager {

    typealias CustomerInfoCompletion = @MainActor @Sendable (Result<CustomerInfo, BackendError>) -> Void

-    var lastSentCustomerInfo: CustomerInfo? { return self.data.value.lastSentCustomerInfo }


This was only visible for tests so I moved it below.

NachoSoto · 2023-08-24T18:28:34Z

Sources/Purchasing/Purchases/Purchases.swift

-        self.purchasedProductsFetcher?.clearCache()
-        self.delegate?.purchases?(self, receivedUpdated: customerInfo)
+    func handleCustomerInfoChanged(from old: CustomerInfo?, to new: CustomerInfo) {
+        if old != nil {


This is the core of this change. We no longer clear the caches for the first time we receive a customer info change.

NachoSoto · 2023-08-24T18:28:48Z

Tests/UnitTests/Identity/CustomerInfoManagerTests.swift

@@ -196,51 +207,10 @@ class CustomerInfoManagerTests: BaseCustomerInfoManagerTests {
        expect(self.mockBackend.invokedGetSubscriberDataCount) == 1
    }

-    func testSendCachedCustomerInfoIfAvailableForAppUserIDSendsIfNeverSent() throws {


Removed all these tests for the unused method.

NachoSoto · 2023-08-24T18:29:02Z

Tests/UnitTests/Identity/CustomerInfoManagerTests.swift

+        expect(self.customerInfoManagerLastCustomerInfoChange) == (old: nil, new: self.mockCustomerInfo)
+    }
+
+    func testCacheCustomerInfoSendsMultipleUpdatesIfChange() throws {


We didn't have this test.

NachoSoto · 2023-08-24T18:29:19Z

Tests/UnitTests/Identity/CustomerInfoManagerTests.swift

+        expect(self.customerInfoManagerLastCustomerInfoChange) == (old: nil, new: info)
+    }
+
+    func testCacheCustomerInfoSendsToDelegateAfterCachingComputedOnDevice() {


The first implementation broke integration tests in a way that this test now captures.

NachoSoto · 2023-08-24T18:30:09Z

Sources/Identity/CustomerInfoManager.swift

@@ -215,7 +205,12 @@ class CustomerInfoManager {
    func clearCustomerInfoCache(forAppUserID appUserID: String) {
        self.modifyData {
            $0.deviceCache.clearCustomerInfoCache(appUserID: appUserID)
-            $0.lastSentCustomerInfo = nil


This didn't make sense. It didn't matter because the property wasn't used by anything, but now this is used for sending the "old" value. Resetting this broke an integration test, which is what I captured in the new testCacheCustomerInfoSendsToDelegateAfterCachingComputedOnDevice test.

NachoSoto · 2023-08-24T18:30:34Z

Tests/UnitTests/Purchasing/Purchases/PurchasesConfiguringTests.swift

+    func testFirstInitializationDoesNotClearIntroEligibilityCache() {
+        self.setupPurchases()
+        expect(self.purchasesDelegate.customerInfoReceivedCount).toEventually(equal(1))
+
+        expect(self.cachingTrialOrIntroPriceEligibilityChecker.invokedClearCache) == false
+    }
+
+    func testFirstInitializationDoesNotClearPurchasedProductsCache() {
+        self.setupPurchases()
+        expect(self.purchasesDelegate.customerInfoReceivedCount).toEventually(equal(1))
+
+        expect(self.mockPurchasedProductsFetcher.invokedClearCache) == false
+    }
+


Tests to capture the new behavior.

… on first launch These caches are important, especially for `RevenueCatUI`. Without this fix, launching the app was doing this: - Pre-warming cache - Pre-warming cache a second time (to be fixed by a separate PR) - Clearing cache Which meant that the cache wasn't really warm when launching paywalls. To fix that, this only clears the cache after receiving an actual change. I've also removed `CustomerInfoManager.sendCachedCustomerInfoIfAvailable` because it wasn't used.

codecov · 2023-08-24T22:55:04Z

Codecov Report

Merging #3067 (5392d52) into main (d4145e6) will increase coverage by 0.05%.
The diff coverage is 96.00%.

@@            Coverage Diff             @@
##             main    #3067      +/-   ##
==========================================
+ Coverage   86.58%   86.64%   +0.05%     
==========================================
  Files         219      219              
  Lines       15674    15676       +2     
==========================================
+ Hits        13572    13582      +10     
+ Misses       2102     2094       -8

Files Changed	Coverage Δ
Sources/Identity/CustomerInfoManager.swift	`95.04% <93.33%> (+0.27%)`	⬆️
Sources/Purchasing/Purchases/Purchases.swift	`75.93% <100.00%> (+0.11%)`	⬆️

... and 3 files with indirect coverage changes

aboedo

this reminds me of this old idea: https://linear.app/revenuecat/issue/SDK-2871/new-customerinfo-listener-with-diff, feels like this change would make that pretty much trivial?

NachoSoto · 2023-08-30T22:38:01Z

Oh that's right 😇 this paves the way for that.

… on first launch (#3067) These caches are important, especially for `RevenueCatUI`. Without this fix, launching the app was doing this: - Pre-warming cache - Pre-warming cache a second time (to be fixed by a separate PR) - Clearing cache Which meant that the cache wasn't really warm when launching paywalls. To fix that, this only clears the cache after receiving an actual change. I've also removed `CustomerInfoManager.sendCachedCustomerInfoIfAvailable` because it wasn't used.

@NachoSoto

**This is an automatic release.** ### Bugfixes * `DebugViewModel`: fixed runtime crash on iOS < 16 (#3139) via NachoSoto (@NachoSoto) ### Performance Improvements * `PurchasesOrchestrator`: return early if receipt has no transactions when checking for promo offers (#3123) via Mark Villacampa (@MarkVillacampa) * `Purchases`: don't clear intro eligibility / purchased products cache on first launch (#3067) via NachoSoto (@NachoSoto) ### Dependency Updates * `SPM`: update `Package.resolved` (#3130) via NachoSoto (@NachoSoto) ### Other Changes * `ReceiptParser`: fixed SPM build (#3144) via NachoSoto (@NachoSoto) * `carthage_installation_tests`: optimize SPM package loading (#3129) via NachoSoto (@NachoSoto) * `CI`: add workaround for `Carthage` timing out (#3119) via NachoSoto (@NachoSoto) * `Integration Tests`: workaround to not lose debug logs (#3108) via NachoSoto (@NachoSoto)

… on first launch (#3067) These caches are important, especially for `RevenueCatUI`. Without this fix, launching the app was doing this: - Pre-warming cache - Pre-warming cache a second time (to be fixed by a separate PR) - Clearing cache Which meant that the cache wasn't really warm when launching paywalls. To fix that, this only clears the cache after receiving an actual change. I've also removed `CustomerInfoManager.sendCachedCustomerInfoIfAvailable` because it wasn't used.

@NachoSoto

**This is an automatic release.** ### Bugfixes * `DebugViewModel`: fixed runtime crash on iOS < 16 (#3139) via NachoSoto (@NachoSoto) ### Performance Improvements * `PurchasesOrchestrator`: return early if receipt has no transactions when checking for promo offers (#3123) via Mark Villacampa (@MarkVillacampa) * `Purchases`: don't clear intro eligibility / purchased products cache on first launch (#3067) via NachoSoto (@NachoSoto) ### Dependency Updates * `SPM`: update `Package.resolved` (#3130) via NachoSoto (@NachoSoto) ### Other Changes * `ReceiptParser`: fixed SPM build (#3144) via NachoSoto (@NachoSoto) * `carthage_installation_tests`: optimize SPM package loading (#3129) via NachoSoto (@NachoSoto) * `CI`: add workaround for `Carthage` timing out (#3119) via NachoSoto (@NachoSoto) * `Integration Tests`: workaround to not lose debug logs (#3108) via NachoSoto (@NachoSoto)

rafaelnobrekz · 2023-11-02T01:24:54Z

Hey @NachoSoto , is there even a way to clear these caches from the user side at all ? I'm having stale cache issues that persist even across a cold app start

edit: for eligibility I mean

NachoSoto · 2023-11-02T01:26:46Z

There is not currently. What are you observing? Could you share some logs so we can take a look?

rafaelnobrekz · 2023-11-02T01:31:26Z

We're hoping to add some trial introductory offers a few weeks from now, and that would go along with some UI updates on the paywall to showcase it to the users. But it takes a long time for the SDK to catch up with any updates we do on App Store Connect, it comes back from disk cache it seems:

2023-11-01 22:20:23.887923-0300 Kinzoo[92535:24609323] [offering] DEBUG: ℹ️ Skipping products request for these products because they were already cached: ["com.kinzoo.app.staging.club.yearly", "com.kinzoo.app.staging.club.monthly"]
2023-11-01 22:20:23.921121-0300 Kinzoo[92535:24609323] [customer] DEBUG: ℹ️ Local intro eligibility computed locally. Result: ["com.kinzoo.app.staging.club.monthly": IntroEligibilityStatus.eligible, "com.kinzoo.app.staging.club.yearly": IntroEligibilityStatus.noIntroOfferExists]
2023-11-01 22:20:23.921359-0300 Kinzoo[92535:24609323] [eligibility] DEBUG: ℹ️ Caching trial or intro eligibility for products: ["com.kinzoo.app.staging.club.yearly", "com.kinzoo.app.staging.club.monthly"]

Could you share with me what is the cache window duration if any? I believe it would have cleared if I killed the app, but apparently it does not

rafaelnobrekz · 2023-11-02T01:37:13Z

The test I'm doing is actually adding/removing a free trial on App Store Connect, so product caching might also play a factor (using the default offering for this)

NachoSoto · 2023-11-02T17:03:10Z

it comes back from disk cache it seems:

Intro eligibility is never cached on disk though, only in memory (so re-computed when launching the app). The cache is cleared whenever the CustomerInfo changes (after a purchase, or when fetching an updated value from the server.

But it takes a long time for the SDK to catch up with any updates we do on App Store Connect

Interesting. What types of changes are you making and what do you observe? Also can confirm if you're using SK1 or SK2?

rafaelnobrekz · 2023-11-02T20:54:17Z

Intro eligibility is never cached on disk though, only in memory (so re-computed when launching the app). The cache is cleared whenever the CustomerInfo changes (after a purchase, or when fetching an updated value from the server.

Cool, thanks for the assurance. I did notice the clearCache() call in handleCustomerChanged, would calling Purchases.shared.getCustomerInfo(fetchPolicy: .fetchCurrent) have any effect when the customer data does not change in an attempt to clear the cache through that means? Not that it would be any efficient. Anyway, the changes surviving restart suggest this is not my issue, possibly RC product cache (is it also memory-only?) or even StoreKit product caching.

Interesting. What types of changes are you making and what do you observe? Also can confirm if you're using SK1 or SK2?

I am removing an existing Introductory Offer from App Store Connect (or adding one if it did not exist). I assume it wouldn't be a very common scenario, but it was caught by our QA team and we're trying to understand exactly what is the criteria for this to update or nudge it in the right way to refresh.
Regarding StoreKit, we're using the defaults for latest RC 4.29.0 so I assume it's SK2 for eligibility checking and SK1 for product listing and purchasing?

NachoSoto · 2023-11-06T16:12:29Z

Anyway, the changes surviving restart suggest this is not my issue, possibly RC product cache (is it also memory-only?) or even StoreKit product caching.

The SDK also doesn't have any on-disk product cache.

Regarding StoreKit, we're using the defaults for latest RC 4.29.0 so I assume it's SK2 for eligibility checking and SK1 for product listing and purchasing?

The default is SK1 for everything.

we're trying to understand exactly what is the criteria for this to update or nudge it in the right way to refresh.

Our current guess is that there's some propagation lag by Apple when you update offers in ASC.
For testing this behavior I'd recommend using SK config files where you can simulate these changes more effectively than relying on ASC servers catching up 👍🏻

rafaelnobrekz · 2023-11-06T19:40:12Z

When using a SK file to introduce / remove the trial offers it reflects as soon as I run the new code as expected. Simulating realtime updates won't be possible and those would be cached by RC's eligibility checker anyway, so I think that's good enough as Apple is the main bottleneck here!
Thanks for all the information @NachoSoto !

NachoSoto added the perf A code change that improves performance label Aug 23, 2023

NachoSoto requested a review from a team August 23, 2023 20:34

NachoSoto force-pushed the invalidate-caches-only-if-old-customer-info branch 2 times, most recently from f3fecaa to c92bf68 Compare August 24, 2023 18:26

NachoSoto commented Aug 24, 2023

View reviewed changes

NachoSoto force-pushed the invalidate-caches-only-if-old-customer-info branch 2 times, most recently from f5705fa to 5ebd497 Compare August 24, 2023 18:28

NachoSoto commented Aug 24, 2023

View reviewed changes

joshdholtz approved these changes Aug 24, 2023

View reviewed changes

NachoSoto requested a review from aboedo August 24, 2023 20:28

NachoSoto assigned NachoSoto and aboedo and unassigned NachoSoto Aug 24, 2023

NachoSoto added 2 commits August 24, 2023 15:30

Fixed integration tests

5392d52

NachoSoto force-pushed the invalidate-caches-only-if-old-customer-info branch from 5ebd497 to 5392d52 Compare August 24, 2023 22:30

aboedo approved these changes Aug 30, 2023

View reviewed changes

NachoSoto merged commit cdcd1a0 into main Aug 30, 2023
17 checks passed

NachoSoto deleted the invalidate-caches-only-if-old-customer-info branch August 30, 2023 22:38

NachoSoto mentioned this pull request Aug 31, 2023

[DO NOT MERGE] Release/4.26.0-beta.2 #3127

Closed

RCGitBot mentioned this pull request Sep 5, 2023

[AUTOMATIC] Release/4.25.9 #3143

Closed

RCGitBot mentioned this pull request Sep 5, 2023

[AUTOMATIC] Release/4.25.9 #3145

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Purchases`: don't clear intro eligibility / purchased products cache on first launch #3067

`Purchases`: don't clear intro eligibility / purchased products cache on first launch #3067

NachoSoto commented Aug 23, 2023

NachoSoto Aug 24, 2023

aboedo Aug 30, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

NachoSoto Aug 24, 2023

codecov bot commented Aug 24, 2023 •

edited

Loading

aboedo left a comment •

edited

Loading

NachoSoto commented Aug 30, 2023

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading

NachoSoto commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading

NachoSoto commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading

NachoSoto commented Nov 6, 2023

rafaelnobrekz commented Nov 6, 2023

		@@ -19,8 +19,6 @@ class CustomerInfoManager {

		typealias CustomerInfoCompletion = @MainActor @Sendable (Result<CustomerInfo, BackendError>) -> Void

		var lastSentCustomerInfo: CustomerInfo? { return self.data.value.lastSentCustomerInfo }

Purchases: don't clear intro eligibility / purchased products cache on first launch #3067

Purchases: don't clear intro eligibility / purchased products cache on first launch #3067

Conversation

NachoSoto commented Aug 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 24, 2023 • edited Loading

Codecov Report

aboedo left a comment • edited Loading

Choose a reason for hiding this comment

NachoSoto commented Aug 30, 2023

rafaelnobrekz commented Nov 2, 2023 • edited Loading

NachoSoto commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023 • edited Loading

NachoSoto commented Nov 2, 2023

rafaelnobrekz commented Nov 2, 2023 • edited Loading

NachoSoto commented Nov 6, 2023

rafaelnobrekz commented Nov 6, 2023

`Purchases`: don't clear intro eligibility / purchased products cache on first launch #3067

`Purchases`: don't clear intro eligibility / purchased products cache on first launch #3067

codecov bot commented Aug 24, 2023 •

edited

Loading

aboedo left a comment •

edited

Loading

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading

rafaelnobrekz commented Nov 2, 2023 •

edited

Loading