Fix for spurious rebuilds with watchdog>=2.3.0 #1117
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
2 tasks
dairiki
force-pushed
the
fix.watcher-fileopened-events
branch
from
1d790bb
to
450b56b
Compare
Since watchdog==2.3.0, its InotifyObserver emits events whenever a file is opened. This was causing spurious Lektor rebuilds.
dairiki
force-pushed
the
fix.watcher-fileopened-events
branch
3 times, most recently
from
2276354
to
db85427
Compare
Under macOS, the FSEventObserver (at least) seems to return events for filesystem changes that happened a bit for the Observer was started. We had a short wait in place to let these stale events go by. It mostly worked, but there have been sporadic spurious failures on the macOS GitHub test runner. Here we increase the wait time, but — so as not to slow tests on other platforms — only perform the wait when running on macOS.
dairiki
force-pushed
the
fix.watcher-fileopened-events
branch
from
db85427
to
9ced7ef
Compare
dairiki
added a commit
that referenced
this pull request
Apr 2, 2023
dairiki
added a commit
to dairiki/lektor
that referenced
this pull request
Sep 11, 2023
* fix(watcher): ignore FileOpenedEvents Since watchdog==2.3.0, its InotifyObserver emits events whenever a file is opened. This was causing spurious Lektor rebuilds. * refactor(watcher): optimization: we only care about file events * fix(tests): increase wait for stale events on macOS Under macOS, the FSEventObserver (at least) seems to return events for filesystem changes that happened a bit for the Observer was started. We had a short wait in place to let these stale events go by. It mostly worked, but there have been sporadic spurious failures on the macOS GitHub test runner. Here we increase the wait time, but — so as not to slow tests on other platforms — only perform the wait when running on macOS.
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.
In release 2.3.0,
watchdogenabled tracking of inotify IN_OPEN events. These fire whenever a file is opened (even when opened for reading). This can happen for any number of reasons, many of which are outside of our control. Currently, this can lead to frequent spurious rebuilds in some cases.The PR fixes things so as to ignore the new file-opened events from watchdog. Actually, here, we change strategy from ignoring events that we don't think we're interested in to specifically tracking only those types of events that we're interested in.
This PR also refactors our watchdog tests, to clean them up as well as to enable testing for the unwanted file-opened events.
(An alternative fix might be to adjust the
event_maskpassed to theInotifyobserver constructor so as to exclude theIN_OPENbit. Doing so would reduce the number of events processed bywatchdog, and so be more efficient — but it takes a lot of special-casing code on our part to apply the proper modifications to just theInotifyobserver — and only in certain versions ofwatchdog.)Issue(s) Resolved
Related Issues / Links
Also see PR #1118 which builds on this one, further refactoring and cleaning up the Watcher code (while changing the API in a backward-incompatible manner.)
Description of Changes