fix: handle TOCTOU race condition in file watcher #22
Conversation
This file contains hidden or 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
During the file processing in process_files, there was a time-of-check to time-of-use (TOCTOU) race condition where a file could be deleted between path.exists() check and read_to_string() call. This commit handles ErrorKind::NotFound error when reading the file. If the file is not found, we assume it was deleted and remove it from the index, similar to how explicit deletion events are handled. Fixes PlatformNetwork/bounty-challenge#90
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.
Description
The
process_files()function insrc/watcher.rshad a time-of-check to time-of-use (TOCTOU) race condition. A file could be deleted between thepath.exists()check and the subsequentread_to_string()call, causing silent failures.This PR addresses the issue by handling
ErrorKind::NotFoundwhen reading the file. If the file is not found during the read operation, it is treated as deleted and removed from the index.Changes
process_filesinsrc/watcher.rsto match onread_to_stringresult.ErrorKind::NotFoundto handle the race condition.NotFoundoccurs, the code now attempts to remove the file from the database and logs the race condition handling.Verification
path.exists()returns true but the file is gone by the timeread_to_string()is called.