chore(android): Update projects to use Java 11 #8543

darcywong00 · 2023-03-29T08:02:51Z

Fixes #2293 (Updating to Java 11)
Also fixes #8542 by moving some configure steps to build actions

After deferring multiple releases, this updates the Android projects to use Java 11 instead of Java 8.
For CI compatibility, the build.sh will override JAVA_HOME for to JAVA_HOME_11 and then revert to JAVA_HOME_8 when the build is finished.

One notable Gradle change is the Keyman Engine for Android artifact name changes
from KMEA/app/build/outputs/aar/${CONFIG}/keyman-engine.aar
to KMEA/app/build/outputs/aar/keyman-engine-${CONFIG}.aar"

The build also flagged notificationManager.notify needing to catch SecurityException.

CI Test configs updated to use the top level Android build.sh script (handles updating JAVA_HOME to JDK 11 for the build).
TODO:

Update Release config - Updated build-publish.sh to also override JAVA_HOME to JDK 11

User Testing

Setup - Install the PR builds of "Keyman for Android" and "FirstVoices for Android"

TEST_KEYMAN - Verifies Keyman app functions

Launch Keyman for Android and dismiss the "Get Started" menu
From the Keyman app, type on the default sil_euro_latin keyboard
Verify the in-app keyboard functions
From Keyman settings --> Search for another keyboard (e.g. khmer_angkor) from keyman.com and install
From the Keyman app, type on the khmer_angkor keyboard
Verify the in-app keyboard functions
From the "Get Started" menu, enable Keyman as a system keyboard and set as default system keyboard
Launch a separate app (e.g. Google Chrome)
Select a textfield
With Keyman as a system keyboard, type
Verify the system keyboard functions

TEST_FV - Verifies FirstVoices for Android functions

Launch FirstVoices for Android
From the FirstVoices "Setup" menu, add a region --> keyboard
From the "Setup" menu, enable FirstVoices as a system keyboard and set as the default system keyboard
Launch a sparate app (e.g. Google Chrome)
Select a textfield
With FirstVoices as the system keyboard, type
Verify the system keyboard functions

keymanapp-test-bot · 2023-03-29T08:02:58Z

User Test Results

Test specification and instructions

✅ TEST_KEYMAN (PASSED): Tested with the attached PR build (17.0.80-alpha-test-8543) in Android 12 / API 31 emulator and here is my observation : 1. Verified that the Keyman In-App functions are working fine. Also, verified that after changing the keyman as the system keyboard, I was able to type in the text field without having any issues. Seems to be working as expected. (notes)
✅ TEST_FV (PASSED): Tested with the attached PR build (17.0.80-alpha-test-8543) in Android 12 / API 31 emulator and here is my observation : 1. Set the FirstVoices as system keyboard. 2. Opened Chrome browser. I was able to type in the text field with FirstVoices keyboard without having any problem. Seems to be working as expected. (notes)

Test Artifacts

Android
Developer
iOS
- Keyman for iOS (simulator image)
- FirstVoices Keyboards for iOS (simulator image)
- TestFlight internal PR build version - 17.0.80 (0.8543.8244)
Keyboards
- Test Keyboards
Linux
- Keyman for Linux
- Keyman for Linux
macOS
- Keyman for macOS
Web
- KeymanWeb Test Home
Windows
- Keyman for Windows
- FirstVoices Keyboards for Windows

bharanidharanj · 2023-03-29T12:25:03Z

Test Results

TEST_KEYMAN (PASSED): Tested with the attached PR build (17.0.80-alpha-test-8543) in Android 12 / API 31 emulator and here is my observation : 1. Verified that the Keyman In-App functions are working fine. Also, verified that after changing the keyman as the system keyboard, I was able to type in the text field without having any issues. Seems to be working as expected.

bharanidharanj · 2023-03-29T12:30:33Z

Test Results

TEST_FV (PASSED): Tested with the attached PR build (17.0.80-alpha-test-8543) in Android 12 / API 31 emulator and here is my observation : 1. Set the FirstVoices as system keyboard. 2. Opened Chrome browser. I was able to type in the text field with FirstVoices keyboard without having any problem. Seems to be working as expected.

android/build.sh

jahorton · 2023-03-30T12:19:03Z

For CI compatibility, the build.sh will override JAVA_HOME for to JAVA_HOME_11 and then revert to JAVA_HOME_8 when the build is finished.

