Skip to content

Fix race condition in retrieveFileList() #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Botono wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix race condition in retrieveFileList() #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions watcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,11 +339,10 @@ func (w *Watcher) listRecursive(name string) (map[string]os.FileInfo, error) {
})
}

// Remove removes either a single file or directory from the file's list.
func (w *Watcher) Remove(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()

// Internal method that removes either a single file or directory from the
// file's list. There are no mutex operations so it is safe to call from inside
// mutex locking methods.
func (w *Watcher) remove(name string) (err error) {
name, err = filepath.Abs(name)
if err != nil {
return err
Expand Down Expand Up @@ -374,12 +373,17 @@ func (w *Watcher) Remove(name string) (err error) {
return nil
}

// RemoveRecursive removes either a single file or a directory recursively from
// the file's list.
func (w *Watcher) RemoveRecursive(name string) (err error) {
// Remove removes either a single file or directory from the file's list.
func (w *Watcher) Remove(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()
return w.remove(name)
}

// Private method that removes either a single file or a directory recursively from
// the file's list. There are no mutex operations so it is safe to call from inside
// mutex locking methods.
func (w *Watcher) removeRecursive(name string) (err error) {
name, err = filepath.Abs(name)
if err != nil {
return err
Expand Down Expand Up @@ -408,6 +412,15 @@ func (w *Watcher) RemoveRecursive(name string) (err error) {
return nil
}

// RemoveRecursive is a public method that removes either a single file or a
// directory recursively from the file's list. Locks the mutex, so do not
// call from within mutex-locking methods.
func (w *Watcher) RemoveRecursive(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()
return w.removeRecursive(name)
}

// Ignore adds paths that should be ignored.
//
// For files that are already added, Ignore removes them.
Expand Down Expand Up @@ -496,12 +509,10 @@ func (w *Watcher) retrieveFileList() map[string]os.FileInfo {
list, err = w.listRecursive(name)
if err != nil {
if os.IsNotExist(err) {
w.mu.Unlock()
if name == err.(*os.PathError).Path {
w.Error <- ErrWatchedFileDeleted
w.RemoveRecursive(name)
w.removeRecursive(name)
}
w.mu.Lock()
} else {
w.Error <- err
}
Expand All @@ -510,12 +521,10 @@ func (w *Watcher) retrieveFileList() map[string]os.FileInfo {
list, err = w.list(name)
if err != nil {
if os.IsNotExist(err) {
w.mu.Unlock()
if name == err.(*os.PathError).Path {
w.Error <- ErrWatchedFileDeleted
w.Remove(name)
w.remove(name)
}
w.mu.Lock()
} else {
w.Error <- err
}
Expand Down