feat(windows): add boot switch #12995

rc-swag · 2025-01-23T01:11:55Z

Fixes: #12994
This updates the registry entry run on start-up to use -boot, add the -boot switch
to initprog. The fmBoot option code allows update state machine code so that
on boot a prompt can let the user the new update is about to install.

User Testing

TEST_BOOT_SWITCH_POP UP

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Start Keyman
Open the Keyman Configuration dialog.
In the Options tab
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 changes from usUpdateAvailable --> usDownloading --> usWaitingRestart
Logout and Back into Windows
Verify a pop-up Keyman is ready to install with two buttons install and close.

TEST_ON_STARTUP_UPDATED

I wasn't able to attach an older build but you can install the build from PR #12956 or even the latest version 17 from Keyman.com
2. Open Keyman Configuration and check Start with Windows option
2. Open the regedit window
WinR type regedit Go the current key Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\Keyman
3. Observe that is "C:\Program Files (x86)\Keyman\Keyman Desktop\kmshell.exe" -s
4. Download the Keyman for windows attached to this PR.
5. Double-click on the file to install it. Ensure you choose the install options and select the 18.0.175-alpha-test-12995
6. The setup will ask you to reboot the computer to continue installing. Once rebooted and the installing is complete.
7. Open the regedit window
WinR type regedit Go the current key Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\Keyman
8. Observe that is "C:\Program Files (x86)\Keyman\Keyman Desktop\kmshell.exe" -boot

This updates the registry entry or run on start up and the switch to initprog. TODO is to actually process the switch correctly when set.

keymanapp-test-bot · 2025-01-23T01:12:09Z

User Test Results

Test specification and instructions

✅ TEST_BOOT_SWITCH_POP (PASSED) (notes)
✅ TEST_ON_STARTUP_UPDATED (PASSED) (notes)

Add fmBoot option code and update state machine code so that on boot a prompt can let the user the new update is about to install.

dinakaranr · 2025-01-29T09:40:40Z

Test Results

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

TEST_BOOT_SWITCH_POP (Passed):

Install Keyman attached the PR
Install the Gff_Amharic 3.1.1 version keyboard.
Start Keyman
Open the Keyman Configuration dialog.
In the Options tab
Navigate to the "Keyboard Layouts tab".
Verified that the installed keyboard shows an older version.
Navigate to the "Update" tab.
Open the "C:\Users\Dinakaran\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 changes from usUpdateAvailable --> usDownloading --> usWaitingRestart
Logout and Back into Windows
Verify a pop-up Keyman(Keyman update) is ready to install with two buttons install and close.
Press the install button on the dialog.
Verified that the two dialog appear to install the build. ("Do you want to allow this app to make changes to your device?")
Press the yes button on the dialog.
Verified that the "Keyman setup" dialog appears and has a "restart now" button.
Press the "Yes" button to restart the machine.
Login into Windows
"Do you want to allow this app to make changes to your device?" dialog appears and then press the yes button.
Verified the installation dialog and completed it.
It works well. Thank you.

mcdurdin · 2025-01-30T05:32:30Z

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

