chore(web,developer): Move keymanweb-osk.ttf to common/resources #9993

darcywong00 · 2023-11-13T13:52:40Z

Follow-on to #9846

Since Developer and Web use the same keymanweb-osk.ttf resource, this PR moves it to /common/resources/fonts
and updates the configure step accordingly.

(edit to add @jahorton tests)

User Testing

TEST_WEB_OSK: Using the "Test unminified KeymanWeb" test page, verify that all OSK keys still show up properly.

Load the page.
Click in a text area so that the OSK becomes visible.
Inspect all keys. If any has text beginning with and ending with **, FAIL this test.
Such keys would normally have special OSK symbols on them.

TEST_DEVELOPER_WEB_OSK: Using the Developer test-host page for testing Web keyboards, verify that all OSK keys still show up properly. (updated for future reference not to use sil_euro_atlin)

Load the keyboard project from the keyboards repo: release/basic/basic_kbdus.
Build the keyboard.
Test the keyboard using Web, starting the test server and using one of Developer's links to start the test page.
Click in a text area so that the OSK becomes visible.
Inspect all keys. If any has text beginning with and ending with **, FAIL this test.
Such keys would normally have special OSK symbols on them.

TEST_ANDROID_OSK - Verifies special characters render on the OSK keycaps and longpress keys
Setup - Install the PR build of KeyboardHarness on an Android device/emulator (newer than Android 5.0)

Launch the KeyboardHarness app
Use the Globe key to select "test9469" keyboard. (There's several test keyboards to cycle through
Verify the keycaps on the default layer display and match the screenshot below (updated with ZWNJGeneric on the right of left-shift)

keymanapp-test-bot · 2023-11-13T13:52:44Z

User Test Results

Test specification and instructions

✅ TEST_WEB_OSK (PASSED): I tested the 'Test unminified KeymanWeb' page in Chrome, and here are my observations: 1. Inspected all the keys on the On-Screen Keyboard and verified that none of them display text begins with or ends with **. (notes)
✅ TEST_DEVELOPER_WEB_OSK (PASSED): Tested with the attached Keyman Developer 17.0.209-alpha-test-9993 and here are my observations: 1. Opened sil_euro_latin Keyboard project in Keyman Developer. 2. Compiled the keyboard. 3. Open it in the local host browser. 4. Inspected all the keys on the On-Screen Keyboard and verified that no display text begins with or ends with **. (notes)
✅ TEST_ANDROID_OSK (PASSED): Installed the PR build of Keyboardharness on an Android device (Samsung Galaxy A23 5g - Android 13) and here is my observation: 1. Opened the KeyboardHarness app. 2 Switched to "test9469" Keyboard using globe key. 3. Verified that the keycaps on the default layer is displayed and matched with the given screenshot. (notes)

Test Artifacts

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

mcdurdin · 2023-11-13T22:14:30Z

web/src/engine/osk/build.sh

@@ -36,7 +36,12 @@ builder_parse "$@"

 #### Build action definitions ####

-builder_run_action configure verify_npm_setup
+if builder_start_action configure; then


builder_describe_outputs (line 32) needs configure to point to the font, because /node_modules is already present, so this step is skipped.

jahorton

This needs user tests. I'm requesting changes on the basis of the test-bot skip command. (There's a noticeable chance for breakage in how the font resource gets included in the build and/or linked for use on the test pages.)

TEST_WEB_OSK: Using the "Test unminified KeymanWeb" test page, verify that all OSK keys still show up properly.

Load the page.
Click in a text area so that the OSK becomes visible.
Inspect all keys. If any has text beginning with and ending with **, FAIL this test.
- Such keys would normally have special OSK symbols on them.

TEST_DEVELOPER_WEB_OSK: Using the Developer test-host page for testing Web keyboards, verify that all OSK keys still show up properly.

