feat: Add a possibility to set app locale #580

mykola-mokhnach · 2020-05-21T18:25:03Z

Currently it is only possible to set locale via Appium Settings helper, which does it in a really hacky manner. Also there is no guarantee this hack going to work in newer Android versions.

Although, Espresso anyway uses the target context concept, which we could change locale for without private method calls. I've added the locale capability that allows to set locale for an initial app startup as well as mobile: setLocale one, which does it dynamically.

I would really appreciate it if you could help me with testing on newer Android versions @KazuCocoa

mykola-mokhnach · 2020-05-21T18:26:28Z

Reference link https://stackoverflow.com/questions/53417037/change-locale-while-executing-espresso-test

KazuCocoa

Let me check RTL, too. Will update our demo app for it to check.

lib/desired-caps.js

KazuCocoa · 2020-05-22T01:02:24Z

espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/LocaleHelpers.kt

+    }
+    val res = context.resources
+    val config = res.configuration
+    config.locales = LocaleList(locale)


config.setLayoutDirection(locale) is necessary to apply RTL style properly

The docstring on setLocales method:

/** * Set the locale list. This is the preferred way for setting up the locales (instead of using * the direct accessor or {@link #setLocale(Locale)}). This will also set the layout direction * according to the first locale in the list. * * Note that the layout direction will always come from the first locale in the locale list, * even if the locale is not supported by the resources (the resources may only support * another locale further down the list which has a different direction). * * @param locales The locale list. If null, an empty LocaleList will be assigned. */

ah, okay. I see.
I also understand this is application-wide change (via the target context), so other areas such as status bar and other applications do not change.
Will check with an app which has multiple locale/layout later

LocaleList is only for API level 24. (below is for lower versions)

config.locale = locale config.setLayoutDirection(locale)

thanks, will change

KazuCocoa · 2020-05-22T06:15:16Z

lib/desired-caps.js

