Poll directory changes before resolving start promise on Windows #75
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
When watching a path on Windows, a new thread gets spawned and a function is scheduled to be executed onto such thread. This function's responsibility is to invoke `ReadDirectoryChangesW` for the first time and to wake up the thread which invoked `Watcher::start`, signaling that nsfw is ready to report events. Previously, the main thread would be woken up _before_ calling `ReadDirectoryChangesW`. If any event occurred before or as `ReadDirectoryChangesW` took place, it wouldn't be reported to clients because that API only reports changes that occur _between_ calls to it. This commit fixes the issue by waiting for `ReadDirectoryChangesW` to have been called before waking up the main thread. This ensures that file system events occurring after watching has started are always reported to clients.
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.
When watching a path on Windows, a new thread gets spawned and a function is scheduled to be executed onto such thread. This function's responsibility is to invoke
ReadDirectoryChangesWfor the first time and to wake up the thread which invokedWatcher::start, signaling that nsfw is ready to report events.Previously, the main thread would be woken up before calling
ReadDirectoryChangesW. If any event occurred before or asReadDirectoryChangesWtook place, it wouldn't be reported to clients because that API only reports changes that occur between calls to it. This is an excerpt from MSDN:This pull request fixes the issue by waiting for
ReadDirectoryChangesWto have been called before waking up the main thread. This ensures that file system events occurring after watching has started are always reported to clients.