Load a keyboard project. (Say, release/sil/sil_euro_latin from the keymanapp/keyboards repo.
Build the keyboard.
Test the keyboard using Web, starting the test server and using one of Developer's links to start the test page.
Click in a text area so that the OSK becomes visible.
Inspect all keys. If any has text beginning with and ending with **, FAIL this test.
- Such keys would normally have special OSK symbols on them.

A similar test for one of the mobile apps (Android, iOS) may also be wise. And feel free to change the directions for the two tests I did spec above to be clearer and/or more specific about the steps if needed.

jahorton · 2023-11-14T01:35:56Z

web/src/engine/osk/build.sh

@@ -30,13 +30,19 @@ builder_describe "Builds the Keyman Engine for Web's On-Screen Keyboard package

 builder_describe_outputs \
  configure   /node_modules \
+  configure   /web/src/resources/osk/keymanweb-osk.ttf \


Wait... can the builder-script setup actually support two separate lines for the same action:target without losing one of them? If so... wish I'd known that; there's a lot of Web scripts that could use multiple output-checks.

I'm hoping that syntax works. builder.inc failed when I originally had

configure /node_modules \ /web/src/resources/osk/keymanweb-osk.ttf \ build ...

No, currently it's only one output per target. Anything more is a future builder feature.

Requested user tests have now been spec'd.

web/src/engine/osk/build.sh

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

mcdurdin

Sorry to say that the Developer build scripts are still Makefile-based, so we'll have to refactor that 😭

android/KMEA/build.sh

developer/build.sh

mcdurdin

looks good to me

bharanidharanj · 2023-11-15T09:23:12Z

Test Results

TEST_WEB_OSK (PASSED): I tested the 'Test unminified KeymanWeb' page in Chrome, and here are my observations: 1. Inspected all the keys on the On-Screen Keyboard and verified that none of them display text begins with or ends with **.

bharanidharanj · 2023-11-15T10:15:25Z

Test Results

TEST_DEVELOPER_WEB_OSK (PASSED): Tested with the attached Keyman Developer 17.0.209-alpha-test-9993 and here are my observations: 1. Opened sil_euro_latin Keyboard project in Keyman Developer. 2. Compiled the keyboard. 3. Open it in the local host browser. 4. Inspected all the keys on the On-Screen Keyboard and verified that no display text begins with or ends with **.

bharanidharanj · 2023-11-15T10:34:33Z

Test Results

TEST_ANDROID_OSK (PASSED): Installed the PR build of Keyboardharness on an Android device (Samsung Galaxy A23 5g - Android 13) and here is my observation: 1. Opened the KeyboardHarness app. 2 Switched to "test9469" Keyboard using globe key. 3. Verified that the keycaps on the default layer is displayed and matched with the given screenshot.

keyman-server · 2023-11-15T18:02:06Z

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

mcdurdin · 2023-11-16T00:13:40Z

TEST_DEVELOPER_WEB_OSK: Using the Developer test-host page for testing Web keyboards, verify that all OSK keys still show up properly.

Load a keyboard project. (Say, release/sil/sil_euro_latin from the keymanapp/keyboards repo.

Unfortunately sil_euro_latin doesn't use the standard OSK and none of the special characters would be visible, so this test result is invalid.

darcywong00 added 3 commits November 13, 2023 15:44

chore(common): Move keymanweb-osk.ttf to common/

6ff0cd2

chore(developer): Add configure step to copy font

799a845

chore(web): Add configure step to copy font

f372936

darcywong00 requested review from jahorton, mcdurdin and rc-swag as code owners November 13, 2023 13:52

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

github-actions bot added web/ developer/ common/ chore labels Nov 13, 2023

mcdurdin requested changes Nov 13, 2023

View reviewed changes

darcywong00 added 2 commits November 14, 2023 06:24

fix(web): Update configure outputs

50e37ce

fix(android): Update keymanweb-osk.ttf

4b3d359

darcywong00 requested a review from sgschantz as a code owner November 13, 2023 23:25

github-actions bot added android/ android/engine/ labels Nov 13, 2023

fix(web): configure output

f1a17b5

jahorton previously requested changes Nov 14, 2023

View reviewed changes

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

fix(developer): Add configure output for font

2f9bb5b

jahorton reviewed Nov 14, 2023

View reviewed changes

mcdurdin reviewed Nov 14, 2023

View reviewed changes

web/src/engine/osk/build.sh Outdated Show resolved Hide resolved

Update web/src/engine/osk/build.sh

c6a9460

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

mcdurdin requested changes Nov 14, 2023

View reviewed changes

android/KMEA/build.sh Outdated Show resolved Hide resolved

developer/build.sh Show resolved Hide resolved

darcywong00 added 2 commits November 15, 2023 06:30

chore(android/engine): Revert build.sh

dfb5cbf

fix(developer): Update Makefile to copy keymanweb-osk.ttf

71ea3c3

darcywong00 requested a review from ermshiperete as a code owner November 14, 2023 23:41

github-actions bot added developer/ide/ android/ android/engine/ and removed android/ android/engine/ labels Nov 14, 2023

fix(developer): Attempt 2 to copy font

9af4ce3

github-actions bot added android/ android/engine/ and removed android/ android/engine/ labels Nov 15, 2023

mcdurdin approved these changes Nov 15, 2023

View reviewed changes

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

darcywong00 merged commit 284ec09 into master Nov 15, 2023
2 checks passed

darcywong00 deleted the chore/common/keymanweb-osk-ttf branch November 15, 2023 12:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(web,developer): Move keymanweb-osk.ttf to common/resources #9993

chore(web,developer): Move keymanweb-osk.ttf to common/resources #9993

darcywong00 commented Nov 13, 2023 •

edited

Loading

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

edited

Loading

mcdurdin Nov 13, 2023

jahorton left a comment •

edited

Loading

jahorton Nov 14, 2023

darcywong00 Nov 14, 2023

mcdurdin Nov 14, 2023 •

edited

Loading

mcdurdin left a comment

mcdurdin left a comment

bharanidharanj commented Nov 15, 2023

bharanidharanj commented Nov 15, 2023

bharanidharanj commented Nov 15, 2023

keyman-server commented Nov 15, 2023

mcdurdin commented Nov 16, 2023

chore(web,developer): Move keymanweb-osk.ttf to common/resources #9993

chore(web,developer): Move keymanweb-osk.ttf to common/resources #9993

Conversation

darcywong00 commented Nov 13, 2023 • edited Loading

User Testing

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

User Test Results

Test Artifacts

mcdurdin Nov 13, 2023

Choose a reason for hiding this comment

jahorton left a comment • edited Loading

Choose a reason for hiding this comment

jahorton Nov 14, 2023

Choose a reason for hiding this comment

darcywong00 Nov 14, 2023

Choose a reason for hiding this comment

mcdurdin Nov 14, 2023 • edited Loading

Choose a reason for hiding this comment

mcdurdin left a comment

Choose a reason for hiding this comment

mcdurdin left a comment

Choose a reason for hiding this comment

bharanidharanj commented Nov 15, 2023

Test Results

bharanidharanj commented Nov 15, 2023

Test Results

bharanidharanj commented Nov 15, 2023

Test Results

keyman-server commented Nov 15, 2023

mcdurdin commented Nov 16, 2023

darcywong00 commented Nov 13, 2023 •

edited

Loading

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

edited

Loading

jahorton left a comment •

edited

Loading

mcdurdin Nov 14, 2023 •

edited

Loading