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

tonidero · 2023-07-20T08:45:01Z

Description

This PR separates PurchasesConfiguration in 2 for the defaults and customEntitlementComputation flavor. The one in customEntitlementComputation will require an app user id, avoiding initializing the sdk with anonymous users.

tonidero · 2023-07-20T08:45:35Z

...tomEntitlementComputationDebug/kotlin/com/revenuecat/purchases/amazon/AmazonConfiguration.kt

+import com.revenuecat.purchases.PurchasesConfiguration
+import com.revenuecat.purchases.Store
+
+class AmazonConfiguration(builder: Builder) : PurchasesConfiguration(builder) {


Also had to create amazon classes for each flavor... Not sure if it's needed but adding it for now

I'd be more inclined to keep Amazon only in the main flavor, unless there's a technical limitation that forces us to have it

Hmm I thought of a way to do that, but will do it in a separate PR. For now, I'm just failing when using this in customEntitlementComputation mode.

Done in #1158

tonidero · 2023-07-20T08:46:02Z

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

+         * This information will be anonymized so it can't be traced back to the end-user.
+         * The default value is false.
+         */
+        fun diagnosticsEnabled(diagnosticsEnabled: Boolean) = apply {


I'm wondering, should we disable diagnostics in customEntitlementComputation mode, @aboedo?

let's keep it disabled on v1 and we can take it from there

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

tonidero · 2023-07-20T08:47:21Z

purchases/src/test/java/com/revenuecat/purchases/PurchasesCommonTest.kt

-        val builder = PurchasesConfiguration.Builder(mockContext, "api").store(Store.PLAY_STORE)
-        Purchases.configure(builder.build())
-        assertThat(Purchases.sharedInstance.store).isEqualTo(Store.PLAY_STORE)
-    }


Had to separate these tests per flavor, now that the purchases configuration is different.

tonidero · 2023-07-20T08:47:43Z

purchases/src/test/java/com/revenuecat/purchases/PurchasesFactoryTest.kt

+            every { apiKey } returns testApiKey
+            every { appUserID } returns "appUserID"
+            every { store } returns Store.PLAY_STORE
+        }


I could have split these tests... But I decided to just use a mock to not have to do that.

codecov · 2023-07-20T09:00:36Z

Codecov Report

Merging #1154 (10f6340) into main (6ec7485) will increase coverage by 0.29%.
The diff coverage is 67.56%.

❗ Current head 10f6340 differs from pull request most recent head 5a3529b. Consider uploading reports for the commit 5a3529b to get more accurate results

@@            Coverage Diff             @@
##             main    #1154      +/-   ##
==========================================
+ Coverage   85.40%   85.69%   +0.29%     
==========================================
  Files         177      176       -1     
  Lines        6275     6095     -180     
  Branches      921      915       -6     
==========================================
- Hits         5359     5223     -136     
+ Misses        571      531      -40     
+ Partials      345      341       -4

Impacted Files	Coverage Δ
...revenuecat/purchases/CoroutinesExtensionsCommon.kt	`80.00% <ø> (ø)`
.../revenuecat/purchases/ListenerConversionsCommon.kt	`60.71% <60.71%> (ø)`
...n/com/revenuecat/purchases/coroutinesExtensions.kt	`85.71% <85.71%> (ø)`
...in/com/revenuecat/purchases/listenerConversions.kt	`23.07% <100.00%> (ø)`

... and 4 files with indirect coverage changes

tonidero · 2023-07-20T10:33:57Z

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

