feat(windows): kmshell switch handling for the installing state #12956

rc-swag · 2025-01-21T05:02:15Z

This improves the switch handling around the installing state. Previously, the SM did a no-op and let the commands go through.
Now when in the installing state and the following modes are set "fmInstallTip, fmInstallTipsForPackages, fmRegisterTip, fmUpgradeKeyboards, fmUpgradeMnemonicLayout" skip being sent to the SM but all other messages are sent through. This then allows us to detect whne kmshell is trying to run as if successuly installed but state machine is still in the installing state.

This is also adds ProcessBackroundUpdate for neatness and readablity of code it is not inteded to change the functionality.
A seperate issue #12994 will add a -boot switch.

User Testing

We will just test there is no regression.

TEST_INSTALL_UPDATE

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Open the Keyman Configuration dialog.
Navigate to the "Keyboard Layouts tab".
Verified that the installed keyboard shows an older version.
Navigate to the "Update" tab.
Open the "C:\Users"yourusername"\AppData\Local\Keyman\UpdateCache" folder.
Open the regedit window (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine).
WinR type regedit Go the current user key update state
Press F5 to keep it refreshing it.
The state will go to usDownloading to usInstalling at the same time keep checking the UpdateCache folder.
Select the "update state"
In Keyman Configuration press the "Check for new updates" button.
Verified that the "UpdateCache" folder is updating or adding files)
On Regedit window. Verify the state is changes from usUpdateAvailable--> usDownloading --> usWaitingRestart
Click the "Apply update now" button. Click the "Update" button on the "Keyman Update" popup.
Verified that the "UpdateCache" folder has the cache.json and the keyboard gff_amharic. and a Keyman.version.exe if avaialable.
On Regedit window. the state is changing to "usldle"
Restart the machine by clicking the "Yes" button on the "Keyman setup" dialog.
Login to the machine.
Click ˘the "Yes" button on the "Do you want to allow to make the change?"
Keyman Installation is completed successfully.
Open the configuration window.
On the Keyboard Layouts: verify gff_amharic keyboard is updated.
On the Update Tab: verify there are no update available.

TEST_INSTALL_IDLE_CLEARED

In this test we will manipulate the registry update state to test the handling of receiving an kmshell request not expected in the installing state.

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Run Keyman
Open the Keyman Configuration dialog.
Navigate to the "Keyboard Layouts tab".
Verified that the installed keyboard shows an older version.
Navigate to the "Update" tab.
Open the "C:\Users"yourusername"\AppData\Local\Keyman\UpdateCache" folder.
Open the regedit window (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine).
WinR type regedit Go the current user key update state
Press F5 to keep it refreshing it.
The state will go to usDownloading to usInstalling at the same time keep checking the UpdateCache folder.
Select the "update state"
In Keyman Configuration press the "Check for new updates" button.
Verified that the "UpdateCache" folder is updating or adding files)
On Regedit window. Verify the state is changed from usUpdateAvailable--> usDownloading --> usWaitingRestart
Use the Regedit to manually modify update state to "usInstalling"
Open a command prompt (kbd>WinR type cmd)
Change to the directory where kmshell is installed
cd "c:\Program Files (x86)\Keyman\Keyman Desktop"
Type kmshell.exe -a
Looking at the registry editor the state should have changed to usIdle press F5 to refresh
The UpdatedCache folder should be empty

Also handle the case where the SM seems to be stuck in the installing state. MSI may have failed.

keymanapp-test-bot · 2025-01-21T05:02:23Z

User Test Results

Test specification and instructions

✅ TEST_INSTALL_UPDATE (PASSED) (notes)
✅ TEST_INSTALL_IDLE_CLEARED (PASSED) (notes)

Test Artifacts

Windows

rc-swag · 2025-01-21T05:43:07Z

windows/src/desktop/kmshell/main/initprog.pas

