chore: refactor to cleanup and use only "new" jest api

Author: huafu

package.json

@@ -12,6 +12,7 @@
     "clean-build": "npm run clean && npm run build",
     "pretest": "npm run tslint && npm run clean-build",
     "test": "node scripts/tests.js",
+    "test:unit": "jest --testRegex '' --testMatch '<rootDir>/src/**/*.spec.ts'",
     "tslint": "tslint src/**/*.ts",
     "doc": "doctoc .",
     "prepublish": "npm run clean-build",
@@ -62,6 +63,7 @@
     ]
   },
   "dependencies": {
+    "closest-file-data": "^0.1.4",
     "cpx": "^1.5.0",
     "fs-extra": "6.0.1",
     "jest-config": "^23.4.1",
@@ -79,6 +81,7 @@
     "@babel/preset-env": "^7.0.0-beta.54",
     "@types/babel-core": "^6.25.5",
     "@types/es6-shim": "0.31.37",
+    "@types/flat": "^0.0.28",
     "@types/fs-extra": "5.0.4",
     "@types/jest": "^23.3.0",
     "@types/lodash": "^4.14.109",
@@ -90,6 +93,7 @@
     "cross-spawn": "latest",
     "cross-spawn-with-kill": "latest",
     "doctoc": "latest",
+    "flat": "^4.1.0",
     "husky": "^0.14.3",
     "jest": "^23.4.1",
     "lint-staged": "^7.1.2",

scripts/tests.js

@@ -41,6 +41,9 @@ function createIntegrationMock() {
 
 createIntegrationMock();
 
+// HACK: allow us to change the `startDir()` during tests
+process.env.__RUNNING_TS_JEST_TESTS = Date.now();
+
 const argv = process.argv.slice(2);
 argv.push('--no-cache');
 argv.push('--testPathPattern', '^(?!(.*watch.spec.ts$)).*');

src/index.ts

@@ -1,27 +1,17 @@
-// structure of this file heavilly inspired on:
-// https://github.com/facebook/jest/blob/master/packages/babel-jest/src/index.js
-
-import jestPreset from 'babel-preset-jest';
-import getCacheKeyForArgs from './utils/get-cache-key';
-import { TsJestContext, JestCacheKeyArguments } from './types';
+import getCacheKey from './utils/get-cache-key';
 import preprocess from './preprocess';
 
+//FIXME: options is always empty
 const createTransformer = (options?: any): jest.Transformer => {
-  const cache = Object.create(null);
-
-  options = Object.assign({}, options, {
-    compact: false,
-    plugins: (options && options.plugins) || [],
-    presets: ((options && options.presets) || []).concat([jestPreset]),
-    sourceMaps: 'both',
-  });
-  delete options.cacheDirectory;
-  delete options.filename;
-
-  const context: TsJestContext = { cache, options };
-
-  const getCacheKey = (...args: any[]) =>
-    getCacheKeyForArgs(args as JestCacheKeyArguments, context);
+  // const cache = Object.create(null);
+  // options = Object.assign({}, options, {
+  //   compact: false,
+  //   plugins: (options && options.plugins) || [],
+  //   presets: ((options && options.presets) || []).concat([jestPreset]),
+  //   sourceMaps: 'both',
+  // });
+  // delete options.cacheDirectory;
+  // delete options.filename;
 
   return {
     canInstrument: true,

src/postprocess.ts

@@ -9,36 +9,28 @@ let babel: typeof __types__babel;
 let istanbulPlugin: typeof __types__istanbulPlugin;
 let jestPreset: typeof __types__jestPreset;
 function importBabelDeps() {
-  if (babel) {
-    return;
-  }
-  babel = require('@babel/core');
-  istanbulPlugin = require('babel-plugin-istanbul').default;
-  jestPreset = require('babel-preset-jest');
+  if (babel) return; // tslint:ignore-line
+  // ensure we use the require from jest
+  babel = require.main.require('@babel/core');
+  istanbulPlugin = require.main.require('babel-plugin-istanbul').default;
+  jestPreset = require.main.require('babel-preset-jest');
 }
-import { CompilerOptions } from 'typescript';
 import {
   BabelTransformOptions,
   PostProcessHook,
   JestCacheKeyOptions,
-  TsJestConfig,
 } from './types';
 import { logOnce } from './utils/logger';
+import getTSJestConfig from './utils/get-ts-jest-config';
 
 // Function that takes the transpiled typescript and runs it through babel/whatever.
 export function postProcessCode(
-  compilerOptions: CompilerOptions,
   jestConfig: jest.ProjectConfig,
-  tsJestConfig: TsJestConfig,
   transformOptions: jest.TransformOptions,
   transpileOutput: jest.TransformedSource,
   filePath: string,
 ): jest.TransformedSource {
-  const postHook = getPostProcessHook(
-    compilerOptions,
-    jestConfig,
-    tsJestConfig,
-  );
+  const postHook = getPostProcessHook(jestConfig);
 
   return postHook(transpileOutput, filePath, jestConfig, transformOptions);
 }
@@ -89,29 +81,29 @@ function createBabelTransformer(
 }
 
 export const getPostProcessHook = (
-  tsCompilerOptions: CompilerOptions,
   jestConfig: jest.ProjectConfig,
-  tsJestConfig: TsJestConfig,
 ): PostProcessHook => {
+  const tsJestConfig = getTSJestConfig(jestConfig);
   if (tsJestConfig.skipBabel) {
     logOnce('Not using any postprocess hook.');
     // Identity function
     return input => input;
   }
 
-  const plugins = Array.from(
-    (tsJestConfig.babelConfig && tsJestConfig.babelConfig.plugins) || [],
-  );
-
+  const tsJestBabelConfig = tsJestConfig.babelConfig || {};
   const babelOptions: BabelTransformOptions = {
-    ...tsJestConfig.babelConfig,
+    ...tsJestBabelConfig,
     babelrc: tsJestConfig.useBabelrc || false,
-    plugins,
-    presets: tsJestConfig.babelConfig ? tsJestConfig.babelConfig.presets : [],
-    sourceMaps: tsJestConfig.disableSourceMapSupport !== true,
+    plugins: toArray(tsJestBabelConfig.plugins),
+    presets: toArray(tsJestBabelConfig.presets),
+    sourceMaps: !tsJestConfig.disableSourceMapSupport,
   };
 
   logOnce('Using babel with options:', babelOptions);
 
   return createBabelTransformer(babelOptions);
 };
+
+function toArray<T>(iter?: Iterable<T> | null): Array<T> {
+  return iter ? Array.from(iter) : [];
+}

src/preprocess.ts

@@ -1,17 +1,19 @@
 import { flushLogs, logOnce } from './utils/logger';
 import { postProcessCode } from './postprocess';
-import { getTSConfig, getTSJestConfig, runTsDiagnostics } from './utils';
 import { transpileTypescript } from './transpiler';
+import runTsDiagnostics from './utils/run-ts-diagnostics';
+import getTSConfig from './utils/get-ts-config';
+import getTSJestConfig from './utils/get-ts-jest-config';
 
 export default function preprocess(
   src: string,
   filePath: jest.Path,
   jestConfig: jest.ProjectConfig,
-  transformOptions: jest.TransformOptions,
+  transformOptions?: jest.TransformOptions,
 ): jest.TransformedSource | string {
   // transformOptions.instrument is a proxy for collectCoverage
   // https://github.com/kulshekhar/ts-jest/issues/201#issuecomment-300572902
-  const compilerOptions = getTSConfig(jestConfig.globals, jestConfig.rootDir);
+  const compilerOptions = getTSConfig(jestConfig);
 
   logOnce('final compilerOptions:', compilerOptions);
 
@@ -31,7 +33,7 @@ export default function preprocess(
     return src;
   }
 
-  const tsJestConfig = getTSJestConfig(jestConfig.globals);
+  const tsJestConfig = getTSJestConfig(jestConfig);
   logOnce('tsJestConfig: ', tsJestConfig);
 
   // We can potentially do this faster by using the language service.
@@ -44,21 +46,19 @@ export default function preprocess(
 
   if (tsJestConfig.ignoreCoverageForAllDecorators === true) {
     transpileOutput.code = transpileOutput.code.replace(
-      /__decorate/g,
+      /\b__decorate\b/g,
       '/* istanbul ignore next */__decorate',
     );
   }
   if (tsJestConfig.ignoreCoverageForDecorators === true) {
     transpileOutput.code = transpileOutput.code.replace(
-      /(__decorate\(\[\r?\n[^\n\r]*)\/\*\s*istanbul\s*ignore\s*decorator(.*)\*\//g,
+      /(\b__decorate\(\[\r?\n[^\n\r]*)\/\*\s*istanbul\s+ignore\s+decorator(.*)\*\//g,
       '/* istanbul ignore next$2*/$1',
     );
   }
 
   const outputText = postProcessCode(
-    compilerOptions,
     jestConfig,
-    tsJestConfig,
     transformOptions,
     transpileOutput,
     filePath,

src/types.ts

@@ -10,13 +10,6 @@ export interface TsJestContext {
   options: any;
 }
 
-export type JestCacheKeyArguments = [
-  string,
-  string,
-  string,
-  JestCacheKeyOptions
-];
-
 export interface HasteConfig {
   defaultPlatform?: string | null;
   hasteImplModulePath?: string;

src/utils/cache-file.ts

@@ -0,0 +1,38 @@
+import { join } from 'path';
+import { createHash } from 'crypto';
+import { outputFileSync } from 'fs-extra';
+import { memoize } from 'lodash';
+
+// to use the same compiled regexp object all the time
+// See https://jsperf.com/string-match-str-re/1
+const memoizedRegexp = memoize(RegExp);
+const cachedTest = (
+  reString: string | undefined | null,
+  subject: string,
+): boolean => {
+  if (reString == null) {
+    return false;
+  }
+  return memoizedRegexp(reString).test(subject);
+};
+
+const cachedMd5 = memoize((path: string) =>
+  createHash('md5')
+    .update(path)
+    .digest('hex'),
+);
+
+// FIXME: I think there is testRegexp and testMatch in Jest configugation
+// There is a default setting for that, but maybe it's defaulted from scratch
+export function cacheFile(
+  jestConfig: jest.ProjectConfig,
+  filePath: string,
+  src: string,
+): void {
+  // store transpiled code contains source map into cache, except test cases
+  if (!cachedTest(jestConfig.testRegex, filePath)) {
+    const hash = cachedMd5(filePath);
+    const outputFilePath = join(jestConfig.cacheDirectory, 'ts-jest', hash);
+    outputFileSync(outputFilePath, src);
+  }
+}

src/utils/format-diagnostics.ts

@@ -0,0 +1,16 @@
+import {
+  sys,
+  Diagnostic,
+  FormatDiagnosticsHost,
+  formatDiagnostics,
+} from 'typescript';
+
+export default function formatTsDiagnostics(errors: Diagnostic[]): string {
+  const defaultFormatHost: FormatDiagnosticsHost = {
+    getCurrentDirectory: () => sys.getCurrentDirectory(),
+    getCanonicalFileName: fileName => fileName,
+    getNewLine: () => sys.newLine,
+  };
+
+  return formatDiagnostics(errors, defaultFormatHost);
+}

src/utils/get-babel-rc.ts

@@ -1,50 +1,23 @@
-import { readFileSync, existsSync } from 'fs';
-import { dirname, join, resolve } from 'path';
+import closestFileData from 'closest-file-data';
+import { readFileSync } from 'fs';
 import {
   BABELRC_FILENAME,
   BABELRC_JS_FILENAME,
   PACKAGE_JSON,
   BABEL_CONFIG_KEY,
 } from './constants';
-import { TsJestContext } from '../types';
+import { BabelTransformOptions } from '../types';
 
-// ideally we'd get that from babel-jest if it was exported,
-// this is a pure translation from js
-export default function getBabelRC(filename, { cache }: TsJestContext) {
-  const paths = [];
-  let directory = filename;
-  // tslint:disable-next-line:no-conditional-assignment
-  while (directory !== (directory = dirname(directory))) {
-    if (cache[directory]) {
-      break;
-    }
+const babelReaders = [
+  {
+    basename: BABELRC_FILENAME,
+    read: f => JSON.parse(readFileSync(f, 'utf8')),
+  },
+  { basename: BABELRC_JS_FILENAME, read: f => require(f) },
+  { basename: PACKAGE_JSON, read: f => require(f)[BABEL_CONFIG_KEY] },
+];
 
-    paths.push(directory);
-    const configFilePath = join(directory, BABELRC_FILENAME);
-    if (existsSync(configFilePath)) {
-      cache[directory] = readFileSync(configFilePath, 'utf8');
-      break;
-    }
-    const configJsFilePath = join(directory, BABELRC_JS_FILENAME);
-    if (existsSync(configJsFilePath)) {
-      cache[directory] = JSON.stringify(require(configJsFilePath));
-      break;
-    }
-    const resolvedJsonFilePath = join(directory, PACKAGE_JSON);
-    const packageJsonFilePath =
-      resolvedJsonFilePath === PACKAGE_JSON
-        ? resolve(directory, PACKAGE_JSON)
-        : resolvedJsonFilePath;
-    if (existsSync(packageJsonFilePath)) {
-      const packageJsonFileContents = require(packageJsonFilePath);
-      if (packageJsonFileContents[BABEL_CONFIG_KEY]) {
-        cache[directory] = JSON.stringify(
-          packageJsonFileContents[BABEL_CONFIG_KEY],
-        );
-        break;
-      }
-    }
-  }
-  paths.forEach(directoryPath => (cache[directoryPath] = cache[directory]));
-  return cache[directory] || '';
+export default function getBabelRC(filename): babel.BabylonOptions | void {
+  const res = closestFileData(filename, babelReaders);
+  return res && res.data;
 }