fix(windows): kmshell continues when sm is in waitingrestart and returns to idle

[rc-swag]

When waiting restart on a handlekmshell event and returning to idle kmshell execution should continue
This also refacted the change in #14295, check if automatic updates have been turned off before pompting user. Therefore will have tests for that also.

Fixes: #14578

User Testing

TEST_KMSHELL_CONTINUE_EXECUTION

We need to test that if a handle kmshell event occurs when in the WaitingRestart state, but the cache is now corrupt that when returning to idle, kmshell execution continues.

Install the PR version of Keyman on this PR

1. If there is no updates available we will maninputlate the state using windows registry Win + R type regedit. Go Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine and change the update state to usWaitingRestart
2. Open Windows Explorer (Win + E) got to the cache C:\Users\{username}\AppData\Local\Keyman\UpdateCache.. If there is a cache.json file remove it. If there are other files they can stay there.
3. Go to Keyman Configuration and the Options and uncheck Start with Windows it will make it easier to verify the change.
4. Restart Windows
5. Start Keyman ensure that Keyman does start and that update state in the registry returns to idle

We need to verify that changes from #14295 still work

TEST_UPDATE_CANCELED_NO_PROMPT

Install the Keyman for Windows Build associated with this PR.

1. Start Keyman
2. Open configuration go to the "Options" tab and ensure "Automatically check for updates and download" is selected.
3. Go to the "Update" tab
4. Open the windows registry (Win+R and type regedit) and check the "update state flag" if it is already usWaitingRestart go straight to step 8. Which should be go to Options and uncheck Automatically check for updates and downloads].
5. Check for now updates
6. Open the windows registry (Win+R and type regedit) and check the "update state flag" at Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine
7. It should end up at state usWaitingRestart after going through the other states -> usUpdateAvailable -> usDownloadloading -> usWaitingRestart
8. Now got to the Options and uncheck Automatically check for updates and downloads.
9. Exit Configuration and Keyman.
10. Restart Windows
11. Once Keyman starts (if it doesn't start, start Keyman)
12. Open the windows registry (Win+R and type regedit) and check the "update state flag" at Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine
13. Observe that the update state flag returns to usIdle

TEST_UPDATE_PROMPT

This is a regression to test to ensure the "normal" case still works.

1. Start Keyman
2. Go to the Options and check Automatically check for updates and downloads.
3. Open configuration go to the "Update" tab
4. Open the windows registry (Win+R and type regedit) and check the "update state flag" if it is already usWaitingRestart go straight to step 8
5. Check for now updates
6. Open the windows registry (Win+R and type regedit) and check the "update state flag" at Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine
7. It should end up at state usWaitingRestart after going through the other states -> usUpdateAvailable -> usDownloadloading -> usWaitingRestart
8. Exit Configuration and Keyman.
9. Restart Windows
10. Once Keyman starts (if it doesn't start, start Keyman), A prompt should appear to notify the user Keyman update will install now with an option to exit.

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ TEST_KMSHELL_CONTINUE_EXECUTION (PASSED) (notes)
• ✅ TEST_UPDATE_CANCELED_NO_PROMPT (PASSED) (notes)
• ✅ TEST_UPDATE_PROMPT (PASSED) (notes)

Test Artifacts

• Windows
  • Keyman for Windows
  • FirstVoices Keyboards for Windows
  • Text Editor (32 bit)
  • Text Editor (64 bit)

[dinakaranr]

Test Results

I tested this PR in the "Keyman-19.0.111-alpha-test-14644" build on Windows 10. Here I am sharing my observation.

• TEST_KMSHELL_CONTINUE_EXECUTION (Passed):

1. Download and Install "Keyman-19.0.111-alpha-test-14644" version of Keyman on this PR
2. Start the Keyman.
3. Go to the "Update" tab.
4. Click the "Check for new updates" button
5. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
6. Select the "Keyman Engine" and then change the update state to "usWaitingRestart" (Go Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine)
7. Open the "Appdata" foler by pressing Win + R and then enter "%appdata%"
8. Go to the C:\Users{username}\AppData\Local\Keyman\UpdateCache.. folder
9. If there is a cache.json file remove it. If there are other files they can stay there.
10. Open the "Keyman Configuration" and then navigate to the Options tab.
11. Uncheck "Start when Windows starts" it will make it easier to verify the change.
12. Restart Windows
13. Start Keyman.
14. Verified that the Keyman does start.
15. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
16. Select the "Keyman Engine"
17. Verified that the "update state" changed to "usIdle"
    It works well. Thank you.

• TEST_UPDATE_CANCELED_NO_PROMPT (Passed):

1. Download and Install "Keyman-19.0.111-alpha-test-14644" version of Keyman on this PR
2. Start Keyman
3. Open the "keyman configuration". Go to the "Options" tab.
4. Verified the "Automatically check for updates and download" is selected.
5. Go to "Update" tab
6. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
7. Select the "Keyman Engine". (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine)
8. Verified that the "Update state" is "usWaitingRestart" or "usIdle"
9. It is showing as "usIdle"
10. Change the "update state" from "usIdle" to "usWaitingRestart"
11. Go to the "Options" tab.
12. Uncheck the "Automatically check for updates and downloads" checkbox.
13. Close the Keyman configuration.
14. Restart the Windows
15. Start Keyman (if it doesn't start, start Keyman)
16. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
17. Select the "Keyman Engine". (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine)
18. Verified that the update state flag returns to usIdle
    It works well. Thank you.

• TEST_UPDATE_PROMPT (Passed):

1. Download and Install "Keyman-19.0.111-alpha-test-14644" version of Keyman on this PR
2. Start Keyman
3. Open the "keyman configuration". Go to the "Options" tab.
4. Checked the "Automatically check for updates and download".
5. Go to "Update" tab.
6. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
7. Select the "Keyman Engine". (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine)
8. Verified that the "Update state" is "usIdle"
9. Click the "Check for new updates" button.
10. Open the "Registry Editor" by pressing the Win + R and type the "regedit".
11. Select the "Keyman Engine". (Computer\HKEY_CURRENT_USER\SOFTWARE\Keyman\Keyman Engine)
12. Verified that the "Update state" is changing "usUpdateAvailable -> usDownloadloading -> usWaitingRestart"
13. Close the Keyman configuration.
14. Restart the Windows
15. Start Keyman
16. Verified that the prompt should appear to notify the user Keyman update will install now
17. Verified that the "Keyman Update" prompt have a "Update now" or "Later" appears
    It works well. Thank you.

[mcdurdin]

I'm finding this a bit hard to parse. Can you review? If possible, it may be easier to avoid the not test?

[rc-swag]

Ok that comment didn't help, I think that was cause for confusion? I reworked it and function block comment.
If I remove the not it will make need to be nested which is even harder to parse.

if TUpdateCheckStorage.CheckMetaDataForUpdate and GetAutomaticUpdates then
begin
  if not HasKeymanRun then
    Exit(True);
  Exit(False);
end
else
begin
  RemoveCachedFiles;
  CurrentState(IdleState);
  Exit(False);
end;

[keyman-server]

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