Fix file watching events being lost #12264
Merged
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
Fixed an issue with tracking the current `FileSystemEvents` in the `MainFileSystemEventService`. Before, the events were tracked in a global field which was intended to be cleaned after an `onDidFilesChanges()` update was sent to the proxy. This is problematic as we do not await sending the update. Thus, the global field will be cleaned before the update is even sent and therefore, file watching updates might get lost. This change ensures that a field of events is kept for each update. Note that simply awaiting the update to be sent is not enough. This would introduce race conditions as other parallel updates might clean the state of other updates before they are being sent. Fixes eclipse-theia#12260. Contributed on behalf of STMicroelectronics
tsmaeder
approved these changes
Mar 10, 2023
tsmaeder
pushed a commit
that referenced
this pull request
Mar 20, 2023
Fixed an issue with tracking the current `FileSystemEvents` in the `MainFileSystemEventService`. Before, the events were tracked in a global field which was intended to be cleaned after an `onDidFilesChanges()` update was sent to the proxy. This is problematic as we do not await sending the update. Thus, the global field will be cleaned before the update is even sent and therefore, file watching updates might get lost. This change ensures that a field of events is kept for each update. Note that simply awaiting the update to be sent is not enough. This would introduce race conditions as other parallel updates might clean the state of other updates before they are being sent. Fixes #12260. Contributed on behalf of STMicroelectronics
vince-fugnitto
added
the
file-watchers
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.
What it does
Fixed an issue with tracking the current
FileSystemEventsin theMainFileSystemEventService.Before, the events were tracked in a global field which was intended to be cleaned after an
onDidFilesChanges()update was sent to the proxy.This is problematic as we do not await sending the update.
Thus, the global field will be cleaned before the update is even sent and therefore, file watching updates might get lost.
This change ensures that a field of events is kept for each update.
Note that simply awaiting the update to be sent is not enough.
This would introduce race conditions as other parallel updates might clean the state of other updates before they are being sent.
Fixes #12260.
Contributed on behalf of STMicroelectronics
How to test
Review checklist
Reminder for reviewers