TS migration jest-circus

CHANGELOG.md

@@ -52,6 +52,7 @@
 - `[docs]` Add missing import to docs ([#7928](https://github.com/facebook/jest/pull/7928))
 - `[jest-resolve-dependencies]`: Migrate to TypeScript ([#7922](https://github.com/facebook/jest/pull/7922))
 - `[expect]`: Migrate to TypeScript ([#7919](https://github.com/facebook/jest/pull/7919))
+- `[jest-circus]`: Migrate to TypeScript ([#7916](https://github.com/facebook/jest/pull/7916))
 
 ### Performance
 

packages/jest-circus/package.json

@@ -8,8 +8,11 @@
   },
   "license": "MIT",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "dependencies": {
     "@babel/traverse": "^7.1.0",
+    "@jest/types": "^24.1.0",
+    "@types/node": "*",
     "chalk": "^2.0.1",
     "co": "^4.6.0",
     "expect": "^24.1.0",
@@ -25,6 +28,7 @@
   },
   "devDependencies": {
     "@types/babel__traverse": "^7.0.4",
+    "@types/co": "^4.6.0",
     "@types/stack-utils": "^1.0.1",
     "execa": "^1.0.0",
     "jest-diff": "^24.0.0",

packages/jest-circus/src/__mocks__/testEventHandler.js → packages/jest-circus/src/__mocks__/testEventHandler.ts

@@ -4,13 +4,9 @@
  * 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.
- *
- * @flow scrict-local
  */
 
-'use strict';
-
-import type {EventHandler} from 'types/Circus';
+import {EventHandler} from '../types';
 
 const testEventHandler: EventHandler = (event, state) => {
   switch (event.name) {

packages/jest-circus/src/__mocks__/testUtils.js → packages/jest-circus/src/__mocks__/testUtils.ts

@@ -4,27 +4,29 @@
  * 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.
- *
- * @flow strict-local
  */
 
-'use strict';
-// $FlowFixMe - execa is untyped
-import {sync as spawnSync} from 'execa';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import crypto from 'crypto';
+import {sync as spawnSync, ExecaReturns} from 'execa';
+// @ts-ignore
 import {skipSuiteOnWindows} from '../../../../scripts/ConditionalTest';
 
-const CIRCUS_PATH = require.resolve('../../build/index');
+const CIRCUS_PATH = require.resolve('../../build');
 const CIRCUS_RUN_PATH = require.resolve('../../build/run');
 const CIRCUS_STATE_PATH = require.resolve('../../build/state');
 const TEST_EVENT_HANDLER_PATH = require.resolve('./testEventHandler');
 const BABEL_REGISTER_PATH = require.resolve('@babel/register');
 
 skipSuiteOnWindows();
 
+interface Result extends ExecaReturns {
+  status: number;
+  error: string;
+}
+
 export const runTest = (source: string) => {
   const filename = crypto
     .createHash('md5')
@@ -33,7 +35,7 @@ export const runTest = (source: string) => {
   const tmpFilename = path.join(os.tmpdir(), filename);
 
   const content = `
-    require('${BABEL_REGISTER_PATH}');
+    require('${BABEL_REGISTER_PATH}')({extensions: [".js", ".ts"]});
     const circus = require('${CIRCUS_PATH}');
     global.test = circus.test;
     global.describe = circus.describe;
@@ -54,7 +56,9 @@ export const runTest = (source: string) => {
   `;
 
   fs.writeFileSync(tmpFilename, content);
-  const result = spawnSync('node', [tmpFilename], {cwd: process.cwd()});
+  const result = spawnSync('node', [tmpFilename], {
+    cwd: process.cwd(),
+  }) as Result;
 
   // For compat with cross-spawn
   result.status = result.code;

packages/jest-circus/src/__tests__/afterAll.test.js → packages/jest-circus/src/__tests__/afterAll.test.ts

@@ -4,12 +4,8 @@
  * 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.
- *
- * @flow strict-local
  */
 
-'use strict';
-
 import {runTest} from '../__mocks__/testUtils';
 
 test('tests are not marked done until their parent afterAll runs', () => {

packages/jest-circus/src/__tests__/baseTest.test.js → packages/jest-circus/src/__tests__/baseTest.test.ts

@@ -4,12 +4,8 @@
  * 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.
- *
- * @flow strict-local
  */
 
-'use strict';
-
 import {runTest} from '../__mocks__/testUtils';
 
 test('simple test', () => {

packages/jest-circus/src/__tests__/circusItTestError.test.js → packages/jest-circus/src/__tests__/circusItTestError.test.ts

@@ -3,20 +3,18 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
  */
 
-'use strict';
+import {Global} from '@jest/types';
 
-let circusIt;
-let circusTest;
+let circusIt: Global.It;
+let circusTest: Global.It;
 
 // using jest-jasmine2's 'it' to test jest-circus's 'it'. Had to differentiate
 // the two with this alias.
 
 const aliasCircusIt = () => {
-  const {it, test} = require('../index.js');
+  const {it, test} = require('../');
   circusIt = it;
   circusTest = test;
 };
@@ -35,21 +33,21 @@ describe('test/it error throwing', () => {
   });
   it(`it throws error with missing callback function`, () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusIt('test2');
     }).toThrowError(
       'Missing second argument. It must be a callback function. Perhaps you want to use `test.todo` for a test placeholder.',
     );
   });
   it(`it throws an error when first argument isn't a string`, () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusIt(() => {});
     }).toThrowError('Invalid first argument, () => {}. It must be a string.');
   });
   it('it throws an error when callback function is not a function', () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusIt('test4', 'test4b');
     }).toThrowError(
       'Invalid second argument, test4b. It must be a callback function.',
@@ -62,21 +60,21 @@ describe('test/it error throwing', () => {
   });
   it(`test throws error with missing callback function`, () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusTest('test6');
     }).toThrowError(
       'Missing second argument. It must be a callback function. Perhaps you want to use `test.todo` for a test placeholder.',
     );
   });
   it(`test throws an error when first argument isn't a string`, () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusTest(() => {});
     }).toThrowError('Invalid first argument, () => {}. It must be a string.');
   });
   it('test throws an error when callback function is not a function', () => {
     expect(() => {
-      // $FlowFixMe: Easy, we're testing runtime errors here
+      // @ts-ignore: Easy, we're testing runtime errors here
       circusTest('test8', 'test8b');
     }).toThrowError(
       'Invalid second argument, test8b. It must be a callback function.',

packages/jest-circus/src/__tests__/circusItTodoTestError.test.js → packages/jest-circus/src/__tests__/circusItTodoTestError.test.ts

@@ -3,19 +3,17 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
  */
 
-'use strict';
+import {Global} from '@jest/types';
 
-let circusIt;
+let circusIt: Global.It;
 
 // using jest-jasmine2's 'it' to test jest-circus's 'it'. Had to differentiate
 // the two with this alias.
 
 const aliasCircusIt = () => {
-  const {it} = require('../index.js');
+  const {it} = require('../');
   circusIt = it;
 };
 
@@ -24,7 +22,7 @@ aliasCircusIt();
 describe('test/it.todo error throwing', () => {
   it('todo throws error when given no arguments', () => {
     expect(() => {
-      // $FlowFixMe: Testing runitme errors here
+      // @ts-ignore: Testing runtime errors here
       circusIt.todo();
     }).toThrowError('Todo must be called with only a description.');
   });
@@ -35,7 +33,7 @@ describe('test/it.todo error throwing', () => {
   });
   it('todo throws error when given none string description', () => {
     expect(() => {
-      // $FlowFixMe: Testing runitme errors here
+      // @ts-ignore: Testing runtime errors here
       circusIt.todo(() => {});
     }).toThrowError('Todo must be called with only a description.');
   });

packages/jest-circus/src/__tests__/hooks.test.js → packages/jest-circus/src/__tests__/hooks.test.ts

@@ -4,12 +4,8 @@
  * 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.
- *
- * @flow strict-local
  */
 
-'use strict';
-
 import {runTest} from '../__mocks__/testUtils';
 
 test('beforeEach is executed before each test in current/child describe blocks', () => {

packages/jest-circus/src/__tests__/hooksError.test.js → packages/jest-circus/src/__tests__/hooksError.test.ts

@@ -3,17 +3,14 @@
  *
  * 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 circus = require('../index.js');
+import circus from '../';
+import {HookType} from '../types';
 
-describe.each([['beforeEach'], ['beforeAll'], ['afterEach'], ['afterAll']])(
+describe.each(['beforeEach', 'beforeAll', 'afterEach', 'afterAll'])(
   '%s hooks error throwing',
-  fn => {
+  (fn: HookType) => {
     test.each([
       ['String'],
       [1],

packages/jest-circus/src/eventHandler.js → packages/jest-circus/src/eventHandler.ts

@@ -3,11 +3,9 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow strict-local
  */
 
-import type {EventHandler, Exception} from 'types/Circus';
+import {EventHandler, TEST_TIMEOUT_SYMBOL} from './types';
 
 import {
   addErrorToEachTestUnderDescribe,
@@ -22,9 +20,6 @@ import {
   restoreGlobalErrorHandlers,
 } from './globalErrorHandlers';
 
-// To pass this value from Runtime object to state we need to use global[sym]
-const TEST_TIMEOUT_SYMBOL = Symbol.for('TEST_TIMEOUT_SYMBOL');
-
 const eventHandler: EventHandler = (event, state): void => {
   switch (event.name) {
     case 'include_test_location_in_result': {
@@ -112,14 +107,14 @@ const eventHandler: EventHandler = (event, state): void => {
 
       if (type === 'beforeAll') {
         invariant(describeBlock, 'always present for `*All` hooks');
-        addErrorToEachTestUnderDescribe(describeBlock, error, asyncError);
+        addErrorToEachTestUnderDescribe(describeBlock!, error, asyncError);
       } else if (type === 'afterAll') {
         // Attaching `afterAll` errors to each test makes execution flow
         // too complicated, so we'll consider them to be global.
         state.unhandledErrors.push([error, asyncError]);
       } else {
         invariant(test, 'always present for `*Each` hooks');
-        test.errors.push([error, asyncError]);
+        test!.errors.push([error, asyncError]);
       }
       break;
     }
@@ -152,8 +147,7 @@ const eventHandler: EventHandler = (event, state): void => {
       break;
     }
     case 'test_retry': {
-      const errors: Array<[?Exception, Exception]> = [];
-      event.test.errors = errors;
+      event.test.errors = [];
       break;
     }
     case 'run_start': {
@@ -185,8 +179,8 @@ const eventHandler: EventHandler = (event, state): void => {
       invariant(state.originalGlobalErrorHandlers);
       invariant(state.parentProcess);
       restoreGlobalErrorHandlers(
-        state.parentProcess,
-        state.originalGlobalErrorHandlers,
+        state.parentProcess!,
+        state.originalGlobalErrorHandlers!,
       );
       break;
     }