fix(developer): make kmc log options consistent across all commands #13075

mcdurdin · 2025-01-30T02:25:48Z

Makes the --log-format, --log-level, and --color/--no-color options available for all commands and DRYs out some of the options processing for consistency. This has positive impact in particular on the Generator classes which removes the need for several unit tests as the interface can now be checked at compile time.

Fixes: #13072
Fixes: #13110
Unblocks: #13073

User Testing

We need to test that the logging options work consistently for all commands in kmc. Run tests for each of the commands below:

GROUP_ANALYZE_OSK_CHAR_USE: kmc analyze osk-char-use
GROUP_ANALYZE_REWRITE_FROM_OSK_CHAR_USE: kmc analyze osk-rewrite-from-char-use
GROUP_BUILD_FILE: kmc build file
GROUP_BUILD_LDML_TEST_DATA: kmc build ldml-test-data
GROUP_BUILD_WINDOWS_PACKAGE_INSTALLER: kmc build windows-package-installer
GROUP_MESSAGE: kmc message
GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard
GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard
GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model
GROUP_COPY: kmc copy
TEST_LOG_LEVEL_SILENT: run the command with --log-level silent and verify that all messages are hidden
TEST_LOG_FORMAT_TSV: run the command with --log-format tsv and verify that all messages are printed in a tabular format
TEST_COLOR: run the command with --no-color --log-level verbose and verify that all printed messages have no color applied

Makes the `--log-format`, `--log-level`, and `--color`/`--no-color` options available for all commands and DRYs out some of the options processing for consistency. This has positive impact in particular on the Generator classes which removes the need for several unit tests as the interface can now be checked at compile time. Fixes: #13072 Unblocks: #13073

keymanapp-test-bot · 2025-01-30T02:26:20Z

User Test Results

Test specification and instructions

✅ GROUP_ANALYZE_OSK_CHAR_USE: kmc analyze osk-char-use
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED) (notes)
- ✅ TEST_LOG_FORMAT_TSV (PASSED) (notes)
- ✅ TEST_COLOR (PASSED) (notes)
✅ GROUP_ANALYZE_REWRITE_FROM_OSK_CHAR_USE: kmc analyze osk-rewrite-from-char-use
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED) (notes)
- ✅ TEST_LOG_FORMAT_TSV (PASSED) (notes)
- ✅ TEST_COLOR (PASSED) (notes)
✅ GROUP_BUILD_FILE: kmc build file
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED) (notes)
- ✅ TEST_LOG_FORMAT_TSV (PASSED) (notes)
- ✅ TEST_COLOR (PASSED) (notes)
🟩 GROUP_BUILD_LDML_TEST_DATA: kmc build ldml-test-data
- 🟩 TEST_LOG_LEVEL_SILENT (SKIPPED)
- 🟩 TEST_LOG_FORMAT_TSV (SKIPPED)
- 🟩 TEST_COLOR (SKIPPED)
🟩 GROUP_BUILD_WINDOWS_PACKAGE_INSTALLER: kmc build windows-package-installer
- 🟩 TEST_LOG_LEVEL_SILENT (SKIPPED)
- 🟩 TEST_LOG_FORMAT_TSV (SKIPPED)
- 🟩 TEST_COLOR (SKIPPED)
✅ GROUP_MESSAGE: kmc message
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED) (notes)
- ✅ TEST_LOG_FORMAT_TSV (PASSED) (notes)
- ✅ TEST_COLOR (PASSED) (notes)
✅ GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED): ): no log generated, and no errors, generate command worked
- ✅ TEST_LOG_FORMAT_TSV (PASSED): ): no log generated, but no errors, generate command worked
- ✅ TEST_COLOR (PASSED): ): no log generated, but no errors, generate command worked
✅ GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED): ): no log generated, and no errors, generate command worked
- ✅ TEST_LOG_FORMAT_TSV (PASSED): ): no log generated, but no errors, generate command worked
- ✅ TEST_COLOR (PASSED): ): no log generated, but no errors, generate command worked
✅ GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED): ): no log generated, and no errors, generate command worked
- ✅ TEST_LOG_FORMAT_TSV (PASSED): ): no log generated, but no errors, generate command worked
- ✅ TEST_COLOR (PASSED): ): no log generated, but no errors, generate command worked
✅ GROUP_COPY: kmc copy
3 tests PASSED
- ✅ TEST_LOG_LEVEL_SILENT (PASSED) (notes)
- ✅ TEST_LOG_FORMAT_TSV (PASSED) (notes)
- ✅ TEST_COLOR (PASSED) (notes)

Test Artifacts

Developer
Keyboards
- Test Keyboards

