[Paywalls] Improve locale consistency by joshdholtz · Pull Request #4158 · RevenueCat/purchases-ios

joshdholtz · 2024-08-08T03:21:42Z

⚠️ Waiting for #4188 to be merged first (because needs all the tests to pass)

Motivation

Fix cases where paywall was showing multiple languages at once and random languages.

Description

👉 For a demo of the problem and solution, look in Slack in the paywalls or SDK channel for the latest Loom that I posted

Flow of paywall localization logic (since it can be confusing)

PaywallView starts with Locale.current but then calls offering.validatedPaywall() which will return the new displayedLocale: Locale variable
PaywallData+Validation returns displayedLocale if its a valid paywall, otherwise it return Locale.current for fallback paywall
PaywallData+Localization has a lot of the new logic
- New locale: Locale computer property that it determines the locale from the localizedConfiguration or localizedConfigurationsByTier
- New defaultLocalizedConfiguration that uses the developer set defaultLocale (from PaywallData) to find the default localization
- Updated localizedConfiguration<Value>() to take a new defaultLocalization to put in its priority (and log it if its used). If for some reason that's not found, it will use the legacy fallbackLocalization (which is the first localization it finds or english)
After all of that, the displayedLocale is passed into the actually SwiftUI LoadedOfferingPaywallView to show this locale everywhere

Problem 1 - Inconsistent languages displayed at once

The user defined localizations and the pre-localized content in the SDK (like links in the footer and package duration names) could should different localizations. The choice of which locale was happening in two different spots.

Since the SDK has all possible localizations that the dashboard offers, the locale SDK displays from the dashboard will be chosen for the pre-localized content.

Problem 2 - Showing random languages if not supported

We decided early on to not use a default_locale but that has hurt us. The solution to use was use localizations.first to show the first locale in the list and the intention that this was the first locale the user did in the paywall. That was not the case, however. The order of the localizations list was indeterministic so it should should a random language (even to the point where different random languages would show the the same user).

We are now introducing a default_locale that the developer can set in the paywall. If the locale the user is requesting is not translated by the developer, it will use the default_locale

Problem 3 - Footer not using correct localization from the bundle

There were times where some parts of the footer itself (mainly the restore button) would be a different language than the terms of service and privacy policy buttons. This was due to a code issue where we were using Bundle.module. Instead, we needed to specify a localization bundle specifically that we wanted to use.

