Support to round+truncate prices displayed on paywalls for backend-specified countries by jamesrb1 · Pull Request #1806 · RevenueCat/purchases-android

jamesrb1 · 2024-08-08T00:00:05Z

Round and truncate prices displayed on paywalls for storefronts specified by the backend

Some countries have cents as part of their currency, but it is rare to see them written in prices. This PR makes it possible to round/hide the cents component.

Prices are only truncated if the price ends in .00.

The steps to do this are:

1. Get list of storefronts for which rounding should occur.

Get list of prices of storefront countries for which rounding applies. There are different storefront codes for Google (Android) and Apple, and we only save the Google ones, in PaywallData as zeroDecimalPlaceCountries.

2. Determine if this user is in a "rounding" country.

If the country of the storefront that the device is connected to is in the list returned by the backend, we set a new property, VariableProcessor.PackageContext.showZeroDecimalPlacePrices to true. VariableProcessor.PackageContext is used by VariableProcessor to translate {{ price_variables }} into the correct strings.

3. Round prices if needed while processing variables

When the VariableProcessor is asked for a localized price string (localizedPrice(...), localizedPricePerWeek(...) etc., it returns a rounded price if rounding conditions are met.

The server is currently returning "PH", "KZ", "TW", "MX", "TH" as zero decimal countries. If your google account is not in one of these countries, you can turn temporarily turn rounding "on" by going to PackageConfigurationFactory.kt and replacing

                paywallData.zeroDecimalPlaceCountries.contains(
                    Purchases.sharedInstance.storefrontCountryCode,
                )

with

                paywallData.zeroDecimalPlaceCountries.contains(
                    "TW",
                )

Note that prices are formatted according to the locale of the RC paywall. For example, if the device's language setting is Canadian English (en_CA), and attached the Canadian Play store (CA), but there is no RC paywall localized to English (Canada), then the paywall that we show falls back to the en_US paywall, and all prices will be formatted according to en_US rules, meaning a price will show as e.g. "CA$7.99". If there is an en_CA paywall, then prices are formatted according to en_CA rules, e.g. "$7.99".

This is the Android version of RevenueCat/purchases-ios#4132

codecov · 2024-08-10T21:21:01Z

Codecov Report

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

Project coverage is 82.84%. Comparing base (f8ee985) to head (44fb0e5).
Report is 2 commits behind head on main.

Files	Patch %	Lines
...urchases/utils/serializers/GoogleListSerializer.kt	28.57%	2 Missing and 3 partials ⚠️
.../com/revenuecat/purchases/PurchasesOrchestrator.kt	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1806      +/-   ##
==========================================
- Coverage   82.89%   82.84%   -0.06%     
==========================================
  Files         221      222       +1     
  Lines        7660     7670      +10     
  Branches     1074     1077       +3     
==========================================
+ Hits         6350     6354       +4     
- Misses        891      894       +3     
- Partials      419      422       +3

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

tonidero

Mostly some API tests missing and some questions but looking good!

tonidero · 2024-08-12T10:17:04Z

+
+    @SerialName("zero_decimal_place_countries")
+    @Serializable(with = GoogleListSerializer::class)
+    val zeroDecimalPlaceCountries: List<String> = emptyList(),


Also need to add this to API tests

I don't see any explicit API testers for PaywallData, but the sample paywalls in SamplePaywalls.kt serves this purpose. Is there somewhere else this should be added?

…venuecatui/data/processed/VariableDataProvider.kt Co-authored-by: JayShortway <29483617+JayShortway@users.noreply.github.com>

…ory`

jamesrb1 · 2024-08-13T00:36:10Z

StoreProduct and PricingPhase have .pricePerPeriod() functions too. Should they exhibit the same rounding behavior, or is this purely Paywall presentation logic?

AFAIK this rounding is only needed for paywall presentation. I see you added the code for PricingPhase - do you know if these values are ever presented to the user?

JayShortway · 2024-08-13T10:00:28Z

StoreProduct and PricingPhase have .pricePerPeriod() functions too. Should they exhibit the same rounding behavior, or is this purely Paywall presentation logic?

AFAIK this rounding is only needed for paywall presentation. I see you added the code for PricingPhase - do you know if these values are ever presented to the user?

(Really missing GitLab's comment threads ☝️)

Alright! They're not presented to the user, unless the app developer does it in their own UI. They're purely convenience functions (but I do imagine their main purpose is to show in UI).

cc @tonidero for verification 🙏

tonidero · 2024-08-13T11:06:46Z

They're not presented to the user, unless the app developer does it in their own UI. They're purely convenience functions (but I do imagine their main purpose is to show in UI).

Yeah, that's true. It's part of the public API, in case a developer wants to use them. They can also write this logic themselves for sure, so this would be a mostly convenience change. However, note that this is configured from the paywalls, so maybe it makes more sense to restrain this logic to paywalls and just use what comes from the store otherwise? Happy to discuss this more over Slack if needed.

JayShortway · 2024-08-13T12:28:07Z

so maybe it makes more sense to restrain this logic to paywalls and just use what comes from the store otherwise?

Yea I think that makes a lot of sense!

jamesrb1 · 2024-08-13T23:27:13Z

I believe I've addressed all concerns raised.

JayShortway

LGTM!

To fix PurchasesAPI.java:

- final String storefrontCountryCode = purchases.storefrontCountryCode();
+ final String storefrontCountryCode = purchases.getStorefrontCountryCode();

Java loves its getters and setters. So a val in Kotlin becomes a getter. A var becomes a pair of getter and setter.

jamesrb1 · 2024-08-15T16:11:32Z

To fix PurchasesAPI.java:

THANK YOU!!!

@joshdholtz

**This is an automatic release.** ### New Features * [Paywalls] Add default locale (#1809) via Josh Holtz (@joshdholtz) * [Paywalls] Support to round+truncate prices displayed on paywalls for backend-specified countries (#1806) via James Borthwick (@jamesrb1) ### Other Changes * Publish paywall tester on each release (#1803) via Toni Rico (@tonidero) --------- Co-authored-by: revenuecat-ops <ops@revenuecat.com> Co-authored-by: Josh Holtz <me@joshholtz.com>

jamesrb1 added 2 commits August 7, 2024 16:58

Deserialize zero_decimal_place_countries maybe

b346f82

Don’t throw if google isn’t there.

b575823

jamesrb1 added the pr:feat A new feature label Aug 8, 2024

jamesrb1 added 11 commits August 9, 2024 10:31

Store and pass if price should be rounded.

a92ca74

Add price rounding when appropriate

030aece

Fish out the storefront’s country code.

bfb8b54

Calculate shouldRound

12776b6

Pass it in

a0cc1c7

Initial tests

411c91b

More tests

05fa695

Deal with currency that doesn’t match locale; Add Euros test

7ad6098

More tests

c130763

Working with storefront region, device language.

7245f49

Tidying

38a8fcb

jamesrb1 mentioned this pull request Aug 10, 2024

Price rounding logic RevenueCat/purchases-ios#4132

Merged

jamesrb1 added 12 commits August 9, 2024 21:25

Just always use device locale for price formatting.

1c30e9f

Use passed locale; bug fixes

02b6452

No more parsing

951e718

MICRO_MULTIPLIER

e792cd3

Much better organization

104d4bc

Test compile

986400f

Test intro prices; price organization

a4fe84c

Update test json.

21da157

Do not require a zero_decimal_place_countries.

4f82215

Don’t die if Purchases aren’t configured (important for tests).

8ad4df3

detekt

fe290df

detekt

858eff2

jamesrb1 marked this pull request as ready for review August 12, 2024 03:22

jamesrb1 requested a review from a team August 12, 2024 03:23

tonidero reviewed Aug 12, 2024

View reviewed changes

jamesrb1 and others added 5 commits August 12, 2024 14:42

Update ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/re…

142e659

…venuecatui/data/processed/VariableDataProvider.kt Co-authored-by: JayShortway <29483617+JayShortway@users.noreply.github.com>

Centralize test zeroPlaceDecimalCountries

0cd208c

Move GoogleListSerializer to separate file.

b5907de

storefrontCountryCode API tests

e5a303f

pass purchases.storefrontCountryCode into `PackageConfigurationFact…

5912b9f

…ory`

jamesrb1 added 10 commits August 12, 2024 17:37

missing ;

4340632

unsure why this is failing to compile

f277b8c

test fix

69f1b40

Remove unused serialization imports

9d5a5ac

Suppress long param list

9f0aba2

Test data

c18b55d

Test data inclusion

8d769a2

Correct Mock

659354c

correct mock

db03cb9

Properties are functions in Javaland

a0c85f9

Rounding logic and test updates

9ad5a9f

Make Java API test a function

5e5f017

JayShortway approved these changes Aug 15, 2024

View reviewed changes

Java API test

44fb0e5

jamesrb1 merged commit d26a594 into main Aug 15, 2024

jamesrb1 deleted the james/drop-paywalls-.00-from-prices branch August 15, 2024 20:53

RCGitBot mentioned this pull request Aug 21, 2024

[AUTOMATIC] Release/8.5.0 #1815

Merged

Conversation

jamesrb1 commented Aug 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Round and truncate prices displayed on paywalls for storefronts specified by the backend

1. Get list of storefronts for which rounding should occur.

2. Determine if this user is in a "rounding" country.

3. Round prices if needed while processing variables

Uh oh!

codecov Bot commented Aug 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tonidero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tonidero Aug 12, 2024

Choose a reason for hiding this comment

Uh oh!

jamesrb1 Aug 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jamesrb1 commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JayShortway commented Aug 13, 2024

Uh oh!

tonidero commented Aug 13, 2024

Uh oh!

JayShortway commented Aug 13, 2024

Uh oh!

jamesrb1 commented Aug 13, 2024

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

jamesrb1 commented Aug 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jamesrb1 commented Aug 8, 2024 •

edited

Loading

codecov Bot commented Aug 10, 2024 •

edited

Loading

jamesrb1 commented Aug 13, 2024 •

edited

Loading