[CustomerCenter] Add networking layer and models by tonidero · Pull Request #1859 · RevenueCat/purchases-android

tonidero · 2024-09-27T13:26:59Z

Description

Adds networking layer and models to RevenueCat to support the new CustomerCenter.
Adds a new X-Preferred-Locales header.
Adds a new Purchases.getCustomerCenterConfigData method to access the data from RevenueCatUI

tonidero · 2024-09-27T13:29:26Z

+        val title: String,
+        val type: PathType,
+        @SerialName("promotional_offer") val promotionalOffer: PathDetail.PromotionalOffer? = null,
+        @SerialName("feedback_survey") val feedbackSurvey: PathDetail.FeedbackSurvey? = null,


Note that this is a bit different to iOS. In iOS, there is a single detail field, which makes sense since you can only have either promotional_offer or feedback_survey. But that was trickier to deserialize and I believe it's fine to separate these 2 into separate fields. Lmk if you have concerns.

For my understanding, in Android we could have both?

Not right now since the flow wouldn't make much sense if both are present... Having said that, we're not currently constraining this in the backend, so it's possible to have both.

Alright, yea I think these models should reflect the backend as closely as possible, so this is fine with me.

tonidero · 2024-09-27T13:30:11Z

+            @Serializable
+            class PromotionalOffer(
+                // WIP: Rename this field name to a new android id
+                @SerialName("ios_offer_id") val androidOfferId: String,


Right now I'm reading the ios_offer_id but we should read the android one before merging this.

tonidero · 2024-09-27T13:30:42Z

+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+typealias RCColor = PaywallColor


Not a big fan of these typealiases, but it's how we have it in iOS, and it kinda made sense now.

tonidero · 2024-09-27T13:32:45Z

+)
+
+@Serializable
+class CustomerCenterConfigData(


Need to write API tests for all these.

tonidero · 2024-09-27T13:33:13Z

+)
+
+@Serializable
+class CustomerCenterConfigData(


Also note that the constructors here are public, so test data can be created more easily from within the RevenueCatUI module.

tonidero · 2024-09-27T13:34:43Z

+        }
+
+        fun commonLocalizedString(key: CommonLocalizedString): String {
+            return localizedStrings[key.name.lowercase()] ?: key.defaultValue


I didn't fully like this... It means the enum name must always match the key in uppercase. Want to write a test to make sure this is setup correctly.

Test written in 8cb3f5f

In this case as well I wouldn't be opposed to having the enum just match the JSON key. (Testing would still be good, but the "rule" is simpler.)

codecov · 2024-09-27T13:52:41Z

Codecov Report

Attention: Patch coverage is 65.82915% with 68 lines in your changes missing coverage. Please review.

Project coverage is 82.37%. Comparing base (6e73386) to head (bc0918b).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...rchases/customercenter/CustomerCenterConfigData.kt	62.90%	34 Missing and 12 partials ⚠️
.../kotlin/com/revenuecat/purchases/common/Backend.kt	75.00%	9 Missing and 1 partial ⚠️
...n/com/revenuecat/purchases/coroutinesExtensions.kt	0.00%	5 Missing ⚠️
...at/purchases/customercenter/ScreenMapSerializer.kt	69.23%	3 Missing and 1 partial ⚠️
...in/com/revenuecat/purchases/listenerConversions.kt	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1859      +/-   ##
==========================================
- Coverage   82.83%   82.37%   -0.46%     
==========================================
  Files         222      225       +3     
  Lines        7703     7900     +197     
  Branches     1084     1104      +20     
==========================================
+ Hits         6381     6508     +127     
- Misses        899      953      +54     
- Partials      423      439      +16

Flag	Coverage Δ
	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

tonidero · 2024-09-27T14:20:55Z

+    @Serializable
+    class Appearance(
+        val light: ColorInformation? = null,
+        val dark: ColorInformation? = null,


This is also different to what we have in iOS... In there, we have each color type first and each one has a light/dark color. Here, it's the opposite. This actually reflects the backend response better, and I think we can parse it as needed later, so I didn't want to try to flip it in the model.

tonidero · 2024-09-27T16:44:52Z

I expect the new backend integration test to fail until we've given the project access to the customer center. It worked fine for a different project I tested on.

JayShortway

Nice, I think this is close! I just had some minor comments and suggestions.

JayShortway · 2024-09-30T08:34:56Z

Not for this PR, and maybe not for v0, but could be good to think about some rate limiting at some point? Even something like "once per 5 seconds" could already relieve some potential stress of calling this in a while(true).

JayShortway · 2024-09-30T09:28:36Z

+    private lateinit var backend: Backend
+    private lateinit var asyncBackend: Backend
+
+    private val expectedCustomerCenterConfigData = CustomerCenterConfigData(


I have never used it, but Kotest's property test framework can supposedly help with generating these test fixtures. (Not for this PR of course, just something we could look into at some point.)

JayShortway

LGTM!

JayShortway · 2024-10-01T09:40:52Z

+internal interface LocaleProvider {
+    val currentLocalesLanguageTags: String
+}


vegaro · 2024-10-02T09:50:46Z

@tonidero

**This is an automatic release.** ## RevenueCat SDK ### 🐞 Bugfixes * Save SDK configuration on paywall activity so it can reconfigure automatically (#1872) via Toni Rico (@tonidero) ### 📦 Dependency Updates * Bump fastlane from 2.223.1 to 2.224.0 (#1870) via dependabot[bot] (@dependabot[bot]) * Bump fastlane-plugin-revenuecat_internal from `5b2e35c` to `3b1e7cf` (#1865) via dependabot[bot] (@dependabot[bot]) * Bump fastlane from 2.222.0 to 2.223.1 (#1860) via dependabot[bot] (@dependabot[bot]) * Bump fastlane-plugin-revenuecat_internal from `55a0455` to `5b2e35c` (#1858) via dependabot[bot] (@dependabot[bot]) ### 🔄 Other Changes * [CustomerCenter] Fix help path deserializing when unknown type (#1869) via Toni Rico (@tonidero) * [CustomerCenter] Create `CustomerCenter` composable and view model with some initial UI (#1867) via Toni Rico (@tonidero) * [CustomerCenter] Add networking layer and models (#1859) via Toni Rico (@tonidero) * [CustomerCenter] Adds SubscriptionDetailsView (#1863) via JayShortway (@JayShortway) Co-authored-by: revenuecat-ops <ops@revenuecat.com>

[CustomerCenter] Add networking layer and models

ea68c9c

tonidero added the pr:other label Sep 27, 2024

tonidero commented Sep 27, 2024

View reviewed changes

tonidero added 3 commits September 27, 2024 16:47

Add backend integration test

9240ed7

Add equals to all classes and some tests

8cb3f5f

Fix detekt

f6281cf

tonidero added the pr:RevenueCatUI label Sep 27, 2024

tonidero commented Sep 27, 2024

View reviewed changes

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

Simplify equals

261a051

tonidero marked this pull request as ready for review September 27, 2024 16:45

tonidero requested a review from a team September 27, 2024 16:46

Add missing tests

36695b7

tonidero force-pushed the customer-center-add-networking-data branch from c8163c6 to 36695b7 Compare September 30, 2024 09:15

JayShortway reviewed Sep 30, 2024

View reviewed changes

tonidero added 6 commits September 30, 2024 12:36

Inject locale list language tags to http client

1496fce

Remove unneeded extra APIs, leave only coroutines API

806a60c

Change to use data classes

156e3dd

Remove unneeded SerialName

07d4fb4

Add missing localizations and some fixes

0a63963

Fix integration test

b48ddd0

tonidero requested review from a team and JayShortway September 30, 2024 16:06

vegaro approved these changes Oct 1, 2024

View reviewed changes

JayShortway approved these changes Oct 1, 2024

View reviewed changes

vegaro reviewed Oct 2, 2024

View reviewed changes

Comment thread purchases/src/defaults/kotlin/com/revenuecat/purchases/coroutinesExtensions.kt Outdated

vegaro Oct 2, 2024

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Make API experimental

64b023b

tonidero force-pushed the customer-center-add-networking-data branch from d9f9f57 to 64b023b Compare October 2, 2024 10:27

Rename field to android_offer_id

bc0918b

tonidero enabled auto-merge (squash) October 2, 2024 11:04

tonidero merged commit 4f8deac into main Oct 2, 2024

tonidero deleted the customer-center-add-networking-data branch October 2, 2024 11:18

RCGitBot mentioned this pull request Oct 2, 2024

[AUTOMATIC] Release/8.8.1 #1864

Closed

RCGitBot mentioned this pull request Oct 9, 2024

[AUTOMATIC] Release/8.8.1 #1876

Merged

Uh oh!

Conversation

tonidero commented Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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 Sep 27, 2024 • 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!

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!

codecov Bot commented Sep 27, 2024 • 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!

Uh oh!

tonidero commented Sep 27, 2024

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JayShortway left a comment

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tonidero commented Sep 27, 2024 •

edited

Loading

tonidero Sep 27, 2024 •

edited

Loading

codecov Bot commented Sep 27, 2024 •

edited

Loading