+        UserCanceled := False;
+        if BUpdateSM.ReadyToInstall and
+          (not FSilent and (FMode in [fmStart, fmSplash, fmMain, fmAbout, fmHelp,
+          fmShowHelp, fmSettings])) then


@mcdurdin I have added fmShowHelp, and fmSettings as gui's where we could notify the user we can pop keyman update is ready to install. select update, or close.

However, I am still not happy that we are missing the all-important case when Keyman starts with Windows which is simply kmshell.exe -s I propose we update this to have a switch -on-boot so kmshell.exe -s -on-boot then we could determine this is a case where the UI can be run. Thoughts?

@marc

This isn't me!

kmshell -s means 'silent' so that means no UI is intended to be shown there... We could change that to kmshell.exe -boot, but we'd have to fixup existing installations -- we'd need to make sure that that change was applied during the upgrade (this is quite doable, just more work and testing).

I think that'd be good because it'd be clearer than the current -s which could be used any time and is ambiguous.

@_marc

This isn't me!

yikes

…h-handling # Keyman Conventional Commit suggestions: # # - Link to a Sentry issue with git trailer: # Fixes: _MODULE_-_ID_ # - Give credit to co-authors: # Co-authored-by: _Name_ <_email_> # - Use imperative, present tense ('attach' not 'attaches', 'attached' etc) # - Don't include a period at the end of the title # - Always include a blank line before trailers # - More: https://github.com/keymanapp/keyman/wiki/Pull-Request-and-Commit-workflow-notes

ermshiperete · 2025-01-28T15:29:39Z

windows/src/desktop/kmshell/main/Keyman.System.UpdateStateMachine.pas

-  // Result = exit straight away as we are installing (MSI installer)
-  // need to just do a no-op keyman will it maybe using kmshell to install
-  // packages.
+  // Should not be called while in installing state MSI installer may have


Is there a period missing after "state"? I have a hard time parsing the sentence as it is.

windows/src/desktop/kmshell/main/initprog.pas

Co-authored-by: Eberhard Beilharz <[email protected]>

dinakaranr · 2025-01-30T12:14:16Z

Test Results

I tested this issue with the attached "Keyman-18.0.175-alpha-test-12956" build(30/01/2025) on Windows 10. I'm sharing my observation here.

TEST_INSTALL_UPDATE (Passed):

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Open the Keyman Configuration dialog.
Navigate to the "Keyboard Layouts tab".
Verified that the installed keyboard shows an older version.
Navigate to the "Update" tab.
Open the "C:\Users"yourusername"\AppData\Local\Keyman\UpdateCache" folder.
Open the regedit window (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine).
WinR type regedit Go the current user key update state
Press F5 to keep it refreshing it.
The state will go to usDownloading to usInstalling at the same time keep checking the UpdateCache folder.
Select the "update state"
In Keyman Configuration press the "Check for new updates" button.
Verified that the "UpdateCache" folder is updating or adding files)
On Regedit window. Verify the state is changes from usUpdateAvailable--> usDownloading --> usWaitingRestart
Click the "Apply update now" button. Click the "Update" button on the "Keyman Update" popup.
Verified that the "UpdateCache" folder has the cache.json and the keyboard gff_amharic. and a Keyman.version.exe if available.
On Regedit window. the state is changing to "usldle"
Restart the machine by clicking the "Yes" button on the "Keyman setup" dialog.
Login to the machine.
Click ˘the "Yes" button on the "Do you want to allow to make the change?"
Keyman Installation is completed successfully.
Open the configuration window.
On the Keyboard Layouts: verify gff_amharic keyboard is updated.
On the Update Tab: Verified there are no updates available.

