fsnotify

This version of fsnotify needs Go 1.17.

Additions

• illumos: add FEN backend to support illumos and Solaris. (#371)

• all: add NewBufferedWatcher() to use a buffered channel, which can be useful in cases where you can't control the kernel buffer and receive a large number of events in bursts. (#550, #572)

• all: add AddWith(), which is identical to Add() but allows passing options. (#521)

• windows: allow setting the ReadDirectoryChangesW() buffer size with fsnotify.WithBufferSize(); the default of 64K is the highest value that works on all platforms and is enough for most purposes, but in some cases a highest buffer is needed. (#521)

Changes and fixes

• inotify: remove watcher if a watched path is renamed (#518)

  After a rename the reported name wasn't updated, or even an empty string. Inotify doesn't provide any good facilities to update it, so just remove the watcher. This is already how it worked on kqueue and FEN.

  On Windows this does work, and remains working.

• windows: don't listen for file attribute changes (#520)

  File attribute changes are sent as FILE_ACTION_MODIFIED by the Windows API, with no way to see if they're a file write or attribute change, so would show up as a fsnotify.Write event. This is never useful, and could result in many spurious Write events.

• windows: return ErrEventOverflow if the buffer is full (#525)

  Before it would merely return "short read", making it hard to detect this error.

• kqueue: make sure events for all files are delivered properly when removing a watched directory (#526)

  Previously they would get sent with "" (empty string) or "." as the path name.

• kqueue: don't emit spurious Create events for symbolic links (#524)

  The link would get resolved but kqueue would "forget" it already saw the link itself, resulting on a Create for every Write event for the directory.

• all: return ErrClosed on Add() when the watcher is closed (#516)

• other: add Watcher.Errors and Watcher.Events to the no-op Watcher in backend_other.go, making it easier to use on unsupported platforms such as WASM, AIX, etc. (#528)

• other: use the backend_other.go no-op if the appengine build tag is set; Google AppEngine forbids usage of the unsafe package so the inotify backend won't compile there.

This version of fsnotify needs Go 1.16 (this was already the case since 1.5.1, but not documented). It also increases the minimum Linux version to 2.6.32.

Additions

• all: add Event.Has() and Op.Has() (#477)

  This makes checking events a lot easier; for example:

    if event.Op&Write == Write && !(event.Op&Remove == Remove) {
    }
  

  Becomes:

    if event.Has(Write) && !event.Has(Remove) {
    }
  

• all: add cmd/fsnotify (#463)

  A command-line utility for testing and some examples.

Changes and fixes

• inotify: don't ignore events for files that don't exist (#260, #470)

  Previously the inotify watcher would call os.Lstat() to check if a file still exists before emitting events.

  This was inconsistent with other platforms and resulted in inconsistent event reporting (e.g. when a file is quickly removed and re-created), and generally a source of confusion. It was added in 2013 to fix a memory leak that no longer exists.

• all: return ErrNonExistentWatch when Remove() is called on a path that's
  not watched (#460)

• inotify: replace epoll() with non-blocking inotify (#434)

  Non-blocking inotify was not generally available at the time this library was written in 2014, but now it is. As a result, the minimum Linux version is bumped from 2.6.27 to 2.6.32. This hugely simplifies the code and is faster.

• kqueue: don't check for events every 100ms (#480)

  The watcher would wake up every 100ms, even when there was nothing to do. Now it waits until there is something to do.

• macos: retry opening files on EINTR (#475)

• kqueue: skip unreadable files (#479)

  kqueue requires a file descriptor for every file in a directory; this would fail if a file was unreadable by the current user. Now these files are simply skipped.

• windows: fix renaming a watched directory if the parent is also watched (#370)

• windows: increase buffer size from 4K to 64K (#485)

• windows: close file handle on Remove() (#288)

• kqueue: put pathname in the error if watching a file fails (#471)

• inotify, windows: calling Close() more than once could race (#465)

• kqueue: improve Close() performance (#233)

• all: various documentation additions and clarifications.

What's Changed

• Removed dead link by @COil in https://github.com/fsnotify/fsnotify/pull/337
• Update issue templates by @nathany in https://github.com/fsnotify/fsnotify/pull/410
• Test on Go 1.18 and two most recent versions by @nathany in https://github.com/fsnotify/fsnotify/pull/411
• fix go vet warnings: call to (*T).Fatalf from a non-test goroutine by @shogo82148 in https://github.com/fsnotify/fsnotify/pull/416
• Run cross-compilation builds on every push by @nshalman in https://github.com/fsnotify/fsnotify/pull/420
• Don't set poller.fd twice in newFdPoller by @tklauser in https://github.com/fsnotify/fsnotify/pull/406
• Re-enable tests for PRs by @nshalman in https://github.com/fsnotify/fsnotify/pull/415
• Enable cross-compilation builds on PRs by @nshalman in https://github.com/fsnotify/fsnotify/pull/423
• Integration Tests: change 1ms sleeps to 50ms by @nshalman in https://github.com/fsnotify/fsnotify/pull/422
• Add FreeBSD testing in Github Actions (fix #389) by @r-darwish in https://github.com/fsnotify/fsnotify/pull/419
• Allow build on unsupported GOOS by @tklauser in https://github.com/fsnotify/fsnotify/pull/424
• Fix potential crash on windows if raw.FileNameLength exceeds syscall.MAX_PATH by @hu13 in https://github.com/fsnotify/fsnotify/pull/361
• Add a feature to return the directories and files that are being monitored by @NitroCao in https://github.com/fsnotify/fsnotify/pull/374

New Contributors

• @COil made their first contribution in https://github.com/fsnotify/fsnotify/pull/337
• @r-darwish made their first contribution in https://github.com/fsnotify/fsnotify/pull/419
• @hu13 made their first contribution in https://github.com/fsnotify/fsnotify/pull/361
• @NitroCao made their first contribution in https://github.com/fsnotify/fsnotify/pull/374

Full Changelog: https://github.com/fsnotify/fsnotify/compare/v1.5.1...v1.5.2

What's Changed

• Fix compilation for OpenBSD by @mattn in https://github.com/fsnotify/fsnotify/pull/443
• go.mod: use latest x/sys by @kevinburkesegment in https://github.com/fsnotify/fsnotify/pull/444
• README.md: link to pkg.go.dev for golang.org/x/sys package by @tklauser in https://github.com/fsnotify/fsnotify/pull/441
• Windows: add missing defer to Watcher.WatchList by @Sojamann in https://github.com/fsnotify/fsnotify/pull/447
• Prepare for v1.5.4 by @shogo82148 in https://github.com/fsnotify/fsnotify/pull/448

New Contributors

• @mattn made their first contribution in https://github.com/fsnotify/fsnotify/pull/443
• @kevinburkesegment made their first contribution in https://github.com/fsnotify/fsnotify/pull/444
• @Sojamann made their first contribution in https://github.com/fsnotify/fsnotify/pull/447

Full Changelog: https://github.com/fsnotify/fsnotify/compare/v1.5.2...v1.5.4

#394

• Go: Increase minimum required version to Go 1.12 #381
• Feature: Add AddRaw method which does not follow symlinks when adding a watch #289
• Windows: Follow symlinks by default like on all other systems #289
• CI: Use GitHub Actions for CI and cover go 1.12-1.17 #378 #381 #385
• Go 1.14+: Fix unsafe pointer conversion #325

• Move example usage to the readme #329. This may resolve #328.

• CI: test more go versions (@nathany 1d13583d846ea9d66dcabbfefbfb9d8e6fb05216)
• Tests: Queued inotify events could have been read by the test before max_queued_events was hit (@matthias-stone #265)
• Tests: t.Fatalf -> t.Errorf in go routines (@gdey #266)
• CI: Less verbosity (@nathany #267)
• Tests: Darwin: Exchangedata is deprecated on 10.13 (@nathany #267)
• Tests: Check if channels are closed in the example (@alexeykazakov #244)
• CI: Only run golint on latest version of go and fix issues (@cpuguy83 #284)
• CI: Add windows to travis matrix (@cpuguy83 #284)
• Docs: Remover appveyor badge (@nathany 11844c0959f6fff69ba325d097fce35bd85a8e93)
• Linux: create epoll and pipe fds with close-on-exec (@JohannesEbke #219)
• Linux: open files with close-on-exec (@linxiulei #273)
• Docs: Plan to support fanotify (@nathany ab058b44498e8b7566a799372a39d150d9ea0119 )
• Project: Add go.mod (@nathany #309)
• Project: Revise editor config (@nathany #309)
• Project: Update copyright for 2019 (@nathany #309)
• CI: Drop go1.8 from CI matrix (@nathany #309)
• Docs: Updating the FAQ section for supportability with NFS & FUSE filesystems (@Pratik32 4bf2d1fec78374803a39307bfb8d340688f4f28e )

• BSD/macOS: Fix possible deadlock on closing the watcher on kqueue (thanks @nhooyr and @glycerine)
• Tests: Fix missing verb on format string (thanks @rchiossi)
• Linux: Fix deadlock in Remove (thanks @aarondl)
• Linux: Watch.Add improvements (avoid race, fix consistency, reduce garbage) (thanks @twpayne)
• Docs: Moved FAQ into the README (thanks @vahe)
• Linux: Properly handle inotify's IN_Q_OVERFLOW event (thanks @zeldovich)
• Docs: replace references to OS X with macOS

Linux: use InotifyInit1 with IN_CLOEXEC to stop leaking a file descriptor to a child process when using fork/exec #178 (thanks @pattyshack)

• Fix flaky inotify stress test on Linux #177 (thanks @pattyshack)

• add a String() method to Event.Op #165 (thanks @oozie)

• windows: fix for double backslash when watching the root of a drive #151 (thanks @brunoqc)

Support linux/arm64 by patching x/sys/unix and switching to to it from syscall #135 (thanks @suihkulokki)

Please see the README for updated information on installation.

• Fix golint errors in windows.go #121 (thanks @tiffanyfj)

kqueue: Fix logic for CREATE after REMOVE #111 (thanks @bep)

• kqueue: fix race condition in Close #105 (thanks @djui for reporting the issue and @ppknap for writing a failing test)
• inotify: fix race in test
• enable race detection for continuous integration (Linux, Mac, Windows)

• inotify: use epoll_create1 for arm64 support (requires Linux 2.6.27 or later) #100 (thanks @suihkulokki)
• inotify: fix path leaks #73 (thanks @chamaken)
• kqueue: watch for rename events on subdirectories #83 (thanks @guotie)
• kqueue: avoid infinite loops from symlinks cycles #101 (thanks @illicitonion)

kqueue: don't watch named pipes #98 (thanks @evanphx)

This releases resolves several issues when Close() is used, from leaking file descriptors to blocking issues. It also is using epoll when reading events on Linux to avoid blocking.

• inotify: use epoll to wake up readEvents #66 #5 (thanks @PieterD)
• inotify: deleted file watches can now be removed #40
• inotify: closing watcher should now always shut down goroutine #63 (thanks @PieterD)
• kqueue: close kqueue after removing watches, fixes #59