watchman.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588
  1. 'use strict';
  2. function _path() {
  3. const data = _interopRequireDefault(require('path'));
  4. _path = function _path() {
  5. return data;
  6. };
  7. return data;
  8. }
  9. function _fbWatchman() {
  10. const data = _interopRequireDefault(require('fb-watchman'));
  11. _fbWatchman = function _fbWatchman() {
  12. return data;
  13. };
  14. return data;
  15. }
  16. var fastPath = _interopRequireWildcard(require('../lib/fast_path'));
  17. var _normalizePathSep = _interopRequireDefault(
  18. require('../lib/normalizePathSep')
  19. );
  20. var _constants = _interopRequireDefault(require('../constants'));
  21. function _interopRequireWildcard(obj) {
  22. if (obj && obj.__esModule) {
  23. return obj;
  24. } else {
  25. var newObj = {};
  26. if (obj != null) {
  27. for (var key in obj) {
  28. if (Object.prototype.hasOwnProperty.call(obj, key)) {
  29. var desc =
  30. Object.defineProperty && Object.getOwnPropertyDescriptor
  31. ? Object.getOwnPropertyDescriptor(obj, key)
  32. : {};
  33. if (desc.get || desc.set) {
  34. Object.defineProperty(newObj, key, desc);
  35. } else {
  36. newObj[key] = obj[key];
  37. }
  38. }
  39. }
  40. }
  41. newObj.default = obj;
  42. return newObj;
  43. }
  44. }
  45. function _interopRequireDefault(obj) {
  46. return obj && obj.__esModule ? obj : {default: obj};
  47. }
  48. function _slicedToArray(arr, i) {
  49. return (
  50. _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest()
  51. );
  52. }
  53. function _nonIterableRest() {
  54. throw new TypeError('Invalid attempt to destructure non-iterable instance');
  55. }
  56. function _iterableToArrayLimit(arr, i) {
  57. var _arr = [];
  58. var _n = true;
  59. var _d = false;
  60. var _e = undefined;
  61. try {
  62. for (
  63. var _i = arr[Symbol.iterator](), _s;
  64. !(_n = (_s = _i.next()).done);
  65. _n = true
  66. ) {
  67. _arr.push(_s.value);
  68. if (i && _arr.length === i) break;
  69. }
  70. } catch (err) {
  71. _d = true;
  72. _e = err;
  73. } finally {
  74. try {
  75. if (!_n && _i['return'] != null) _i['return']();
  76. } finally {
  77. if (_d) throw _e;
  78. }
  79. }
  80. return _arr;
  81. }
  82. function _arrayWithHoles(arr) {
  83. if (Array.isArray(arr)) return arr;
  84. }
  85. function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
  86. try {
  87. var info = gen[key](arg);
  88. var value = info.value;
  89. } catch (error) {
  90. reject(error);
  91. return;
  92. }
  93. if (info.done) {
  94. resolve(value);
  95. } else {
  96. Promise.resolve(value).then(_next, _throw);
  97. }
  98. }
  99. function _asyncToGenerator(fn) {
  100. return function() {
  101. var self = this,
  102. args = arguments;
  103. return new Promise(function(resolve, reject) {
  104. var gen = fn.apply(self, args);
  105. function _next(value) {
  106. asyncGeneratorStep(gen, resolve, reject, _next, _throw, 'next', value);
  107. }
  108. function _throw(err) {
  109. asyncGeneratorStep(gen, resolve, reject, _next, _throw, 'throw', err);
  110. }
  111. _next(undefined);
  112. });
  113. };
  114. }
  115. const watchmanURL =
  116. 'https://facebook.github.io/watchman/docs/troubleshooting.html';
  117. function WatchmanError(error) {
  118. error.message =
  119. `Watchman error: ${error.message.trim()}. Make sure watchman ` +
  120. `is running for this project. See ${watchmanURL}.`;
  121. return error;
  122. }
  123. module.exports =
  124. /*#__PURE__*/
  125. (function() {
  126. var _watchmanCrawl = _asyncToGenerator(function*(options) {
  127. const fields = ['name', 'exists', 'mtime_ms', 'size'];
  128. const data = options.data,
  129. extensions = options.extensions,
  130. ignore = options.ignore,
  131. rootDir = options.rootDir,
  132. roots = options.roots;
  133. const defaultWatchExpression = [
  134. 'allof',
  135. ['type', 'f'],
  136. ['anyof', ...extensions.map(extension => ['suffix', extension])]
  137. ];
  138. const clocks = data.clocks;
  139. const client = new (_fbWatchman()).default.Client();
  140. let clientError;
  141. client.on('error', error => (clientError = WatchmanError(error))); // TODO: type better than `any`
  142. const cmd = (...args) =>
  143. new Promise((resolve, reject) =>
  144. client.command(args, (error, result) =>
  145. error ? reject(WatchmanError(error)) : resolve(result)
  146. )
  147. );
  148. if (options.computeSha1) {
  149. const _ref = yield cmd('list-capabilities'),
  150. capabilities = _ref.capabilities;
  151. if (capabilities.indexOf('field-content.sha1hex') !== -1) {
  152. fields.push('content.sha1hex');
  153. }
  154. }
  155. function getWatchmanRoots(_x2) {
  156. return _getWatchmanRoots.apply(this, arguments);
  157. }
  158. function _getWatchmanRoots() {
  159. _getWatchmanRoots = _asyncToGenerator(function*(roots) {
  160. const watchmanRoots = new Map();
  161. yield Promise.all(
  162. roots.map(
  163. /*#__PURE__*/
  164. (function() {
  165. var _ref2 = _asyncToGenerator(function*(root) {
  166. const response = yield cmd('watch-project', root);
  167. const existing = watchmanRoots.get(response.watch); // A root can only be filtered if it was never seen with a
  168. // relative_path before.
  169. const canBeFiltered = !existing || existing.length > 0;
  170. if (canBeFiltered) {
  171. if (response.relative_path) {
  172. watchmanRoots.set(
  173. response.watch,
  174. (existing || []).concat(response.relative_path)
  175. );
  176. } else {
  177. // Make the filter directories an empty array to signal that this
  178. // root was already seen and needs to be watched for all files or
  179. // directories.
  180. watchmanRoots.set(response.watch, []);
  181. }
  182. }
  183. });
  184. return function(_x4) {
  185. return _ref2.apply(this, arguments);
  186. };
  187. })()
  188. )
  189. );
  190. return watchmanRoots;
  191. });
  192. return _getWatchmanRoots.apply(this, arguments);
  193. }
  194. function queryWatchmanForDirs(_x3) {
  195. return _queryWatchmanForDirs.apply(this, arguments);
  196. }
  197. function _queryWatchmanForDirs() {
  198. _queryWatchmanForDirs = _asyncToGenerator(function*(
  199. rootProjectDirMappings
  200. ) {
  201. const files = new Map();
  202. let isFresh = false;
  203. yield Promise.all(
  204. Array.from(rootProjectDirMappings).map(
  205. /*#__PURE__*/
  206. (function() {
  207. var _ref3 = _asyncToGenerator(function*([
  208. root,
  209. directoryFilters
  210. ]) {
  211. const expression = Array.from(defaultWatchExpression);
  212. const glob = [];
  213. if (directoryFilters.length > 0) {
  214. expression.push([
  215. 'anyof',
  216. ...directoryFilters.map(dir => ['dirname', dir])
  217. ]);
  218. var _iteratorNormalCompletion2 = true;
  219. var _didIteratorError2 = false;
  220. var _iteratorError2 = undefined;
  221. try {
  222. for (
  223. var _iterator2 = directoryFilters[Symbol.iterator](),
  224. _step2;
  225. !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next())
  226. .done);
  227. _iteratorNormalCompletion2 = true
  228. ) {
  229. const directory = _step2.value;
  230. var _iteratorNormalCompletion3 = true;
  231. var _didIteratorError3 = false;
  232. var _iteratorError3 = undefined;
  233. try {
  234. for (
  235. var _iterator3 = extensions[Symbol.iterator](),
  236. _step3;
  237. !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next())
  238. .done);
  239. _iteratorNormalCompletion3 = true
  240. ) {
  241. const extension = _step3.value;
  242. glob.push(`${directory}/**/*.${extension}`);
  243. }
  244. } catch (err) {
  245. _didIteratorError3 = true;
  246. _iteratorError3 = err;
  247. } finally {
  248. try {
  249. if (
  250. !_iteratorNormalCompletion3 &&
  251. _iterator3.return != null
  252. ) {
  253. _iterator3.return();
  254. }
  255. } finally {
  256. if (_didIteratorError3) {
  257. throw _iteratorError3;
  258. }
  259. }
  260. }
  261. }
  262. } catch (err) {
  263. _didIteratorError2 = true;
  264. _iteratorError2 = err;
  265. } finally {
  266. try {
  267. if (
  268. !_iteratorNormalCompletion2 &&
  269. _iterator2.return != null
  270. ) {
  271. _iterator2.return();
  272. }
  273. } finally {
  274. if (_didIteratorError2) {
  275. throw _iteratorError2;
  276. }
  277. }
  278. }
  279. } else {
  280. var _iteratorNormalCompletion4 = true;
  281. var _didIteratorError4 = false;
  282. var _iteratorError4 = undefined;
  283. try {
  284. for (
  285. var _iterator4 = extensions[Symbol.iterator](), _step4;
  286. !(_iteratorNormalCompletion4 = (_step4 = _iterator4.next())
  287. .done);
  288. _iteratorNormalCompletion4 = true
  289. ) {
  290. const extension = _step4.value;
  291. glob.push(`**/*.${extension}`);
  292. }
  293. } catch (err) {
  294. _didIteratorError4 = true;
  295. _iteratorError4 = err;
  296. } finally {
  297. try {
  298. if (
  299. !_iteratorNormalCompletion4 &&
  300. _iterator4.return != null
  301. ) {
  302. _iterator4.return();
  303. }
  304. } finally {
  305. if (_didIteratorError4) {
  306. throw _iteratorError4;
  307. }
  308. }
  309. }
  310. }
  311. const relativeRoot = fastPath.relative(rootDir, root);
  312. const query = clocks.has(relativeRoot) // Use the `since` generator if we have a clock available
  313. ? {
  314. expression,
  315. fields,
  316. since: clocks.get(relativeRoot)
  317. } // Otherwise use the `glob` filter
  318. : {
  319. expression,
  320. fields,
  321. glob
  322. };
  323. const response = yield cmd('query', root, query);
  324. if ('warning' in response) {
  325. console.warn('watchman warning: ', response.warning);
  326. }
  327. isFresh = isFresh || response.is_fresh_instance;
  328. files.set(root, response);
  329. });
  330. return function(_x5) {
  331. return _ref3.apply(this, arguments);
  332. };
  333. })()
  334. )
  335. );
  336. return {
  337. files,
  338. isFresh
  339. };
  340. });
  341. return _queryWatchmanForDirs.apply(this, arguments);
  342. }
  343. let files = data.files;
  344. let removedFiles = new Map();
  345. const changedFiles = new Map();
  346. let watchmanFiles;
  347. let isFresh = false;
  348. try {
  349. const watchmanRoots = yield getWatchmanRoots(roots);
  350. const watchmanFileResults = yield queryWatchmanForDirs(watchmanRoots); // Reset the file map if watchman was restarted and sends us a list of
  351. // files.
  352. if (watchmanFileResults.isFresh) {
  353. files = new Map();
  354. removedFiles = new Map(data.files);
  355. isFresh = true;
  356. }
  357. watchmanFiles = watchmanFileResults.files;
  358. } finally {
  359. client.end();
  360. }
  361. if (clientError) {
  362. throw clientError;
  363. } // TODO: remove non-null
  364. var _iteratorNormalCompletion = true;
  365. var _didIteratorError = false;
  366. var _iteratorError = undefined;
  367. try {
  368. for (
  369. var _iterator = watchmanFiles[Symbol.iterator](), _step;
  370. !(_iteratorNormalCompletion = (_step = _iterator.next()).done);
  371. _iteratorNormalCompletion = true
  372. ) {
  373. const _step$value = _slicedToArray(_step.value, 2),
  374. watchRoot = _step$value[0],
  375. response = _step$value[1];
  376. const fsRoot = (0, _normalizePathSep.default)(watchRoot);
  377. const relativeFsRoot = fastPath.relative(rootDir, fsRoot);
  378. clocks.set(relativeFsRoot, response.clock);
  379. var _iteratorNormalCompletion5 = true;
  380. var _didIteratorError5 = false;
  381. var _iteratorError5 = undefined;
  382. try {
  383. for (
  384. var _iterator5 = response.files[Symbol.iterator](), _step5;
  385. !(_iteratorNormalCompletion5 = (_step5 = _iterator5.next()).done);
  386. _iteratorNormalCompletion5 = true
  387. ) {
  388. const fileData = _step5.value;
  389. const filePath =
  390. fsRoot +
  391. _path().default.sep +
  392. (0, _normalizePathSep.default)(fileData.name);
  393. const relativeFilePath = fastPath.relative(rootDir, filePath);
  394. const existingFileData = data.files.get(relativeFilePath); // If watchman is fresh, the removed files map starts with all files
  395. // and we remove them as we verify they still exist.
  396. if (isFresh && existingFileData && fileData.exists) {
  397. removedFiles.delete(relativeFilePath);
  398. }
  399. if (!fileData.exists) {
  400. // No need to act on files that do not exist and were not tracked.
  401. if (existingFileData) {
  402. files.delete(relativeFilePath); // If watchman is not fresh, we will know what specific files were
  403. // deleted since we last ran and can track only those files.
  404. if (!isFresh) {
  405. removedFiles.set(relativeFilePath, existingFileData);
  406. }
  407. }
  408. } else if (!ignore(filePath)) {
  409. const mtime =
  410. typeof fileData.mtime_ms === 'number'
  411. ? fileData.mtime_ms
  412. : fileData.mtime_ms.toNumber();
  413. const size = fileData.size;
  414. let sha1hex = fileData['content.sha1hex'];
  415. if (typeof sha1hex !== 'string' || sha1hex.length !== 40) {
  416. sha1hex = null;
  417. }
  418. let nextData;
  419. if (
  420. existingFileData &&
  421. existingFileData[_constants.default.MTIME] === mtime
  422. ) {
  423. nextData = existingFileData;
  424. } else if (
  425. existingFileData &&
  426. sha1hex &&
  427. existingFileData[_constants.default.SHA1] === sha1hex
  428. ) {
  429. nextData = [
  430. existingFileData[0],
  431. mtime,
  432. existingFileData[2],
  433. existingFileData[3],
  434. existingFileData[4],
  435. existingFileData[5]
  436. ];
  437. } else {
  438. // See ../constants.ts
  439. nextData = ['', mtime, size, 0, '', sha1hex];
  440. }
  441. const mappings = options.mapper
  442. ? options.mapper(filePath)
  443. : null;
  444. if (mappings) {
  445. var _iteratorNormalCompletion6 = true;
  446. var _didIteratorError6 = false;
  447. var _iteratorError6 = undefined;
  448. try {
  449. for (
  450. var _iterator6 = mappings[Symbol.iterator](), _step6;
  451. !(_iteratorNormalCompletion6 = (_step6 = _iterator6.next())
  452. .done);
  453. _iteratorNormalCompletion6 = true
  454. ) {
  455. const absoluteVirtualFilePath = _step6.value;
  456. if (!ignore(absoluteVirtualFilePath)) {
  457. const relativeVirtualFilePath = fastPath.relative(
  458. rootDir,
  459. absoluteVirtualFilePath
  460. );
  461. files.set(relativeVirtualFilePath, nextData);
  462. changedFiles.set(relativeVirtualFilePath, nextData);
  463. }
  464. }
  465. } catch (err) {
  466. _didIteratorError6 = true;
  467. _iteratorError6 = err;
  468. } finally {
  469. try {
  470. if (
  471. !_iteratorNormalCompletion6 &&
  472. _iterator6.return != null
  473. ) {
  474. _iterator6.return();
  475. }
  476. } finally {
  477. if (_didIteratorError6) {
  478. throw _iteratorError6;
  479. }
  480. }
  481. }
  482. } else {
  483. files.set(relativeFilePath, nextData);
  484. changedFiles.set(relativeFilePath, nextData);
  485. }
  486. }
  487. }
  488. } catch (err) {
  489. _didIteratorError5 = true;
  490. _iteratorError5 = err;
  491. } finally {
  492. try {
  493. if (!_iteratorNormalCompletion5 && _iterator5.return != null) {
  494. _iterator5.return();
  495. }
  496. } finally {
  497. if (_didIteratorError5) {
  498. throw _iteratorError5;
  499. }
  500. }
  501. }
  502. }
  503. } catch (err) {
  504. _didIteratorError = true;
  505. _iteratorError = err;
  506. } finally {
  507. try {
  508. if (!_iteratorNormalCompletion && _iterator.return != null) {
  509. _iterator.return();
  510. }
  511. } finally {
  512. if (_didIteratorError) {
  513. throw _iteratorError;
  514. }
  515. }
  516. }
  517. data.files = files;
  518. return {
  519. changedFiles: isFresh ? undefined : changedFiles,
  520. hasteMap: data,
  521. removedFiles
  522. };
  523. });
  524. function watchmanCrawl(_x) {
  525. return _watchmanCrawl.apply(this, arguments);
  526. }
  527. return watchmanCrawl;
  528. })();