Call AppTransaction.refresh() in certain scenarios if AppTransaction.shared is invalid #4099
Conversation
…shared is invalid: - After a purchase - When calling restorePurchaes This will always show an authentication prompt
| @@ -1022,7 +1022,7 @@ private extension PurchasesOrchestrator { | |||
| } | |||
| } | |||
|
|
|||
| func syncPurchases(receiptRefreshPolicy: ReceiptRefreshPolicy, | |||
| func syncPurchases(receiptRefreshAllowed: Bool, | |||
There was a problem hiding this comment.
Since ReceiptRefreshPolicy is very tied to SK1, I changed the parameter to a more SK-agnostic one and decide in the method body what policy to use for each SK version.
| @@ -1139,6 +1140,9 @@ private extension PurchasesOrchestrator { | |||
| return | |||
| } | |||
|
|
|||
| let appTransactionJWS = await self.transactionFetcher.appTransactionJWS( | |||
| refreshPolicy: refreshPolicy) | |||
There was a problem hiding this comment.
Moved fetching the AppTransaction to after the check to see if we have transactions, originalPurchaseDate and originalApplicationVersion.
This way, if we don't need to post the receipt, we wouldn't be fetching the AppTransaction unnecessarily, potentially showing the authentication prompt.
| // Only allow refreshing the AppTransaction if the source was a user action (e.g. purchase) | ||
| let refreshPolicy: AppTransactionRefreshPolicy = | ||
| data.source.initiationSource == .purchase ? .onlyIfEmpty : .never | ||
| self.transactionFetcher.appTransactionJWS(refreshPolicy: refreshPolicy) { appTransaction in |
There was a problem hiding this comment.
We dont want to potentially show the login prompt for transactions coming from the queue
There was a problem hiding this comment.
sounds good, but let's also add that explicitly to the comment, i.e.:
// Only allow refreshing the AppTransaction if the source was a user action (e.g. purchase)
// This is to prevent showing a login prompt unnecessarily
let refreshPolicy: AppTransactionRefreshPolicy =
| self.bundleId = appTransaction.bundleID | ||
| self.originalApplicationVersion = appTransaction.originalAppVersion | ||
| self.originalPurchaseDate = appTransaction.originalPurchaseDate | ||
| self.environment = .init(environment: appTransaction.environment) | ||
| self.jwsRepresentation = jwsRepresentation |
There was a problem hiding this comment.
This is similar to what we already so with the SK2StoreTransaction. The JWS token is part of the VerificationResult, not the AppTansaction, but we want to preserve it.
| @available(iOS 15.0, tvOS 15.0, macOS 12.0, watchOS 8.0, *) | ||
| private var appTransaction: SK2AppTransaction? { | ||
| @available(iOS 16.0, macOS 13.0, tvOS 16.0, watchOS 9.0, *) | ||
| private var refreshedAppTransaction: SK2AppTransaction? { |
There was a problem hiding this comment.
The unified diff of this is a bit weird.
appTransaction was modified into the appTransaction(refreshPolicy:) method below.
and refreshedAppTransaction was added as a helper to fetch an AppTransaction via StoreKit.AppTransaction.refresh()
| var receivedRefreshPolicy: AppTransactionRefreshPolicy? { | ||
| get { return self._receivedRefreshPolicy.value } | ||
| set { self._receivedRefreshPolicy.value = newValue } | ||
| } |
There was a problem hiding this comment.
Added a little helper in the mock so we can check the received refresh policy in different tests.
| // Only allow refreshing the AppTransaction if the source was a user action (e.g. purchase) | ||
| let refreshPolicy: AppTransactionRefreshPolicy = | ||
| data.source.initiationSource == .purchase ? .onlyIfEmpty : .never | ||
| self.transactionFetcher.appTransactionJWS(refreshPolicy: refreshPolicy) { appTransaction in |
There was a problem hiding this comment.
sounds good, but let's also add that explicitly to the comment, i.e.:
// Only allow refreshing the AppTransaction if the source was a user action (e.g. purchase)
// This is to prevent showing a login prompt unnecessarily
let refreshPolicy: AppTransactionRefreshPolicy =
| case .onlyIfEmpty: | ||
| return await refreshedAppTransaction | ||
| case .never: | ||
| Logger.warn(Strings.storeKit.sk2_error_fetching_app_transaction(error)) |
There was a problem hiding this comment.
Would this qualify for a a Logger.appleError?
When
AppTransaction.sharedis empty or invalid, Apple recommends callingAppTransaction.refresh().https://developer.apple.com/documentation/storekit/apptransaction/4020517-refresh
Calling
refresh()will always show an authentication prompt so we want to make sure we only call it in response to a user action:restorePurchasesChecklist
purchases-androidand hybridsMotivation
AppTransaction.sharedseems to be empty more often than expected. We're hoping refreshing it where applicable will improve the situation.Description