+import android.content.Context
+import java.util.concurrent.ExecutorService
+
+open class PurchasesConfiguration(builder: Builder) {


Originally I wasn't planning to copy the whole PurchasesConfiguration... But I didn't know how to have the Builder have a different constructor per flavor without duplicating everything like this :(

Could it just be a public extension declared in each flavor?

I don't think kotlin allows to declare an inner class or a constructor as an extension :(

tonidero · 2023-07-20T10:40:11Z

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

+         * Only use a Dangerous Setting if suggested by RevenueCat support team.
+         */
+        fun dangerousSettings(dangerousSettings: DangerousSettings) = apply {
+            this.dangerousSettings = dangerousSettings.copy(customEntitlementComputation = true)


Note how I'm doing this, so in case somone using this package changes dangerous settings, we still enable customEntitlementComputation.

Hmm this makes me think why do we even have the setter in DangerousSettings? If someone in the defaults flavor enables it, they won't access the same API, and if someone in the custom entitlements flavor disables it and sets it here, it will be re-enabled

Hmm the customEntitlementComputation in DangerousSettings is internal, so devs won't be able to set it up themselves. So it should always be false in the defaults flavor and true in the customEntitlementComputation flavor. Not sure if I'm missing something?

Oh then nevermind, I had missed that point

vegaro · 2023-07-20T13:30:54Z

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

+         * Only use a Dangerous Setting if suggested by RevenueCat support team.
+         */
+        fun dangerousSettings(dangerousSettings: DangerousSettings) = apply {
+            this.dangerousSettings = dangerousSettings.copy(customEntitlementComputation = true)


Hmm this makes me think why do we even have the setter in DangerousSettings? If someone in the defaults flavor enables it, they won't access the same API, and if someone in the custom entitlements flavor disables it and sets it here, it will be re-enabled

purchases/src/testCustomEntitlementComputation/kotlin/com/revenuecat/purchases/PurchasesTest.kt

tonidero · 2023-07-21T07:24:15Z

...tomEntitlementComputationDebug/kotlin/com/revenuecat/purchases/amazon/AmazonConfiguration.kt

+    ) : PurchasesConfiguration.Builder(context, apiKey, appUserId) {
+
+        init {
+            error("AmazonConfiguration is not currently supported in the custom entitlement computation package.")


Will remove this class (and the customEntitlementComputation flavor) in a followup PR

tonidero · 2023-07-21T07:25:11Z

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

+        this.dangerousSettings = builder.dangerousSettings
+    }
+
+    open class Builder(


Note that I removed the observerMode setter as well, so it won't be available in the customEntitlementComputation package. CC @aboedo

…rameter

…avor

…Configuration

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

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

+        /**
+         * Sets the [EntitlementVerificationMode] to perform signature verification of requests to the
+         * RevenueCat backend.
+         *
+         * When changing from [EntitlementVerificationMode.DISABLED] to other modes, the SDK will clear the
+         * CustomerInfo cache.
+         * This means users will need to connect to the internet to get their entitlements back.
+         *
+         * The result of the verification can be obtained from [EntitlementInfos.verification] or
+         * [EntitlementInfo.verification].
+         *
+         * Default mode is disabled. Please see https://rev.cat/trusted-entitlements for more info.
+         */
+        fun entitlementVerificationMode(verificationMode: EntitlementVerificationMode) = apply {
+            this.verificationMode = verificationMode
+        }


this shouldn't be added here, it's not a part of this mode

I see you're already removing it in #1167

@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-3229-disallow-anonymous-users branch from 36d9eab to 4e590d0 Compare July 20, 2023 09:19

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

tonidero force-pushed the toniricodiez/sdk-3229-disallow-anonymous-users branch from 4e590d0 to c0e8cee Compare July 20, 2023 10:19

tonidero commented Jul 20, 2023

View reviewed changes

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

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

tonidero force-pushed the toniricodiez/sdk-3229-disallow-anonymous-users branch from 20e21e8 to 36ee010 Compare July 20, 2023 10:55

vegaro reviewed Jul 20, 2023

View reviewed changes

vegaro approved these changes Jul 20, 2023

View reviewed changes

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

tonidero force-pushed the toniricodiez/sdk-3229-disallow-anonymous-users branch 2 times, most recently from 2c28c0c to 10f6340 Compare July 21, 2023 07:17

tonidero requested review from vegaro and aboedo July 21, 2023 07:23

tonidero commented Jul 21, 2023

View reviewed changes

vegaro approved these changes Jul 21, 2023

View reviewed changes

Base automatically changed from toniricodiez/sdk-3223-new-custom-entitlements-purchases-class to main July 21, 2023 14:17

tonidero added 7 commits July 21, 2023 16:18

Create different PurchasesConfiguration that requires an appUserId pa…

d9046e4

…rameter

Fix API tests after rebase

e3e5f9c

Set customEntitlementComputation flag

3e6d212

Add run configuration to run tests in customEntitlementComputation fl…

b56c093

…avor

Also exclude new test folders in baseline task

bcd60f1

Extract tests to PurchaseConfigureTest

8749378

Remove some functionality from customEntitlementComputation Purchases…

5a3529b

…Configuration

tonidero force-pushed the toniricodiez/sdk-3229-disallow-anonymous-users branch from 10f6340 to 5a3529b Compare July 21, 2023 14:18

tonidero enabled auto-merge (squash) July 21, 2023 14:18

tonidero merged commit c661ac4 into main Jul 21, 2023

tonidero deleted the toniricodiez/sdk-3229-disallow-anonymous-users branch July 21, 2023 14:29

RCGitBot mentioned this pull request Jul 21, 2023

[AUTOMATIC] Release/6.8.0 #1165

Closed

aboedo reviewed Jul 21, 2023

View reviewed changes

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

tonidero commented Jul 20, 2023

tonidero Jul 20, 2023

aboedo Jul 20, 2023

tonidero Jul 21, 2023

tonidero Jul 21, 2023

tonidero Jul 20, 2023

aboedo Jul 20, 2023

tonidero Jul 20, 2023

tonidero Jul 20, 2023

codecov bot commented Jul 20, 2023 •

edited

Loading

tonidero Jul 20, 2023

aboedo Jul 20, 2023

tonidero Jul 21, 2023

tonidero Jul 20, 2023

vegaro Jul 20, 2023

tonidero Jul 20, 2023

vegaro Jul 21, 2023

vegaro Jul 20, 2023

tonidero Jul 21, 2023 •

edited

Loading

tonidero Jul 21, 2023 •

edited

Loading

aboedo Jul 21, 2023

tonidero Jul 24, 2023

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

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

Conversation

tonidero commented Jul 20, 2023

Description

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

codecov bot commented Jul 20, 2023 • edited Loading

Codecov Report

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

tonidero Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

tonidero Jul 21, 2023 • edited Loading

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 20, 2023 •

edited

Loading

tonidero Jul 21, 2023 •

edited

Loading

tonidero Jul 21, 2023 •

edited

Loading