@@ -451,14 +453,14 @@ procedure RunKMCOM(FMode: TKMShellMode; KeyboardFileNames: TStrings; FSilent, FF
      Exit;
  end;

-  if not FSilent and (FMode in [fmStart, fmSplash, fmMain, fmAbout]) then   // I4773
+  if not FSilent and (FMode in [fmStart, fmSplash, fmMain, fmAbout, fmBoot]) then   // I4773


Is this right? Previously, we used -s as the boot switch, which meant FSilent = True. So I don't think fmBoot should be checking TIP install status?

Yes, because we were overloading the -s to use it for boot which wasn't a perfect match. For boot we wanted -s to supress splash screen or configuration. but checking the DoCheckTIPInstallStatus?
I have changed it back. DoCheckTIPInstallStatus does nothing anyway as it is all commented out. DoCheckTIPInstallStatus
I have created an issue to investigate cleaning this up. #13100

mcdurdin · 2025-01-30T05:33:48Z

windows/src/engine/kmcomapi/util/utilkeymanoption.pas

@@ -323,7 +323,7 @@ procedure TUtilKeymanOptionEntry.CustomSave;
      if OpenKey('\'+SRegKey_WindowsRun_CU, True) then
      begin
        if FBoolValue then
-          WriteString(SRegValue_WindowsRun_Keyman, '"'+TKeymanPaths.KeymanDesktopInstallPath(TKeymanPaths.S_KMShell)+'" -s')
+          WriteString(SRegValue_WindowsRun_Keyman, '"'+TKeymanPaths.KeymanDesktopInstallPath(TKeymanPaths.S_KMShell)+'" -boot')


Do we need to reapply the -boot flag to the setting when we upgrade from an earlier version of Keyman? AFAICT, the registry setting is not rewritten during the upgrade.

The way I read it is that RunTools.PrepareForReboot Deletes the key SRegValue_WindowsRun_Keyman.

// Delete the Keyman autostart; it will be reinstated when setup finishes

Then it is setup again with firstrun via the options being passed through the command line ..... and the those options being applied. I didn't step all the way through.

I will add a test to this attaching an old build with the -s then have it be upgraded with this PR build

dinakaranr · 2025-01-30T14:16:03Z

Test Results

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

TEST_ON_STARTUP_UPDATED (Passed):

Installed the "Keyman-18.0.175-alpha-test-12956" PR build.
Open Keyman Configuration and check Start with Windows option
Open the regedit window
WinR type regedit Go the current key Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\Keyman
Verified that the "C:\Program Files (x86)\Keyman\Keyman Desktop\kmshell.exe" -s
Uninstalled the "Keyman-18.0.175-alpha-test-12956.exe" file
Download the Keyman for Windows attached to this PR("Keyman-18.0.175-alpha-test-12995").
Double-click on the file to install it. Ensure you choose the install options and select the 18.0.175-alpha-test-12995
The setup will ask you to reboot the computer to continue installing. Once you have rebooted, the installation is complete.
Open the regedit window WinR type regedit Go the current key Computer\HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Run\Keyman
Verified that the "C:\Program Files (x86)\Keyman\Keyman Desktop\kmshell.exe" -boot
It works well. Thank you.

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

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

feat(windows): initall adding -boot

4387418

This updates the registry entry or run on start up and the switch to initprog. TODO is to actually process the switch correctly when set.

rc-swag self-assigned this Jan 23, 2025

github-actions bot added windows/ windows/config/ windows/engine/ labels Jan 23, 2025

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

github-actions bot added the feat label Jan 23, 2025

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

rc-swag changed the base branch from master to feat/windows/kmshell-switch-handling January 28, 2025 07:30

feat(windows): add fmBoot option

27bf535

Add fmBoot option code and update state machine code so that on boot a prompt can let the user the new update is about to install.

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 14:13

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

rc-swag requested review from mcdurdin and ermshiperete and removed request for ermshiperete January 28, 2025 14:13

ermshiperete approved these changes Jan 28, 2025

View reviewed changes

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

mcdurdin requested changes Jan 30, 2025

View reviewed changes

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

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

Base automatically changed from feat/windows/kmshell-switch-handling to master January 30, 2025 23:59

feat(windows): remove fmBoot from DoCheckTIPInstallStatus

0a8c046

rc-swag requested a review from mcdurdin January 31, 2025 00:15

mcdurdin approved these changes Jan 31, 2025

View reviewed changes

rc-swag merged commit 53daacd into master Jan 31, 2025
6 checks passed

rc-swag deleted the feat/windows/12994/add-boot-switch branch January 31, 2025 02:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(windows): add boot switch #12995

feat(windows): add boot switch #12995

rc-swag commented Jan 23, 2025 •

edited

Loading

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

edited

Loading

dinakaranr commented Jan 29, 2025

mcdurdin Jan 30, 2025

rc-swag Jan 31, 2025 •

edited

Loading

mcdurdin Jan 30, 2025

rc-swag Jan 30, 2025 •

edited

Loading

dinakaranr commented Jan 30, 2025

keyman-server commented Jan 31, 2025

feat(windows): add boot switch #12995

feat(windows): add boot switch #12995

Conversation

rc-swag commented Jan 23, 2025 • edited Loading

User Testing

TEST_BOOT_SWITCH_POP UP

TEST_ON_STARTUP_UPDATED

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

User Test Results

dinakaranr commented Jan 29, 2025

Test Results

mcdurdin Jan 30, 2025

Choose a reason for hiding this comment

rc-swag Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

mcdurdin Jan 30, 2025

Choose a reason for hiding this comment

rc-swag Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

dinakaranr commented Jan 30, 2025

Test Results

keyman-server commented Jan 31, 2025

rc-swag commented Jan 23, 2025 •

edited

Loading

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

edited

Loading

rc-swag Jan 31, 2025 •

edited

Loading

rc-swag Jan 30, 2025 •

edited

Loading