@@ -41,7 +41,7 @@ let espressoCapConstraints = {
  activityOptions: {
    isObject: true
  },
-  locale: {
+  appLocale: {


KazuCocoa · 2020-05-22T16:17:00Z

How did you check this feature?
I downloaded Firefox app, and set it as the app under test. The device under test was Android 10 Nokia device.

But the locale (displayed language) did not change by this via mobile command even only application-wide.

mykola-mokhnach · 2020-05-22T16:33:22Z

I tried Android 8. I suppose you have to restart the activity or start a new one/restart the current to have the changes applied to the UI.

KazuCocoa · 2020-05-22T17:03:44Z

Thanks.
Yeah, it worked in application-wide after killing running activity, and launch it again.

Even we provide appLocale capability, the initial activity does not have the appLocale one.
I mean when the device is en_US and I set appLocale as appLocale: {language: 'ja', country: 'JP'},, the initial activity has the en_US's one. Once I close the activity and launch a new or the same one, the appLocale has the jp's one.

We should apply the locale change before starting the app under test's process to apply this from the beginning. In Espresso case, I imagine applying this change in ActivityScenario before launching the activity under test.

mykola-mokhnach · 2020-05-22T17:55:46Z

Even we provide appLocale capability, the initial activity does not have the appLocale one.

Yes, this is something I was getting as well. And this is strange, because I actually set the stuff before starting the activity

mykola-mokhnach · 2020-05-22T18:18:18Z

Added some methods to restart the activity after locale change. Perhaps, it could make it working

KazuCocoa · 2020-05-23T01:50:17Z

I have Android 6 and Android 10 devices.
#580 (comment) worked for Android 6 with the current logic with capabilities. When I sent mobile:setAppLocal as {language: 'fa', country: 'AF'}, the preference was applied the locale partially (it depends on Firefox app's implementation, I believe) after backing the app to background and moving it forward with launch the app by history. Once I killed the app process and launched it again, the {language: 'fa', country: 'AF'} was applied fully. So, capabilities style works expectedly but we should note for mobile command the locale will be applied activities which launches after the command. (Or I also think only capabilities is fine to reduce user's confusion)

But no luck for Android 10 even I did the same steps with Android 6. I mean both via capabilities and mobile command. I needed to kill the activity once and launch them again by manual.

mykola-mokhnach · 2020-05-23T06:16:25Z

thanks for your help
Let me focus better on Android 10 then.

mykola-mokhnach · 2020-05-23T06:16:47Z

Let me know if you have any ideas regarding the code modification

mykola-mokhnach · 2020-05-23T17:44:57Z

You were right @KazuCocoa
We never know how to restart an activity properly, since it depends on the particular app implementation. Thus I've removed the mobile: endpoint and only keep the capability for setting the locale on app startup. Tested on Android 10 and Android 5 (Firefox binary): both worked as expected

KazuCocoa

👍
I checked this method worked on my phone, too.

I think this way, leaving only the capability, is the best enough way for us (as espresso-driver)
The Espresso approach depends on the app under test's implementation.
So, generally, users should decide if follow this application-wide method or system-wide (by settings app, but hacky one) in their tests

KazuCocoa · 2020-05-24T05:01:21Z

...esso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/ActivityHelpers.kt

+                }
+                return null
+            }
+            for (method in listOf(method1, method2)) {


KazuCocoa · 2020-05-24T05:01:29Z

espresso-server/app/src/androidTest/java/io/appium/espressoserver/lib/helpers/LocaleHelpers.kt

+        Locale.setDefault(Locale.Category.DISPLAY, locale)
+    }
+
+    if (SDK_INT >= Build.VERSION_CODES.N) {


feat: Add a possibility to set locale

a296dc6

mykola-mokhnach requested a review from KazuCocoa May 21, 2020 18:25

KazuCocoa reviewed May 22, 2020

View reviewed changes

Address review comments

e357447

KazuCocoa reviewed May 22, 2020

View reviewed changes

mykola-mokhnach changed the title ~~feat: Add a possibility to set locale~~ feat: Add a possibility to set app locale May 22, 2020

Add activity restart after locale change

73704a4

mykola-mokhnach added 2 commits May 23, 2020 14:18

Tune the approach

75de235

Remove mobile endpoint

4c996f2

KazuCocoa approved these changes May 24, 2020

View reviewed changes

mykola-mokhnach merged commit 74910bf into appium:master May 24, 2020

mykola-mokhnach deleted the locale branch May 24, 2020 05:38

KazuCocoa mentioned this pull request May 29, 2020

docs: add appLocale appium/appium#14388

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add a possibility to set app locale #580

feat: Add a possibility to set app locale #580

mykola-mokhnach commented May 21, 2020

mykola-mokhnach commented May 21, 2020

KazuCocoa left a comment

KazuCocoa May 22, 2020

mykola-mokhnach May 22, 2020

KazuCocoa May 22, 2020

KazuCocoa May 23, 2020 •

edited

Loading

mykola-mokhnach May 23, 2020

KazuCocoa May 22, 2020

KazuCocoa commented May 22, 2020

mykola-mokhnach commented May 22, 2020 •

edited

Loading

KazuCocoa commented May 22, 2020 •

edited

Loading

mykola-mokhnach commented May 22, 2020

mykola-mokhnach commented May 22, 2020 •

edited

Loading

KazuCocoa commented May 23, 2020 •

edited

Loading

mykola-mokhnach commented May 23, 2020

mykola-mokhnach commented May 23, 2020

mykola-mokhnach commented May 23, 2020 •

edited

Loading

KazuCocoa left a comment

KazuCocoa May 24, 2020

KazuCocoa May 24, 2020

feat: Add a possibility to set app locale #580

feat: Add a possibility to set app locale #580

Conversation

mykola-mokhnach commented May 21, 2020

mykola-mokhnach commented May 21, 2020

KazuCocoa left a comment

Choose a reason for hiding this comment

KazuCocoa May 22, 2020

Choose a reason for hiding this comment

mykola-mokhnach May 22, 2020

Choose a reason for hiding this comment

KazuCocoa May 22, 2020

Choose a reason for hiding this comment

KazuCocoa May 23, 2020 • edited Loading

Choose a reason for hiding this comment

mykola-mokhnach May 23, 2020

Choose a reason for hiding this comment

KazuCocoa May 22, 2020

Choose a reason for hiding this comment

KazuCocoa commented May 22, 2020

mykola-mokhnach commented May 22, 2020 • edited Loading

KazuCocoa commented May 22, 2020 • edited Loading

mykola-mokhnach commented May 22, 2020

mykola-mokhnach commented May 22, 2020 • edited Loading

KazuCocoa commented May 23, 2020 • edited Loading

mykola-mokhnach commented May 23, 2020

mykola-mokhnach commented May 23, 2020

mykola-mokhnach commented May 23, 2020 • edited Loading

KazuCocoa left a comment

Choose a reason for hiding this comment

KazuCocoa May 24, 2020

Choose a reason for hiding this comment

KazuCocoa May 24, 2020

Choose a reason for hiding this comment

KazuCocoa May 23, 2020 •

edited

Loading

mykola-mokhnach commented May 22, 2020 •

edited

Loading

KazuCocoa commented May 22, 2020 •

edited

Loading

mykola-mokhnach commented May 22, 2020 •

edited

Loading

KazuCocoa commented May 23, 2020 •

edited

Loading

mykola-mokhnach commented May 23, 2020 •

edited

Loading