fix(android): no suggestions available when swapping pred-text target language ✨ #10061

jahorton · 2023-11-23T03:19:59Z

Addresses the issue documented here: #10017 (comment)

The net effect of that issue is that suggestions would appear to be disabled upon swapping to a language with an different 'dictionary' from the most recently-used one.

The full documentation of the underlying cause can be found in that linked comment, but the essence of it is that the banner can't display any suggestions because it's constantly being deactivated and reactivated. This is also generally considered "not good" for performance and device batteries.

User Testing

TEST_PICKER_SELECTION_ANDROID: Ensure suggestions are properly displayed after swapping keyboards with different language models.

Install the Android Keyman app test build from this PR.
Open Keyman App.
Install Khmer Angkor and Tamil Keyboards using Settings / Install Keyboard or Dictionary / Install from keyman.com option.
- The break & bug - occurs when swapping models.
Verify all the Keyboards are installed under Installed languages menu.
Return to main page.
Verify that the default keyboard English -EuroLatin(SIL) is displayed on the page.
Short-press the globe key and observe the keyboard change. There should be minimal adjustment while the keyboard loads.
Now, long press the globe key, Click Khmer or Tamil Keyboard and observe the keyboard change. It should change as smoothly as it did after the globe-key short-press (step 7).
- If suggestions for the suggestion banner do not appear after a second, type a single key. If no suggestions appear even then, FAIL the test.

TEST_PICKER_SELECTION_IOS: Ensure suggestions are properly displayed after swapping keyboards with different language models.

Install the iOS Keyman app test build from this PR.
Open Keyman App.
Install Khmer Angkor and Tamil Keyboards using Settings / Install Keyboard or Dictionary / Install from keyman.com option.
- The break & bug - occurs when swapping models.
Verify all the Keyboards are installed under Installed languages menu.
Return to main page.
Verify that the default keyboard English -EuroLatin(SIL) is displayed on the page.
Short-press the globe key and observe the keyboard change. There should be minimal adjustment while the keyboard loads.
Now, long press the globe key, Click Khmer or Tamil Keyboard and observe the keyboard change. It should change as smoothly as it did after the globe-key short-press (step 7).
- If suggestions for the suggestion banner do not appear after a second, type a single key. If no suggestions appear even then, FAIL the test.

keymanapp-test-bot · 2023-11-23T03:20:13Z

User Test Results

Test specification and instructions

✅ TEST_PICKER_SELECTION_ANDROID (PASSED): Retested with the attached PR build keyman 17.0.216-alpha-test-10061 in Android 12 (API 31) emulator and here is my observation: 1. Intsalled Khmer Angkor keyboard followed by Tamil Keyboard using Settings / Install Keyboard or Dictionary /Install from keyman.com option. 2. Verified all the keyboards are installed under the Installed languages menu. Returned to the main page. Noticed that Tamil keyboard is displayed on the page. 3. Short-pressed the globe key and observed the keyboard changed immediately. 4. Long pressed the globe key. Clicked the Khmer Angkor (or Tamil keyboard) keyboard and observed that there was no flickering on the suggestion bar. Also, the Predictive text for Khmer Angkor or EuroLatin (SIL) appears correctly on the Suggestion banner. Seems to be working fine.
✅ TEST_PICKER_SELECTION_IOS (PASSED): Retested in iOS 16.6 - iPhone 13 mobile device and here is my observation: 1. Installed the attached TestFlight internal PR build and noticed that it is showing keyman 17.0.215 version instead of showing keyman 17.0.216 version. However, I tried to test with this build. 2. Installed Khmer Angkor keyboard followed by Tamil Keyboard using Settings / Installed Languages menu. 2. Verified all the keyboards are installed under the Installed languages menu. Returned to the main page. Noticed that the Tamil keyboard is displayed on the page. 3. Noticed that the short-press or long-press the globe key only opens the 'Keyboards' menu. 4. Selecting the Khmer Angkor or EuroLatin(SIL) keyboard shows up the Predictive text on the suggestion banner. (notes)

Test Artifacts

Android
Developer
iOS
- Keyman for iOS (simulator image)
- FirstVoices Keyboards for iOS (simulator image)
- TestFlight internal PR build version - 17.0.216 (0.10061.9828)
Keyboards
- Test Keyboards
Web
- KeymanWeb Test Home
Windows

mcdurdin

I guess we've removed the isModelActive flag because the banner is always intended to be visible?

I don't really understand how change to languageProcessor.ts addresses the issue. Can you elaborate?

One change requested -- further cleanup with the removal of change parameter 😁

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboardWebViewClient.java

common/web/input-processor/src/text/prediction/languageProcessor.ts

mcdurdin · 2023-11-23T04:35:09Z

android/KMEA/app/src/main/assets/android-host.js

-  if(change != 'configured') { // doesn't change the display; only initiates suggestions.
-    window.location.hash = 'refreshBannerHeight-'+fragmentToggle+'+change='+change;
-  }


So 'configured' will also trigger a refreshBannerHeight now, is that okay?

Oh, I guess I did misread it slightly. Thought that it only affected the value of change sent in the message for some reason.