mcdurdin · 2025-01-30T02:30:05Z

developer/src/kmc/test/generateKmnKeyboard.tests.ts

@@ -45,32 +46,11 @@ describe('generateKeymanKeyboard', function() {
    outPath = null;
  });

-  it('should only allow a single id', async function() {


These two tests are no longer necessary as they are validated at compile-time.

darcywong00

lgtm

darcywong00 · 2025-01-30T11:00:38Z

developer/src/kmc/test/generateKmnKeyboard.tests.ts

-  const keyboardOptions = {
-    icon: true,
+  const keyboardOptions: GeneratorOptions = {
+    // icon: true,


Was this supposed to be part of #12971?

Same change on the other tests.ts

Yes, it was missed because it was essentially ignored (because it was an untyped object). Once I added the GeneratorOptions type, that forced the removal of the icon property. No real harm done, fortunately!

srl295

nice DRY work

darcywong00

lgtm

Also add some resilience to option usage in kmc-generate; more work may need to be done here in future. Fixes: #13110

dinakaranr · 2025-02-03T10:43:25Z

Test Results

I tested this issue with the attached "Keyman-18.0.178-alpha-test-13075" build(03/02/2025) on Windows 10. I'm sharing my observation here.

GROUP_ANALYZE_OSK_CHAR_USE: `kmc analyze osk-char-use`

TEST_LOG_LEVEL_SILENT (Passed):
Switched to Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-char-use -m ghanatext.json --log-level silent
Verified that the file was created in the project folder.
It works well.
TEST_LOG_FORMAT_TSV (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-char-use -m ghanatext.json --log-format tsv
Verified that the file was created in the project folder.
It works well.
TEST_COLOR (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-char-use -m ghanatext.json--no-color --log-level verbose
Verified that the file was created in the project folder.
It works well.

GROUP_ANALYZE_REWRITE_FROM_OSK_CHAR_USE: `kmc analyze osk-rewrite-from-char-use`

TEST_LOG_LEVEL_SILENT (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-rewrite-from-char-use -m ghanatext.json --log-level silent
Verified that the file was created in the project folder.
It works well.
TEST_LOG_FORMAT_TSV (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-rewrite-from-char-use -m ghanatext.json --log-format tsv
Verified that the file was created in the project folder.
It works well.
TEST_COLOR (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc analyze osk-rewrite-from-char-use -m ghanatext.json --no-color --log-level verbose
Verified that the file was created in the project folder.
It works well.

GROUP_BUILD_FILE: `kmc build file`

TEST_LOG_LEVEL_SILENT (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc build file --log-level silent
Verified that the build file was created in the project folder.
It works well.
TEST_LOG_FORMAT_TSV (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run the below command
kmc build file --log-format tsv
Verified that the build file was created in the project folder.
It works well.
TEST_COLOR (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc build file --no-color --log-level verbose
Verified that the build file was created in the project folder.
It works well.

GROUP_BUILD_LDML_TEST_DATA: `kmc build ldml-test-data`

TEST_LOG_LEVEL_SILENT (Skip):
TEST_LOG_FORMAT_TSV (Skip):
TEST_COLOR (Skip):

GROUP_BUILD_WINDOWS_PACKAGE_INSTALLER: `kmc build windows-package-installer`

TEST_LOG_LEVEL_SILENT (Skip):
TEST_LOG_FORMAT_TSV (Skip):
TEST_COLOR (Skip):

GROUP_MESSAGE: `kmc message`

TEST_LOG_LEVEL_SILENT (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc message 400c --log-level silent
Verified that the "HINT_PackageShouldNotRepeatLanguages" message with details.
It works well.
TEST_LOG_FORMAT_TSV (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc message 400c --log-format tsv
Verified that the "HINT_PackageShouldNotRepeatLanguages" message with details.
It works well.
TEST_COLOR (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects\ghana_read)
Open the command prompt from the project folder.
Run below command
kmc message 400c --no-color --log-level verbose
Verified that the "HINT_PackageShouldNotRepeatLanguages" message with details.
It works well.

GROUP_GENERATE_KEYMAN_KEYBOARD: `kmc generate keyman-keyboard`

TEST_LOG_LEVEL_SILENT (failed):
TEST_LOG_FORMAT_TSV (failed):
TEST_COLOR (failed):

GROUP_GENERATE_LDML_KEYBOARD: `kmc generate ldml-keyboard`

TEST_LOG_LEVEL_SILENT (failed):
TEST_LOG_FORMAT_TSV (failed):
TEST_COLOR (failed):

GROUP_GENERATE_LEXICAL_MODEL: `kmc generate lexical-model`

TEST_LOG_LEVEL_SILENT (failed):
TEST_LOG_FORMAT_TSV (failed):
TEST_COLOR (failed):

GROUP_COPY: `kmc copy`

TEST_LOG_LEVEL_SILENT (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects)
Open the command prompt from the project folder.
Run below command
kmc copy "source keyman project folder path" -o "destination folder path" --log-level silent
Verified that the project folder was copied into the destination folder path.
It works well.
TEST_LOG_FORMAT_TSV (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects)
Open the command prompt from the project folder.
Run below command
kmc copy "source keyman project folder path" -o "destination folder path" --log-level silent
Verified that the project folder was copied into the destination folder path.
It works well.
TEST_COLOR (Passed):
Switched to the Project folder. (C:\Users\User_Name\Documents\Keyman Developer\Projects)
Open the command prompt from the project folder.
Run below command
kmc copy "source keyman project folder path" -o "destination folder path" --log-level silent
Verified that the project folder was copied into the destination folder path.
It works well.

mcdurdin · 2025-02-04T02:56:20Z

GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard

TEST_LOG_LEVEL_SILENT (failed):

TEST_LOG_FORMAT_TSV (failed):

TEST_COLOR (failed):

GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard

TEST_LOG_LEVEL_SILENT (failed):

TEST_LOG_FORMAT_TSV (failed):

TEST_COLOR (failed):

GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model

TEST_LOG_LEVEL_SILENT (failed):

TEST_LOG_FORMAT_TSV (failed):

TEST_COLOR (failed):

Hi @dinakaranr, could you let me know what the failures were here please?

dinakaranr · 2025-02-04T15:04:22Z

Okay. I failed these three problems because you indicated I filed a PR13110 in GitHub for these three cases. I attempted to generate keyboards. However, no log lines show after performing commands. Please look at the screenshot. Thank you.

mcdurdin · 2025-02-05T03:25:02Z

Thank you @dinakaranr. I think the generate command does not currently generate any logs unless there is an error. We should add some 'info' logs for normal operation, which I will put into a new issue to resolve during beta. So I think we can say that these passed, hurrah!

GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard
TEST_LOG_LEVEL_SILENT (PASS): no log generated, and no errors, generate command worked
TEST_LOG_FORMAT_TSV (PASS): no log generated, but no errors, generate command worked
TEST_COLOR (PASS): no log generated, but no errors, generate command worked
GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard
TEST_LOG_LEVEL_SILENT (PASS): no log generated, and no errors, generate command worked
TEST_LOG_FORMAT_TSV (PASS): no log generated, but no errors, generate command worked
TEST_COLOR (PASS): no log generated, but no errors, generate command worked
GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model
TEST_LOG_LEVEL_SILENT (PASS): no log generated, and no errors, generate command worked
TEST_LOG_FORMAT_TSV (PASS): no log generated, but no errors, generate command worked
TEST_COLOR (PASS): no log generated, but no errors, generate command worked

keyman-server · 2025-02-05T18:01:48Z

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

mcdurdin requested review from darcywong00, SabineSIL, markcsinclair and srl295 as code owners January 30, 2025 02:25

github-actions bot added developer/ developer/compilers/ fix labels Jan 30, 2025

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Jan 30, 2025

keymanapp-test-bot bot added this to the A18S20 milestone Jan 30, 2025

mcdurdin commented Jan 30, 2025

View reviewed changes

mcdurdin linked an issue Jan 30, 2025 that may be closed by this pull request

bug(developer): kmc log level options are inconsistently declared across kmc modules #13072

Closed

darcywong00 approved these changes Jan 30, 2025

View reviewed changes

srl295 approved these changes Jan 30, 2025

View reviewed changes

Base automatically changed from feat/developer/13060-relocate-files-in-kmc-copy to master January 30, 2025 23:06

darcywong00 approved these changes Jan 31, 2025

View reviewed changes

darcywong00 modified the milestones: A18S20, B18S1 Feb 1, 2025

mcdurdin mentioned this pull request Feb 3, 2025

bug(developer): kmc-generate fails with TypeError: Cannot read properties of undefined (reading 'length') if langtags are not provided as a parameter #13110

Closed

fix(developer): pass correct generator options from kmc

072c47b

Also add some resilience to option usage in kmc-generate; more work may need to be done here in future. Fixes: #13110

mcdurdin linked an issue Feb 3, 2025 that may be closed by this pull request

bug(developer): kmc-generate fails with TypeError: Cannot read properties of undefined (reading 'length') if langtags are not provided as a parameter #13110

Closed

chore(developer): make kmc-generate more resilient with nullish options

adf4b80

keymanapp-test-bot bot added user-test-failed and removed user-test-required User tests have not been completed labels Feb 3, 2025

keymanapp-test-bot bot removed the user-test-failed label Feb 5, 2025

mcdurdin merged commit 2df63dd into master Feb 5, 2025
6 checks passed

mcdurdin deleted the fix/developer/13072-make-kmc-log-options-consistent branch February 5, 2025 04:30

mcdurdin mentioned this pull request Feb 5, 2025

chore(developer): add info logs for kmc-copy and kmc-generate to indicate success #13127

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(developer): make kmc log options consistent across all commands #13075

fix(developer): make kmc log options consistent across all commands #13075

mcdurdin commented Jan 30, 2025 •

edited

Loading

keymanapp-test-bot bot commented Jan 30, 2025 •

edited

Loading

mcdurdin Jan 30, 2025

darcywong00 left a comment

darcywong00 Jan 30, 2025

mcdurdin Jan 31, 2025

srl295 left a comment

darcywong00 left a comment

dinakaranr commented Feb 3, 2025

mcdurdin commented Feb 4, 2025

GROUP_GENERATE_KEYMAN_KEYBOARD: `kmc generate keyman-keyboard`

GROUP_GENERATE_LDML_KEYBOARD: `kmc generate ldml-keyboard`

GROUP_GENERATE_LEXICAL_MODEL: `kmc generate lexical-model`

dinakaranr commented Feb 4, 2025

mcdurdin commented Feb 5, 2025

keyman-server commented Feb 5, 2025

fix(developer): make kmc log options consistent across all commands #13075

fix(developer): make kmc log options consistent across all commands #13075

Conversation

mcdurdin commented Jan 30, 2025 • edited Loading

User Testing

keymanapp-test-bot bot commented Jan 30, 2025 • edited Loading

User Test Results

Test Artifacts

mcdurdin Jan 30, 2025

Choose a reason for hiding this comment

darcywong00 left a comment

Choose a reason for hiding this comment

darcywong00 Jan 30, 2025

Choose a reason for hiding this comment

mcdurdin Jan 31, 2025

Choose a reason for hiding this comment

srl295 left a comment

Choose a reason for hiding this comment

darcywong00 left a comment

Choose a reason for hiding this comment

dinakaranr commented Feb 3, 2025

Test Results

GROUP_ANALYZE_OSK_CHAR_USE: kmc analyze osk-char-use

GROUP_ANALYZE_REWRITE_FROM_OSK_CHAR_USE: kmc analyze osk-rewrite-from-char-use

GROUP_BUILD_FILE: kmc build file

GROUP_BUILD_LDML_TEST_DATA: kmc build ldml-test-data

GROUP_BUILD_WINDOWS_PACKAGE_INSTALLER: kmc build windows-package-installer

GROUP_MESSAGE: kmc message

GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard

GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard

GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model

GROUP_COPY: kmc copy

mcdurdin commented Feb 4, 2025

GROUP_GENERATE_KEYMAN_KEYBOARD: kmc generate keyman-keyboard

GROUP_GENERATE_LDML_KEYBOARD: kmc generate ldml-keyboard

GROUP_GENERATE_LEXICAL_MODEL: kmc generate lexical-model

dinakaranr commented Feb 4, 2025

mcdurdin commented Feb 5, 2025

keyman-server commented Feb 5, 2025

mcdurdin commented Jan 30, 2025 •

edited

Loading

keymanapp-test-bot bot commented Jan 30, 2025 •

edited

Loading

GROUP_ANALYZE_OSK_CHAR_USE: `kmc analyze osk-char-use`

GROUP_ANALYZE_REWRITE_FROM_OSK_CHAR_USE: `kmc analyze osk-rewrite-from-char-use`

GROUP_BUILD_FILE: `kmc build file`

GROUP_BUILD_LDML_TEST_DATA: `kmc build ldml-test-data`

GROUP_BUILD_WINDOWS_PACKAGE_INSTALLER: `kmc build windows-package-installer`

GROUP_MESSAGE: `kmc message`

GROUP_GENERATE_KEYMAN_KEYBOARD: `kmc generate keyman-keyboard`

GROUP_GENERATE_LDML_KEYBOARD: `kmc generate ldml-keyboard`

GROUP_GENERATE_LEXICAL_MODEL: `kmc generate lexical-model`

GROUP_COPY: `kmc copy`

GROUP_GENERATE_KEYMAN_KEYBOARD: `kmc generate keyman-keyboard`

GROUP_GENERATE_LDML_KEYBOARD: `kmc generate ldml-keyboard`

GROUP_GENERATE_LEXICAL_MODEL: `kmc generate lexical-model`