I assume this is in order to continue maintenance of Keyman for Android 16.0? Any other reasons of note or causes to be aware of before we fully convert over at some point in the future?

jahorton · 2023-03-30T12:20:47Z

android/KMEA/app/src/test/resources/com/tavultesoft/kmea/robolectric.properties

TODO: update the comment (since we can use something newer now - yay!)

Done. Also bumped sdk higher to 33.

android/KMEA/build.gradle

jahorton · 2023-03-30T12:24:17Z

android/build.sh

@@ -37,6 +37,10 @@ builder_describe \

 builder_parse "$@"

+# Override JAVA_HOME to OpenJDK 11
+builder_heading "Setting JAVA_HOME to OpenJDK 11"
+export JAVA_HOME=${JAVA_HOME_11}


So, a problem here:

If the build fails, I doubt that JAVA_HOME will be restored properly given the current implementation of this build script.

To be extra-explicit, this is the requested change.

It may be wise to extend the existing builder trap (because only one may be set...) and add functionality there to ensure that JAVA_HOME is fixed before re-throwing an exit-triggering exit code.

For the in-repo reference, refer to _builder_failure_trap via CTRL-F. It'd probably be best to simply write your own trap and have it call this one, and then replace this one with your version.

JAVA_HOME doesn't need to be reset -- you don't modify the environment for the caller of the script with export, only with child processes. (You can only modify 'parent' environment with sourced scripts -- which run in the same process not a child process.)

Ah, good to hear. I inferred that it did based on the implementation I reviewed, but didn't investigate it with any serious depth. Glad to hear it's not actually going to be an issue.

darcywong00 · 2023-03-30T12:59:44Z

I assume this is in order to continue maintenance of Keyman for Android 16.0?

Right - 16.0 is still building with JDK 8.

mcdurdin

This is good but I think we should tweak the JAVA_HOME_11 usage a bit.

mcdurdin · 2023-03-30T22:14:41Z

android/KMAPro/build.sh

@@ -81,7 +81,7 @@ fi
 if builder_start_action configure; then

  # Copy Keyman Engine for Android
-  cp "$KEYMAN_ROOT/android/KMEA/app/build/outputs/aar/${CONFIG}/keyman-engine.aar" "$KEYMAN_ROOT/android/KMAPro/kMAPro/libs/keyman-engine.aar"
+  cp "$KEYMAN_ROOT/android/KMEA/app/build/outputs/aar/keyman-engine-${CONFIG}.aar" "$KEYMAN_ROOT/android/KMAPro/kMAPro/libs/keyman-engine.aar"


