Migrate jest-runner to typescript by natealcedo · Pull Request #7968 · jestjs/jest

natealcedo · 2019-02-23T17:13:53Z

This PR migrates jest-runner. I need help on some things hence opening an early PR

Heres the diff

Details

diff --git c/packages/jest-runner/build/index.js w/packages/jest-runner/build/index.js
index ab3272fb1..d9b5092bd 100644
--- c/packages/jest-runner/build/index.js
+++ w/packages/jest-runner/build/index.js
@@ -10,8 +10,6 @@ function _exit() {
   return data;
 }
 
-var _runTest = _interopRequireDefault(require('./runTest'));
-
 function _throat() {
   const data = _interopRequireDefault(require('throat'));
 
@@ -32,6 +30,10 @@ function _jestWorker() {
   return data;
 }
 
+var _runTest = _interopRequireDefault(require('./runTest'));
+
+var _testWorker = require('./testWorker');
+
 function _interopRequireDefault(obj) {
   return obj && obj.__esModule ? obj : {default: obj};
 }
diff --git c/packages/jest-runner/build/runTest.js w/packages/jest-runner/build/runTest.js
index 4d2628682..5439bd4fe 100644
--- c/packages/jest-runner/build/runTest.js
+++ w/packages/jest-runner/build/runTest.js
@@ -178,7 +178,7 @@ function _asyncToGenerator(fn) {
   };
 }
 
