Add concept of internal modules to jest-runtime. (#1322)

Author: cpojer

packages/jest-jasmine2/src/extendJasmineExpect.js

@@ -7,8 +7,6 @@
  */
 'use strict';
 
-jest.deepUnmock('jest-matchers');
-
 const jestExpect = require('jest-matchers').expect;
 
 const jasmineExpect = global.expect;

packages/jest-jasmine2/src/index.js

@@ -155,7 +155,7 @@ function jasmine2(
     '',
     'jest-check',
     () => {
-      const jasmineCheck = runtime.requireModule(JASMINE_CHECK_PATH);
+      const jasmineCheck = runtime.requireInternalModule(JASMINE_CHECK_PATH);
       return jasmineCheck(environment.global, config.testcheckOptions);
     },
     {virtual: true},
@@ -300,7 +300,9 @@ function jasmine2(
   // `jest-matchers` should be required inside test environment (vm).
   // Otherwise if they throw, the `Error` class will differ from the `Error`
   // class of the test and `error instanceof Error` will return `false`.
-  runtime.requireModule(path.resolve(__dirname, './extendJasmineExpect.js'));
+  runtime.requireInternalModule(
+    path.resolve(__dirname, './extendJasmineExpect.js'),
+  );
 
   runtime.requireModule(testPath);
   env.execute();

packages/jest-jasmine2/src/jasmine-check.js

@@ -7,8 +7,6 @@
  */
 'use strict';
 
-jest.unmock('jasmine-check');
-
 const jasmineCheck = require('jasmine-check');
 
 module.exports = (global, configOptions) => {

packages/jest-runtime/src/__tests__/Runtime-internalModule-test.js

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @emails oncall+jsinfra
+ */
+'use strict';
+
+const path = require('path');
+
+let createRuntime;
+
+describe('Runtime', () => {
+  beforeEach(() => {
+    createRuntime = require('createRuntime');
+  });
+
+  describe('internalModule', () => {
+    it('loads modules and applies transforms', () =>
+      createRuntime(__filename, {
+        scriptPreprocessor: './test-preprocessor',
+      }).then(runtime => {
+        const modulePath = path.resolve(
+          path.dirname(runtime.__mockRootPath),
+          'internal-root.js',
+        );
+        expect(() => {
+          runtime.requireModule(modulePath);
+        }).toThrow(new Error('preprocessor must not run.'));
+      }),
+    );
+
+    it('loads internal modules without applying transforms', () =>
+      createRuntime(__filename, {
+        scriptPreprocessor: './test-preprocessor',
+      }).then(runtime => {
+        const modulePath = path.resolve(
+          path.dirname(runtime.__mockRootPath),
+          'internal-root.js',
+        );
+        const exports = runtime.requireInternalModule(modulePath);
+        expect(exports()).toBe('internal-module-data');
+      }),
+    );
+  });
+});

packages/jest-runtime/src/__tests__/test_root/internal-module.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+'use strict';
+
+module.exports = () => 'internal-module-data';

packages/jest-runtime/src/__tests__/test_root/internal-root.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+'use strict';
+
+module.exports = require('./internal-module');

packages/jest-runtime/src/__tests__/test_root/test-preprocessor.js

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+'use strict';
+
+module.exports.process = () => `throw new Error('preprocessor must not run.');`;

packages/jest-runtime/src/index.js

@@ -38,6 +38,8 @@ type HasteMapOptions = {
   resetCache: boolean,
 };
 
+type InternalModuleOptions = {isInternalModule: boolean};
+
 const NODE_MODULES = path.sep + 'node_modules' + path.sep;
 const SNAPSHOT_EXTENSION = 'snap';
 
@@ -214,7 +216,11 @@ class Runtime {
     return require('./cli/args').options;
   }
 
-  requireModule(from: Path, moduleName?: string) {
+  requireModule(
+    from: Path,
+    moduleName?: string,
+    options: ?InternalModuleOptions,
+  ) {
     const moduleID = this._normalizeID(from, moduleName);
     let modulePath;
 
@@ -225,6 +231,7 @@ class Runtime {
     moduleResource = moduleName && this._resolver.getModule(moduleName);
     manualMockResource = moduleName && this._resolver.getMockModule(moduleName);
     if (
+      (!options || !options.isInternalModule) &&
       !moduleResource &&
       manualMockResource &&
       manualMockResource !== this._isCurrentlyExecutingManualMock &&
@@ -250,7 +257,6 @@ class Runtime {
         filename: modulePath,
         exports: {},
       };
-
       this._moduleRegistry[modulePath] = localModule;
       if (path.extname(modulePath) === '.json') {
         localModule.exports = this._environment.global.JSON.parse(
@@ -260,12 +266,16 @@ class Runtime {
         // $FlowFixMe
         localModule.exports = require(modulePath);
       } else {
-        this._execModule(localModule);
+        this._execModule(localModule, options);
       }
     }
     return this._moduleRegistry[modulePath].exports;
   }
 
+  requireInternalModule(from: Path, to?: string) {
+    return this.requireModule(from, to, {isInternalModule: true});
+  }
+
   requireMock(from: Path, moduleName: string) {
     const moduleID = this._normalizeID(from, moduleName);
 
@@ -380,28 +390,30 @@ class Runtime {
     return to ? this._resolver.resolveModule(from, to) : from;
   }
 
-  _shouldCollectCoverage(filename: Path) {
+  _shouldCollectCoverage(filename: Path): boolean {
     const collectOnlyFrom = this._config.collectCoverageOnlyFrom;
     const shouldCollectCoverage = (
       (this._config.collectCoverage && !collectOnlyFrom) ||
       (collectOnlyFrom && collectOnlyFrom[filename])
     );
-    return (
+    return !!(
       shouldCollectCoverage &&
       !this._coverageRegex.test(filename) &&
       !(this._mocksPattern && this._mocksPattern.test(filename)) &&
       !this._testRegex.test(filename)
     );
   }
 
-  _execModule(localModule: Module) {
+  _execModule(localModule: Module, options: ?InternalModuleOptions) {
     // If the environment was disposed, prevent this module from being executed.
     if (!this._environment.global) {
       return;
     }
 
     const filename = localModule.filename;
-    const shouldCollectCoverage = this._shouldCollectCoverage(filename);
+    const shouldCollectCoverage =
+      (!options || !options.isInternalModule) &&
+      this._shouldCollectCoverage(filename);
     const collectors = this._coverageCollectors;
     if (shouldCollectCoverage && !collectors[filename]) {
       collectors[filename] = new this._CoverageCollector();
@@ -418,17 +430,19 @@ class Runtime {
     localModule.children = [];
     localModule.parent = mockParentModule;
     localModule.paths = this._resolver.getModulePaths(dirname);
-    localModule.require = this._createRequireImplementation(filename);
+    localModule.require = this._createRequireImplementation(filename, options);
 
-    const script = transform(filename, this._config, {
-      instrument: shouldCollectCoverage && (
-        source => collectors[filename].getInstrumentedSource(
+    const script = transform(
+      filename,
+      options && options.isInternalModule ? null : this._config,
+      shouldCollectCoverage ? {
+        instrument: source => collectors[filename].getInstrumentedSource(
           source,
           filename,
           '$JEST',
-        )
-      ),
-    });
+        ),
+      } : null,
+    );
     const wrapper = this._runScript(script, filename);
     wrapper.call(
       localModule.exports, // module context
@@ -645,13 +659,18 @@ class Runtime {
     return this._shouldMockModuleCache[moduleID] = true;
   }
 
-  _createRequireImplementation(from: Path) {
-    const moduleRequire = this.requireModuleOrMock.bind(this, from);
-    moduleRequire.requireMock = this.requireMock.bind(this, from);
-    moduleRequire.requireActual = this.requireModule.bind(this, from);
-    moduleRequire.resolve = moduleName => this._resolveModule(from, moduleName);
+  _createRequireImplementation(
+    from: Path,
+    options: ?InternalModuleOptions,
+  ) {
+    const moduleRequire = options && options.isInternalModule
+      ? (moduleName: string) => this.requireInternalModule(from, moduleName)
+      : this.requireModuleOrMock.bind(this, from);
     moduleRequire.cache = Object.create(null);
     moduleRequire.extensions = Object.create(null);
+    moduleRequire.requireActual = this.requireModule.bind(this, from);
+    moduleRequire.requireMock = this.requireMock.bind(this, from);
+    moduleRequire.resolve = moduleName => this._resolveModule(from, moduleName);
     return moduleRequire;
   }
 

packages/jest-runtime/src/transform.js

@@ -112,7 +112,7 @@ const readCacheFile = (filePath: Path, cachePath: Path): ?string => {
 
 module.exports = (
   filename: Path,
-  config: Config,
+  config: ?Config,
   options: ?TransformOptions,
 ): vm.Script => {
   const mtime = fs.statSync(filename).mtime;
@@ -133,14 +133,15 @@ module.exports = (
     content = content.replace(/^#!.*/, '');
   }
 
-  if (!ignoreCache.has(config)) {
+  if (config && !ignoreCache.has(config)) {
     ignoreCache.set(
       config,
       new RegExp(config.preprocessorIgnorePatterns.join('|')),
     );
   }
 
   if (
+    config &&
     config.scriptPreprocessor &&
     (
       !config.preprocessorIgnorePatterns.length ||