TEST_INSTALL_IDLE_CLEARED (Passed):

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Run Keyman
Open the Keyman Configuration dialog.
Navigate to the "Keyboard Layouts tab".
Verified that the installed keyboard shows an older version.
Navigate to the "Update" tab.
Open the "C:\Users"yourusername"\AppData\Local\Keyman\UpdateCache" folder.
Open the regedit window (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine).
WinR type regedit Go the current user key update state
Press F5 to keep it refreshing it.
The state will go to usDownloading to usInstalling at the same time keep checking the UpdateCache folder.
Select the "update state"
In Keyman Configuration press the "Check for new updates" button.
Verified that the "UpdateCache" folder is updating or adding files)
On Regedit window. Verify the state is changed from usUpdateAvailable--> usDownloading --> usWaitingRestart
Use the Regedit to manually modify the update state to "usInstalling"
Open a command prompt (kbd>WinR type cmd)
Change to the directory where kmshell is installed
cd "c:\Program Files (x86)\Keyman\Keyman Desktop"
Type kmshell.exe -a
Looking at the registry editor the state should have changed to "usIdle". press F5 to refresh
Verified that the "UpdatedCache" folder is empty.
It works well. Thank you.

keyman-server · 2025-01-31T18:02:40Z

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

feat(windows): improve switch handling for installing state

14b4118

Also handle the case where the SM seems to be stuck in the installing state. MSI may have failed.

rc-swag self-assigned this Jan 21, 2025

keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Jan 21, 2025

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

github-actions bot added windows/ windows/config/ feat labels Jan 21, 2025

rc-swag requested a review from mcdurdin January 21, 2025 05:03

rc-swag changed the base branch from master to feat/windows/test-online-update January 21, 2025 05:36

rc-swag commented Jan 21, 2025

View reviewed changes

Base automatically changed from feat/windows/test-online-update to master January 21, 2025 23:47

rc-swag mentioned this pull request Jan 23, 2025

feat(windows): Add -boot switch to kmshell #12994

Closed

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed and removed user-test-missing User tests have not yet been defined for the PR labels Jan 28, 2025

rc-swag marked this pull request as ready for review January 28, 2025 13:48

rc-swag requested a review from ermshiperete as a code owner January 28, 2025 13:48

ermshiperete approved these changes Jan 28, 2025

View reviewed changes

rc-swag and others added 3 commits January 29, 2025 22:17

feat(windows): review comments

f57f2e7

Co-authored-by: Eberhard Beilharz <[email protected]>

feat(windows): review commments

6b40ff8

feat(windows): update comments for clarity

39b8bb6

ermshiperete approved these changes Jan 29, 2025

View reviewed changes

rc-swag mentioned this pull request Jan 30, 2025

feat(windows): add boot switch #12995

Merged

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Jan 30, 2025

rc-swag merged commit adb095b into master Jan 30, 2025
6 checks passed

rc-swag deleted the feat/windows/kmshell-switch-handling branch January 30, 2025 23:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(windows): kmshell switch handling for the installing state #12956

feat(windows): kmshell switch handling for the installing state #12956

rc-swag commented Jan 21, 2025 •

edited

Loading

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

edited

Loading

rc-swag Jan 21, 2025 •

edited

Loading

mcdurdin Jan 21, 2025

mcdurdin Jan 21, 2025

rc-swag Jan 22, 2025

ermshiperete Jan 28, 2025

dinakaranr commented Jan 30, 2025

keyman-server commented Jan 31, 2025

feat(windows): kmshell switch handling for the installing state #12956

feat(windows): kmshell switch handling for the installing state #12956

Conversation

rc-swag commented Jan 21, 2025 • edited Loading

User Testing

TEST_INSTALL_UPDATE

TEST_INSTALL_IDLE_CLEARED

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

User Test Results

Test Artifacts

rc-swag Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

mcdurdin Jan 21, 2025

Choose a reason for hiding this comment

mcdurdin Jan 21, 2025

Choose a reason for hiding this comment

rc-swag Jan 22, 2025

Choose a reason for hiding this comment

ermshiperete Jan 28, 2025

Choose a reason for hiding this comment

dinakaranr commented Jan 30, 2025

Test Results

keyman-server commented Jan 31, 2025

rc-swag commented Jan 21, 2025 •

edited

Loading

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

edited

Loading

rc-swag Jan 21, 2025 •

edited

Loading