Should be fine anyway, but... 🤷

bharanidharanj · 2023-11-23T07:47:40Z

Test Results

TEST_PICKER_SELECTION_ANDROID (PASSED): Retested with the attached PR build keyman 17.0.216-alpha-test-10061 in Android 12 (API 31) emulator and here is my observation: 1. Intsalled Khmer Angkor keyboard followed by Tamil Keyboard using Settings / Install Keyboard or Dictionary /Install from keyman.com option. 2. Verified all the keyboards are installed under the Installed languages menu. Returned to the main page. Noticed that Tamil keyboard is displayed on the page. 3. Short-pressed the globe key and observed the keyboard changed immediately. 4. Long pressed the globe key. Clicked the Khmer Angkor (or Tamil keyboard) keyboard and observed that there was no flickering on the suggestion bar. Also, the Predictive text for Khmer Angkor or EuroLatin (SIL) appears correctly on the Suggestion banner. Seems to be working fine.

bharanidharanj · 2023-11-23T08:33:48Z

Test Results

TEST_PICKER_SELECTION_IOS (PASSED): Retested in iOS 16.6 - iPhone 13 mobile device and here is my observation: 1. Installed the attached TestFlight internal PR build and noticed that it is showing keyman 17.0.215 version instead of showing keyman 17.0.216 version. However, I tried to test with this build. 2. Installed Khmer Angkor keyboard followed by Tamil Keyboard using Settings / Installed Languages menu. 2. Verified all the keyboards are installed under the Installed languages menu. Returned to the main page. Noticed that the Tamil keyboard is displayed on the page. 3. Noticed that the short-press or long-press the globe key only opens the 'Keyboards' menu. 4. Selecting the Khmer Angkor or EuroLatin(SIL) keyboard shows up the Predictive text on the suggestion banner.

keyman-server · 2023-12-01T18:02:49Z

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

fix(android): banner event loop on model change

7754427

jahorton requested review from mcdurdin, darcywong00 and sgschantz as code owners November 23, 2023 03:20

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

github-actions bot added android/ common/ android/engine/ common/web/ fix and removed user-test-required User tests have not been completed labels Nov 23, 2023

keymanapp-test-bot bot added this to the A17S26 milestone Nov 23, 2023

keymanapp-test-bot bot added the user-test-required User tests have not been completed label Nov 23, 2023

jahorton mentioned this pull request Nov 23, 2023

change(android): flishy flashy mitigation, round 1 ✨ #10017

Merged

jahorton changed the title ~~fix(android): no suggestions available when swapping pred-text target language~~ fix(android): no suggestions available when swapping pred-text target language ✨ Nov 23, 2023

mcdurdin requested changes Nov 23, 2023

View reviewed changes

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboardWebViewClient.java Show resolved Hide resolved

jahorton commented Nov 23, 2023

View reviewed changes

common/web/input-processor/src/text/prediction/languageProcessor.ts Show resolved Hide resolved

change(android): drops the 'change=' fragment

a2c30b9

mcdurdin reviewed Nov 23, 2023

View reviewed changes

mcdurdin approved these changes Nov 23, 2023

View reviewed changes

chore(android): restores removed conditional

ad0ed37

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

jahorton mentioned this pull request Nov 24, 2023

chore(ios): test build artifact did not show correct version string in-app #10078

Closed

darcywong00 modified the milestones: A17S26, A17S27 Nov 27, 2023

Base automatically changed from change/android/flishy-flashy-mitigation to master December 1, 2023 02:12

jahorton merged commit 8e272d8 into master Dec 1, 2023
2 checks passed

jahorton deleted the fix/android/banner-event-loop branch December 1, 2023 02:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(android): no suggestions available when swapping pred-text target language ✨ #10061

fix(android): no suggestions available when swapping pred-text target language ✨ #10061

jahorton commented Nov 23, 2023 •

edited

Loading

keymanapp-test-bot bot commented Nov 23, 2023 •

edited

Loading

mcdurdin left a comment

mcdurdin Nov 23, 2023

jahorton Nov 23, 2023 •

edited

Loading

bharanidharanj commented Nov 23, 2023

bharanidharanj commented Nov 23, 2023

keyman-server commented Dec 1, 2023

fix(android): no suggestions available when swapping pred-text target language ✨ #10061

fix(android): no suggestions available when swapping pred-text target language ✨ #10061

Conversation

jahorton commented Nov 23, 2023 • edited Loading

User Testing

keymanapp-test-bot bot commented Nov 23, 2023 • edited Loading

User Test Results

Test Artifacts

mcdurdin left a comment

Choose a reason for hiding this comment

mcdurdin Nov 23, 2023

Choose a reason for hiding this comment

jahorton Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

bharanidharanj commented Nov 23, 2023

Test Results

bharanidharanj commented Nov 23, 2023

Test Results

keyman-server commented Dec 1, 2023

jahorton commented Nov 23, 2023 •

edited

Loading

keymanapp-test-bot bot commented Nov 23, 2023 •

edited

Loading

jahorton Nov 23, 2023 •

edited

Loading