Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Paywalls V2] New overrides structure #2120

Merged
merged 7 commits into from
Feb 7, 2025
Merged

[Paywalls V2] New overrides structure #2120

merged 7 commits into from
Feb 7, 2025

Conversation

tonidero
Copy link
Contributor

@tonidero tonidero commented Feb 6, 2025

Motivation

Migrating overrides from a structured object to an array of override objects

Description

Previously

Overrides were a very structure object that had all of the different types of states/conditions that allowed base properties of a component to be overridden. However, this was not flexible when it came to multiple being activated as it was missing for cases when multiples types of conditions were being evaluated.

Now

Overrides is an array that has an array of conditions and properties. It will get applied in order from first to last IF all of the conditions are true.

This allows the FE/BE to determine the orders of overrides from lowest to higher priority so all of the SDKs/renderers don't need to duplicate that logic.

Android equivalent of RevenueCat/purchases-ios#4705

UNSUPPORTED,
}

private object ConditionSerializer : KSerializer<Condition> {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was a bit confused with this one... The backend right now returns an object with a type property but in iOS, we deserialize that directly to the Condition enum so I followed the same pattern... I'm not sure if we add more properties to that object, if we would be able to expose it with this API though...

Copy link
Member

Choose a reason for hiding this comment

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

We could automatically deserialize an object with only a type property if we make Condition sealed, and make its cases (Kotlin) objects instead of an enum. However, we would still need a custom serializer to handle the UNSUPPORTED case, so we wouldn't really gain anything in that respect haha.

As an example, TabControlComponent is a Kotlin object, because it's JSON is:

{ "type": "tab_control" }

Making Condition sealed now would maybe make it slightly easier to "migrate" (big word) if we ever add more properties to it. But we can also cross that bridge when we get there, as this is not public. I'd say whatever you prefer!


@RunWith(Enclosed::class)
internal class ComponentOverridesTests {

// This tests deserialization of ComponentOverrides containing PartialTextComponent and PartialImageComponent, just
// to make sure deserialization of generics works as expected.

@RunWith(Parameterized::class)
@RunWith(ParameterizedRobolectricTestRunner::class)
Copy link
Contributor Author

@tonidero tonidero Feb 6, 2025

Choose a reason for hiding this comment

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

I'm adding a test where a log gets called (when a condition is unknown). It was failing with the junit runner since it doesn't know the Log android class.

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

Attention: Patch coverage is 80.64516% with 6 lines in your changes missing coverage. Please review.

Project coverage is 80.62%. Comparing base (424d477) to head (45d7416).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
...es/paywalls/components/common/ComponentOverride.kt 86.20% 2 Missing and 2 partials ⚠️
...at/purchases/paywalls/components/ImageComponent.kt 0.00% 1 Missing ⚠️
...cat/purchases/paywalls/components/TextComponent.kt 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2120      +/-   ##
==========================================
+ Coverage   80.60%   80.62%   +0.01%     
==========================================
  Files         273      273              
  Lines        9143     9166      +23     
  Branches     1287     1289       +2     
==========================================
+ Hits         7370     7390      +20     
- Misses       1232     1236       +4     
+ Partials      541      540       -1     

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

@tonidero tonidero marked this pull request as ready for review February 6, 2025 18:24
@tonidero tonidero requested review from JayShortway and a team February 6, 2025 18:24
Copy link
Member

@JayShortway JayShortway left a comment

Choose a reason for hiding this comment

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

Very nice job! 💪 Just a comment on ignoring unknown JSON keys in condition, and some suggestions for tests.

UNSUPPORTED,
}

private object ConditionSerializer : KSerializer<Condition> {
Copy link
Member

Choose a reason for hiding this comment

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

We could automatically deserialize an object with only a type property if we make Condition sealed, and make its cases (Kotlin) objects instead of an enum. However, we would still need a custom serializer to handle the UNSUPPORTED case, so we wouldn't really gain anything in that respect haha.

As an example, TabControlComponent is a Kotlin object, because it's JSON is:

{ "type": "tab_control" }

Making Condition sealed now would maybe make it slightly easier to "migrate" (big word) if we ever add more properties to it. But we can also cross that bridge when we get there, as this is not public. I'd say whatever you prefer!

@@ -58,6 +56,33 @@ internal class ToPresentedOverridesTests(@Suppress("UNUSED_PARAMETER") name: Str
medium to FontSpec.System("medium"),
expanded to FontSpec.System("expanded"),
)

private val defaultAvailableOverrides = listOf(
Copy link
Member

Choose a reason for hiding this comment

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

Good idea haha!

@tonidero tonidero force-pushed the new-overrides-system branch from 3e53119 to 8862d9a Compare February 7, 2025 12:05
@tonidero tonidero force-pushed the new-overrides-system branch from 8862d9a to a6ae83d Compare February 7, 2025 12:12
@tonidero tonidero merged commit a07303d into main Feb 7, 2025
10 checks passed
@tonidero tonidero deleted the new-overrides-system branch February 7, 2025 15:06
This was referenced Feb 12, 2025
tonidero added a commit that referenced this pull request Feb 14, 2025
**This is an automatic release.**

## RevenueCat SDK
### 🐞 Bugfixes
* fix: Add prepaid as a period type (#2141) via Greenie (@greenietea)

## RevenueCatUI SDK
### Paywalls v2
#### ✨ New Features
* [Paywalls V2] Adds support for Paywalls V2! (#2127) via JayShortway
(@JayShortway)
### Customer Center
#### ✨ New Features
* Adds support for `CustomerCenter` (#2156) via Cesar de la Vega
(@vegaro)

### 🔄 Other Changes
* [Paywalls V2] Deprecate PaywallFooter in favor of
OriginalTemplatePaywallFooter (#2111) via Toni Rico (@tonidero)
* feat: Filter CANCEL from help path if lifetime (#2140) via Facundo
Menzella (@facumenzella)
* fix: Localize Restore Purchases Dialog (#2139) via Facundo Menzella
(@facumenzella)
* fix: Hide contact support if there's no email (#2135) via Facundo
Menzella (@facumenzella)
* feat: Track IMPRESSION and SURVER_OPTION_CHOSEN for CustomerCenter
(#2124) via Facundo Menzella (@facumenzella)
* fix: Use TextButton instead of outline for Promotionals (#2138) via
Facundo Menzella (@facumenzella)
* Rename carousel slide to page (#2144) via Josh Holtz (@joshdholtz)
* [Paywalls V2] Make border draw on top of the image overlay (#2165) via
Toni Rico (@tonidero)
* [Paywalls V2] Gradients Reloaded: Makes linear gradients match CSS
even more closely (#2166) via JayShortway (@JayShortway)
* [Paywalls V2] Fix wrong spacers in Stack when some children are Fill
(#2164) via Toni Rico (@tonidero)
* chore: Unify Json encoding with JsonHelper (#2160) via Facundo
Menzella (@facumenzella)
* [Paywalls V2] Fixes the top system bar padding being applied to all
children in a vertical container (#2162) via JayShortway (@JayShortway)
* [Paywalls V2] Refactor to use a single ImageLoader singleton in
RevenueCatUI (#2161) via Toni Rico (@tonidero)
* [Paywalls V2] Apply stack margins to overlay badges (#2158) via Toni
Rico (@tonidero)
* [Paywalls V2] Disables the click handler for the selected package
(#2159) via JayShortway (@JayShortway)
* [Paywalls V2] Change stack distribution system to use spacers instead
of custom arrangements (#2154) via Toni Rico (@tonidero)
* [Paywalls V2] Fixes empty stacks not showing up. (#2157) via
JayShortway (@JayShortway)
* Explicitly sets the `defaults` flavor as the default. (#2155) via
JayShortway (@JayShortway)
* Updates on no active purchases screen (#2150) via Cesar de la Vega
(@vegaro)
* [Paywalls V2] Fix issue with sizing of stacks with nested badges
(#2152) via Toni Rico (@tonidero)
* [Paywalls V2] Fix issue with shadows overlapping long edgeToEdge
badges (#2149) via Toni Rico (@tonidero)
* [Paywalls V2] Adjusts the convex/concave offset to 10% of the image
height (#2151) via JayShortway (@JayShortway)
* [Paywalls V2] Fixes variables for multi month periods (#2148) via
JayShortway (@JayShortway)
* [Paywalls V2] Correctly handles variables for lifetime products
(#2145) via JayShortway (@JayShortway)
* [Paywalls V2] Add shadows to badge previews (#2147) via Toni Rico
(@tonidero)
* [Paywalls V2] Predownload paywall low res images (#2143) via Toni Rico
(@tonidero)
* [Paywalls V2] Makes linear gradients consistent with CSS (#2142) via
JayShortway (@JayShortway)
* [Paywalls V2] Adds edge-to-edge support (#2137) via JayShortway
(@JayShortway)
* [Paywalls V2] Make root stack component use all the available space by
default (#2136) via Toni Rico (@tonidero)
* [Paywalls V2] Avoids a crash if a package is missing (#2130) via
JayShortway (@JayShortway)
* [Paywalls V2] Fix stack clipping issues (#2126) via Toni Rico
(@tonidero)
* fix: Address typo and wrong doc for CustomerCenter events (#2133) via
Facundo Menzella (@facumenzella)
* [Paywalls V2] Fix merge conflict (#2134) via Toni Rico (@tonidero)
* [Paywalls V2] Actually ignores the font provider for V2. (#2129) via
JayShortway (@JayShortway)
* Rename `PromotionalOfferView` to `PromotionalOfferScreen` (#2132) via
Cesar de la Vega (@vegaro)
* [Paywalls V2] Support background images in StackComponent,
CarouselComponent, TabsComponent (#2131) via Toni Rico (@tonidero)
* [Paywalls V2] Support scroll orientation in StackComponent (#2108) via
Toni Rico (@tonidero)
* [Paywalls V2] Correctly selects packages on tabs (#2122) via
JayShortway (@JayShortway)
* Revamp UI in Customer Center (#2123) via Cesar de la Vega (@vegaro)
* [Paywalls V2] Remove cursive as a generic font (#2118) via Josh Holtz
(@joshdholtz)
* Publishes PaywallsTester to Internal testing track on every commit to
`main` (#2100) via JayShortway (@JayShortway)
* Fixes `X` in promo offer not dismissing the promo (#2110) via Cesar de
la Vega (@vegaro)
* [Paywalls V2] Published version of PaywallTester now uses the Paywalls
V2 Alpha RC project (#2093) via JayShortway (@JayShortway)
* [Paywalls V2] New overrides structure (#2120) via Toni Rico
(@tonidero)
* [Paywalls V2] Adds `TabsComponent` samples and tests (#2115) via
JayShortway (@JayShortway)
* Ignores `RestorePurchasesDialog` previews using `IgnoreEmergeSnapshot`
(#2116) via Cesar de la Vega (@vegaro)
* [Paywalls V2] Adds `TabsComponentView` (#2114) via JayShortway
(@JayShortway)
* Fixes "View field header collides with a variable" data binding error
in PurchaseTester (#2119) via JayShortway (@JayShortway)
* feat: Add support for tracking customer center events (#2117) via
Facundo Menzella (@facumenzella)
* [Paywalls V2] Adds `TabsComponentStyle` (#2113) via JayShortway
(@JayShortway)
* [Paywalls V2] Adds deserialization of `TabsComponent` (#2101) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements Variables V2 (#2099) via JayShortway
(@JayShortway)
* refactor: Introduce EventsManager to track events for different
features (#2096) via Facundo Menzella (@facumenzella)
* Rename to Web Billing (#2094) via Antonio Borrero Granell (@antoniobg)
* [Paywalls V2] Fixes shadows drawing behind transparent components
(#2112) via JayShortway (@JayShortway)
* Fix title not being reset after closing Feedback Survey (#2109) via
Cesar de la Vega (@vegaro)
* Support for opening custom urls in Customer Center (#2107) via Cesar
de la Vega (@vegaro)
* Prices in accept promotional offer button (#2104) via Cesar de la Vega
(@vegaro)
* Customer Center use remote appearance config (#2102) via Cesar de la
Vega (@vegaro)
* [Paywalls V2] Use original paywall fallback when trying to use Footer
modes in a Components paywall (#2106) via Toni Rico (@tonidero)
* [Paywalls V2] Add more `ImageComponentView` preview tests (#2103) via
Toni Rico (@tonidero)
* [Paywalls V2] Add CarouselComponent page indicator animation (#2105)
via Toni Rico (@tonidero)
* [Paywalls V2] Add `CarouselComponentView` (#2095) via Toni Rico
(@tonidero)
* [Paywalls V2] Add `CarouselComponent` infrastructure (#2092) via Toni
Rico (@tonidero)
* [Paywalls V2] Adds new price calculations needed for Variables V2
(#2098) via JayShortway (@JayShortway)
* [Paywalls V2] Preparation for Variables V2 (#2097) via JayShortway
(@JayShortway)
* Promotional offers (#2011) via Cesar de la Vega (@vegaro)
* [Paywalls V2] No longer provides the entire `UiConfig` to
`StyleFactory` (#2091) via JayShortway (@JayShortway)
* [Paywalls V2] Adds support for custom fonts (#2090) via JayShortway
(@JayShortway)
* feat: Add basic customer center events (#2075) via Facundo Menzella
(@facumenzella)
* Add support to manage non-Google purchases in Customer Center (#2067)
via Cesar de la Vega (@vegaro)
* [Paywalls V2] Add `TimelineComponentView` (#2083) via Toni Rico
(@tonidero)
* [Paywalls V2] Process `TimelineComponent` overrides and state (#2082)
via Toni Rico (@tonidero)
* [Paywalls V2] Cleans up after implementing color aliases (#2087) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for backgrounds (#2086) via
JayShortway (@JayShortway)
* `PaywallTesterApp` is no longer wrapped in a `Surface` (#2089) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for shadows (#2085) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for borders (#2084) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `TextComponent` (#2080) via
JayShortway (@JayShortway)
* [Paywalls V2] Add `TimelineComponent` network parsing (#2047) via Toni
Rico (@tonidero)
* [Paywalls V2] Implements color aliases for `ImageComponent` (#2079)
via JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `IconComponent` (#2078) via
JayShortway (@JayShortway)
* Build `SubscriptionDetailsView` using `CustomerInfo` (#2057) via Cesar
de la Vega (@vegaro)
* Some Material 3 updates to the `ManageSubscriptionsView` (#2072) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `StackComponent` (#2076)
via JayShortway (@JayShortway)
* Fixes compilation of `IconComponentView`. (#2073) via JayShortway
(@JayShortway)
* [Paywalls V2] Make `edgeToEdge` top/bottom badge extend to entire
stack background (#2070) via Toni Rico (@tonidero)
* [Paywalls V2] Parses `UiConfig` (#2068) via JayShortway (@JayShortway)
* [Paywalls V2] Add `IconComponent` (#2071) via Toni Rico (@tonidero)
* [Paywalls V2] Badge: Handle main stack border width correctly in
overlay and nested badge styles (#2069) via Toni Rico (@tonidero)
* [Paywalls V2] Add `edgeToEdge` badge trailing/leading style layout
(#2054) via Toni Rico (@tonidero)
* [Paywalls V2] Adds support for fallback components (#2064) via
JayShortway (@JayShortway)

---------

Co-authored-by: revenuecat-ops <[email protected]>
Co-authored-by: Toni Rico <[email protected]>
Co-authored-by: Toni Rico <[email protected]>
Co-authored-by: Cesar de la Vega <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants