Purchase.Builder #825

beylmk · 2023-02-28T17:08:48Z

Adding the isPersonalizedPrice parameter to the purchase functions acted as a bit of a forcing function for us to refactor all of the purchase methods. See that conversation here.

Ultimately, what was decided is that we should use the builder pattern for purchases. Now, rather than having 8+ different purchase functions, we have 1, with a Builder for options like oldProductId, prorationMode, and isPersonalizedPrice. The builder can be constructed with either a StoreProduct, Package, or SubscriptionOption, to cover all of the purchaseable entities.

Making this change means we need to unify ProductChangeCallback and PurchaseCallback, since the same method could be used for a normal purchase or a product change. This means making a single interface that has a nullable StoreTransaction.

This is a WIP, but would like to get eyes on it early in the process, as it touches a lot of code.

Open Questions:

I'd love feedback on how to handle deprecation of the callbacks. It'd be great to keep the name PurchaseCallback and just make the StoreTransaction nullable, but I don't know of an easy way to notate that with annotations... I think in the past we've just fully deprecated and added something new, but I don't want to give up the good name. Perhaps PurchaseListener works, but we already did a big refactor to make listener -> callback.
Should we allow all proration modes when the deprecated versions of the purchase methods are called?

…ors, lots of TODOs for rest of impl

…te purchase tester to use that

beylmk · 2023-02-28T19:28:12Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt

+import com.revenuecat.purchases.models.StoreProduct
+import com.revenuecat.purchases.models.SubscriptionOption
+
+open class Purchase(builder: Builder) {


i don't think we should name it this, too confusing with Purchases. will have to think of a better name

PurchaseParams?

Also, I would generate a toString, equals and hashCode

i like that, done!

and just curious - is there a reason the PurchasesConfiguration doesn't need those methods?

actually, i don't think there'd be any custom equality logic here.. unless i'm missing something..

beylmk · 2023-02-28T22:43:48Z

examples/purchase-tester/src/main/java/com/revenuecat/purchasetester/OfferingFragment.kt

-        }
-
-    private val successfulUpgradeCallback: (purchase: StoreTransaction?, customerInfo: CustomerInfo) -> Unit =
+    private val successfulPurchaseCallback: (purchase: StoreTransaction?, customerInfo: CustomerInfo) -> Unit =


during development/until i figure out the deprecation/renaming strategy, i'm just changing this type.

beylmk · 2023-02-28T22:44:35Z

examples/purchase-tester/src/main/java/com/revenuecat/purchasetester/OfferingFragment.kt

@@ -156,48 +139,6 @@ class OfferingFragment : Fragment(), PackageCardAdapter.PackageCardAdapterListen
        }
    }

