Custom entitlements: add README and other improvements #1167

aboedo · 2023-07-21T22:51:37Z

Added the README file and did more cleanup on other tings.

examples/CustomEntitlementComputationSample/README.md

aboedo · 2023-07-21T22:53:29Z

examples/CustomEntitlementComputationSample/README.md

+} catch (error: PurchasesTransactionException) {
+    if (error.userCancelled) {
+        _uiState.update { it.copy(displayErrorMessage = "User cancelled") }
+    } else {
+        _uiState.update { it.copy(displayErrorMessage = error.message) }
+    }


we should add the exact code to catch:

receipt already in use

payment pending

purchase cancelled

product already purchased

Hmm they could check the PurchasesTransactionException.error.errorCode and check for the following error codes:

PurchasesErrorCode.ProductAlreadyPurchasedError

PurchasesErrorCode.PurchaseCancelledError: though it's easier to just use the userCancelled property.

PurchasesErrorCode.ReceiptAlreadyInUseError: I might be missing something but this one shouldn't happen I think? As in, we are posting purchases:

Performed through the app (which should only be for new purchases and so should never have this error)

On app foreground, if we haven't synced the purchase before. In this case, it would fail silently to sync, so a user in this mode would never see this happening.

PurchasesErrorCode.PaymentPendingError: need to test to confirm this error happens...

examples/CustomEntitlementComputationSample/README.md

...s/src/customEntitlementComputation/kotlin/com/revenuecat/purchases/PurchasesConfiguration.kt

...omEntitlementComputationSample/app/src/main/java/com/revenuecat/sample/main/MainViewModel.kt

aboedo · 2023-07-21T22:54:36Z

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml

-purchases = "6.5.0"
+purchases = "6.8.0"


not sure why this was 6.5.0

I'm guessing since it is using the local version (in settings.gradle), it doesn't really matter?

It is outdated on MagicWeatherCompose, which is what I used as a base project for the sample. I am not sure why it's outdated there, but I guess it's an issue in the releasing scripts

Both magic weather sample apps don't update their version automatically... We definitely should fix that, even if it's just pointing to the latest snapshot... I created a task here.

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml

codecov · 2023-07-21T23:25:01Z

Codecov Report

Merging #1167 (205bd91) into main (192326b) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1167      +/-   ##
==========================================
+ Coverage   85.59%   85.61%   +0.02%     
==========================================
  Files         179      180       +1     
  Lines        6121     6181      +60     
  Branches      918      919       +1     
==========================================
+ Hits         5239     5292      +53     
- Misses        540      547       +7     
  Partials      342      342

Impacted Files	Coverage Δ
...com/revenuecat/purchases/PurchasesConfiguration.kt	`88.33% <ø> (ø)`

vegaro · 2023-07-24T11:43:11Z

examples/CustomEntitlementComputationSample/README.md

+```
+for Gradle version catalogs, or
+```gradle
+implementation 'com.revenuecat.purchases:purchases@customEntitlementsComputation:6.8.0'


@customEntitlementsComputation would be valid if we were publishing as a flavor, but we are publishing the flavor as a different artifact

implementation 'com.revenuecat.purchases:purchases-custom-entitlement-computation:6.8.0'

I would also remove the Gradle catalogs version and simply leave the standard nomenclature

vegaro · 2023-07-24T11:45:20Z

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml

-purchases = "6.5.0"
+purchases = "6.8.0"


It is outdated on MagicWeatherCompose, which is what I used as a base project for the sample. I am not sure why it's outdated there, but I guess it's an issue in the releasing scripts

tonidero

Looks great, left a few comments, but nothing blocking

examples/CustomEntitlementComputationSample/settings.gradle

examples/CustomEntitlementComputationSample/Sample screenshot.png

examples/CustomEntitlementComputationSample/README.md

tonidero · 2023-07-24T17:04:02Z

examples/CustomEntitlementComputationSample/README.md

+### Observing changes to purchases:
+
+To ensure that your app reacts to changes to subscriptions in real time, you can use `customerInfoStream`. This stream will only fire when new `customerInfo` is registered
+in RevenueCat, like when a subscription is renewed. If there are no changes from the last value, it will not fire. This means it's not guaranteed to fire on every app open.


like when a subscription is renewed

This is not true for Android. Maybe we should mention this will only update on purchases. cc @aboedo

yeah, good call, we should update

also, customerInfoStream is not a thing in Android. I will update

check it out and let me know what you think

examples/CustomEntitlementComputationSample/README.md

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml

examples/CustomEntitlementComputationSample/README.md

aboedo · 2023-07-24T17:35:47Z

examples/CustomEntitlementComputationSample/README.md

+### Observing changes to purchases:
+
+To ensure that your app reacts to changes to subscriptions in real time, you can use `customerInfoStream`. This stream will only fire when new `customerInfo` is registered
+in RevenueCat, like when a subscription is renewed. If there are no changes from the last value, it will not fire. This means it's not guaranteed to fire on every app open.


yeah, good call, we should update

vegaro · 2023-07-24T17:36:45Z

...ustomEntitlementComputationSample/app/src/main/java/com/revenuecat/sample/main/MainScreen.kt

@@ -181,8 +181,7 @@ fun MainScreen(
                Box(
                    contentAlignment = Alignment.TopStart,
                ) {
-                    Column {
-
+                    Column(modifier = Modifier.fillMaxWidth().padding(32.dp)) {


Updated this because the width changed when the list got it first item. It got wider because the content was wider and had a weird spacing, like in this screenshot:

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

…tener

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

@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 self-assigned this Jul 21, 2023

aboedo commented Jul 21, 2023

View reviewed changes

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

aboedo requested review from vegaro and tonidero July 21, 2023 22:58

tonidero mentioned this pull request Jul 24, 2023

CustomEntitlementComputation: Create different PurchasesConfiguration that requires an appUserId parameter #1154

Merged

vegaro reviewed Jul 24, 2023

View reviewed changes

aboedo added 6 commits July 24, 2023 11:11

remove amazon, actually use custom entitlements mode

6002092

removed trusted entitlements from this mode

339223c

more updates to readme

0e843f1

made things internal instead of removing them

6825799

removed trusted entitlements from API tests

3573b01

remove unused import

ce6f417

aboedo force-pushed the andy/custom_entitlements_add_readme branch from 7ee0c1b to ce6f417 Compare July 24, 2023 14:23

vegaro added 4 commits July 24, 2023 16:57

fix adding dependency README section

38e2ec1

update to Purchases.configureInCustomEntitlementsComputationMode

f40ebfa

comment out includeBuild

6b777fe

better error handling

226c82c

vegaro marked this pull request as ready for review July 24, 2023 16:53

vegaro requested a review from a team July 24, 2023 16:54

vegaro changed the title ~~Custom entitlements: add README~~ Custom entitlements: add README and other improvements Jul 24, 2023

tonidero approved these changes Jul 24, 2023

View reviewed changes

tonidero reviewed Jul 24, 2023

View reviewed changes

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml Outdated Show resolved Hide resolved

vegaro added 6 commits July 24, 2023 19:21

update artifact id

883202b

renames in readme

f99c646

comment out includebuild

83c5a09

update screenshot

3865342

update PurchasesErrorCode.ProductAlreadyPurchasedError message

ff0ae38

updates padding so column doesn't change with

2c231e2

aboedo commented Jul 24, 2023

View reviewed changes

vegaro reviewed Jul 24, 2023

View reviewed changes

vegaro and others added 10 commits July 24, 2023 19:37

Update examples/CustomEntitlementComputationSample/README.md

e50c7dc

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

bd54564

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

86b7ab6

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

d2fe571

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

rename screenshot

36ea52a

update description of Purchases.sharedInstance.updatedCustomerInfoLis…

2d2a10e

…tener

Update examples/CustomEntitlementComputationSample/README.md

cb2e4c4

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

240bb4b

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

5468bc2

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

Update examples/CustomEntitlementComputationSample/README.md

205bd91

Co-authored-by: Andy Boedo <andresboedo@gmail.com>

tonidero approved these changes Jul 24, 2023

View reviewed changes

aboedo merged commit 66e1566 into main Jul 24, 2023
2 checks passed

aboedo deleted the andy/custom_entitlements_add_readme branch July 24, 2023 19:08

RCGitBot mentioned this pull request Jul 24, 2023

[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

Custom entitlements: add README and other improvements #1167

Custom entitlements: add README and other improvements #1167

aboedo commented Jul 21, 2023

aboedo Jul 21, 2023

tonidero Jul 24, 2023

aboedo Jul 21, 2023

tonidero Jul 24, 2023

vegaro Jul 24, 2023

tonidero Jul 24, 2023

codecov bot commented Jul 21, 2023 •

edited

Loading

vegaro Jul 24, 2023

vegaro Jul 24, 2023

tonidero left a comment

tonidero Jul 24, 2023

aboedo Jul 24, 2023

vegaro Jul 24, 2023

vegaro Jul 24, 2023

aboedo Jul 24, 2023

vegaro Jul 24, 2023 •

edited

Loading

Custom entitlements: add README and other improvements #1167

Custom entitlements: add README and other improvements #1167

Conversation

aboedo commented Jul 21, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 21, 2023 • edited Loading

Codecov Report

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

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 Jul 24, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jul 21, 2023 •

edited

Loading

vegaro Jul 24, 2023 •

edited

Loading