watchman_watcher.js
5.61 KB
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
'use strict';
const fs = require('fs');
const path = require('path');
const common = require('./common');
const watchmanClient = require('./watchman_client');
const EventEmitter = require('events').EventEmitter;
const RecrawlWarning = require('./utils/recrawl-warning-dedupe');
/**
* Constants
*/
const CHANGE_EVENT = common.CHANGE_EVENT;
const DELETE_EVENT = common.DELETE_EVENT;
const ADD_EVENT = common.ADD_EVENT;
const ALL_EVENT = common.ALL_EVENT;
/**
* Export `WatchmanWatcher` class.
*/
module.exports = WatchmanWatcher;
/**
* Watches `dir`.
*
* @class WatchmanWatcher
* @param String dir
* @param {Object} opts
* @public
*/
function WatchmanWatcher(dir, opts) {
common.assignOptions(this, opts);
this.root = path.resolve(dir);
this._init();
}
WatchmanWatcher.prototype.__proto__ = EventEmitter.prototype;
/**
* Run the watchman `watch` command on the root and subscribe to changes.
*
* @private
*/
WatchmanWatcher.prototype._init = function() {
if (this._client) {
this._client = null;
}
// Get the WatchmanClient instance corresponding to our watchmanPath (or nothing).
// Then subscribe, which will do the appropriate setup so that we will receive
// calls to handleChangeEvent when files change.
this._client = watchmanClient.getInstance(this.watchmanPath);
return this._client.subscribe(this, this.root).then(
resp => {
this._handleWarning(resp);
this.emit('ready');
},
error => {
this._handleError(error);
}
);
};
/**
* Called by WatchmanClient to create the options, either during initial 'subscribe'
* or to resubscribe after a disconnect+reconnect. Note that we are leaving out
* the watchman 'since' and 'relative_root' options, which are handled inside the
* WatchmanClient.
*/
WatchmanWatcher.prototype.createOptions = function() {
let options = {
fields: ['name', 'exists', 'new'],
};
// If the server has the wildmatch capability available it supports
// the recursive **/*.foo style match and we can offload our globs
// to the watchman server. This saves both on data size to be
// communicated back to us and compute for evaluating the globs
// in our node process.
if (this._client.wildmatch) {
if (this.globs.length === 0) {
if (!this.dot) {
// Make sure we honor the dot option if even we're not using globs.
options.expression = [
'match',
'**',
'wholename',
{
includedotfiles: false,
},
];
}
} else {
options.expression = ['anyof'];
for (let i in this.globs) {
options.expression.push([
'match',
this.globs[i],
'wholename',
{
includedotfiles: this.dot,
},
]);
}
}
}
return options;
};
/**
* Called by WatchmanClient when it receives an error from the watchman daemon.
*
* @param {Object} resp
*/
WatchmanWatcher.prototype.handleErrorEvent = function(error) {
this.emit('error', error);
};
/**
* Called by the WatchmanClient when it is notified about a file change in
* the tree for this particular watcher's root.
*
* @param {Object} resp
* @private
*/
WatchmanWatcher.prototype.handleChangeEvent = function(resp) {
if (Array.isArray(resp.files)) {
resp.files.forEach(this.handleFileChange, this);
}
};
/**
* Handles a single change event record.
*
* @param {Object} changeDescriptor
* @private
*/
WatchmanWatcher.prototype.handleFileChange = function(changeDescriptor) {
let absPath;
let relativePath;
relativePath = changeDescriptor.name;
absPath = path.join(this.root, relativePath);
if (
!(this._client.wildmatch && !this.hasIgnore) &&
!common.isFileIncluded(this.globs, this.dot, this.doIgnore, relativePath)
) {
return;
}
if (!changeDescriptor.exists) {
this.emitEvent(DELETE_EVENT, relativePath, this.root);
} else {
fs.lstat(absPath, (error, stat) => {
// Files can be deleted between the event and the lstat call
// the most reliable thing to do here is to ignore the event.
if (error && error.code === 'ENOENT') {
return;
}
if (this._handleError(error)) {
return;
}
let eventType = changeDescriptor.new ? ADD_EVENT : CHANGE_EVENT;
// Change event on dirs are mostly useless.
if (!(eventType === CHANGE_EVENT && stat.isDirectory())) {
this.emitEvent(eventType, relativePath, this.root, stat);
}
});
}
};
/**
* Dispatches an event.
*
* @param {string} eventType
* @param {string} filepath
* @param {string} root
* @param {fs.Stat} stat
* @private
*/
WatchmanWatcher.prototype.emitEvent = function(
eventType,
filepath,
root,
stat
) {
this.emit(eventType, filepath, root, stat);
this.emit(ALL_EVENT, eventType, filepath, root, stat);
};
/**
* Closes the watcher.
*
* @param {function} callback
* @private
*/
WatchmanWatcher.prototype.close = function(callback) {
this._client.closeWatcher(this);
callback && callback(null, true);
};
/**
* Handles an error and returns true if exists.
*
* @param {WatchmanWatcher} self
* @param {Error} error
* @private
*/
WatchmanWatcher.prototype._handleError = function(error) {
if (error != null) {
this.emit('error', error);
return true;
} else {
return false;
}
};
/**
* Handles a warning in the watchman resp object.
*
* @param {object} resp
* @private
*/
WatchmanWatcher.prototype._handleWarning = function(resp) {
if ('warning' in resp) {
if (RecrawlWarning.isRecrawlWarningDupe(resp.warning)) {
return true;
}
console.warn(resp.warning);
return true;
} else {
return false;
}
};