joshdholtz · 2024-08-08T17:13:32Z

    static func localized(
        packageType: PackageType,
-        locale: Locale = .current
+        locale: Locale,


Defaulting to .current is hard to traceback for decision making and debugging to getting rid of it

joshdholtz · 2024-08-08T17:14:05Z

            switch paywall.validate() {
            case let .success(template):
-                return (paywall, template, nil)
+                return (paywall, paywall.locale ?? locale, template, nil)


paywall.locale SHOULD always exist at this point but needed to do something like this to make it happy 🤷‍♂️

joshdholtz · 2024-08-08T17:14:45Z

-            Text("All subscriptions", bundle: .module)
+            Text("All subscriptions", bundle: bundle)


Things like this were the cause of not putting correct localizations and so needing to "add" the localizations to Xcode

joshdholtz · 2024-08-08T17:15:26Z

+    var locale: Locale? {
+        let singleTier = self.localizedConfiguration(for: Self.localesOrderedByPriority)?.0
+        let multiTier = self.localizedConfigurationByTier(for: Self.localesOrderedByPriority)?.0
+
+        return singleTier ?? multiTier
+    }


This is slightly gross but it gets the job done 🤷‍♂️

joshdholtz · 2024-08-08T17:16:15Z

One thing I don't love here is how all of these variables are computed 😬 If they are called multiple times, it reruns all of this logic again. I don't really feel comfortable changing all of that in this PR yet

I guess the computed properties might support changing localizations on the fly. Not sure how often that happens or if it's even a use case worth supporting though.

jamesrb1

Very nice!!

jamesrb1 · 2024-08-08T23:48:00Z

            locale: locale,
-            // Or defaults to english
-            default: value(locale: Self.defaultLocale, default: nil)
+            // Or falls back to first localization or english


Suggested change

// Or falls back to first localization or english

// Or falls back to first localization, and if unavailable, english

jamesrb1 · 2024-08-08T23:54:40Z

        introEligibility: TrialOrIntroEligibilityChecker? = nil,
-        purchaseHandler: PurchaseHandler
+        purchaseHandler: PurchaseHandler,
+        locale: Locale = .current


Based on your loom, is a default of .current safe?

That's a fair point! I removed it 😊

jamesrb1 · 2024-08-09T00:02:18Z

-    internal func localizedConfiguration(for preferredLocales: [Locale]) -> LocalizedConfiguration? {
+    internal func localizedConfiguration(
+        for preferredLocales: [Locale]
+    ) -> (Locale, LocalizedConfiguration)? {


Consider labeling the tuple parameters so that we can refer to them by name rather than order (ie instead of ?.0, ?.locale).

Suggested change

) -> (Locale, LocalizedConfiguration)? {

) -> (locale: Locale, localizedConfiguration: LocalizedConfiguration)? {

jamesrb1 · 2024-08-09T00:05:53Z

        set { self._revision = newValue }
    }

+    /// The default localue identifier for this paywall.


typo

Suggested change

/// The default localue identifier for this paywall.

/// The default locale identifier for this paywall.

jamesrb1 · 2024-08-09T00:12:19Z

I guess the computed properties might support changing localizations on the fly. Not sure how often that happens or if it's even a use case worth supporting though.

jamesrb1 · 2024-08-09T00:19:58Z

            introEligibility: Self.introEligibility,
-            purchaseHandler: Self.purchaseHandler
+            purchaseHandler: Self.purchaseHandler,
+            locale: Locale.current


Should we be defaulting to Locale.preferredLocales.first ?? Locale.current? (access restrictions aside.)

Ah, probably! The loading view is all skeleton stuff anyway so there isn't actually any text anywhere but that does feel better 😇

tonidero

Not an expert, but this makes sense. Great fixes!

joshdholtz · 2024-08-15T14:51:21Z

@RCGitBot please test

joshdholtz · 2024-08-19T03:30:12Z

@RCGitBot please test

joshdholtz · 2024-08-20T13:24:38Z

@RCGitBot please test

@jamesrb1

**This is an automatic release.** ### New Features * Price rounding logic (#4132) via James Borthwick (@jamesrb1) ### Bugfixes * [Customer Center] Migrate to List style (#4190) via Cody Kerns (@codykerns) * [Paywalls] Improve locale consistency (#4158) via Josh Holtz (@joshdholtz) * Set Paywalls Tester deployment target to iOS 15 (#4196) via James Borthwick (@jamesrb1) * [Customer Center] Hide Contact Support button if URL can't be created (#4192) via Cesar de la Vega (@vegaro) * Fix the setting for SKIP_INSTALL in Xcode project (#4195) via Andy Boedo (@aboedo) * [Customer Center] Improving customer center buttons (#4165) via Cody Kerns (@codykerns) * Revert workaround for iOS 18 beta 5 SwiftUI crash (#4173) via Mark Villacampa (@MarkVillacampa) * [Paywalls] Make iOS version calculation lazy (#4163) via Mark Villacampa (@MarkVillacampa) * [Paywalls] Observe `PurchaseHandler` when owned externally (#4097) via James Borthwick (@jamesrb1) ### Other Changes * [Customer Center] Clean up colors in WrongPlatformView and NoSubscriptionsView (#4204) via Cesar de la Vega (@vegaro) * Fix failing `all-tests` and retry more flaky tests (#4188) via Josh Holtz (@joshdholtz) * Compatibility content unavailable improvements (#4197) via James Borthwick (@jamesrb1) * Create lane to enable customer center (#4191) via Cesar de la Vega (@vegaro) * XCFramework artifacts in CircleCI (#4189) via Andy Boedo (@aboedo) * [Customer Center] CustomerCenterViewModel checks whether the app is the latest version (#4169) via JayShortway (@JayShortway) * export RevenueCatUI xcframework (#4172) via Andy Boedo (@aboedo) * Corrects references from ManageSubscriptionsButtonStyle to ButtonsStyle. (#4186) via JayShortway (@JayShortway) * Speed up carthage installation tests (#4184) via Andy Boedo (@aboedo) * Customer center improvements (#4166) via James Borthwick (@jamesrb1) * replace `color(from colorInformation:)` global with extension (#4183) via Andy Boedo (@aboedo) * Fix tests in main (#4174) via Andy Boedo (@aboedo) * Enable customer center tests (#4171) via James Borthwick (@jamesrb1) * [Customer Center] Initial implementation (#3967) via Cesar de la Vega (@vegaro) --------- Co-authored-by: Josh Holtz <me@joshholtz.com>

⚠️ Waiting for #4188 to be merged first (because needs all the tests to pass) ## Motivation Fix cases where paywall was showing multiple languages at once and random languages. ## Description 👉 For a demo of the problem and solution, look in Slack in the paywalls or SDK channel for the latest Loom that I posted ### Flow of paywall localization logic (since it can be confusing) 1. [PaywallView](https://github.com/RevenueCat/purchases-ios/pull/4158/files#diff-ea75fe7280803e15b975d702a16c6851ffc2bbed01b7b196bf0fb80d75b4b332) starts with `Locale.current` but then calls `offering.validatedPaywall()` which will return the new `displayedLocale: Locale` variable 2. [PaywallData+Validation](https://github.com/RevenueCat/purchases-ios/pull/4158/files#diff-452790cf5287a44f75a4b2260254db2281a066faeea2b3e441a007ec60522b6b) returns `displayedLocale` if its a valid paywall, otherwise it return `Locale.current` for fallback paywall 3. [PaywallData+Localization](https://github.com/RevenueCat/purchases-ios/pull/4158/files#diff-e620baead94f7acad56d931c485d7691c4f909be3fe625e104528a2702cca2a0) has a lot of the new logic - New `locale: Locale` computer property that it determines the locale from the `localizedConfiguration` or `localizedConfigurationsByTier` - New ` defaultLocalizedConfiguration` that uses the developer set `defaultLocale` (from `PaywallData`) to find the default localization - Updated `localizedConfiguration<Value>()` to take a new `defaultLocalization` to put in its priority (and log it if its used). If for some reason that's not found, it will use the legacy `fallbackLocalization` (which is the first localization it finds or english) 4. After all of that, the `displayedLocale` is passed into the actually SwiftUI `LoadedOfferingPaywallView` to show this locale everywhere ### Problem 1 - Inconsistent languages displayed at once The user defined localizations and the pre-localized content in the SDK (like links in the footer and package duration names) could should different localizations. The choice of which locale was happening in two different spots. Since the SDK has all possible localizations that the dashboard offers, the locale SDK displays from the dashboard will be chosen for the pre-localized content. ### Problem 2 - Showing random languages if not supported We decided early on to not use a `default_locale` but that has hurt us. The solution to use was use `localizations.first` to show the first locale in the list and the intention that this was the first locale the user did in the paywall. That was not the case, however. The order of the localizations list was indeterministic so it should should a random language (even to the point where different random languages would show the the same user). We are now introducing a `default_locale` that the developer can set in the paywall. If the locale the user is requesting is not translated by the developer, it will use the `default_locale` ### Problem 3 - Footer not using correct localization from the bundle There were times where some parts of the footer itself (mainly the restore button) would be a different language than the terms of service and privacy policy buttons. This was due to a code issue where we were using `Bundle.module`. Instead, we needed to specify a localization bundle specifically that we wanted to use.

@jamesrb1

**This is an automatic release.** ### New Features * Price rounding logic (#4132) via James Borthwick (@jamesrb1) ### Bugfixes * [Customer Center] Migrate to List style (#4190) via Cody Kerns (@codykerns) * [Paywalls] Improve locale consistency (#4158) via Josh Holtz (@joshdholtz) * Set Paywalls Tester deployment target to iOS 15 (#4196) via James Borthwick (@jamesrb1) * [Customer Center] Hide Contact Support button if URL can't be created (#4192) via Cesar de la Vega (@vegaro) * Fix the setting for SKIP_INSTALL in Xcode project (#4195) via Andy Boedo (@aboedo) * [Customer Center] Improving customer center buttons (#4165) via Cody Kerns (@codykerns) * Revert workaround for iOS 18 beta 5 SwiftUI crash (#4173) via Mark Villacampa (@MarkVillacampa) * [Paywalls] Make iOS version calculation lazy (#4163) via Mark Villacampa (@MarkVillacampa) * [Paywalls] Observe `PurchaseHandler` when owned externally (#4097) via James Borthwick (@jamesrb1) ### Other Changes * [Customer Center] Clean up colors in WrongPlatformView and NoSubscriptionsView (#4204) via Cesar de la Vega (@vegaro) * Fix failing `all-tests` and retry more flaky tests (#4188) via Josh Holtz (@joshdholtz) * Compatibility content unavailable improvements (#4197) via James Borthwick (@jamesrb1) * Create lane to enable customer center (#4191) via Cesar de la Vega (@vegaro) * XCFramework artifacts in CircleCI (#4189) via Andy Boedo (@aboedo) * [Customer Center] CustomerCenterViewModel checks whether the app is the latest version (#4169) via JayShortway (@JayShortway) * export RevenueCatUI xcframework (#4172) via Andy Boedo (@aboedo) * Corrects references from ManageSubscriptionsButtonStyle to ButtonsStyle. (#4186) via JayShortway (@JayShortway) * Speed up carthage installation tests (#4184) via Andy Boedo (@aboedo) * Customer center improvements (#4166) via James Borthwick (@jamesrb1) * replace `color(from colorInformation:)` global with extension (#4183) via Andy Boedo (@aboedo) * Fix tests in main (#4174) via Andy Boedo (@aboedo) * Enable customer center tests (#4171) via James Borthwick (@jamesrb1) * [Customer Center] Initial implementation (#3967) via Cesar de la Vega (@vegaro) --------- Co-authored-by: Josh Holtz <me@joshholtz.com>

joshdholtz added the pr:fix A bug fix label Aug 8, 2024

joshdholtz requested review from a team August 8, 2024 16:55

joshdholtz force-pushed the paywall-locale-choosing-improvements branch from f6eeca4 to d330125 Compare August 8, 2024 16:58

joshdholtz marked this pull request as ready for review August 8, 2024 16:58

joshdholtz commented Aug 8, 2024

View reviewed changes

jamesrb1 approved these changes Aug 9, 2024

View reviewed changes

tonidero approved these changes Aug 9, 2024

View reviewed changes

joshdholtz force-pushed the paywall-locale-choosing-improvements branch from 4349304 to faa499e Compare August 15, 2024 12:50

joshdholtz added 16 commits August 16, 2024 18:09

Empty commit to make PR to run tests

2795768

Maybe this

0353658

Will this pass

3a562ae

This

cea708d

Fix missing file

c2a6c57

Removed double ButtonStyles reference

82071e3

Revert

e567132

Also reverT

2e39cd3

This should do it

750f39b

Fixes for iOS 15 now

ff41588

Or this

1c56c69

Oops

8e0f7c5

What am i doing

8d06467

Undo this

a734965

Does this work

992b7d4

reset everything

f4e8c41

joshdholtz added 18 commits August 18, 2024 22:14

This actually works

77715c9

It wooorrkkksss

476172a

Fixed lint

8181bd2

Fix compilation failures in some tests

94fef82

Maybe this

ad36821

This is better

c57bb34

Maybe this

c41c3ff

Fixed watch template view

e3b08a0

Fix UI tests

bae926c

Some fixes

53f4656

Fixed some confusing name of default and fallback

a00ee81

Fixed some confusing name of default and fallback

44f7fc9

Didn't need environment thing

35886b3

oops, forgot a thing

3a85a4b

Some improvements from PR comment

76a3518

Keep Locale.current on PaywallViewConfiguration

d94848a

Fix a lint

2aee251

Fix backend integration snapshot

dfc4342

joshdholtz force-pushed the paywall-locale-choosing-improvements branch from b755f25 to dfc4342 Compare August 19, 2024 03:15

Base automatically changed from fix-failing-tests-that-rcbot-does to main August 20, 2024 12:44

Fix merge from main issues

c3cc6b6

joshdholtz merged commit 1fa69d4 into main Aug 20, 2024

joshdholtz deleted the paywall-locale-choosing-improvements branch August 20, 2024 14:44

RCGitBot mentioned this pull request Aug 21, 2024

[AUTOMATIC] Release/5.3.0 #4205

Merged

JayShortway mentioned this pull request Sep 3, 2024

Language management - iOS paywall RevenueCat/purchases-kmp#173

Closed

10 tasks

		Text("All subscriptions", bundle: .module)
		Text("All subscriptions", bundle: bundle)

	// Or falls back to first localization or english
	// Or falls back to first localization, and if unavailable, english

	) -> (Locale, LocalizedConfiguration)? {
	) -> (locale: Locale, localizedConfiguration: LocalizedConfiguration)? {

	/// The default localue identifier for this paywall.
	/// The default locale identifier for this paywall.

Uh oh!

Conversation

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

Uh oh!

Motivation

Description

Flow of paywall localization logic (since it can be confusing)

Problem 1 - Inconsistent languages displayed at once

Problem 2 - Showing random languages if not supported

Problem 3 - Footer not using correct localization from the bundle

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!

jamesrb1 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!

Choose a reason for hiding this comment

Uh oh!

jamesrb1 Aug 9, 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!

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 left a comment

Choose a reason for hiding this comment

Uh oh!

joshdholtz commented Aug 15, 2024

Uh oh!

joshdholtz commented Aug 19, 2024

Uh oh!

joshdholtz commented Aug 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

joshdholtz commented Aug 8, 2024 •

edited

Loading

jamesrb1 Aug 9, 2024 •

edited

Loading