-
Notifications
You must be signed in to change notification settings - Fork 0
/
fswatcher.go
159 lines (132 loc) · 3.48 KB
/
fswatcher.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*
Copyright 2021 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package utils
import (
"fmt"
"path/filepath"
"time"
"github.com/fsnotify/fsnotify"
"golang.org/x/exp/slog"
)
// FsWatcher is a wrapper helper for watching files
type FsWatcher struct {
*fsnotify.Watcher
Events chan struct{}
ratelimit time.Duration
names []string
paths map[string]struct{}
}
// CreateFsWatcher creates a new FsWatcher
func CreateFsWatcher(ratelimit time.Duration, names ...string) (*FsWatcher, error) {
w := &FsWatcher{
Events: make(chan struct{}),
names: names,
ratelimit: ratelimit,
}
if err := w.reset(names...); err != nil {
return nil, err
}
go w.watch()
return w, nil
}
// reset resets the file watches
func (w *FsWatcher) reset(names ...string) error {
if err := w.initWatcher(); err != nil {
return err
}
if err := w.add(names...); err != nil {
return err
}
return nil
}
func (w *FsWatcher) initWatcher() error {
if w.Watcher != nil {
if err := w.Watcher.Close(); err != nil {
return fmt.Errorf("failed to close fsnotify watcher: %w", err)
}
}
w.paths = make(map[string]struct{})
watcher, err := fsnotify.NewWatcher()
if err != nil {
w.Watcher = nil
return fmt.Errorf("failed to create fsnotify watcher: %w", err)
}
w.Watcher = watcher
return nil
}
func (w *FsWatcher) add(names ...string) error {
for _, name := range names {
if name == "" {
continue
}
added := false
// Add watches for all directory components so that we catch e.g. renames
// upper in the tree
for p := name; ; p = filepath.Dir(p) {
if _, ok := w.paths[p]; !ok {
if err := w.Add(p); err != nil {
slog.Any(fmt.Sprintf("failed to add fsnotify watch path %s", p), err)
} else {
slog.Info("added fsnotify watch", "path", p)
added = true
}
w.paths[p] = struct{}{}
} else {
added = true
}
if filepath.Dir(p) == p {
break
}
}
if !added {
// Want to be sure that we watch something
return fmt.Errorf("failed to add any watch")
}
}
return nil
}
func (w *FsWatcher) watch() {
var ratelimiter <-chan time.Time
for {
select {
case e, ok := <-w.Watcher.Events:
// Watcher has been closed
if !ok {
slog.Info("watcher closed")
return
}
// If any of our paths change
name := filepath.Clean(e.Name)
if _, ok := w.paths[filepath.Clean(name)]; ok {
slog.Info("fsnotify event detected", "path", name, "fsNotifyEvent", e)
// Rate limiter. In certain filesystem operations we get
// numerous events in quick succession
ratelimiter = time.After(w.ratelimit)
}
case e, ok := <-w.Watcher.Errors:
// Watcher has been closed
if !ok {
slog.Info("watcher closed")
return
}
slog.Any("fswatcher error event detected", e)
case <-ratelimiter:
// Blindly remove existing watch and add a new one
if err := w.reset(w.names...); err != nil {
slog.Any("re-trying in 60 seconds", err)
ratelimiter = time.After(60 * time.Second)
}
w.Events <- struct{}{}
}
}
}