fix(developer): prevent simultaneous opening of the same project by two processes #13341
+72
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…wo processes There is a race condition where two processes may both attempt to open the same project file. This appears to happen, for example, if an author double-clicks on a single-click shortcut, launching Keyman Developer twice in quick succession. This fix adds a .lock file which is deleted automatically on close of the project or on normal or abnormal process termination. If a second process encounters the .lock file, it will simply open the welcome view instead of attempting to open the project. Fixes: #11584 Fixes: KEYMAN-DEVELOPER-1PR
mcdurdin
requested review from
darcywong00,
SabineSIL,
markcsinclair and
srl295
as code owners
keymanapp-test-bot
bot
added
has-user-test
user-test-required
User Test ResultsTest specification and instructions Test Artifacts
|
darcywong00
approved these changes
Feb 25, 2025
|
Review: I want to use a private appdata folder with hash of project filename (lowercased) instead of the current design of a .lock file next to the .kpj file. This will be less confusing for keyboard authors because the .lock file comes and goes and is never readable anyway. |
For the project lock files, instead of using a filename in the same path as the project file, with a .lock extension, use a hash of the project filename in the Keyman Developer appdata folder, to avoid confusion and conflict in project folders. Fixes: #11584
Test ResultsI tested this issue with the attached KeymanDeveloper"18.0.199-beta-test-133341" build(25/02/2025) on Windows 10 and 11. Here I am sharing my observation.
|
keymanapp-test-bot
bot
removed
the
user-test-required
darcywong00
reviewed
Feb 25, 2025
| LoadGlobalProjectUI(ptUnknown, TikeCommandLine.StartupProjectPath); | ||
| if LoadGlobalProjectUI(ptUnknown, TikeCommandLine.StartupProjectPath) = nil then | ||
| begin | ||
| raise EProjectLoader.Create('Project is already open in another process'); |
There was a problem hiding this comment.
Does the lock file get left behind if the user reboots/shuts down while Keyman Developer is open?
I get frustrated by Android Studio when it does this. They include the path of the lock file to remove, so the user can manually remove it.
There was a problem hiding this comment.
Two things:
- The lock file is automatically deleted on close. It would take a hard reset for it to remain
- Keyman Developer will attempt to recreate it even if it exists -- so it does no real damage to leave it there in any case (and it's out of the way of the user now so it's really very harmless).
mcdurdin
deleted the
fix/developer/11584-prevent-opening-same-project-twice
branch
|
Changes in this pull request will be available for download in Keyman version 18.0.202-beta |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is a race condition where two processes may both attempt to open the same project file. This appears to happen, for example, if an author double-clicks on a single-click shortcut, launching Keyman Developer twice in quick succession.
This fix adds a .lock file which is deleted automatically on close of the project or on normal or abnormal process termination. If a second process encounters the .lock file, it will simply open the welcome view instead of attempting to open the project.
Fixes: #11584
Fixes: KEYMAN-DEVELOPER-1PR
User Testing