CustomEntitlementComputation: New Purchases class by tonidero · Pull Request #1153 · RevenueCat/purchases-android

tonidero · 2023-07-20T06:52:38Z

Description

This PR moves the existing Purchases class into the defaults flavor and creates a new Purchases class in the customEntitlementComputation flavor. It also moves some of the extension functions to the defaults flavor since they aren't possible in the customEntitlementComputation flavor. It also splits the tests and api tests to run some tests on the defaults flavor only

codecov · 2023-07-20T07:51:23Z

Codecov Report

Attention: Patch coverage is 58.82353% with 14 lines in your changes missing coverage. Please review.

Project coverage is 85.64%. Comparing base (46321d2) to head (d4886aa).
Report is 575 commits behind head on main.

Files with missing lines	Patch %	Lines
.../revenuecat/purchases/ListenerConversionsCommon.kt	54.54%	8 Missing and 2 partials ⚠️
...in/com/revenuecat/purchases/listenerConversions.kt	40.00%	3 Missing ⚠️
...n/com/revenuecat/purchases/coroutinesExtensions.kt	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1153      +/-   ##
==========================================
+ Coverage   85.40%   85.64%   +0.24%     
==========================================
  Files         177      178       +1     
  Lines        6275     6160     -115     
  Branches      921      916       -5     
==========================================
- Hits         5359     5276      -83     
+ Misses        571      543      -28     
+ Partials      345      341       -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tonidero · 2023-07-20T07:37:26Z

Honestly, I would like to run the linter in the tests as well... But there were a bunch of issues and didn't want to make this PR even bigger, so I'm just excluding this for now.

tonidero · 2023-07-20T07:42:27Z

I renamed this file to ListenerConversionsCommon, this is technically a breaking change in Java, since users in Java would need to upgrade from using ListenerConversionsKt to ListenerConversionsCommonKt for this... I would say people shouldn't be using these extension functions in Java, but they "can".

An alternative to this is to just not have a "common" file and duplicate all functions in both flavors... I wanted to try to reduce the duplication, but might be worth it... Thoughts?

(Note that this doesn't affect the CoroutinesConversionCommon since those functions are marked as @JvmSynthetic so they shouldn't be available in Java.)

Hmm, probably worth asking the rest of the team, but I think we can rename, imo

tonidero · 2023-07-20T07:43:36Z

I only added the functions that were needed looking at the API in iOS, but please confirm the API is what we expect. Also, I didn't add any deprecated functions. No need to add those to a new package.

tonidero · 2023-07-20T07:43:50Z

It's also annoying that we have to duplicate the docs 😢

I'd actually argue that it's not that bad, given that the docs could be different - for one, the configuration in custom entitlements mode has a non-nullable app user id, so its usage is slightly different, copy can accommodate for that

tonidero · 2023-07-20T07:45:34Z

I kept these in the main source set... I don't think these should be public, but we use them internally, so they would need to be public in defaults to not cause a breaking change but internal in customEntitlementComputation.

tonidero · 2023-07-20T07:52:56Z

I tried to split the tests in "Common" for those that should be run in both flavors, and flavor specific ones.

tonidero · 2023-07-20T07:53:56Z

I went back to using the purchaseOrchestrator for these... the one in Purchases is deprecated in the defaults flavor and it doesn't exist in the customEntitlementComputation flavor, so this allowed me to share the test between both flavors and use non-deprecated functions.

tonidero · 2023-07-20T10:56:30Z

This was missed from #1144. Made the change here to avoid conflicts later

I guess this doesn't really matter since we use these 2 only when configuring the SDK, and we use the value from Purchases, not PurchasesOrchestrator... We might be able to remove the ones in PurchasesOrchestrator. But for now, this seems more secure.

tonidero · 2023-07-20T12:26:39Z

Moving back to draft. Exploring using a public base class instead to try to share more code

vegaro · 2023-07-20T13:58:48Z

nitpick

We have typically lowercased these files since they are files and not classes. Not sure if that's what we should be doing, but that's what they other files look like.

Well, detekt was complaining with the lowercase... I think we should try to move toward this instead. Lmk if you think otherwise!

oh ok! yeah, I don't care, if we go with uppercase, let's make sure we start moving towards that

vegaro · 2023-07-20T13:59:00Z

nitpick

Same comment about lowercasing the file

…d also extension functions

aboedo · 2023-07-20T18:08:22Z

I'd actually argue that it's not that bad, given that the docs could be different - for one, the configuration in custom entitlements mode has a non-nullable app user id, so its usage is slightly different, copy can accommodate for that

aboedo · 2023-07-20T18:09:40Z

