[WIP] Remove usage of retainLines

.babelrc

@@ -8,6 +8,5 @@
     "transform-async-to-generator",
     "transform-strict-mode",
     ["transform-es2015-modules-commonjs", {"allowTopLevelThis": true}]
-  ],
-  "retainLines": true
+  ]
 }

CHANGELOG.md

@@ -11,6 +11,8 @@
   ([#5560](https://github.com/facebook/jest/pull/5560))
 * `[jest-config]` Make it possible to merge `transform` option with preset
   ([#5505](https://github.com/facebook/jest/pull/5505))
+* `[babel-jest]` Remove `retainLines` argument to babel.
+  ([#5594](https://github.com/facebook/jest/pull/5594))
 
 ### Features
 

integration-tests/__tests__/__snapshots__/failures.test.js.snap

@@ -118,7 +118,7 @@ exports[`works with async failures 1`] = `
     +   \\"foo\\": \\"bar\\",
       }
 
-      at ../../packages/expect/build/index.js:145:57
+      at ../../packages/expect/build/index.js:104:76
 
 "
 `;

integration-tests/__tests__/location_in_results.test.js

@@ -28,6 +28,6 @@ it('adds correct location info when provided with flag', () => {
   const assertions = result.testResults[0].assertionResults;
   expect(result.success).toBe(true);
   expect(result.numTotalTests).toBe(2);
-  expect(assertions[0].location).toEqual({column: 1, line: 9});
-  expect(assertions[1].location).toEqual({column: 3, line: 14});
+  expect(assertions[0].location).toEqual({column: 1, line: 10});
+  expect(assertions[1].location).toEqual({column: 2, line: 15});
 });

integration-tests/location-in-results/__tests__/test.js

@@ -4,7 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-'use strict';
+// This file is missing 'use strict' to force babel into doing something
+// as we have `transform-strict-mode`
 
 it('no ancestors', () => {
   expect(true).toBeTruthy();

packages/babel-jest/src/index.js

@@ -74,7 +74,6 @@ const createTransformer = (options: any): Transformer => {
   options = Object.assign({}, options, {
     plugins: (options && options.plugins) || [],
     presets: ((options && options.presets) || []).concat([jestPreset]),
-    retainLines: true,
     sourceMaps: 'both',
   });
   delete options.cacheDirectory;

packages/jest-jasmine2/package.json

@@ -8,7 +8,6 @@
   "license": "MIT",
   "main": "build/index.js",
   "dependencies": {
-    "callsites": "^2.0.0",
     "chalk": "^2.0.1",
     "co": "^4.6.0",
     "expect": "^22.3.0",
@@ -18,6 +17,7 @@
     "jest-matcher-utils": "^22.2.0",
     "jest-message-util": "^22.2.0",
     "jest-snapshot": "^22.2.0",
+    "jest-util": "^22.3.0",
     "source-map-support": "^0.5.0"
   },
   "devDependencies": {

packages/jest-jasmine2/src/index.js

@@ -15,8 +15,7 @@ import type {TestResult} from 'types/TestResult';
 import type Runtime from 'jest-runtime';
 
 import path from 'path';
-import fs from 'fs';
-import callsites from 'callsites';
+import {getCallsite} from 'jest-util';
 import JasmineReporter from './reporter';
 import {install as jasmineAsyncInstall} from './jasmine_async';
 
@@ -51,7 +50,7 @@ async function jasmine2(
   if (config.testLocationInResults === true) {
     const originalIt = environment.global.it;
     environment.global.it = (...args) => {
-      const stack = callsites()[1];
+      const stack = getCallsite(1, runtime.getSourceMaps());
       const it = originalIt(...args);
 
       it.result.__callsite = stack;
@@ -125,12 +124,11 @@ async function jasmine2(
       environment: 'node',
       handleUncaughtExceptions: false,
       retrieveSourceMap: source => {
-        if (runtime._sourceMapRegistry[source]) {
+        const sourceMap = runtime.getSourceMapForFile(source);
+        if (sourceMap) {
           try {
             return {
-              map: JSON.parse(
-                fs.readFileSync(runtime._sourceMapRegistry[source]),
-              ),
+              map: JSON.parse(sourceMap),
               url: source,
             };
           } catch (e) {}

packages/jest-runner/src/run_test.js

@@ -74,13 +74,21 @@ async function runTestInternal(
     RuntimeClass,
   >);
 
+  let runtime = undefined;
+
   const consoleOut = globalConfig.useStderr ? process.stderr : process.stdout;
   const consoleFormatter = (type, message) =>
     getConsoleOutput(
       config.cwd,
       !!globalConfig.verbose,
       // 4 = the console call is buried 4 stack frames deep
-      BufferedConsole.write([], type, message, 4),
+      BufferedConsole.write(
+        [],
+        type,
+        message,
+        4,
+        runtime && runtime.getSourceMaps(),
+      ),
     );
 
   let testConsole;
@@ -101,7 +109,7 @@ async function runTestInternal(
   const cacheFS = {[path]: testSource};
   setGlobal(environment.global, 'console', testConsole);
 
-  const runtime = new Runtime(config, environment, resolver, cacheFS, {
+  runtime = new Runtime(config, environment, resolver, cacheFS, {
     collectCoverage: globalConfig.collectCoverage,
     collectCoverageFrom: globalConfig.collectCoverageFrom,
     collectCoverageOnlyFrom: globalConfig.collectCoverageOnlyFrom,

packages/jest-runtime/src/index.js

@@ -15,6 +15,7 @@ import type {Context} from 'types/Context';
 import type {Jest, LocalModuleRequire} from 'types/Jest';
 import type {ModuleMap} from 'jest-haste-map';
 import type {MockFunctionMetadata, ModuleMocker} from 'types/Mock';
+import type {SourceMapRegistry} from 'types/SourceMaps';
 
 import path from 'path';
 import HasteMap from 'jest-haste-map';
@@ -100,7 +101,7 @@ class Runtime {
   _shouldAutoMock: boolean;
   _shouldMockModuleCache: BooleanObject;
   _shouldUnmockTransitiveDependenciesCache: BooleanObject;
-  _sourceMapRegistry: {[key: string]: string, __proto__: null};
+  _sourceMapRegistry: SourceMapRegistry;
   _scriptTransformer: ScriptTransformer;
   _transitiveShouldMock: BooleanObject;
   _unmockList: ?RegExp;
@@ -449,6 +450,21 @@ class Runtime {
     }, {});
   }
 
+  getSourceMapForFile(filename: string): ?string {
+    const sourceMap = this._sourceMapRegistry[filename];
+
+    try {
+      return fs.readFileSync(sourceMap, 'utf8');
+    } catch (e) {
+      // ignore
+    }
+    return null;
+  }
+
+  getSourceMaps(): SourceMapRegistry {
+    return this._sourceMapRegistry;
+  }
+
   setMock(
     from: string,
     moduleName: string,

packages/jest-util/package.json

@@ -13,7 +13,8 @@
     "graceful-fs": "^4.1.11",
     "is-ci": "^1.0.10",
     "jest-message-util": "^22.2.0",
-    "mkdirp": "^0.5.1"
+    "mkdirp": "^0.5.1",
+    "source-map": "^0.6.0"
   },
   "devDependencies": {
     "jest-mock": "^22.2.0"

packages/jest-util/src/buffered_console.js

@@ -15,10 +15,12 @@ import type {
   LogTimers,
 } from 'types/Console';
 
+import type {SourceMapRegistry} from 'types/SourceMaps';
+
 import {Console} from 'console';
 import {format} from 'util';
 import chalk from 'chalk';
-import callsites from 'callsites';
+import getCallsite from './get_callsite';
 
 export default class BufferedConsole extends Console {
   _buffer: ConsoleBuffer;
@@ -40,9 +42,10 @@ export default class BufferedConsole extends Console {
     type: LogType,
     message: LogMessage,
     level: ?number,
+    sourceMaps: ?SourceMapRegistry,
   ) {
-    const call = callsites()[level != null ? level : 2];
-    const origin = call.getFileName() + ':' + call.getLineNumber();
+    const callsite = getCallsite(level != null ? level : 2, sourceMaps);
+    const origin = callsite.getFileName() + ':' + callsite.getLineNumber();
 
     buffer.push({
       message,

packages/jest-util/src/get_callsite.js

@@ -0,0 +1,61 @@
+import type {SourceMapRegistry} from 'types/SourceMaps';
+
+import fs from 'fs';
+import callsites from 'callsites';
+import {SourceMapConsumer} from 'source-map';
+
+// Copied from https://github.com/rexxars/sourcemap-decorate-callsites/blob/5b9735a156964973a75dc62fd2c7f0c1975458e8/lib/index.js#L113-L158
+const addSourceMapConsumer = (callsite, consumer) => {
+  try {
+    const getLineNumber = callsite.getLineNumber;
+    const getColumnNumber = callsite.getColumnNumber;
+    let position = null;
+
+    function getPosition() {
+      if (!position) {
+        position = consumer.originalPositionFor({
+          column: getColumnNumber.call(callsite),
+          line: getLineNumber.call(callsite),
+        });
+      }
+
+      return position;
+    }
+
+    Object.defineProperties(callsite, {
+      getColumnNumber: {
+        value() {
+          return getPosition().column || getColumnNumber.call(callsite);
+        },
+        writable: false,
+      },
+      getLineNumber: {
+        value() {
+          return getPosition().line || getLineNumber.call(callsite);
+        },
+        writable: false,
+      },
+    });
+  } catch (e) {
+    // ignored
+  }
+};
+
+export default (level: number, sourceMaps: SourceMapRegistry) => {
+  const levelAfterThisCall = level + 1;
+  const stack = callsites()[levelAfterThisCall];
+  const sourceMapFileName = sourceMaps && sourceMaps[stack.getFileName()];
+
+  try {
+    if (sourceMapFileName) {
+      const sourceMap = fs.readFileSync(sourceMapFileName, 'utf8');
+      if (sourceMap) {
+        addSourceMapConsumer(stack, new SourceMapConsumer(sourceMap));
+      }
+    }
+
+    return stack;
+  } catch (e) {
+    return null;
+  }
+};

packages/jest-util/src/index.js

@@ -19,6 +19,7 @@ import getConsoleOutput from './get_console_output';
 import installCommonGlobals from './install_common_globals';
 import NullConsole from './null_console';
 import isInteractive from './is_interative';
+import getCallsite from './get_callsite';
 import setGlobal from './set_global';
 import deepCyclicCopy from './deep_cyclic_copy';
 
@@ -41,6 +42,7 @@ module.exports = {
   createDirectory,
   deepCyclicCopy,
   formatTestResults,
+  getCallsite,
   getConsoleOutput,
   getFailedSnapshotTests,
   installCommonGlobals,

types/SourceMaps.js

@@ -0,0 +1,10 @@
+/**
+ * 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
+ */
+
+export type SourceMapRegistry = {[key: string]: string, __proto__: null};