Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` #2623

NachoSoto · 2023-06-12T16:56:49Z

This method was a hack to deal with apps getting didBecomeActive notifications in the middle of a purchase when the popups were displayed.
This had several problems:

It was only being used for StoreKit 1 purchases
It wasn't used for StoreKit 2 purchases through the SDK
It wasn't used for purchases initiated outside the SDK (like using the upcoming paywall screens)
It updated the cache timestamp to "now", including offerings, despite not actually updating data
It was an indirect and implicit way of solving a problem instead of an explicit one

This solves the same by observing willEnterForeground, which only happens when the app actually comes back from the background, and not when it simply loses focus.

NachoSoto · 2023-06-12T21:24:48Z

Sources/Purchasing/Purchases/PurchasesOrchestrator.swift

@@ -361,7 +361,6 @@ final class PurchasesOrchestrator {
        }

        payment.applicationUsername = self.appUserID
-        self.preventPurchasePopupCallFromTriggeringCacheRefresh(appUserID: self.appUserID)


This is no longer needed, we won't update caches in the middle of a purchase.

…caches on `willEnterForeground` This method was a hack to deal with apps getting `didBecomeActive` notifications in the middle of a purchase when the popups were displayed. This had several problems: - It was only being used for StoreKit 1 purchases - It wasn't used for StoreKit 2 purchases through the SDK - It wasn't used for purchases initiated outside the SDK (like using the upcoming paywall screens) - It updated the cache timestamp to "now", including offerings, despite not actually updating data - It was an indirect and implicit way of solving a problem instead of an explicit one This solves the same by observing `willEnterForeground`, which only happens when the app actually comes back from the background, and not when it simply loses focus.

aboedo · 2023-06-12T22:04:12Z

I went through the trouble of spelunking through RC history to see when that was added, to see if we were missing anything...

Jan 2019 🤯 64e59c9

aboedo · 2023-06-12T22:04:38Z

It was only being used for StoreKit 1 purchases

Could you clarify this? Why would SK2 not trigger didBecomeActive after the modal? Or other stuff? They all show the same UI

aboedo

Godspeed, old hack

aboedo · 2023-06-12T22:06:30Z

Tests/UnitTests/Purchasing/Purchases/PurchasesDelegateTests.swift

-    func testSubscribesToUIApplicationDidBecomeActive() throws {
+    func testSubscribesToUIApplicationWillEnterForeground() throws {
        expect(self.notificationCenter.observers).to(haveCount(2))

        let (_, _, name, _) = try XCTUnwrap(self.notificationCenter.observers.first)
-        expect(name) == SystemInfo.applicationDidBecomeActiveNotification
+        expect(name) == SystemInfo.applicationWillEnterForegroundNotification


maybe we can also test "does not subscribe to app did become active", since doing so would actually introduce a regression where we double-post?

👍🏻 will add.

NachoSoto · 2023-06-12T22:13:35Z

Could you clarify this? Why would SK2 not trigger didBecomeActive after the modal? Or other stuff? They all show the same UI

StoreKit 2 purchases wasn't calling preventPurchasePopupCallFromTriggeringCacheRefresh

@NachoSoto

**This is an automatic release.** ### New Features * New `DebugViewController`: UIKit counterpart for SwiftUI's `debugRevenueCatOverlay` (#2631) via NachoSoto (@NachoSoto) * Created `PaywallExtensions`: `StoreView` and `SubscriptionStoreView` overloads for `Offering` (#2593) via NachoSoto (@NachoSoto) * Introduced `debugRevenueCatOverlay()`: new SwiftUI debug overlay (#2567) via NachoSoto (@NachoSoto) ### Bugfixes * Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` (#2623) via NachoSoto (@NachoSoto) * Fixed `Catalyst` build with `Xcode 15 beta 1` (#2586) via NachoSoto (@NachoSoto) ### Dependency Updates * Bump danger from 9.3.0 to 9.3.1 (#2592) via dependabot[bot] (@dependabot[bot]) ### Other Changes * `StoreTransaction`: added new `Storefront` to API testers (#2634) via NachoSoto (@NachoSoto) * `DebugView`: added snapshot tests (#2630) via NachoSoto (@NachoSoto) * `verifyNoUnfinishedTransactions`/`verifyUnfinishedTransaction`: added missing `#file` parameter (#2625) via NachoSoto (@NachoSoto) * `PostReceiptDataOperation`: clean up cache key (#2628) via NachoSoto (@NachoSoto) * `PurchasesOrchestrator`: also get `Storefront` from SK1 (#2629) via NachoSoto (@NachoSoto) * `CI`: disable iOS 17 for now (#2627) via NachoSoto (@NachoSoto) * `Tests`: fixed crash on iOS 13 (#2624) via NachoSoto (@NachoSoto) * `StoreTransaction`: read `Storefront` from `StoreKit.Transaction` (#2611) via NachoSoto (@NachoSoto) * `StoreKitConfigTestCase`/`BaseStoreKitIntegrationTests`: also clear transactions after every test (#2616) via NachoSoto (@NachoSoto) * `ErrorCode.networkError`: improved description (#2610) via NachoSoto (@NachoSoto) * `PurchaseTester`: make CI job always point to current version (#2622) via NachoSoto (@NachoSoto) * Improved `finishAllUnfinishedTransactions` (#2615) via NachoSoto (@NachoSoto) * `StoreKitConfigTestCase`: improved `waitForStoreKitTestIfNeeded` (#2614) via NachoSoto (@NachoSoto) * `StoreKitConfigTestCase`: set `continueAfterFailure` to `false` (#2617) via NachoSoto (@NachoSoto) * `PaywallExtensions`: fixed compilation (#2613) via NachoSoto (@NachoSoto) * `CI`: added `iOS 17` job (#2591) via NachoSoto (@NachoSoto) * `Encodable.jsonEncodedData`: fixed tests on iOS 17 due to inconsistent key ordering (#2607) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay`: added ability to display new `SubscriptionStoreView` (#2595) via NachoSoto (@NachoSoto) * Refactor: extracted all log strings (#2600) via NachoSoto (@NachoSoto) * Changed tests to work around `URL` decoding differences in `iOS 17` (#2605) via NachoSoto (@NachoSoto) * Removed unnecessary `Strings.trimmedOrError` (#2601) via NachoSoto (@NachoSoto) * Fixed test compilation with `Xcode 15` (#2602) via NachoSoto (@NachoSoto) * Tests: added `iOS 17` snapshots (#2603) via NachoSoto (@NachoSoto) * `StoreProductDiscount`: added `description` (#2604) via NachoSoto (@NachoSoto) * `debugRevenueCatOverlay` improvements (#2594) via NachoSoto (@NachoSoto) * `Xcode 15`: fixed all documentation warnings (#2596) via NachoSoto (@NachoSoto) * `StoreKitObserverModeIntegrationTests`: fixed and disabled SK2 `testPurchaseInDevicePostsReceipt` (#2589) via NachoSoto (@NachoSoto) * `StoreKit2TransactionListener`: added log when receiving `Transactions.Updates` (#2588) via NachoSoto (@NachoSoto) * `Dictionary.MergeStrategy`: simplify implementation (#2587) via NachoSoto (@NachoSoto) * `Configuration.Builder`: fixed doc reference (#2583) via NachoSoto (@NachoSoto) * `APITesters`: available since iOS 11 (#2581) via NachoSoto (@NachoSoto)

…p launch Possibly as a consequence of #2623 we were calling `updateAllCachesIfNeeded` on app launch together with `updateCachesIfInForeground`, meaning that we were updating all caches twice. Thanks to our de-duping logic this is normally not a big issue, but this issue combined with what #2954 fixes, means that if there are pending transactions, opening the app would probably end up posting receipts duplicated times. This adds a new log as well to detect this: > [purchases] DEBUG: ℹ️ Throttling cache update, only 0.8 seconds elapsed And a new integration test that posts `UIApplication.willEnterForegroundNotification` to test this.

NachoSoto added the pr:fix A bug fix label Jun 12, 2023

NachoSoto requested a review from a team June 12, 2023 16:56

NachoSoto force-pushed the nacho/sdk-3172-fix-preventpurchasepopupcallfromtriggeringcacherefresh branch 2 times, most recently from e5312ce to 56b7cb4 Compare June 12, 2023 17:48

NachoSoto mentioned this pull request Jun 12, 2023

OfferingsManager: don't clear offerings cache timestamp when request fails #2359

Merged

NachoSoto changed the title ~~Replaced preventPurchasePopupCallFromTriggeringCacheRefresh with checking purchase in progress~~ [WIP] Replaced preventPurchasePopupCallFromTriggeringCacheRefresh with checking purchase in progress Jun 12, 2023

NachoSoto force-pushed the nacho/sdk-3172-fix-preventpurchasepopupcallfromtriggeringcacherefresh branch 2 times, most recently from 5083bfe to cb946b8 Compare June 12, 2023 21:23

NachoSoto changed the title ~~[WIP] Replaced preventPurchasePopupCallFromTriggeringCacheRefresh with checking purchase in progress~~ Removed preventPurchasePopupCallFromTriggeringCacheRefresh, update caches on willEnterForeground Jun 12, 2023

NachoSoto marked this pull request as ready for review June 12, 2023 21:24

NachoSoto commented Jun 12, 2023

View reviewed changes

NachoSoto force-pushed the nacho/sdk-3172-fix-preventpurchasepopupcallfromtriggeringcacherefresh branch from cb946b8 to c0538c8 Compare June 12, 2023 21:34

aboedo approved these changes Jun 12, 2023

View reviewed changes

Added new test

4ca2b74

NachoSoto enabled auto-merge (squash) June 12, 2023 23:13

NachoSoto merged commit b28f9fb into main Jun 12, 2023

NachoSoto deleted the nacho/sdk-3172-fix-preventpurchasepopupcallfromtriggeringcacherefresh branch June 12, 2023 23:26

This was referenced Jun 13, 2023

[AUTOMATIC] Release/4.22.0 #2633

Closed

[AUTOMATIC] Release/4.22.0 #2637

Merged

NachoSoto mentioned this pull request Aug 8, 2023

Performance: throttle cache updates, and avoid double updates on app launch #2983

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` #2623

Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` #2623

NachoSoto commented Jun 12, 2023 •

edited

Loading

NachoSoto Jun 12, 2023

aboedo commented Jun 12, 2023

aboedo commented Jun 12, 2023 •

edited

Loading

aboedo left a comment

aboedo Jun 12, 2023

NachoSoto Jun 12, 2023

NachoSoto commented Jun 12, 2023

Removed preventPurchasePopupCallFromTriggeringCacheRefresh, update caches on willEnterForeground #2623

Removed preventPurchasePopupCallFromTriggeringCacheRefresh, update caches on willEnterForeground #2623

Conversation

NachoSoto commented Jun 12, 2023 • edited Loading

NachoSoto Jun 12, 2023

Choose a reason for hiding this comment

aboedo commented Jun 12, 2023

aboedo commented Jun 12, 2023 • edited Loading

aboedo left a comment

Choose a reason for hiding this comment

aboedo Jun 12, 2023

Choose a reason for hiding this comment

NachoSoto Jun 12, 2023

Choose a reason for hiding this comment

NachoSoto commented Jun 12, 2023

Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` #2623

Removed `preventPurchasePopupCallFromTriggeringCacheRefresh`, update caches on `willEnterForeground` #2623

NachoSoto commented Jun 12, 2023 •

edited

Loading

aboedo commented Jun 12, 2023 •

edited

Loading