Re-inject native Node modules (#4970)

* Re-inject native Node modules

* Fix jest-editor-support test

* Addressed feedback

* Update index.js

integration_tests/__tests__/leak_detection.test.js

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ *
+ * @flow
+ */
+'use strict';
+
+const runJest = require('../runJest');
+
+it('Makes sure that Jest does not leak the environment', () => {
+  const result = runJest.json('leak-detection', ['--detectLeaks']).json;
+
+  expect(result.success).toBe(true);
+});

integration_tests/__tests__/require_all_modules.test.js

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ *
+ * @flow
+ */
+'use strict';
+
+const runJest = require('../runJest');
+
+it('Makes sure that no native module makes Jest crash', () => {
+  const result = runJest.json('require-all-modules').json;
+
+  if (!result.success) {
+    console.warn(result);
+  }
+
+  expect(result.success).toBe(true);
+});

integration_tests/leak-detection/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

integration_tests/leak-detection/test.js

@@ -0,0 +1,27 @@
+/**
+ * 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 fs = require('fs');
+const http = require('http');
+
+it('expands a native module', () => {
+  fs.expandingNativeObject = () => {
+    console.log(global);
+  };
+});
+
+it('expands the prototype of a native constructor', () => {
+  http.ServerResponse.prototype.expandingNativePrototype = () => {
+    console.log(global);
+  };
+});
+
+it('adds listeners to process', () => {
+  process.on('foo', () => {
+    console.log(global);
+  });
+});

integration_tests/require-all-modules/package.json

@@ -0,0 +1,5 @@
+{
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

integration_tests/require-all-modules/test.js

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+
+it('requires all native modules to check they all work', () => {
+  const modules = Object.keys(process.binding('natives')).filter(module =>
+    /^[^_][^\/]*$/.test(module)
+  );
+
+  // Node 6 has 34 native modules; so the total value has to be >= than 34.
+  expect(modules.length).not.toBeLessThan(34);
+
+  // Require all modules to verify they don't throw.
+  modules.forEach(module => require(module));
+});

jest-inspect

@@ -0,0 +1,9 @@
+#!/usr/bin/env node --inspect-brk
+/**
+ * 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.
+ */
+
+require('./packages/jest-cli/bin/jest');

packages/jest-editor-support/src/__tests__/runner.test.js

@@ -15,6 +15,10 @@ const {readFileSync} = require('fs');
 const fixtures = path.resolve(__dirname, '../../../../fixtures');
 import ProjectWorkspace from '../project_workspace';
 
+// Win32 requires to spawn a process to kill the first one, by using "taskkill".
+// Mocking "child_process" avoids the async spawn.
+jest.mock('child_process');
+
 // Replace `readFile` with `readFileSync` so we don't get multiple threads
 jest.doMock('fs', () => {
   return {

packages/jest-jasmine2/src/index.js

@@ -25,10 +25,17 @@ const JASMINE = require.resolve('./jasmine/jasmine_light.js');
 async function jasmine2(
   globalConfig: GlobalConfig,
   config: ProjectConfig,
-  environment: Environment,
+  environment: ?Environment,
   runtime: Runtime,
   testPath: string,
 ): Promise<TestResult> {
+  // The "environment" parameter is nullable just so that we can clean its
+  // reference after adding some variables to it; but you still need to pass
+  // it when calling "jasmine2".
+  if (!environment) {
+    throw new ReferenceError('Please pass a valid Jest Environment object');
+  }
+
   const reporter = new JasmineReporter(
     globalConfig,
     config,
@@ -85,12 +92,17 @@ async function jasmine2(
     if (config.resetMocks) {
       runtime.resetAllMocks();
 
-      if (config.timers === 'fake') {
+      if (environment && config.timers === 'fake') {
         environment.fakeTimers.useFakeTimers();
       }
     }
   });
 
+  // Free references to environment to avoid leaks.
+  env.afterAll(() => {
+    environment = null;
+  });
+
   env.addReporter(reporter);
 
   runtime
@@ -114,7 +126,9 @@ async function jasmine2(
 
   if (config.setupTestFramework && config.setupTestFramework.length) {
     config.setupTestFramework.forEach(module => {
-      require(module)(environment.global);
+      if (environment) {
+        require(module)(environment.global);
+      }
     });
   }
 

packages/jest-message-util/src/index.js

@@ -40,6 +40,8 @@ type StackTraceOptions = {
 // filter for noisy stack trace lines
 const JASMINE_IGNORE = /^\s+at(?:(?:.*?vendor\/|jasmine\-)|\s+jasmine\.buildExpectationResult)/;
 const JEST_INTERNALS_IGNORE = /^\s+at.*?jest(-.*?)?(\/|\\)(build|node_modules|packages)(\/|\\)/;
+
+const JEST_NODE_NATIVE_IGNORE = /^\s+at.*?jest-node-native-/;
 const ANONYMOUS_FN_IGNORE = /^\s+at <anonymous>.*$/;
 const ANONYMOUS_PROMISE_IGNORE = /^\s+at (new )?Promise \(<anonymous>\).*$/;
 const ANONYMOUS_GENERATOR_IGNORE = /^\s+at Generator.next \(<anonymous>\).*$/;
@@ -138,6 +140,10 @@ const removeInternalStackEntries = (lines, options: StackTraceOptions) => {
       return false;
     }
 
+    if (JEST_NODE_NATIVE_IGNORE.test(line)) {
+      return false;
+    }
+
     if (!STACK_PATH_REGEXP.test(line)) {
       return true;
     }

packages/jest-runner/src/run_test.js

@@ -74,7 +74,8 @@ async function runTestInternal(
     RuntimeClass,
   >);
 
-  const environment = new TestEnvironment(config);
+  let environment = new TestEnvironment(config);
+
   const leakDetector = config.detectLeaks
     ? new LeakDetector(environment)
     : null;
@@ -98,15 +99,24 @@ async function runTestInternal(
     testConsole = new BufferedConsole();
   }
 
-  const cacheFS = {[path]: testSource};
+  let cacheFS = {[path]: testSource};
   setGlobal(environment.global, 'console', testConsole);
 
-  const runtime = new Runtime(config, environment, resolver, cacheFS, {
+  const coverageOptions = {
     collectCoverage: globalConfig.collectCoverage,
     collectCoverageFrom: globalConfig.collectCoverageFrom,
     collectCoverageOnlyFrom: globalConfig.collectCoverageOnlyFrom,
     mapCoverage: globalConfig.mapCoverage,
-  });
+  };
+
+  let runtime = new Runtime(
+    config,
+    environment,
+    resolver,
+    cacheFS,
+    coverageOptions,
+    path,
+  );
 
   const start = Date.now();
   await environment.setup();
@@ -129,19 +139,23 @@ async function runTestInternal(
     result.skipped = testCount === result.numPendingTests;
     result.displayName = config.displayName;
 
-    if (globalConfig.logHeapUsage) {
-      if (global.gc) {
-        global.gc();
-      }
-      result.memoryUsage = process.memoryUsage().heapUsed;
-    }
-
     // Delay the resolution to allow log messages to be output.
     return new Promise(resolve => {
       setImmediate(() => resolve({leakDetector, result}));
     });
   } finally {
-    await environment.teardown();
+    if (environment.teardown) {
+      await environment.teardown();
+    }
+
+    if (runtime.reset) {
+      await runtime.reset();
+    }
+
+    // Free references to environment to avoid leaks.
+    cacheFS = null;
+    environment = null;
+    runtime = null;
   }
 }
 
@@ -158,6 +172,11 @@ export default async function runTest(
     resolver,
   );
 
+  if (globalConfig.logHeapUsage) {
+    global.gc && global.gc();
+    result.memoryUsage = process.memoryUsage().heapUsed;
+  }
+
   // Resolve leak detector, outside the "runTestInternal" closure.
   result.leaks = leakDetector ? leakDetector.isLeaking() : false;