'use strict'; var _child_process; function _load_child_process() { return _child_process = require('child_process'); } var _package; function _load_package() { return _package = require('../package.json'); } var _worker; function _load_worker() { return _worker = require('./worker'); } var _crypto; function _load_crypto() { return _crypto = _interopRequireDefault(require('crypto')); } var _events; function _load_events() { return _events = _interopRequireDefault(require('events')); } var _get_mock_name; function _load_get_mock_name() { return _get_mock_name = _interopRequireDefault(require('./get_mock_name')); } var _get_platform_extension; function _load_get_platform_extension() { return _get_platform_extension = _interopRequireDefault(require('./lib/get_platform_extension')); } var _constants; function _load_constants() { return _constants = _interopRequireDefault(require('./constants')); } var _haste_fs; function _load_haste_fs() { return _haste_fs = _interopRequireDefault(require('./haste_fs')); } var _module_map; function _load_module_map() { return _module_map = _interopRequireDefault(require('./module_map')); } var _node; function _load_node() { return _node = _interopRequireDefault(require('./crawlers/node')); } var _normalize_path_sep; function _load_normalize_path_sep() { return _normalize_path_sep = _interopRequireDefault(require('./lib/normalize_path_sep')); } var _os; function _load_os() { return _os = _interopRequireDefault(require('os')); } var _path; function _load_path() { return _path = _interopRequireDefault(require('path')); } var _sane; function _load_sane() { return _sane = _interopRequireDefault(require('sane')); } var _jestSerializer; function _load_jestSerializer() { return _jestSerializer = _interopRequireDefault(require('jest-serializer')); } var _watchman; function _load_watchman() { return _watchman = _interopRequireDefault(require('./crawlers/watchman')); } var _watchman_watcher; function _load_watchman_watcher() { return _watchman_watcher = _interopRequireDefault(require('./lib/watchman_watcher')); } var _jestWorker; function _load_jestWorker() { return _jestWorker = _interopRequireDefault(require('jest-worker')); } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } // eslint-disable-next-line import/no-duplicates // eslint-disable-next-line import/no-duplicates const CHANGE_INTERVAL = 30; // eslint-disable-next-line import/default // eslint-disable-next-line import/default /** * Copyright (c) 2014-present, Facebook, Inc. 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. * * */ const MAX_WAIT_TIME = 240000; const NODE_MODULES = (_path || _load_path()).default.sep + 'node_modules' + (_path || _load_path()).default.sep; const canUseWatchman = (() => { try { (0, (_child_process || _load_child_process()).execSync)('watchman --version', { stdio: ['ignore'] }); return true; } catch (e) {} return false; })(); const escapePathSeparator = string => (_path || _load_path()).default.sep === '\\' ? string.replace(/(\/|\\)/g, '\\\\') : string; const getWhiteList = list => { if (list && list.length) { return new RegExp('(' + escapePathSeparator(NODE_MODULES) + '(?:' + list.join('|') + ')(?=$|' + escapePathSeparator((_path || _load_path()).default.sep) + '))', 'g'); } return null; }; /** * HasteMap is a JavaScript implementation of Facebook's haste module system. * * This implementation is inspired by https://github.com/facebook/node-haste * and was built with for high-performance in large code repositories with * hundreds of thousands of files. This implementation is scalable and provides * predictable performance. * * Because the haste map creation and synchronization is critical to startup * performance and most tasks are blocked by I/O this class makes heavy use of * synchronous operations. It uses worker processes for parallelizing file * access and metadata extraction. * * The data structures created by `jest-haste-map` can be used directly from the * cache without further processing. The metadata objects in the `files` and * `map` objects contain cross-references: a metadata object from one can look * up the corresponding metadata object in the other map. Note that in most * projects, the number of files will be greater than the number of haste * modules one module can refer to many files based on platform extensions. * * type HasteMap = { * clocks: WatchmanClocks, * files: {[filepath: string]: FileMetaData}, * map: {[id: string]: ModuleMapItem}, * mocks: {[id: string]: string}, * } * * // Watchman clocks are used for query synchronization and file system deltas. * type WatchmanClocks = {[filepath: string]: string}; * * type FileMetaData = { * id: ?string, // used to look up module metadata objects in `map`. * mtime: number, // check for outdated files. * visited: boolean, // whether the file has been parsed or not. * dependencies: Array, // all relative dependencies of this file. * }; * * // Modules can be targeted to a specific platform based on the file name. * // Example: platform.ios.js and Platform.android.js will both map to the same * // `Platform` module. The platform should be specified during resolution. * type ModuleMapItem = {[platform: string]: ModuleMetaData}; * * // * type ModuleMetaData = { * path: string, // the path to look up the file object in `files`. * type: string, // the module type (either `package` or `module`). * }; * * Note that the data structures described above are conceptual only. The actual * implementation uses arrays and constant keys for metadata storage. Instead of * `{id: 'flatMap', mtime: 3421, visited: true, dependencies: []}` the real * representation is similar to `['flatMap', 3421, 1, []]` to save storage space * and reduce parse and write time of a big JSON blob. * * The HasteMap is created as follows: * 1. read data from the cache or create an empty structure. * 2. crawl the file system. * * empty cache: crawl the entire file system. * * cache available: * * if watchman is available: get file system delta changes. * * if watchman is unavailable: crawl the entire file system. * * build metadata objects for every file. This builds the `files` part of * the `HasteMap`. * 3. parse and extract metadata from changed files. * * this is done in parallel over worker processes to improve performance. * * the worst case is to parse all files. * * the best case is no file system access and retrieving all data from * the cache. * * the average case is a small number of changed files. * 4. serialize the new `HasteMap` in a cache file. * Worker processes can directly access the cache through `HasteMap.read()`. * */ class HasteMap extends (_events || _load_events()).default { constructor(options) { super(); this._options = { cacheDirectory: options.cacheDirectory || (_os || _load_os()).default.tmpdir(), extensions: options.extensions, forceNodeFilesystemAPI: !!options.forceNodeFilesystemAPI, hasteImplModulePath: options.hasteImplModulePath, ignorePattern: options.ignorePattern, maxWorkers: options.maxWorkers, mocksPattern: options.mocksPattern ? new RegExp(options.mocksPattern) : null, name: options.name, platforms: options.platforms, resetCache: options.resetCache, retainAllFiles: options.retainAllFiles, roots: Array.from(new Set(options.roots)), throwOnModuleCollision: !!options.throwOnModuleCollision, useWatchman: options.useWatchman == null ? true : options.useWatchman, watch: !!options.watch }; this._console = options.console || global.console; if (!(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.'); } this._cachePath = HasteMap.getCacheFilePath(this._options.cacheDirectory, `haste-map-${this._options.name}`, (_package || _load_package()).version, this._options.roots.join(':'), this._options.extensions.join(':'), this._options.platforms.join(':'), options.mocksPattern || '', options.ignorePattern.toString()); this._whitelist = getWhiteList(options.providesModuleNodeModules); this._buildPromise = null; this._watchers = []; this._worker = null; } static getCacheFilePath(tmpdir, name) { for (var _len = arguments.length, extra = Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) { extra[_key - 2] = arguments[_key]; } const hash = (_crypto || _load_crypto()).default.createHash('md5').update(name + extra.join('')); return (_path || _load_path()).default.join(tmpdir, name.replace(/\W/g, '-') + '-' + hash.digest('hex')); } build() { if (!this._buildPromise) { this._buildPromise = this._buildFileMap().then(data => this._buildHasteMap(data)).then(hasteMap => { this._persist(hasteMap); const hasteFS = new (_haste_fs || _load_haste_fs()).default(hasteMap.files); const moduleMap = new (_module_map || _load_module_map()).default({ duplicates: hasteMap.duplicates, map: hasteMap.map, mocks: hasteMap.mocks }); const __hasteMapForTest = process.env.NODE_ENV === 'test' && hasteMap || null; return this._watch(hasteMap, hasteFS, moduleMap).then(() => ({ __hasteMapForTest, hasteFS, moduleMap })); }); } return this._buildPromise; } /** * 1. read data from the cache or create an empty structure. */ read() { let hasteMap; try { hasteMap = (_jestSerializer || _load_jestSerializer()).default.readFileSync(this._cachePath); } catch (err) { hasteMap = this._createEmptyMap(); } for (const key in hasteMap) { Object.setPrototypeOf(hasteMap[key], null); } return hasteMap; } readModuleMap() { const data = this.read(); return new (_module_map || _load_module_map()).default({ duplicates: data.duplicates, map: data.map, mocks: data.mocks }); } /** * 2. crawl the file system. */ _buildFileMap() { const read = this._options.resetCache ? this._createEmptyMap : this.read; return Promise.resolve().then(() => read.call(this)).catch(() => this._createEmptyMap()).then(cachedHasteMap => { const cachedFiles = Object.keys(cachedHasteMap.files).map(filePath => { const moduleName = cachedHasteMap.files[filePath][(_constants || _load_constants()).default.ID]; return { moduleName, path: filePath }; }); return this._crawl(cachedHasteMap).then(hasteMap => { const deprecatedFiles = cachedFiles.filter(file => { const fileData = hasteMap.files[file.path]; return fileData == null || file.moduleName !== fileData[(_constants || _load_constants()).default.ID]; }); return { deprecatedFiles, hasteMap }; }); }); } /** * 3. parse and extract metadata from changed files. */ _processFile(hasteMap, map, mocks, filePath, workerOptions) { const setModule = (id, module) => { if (!map[id]) { // $FlowFixMe map[id] = Object.create(null); } const moduleMap = map[id]; const platform = (0, (_get_platform_extension || _load_get_platform_extension()).default)(module[(_constants || _load_constants()).default.PATH], this._options.platforms) || (_constants || _load_constants()).default.GENERIC_PLATFORM; const existingModule = moduleMap[platform]; if (existingModule && existingModule[(_constants || _load_constants()).default.PATH] !== module[(_constants || _load_constants()).default.PATH]) { const message = `jest-haste-map: @providesModule naming collision:\n` + ` Duplicate module name: ${id}\n` + ` Paths: ${module[(_constants || _load_constants()).default.PATH]} collides with ` + `${existingModule[(_constants || _load_constants()).default.PATH]}\n\nThis ` + `${this._options.throwOnModuleCollision ? 'error' : 'warning'} ` + `is caused by a @providesModule declaration ` + `with the same name across two different files.`; if (this._options.throwOnModuleCollision) { throw new Error(message); } this._console.warn(message); // We do NOT want consumers to use a module that is ambiguous. delete moduleMap[platform]; if (Object.keys(moduleMap).length === 1) { delete map[id]; } let dupsByPlatform = hasteMap.duplicates[id]; if (dupsByPlatform == null) { dupsByPlatform = hasteMap.duplicates[id] = Object.create(null); } const dups = dupsByPlatform[platform] = Object.create(null); dups[module[(_constants || _load_constants()).default.PATH]] = module[(_constants || _load_constants()).default.TYPE]; dups[existingModule[(_constants || _load_constants()).default.PATH]] = existingModule[(_constants || _load_constants()).default.TYPE]; return; } const dupsByPlatform = hasteMap.duplicates[id]; if (dupsByPlatform != null) { const dups = dupsByPlatform[platform]; if (dups != null) { dups[module[(_constants || _load_constants()).default.PATH]] = module[(_constants || _load_constants()).default.TYPE]; } return; } moduleMap[platform] = module; }; // If we retain all files in the virtual HasteFS representation, we avoid // reading them if they aren't important (node_modules). if (this._options.retainAllFiles && this._isNodeModulesDir(filePath)) { return null; } if (this._options.mocksPattern && this._options.mocksPattern.test(filePath)) { const mockPath = (0, (_get_mock_name || _load_get_mock_name()).default)(filePath); if (mocks[mockPath]) { this._console.warn(`jest-haste-map: duplicate manual mock found:\n` + ` Module name: ${mockPath}\n` + ` Duplicate Mock path: ${filePath}\nThis warning ` + `is caused by two manual mock files with the same file name.\n` + `Jest will use the mock file found in: \n` + `${filePath}\n` + ` Please delete one of the following two files: \n ` + `${mocks[mockPath]}\n${filePath}\n\n`); } mocks[mockPath] = filePath; } const fileMetadata = hasteMap.files[filePath]; const moduleMetadata = hasteMap.map[fileMetadata[(_constants || _load_constants()).default.ID]]; if (fileMetadata[(_constants || _load_constants()).default.VISITED]) { if (!fileMetadata[(_constants || _load_constants()).default.ID]) { return null; } if (moduleMetadata != null) { const platform = (0, (_get_platform_extension || _load_get_platform_extension()).default)(filePath, this._options.platforms) || (_constants || _load_constants()).default.GENERIC_PLATFORM; const module = moduleMetadata[platform]; if (module == null) { return null; } const modulesByPlatform = map[fileMetadata[(_constants || _load_constants()).default.ID]] || (map[fileMetadata[(_constants || _load_constants()).default.ID]] = {}); modulesByPlatform[platform] = module; return null; } } return this._getWorker(workerOptions).worker({ filePath, hasteImplModulePath: this._options.hasteImplModulePath }).then(metadata => { // `1` for truthy values instead of `true` to save cache space. fileMetadata[(_constants || _load_constants()).default.VISITED] = 1; const metadataId = metadata.id; const metadataModule = metadata.module; if (metadataId && metadataModule) { fileMetadata[(_constants || _load_constants()).default.ID] = metadataId; setModule(metadataId, metadataModule); } fileMetadata[(_constants || _load_constants()).default.DEPENDENCIES] = metadata.dependencies || []; }, error => { if (typeof error !== 'object' || !error.message || !error.stack) { error = new Error(error); error.stack = ''; // Remove stack for stack-less errors. } // $FlowFixMe: checking error code is OK if error comes from "fs". if (['ENOENT', 'EACCES'].indexOf(error.code) < 0) { throw error; } // If a file cannot be read we remove it from the file list and // ignore the failure silently. delete hasteMap.files[filePath]; }); } _buildHasteMap(data) { const deprecatedFiles = data.deprecatedFiles, hasteMap = data.hasteMap; const map = Object.create(null); const mocks = Object.create(null); const promises = []; for (let i = 0; i < deprecatedFiles.length; ++i) { const file = deprecatedFiles[i]; this._recoverDuplicates(hasteMap, file.path, file.moduleName); } for (const filePath in hasteMap.files) { const promise = this._processFile(hasteMap, map, mocks, filePath); if (promise) { promises.push(promise); } } return Promise.all(promises).then(() => { this._cleanup(); hasteMap.map = map; hasteMap.mocks = mocks; return hasteMap; }).catch(error => { this._cleanup(); return Promise.reject(error); }); } _cleanup() { const worker = this._worker; if (worker && typeof worker.end === 'function') { worker.end(); } this._worker = null; } /** * 4. serialize the new `HasteMap` in a cache file. */ _persist(hasteMap) { (_jestSerializer || _load_jestSerializer()).default.writeFileSync(this._cachePath, hasteMap); } /** * Creates workers or parses files and extracts metadata in-process. */ _getWorker(options) { if (!this._worker) { if (options && options.forceInBand || this._options.maxWorkers <= 1) { this._worker = { worker: (_worker || _load_worker()).worker }; } else { // $FlowFixMe: assignment of a worker with custom properties. this._worker = new (_jestWorker || _load_jestWorker()).default(require.resolve('./worker'), { exposedMethods: ['worker'], maxRetries: 3, numWorkers: this._options.maxWorkers }); } } return this._worker; } _crawl(hasteMap) { const options = this._options; const ignore = this._ignore.bind(this); const crawl = canUseWatchman && this._options.useWatchman ? (_watchman || _load_watchman()).default : (_node || _load_node()).default; const retry = error => { if (crawl === (_watchman || _load_watchman()).default) { this._console.warn(`jest-haste-map: Watchman crawl failed. Retrying once with node ` + `crawler.\n` + ` Usually this happens when watchman isn't running. Create an ` + `empty \`.watchmanconfig\` file in your project's root folder or ` + `initialize a git or hg repository in your project.\n` + ` ` + error); return (0, (_node || _load_node()).default)({ data: hasteMap, extensions: options.extensions, forceNodeFilesystemAPI: options.forceNodeFilesystemAPI, ignore, roots: options.roots }).catch(e => { throw new Error(`Crawler retry failed:\n` + ` Original error: ${error.message}\n` + ` Retry error: ${e.message}\n`); }); } throw error; }; try { return crawl({ data: hasteMap, extensions: options.extensions, forceNodeFilesystemAPI: options.forceNodeFilesystemAPI, ignore, roots: options.roots }).catch(retry); } catch (error) { return retry(error); } } /** * Watch mode */ _watch(hasteMap, hasteFS, moduleMap) { if (!this._options.watch) { return Promise.resolve(); } // In watch mode, we'll only warn about module collisions and we'll retain // all files, even changes to node_modules. this._options.throwOnModuleCollision = false; this._options.retainAllFiles = true; const Watcher = canUseWatchman && this._options.useWatchman ? (_watchman_watcher || _load_watchman_watcher()).default : (_os || _load_os()).default.platform() === 'darwin' ? (_sane || _load_sane()).default.FSEventsWatcher : (_sane || _load_sane()).default.NodeWatcher; const extensions = this._options.extensions; const ignorePattern = this._options.ignorePattern; let changeQueue = Promise.resolve(); let eventsQueue = []; // We only need to copy the entire haste map once on every "frame". let mustCopy = true; const createWatcher = root => { const watcher = new Watcher(root, { dot: false, glob: extensions.map(extension => '**/*.' + extension), ignored: ignorePattern }); return new Promise((resolve, reject) => { const rejectTimeout = setTimeout(() => reject(new Error('Failed to start watch mode.')), MAX_WAIT_TIME); watcher.once('ready', () => { clearTimeout(rejectTimeout); watcher.on('all', onChange); resolve(watcher); }); }); }; const emitChange = () => { if (eventsQueue.length) { mustCopy = true; this.emit('change', { eventsQueue, hasteFS: new (_haste_fs || _load_haste_fs()).default(hasteMap.files), moduleMap: new (_module_map || _load_module_map()).default({ duplicates: hasteMap.duplicates, map: hasteMap.map, mocks: hasteMap.mocks }) }); eventsQueue = []; } }; const onChange = (type, filePath, root, stat) => { filePath = (_path || _load_path()).default.join(root, (0, (_normalize_path_sep || _load_normalize_path_sep()).default)(filePath)); if (this._ignore(filePath) || !extensions.some(extension => filePath.endsWith(extension))) { return; } changeQueue = changeQueue.then(() => { // If we get duplicate events for the same file, ignore them. if (eventsQueue.find(event => event.type === type && event.filePath === filePath && (!event.stat && !stat || event.stat && stat && event.stat.mtime.getTime() === stat.mtime.getTime()))) { return null; } if (mustCopy) { mustCopy = false; // $FlowFixMe hasteMap = { clocks: copy(hasteMap.clocks), duplicates: copy(hasteMap.duplicates), files: copy(hasteMap.files), map: copy(hasteMap.map), mocks: copy(hasteMap.mocks) }; } const add = () => eventsQueue.push({ filePath, stat, type }); // Delete the file and all of its metadata. const moduleName = hasteMap.files[filePath] && hasteMap.files[filePath][(_constants || _load_constants()).default.ID]; const platform = (0, (_get_platform_extension || _load_get_platform_extension()).default)(filePath, this._options.platforms) || (_constants || _load_constants()).default.GENERIC_PLATFORM; delete hasteMap.files[filePath]; let moduleMap = hasteMap.map[moduleName]; if (moduleMap != null) { // We are forced to copy the object because jest-haste-map exposes // the map as an immutable entity. moduleMap = copy(moduleMap); delete moduleMap[platform]; if (Object.keys(moduleMap).length === 0) { delete hasteMap.map[moduleName]; } else { // $FlowFixMe hasteMap.map[moduleName] = moduleMap; } } if (this._options.mocksPattern && this._options.mocksPattern.test(filePath)) { const mockName = (0, (_get_mock_name || _load_get_mock_name()).default)(filePath); delete hasteMap.mocks[mockName]; } this._recoverDuplicates(hasteMap, filePath, moduleName); // If the file was added or changed, // parse it and update the haste map. if (type === 'add' || type === 'change') { const fileMetadata = ['', stat.mtime.getTime(), 0, []]; hasteMap.files[filePath] = fileMetadata; const promise = this._processFile(hasteMap, hasteMap.map, hasteMap.mocks, filePath, { forceInBand: true }); // Cleanup this._cleanup(); if (promise) { return promise.then(add); } else { // If a file in node_modules has changed, // emit an event regardless. add(); } } else { add(); } return null; }).catch(error => { this._console.error(`jest-haste-map: watch error:\n ${error.stack}\n`); }); }; this._changeInterval = setInterval(emitChange, CHANGE_INTERVAL); return Promise.all(this._options.roots.map(createWatcher)).then(watchers => { this._watchers = watchers; }); } /** * This function should be called when the file under `filePath` is removed * or changed. When that happens, we want to figure out if that file was * part of a group of files that had the same ID. If it was, we want to * remove it from the group. Furthermore, if there is only one file * remaining in the group, then we want to restore that single file as the * correct resolution for its ID, and cleanup the duplicates index. */ _recoverDuplicates(hasteMap, filePath, moduleName) { let dupsByPlatform = hasteMap.duplicates[moduleName]; if (dupsByPlatform == null) { return; } const platform = (0, (_get_platform_extension || _load_get_platform_extension()).default)(filePath, this._options.platforms) || (_constants || _load_constants()).default.GENERIC_PLATFORM; let dups = dupsByPlatform[platform]; if (dups == null) { return; } dupsByPlatform = hasteMap.duplicates[moduleName] = copy(dupsByPlatform); dups = dupsByPlatform[platform] = copy(dups); const dedupType = dups[filePath]; delete dups[filePath]; const filePaths = Object.keys(dups); if (filePaths.length > 1) { return; } let dedupMap = hasteMap.map[moduleName]; if (dedupMap == null) { dedupMap = hasteMap.map[moduleName] = Object.create(null); } dedupMap[platform] = [filePaths[0], dedupType]; delete dupsByPlatform[platform]; if (Object.keys(dupsByPlatform).length === 0) { delete hasteMap.duplicates[moduleName]; } } end() { clearInterval(this._changeInterval); if (!this._watchers.length) { return Promise.resolve(); } return Promise.all(this._watchers.map(watcher => new Promise(resolve => watcher.close(resolve)))).then(() => { this._watchers = []; }); } /** * Helpers */ _ignore(filePath) { const ignorePattern = this._options.ignorePattern; const ignoreMatched = ignorePattern instanceof RegExp ? ignorePattern.test(filePath) : ignorePattern(filePath); return ignoreMatched || !this._options.retainAllFiles && this._isNodeModulesDir(filePath); } _isNodeModulesDir(filePath) { if (!filePath.includes(NODE_MODULES)) { return false; } if (this._whitelist) { const whitelist = this._whitelist; const match = whitelist.exec(filePath); const matchEndIndex = whitelist.lastIndex; whitelist.lastIndex = 0; if (!match) { return true; } const filePathInPackage = filePath.substr(matchEndIndex); return filePathInPackage.startsWith(NODE_MODULES); } return true; } _createEmptyMap() { // $FlowFixMe return { clocks: Object.create(null), duplicates: Object.create(null), files: Object.create(null), map: Object.create(null), mocks: Object.create(null) }; } } const copy = object => Object.assign(Object.create(null), object); HasteMap.H = (_constants || _load_constants()).default; HasteMap.ModuleMap = (_module_map || _load_module_map()).default; module.exports = HasteMap;