purchase coroutine #1142

aboedo · 2023-07-19T10:26:50Z

Adds a coroutine alternative to purchase()

aboedo · 2023-07-19T10:27:17Z

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

+
+class PurchasesTransactionException(
+    purchasesError: PurchasesError,
+    val userCancelled: Boolean


needed a new type so we can pass in the value for userCancelled as well

aboedo · 2023-07-19T10:27:49Z

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

+@ExperimentalPreviewRevenueCatPurchasesAPI
+@Throws(PurchasesTransactionException::class)
+suspend fun Purchases.awaitPurchase(purchaseParams: PurchaseParams):
+        Pair<StoreTransaction, CustomerInfo> {


similar to others, the Pair return type and the new exception are the only notable differences

aboedo · 2023-07-19T12:24:10Z

tested on device and it's working correctly

NachoSoto

Yessss

NachoSoto · 2023-07-19T13:23:01Z

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

+    private fun purchase(params: PurchaseParams) {
+        scope.launch {
+            try {
+                val (storeTransaction, _) = Purchases.sharedInstance.awaitPurchase(params)


NachoSoto · 2023-07-19T13:23:31Z

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

+class PurchasesTransactionException(
+    purchasesError: PurchasesError,
+    val userCancelled: Boolean,
+) : PurchasesException(purchasesError)


This makes sense

codecov · 2023-07-19T13:26:47Z

Codecov Report

Merging #1142 (4ed3a74) into main (a81f73a) will decrease coverage by 0.24%.
The diff coverage is 92.30%.

❗ Current head 4ed3a74 differs from pull request most recent head 95af972. Consider uploading reports for the commit 95af972 to get more accurate results

@@            Coverage Diff             @@
##             main    #1142      +/-   ##
==========================================
- Coverage   85.65%   85.42%   -0.24%     
==========================================
  Files         178      178              
  Lines        6163     6290     +127     
  Branches      917      923       +6     
==========================================
+ Hits         5279     5373      +94     
- Misses        543      571      +28     
- Partials      341      346       +5

Impacted Files	Coverage Δ
...n/com/revenuecat/purchases/CoroutinesExtensions.kt	`86.36% <90.00%> (ø)`
...lin/com/revenuecat/purchases/PurchasesException.kt	`100.00% <100.00%> (ø)`
...enuecat/purchases/PurchasesTransactionException.kt	`100.00% <100.00%> (ø)`

... and 7 files with indirect coverage changes

tonidero

Left some comments but looking great!

tonidero · 2023-07-19T17:13:02Z

api-tester/src/main/java/com/revenuecat/apitester/kotlin/PurchasesAPI.kt

    ) {
        val customerInfo: CustomerInfo = purchases.awaitCustomerInfo()
        val customerInfoFetchPolicy: CustomerInfo =
            purchases.awaitCustomerInfo(fetchPolicy = CacheFetchPolicy.FETCH_CURRENT)

        val offerings: Offerings = purchases.awaitOfferings()
+
+        val purchasePackageBuilder: PurchaseParams.Builder = PurchaseParams.Builder(activity, packageToPurchase)


This is not directly related to coroutines. I would just pass a PurchaseParams as a parameter to the function, and pass that to the awaitPurchase function

api-tester/src/main/java/com/revenuecat/apitester/kotlin/PurchasesAPI.kt

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

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

tonidero · 2023-07-20T05:52:00Z

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

+@JvmSynthetic
+@ExperimentalPreviewRevenueCatPurchasesAPI
+@Throws(PurchasesTransactionException::class)
+suspend fun Purchases.awaitPurchase(purchaseParams: PurchaseParams): Pair<StoreTransaction, CustomerInfo> {


I wonder if we should return a new class instead of a Pair... Thinking about, if we ever want to add a third or more return values in the future, if it's a pair, it would be a breaking change (we could potentially deprecated it). But if we create a new class and just add a parameter, it should be fine to just add the parameter.

great idea! I'll do that

tonidero

Just that comment about the unnecessary catch in the api tests. Other than that, looks great!

tonidero · 2023-07-21T07:00:14Z

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

@@ -60,3 +61,45 @@ suspend fun Purchases.awaitOfferings(): Offerings {
        )
    }
 }
+
+data class PurchaseResult(


Ideally we would use this as well for the non-coroutine version... But we would need to deprecate the existing ones I guess. I think it's ok to keep this to the coroutines version for now and move to this in a future PR.

tonidero · 2023-07-21T07:00:41Z

Looks like the linter is failing

vegaro

Looks great

aboedo · 2023-07-21T13:58:59Z

I had the lint fixes locally but never pushed 🤦 fixed now

…tine for purchase

aboedo · 2023-07-21T15:36:16Z

api-tester/src/main/java/com/revenuecat/apitester/kotlin/PurchasesCommonAPI.kt

+        val (transaction, newCustomerInfo) = purchases.awaitPurchase(purchasePackageBuilder.build())
+        val purchaseResult: PurchaseResult = purchases.awaitPurchase(purchasePackageBuilder.build())


you can unpack both ways? kotlin is great

### Description Fix tests after merges of #1142 and #1156 caused issue in main

@aboedo

**This is an automatic release.** ### New Features Introduced Custom Entitlements Computation mode. This is new library intended for apps that will do their own entitlement computation separate from RevenueCat. It's distributed as a separate artifact in Maven. Apps using this mode rely on webhooks to signal their backends to refresh entitlements with RevenueCat. See the [demo app for an example and usage instructions](https://github.com/RevenueCat/purchases-android/tree/main/examples/CustomEntitlementComputationSample). * Custom entitlements: add README and other improvements (#1167) via Andy Boedo (@aboedo) * Update Custom Entitlements Sample app (#1166) via Andy Boedo (@aboedo) * purchase coroutine (#1142) via Andy Boedo (@aboedo) * Add switchUser (#1156) via Cesar de la Vega (@vegaro) * CustomEntitlementsComputation: disable first listener callback when set (#1152) via Andy Boedo (@aboedo) * CustomEntitlementsComputation: Prevent posting subscriber attributes in post receipt (#1151) via Andy Boedo (@aboedo) * Fix `customEntitlementComputation` library deployment (#1169) via Toni Rico (@tonidero) * CustomEntitlementComputation: Configure method for customEntitlementComputation mode (#1168) via Toni Rico (@tonidero) * Add publish system for customEntitlementComputation package (#1149) via Cesar de la Vega (@vegaro) * Use purchase coroutine in CustomEntitlementComputationSample (#1162) via Cesar de la Vega (@vegaro) * Adds CustomEntitlementComputationSample (#1160) via Cesar de la Vega (@vegaro) * Fix tests in customEntitlementComputation after merges (#1161) via Toni Rico (@tonidero) * CustomEntitlementComputation: Remove custom entitlement computation flavor for amazon module (#1158) via Toni Rico (@tonidero) * CustomEntitlementComputation: Generate dokka docs only for defaults flavor (#1159) via Toni Rico (@tonidero) * CustomEntitlementComputation: Create different PurchasesConfiguration that requires an appUserId parameter (#1154) via Toni Rico (@tonidero) * CustomEntitlementComputation: New Purchases class (#1153) via Toni Rico (@tonidero) * CustomEntitlementComputation: Disable automatic cache refresh (#1157) via Toni Rico (@tonidero) * Add `customEntitlementComputation` flavor (#1147) via Toni Rico (@tonidero) * Make `customEntitlementComputation` singular (#1148) via Toni Rico (@tonidero) * Disable offline entitlements in custom entitlements computation mode (#1146) via Toni Rico (@tonidero) * Remove integration test flavor (#1143) via Toni Rico (@tonidero) * Add header to requests when in custom entitlement computation mode (#1145) via Toni Rico (@tonidero) * Add internal customEntitlementsComputation mode to app config (#1141) via Toni Rico (@tonidero) ### New Coroutines * `awaitPurchase` is available as a coroutine-friendly alternative to `purchase()`. (#1142) via Andy Boedo (@aboedo) ### Dependency Updates * Bump fastlane from 2.213.0 to 2.214.0 (#1140) via dependabot[bot] (@dependabot[bot]) ### Other changes * CI: make all Codecov jobs informational (#1155) via Cesar de la Vega (@vegaro) * Creates PurchasesOrchestrator (#1144) via Cesar de la Vega (@vegaro) --------- Co-authored-by: revenuecat-ops <ops@revenuecat.com> Co-authored-by: Andy Boedo <andresboedo@gmail.com>

@aboedo

### New Features Introduced Custom Entitlements Computation mode. This is new library intended for apps that will do their own entitlement computation separate from RevenueCat. It's distributed as a separate artifact in Maven. Apps using this mode rely on webhooks to signal their backends to refresh entitlements with RevenueCat. See the [demo app for an example and usage instructions](https://github.com/RevenueCat/purchases-android/tree/main/examples/CustomEntitlementComputationSample). * Custom entitlements: add README and other improvements (#1167) via Andy Boedo (@aboedo) * Update Custom Entitlements Sample app (#1166) via Andy Boedo (@aboedo) * purchase coroutine (#1142) via Andy Boedo (@aboedo) * Add switchUser (#1156) via Cesar de la Vega (@vegaro) * CustomEntitlementsComputation: disable first listener callback when set (#1152) via Andy Boedo (@aboedo) * CustomEntitlementsComputation: Prevent posting subscriber attributes in post receipt (#1151) via Andy Boedo (@aboedo) * Fix `customEntitlementComputation` library deployment (#1169) via Toni Rico (@tonidero) * CustomEntitlementComputation: Configure method for customEntitlementComputation mode (#1168) via Toni Rico (@tonidero) * Add publish system for customEntitlementComputation package (#1149) via Cesar de la Vega (@vegaro) * Use purchase coroutine in CustomEntitlementComputationSample (#1162) via Cesar de la Vega (@vegaro) * Adds CustomEntitlementComputationSample (#1160) via Cesar de la Vega (@vegaro) * Fix tests in customEntitlementComputation after merges (#1161) via Toni Rico (@tonidero) * CustomEntitlementComputation: Remove custom entitlement computation flavor for amazon module (#1158) via Toni Rico (@tonidero) * CustomEntitlementComputation: Generate dokka docs only for defaults flavor (#1159) via Toni Rico (@tonidero) * CustomEntitlementComputation: Create different PurchasesConfiguration that requires an appUserId parameter (#1154) via Toni Rico (@tonidero) * CustomEntitlementComputation: New Purchases class (#1153) via Toni Rico (@tonidero) * CustomEntitlementComputation: Disable automatic cache refresh (#1157) via Toni Rico (@tonidero) * Add `customEntitlementComputation` flavor (#1147) via Toni Rico (@tonidero) * Make `customEntitlementComputation` singular (#1148) via Toni Rico (@tonidero) * Disable offline entitlements in custom entitlements computation mode (#1146) via Toni Rico (@tonidero) * Remove integration test flavor (#1143) via Toni Rico (@tonidero) * Add header to requests when in custom entitlement computation mode (#1145) via Toni Rico (@tonidero) * Add internal customEntitlementsComputation mode to app config (#1141) via Toni Rico (@tonidero) ### New Coroutines * `awaitPurchase` is available as a coroutine-friendly alternative to `purchase()`. (#1142) via Andy Boedo (@aboedo) ### Dependency Updates * Bump fastlane from 2.213.0 to 2.214.0 (#1140) via dependabot[bot] (@dependabot[bot]) ### Other changes * CI: make all Codecov jobs informational (#1155) via Cesar de la Vega (@vegaro) * Creates PurchasesOrchestrator (#1144) via Cesar de la Vega (@vegaro) --------- Co-authored-by: revenuecat-ops <ops@revenuecat.com> Co-authored-by: Andy Boedo <andresboedo@gmail.com>

aboedo requested a review from vegaro July 19, 2023 10:26

aboedo self-assigned this Jul 19, 2023

aboedo commented Jul 19, 2023

View reviewed changes

aboedo added the pr:feat A new feature label Jul 19, 2023

aboedo marked this pull request as ready for review July 19, 2023 12:23

aboedo requested a review from a team July 19, 2023 13:20

NachoSoto reviewed Jul 19, 2023

View reviewed changes

tonidero reviewed Jul 19, 2023

View reviewed changes

tonidero reviewed Jul 20, 2023

View reviewed changes

tonidero approved these changes Jul 20, 2023

View reviewed changes

aboedo force-pushed the andy/purchase_coroutine branch from eaca37f to ae58dd5 Compare July 20, 2023 18:29

aboedo requested a review from tonidero July 20, 2023 18:43

tonidero approved these changes Jul 21, 2023

View reviewed changes

vegaro approved these changes Jul 21, 2023

View reviewed changes

aboedo added 12 commits July 21, 2023 17:07

added a new error type for PurchasesTransactionException, added corou…

a8f1543

…tine for purchase

indentation fixes

57ead8b

added api tests for new exception type

811612a

added api tests

2e15fbc

used async purchase method for purchase tester

142d94b

added purchases transaction exception tests

ae4d22f

WIP adding purchase test

ae48b83

added test for exception

815dc77

removed unused imports

6273f0e

added trailing commas

8624379

couple more detekt things

ca1419e

more trailing commas

57fbaf1

aboedo and others added 4 commits July 21, 2023 17:13

hopefully final detekt update

539c363

some cleanup in tests

3933cd7

fixed tests

bc1443e

Cleanup imports and some issues after rebase

b9f13c3

vegaro mentioned this pull request Jul 21, 2023

Adds CustomEntitlementComputationSample #1160

Merged

Move method to defaults flavor tests

fd90f2e

tonidero force-pushed the andy/purchase_coroutine branch from 4ed3a74 to fd90f2e Compare July 21, 2023 15:29

tonidero enabled auto-merge (squash) July 21, 2023 15:29

tonidero disabled auto-merge July 21, 2023 15:31

aboedo commented Jul 21, 2023

View reviewed changes

Add back PurchaseResult model

36c4d81

tonidero force-pushed the andy/purchase_coroutine branch from 2922481 to 36c4d81 Compare July 21, 2023 15:36

Fix some missing changes from rebase

95af972

tonidero enabled auto-merge (squash) July 21, 2023 15:53

tonidero merged commit e2cab2a into main Jul 21, 2023

tonidero deleted the andy/purchase_coroutine branch July 21, 2023 15:57

tonidero mentioned this pull request Jul 21, 2023

Fix tests in customEntitlementComputation after merges #1161

Merged

tonidero added a commit that referenced this pull request Jul 21, 2023

Fix tests in customEntitlementComputation after merges (#1161)

b0ef312

### Description Fix tests after merges of #1142 and #1156 caused issue in main

This was referenced Jul 21, 2023

[AUTOMATIC] Release/6.8.0 #1165

Closed

[AUTOMATIC] Release/6.8.0 #1170

Merged

RCGitBot mentioned this pull request Jul 24, 2023

[AUTOMATIC] Release/6.8.0 #1173

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

purchase coroutine #1142

purchase coroutine #1142

aboedo commented Jul 19, 2023

aboedo Jul 19, 2023

aboedo Jul 19, 2023

aboedo commented Jul 19, 2023

NachoSoto left a comment

NachoSoto Jul 19, 2023

NachoSoto Jul 19, 2023

codecov bot commented Jul 19, 2023 •

edited

Loading

tonidero left a comment

tonidero Jul 19, 2023

aboedo Jul 19, 2023

tonidero Jul 20, 2023 •

edited

Loading

aboedo Jul 20, 2023

aboedo Jul 20, 2023

tonidero left a comment

tonidero Jul 21, 2023

tonidero commented Jul 21, 2023

vegaro left a comment

aboedo commented Jul 21, 2023

aboedo Jul 21, 2023

		val (transaction, newCustomerInfo) = purchases.awaitPurchase(purchasePackageBuilder.build())
		val purchaseResult: PurchaseResult = purchases.awaitPurchase(purchasePackageBuilder.build())

purchase coroutine #1142

purchase coroutine #1142

Conversation

aboedo commented Jul 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aboedo commented Jul 19, 2023

NachoSoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 19, 2023 • edited Loading

Codecov Report

tonidero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero Jul 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero commented Jul 21, 2023

vegaro left a comment

Choose a reason for hiding this comment

aboedo commented Jul 21, 2023

Choose a reason for hiding this comment

codecov bot commented Jul 19, 2023 •

edited

Loading

tonidero Jul 20, 2023 •

edited

Loading