Per earlier discussions (#8542), this should be done in build action.

mcdurdin · 2023-03-30T22:18:11Z

android/build-publish.sh

+if [ -f .build-builder ]; then
+  builder_heading "Setting JAVA_HOME to OpenJDK 11"
+  export JAVA_HOME=${JAVA_HOME_11}
+fi


Can we move this to a function in build-utils.sh?

android/build-publish.sh

android/build.sh

docs/build/windows.md

mcdurdin · 2023-03-30T22:33:55Z

docs/build/windows.md

@@ -341,6 +346,17 @@ To include UserDefines.mak in the build, use the command line parameter
 `-DUSERDEFINES`. You can also set an environment variable `USERDEFINES=1` to get
 the same result.

+### JAVA_HOME


I wonder if this whole section should be in a non-platform-specific doc?

jahorton

Per @mcdurdin's remarks about build-script environment variable handling, my concerns re JAVA_HOME are satisfied now.

Co-authored-by: Marc Durdin <[email protected]>

mcdurdin

LGTM.

keyman-server · 2023-04-10T18:01:57Z

Changes in this pull request will be available for download in Keyman version 17.0.84-alpha

darcywong00 added 6 commits March 29, 2023 09:46

chore(android/engine): Update to Java 11

c11352b

chore(android): Update gradle-wrapper to 7.5.1

9948407

chore(android): Update Android projects for Java 11

ff6d5db

chore(android): Update setup documentation

85a9f90

refactor(android): Use JAVA_HOME_ vars to set Java version

0ebbe77

fix(oem/fv/android): Use Java 11

3d1e2da

darcywong00 requested review from sgschantz, mcdurdin and jahorton as code owners March 29, 2023 08:02

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Mar 29, 2023

github-actions bot added android/ android/app/ android/engine/ android/samples/ docs oem/ oem/fv/ oem/fv/android/ chore labels Mar 29, 2023

darcywong00 added this to the A17S10 milestone Mar 29, 2023

darcywong00 marked this pull request as draft March 29, 2023 08:24

darcywong00 marked this pull request as ready for review March 29, 2023 11:11

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 29, 2023

darcywong00 added 3 commits March 30, 2023 07:11

fix(android): Update build-publish to override JAVA_HOME

98351ad

docs(common): Update dev notes for JAVA_HOME

a83e3b5

docs(common): Add syntax

8db1ccd

fix(android/app): Update triplet.play version

ea17790

darcywong00 commented Mar 30, 2023

View reviewed changes

android/build.sh Outdated Show resolved Hide resolved

jahorton requested changes Mar 30, 2023

View reviewed changes

mcdurdin requested changes Mar 30, 2023

View reviewed changes

jahorton approved these changes Mar 31, 2023

View reviewed changes

darcywong00 and others added 3 commits March 31, 2023 12:56

Apply suggestions from code review

aeab288

Co-authored-by: Marc Durdin <[email protected]>

fix(android): Move set_java_home to build-utils

c7e6540

fix(android): Move cp from configure to build actions

cd2d2b7

github-actions bot added common/ common/resources/ Build infrastructure labels Mar 31, 2023

chore(android/engine): Update comment and SDK version in test

1d65114

darcywong00 requested a review from mcdurdin April 8, 2023 02:58

mcdurdin approved these changes Apr 10, 2023

View reviewed changes

darcywong00 merged commit d2cacd5 into master Apr 10, 2023

darcywong00 deleted the chore/android/java-11 branch April 10, 2023 02:20

jahorton mentioned this pull request Apr 12, 2023

chore: Updates feature-esmodule-web-engine via merge with A17S10 master 🧩 #8585

Merged

darcywong00 mentioned this pull request Apr 26, 2023

chore(android): Update QRGen version for Java 11 #8673

Merged

darcywong00 mentioned this pull request Sep 19, 2023

chore(oem/fv/android): Update Gradle to 7.4 #9590

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(android): Update projects to use Java 11 #8543

chore(android): Update projects to use Java 11 #8543

darcywong00 commented Mar 29, 2023 •

edited

Loading

keymanapp-test-bot bot commented Mar 29, 2023 •

edited

Loading

bharanidharanj commented Mar 29, 2023

bharanidharanj commented Mar 29, 2023

jahorton commented Mar 30, 2023

jahorton Mar 30, 2023

darcywong00 Mar 31, 2023

jahorton Mar 30, 2023 •

edited

Loading

mcdurdin Mar 30, 2023

jahorton Mar 31, 2023

darcywong00 commented Mar 30, 2023

mcdurdin left a comment

mcdurdin Mar 30, 2023

mcdurdin Mar 30, 2023

mcdurdin Mar 30, 2023

jahorton left a comment

mcdurdin left a comment •

edited

Loading

keyman-server commented Apr 10, 2023

chore(android): Update projects to use Java 11 #8543

chore(android): Update projects to use Java 11 #8543

Conversation

darcywong00 commented Mar 29, 2023 • edited Loading

User Testing

keymanapp-test-bot bot commented Mar 29, 2023 • edited Loading

User Test Results

Test Artifacts

bharanidharanj commented Mar 29, 2023

Test Results

bharanidharanj commented Mar 29, 2023

Test Results

jahorton commented Mar 30, 2023

jahorton Mar 30, 2023

Choose a reason for hiding this comment

darcywong00 Mar 31, 2023

Choose a reason for hiding this comment

jahorton Mar 30, 2023 • edited Loading

Choose a reason for hiding this comment

mcdurdin Mar 30, 2023

Choose a reason for hiding this comment

jahorton Mar 31, 2023

Choose a reason for hiding this comment

darcywong00 commented Mar 30, 2023

mcdurdin left a comment

Choose a reason for hiding this comment

mcdurdin Mar 30, 2023

Choose a reason for hiding this comment

mcdurdin Mar 30, 2023

Choose a reason for hiding this comment

mcdurdin Mar 30, 2023

Choose a reason for hiding this comment

jahorton left a comment

Choose a reason for hiding this comment

mcdurdin left a comment • edited Loading

Choose a reason for hiding this comment

keyman-server commented Apr 10, 2023

darcywong00 commented Mar 29, 2023 •

edited

Loading

keymanapp-test-bot bot commented Mar 29, 2023 •

edited

Loading

jahorton Mar 30, 2023 •

edited

Loading

mcdurdin left a comment •

edited

Loading