+    /**
+     * Invalidates the cache for customer information.
+     *
+     * Most apps will not need to use this method; invalidating the cache can leave your app in an invalid state.
+     * Refer to https://rev.cat/customer-info-cache for more information on
+     * using the cache properly.
+     *
+     * This is useful for cases where purchaser information might have been updated outside of the
+     * app, like if a promotional subscription is granted through the RevenueCat dashboard.
+     */
+    fun invalidateCustomerInfoCache() {
+        purchasesOrchestrator.invalidateCustomerInfoCache()


I believe this one is available in iOS. But yeah, I think it's probably ok to remove it. CC @NachoSoto

Just asked to see if it's being used 👀

tonidero · 2023-07-21T06:56:32Z

Removed some extra methods from the custom entitlement computation flavor here, so asking for a rereview, 🙏

…lavor (#1159) ### Description After #1153, docs were generated with multiple `Purchases` classes and it was very confusing. For the public docs, we only need the defaults flavor, so we can remove docs for the customEntitlementComputation package

@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>

tonidero added the refactor label Jul 20, 2023

tonidero commented Jul 20, 2023

View reviewed changes

tonidero force-pushed the toniricodiez/sdk-3223-new-custom-entitlements-purchases-class branch from 5148d25 to 58592a5 Compare July 20, 2023 07:54

Base automatically changed from cesar/sdk-3222-custom-entitlements-purchases-internal-class to main July 20, 2023 09:41

tonidero force-pushed the toniricodiez/sdk-3223-new-custom-entitlements-purchases-class branch from 33341fa to ca42170 Compare July 20, 2023 09:47

tonidero marked this pull request as ready for review July 20, 2023 10:11

tonidero requested a review from a team July 20, 2023 10:12

tonidero commented Jul 20, 2023

View reviewed changes

tonidero marked this pull request as draft July 20, 2023 12:26

vegaro reviewed Jul 20, 2023

View reviewed changes

Comment thread api-tester/src/defaults/kotlin/com/revenuecat/apitester/java/DeprecatedPurchasesAPI.java Outdated

tonidero marked this pull request as ready for review July 20, 2023 13:36

vegaro approved these changes Jul 20, 2023

View reviewed changes

tonidero added 12 commits July 20, 2023 16:36

Create new Purchases class for customEntitlementComputation flavor an…

55d14c5

…d also extension functions

Fix API tests per flavor

d065caf

Fix detekt

947e2cb

Split tests per flavor

2a6d8d3

Small fix in docs

530a4e3

Fix integration tests and run them only in defaults flavor

46831d9

Keep common API tests in main source set

8efc0da

Revert change

e203ef6

Also exclude tests in baseline task

4a978a0

Allow to set platforminfo and proxyURL correctly

873edfe

Move some java files to the java folder

7cbeb9d

Remove unused function

85d6dc5

tonidero force-pushed the toniricodiez/sdk-3223-new-custom-entitlements-purchases-class branch from bf5776f to 85d6dc5 Compare July 20, 2023 14:39

Fix test after rebase

e323cc7

aboedo reviewed Jul 20, 2023

View reviewed changes

Move some methods to the defaults flavor only

f914790

tonidero requested review from aboedo and vegaro July 21, 2023 06:56

tonidero requested a review from NachoSoto July 21, 2023 07:18

tonidero mentioned this pull request Jul 21, 2023

CustomEntitlementComputation: Generate dokka docs only for defaults flavor #1159

Merged

vegaro reviewed Jul 21, 2023

View reviewed changes

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/ListenerConversionsCommon.kt Outdated

Comment thread purchases/src/main/kotlin/com/revenuecat/purchases/ListenerConversionsCommon.kt Outdated

tonidero added 2 commits July 21, 2023 15:29

Move some listeners to the defaults flavor only

fcbab47

fix detekt

d4886aa

vegaro approved these changes Jul 21, 2023

View reviewed changes

tonidero merged commit a81f73a into main Jul 21, 2023

tonidero deleted the toniricodiez/sdk-3223-new-custom-entitlements-purchases-class branch July 21, 2023 14:17

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

vegaro added pr:other and removed pr:refactor labels Sep 17, 2024

Uh oh!

Conversation

tonidero commented Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

codecov Bot commented Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero Jul 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero commented Jul 20, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NachoSoto Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tonidero commented Jul 21, 2023

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tonidero commented Jul 20, 2023 •

edited

Loading

codecov Bot commented Jul 20, 2023 •

edited

Loading

tonidero Jul 20, 2023 •

edited

Loading

tonidero Jul 20, 2023 •

edited

Loading

NachoSoto Jul 21, 2023 •

edited

Loading