feat(haste-map): watchman crawler now includes dotfiles (#10075)

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - `[jest-core, jest-circus, jest-reporter, jest-runner]` Added support for reporting individual test cases using jest-circus ([#10227](https://github.com/facebook/jest/pull/10227))
 - `[jest-config, jest-reporter, jest-runner, jest-test-sequencer]` Add `slowTestThreshold` configuration option ([#9366](https://github.com/facebook/jest/pull/9366))
+- `[jest-haste-map]` Watchman crawler now includes dotfiles ([#10075](https://github.com/facebook/jest/pull/10075))
 - `[jest-worker]` Added support for workers to send custom messages to parent in jest-worker ([#10293](https://github.com/facebook/jest/pull/10293))
 - `[jest-worker]` Support passing `resourceLimits` ([#10335](https://github.com/facebook/jest/pull/10335))
 - `[pretty-format]` Added support for serializing custom elements (web components) ([#10217](https://github.com/facebook/jest/pull/10237))

jest.config.js

@@ -49,6 +49,7 @@ module.exports = {
     '/packages/jest-cli/src/init/__tests__/fixtures/',
     '/packages/jest-haste-map/src/__tests__/haste_impl.js',
     '/packages/jest-haste-map/src/__tests__/dependencyExtractor.js',
+    '/packages/jest-haste-map/src/__tests__/test_dotfiles_root/',
     '/packages/jest-resolve-dependencies/src/__tests__/__fixtures__/',
     '/packages/jest-runtime/src/__tests__/defaultResolver.js',
     '/packages/jest-runtime/src/__tests__/module_dir/',

packages/jest-haste-map/package.json

@@ -16,6 +16,7 @@
     "anymatch": "^3.0.3",
     "fb-watchman": "^2.0.0",
     "graceful-fs": "^4.2.4",
+    "jest-regex-util": "^26.0.0",
     "jest-serializer": "^26.1.0",
     "jest-util": "^26.1.0",
     "jest-worker": "^26.1.0",

packages/jest-haste-map/src/__tests__/includes_dotfiles.test.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import HasteMap from '../index';
+
+const rootDir = path.join(__dirname, './test_dotfiles_root');
+
+const commonOptions = {
+  extensions: ['js'],
+  maxWorkers: 1,
+  platforms: [],
+  resetCache: true,
+  retainAllFiles: true,
+  rootDir,
+  roots: [rootDir],
+};
+
+test('watchman crawler and node crawler both include dotfiles', async () => {
+  const hasteMapWithWatchman = new HasteMap({
+    ...commonOptions,
+    name: 'withWatchman',
+    useWatchman: true,
+  });
+
+  const hasteMapWithNode = new HasteMap({
+    ...commonOptions,
+    name: 'withNode',
+    useWatchman: false,
+  });
+
+  const [builtHasteMapWithWatchman, builtHasteMapWithNode] = await Promise.all([
+    hasteMapWithWatchman.build(),
+    hasteMapWithNode.build(),
+  ]);
+
+  expect(
+    builtHasteMapWithWatchman.hasteFS.matchFiles('.eslintrc.js'),
+  ).toHaveLength(1);
+
+  expect(builtHasteMapWithWatchman.hasteFS.getAllFiles().sort()).toEqual(
+    builtHasteMapWithNode.hasteFS.getAllFiles().sort(),
+  );
+});

packages/jest-haste-map/src/__tests__/index.test.js

@@ -294,6 +294,45 @@ describe('HasteMap', () => {
     });
   });
 
+  it('ignores vcs directories without ignore pattern', () => {
+    mockFs['/project/fruits/.git/fruit-history.js'] = `
+      // test
+    `;
+    return new HasteMap(defaultConfig).build().then(({hasteFS}) => {
+      expect(hasteFS.matchFiles('.git')).toEqual([]);
+    });
+  });
+
+  it('ignores vcs directories with ignore pattern regex', () => {
+    const config = {...defaultConfig, ignorePattern: /Kiwi/};
+    mockFs['/project/fruits/Kiwi.js'] = `
+      // Kiwi!
+    `;
+
+    mockFs['/project/fruits/.git/fruit-history.js'] = `
+      // test
+    `;
+    return new HasteMap(config).build().then(({hasteFS}) => {
+      expect(hasteFS.matchFiles(/Kiwi/)).toEqual([]);
+      expect(hasteFS.matchFiles('.git')).toEqual([]);
+    });
+  });
+
+  it('ignores vcs directories with ignore pattern function', () => {
+    const config = {...defaultConfig, ignorePattern: f => /Kiwi/.test(f)};
+    mockFs['/project/fruits/Kiwi.js'] = `
+      // Kiwi!
+    `;
+
+    mockFs['/project/fruits/.git/fruit-history.js'] = `
+      // test
+    `;
+    return new HasteMap(config).build().then(({hasteFS}) => {
+      expect(hasteFS.matchFiles(/Kiwi/)).toEqual([]);
+      expect(hasteFS.matchFiles('.git')).toEqual([]);
+    });
+  });
+
   it('builds a haste map on a fresh cache', () => {
     // Include these files in the map
     mockFs['/project/fruits/node_modules/react/React.js'] = `

packages/jest-haste-map/src/__tests__/test_dotfiles_root/.eslintrc.js

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

packages/jest-haste-map/src/__tests__/test_dotfiles_root/index.js

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

packages/jest-haste-map/src/crawlers/watchman.ts

@@ -126,7 +126,7 @@ export = async function watchmanCrawl(
             ? // Use the `since` generator if we have a clock available
               {expression, fields, since: clocks.get(relativeRoot)}
             : // Otherwise use the `glob` filter
-              {expression, fields, glob};
+              {expression, fields, glob, glob_includedotfiles: true};
 
           const response = await cmd('query', root, query);
 

packages/jest-haste-map/src/index.ts

@@ -15,6 +15,7 @@ import {NodeWatcher, Watcher as SaneWatcher} from 'sane';
 import type {Config} from '@jest/types';
 import serializer from 'jest-serializer';
 import Worker from 'jest-worker';
+import {escapePathForRegex} from 'jest-regex-util';
 import {getSha1, worker} from './worker';
 import getMockName from './getMockName';
 import getPlatformExtension from './lib/getPlatformExtension';
@@ -113,6 +114,9 @@ const CHANGE_INTERVAL = 30;
 const MAX_WAIT_TIME = 240000;
 const NODE_MODULES = path.sep + 'node_modules' + path.sep;
 const PACKAGE_JSON = path.sep + 'package.json';
+const VCS_DIRECTORIES = ['.git', '.hg']
+  .map(vcs => escapePathForRegex(path.sep + vcs + path.sep))
+  .join('|');
 
 // TypeScript doesn't like us importing from outside `rootDir`, but it doesn't
 // understand `require`.
@@ -233,7 +237,6 @@ class HasteMap extends EventEmitter {
       extensions: options.extensions,
       forceNodeFilesystemAPI: !!options.forceNodeFilesystemAPI,
       hasteImplModulePath: options.hasteImplModulePath,
-      ignorePattern: options.ignorePattern,
       maxWorkers: options.maxWorkers,
       mocksPattern: options.mocksPattern
         ? new RegExp(options.mocksPattern)
@@ -250,11 +253,26 @@ class HasteMap extends EventEmitter {
       watch: !!options.watch,
     };
     this._console = options.console || global.console;
-    if (options.ignorePattern && !(options.ignorePattern instanceof RegExp)) {
-      this._console.warn(
-        'jest-haste-map: the `ignorePattern` options as a function is being ' +
-          'deprecated. Provide a RegExp instead. See https://github.com/facebook/jest/pull/4063.',
-      );
+
+    if (options.ignorePattern) {
+      if (options.ignorePattern instanceof RegExp) {
+        this._options.ignorePattern = new RegExp(
+          options.ignorePattern.source.concat('|' + VCS_DIRECTORIES),
+          options.ignorePattern.flags,
+        );
+      } else {
+        const ignorePattern = options.ignorePattern;
+        const vcsIgnoreRegExp = new RegExp(VCS_DIRECTORIES);
+        this._options.ignorePattern = (filePath: string) =>
+          vcsIgnoreRegExp.test(filePath) || ignorePattern(filePath);
+
+        this._console.warn(
+          'jest-haste-map: the `ignorePattern` options as a function is being ' +
+            'deprecated. Provide a RegExp instead. See https://github.com/facebook/jest/pull/4063.',
+        );
+      }
+    } else {
+      this._options.ignorePattern = new RegExp(VCS_DIRECTORIES);
     }
 
     const rootDirHash = createHash('md5').update(options.rootDir).digest('hex');
@@ -790,7 +808,7 @@ class HasteMap extends EventEmitter {
     const createWatcher = (root: Config.Path): Promise<Watcher> => {
       // @ts-expect-error: TODO how? "Cannot use 'new' with an expression whose type lacks a call or construct signature."
       const watcher = new Watcher(root, {
-        dot: false,
+        dot: true,
         glob: extensions.map(extension => '**/*.' + extension),
         ignored: ignorePattern,
       });

packages/jest-haste-map/tsconfig.json

@@ -5,9 +5,10 @@
     "outDir": "build"
   },
   "references": [
-    {"path": "../jest-worker"},
+    {"path": "../jest-regex-util"},
     {"path": "../jest-serializer"},
+    {"path": "../jest-types"},
     {"path": "../jest-util"},
-    {"path": "../jest-types"}
+    {"path": "../jest-worker"}
   ]
 }

yarn.lock

@@ -11220,6 +11220,7 @@ fsevents@^1.2.7:
     fb-watchman: ^2.0.0
     fsevents: ^2.1.2
     graceful-fs: ^4.2.4
+    jest-regex-util: ^26.0.0
     jest-serializer: ^26.1.0
     jest-util: ^26.1.0
     jest-worker: ^26.1.0