feat(developer): LDML Keyboard Test Window 🌱

[mcdurdin]

Fixes #10420.

Implements a basic LDML keyboard test window. Press F5 or Keyboard/Test to start test. Shows a character grid for each character in the text.

Does not yet support display of markers (#10458). Does not support interactive debugging, nor any more detailed status information.

User Testing

• TEST_DEBUGGER: Create a new LDML Keyboard Project. Open the keyboard and press F5 to start testing. Verify that pressing a generates Hello World! and that basic text editing functions work as expected. Press Shift+F5 or the stop button in the debug toolbar to stop testing.

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ TEST_DEBUGGER (PASSED): Retested with the updated PR build (Keyman Developer 17.0.248-alpha-test-10459) on Windows 11 OS (VM) and here is my observation: 1. Created an LDML keyboard project. 2. Opened the project. 3. Clicked Keyboard / Test Keyboard option from the Keyboard menu. Verified that the project doesn't throw any error messages. 4. Pressing 'a' key shows 'Hello World!' on the pane. Seems to be working fine. Thanks. (notes)

Test Artifacts

• Developer
  • Keyman Developer
  • Compiler Regression Tests
  • kmcomp.zip
• Keyboards
  • Test Keyboards

[bharanidharanj]

Test Results

• TEST_DEBUGGER (FAILED): Tested with the attached PR build (Keyman Developer 17.0.247-alpha-test-10459) on Windows 11 OS (VM) and here is my observation: 1. Created an LDML project. 2. Created a keyboard. 3. Compiled it. 4. Pressed F5 to start the Debugger. In the Debugger mode, pressed 'a' key and I noticed that there was no output "Hello World!" appearing on the pane.

  

[mcdurdin]

Hi @bharanidharanj, that's a Keyman keyboard project, not an LDML keyboard project. To create an LDML keyboard project, you need to select Project / New Project / LDML Keyboard. Can you retest please? Thanks!

@keymanapp-test-bot retest all

[bharanidharanj]

Test Results

• TEST_DEBUGGER (FAILED): 1. Created an LDML keyboard project by Clicking Project / New Project / LDML keyboard options. 2. Opened the Keyboard window. 3. Pressing F5 to open the Debugger window. 4. Noticed that pressing the letter 'a' did not output the "Hello World!" text. Seems to be an issue. Or did I miss out on any steps?

  

[bharanidharanj]

@mcdurdin I noticed that there was an error message that appeared in 'Node' widow which is running behind the Keyman Developer application.

[mcdurdin]

@bharanidharanj (I think the node error is unrelated)

Can you follow the steps in the video to run your test keyboard (note, once you have selected Test Keyboard, then you'll need to press a as per the instructions above; my example does not have that final step)

new-ldml-keyboard.mp4

[bharanidharanj]

@mcdurdin Followed the steps as mentioned in the video and I got an error message after clicking the 'Test Keyboard' option.

[srl295]

@mcdurdin Followed the steps as mentioned in the video and I got an error message after clicking the 'Test Keyboard' option.

sounds like some kind of install issue. I'll dig into it a bit more.

I also noticed a minor typo in the error message you got, filed #10484 to fix.

[mcdurdin]

sounds like some kind of install issue. I'll dig into it a bit more.

The issue is the techpreview files are not included in the Keyman Developer msi. I am looking at how best to solve.

[srl295]

@mcdurdin should there be some kind of sanity checking at start-up? to make sure the schemas and data all arrived ok?

[mcdurdin]

@mcdurdin should there be some kind of sanity checking at start-up? to make sure the schemas and data all arrived ok?

Doesn't really help us. It would still fail so the user is still stuck. Need to have the files present in the installer, see #10485 and a cascade of following issues.

[mcdurdin]

Note: schemas are bundled in the .mjs but imports are not.

[mcdurdin]

Fix is blocked until #10489, #10492 are merged into this branch, will merge those up to the epic once they pass and then update this branch; will then retest.

[mcdurdin]

@bharanidharanj the underlying issues have now been addressed, hopefully! Please retest 😁
@keymanapp-test-bot retest

[rc-swag]

Seeing all the if ActiveLdmlKeyboardEditor else if ActiveLdmlKeyboardEditor feels like some aggregation or maybe even inheritance could have been used for a ActiveKeyboardEditor. Otherwise
LGTM

[mcdurdin]

Seeing all the if ActiveLdmlKeyboardEditor else if ActiveLdmlKeyboardEditor feels like some aggregation or maybe even inheritance could have been used for a ActiveKeyboardEditor

Agree. Certainly would be a nice refactor. For now, given the code is deprecated before it even lands, leaving it as is. The ActiveLdmlKeyboardEditor is likely to be completely rewritten in 18.0 as a web component.

[bharanidharanj]

Test Results

• TEST_DEBUGGER (PASSED): Retested with the updated PR build (Keyman Developer 17.0.248-alpha-test-10459) on Windows 11 OS (VM) and here is my observation: 1. Created an LDML keyboard project. 2. Opened the project. 3. Clicked Keyboard / Test Keyboard option from the Keyboard menu. Verified that the project doesn't throw any error messages. 4. Pressing 'a' key shows 'Hello World!' on the pane. Seems to be working fine. Thanks.