Paywalls manually handle purchases, finishTransactions/ObserverMode -> PurchasesAreCompletedBy #3917
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,6 +63,21 @@ enum Logger { | |
| ) | ||
| } | ||
|
|
||
| static func error( | ||
| _ text: CustomStringConvertible, | ||
| file: String = #file, | ||
| function: String = #function, | ||
| line: UInt = #line | ||
| ) { | ||
| Self.log( | ||
| text, | ||
| .error, | ||
| file: file, | ||
| function: function, | ||
| line: line | ||
| ) | ||
| } | ||
|
|
||
| private static func log( | ||
| _ text: CustomStringConvertible, | ||
| _ level: LogLevel, | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -310,6 +310,10 @@ struct LoadedOfferingPaywallView: View { | |
| value: self.purchaseHandler.packageBeingPurchased) | ||
| .preference(key: PurchasedResultPreferenceKey.self, | ||
| value: .init(data: self.purchaseHandler.purchaseResult)) | ||
| .preference(key: HandlePurchasePreferenceKey.self, | ||
| value: self.purchaseHandler.performPurchase) | ||
| .preference(key: HandleRestorePreferenceKey.self, | ||
| value: self.purchaseHandler.performRestore) | ||
| .preference(key: RestoredCustomerInfoPreferenceKey.self, | ||
| value: self.purchaseHandler.restoredCustomerInfo) | ||
| .preference(key: RestoreInProgressPreferenceKey.self, | ||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,22 +19,38 @@ import RevenueCat | |
| @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *) | ||
| final class MockPurchases: PaywallPurchasesType { | ||
|
|
||
| typealias CustomerInfoBlock = @Sendable () async throws -> CustomerInfo | ||
| typealias PurchaseBlock = @Sendable (Package) async throws -> PurchaseResultData | ||
| typealias RestoreBlock = @Sendable () async throws -> CustomerInfo | ||
| typealias TrackEventBlock = @Sendable (PaywallEvent) async -> Void | ||
|
|
||
| private let customerInfoBlock: CustomerInfoBlock | ||
| private let purchaseBlock: PurchaseBlock | ||
| private let restoreBlock: RestoreBlock | ||
| private let trackEventBlock: TrackEventBlock | ||
| private let _purchasesAreCompletedBy: PurchasesAreCompletedBy | ||
|
|
||
| var purchasesAreCompletedBy: PurchasesAreCompletedBy { | ||
| get { return _purchasesAreCompletedBy } | ||
| set { _ = newValue } | ||
| } | ||
|
|
||
| init( | ||
| purchasesAreCompletedBy: PurchasesAreCompletedBy = .revenueCat, | ||
| purchase: @escaping PurchaseBlock, | ||
| restorePurchases: @escaping RestoreBlock, | ||
| trackEvent: @escaping TrackEventBlock, | ||
| customerInfo: @escaping CustomerInfoBlock | ||
| ) { | ||
| self.purchaseBlock = purchase | ||
| self.restoreBlock = restorePurchases | ||
| self.trackEventBlock = trackEvent | ||
| self.customerInfoBlock = customerInfo | ||
| self._purchasesAreCompletedBy = purchasesAreCompletedBy | ||
| } | ||
|
|
||
| func customerInfo() async throws -> RevenueCat.CustomerInfo { | ||
| return try await self.customerInfoBlock() | ||
| } | ||
|
|
||
| func purchase(package: Package) async throws -> PurchaseResultData { | ||
|
|
@@ -65,6 +81,8 @@ extension PaywallPurchasesType { | |
| try await restore(self.restorePurchases)() | ||
| } trackEvent: { event in | ||
| await self.track(paywallEvent: event) | ||
| } customerInfo: { | ||
| try await self.customerInfo() | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -78,6 +96,8 @@ extension PaywallPurchasesType { | |
| try await self.restorePurchases() | ||
| } trackEvent: { event in | ||
| await trackEvent(self.track(paywallEvent:))(event) | ||
| } customerInfo: { | ||
| try await self.customerInfo() | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,12 +17,17 @@ import RevenueCat | |
| @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *) | ||
| protocol PaywallPurchasesType: Sendable { | ||
|
|
||
| var purchasesAreCompletedBy: PurchasesAreCompletedBy { get set } | ||
|
|
||
| @Sendable | ||
| func purchase(package: Package) async throws -> PurchaseResultData | ||
|
|
||
| @Sendable | ||
| func restorePurchases() async throws -> CustomerInfo | ||
|
|
||
| @Sendable | ||
| func customerInfo() async throws -> CustomerInfo | ||
|
|
||
| @Sendable | ||
| func track(paywallEvent: PaywallEvent) async | ||
|
|
||
|
|
||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,9 +19,11 @@ import RevenueCat | |
| @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *) | ||
| extension PurchaseHandler { | ||
|
|
||
| static func mock(_ customerInfo: CustomerInfo = TestData.customerInfo, | ||
| purchasesAreCompletedBy: PurchasesAreCompletedBy = .revenueCat) | ||
| -> Self { | ||
| return self.init( | ||
| purchases: MockPurchases(purchasesAreCompletedBy: purchasesAreCompletedBy) { _ in | ||
| return ( | ||
| // No current way to create a mock transaction with RevenueCat's public methods. | ||
| transaction: nil, | ||
|
|
@@ -32,12 +34,14 @@ extension PurchaseHandler { | |
| return customerInfo | ||
| } trackEvent: { event in | ||
| Logger.debug("Tracking event: \(event)") | ||
| } customerInfo: { | ||
| return customerInfo | ||
| } | ||
| ) | ||
| } | ||
|
|
||
| static func cancelling(purchasesAreCompletedBy: PurchasesAreCompletedBy = .revenueCat) -> Self { | ||
| return .mock(purchasesAreCompletedBy: purchasesAreCompletedBy) | ||
| .map { block in { | ||
| var result = try await block($0) | ||
| result.userCancelled = true | ||
|
|
@@ -55,6 +59,8 @@ extension PurchaseHandler { | |
| throw error | ||
| } trackEvent: { event in | ||
| Logger.debug("Tracking event: \(event)") | ||
| } customerInfo: { | ||
| throw error | ||
| } | ||
| ) | ||
| } | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems a bit misleading to me - a lot of StoreKit purchasing logic will be performed by RevenueCat regardless. We still fetch products, post receipts, etc, right?
The only real change is that we won't finish transactions. I realize that that might not be a concept that a user grasps all that well, but then again, we're assuming that this developer has a full StoreKit implementation of their own, so it feels reasonable that they could figure out what finishing transactions is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about something like
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think my confusion here is regarding exactly what StoreKit logic is outsourced to our customer's app.
This:
sounds the same to me as:
The only real change is that we won't finish transactions, but when
purchasesAreCompletedByis.myApp, we don't call intoPurchasesOrchestrator.purchase(product:package:completion:)- is this part of finishing transactions?I think what matters most is that someone who has written or is going to write their own StoreKit interfacing code understands exactly what they are now responsible for. Should we list the StoreKit API calls we no longer call? I'm a bit concerned that unless we're crystal clear, there may be confusion on the customer's side too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that was my specific concern as well - we need to make it clear that you need to finish transactions.
That's really the only important part.
Finishing transactions happens specifically when we detect a purchase, then post it to the backend, and receive a response from the backend.
So even if you don't go through the purchase method, we can still detect the purchase, and that's when we finish transactions (unless this mode is enabled).
It'd be finishTransaction in SK1, transaction.finish() in SK2