Purchases initialization: refactor to avoid multiple concurrent instances in memory#2180
Merged
Conversation
…tances in memory We allow calling `Purchases.configure` multiple times. Likely a programmer error, but it's common in tests, or for example in `Purchase Tester` where users can re-configure the SDK at runtime (#1999). When this happens, the SDK was creating the new instance before clearing the old one from memory (clear thanks to #2082, notice how the first `deinit` happens after the second `init`): ``` [Purchases] - VERBOSE: Purchases.init: created new Purchases instance: Purchases (0x0000600003ca4200) [Purchases] - INFO: ℹ️ Purchases instance already set. Did you mean to configure two Purchases objects? [Purchases] - VERBOSE: Purchases.init: created new Purchases instance: Purchases (0x0000600003c8a100) [Purchases] - VERBOSE: Purchases.deinit: Purchases (0x0000600003ca4200) [Purchases] - VERBOSE: Purchases.deinit: Purchases (0x0000600003c8a100) ``` With this change, we avoid that, which could also avoid issues with concurrent requests ([CSDK-517]): ``` [Purchases] - VERBOSE: Purchases.init: created new Purchases instance: Purchases (0x0000600002b6e600) [Purchases] - INFO: ℹ️ Purchases instance already set. Did you mean to configure two Purchases objects? [Purchases] - VERBOSE: Purchases.deinit: Purchases (0x0000600002b6e600) [Purchases] - VERBOSE: Purchases.init: created new Purchases instance: Purchases (0x0000600002b68100) [Purchases] - VERBOSE: Purchases.deinit: Purchases (0x0000600002b68100) ```
vegaro
approved these changes
Dec 21, 2022
| static func setDefaultInstance(_ purchases: Purchases) { | ||
| self.purchases.modify { currentInstance in | ||
| @discardableResult | ||
| static func setDefaultInstance(_ purchases: @autoclosure () -> Purchases) -> Purchases { |
Member
There was a problem hiding this comment.
Do you mind adding a comment here why this is an autoclosure and not just an instance of Purchases?
NachoSoto
pushed a commit
that referenced
this pull request
Dec 21, 2022
**This is an automatic release.** ### Bugfixes * `ErrorUtils.purchasesError(withUntypedError:)`: handle `PublicError`s (#2165) via NachoSoto (@NachoSoto) * Fixed race condition finishing `SK1` transactions (#2148) via NachoSoto (@NachoSoto) * `IntroEligibilityStatus`: added `CustomStringConvertible` implementation (#2182) via NachoSoto (@NachoSoto) * `BundleSandboxEnvironmentDetector`: fixed logic for `macOS` (#2176) via NachoSoto (@NachoSoto) * Fixed `AttributionFetcher.adServicesToken` hanging when called in simulator (#2157) via NachoSoto (@NachoSoto) ### Other Changes * `Purchase Tester`: added ability to purchase products directly with `StoreKit` (#2172) via NachoSoto (@NachoSoto) * `DNSChecker`: simplified `NetworkError` initialization (#2166) via NachoSoto (@NachoSoto) * `Purchases` initialization: refactor to avoid multiple concurrent instances in memory (#2180) via NachoSoto (@NachoSoto) * `Purchase Tester`: added button to clear messages on logger view (#2179) via NachoSoto (@NachoSoto) * `NetworkOperation`: added assertion to ensure that subclasses call completion (#2138) via NachoSoto (@NachoSoto) * `CacheableNetworkOperation`: avoid unnecessarily creating operations for cache hits (#2135) via NachoSoto (@NachoSoto) * `PurchaseTester`: fixed `macOS` support (#2175) via NachoSoto (@NachoSoto) * `IntroEligibilityCalculator`: added log including `AppleReceipt` (#2181) via NachoSoto (@NachoSoto) * `Purchase Tester`: fixed scene manifest (#2170) via NachoSoto (@NachoSoto) * `HTTPClientTests`: refactored to use `waitUntil` (#2168) via NachoSoto (@NachoSoto) * `Integration Tests`: split up tests in smaller files (#2158) via NachoSoto (@NachoSoto) * `StoreKitRequestFetcher`: removed unnecessary dispatch (#2152) via NachoSoto (@NachoSoto) * `Purchase Tester`: added companion `watchOS` app (#2140) via NachoSoto (@NachoSoto) * `StoreKit1Wrapper`: added warning if receiving too many updated transactions (#2117) via NachoSoto (@NachoSoto) * `StoreKitTestHelpers`: cleaned up unnecessary log (#2177) via NachoSoto (@NachoSoto) * `TrialOrIntroPriceEligibilityCheckerSK1Tests`: use `waitUntilValue` (#2173) via NachoSoto (@NachoSoto) * `DNSChecker`: added log with resolved host (#2167) via NachoSoto (@NachoSoto) * `MagicWeatherSwiftUI`: updated `README` to point to workspace (#2142) via NachoSoto (@NachoSoto) * `Purchase Tester`: fixed `.storekit` config file reference (#2171) via NachoSoto (@NachoSoto) * `Purchase Tester`: fixed error alerts (#2169) via NachoSoto (@NachoSoto) * `CI`: don't make releases until `release-checks` pass (#2162) via NachoSoto (@NachoSoto) * `Fastfile`: changed `match` to `readonly` (#2161) via NachoSoto (@NachoSoto)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We allow calling
Purchases.configuremultiple times. Likely a programmer error, but it's common in tests, or for example inPurchase Testerwhere users can re-configure the SDK at runtime (#1999), which is where I saw this issue.When this happens, the SDK was creating the new instance before clearing the old one from memory (clear thanks to #2082). Notice how the first
deinithappens after the secondinit:With this change, we avoid that, which could also avoid issues with concurrent requests (CSDK-517):
Unfortunately we don't have an easy way to test this, especially considering that we prohibit multiple instances in tests (#2100).