-    private fun startPurchaseProduct(


this file is a cool showcase of how much our API is simplified..though i doubt customers have this kinda code exactly 😅

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt

beylmk · 2023-02-28T22:48:03Z

strings/src/main/java/com/revenuecat/purchases/strings/PurchaseStrings.kt

@@ -38,4 +38,6 @@ object PurchaseStrings {
    const val INVALID_PURCHASE_TYPE = "Purchase for a %s purchase must be a %s."
    const val INVALID_STORE_PRODUCT_TYPE = "StoreProduct for a %s purchase must be a %s."
    const val INVALID_PRODUCT_NO_PRICE = "Error finding a price for %s."
+    const val NULL_TRANSACTION_ON_PURCHASE_ERROR = "Error purchasing. Null transaction returned from a non-upgrade" +


this shouldn't ever happen

…reate helper to translate callback

beylmk · 2023-02-28T23:02:27Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

@@ -1372,7 +1407,33 @@ class Purchases internal constructor(
        }
    }

-    private fun getPurchaseCallback(productId: String): PurchaseCallback? {
+    internal fun purchaseNonUpgradeWithDeprecatedCallback(


could probably do something like toPurchaseCallback did in the last release?

I love this name, TBH 🙃

vegaro · 2023-02-28T23:31:39Z

Making this change means we need to unify ProductChangeCallback and PurchaseCallback, since the same method could be used for a normal purchase or a product change. This means making a single interface that has a nullable StoreTransaction.

I think making it nullable is a good compromise

vegaro · 2023-02-28T23:35:23Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

+    fun purchase(
+        purchaseConfig: Purchase,
+        listener: NewPurchaseCallback
+    ) {


This is going to be so much nicer to maintain 💪

vegaro · 2023-02-28T23:44:08Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt

+    val oldProductId: String?
+    val googleProrationMode: GoogleProrationMode
+    internal val purchasingData: PurchasingData
+    internal val activity: Activity


Friendly reminder to make sure this class' API looks good in Java. So far I think it should be fine

it's been nice having the API tester, for some reason i held off on pushing that bc i wanted it in it's own commit 😓 but it's looking good so far!

vegaro · 2023-02-28T23:44:37Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt

+    val isPersonalizedPrice: Boolean
+    val oldProductId: String?
+    val googleProrationMode: GoogleProrationMode
+    internal val purchasingData: PurchasingData


Don't forget to add JVMSynthetic to these internal properties

joshdholtz

This looks so good! I can't wait for this

joshdholtz · 2023-03-01T03:35:36Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt

+        fun isPersonalizedPrice(isPersonalizedPrice: Boolean) = apply {
+            this.isPersonalizedPrice = isPersonalizedPrice
+        }
+
+        fun oldProductId(oldProductId: String?) = apply {
+            this.oldProductId = oldProductId
+        }
+
+        fun googleProrationMode(googleProrationMode: GoogleProrationMode) = apply {
+            this.googleProrationMode = googleProrationMode
+        }


This looks so nice 😍

joshdholtz · 2023-03-01T03:36:05Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

+    fun purchase(
+        purchaseConfig: Purchase,
+        listener: NewPurchaseCallback
+    ) {


This is going to be so much nicer to maintain 💪

joshdholtz · 2023-03-01T03:38:09Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

@@ -1372,7 +1407,33 @@ class Purchases internal constructor(
        }
    }

-    private fun getPurchaseCallback(productId: String): PurchaseCallback? {
+    internal fun purchaseNonUpgradeWithDeprecatedCallback(


I love this name, TBH 🙃

joshdholtz · 2023-03-01T03:40:26Z

purchases/src/main/kotlin/com/revenuecat/purchases/interfaces/PurchaseCallback.kt

+     * Will be called after the purchase has completed
+     * @param storeTransaction StoreTransaction object for the purchased product.
+     * @param customerInfo Updated [CustomerInfo].
+     */
+    fun onCompleted(storeTransaction: StoreTransaction?, customerInfo: CustomerInfo)


StoreTransaction is nullable here because this could be deferred or something, right? Do we need to update the docs here explaining that?

yep 💯 definitely should

beylmk · 2023-03-02T19:36:04Z

api-tester/src/main/java/com/revenuecat/apitester/java/DeprecatedPurchasesAPI.java

+        final PurchaseCallback makePurchaseListener = new PurchaseCallback() {
+            @Override
+            public void onCompleted(@NonNull StoreTransaction storeTransaction, @NonNull CustomerInfo customerInfo) {
+            }
+
+            @Override
+            public void onError(@NonNull PurchasesError error, boolean userCancelled) {
+            }
+        };


anyone have thoughts on how to migrate this? can we just change one of the parameters to be nullable and call it out, and keep the same name?

@vegaro @joshdholtz ^^

beylmk · 2023-03-02T19:48:44Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

+            // TODO how to best migrate old proration mode to new?
+//            val rcProrationMode = GoogleProrationMode(googleProrationMode)


this is an interesting one... should we allow them to pass any proration mode into the old purchase functions, as to not push a breaking change?

Ugh, so torn here I changed this comment like 8 times...

I think we need hardcode but:

Put a comment for this method explaining that and why

Also included this as a big warning in the migration docs

…mode references

codecov · 2023-03-03T17:08:04Z

Codecov Report

Merging #825 (797022d) into bc5-support (de1e207) will decrease coverage by 1.02%.
The diff coverage is 52.23%.

@@               Coverage Diff               @@
##           bc5-support     #825      +/-   ##
===============================================
- Coverage        80.31%   79.30%   -1.02%     
===============================================
  Files              131      133       +2     
  Lines             4622     4696      +74     
  Branches           649      650       +1     
===============================================
+ Hits              3712     3724      +12     
- Misses             650      714      +64     
+ Partials           260      258       -2

Impacted Files	Coverage Δ
...evenuecat/purchases/interfaces/PurchaseCallback.kt	`0.00% <0.00%> (ø)`
...om/revenuecat/purchases/strings/PurchaseStrings.kt	`0.00% <ø> (ø)`
.../main/kotlin/com/revenuecat/purchases/Purchases.kt	`84.98% <43.85%> (-2.70%)`	⬇️
...in/com/revenuecat/purchases/listenerConversions.kt	`33.33% <45.83%> (-23.81%)`	⬇️
.../kotlin/com/revenuecat/purchases/PurchaseParams.kt	`76.31% <76.31%> (ø)`
.../kotlin/com/revenuecat/purchases/PurchasesState.kt	`100.00% <100.00%> (ø)`
...ain/kotlin/com/revenuecat/purchases/UpgradeInfo.kt	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

joshdholtz · 2023-03-06T15:50:44Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

+            // TODO how to best migrate old proration mode to new?
+//            val rcProrationMode = GoogleProrationMode(googleProrationMode)


Ugh, so torn here I changed this comment like 8 times...

I think we need hardcode but:

Put a comment for this method explaining that and why

Also included this as a big warning in the migration docs

joshdholtz · 2023-03-06T15:54:32Z

purchases/src/main/kotlin/com/revenuecat/purchases/Purchases.kt

+                // TODO fix proration
+                .googleProrationMode(GoogleProrationMode.IMMEDIATE_WITHOUT_PRORATION)


What does // TODO fix proration mode mean here? 🤔 Is like... don't hardcode?

And should we add a comment on this one too saying the mode is hardcoded to IMMEDIATE_WITHOUT_PRORATION?

means we need to determine whether or not we can use the old prorationmodes moving forward 🤷‍♀️ but i think this is resolved by your other comment...we should jsut fully utilize the old methods

joshdholtz · 2023-03-06T15:57:10Z

purchases/src/main/kotlin/com/revenuecat/purchases/interfaces/ProductChangeCallback.kt

@@ -11,6 +11,7 @@ import com.revenuecat.purchases.models.StoreTransaction
 /**
 * Interface to be implemented when upgrading or downgrading a purchase.
 */
+// TODO BC5 deprecate and/or rename


This isn't used in anything "new", right? So we should be able to just fully deprecate this?

well technically this is the proper signature for the new callback. so we could either rename this OR create a completely new one.

joshdholtz · 2023-03-06T15:57:46Z

purchases/src/main/kotlin/com/revenuecat/purchases/interfaces/PurchaseCallback.kt

+// TODO rename, update docs
+interface NewPurchaseCallback : PurchaseErrorCallback {


Do we have any ideas on what we'll rename this too? 🤷‍♂️

no, that's the open question... it's tricky bc i think PurchaseCallback is perfect but i'm not sure if we are "allowed" to change nullability without renaming

joshdholtz · 2023-03-06T15:58:57Z

purchases/src/main/kotlin/com/revenuecat/purchases/interfaces/PurchaseCallback.kt

+     * @param storeTransaction StoreTransaction object for the purchased product. Null for deferred purchases.
+     * @param customerInfo Updated [CustomerInfo].
+     */
+    fun onCompleted(storeTransaction: StoreTransaction?, customerInfo: CustomerInfo)


Could we add another function here called onDeferred so that onCompleted doesn't have a possible null StoreTransacton? Not sure how well that plays with Kotlin lambdas and everything though 🤷‍♂️

joshdholtz · 2023-03-06T17:08:32Z

purchases/src/main/kotlin/com/revenuecat/purchases/listenerConversions.kt

-    purchaseProduct(activity, storeProduct, purchaseCompletedCallback(onSuccess, onError))
+    val purchase = PurchaseParams.Builder(storeProduct, activity).build()
+    purchaseNonUpgradeWithDeprecatedCallback(
+        purchase,
+        purchaseCompletedCallback(onSuccess, onError)


I think it might be nice to have all of these deprecated With functions call the deprecated version so all of the retrofitting is contained in the Purchases.kt implementation 😇

yeah, good call. then we probably need to use the old prorationmodes, too

joshdholtz

I say LGTM and then do some followup PRs 💪 I love this and want to start using it 😊

beylmk · 2023-03-06T21:09:22Z

merging this to unblock a bunch of other tickets, will do a follow-up PR with other comments after!

### Motivation [CF-1167](https://revenuecats.atlassian.net/browse/CF-1167) ### Description This task was supposed to rename `UpgradeInfo` to `ProductChangeInfo` but... `UpgradeInfo` is now deprecated as of #825 and replaced with `PurchaseParams` so... This PR simply just removes the last use of `UpgradeInfo` which was in our Purchase Tester 😇 [CF-1167]: https://revenuecats.atlassian.net/browse/CF-1167?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

@beylmk

### Breaking Changes * New `purchase(PurchaseParams.Builder)` method and removed `purchase(SubscriptionOption)` method (#825) (#850) via beylmk (@beylmk) ### New Features * Add/use productPlanIdentifier to EntitlementInfo and CustomerInfo (#849) via Josh Holtz (@joshdholtz) ### Bugfixes * New API for getting products by type, properly filter deprecated functions, reworked logic (#843) via Josh Holtz (@joshdholtz) ### Other Changes * Hide isPersonalizedPrice (#858) via beylmk (@beylmk) * Always use purchasingData property directly on the StoreProduct when purchasing (#847) via Josh Holtz (@joshdholtz) * Remove use of UpgradeInfo from Purchase Tester (#846) via Josh Holtz (@joshdholtz) * Update MagicWeather and Purchase Tester with 6.0.0-alpha.4 APIs (#834) via Josh Holtz (@joshdholtz)

Initial setup - create Purchase and Purchase.Builder with multiple ct…

3290aa0

…ors, lots of TODOs for rest of impl

beylmk mentioned this pull request Feb 28, 2023

[CF-1004] Add isPersonalizedPrice parameter to purchasing functions #796

Closed

beylmk added pr:breaking Changes that are breaking pr:feat A new feature refactor and removed refactor labels Feb 28, 2023

Maddie Beyl added 3 commits February 28, 2023 12:26

update purchasetester to use new method, comment out listenerConversions

8753b45

remove listener from builder, add listenerConversion version and upda…

d85eaa3

…te purchase tester to use that

Add back & deprecate old versions with upgradeinfo

f69deba

beylmk commented Feb 28, 2023

View reviewed changes

purchases/src/main/kotlin/com/revenuecat/purchases/Purchase.kt Outdated Show resolved Hide resolved

beylmk commented Feb 28, 2023

View reviewed changes

Uncomment and deprecate non-builder non-upgrade purchase functions, c…

3e95730

…reate helper to translate callback

beylmk force-pushed the purchase-builder branch from 2d38454 to 3e95730 Compare February 28, 2023 22:48

beylmk requested a review from vegaro February 28, 2023 22:54

beylmk commented Feb 28, 2023

View reviewed changes

quick POC of toNewPurchaseCallback

698c10f

vegaro reviewed Feb 28, 2023

View reviewed changes

joshdholtz mentioned this pull request Mar 1, 2023

[BC5] Rename UpgradeInfo to ProductChangeInfo #819

Closed

joshdholtz reviewed Mar 1, 2023

View reviewed changes

Maddie Beyl added 5 commits March 1, 2023 10:18

Merge branch 'bc5-support' into purchase-builder

1ad96fe

Update to use NewPurchaseCallback

b989eb6

rename purchase -> purchaseparams

d9bc107

Move deprecated function calls in api testers to deprecated files

9f26896

add new methods to api testers

d4bbda7

Maddie Beyl added 5 commits March 1, 2023 11:45

add jvmsynthetic to internal vals, fix api tester detekt

497a551

Merge branch 'bc5-support' into purchase-builder

6edb3e4

Revert UpgradeInfo to v5 version and deprecate

c4b19a7

Update v6-migration

07695ab

Add some javadocs, remove some todos

be55184

beylmk commented Mar 2, 2023

View reviewed changes

add listener call to api tester

2ba06fa

beylmk commented Mar 2, 2023

View reviewed changes

beylmk changed the title ~~[WIP] Purchase.Builder~~ Purchase.Builder Mar 2, 2023

beylmk requested review from joshdholtz and vegaro March 2, 2023 19:49

Maddie Beyl added 3 commits March 3, 2023 10:27

Start updating PurchasesTests with new purchase call

12a3c08

Fix not passing through presentedOfferingIdentifier

1eafa11

Fix UpgradeInfo api testers, comment out offering fragment proration …

797022d

…mode references

joshdholtz reviewed Mar 6, 2023

View reviewed changes

joshdholtz approved these changes Mar 6, 2023

View reviewed changes

beylmk marked this pull request as ready for review March 6, 2023 21:08

beylmk merged commit db98fda into bc5-support Mar 6, 2023

beylmk deleted the purchase-builder branch March 6, 2023 21:09

joshdholtz mentioned this pull request Mar 7, 2023

[BC5] Remove use of UpgradeInfo from Purchase Tester #846

Merged

joshdholtz mentioned this pull request Mar 9, 2023

Release/6.0.0-beta.1 #860

Merged

vegaro mentioned this pull request Jun 3, 2024

SDK-3469 Remove deprecated purchase methods #1711

Merged

		// TODO how to best migrate old proration mode to new?
		// val rcProrationMode = GoogleProrationMode(googleProrationMode)

		// TODO fix proration
		.googleProrationMode(GoogleProrationMode.IMMEDIATE_WITHOUT_PRORATION)

		// TODO rename, update docs
		interface NewPurchaseCallback : PurchaseErrorCallback {

Purchase.Builder #825

Purchase.Builder #825

Conversation

beylmk commented Feb 28, 2023 • edited Loading

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

beylmk Feb 28, 2023 • edited Loading

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

vegaro commented Feb 28, 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

vegaro Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

joshdholtz left a 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

Choose a reason for hiding this comment

joshdholtz Mar 6, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Mar 3, 2023

Codecov Report

joshdholtz Mar 6, 2023 • edited Loading

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

Choose a reason for hiding this comment

joshdholtz left a comment

Choose a reason for hiding this comment

beylmk commented Mar 6, 2023

beylmk commented Feb 28, 2023 •

edited

Loading

beylmk Feb 28, 2023 •

edited

Loading

vegaro Feb 28, 2023 •

edited

Loading

joshdholtz Mar 6, 2023 •

edited

Loading

joshdholtz Mar 6, 2023 •

edited

Loading