-function freezeConsole(testConsole, config) {
+function freezeConsole(testConsole, config) { // @ts-ignore: Correct types when `jest-util` is ESM
   testConsole._log = function fakeConsolePush(_type, message) {
     const error = new (_jestUtil()).ErrorWithStack(
       `${_chalk().default.red(
@@ -235,18 +235,15 @@ function _runTestInternal() {
         })
       );
     }
-    /* $FlowFixMe */
 
     const TestEnvironment = require(testEnvironment);
 
     const testFramework =
       process.env.JEST_CIRCUS === '1'
         ? require('jest-circus/runner') // eslint-disable-line import/no-extraneous-dependencies
-        : /* $FlowFixMe */
-          require(config.testRunner);
+        : require(config.testRunner);
     const Runtime = config.moduleLoader
-      ? /* $FlowFixMe */
-        require(config.moduleLoader)
+      ? require(config.moduleLoader)
       : require('jest-runtime');
     let runtime = undefined;
     const consoleOut = globalConfig.useStderr ? process.stderr : process.stdout;
@@ -313,7 +310,7 @@ function _runTestInternal() {
           try {
             return {
               map: JSON.parse(
-                _gracefulFs().default.readFileSync(sourceMapSource)
+                _gracefulFs().default.readFileSync(sourceMapSource, 'utf8')
               ),
               url: source
             };
@@ -413,7 +410,7 @@ function _runTestInternal() {
         );
       });
     } finally {
-      yield environment.teardown();
+      yield environment.teardown(); // @ts-ignore: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/33351
 
       _sourceMapSupport().default.resetRetrieveHandlers();
     }
diff --git c/packages/jest-runner/build/testWorker.js w/packages/jest-runner/build/testWorker.js
index 3e87b5fc2..ba8bc6c58 100644
--- c/packages/jest-runner/build/testWorker.js
+++ w/packages/jest-runner/build/testWorker.js
@@ -5,20 +5,20 @@ Object.defineProperty(exports, '__esModule', {
 });
 exports.worker = worker;
 
-function _exit() {
-  const data = _interopRequireDefault(require('exit'));
+function _jestHasteMap() {
+  const data = _interopRequireDefault(require('jest-haste-map'));
 
-  _exit = function _exit() {
+  _jestHasteMap = function _jestHasteMap() {
     return data;
   };
 
   return data;
 }
 
-function _jestHasteMap() {
-  const data = _interopRequireDefault(require('jest-haste-map'));
+function _exit() {
+  const data = _interopRequireDefault(require('exit'));
 
-  _jestHasteMap = function _jestHasteMap() {
+  _exit = function _exit() {
     return data;
   };
 
diff --git c/packages/jest-runner/build/types.js w/packages/jest-runner/build/types.js
new file mode 100644
index 000000000..ad9a93a7c
--- /dev/null
+++ w/packages/jest-runner/build/types.js
@@ -0,0 +1 @@
+'use strict';

natealcedo

Leaving some comments on the parts I need help. The test suite is failing for me locally. Can't verify if its just my machine or not. Well on the flipside, nearly there!

natealcedo · 2019-02-23T17:20:11Z


-    environment.global.process.exit = function exit(...args) {
+    (environment.global as NodeJS.Global).process.exit = function exit(
+      ...args: Array<any>


unknown doesnt work here

SimenB · 2019-02-23T19:58:29Z

Regarding your Environment woes, I've made some changes to it in #7964, not sure if that'll help or not, though 🙂

natealcedo · 2019-02-24T01:08:36Z

Just pushed some more changes. Let me know what else needs resolving

SimenB · 2019-02-24T19:25:55Z

You need to add a couple of @ts-ignores for the modules not yet migrated

SimenB · 2019-02-25T00:22:00Z

I've tweaked this a bit, I think it's pretty close now. Will review properly tomorrow 🙂

natealcedo · 2019-02-25T00:25:25Z

Hey thank you so much for the small fixes that I missed! They’re much appreciated. I’ll add in the diff and update the change log in a bit.

codecov-io · 2019-02-25T00:39:15Z

Codecov Report

❗ No coverage uploaded for pull request base (master@5d48312). Click here to learn what that means.
The diff coverage is 28.57%.

@@           Coverage Diff            @@
##             master   #7968   +/-   ##
========================================
  Coverage          ?   64.7%           
========================================
  Files             ?     256           
  Lines             ?   10051           
  Branches          ?    1497           
========================================
  Hits              ?    6504           
  Misses            ?    3223           
  Partials          ?     324

Impacted Files	Coverage Δ
packages/jest-worker/src/types.ts	`100% <ø> (ø)`
packages/jest-runner/src/runTest.ts	`2.59% <0%> (ø)`
packages/jest-runner/src/testWorker.ts	`0% <0%> (ø)`
packages/jest-runner/src/index.ts	`65.11% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5d48312...949baad. Read the comment docs.

SimenB · 2019-02-25T00:40:32Z

-  uid?: number;
-  gid?: number;
-};
+export {ForkOptions};


I love these changes 😀

natealcedo · 2019-02-25T00:43:56Z

 }

-export interface Global {
+export interface Global extends NodeJS.Global {


I didn't know this was the fix. I tried extending the global inside the declare. Cool beans.

gengjiawen · 2019-02-25T01:54:51Z

 * LICENSE file in the root directory of this source tree.
 */

+import EventEmitter from 'events';


Should this be import * as EventEmitter from 'events' ?

It's the same object

$ node -p "require('events') === require('events').EventEmitter" true

And the node docs does not destructure: https://nodejs.org/api/events.html#events_events

My concern is that events may not has a default export just like path.
import path from 'path' won't work on ts.

Fair point! Changed. Should we add "allowSyntheticDefaultImports": false to out tsconfig?

That would conflict with esModuleInterop: true. I think we need it for now, but in an ideal world in the future where everything is written in ESM we will be able to drop esModuleInterop

Anyways, this PR is not the right place to discuss it. Might be worth a new issue, though, so we do it correctly

esModuleInterop doc: "Emit __importStar and __importDefault helpers for runtime babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility"

Yeah, but that doesn't mean I can't disable it again, does it?

Might be possible to, but it seems like that would mean to forbid default-importing module.exports for type checking, but including the interop helper in output code. Because we use Babel, so our tsc does not emit anything, that would equal not enabling either of them at all, I think. And I believe we need it at least for default-importing some util libraries from npm that use module.exports =

Anyways, this PR is not the right place to discuss it. Might be worth a new issue, though, so we do it correctly

😀

This reverts commit 266a8c9.

github-actions · 2021-05-12T00:06:59Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

Alcedo Nathaniel De Guzman Jr added 12 commits February 24, 2019 01:07

Add a tsconfig

1db25d4

Rename files to .ts

7f32f83

Add a types key and import @jest/types in jest-runner

5980012

Migrate basic types in test-worker

5eaaf53

Migrate test-runner types here and add some types

1cf4620

Type runTest

f7ebefb

Update types

3298bd0

Update workerData type

2e222bd

Add jsresolve in dependencies

fb04d2a

Run eslint and remove flow declarations

fd30cc7

Add jest-core in tsconfig

c4b75ef

Add dependencies

e734a23

facebook-github-bot added the cla signed label Feb 23, 2019

natealcedo commented Feb 23, 2019

View reviewed changes

Comment thread packages/jest-runner/src/runTest.ts

SimenB reviewed Feb 23, 2019

View reviewed changes

Comment thread packages/jest-runner/src/runTest.ts Outdated

SimenB reviewed Feb 23, 2019

View reviewed changes

Comment thread packages/jest-runner/tsconfig.json Outdated

Alcedo Nathaniel De Guzman Jr added 3 commits February 24, 2019 08:50

Fix arguments for jest worker instantiation

68a88f6

Resolve comments for now

d111542

Update tsconfig

fff3691

natealcedo mentioned this pull request Feb 24, 2019

Update source-map-support to include definition for resetRetrieveHandlers DefinitelyTyped/DefinitelyTyped#33351

Merged

16 tasks

SimenB reviewed Feb 24, 2019

View reviewed changes

Comment thread packages/jest-runner/package.json Outdated

SimenB reviewed Feb 24, 2019

View reviewed changes

Comment thread packages/jest-runner/src/types.ts Outdated

SimenB added 3 commits February 25, 2019 00:00

tweaks

525783e

correct export

fb7ea5c

remove some casts and ignores

20d9d4b

reuse ForkOptions from node core instead of redefining them (wrongly)

d8ff4ea

SimenB reviewed Feb 25, 2019

View reviewed changes

natealcedo commented Feb 25, 2019

View reviewed changes

SimenB requested a review from thymikee February 25, 2019 00:45

natealcedo changed the title ~~[WIP] Migrate jest-runner to typescript~~ Migrate jest-runner to typescript Feb 25, 2019

Alcedo Nathaniel De Guzman Jr and others added 4 commits February 25, 2019 08:54

Update changelog to include info about jest-runner typescript migration

bca1d29

final type tweak

951dadc

Merge branch 'master' into migrate/jest-runner

f254cb0

i lied, one more

949baad

SimenB approved these changes Feb 25, 2019

View reviewed changes

--wip-- [skip ci]

266a8c9

gengjiawen suggested changes Feb 25, 2019

View reviewed changes

gengjiawen reviewed Feb 25, 2019

View reviewed changes

Comment thread packages/jest-runner/src/types.ts Outdated

named import

01485d4

SimenB force-pushed the migrate/jest-runner branch from 0f7b761 to 01485d4 Compare February 25, 2019 08:42

SimenB added 2 commits February 25, 2019 09:45

another named

a1e9a6b

Revert "--wip-- [skip ci]"

b926c32

This reverts commit 266a8c9.

SimenB merged commit af669ef into jestjs:master Feb 25, 2019

SimenB mentioned this pull request Feb 25, 2019

☂️TypeScript migration tracking issue #7807

Closed

SimenB added this to the TypeScript Migration milestone Feb 25, 2019

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade babel-jest from 24.0.0 to 24.9.0 jakeherp/burger-builder#14

Open

snyk-bot mentioned this pull request Mar 21, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#88

Closed

github-actions Bot locked as resolved and limited conversation to collaborators May 12, 2021

Uh oh!

Conversation

natealcedo commented Feb 23, 2019 • edited by SimenB Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

natealcedo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SimenB commented Feb 23, 2019

Uh oh!

natealcedo commented Feb 24, 2019

Uh oh!

SimenB commented Feb 24, 2019

Uh oh!

Uh oh!

Uh oh!

SimenB commented Feb 25, 2019

Uh oh!

natealcedo commented Feb 25, 2019

Uh oh!

codecov-io commented Feb 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gengjiawen Feb 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented May 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

natealcedo commented Feb 23, 2019 •

edited by SimenB

Loading

natealcedo left a comment •

edited

Loading

codecov-io commented Feb 25, 2019 •

edited

Loading

gengjiawen Feb 25, 2019 •

edited

Loading