Add option testSequencer allow user use custom sequencer.

CHANGELOG.md

@@ -9,6 +9,11 @@
 - `[jest-runner]` Support default exports for test environments ([#8163](https://github.com/facebook/jest/pull/8163))
 - `[pretty-format]` Support React.Suspense ([#8180](https://github.com/facebook/jest/pull/8180))
 - `[jest-snapshot]` Indent inline snapshots ([#8198](https://github.com/facebook/jest/pull/8198))
+- `[@jest/core]` Move `testSequencer` to individual package `@jest/test-sequencer` ([#8223](https://github.com/facebook/jest/pull/8223))
+- `[@jest/test-sequencer]` Move `testSequencer` to individual package `@jest/test-sequencer` ([#8223](https://github.com/facebook/jest/pull/8223))
+- `[@jest/core]` Add option `testSequencer` allow user use custom sequencer. ([#8223](https://github.com/facebook/jest/pull/8223))
+- `[jest-config]` Add option `testSequencer` allow user use custom sequencer. ([#8223](https://github.com/facebook/jest/pull/8223))
+- `[jest-cli]` Add option `testSequencer` allow user use custom sequencer. ([#8223](https://github.com/facebook/jest/pull/8223))
 
 ### Fixes
 

e2e/__tests__/__snapshots__/showConfig.test.ts.snap

@@ -117,6 +117,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
     "testFailureExitCode": 1,
     "testPathPattern": "",
     "testResultsProcessor": null,
+    "testSequencer": "@jest/test-sequencer",
     "updateSnapshot": "all",
     "useStderr": false,
     "verbose": null,

e2e/__tests__/customTestSequencers.test.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+
+import path from 'path';
+import runJest from '../runJest';
+import {extractSummary} from '../Utils';
+const dir = path.resolve(__dirname, '../custom-test-sequencer');
+
+expect.extend({
+  toBeIn(received, arr) {
+    const isIn = arr.includes(received);
+    if (isIn)
+      return {
+        message: `expect ${received} not to be in [${arr.join(', ')}]`,
+        pass: true,
+      };
+    else
+      return {
+        message: `expect ${received} to be in [${arr.join(', ')}]`,
+        pass: false,
+      };
+  },
+});
+
+test('run prioritySequence first', () => {
+  const result = runJest(dir, ['-i']);
+  expect(result.status).toBe(0);
+  const sequence = extractSummary(result.stderr)
+    .rest.replace(/PASS /g, '')
+    .split('\n');
+  expect(sequence).toEqual([
+    './d.test.js',
+    './b.test.js',
+    './c.test.js',
+    expect.toBeIn(['./a.test.js', './e.test.js']),
+    expect.toBeIn(['./a.test.js', './e.test.js']),
+  ]);
+});

e2e/custom-test-sequencer/a.test.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+test('a', () => {});

e2e/custom-test-sequencer/b.test.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+test('b', () => {});

e2e/custom-test-sequencer/c.test.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+test('c', () => {});

e2e/custom-test-sequencer/d.test.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+test('d', () => {});

e2e/custom-test-sequencer/e.test.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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.
+ */
+test('e', () => {});

e2e/custom-test-sequencer/package.json

@@ -0,0 +1,6 @@
+{
+  "jest": {
+    "testEnvironment": "node",
+    "testSequencer": "<rootDir>/testSequencer.js"
+  }
+}

e2e/custom-test-sequencer/testSequencer.js

@@ -0,0 +1,107 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. 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 path = require('path');
+const {getCacheFilePath} = require('../../packages/jest-haste-map/build');
+
+const priorityOrder = [
+  path.resolve('./d.test.js'),
+  path.resolve('./b.test.js'),
+  path.resolve('./c.test.js'),
+];
+const FAIL = 0;
+const SUCCESS = 1;
+
+class TestSequencer {
+  constructor() {
+    this._cache = new Map();
+  }
+  _getCachePath(context) {
+    const {config} = context;
+    return getCacheFilePath(config.cacheDirectory, 'perf-cache-' + config.name);
+  }
+
+  _getCache(test) {
+    const {context} = test;
+    if (!this._cache.has(context) && context.config.cache) {
+      const cachePath = this._getCachePath(context);
+      if (fs.existsSync(cachePath)) {
+        try {
+          this._cache.set(
+            context,
+            JSON.parse(fs.readFileSync(cachePath, 'utf8'))
+          );
+        } catch (e) {}
+      }
+    }
+
+    let cache = this._cache.get(context);
+    if (!cache) {
+      cache = {};
+      this._cache.set(context, cache);
+    }
+
+    return cache;
+  }
+
+  sort(tests) {
+    const stats = {};
+    const fileSize = ({path, context: {hasteFS}}) =>
+      stats[path] || (stats[path] = hasteFS.getSize(path) || 0);
+    const hasFailed = (cache, test) =>
+      cache[test.path] && cache[test.path][0] === FAIL;
+    const time = (cache, test) => cache[test.path] && cache[test.path][1];
+
+    tests.forEach(test => (test.duration = time(this._getCache(test), test)));
+    return tests.sort((testA, testB) => {
+      const cacheA = this._getCache(testA);
+      const cacheB = this._getCache(testB);
+      const failedA = hasFailed(cacheA, testA);
+      const failedB = hasFailed(cacheB, testB);
+      const hasTimeA = testA.duration != null;
+      const indexA = priorityOrder.indexOf(testA.path);
+      const indexB = priorityOrder.indexOf(testB.path);
+
+      if (indexA !== indexB) {
+        if (indexA === -1) return 1;
+        if (indexB === -1) return -1;
+        return indexA < indexB ? -1 : 1;
+      } else if (failedA !== failedB) {
+        return failedA ? -1 : 1;
+      } else if (hasTimeA != (testB.duration != null)) {
+        // If only one of two tests has timing information, run it last
+        return hasTimeA ? 1 : -1;
+      } else if (testA.duration != null && testB.duration != null) {
+        return testA.duration < testB.duration ? 1 : -1;
+      } else {
+        return fileSize(testA) < fileSize(testB) ? 1 : -1;
+      }
+    });
+  }
+
+  cacheResults(tests, results) {
+    const map = Object.create(null);
+    tests.forEach(test => (map[test.path] = test));
+    results.testResults.forEach(testResult => {
+      if (testResult && map[testResult.testFilePath] && !testResult.skipped) {
+        const cache = this._getCache(map[testResult.testFilePath]);
+        const perf = testResult.perfStats;
+        cache[testResult.testFilePath] = [
+          testResult.numFailingTests ? FAIL : SUCCESS,
+          perf.end - perf.start || 0,
+        ];
+      }
+    });
+
+    this._cache.forEach((cache, context) =>
+      fs.writeFileSync(this._getCachePath(context), JSON.stringify(cache))
+    );
+  }
+}
+
+module.exports = TestSequencer;

packages/jest-cli/src/cli/args.ts

@@ -615,6 +615,13 @@ export const options = {
       '`<rootDir>/path/to/testRunner.js`.',
     type: 'string' as 'string',
   },
+  testSequencer: {
+    description:
+      'Allows to specify a custom test sequencer. The default is ' +
+      '`@jest/test-sequencer`. A path to a custom test sequencer can be ' +
+      'provided: `<rootDir>/path/to/testSequencer.js`',
+    type: 'string' as 'string',
+  },
   testURL: {
     description: 'This option sets the URL for the jsdom environment.',
     type: 'string' as 'string',

packages/jest-config/src/Defaults.ts

@@ -72,6 +72,7 @@ const defaultOptions: Config.DefaultOptions = {
   testRegex: [],
   testResultsProcessor: null,
   testRunner: 'jasmine2',
+  testSequencer: '@jest/test-sequencer',
   testURL: 'http://localhost',
   timers: 'real',
   transform: null,

packages/jest-config/src/ValidConfig.ts

@@ -112,6 +112,7 @@ const initialOptions: Config.InitialOptions = {
   ),
   testResultsProcessor: 'processor-node-module',
   testRunner: 'jasmine2',
+  testSequencer: '@jest/test-sequencer',
   testURL: 'http://localhost',
   timers: 'real',
   transform: {

packages/jest-config/src/index.ts

@@ -148,6 +148,7 @@ const groupOptions = (
     testNamePattern: options.testNamePattern,
     testPathPattern: options.testPathPattern,
     testResultsProcessor: options.testResultsProcessor,
+    testSequencer: options.testSequencer,
     updateSnapshot: options.updateSnapshot,
     useStderr: options.useStderr,
     verbose: options.verbose,

packages/jest-config/src/normalize.ts

@@ -28,6 +28,7 @@ import {
   getRunner,
   getWatchPlugin,
   resolve,
+  getSequencer,
 } from './utils';
 import {DEFAULT_JS_PATTERN, DEFAULT_REPORTER_LABEL} from './constants';
 import {validateReporters} from './ReporterValidationErrors';
@@ -594,6 +595,17 @@ export default function normalize(
             });
         }
         break;
+      case 'testSequencer':
+        {
+          const option = oldOptions[key];
+          value =
+            option &&
+            getSequencer(newOptions.resolver, {
+              filePath: option,
+              rootDir: options.rootDir,
+            });
+        }
+        break;
       case 'prettierPath':
         {
           // We only want this to throw if "prettierPath" is explicitly passed

packages/jest-config/src/utils.ts

@@ -223,3 +223,15 @@ export const isJSONString = (text?: JSONString | string): text is JSONString =>
   typeof text === 'string' &&
   text.startsWith('{') &&
   text.endsWith('}');
+
+export const getSequencer = (
+  resolver: string | undefined | null,
+  {filePath, rootDir}: {filePath: string; rootDir: Config.Path},
+) =>
+  resolveWithPrefix(resolver, {
+    filePath,
+    humanOptionName: 'Jest Sequencer',
+    optionName: 'sequencer',
+    prefix: 'jest-sequencer-',
+    rootDir,
+  });

packages/jest-core/package.json

@@ -8,6 +8,7 @@
     "@jest/console": "^24.3.0",
     "@jest/reporters": "^24.5.0",
     "@jest/test-result": "^24.5.0",
+    "@jest/test-sequencer": "^24.5.0",
     "@jest/transform": "^24.5.0",
     "@jest/types": "^24.5.0",
     "ansi-escapes": "^3.0.0",

packages/jest-core/src/__tests__/run_jest.test.js

@@ -16,7 +16,7 @@ describe('runJest', () => {
     await runJest({
       changedFilesPromise: Promise.resolve({repos: {git: {size: 0}}}),
       contexts: [],
-      globalConfig: {watch: true},
+      globalConfig: {testSequencer: '@jest/test-sequencer', watch: true},
       onComplete: () => null,
       outputStream: {},
       startRun: {},

packages/jest-core/src/runJest.ts

@@ -9,7 +9,7 @@ import path from 'path';
 import chalk from 'chalk';
 import {sync as realpath} from 'realpath-native';
 import {CustomConsole} from '@jest/console';
-import {formatTestResults} from 'jest-util';
+import {formatTestResults, interopRequireDefault} from 'jest-util';
 import exit from 'exit';
 import fs from 'graceful-fs';
 import {JestHook, JestHookEmitter} from 'jest-watcher';
@@ -20,12 +20,12 @@ import {
   AggregatedResult,
   makeEmptyAggregatedTestResult,
 } from '@jest/test-result';
+import TestSequencer from '@jest/test-sequencer';
 import {ChangedFiles, ChangedFilesPromise} from 'jest-changed-files';
 import getNoTestsFoundMessage from './getNoTestsFoundMessage';
 import runGlobalHook from './runGlobalHook';
 import SearchSource from './SearchSource';
 import TestScheduler, {TestSchedulerContext} from './TestScheduler';
-import TestSequencer from './TestSequencer';
 import FailedTestsCache from './FailedTestsCache';
 import collectNodeHandles from './collectHandles';
 import TestWatcher from './TestWatcher';
@@ -143,7 +143,10 @@ export default (async function runJest({
   failedTestsCache?: FailedTestsCache;
   filter?: Filter;
 }) {
-  const sequencer = new TestSequencer();
+  const Sequencer: typeof TestSequencer = interopRequireDefault(
+    require(globalConfig.testSequencer),
+  ).default;
+  const sequencer = new Sequencer();
   let allTests: Array<Test> = [];
 
   if (changedFilesPromise && globalConfig.watch) {

packages/jest-core/tsconfig.json

@@ -17,6 +17,7 @@
     {"path": "../jest-runtime"},
     {"path": "../jest-snapshot"},
     {"path": "../jest-test-result"},
+    {"path": "../jest-test-sequencer"},
     {"path": "../jest-types"},
     {"path": "../jest-transform"},
     {"path": "../jest-util"},

packages/jest-test-sequencer/.npmignore

@@ -0,0 +1,3 @@
+**/__mocks__/**
+**/__tests__/**
+src

packages/jest-test-sequencer/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@jest/test-sequencer",
+  "version": "24.5.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/jest.git",
+    "directory": "packages/test-sequencer"
+  },
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "dependencies": {
+    "@jest/test-result": "^24.5.0",
+    "jest-haste-map": "^24.5.0",
+    "jest-runtime": "^24.5.0",
+    "jest-runner": "^24.5.0"
+  },
+  "engines": {
+    "node": ">= 6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "800533020f5b2f153615c821ed7cb12fd868fa6f"
+}

packages/jest-core/src/__tests__/test_sequencer.test.js → packages/jest-test-sequencer/src/__tests__/test_sequencer.test.js

@@ -6,7 +6,7 @@
  */
 'use strict';
 
-import TestSequencer from '../TestSequencer';
+import TestSequencer from '../index';
 
 jest.mock('fs');