chore: migrate jest-environment-node to TypeScript #7985

lirbank · 2019-02-25T21:09:14Z

@SimenB here is a first migration of jest-environment-node.

I can't seem to import FakeTimers via the default module export. If I do this:

import {installCommonGlobals, FakeTimers} from 'jest-util';

I get Cannot find name 'FakeTimers'.ts(2304).

However, this works (albeit not ideal):

import {installCommonGlobals} from 'jest-util';
import FakeTimers from 'jest-util/build/FakeTimers';

I think it has to do with the use of NodeJS-style export in jest-utils (instead of ES6 style export {} (no equals sign)), but not sure:

https://github.com/facebook/jest/blob/51817fd79a3744078a82861f3763dc346ca0cbd6/packages/jest-util/src/index.ts#L30-L52

How should I deal with this you think?

diff --git a/packages/jest-environment-node/build/index.js b/packages/jest-environment-node/build/index.js
index 36c28a2bc..e107def56 100644
--- a/packages/jest-environment-node/build/index.js
+++ b/packages/jest-environment-node/build/index.js
@@ -10,6 +10,16 @@ function _vm() {
   return data;
 }
 
+function _jestMock() {
+  const data = require('jest-mock');
+
+  _jestMock = function _jestMock() {
+    return data;
+  };
+
+  return data;
+}
+
 function _jestUtil() {
   const data = require('jest-util');
 
@@ -20,10 +30,10 @@ function _jestUtil() {
   return data;
 }
 
-function _jestMock() {
-  const data = _interopRequireDefault(require('jest-mock'));
+function _FakeTimers() {
+  const data = _interopRequireDefault(require('jest-util/build/FakeTimers'));
 
-  _jestMock = function _jestMock() {
+  _FakeTimers = function _FakeTimers() {
     return data;
   };
 
@@ -39,8 +49,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 class NodeEnvironment {
   constructor(config) {
@@ -65,7 +73,7 @@ class NodeEnvironment {
     }
 
     (0, _jestUtil().installCommonGlobals)(global, config.globals);
-    this.moduleMocker = new (_jestMock()).default.ModuleMocker(global);
+    this.moduleMocker = new (_jestMock()).ModuleMocker(global);
 
     const timerIdToRef = id => ({
       id,
@@ -79,13 +87,13 @@ class NodeEnvironment {
       }
     });
 
-    const timerRefToId = timer => (timer && timer.id) || null;
+    const timerRefToId = timer => (timer && timer.id) || undefined;
 
     const timerConfig = {
       idToRef: timerIdToRef,
       refToId: timerRefToId
     };
-    this.fakeTimers = new (_jestUtil()).FakeTimers({
+    this.fakeTimers = new (_FakeTimers()).default({
       config,
       global,
       moduleMocker: this.moduleMocker,

facebook-github-bot · 2019-02-25T21:09:22Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

facebook-github-bot · 2019-02-25T21:19:22Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

SimenB · 2019-02-25T22:48:26Z

Thanks @lirbank! That's the same issue I had in @jest/environment. I'll extract the fake timer into its own package, which should fix its export

EDIT: #7987

lirbank · 2019-02-26T00:10:05Z

Ok, got it! That's what you were referring to here #7964 (review) I take?

I'll wait for #7987 to be merged and then I'll finish up this PR.

SimenB · 2019-02-26T00:11:30Z

Yeah!

milesj · 2019-02-26T08:25:39Z

packages/jest-environment-node/src/index.ts

@@ -88,7 +84,7 @@ class NodeEnvironment {
  }

  // Disabling rule as return type depends on script's return type.
-  runScript(script: Script): ?any {
+  runScript(script: Script): any | null | undefined {


null | undefined is redundant since this is already any.

It shouldn't be any. This is my current best guess at the type: https://github.com/facebook/jest/blob/419661f57ea8e3af26a788bb3db92127c854d13b/packages/jest-environment/src/index.ts#L30-L32

Essentially, the return value this object: https://github.com/facebook/jest/blob/419661f57ea8e3af26a788bb3db92127c854d13b/packages/jest-transform/src/ScriptTransformer.ts#L559-L565
which is called like this: https://github.com/facebook/jest/blob/419661f57ea8e3af26a788bb3db92127c854d13b/packages/jest-runtime/src/index.ts#L689-L711

null | undefined is redundant since this is already any.

I agree, I was just trying to refactor without changing to much. I'll try to change it into a proper type instead of any.

@SimenB WRT the any type here. I've just logged what is returned from runScript() and it looks like this (in a separate app/jest setup):

{ 'Object.<anonymous>': [Function: Object.<anonymous>] }

JSON stringified it is an empty object:

'{}'

I'm not sure what to put as the return type here. I just don't have enough understanding of what is being done in the method. Just keep it as any? Or an unsealed object {} | undefined | null? Open to suggestions.

Never mind, I'll follow your diff below.

SimenB · 2019-02-26T08:39:45Z

@lirbank merged

codecov-io · 2019-02-26T08:59:13Z

Codecov Report

Merging #7985 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #7985      +/-   ##
==========================================
+ Coverage   64.54%   64.54%   +<.01%     
==========================================
  Files         257      257              
  Lines       10074    10076       +2     
  Branches     1587     1586       -1     
==========================================
+ Hits         6502     6504       +2     
- Misses       3229     3230       +1     
+ Partials      343      342       -1

Impacted Files	Coverage Δ
packages/jest-environment-jsdom/src/index.js	`39.02% <ø> (ø)`	⬆️
packages/jest-environment-node/src/index.js	`62.06% <ø> (ø)`	⬆️
packages/expect/src/jasmineUtils.ts	`76.03% <100%> (+0.82%)`	⬆️
packages/jest-fake-timers/src/jestFakeTimers.ts	`88.17% <100%> (ø)`
packages/jest-util/src/setGlobal.ts	`0% <0%> (-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 51817fd...57a3567. Read the comment docs.

SimenB · 2019-02-26T09:45:00Z

Opened up #7988 as well, which is needed here. If I rebase this branch on top of master, I can apply this diff:

diff --git i/packages/jest-environment-node/src/index.ts w/packages/jest-environment-node/src/index.ts
index 28473c6c5..3a9b5672e 100644
--- i/packages/jest-environment-node/src/index.ts
+++ w/packages/jest-environment-node/src/index.ts
@@ -9,6 +9,7 @@ import vm, {Script, Context} from 'vm';
 import {Global, Config} from '@jest/types';
 import {ModuleMocker} from 'jest-mock';
 import {installCommonGlobals} from 'jest-util';
+import {JestEnvironment} from '@jest/environment';
 import {JestFakeTimers as FakeTimers} from '@jest/fake-timers';
 
 type Timer = {
@@ -17,11 +18,11 @@ type Timer = {
   unref: () => Timer;
 };
 
-class NodeEnvironment {
-  context?: Context | null;
-  fakeTimers?: FakeTimers<Timer> | null;
-  global?: Global.Global | null;
-  moduleMocker?: ModuleMocker | null;
+class NodeEnvironment implements JestEnvironment {
+  context: Context | null;
+  fakeTimers: FakeTimers<Timer> | null;
+  global: Global.Global;
+  moduleMocker: ModuleMocker | null;
 
   constructor(config: Config.ProjectConfig) {
     this.context = vm.createContext();
@@ -70,11 +71,11 @@ class NodeEnvironment {
     });
   }
 
-  setup(): Promise<void> {
+  setup() {
     return Promise.resolve();
   }
 
-  teardown(): Promise<void> {
+  teardown() {
     if (this.fakeTimers) {
       this.fakeTimers.dispose();
     }
@@ -83,8 +84,8 @@ class NodeEnvironment {
     return Promise.resolve();
   }
 
-  // Disabling rule as return type depends on script's return type.
-  runScript(script: Script): any | null | undefined {
+  // TS infers the return type to be `any`, since that's what `runInContext` returns.
+  runScript(script: Script): ReturnType<JestEnvironment['runScript']> {
     if (this.context) {
       return script.runInContext(this.context);
     }
@@ -92,4 +93,4 @@ class NodeEnvironment {
   }
 }
 
-module.exports = NodeEnvironment;
+export = NodeEnvironment;

and everything seems to work 🙂

lirbank · 2019-02-26T18:02:20Z

@SimenB do you want NodeEnvironment to implement the JestEnvironment? I've tried it and would need to update the typings for the fakeTimers, global and moduleMocker members for it to work.

lirbank · 2019-02-26T18:05:21Z

packages/jest-environment-node/src/index.ts

@@ -60,7 +54,8 @@ class NodeEnvironment {
      },
    });

-    const timerRefToId = (timer: Timer): ?number => (timer && timer.id) || null;
+    const timerRefToId = (timer: Timer): number | undefined =>
+      (timer && timer.id) || undefined;


Please note that I've changed the possible return type from null to undefined here. FakeTimers does not like the timerConfig if timerRefToId returns null (but undefined is OK).

That's fine. Happy to get rid of the null!

SimenB · 2019-02-26T18:07:34Z

@SimenB do you want NodeEnvironment to implement the JestEnvironment? I've tried it and would need to update the typings for the fakeTimers, global and moduleMocker members for it to work.

Yes 🙂

lirbank · 2019-02-26T18:08:06Z

@SimenB

@SimenB do you want NodeEnvironment to implement the JestEnvironment? I've tried it and would need to update the typings for the fakeTimers, global and moduleMocker members for it to work.

Never mind, I see your diff above now. I'll update this PR. Just a sec.

SimenB · 2019-02-26T18:49:03Z

Thanks! Could you update the changelog and mark this PR ready for review (I'm not allowed to merge while it's a draft 🙂)?

lirbank · 2019-02-26T18:55:13Z

Updated git diff:

diff --git a/packages/jest-environment-node/build/index.js b/packages/jest-environment-node/build/index.js
index 1c59cb7b7..25d56a387 100644
--- a/packages/jest-environment-node/build/index.js
+++ b/packages/jest-environment-node/build/index.js
@@ -10,10 +10,10 @@ function _vm() {
   return data;
 }
 
-function _fakeTimers() {
-  const data = require('@jest/fake-timers');
+function _jestMock() {
+  const data = require('jest-mock');
 
-  _fakeTimers = function _fakeTimers() {
+  _jestMock = function _jestMock() {
     return data;
   };
 
@@ -30,10 +30,10 @@ function _jestUtil() {
   return data;
 }
 
-function _jestMock() {
-  const data = _interopRequireDefault(require('jest-mock'));
+function _fakeTimers() {
+  const data = require('@jest/fake-timers');
 
-  _jestMock = function _jestMock() {
+  _fakeTimers = function _fakeTimers() {
     return data;
   };
 
@@ -49,8 +49,6 @@ function _interopRequireDefault(obj) {
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- *
  */
 class NodeEnvironment {
   constructor(config) {
@@ -75,7 +73,7 @@ class NodeEnvironment {
     }
 
     (0, _jestUtil().installCommonGlobals)(global, config.globals);
-    this.moduleMocker = new (_jestMock()).default.ModuleMocker(global);
+    this.moduleMocker = new (_jestMock()).ModuleMocker(global);
 
     const timerIdToRef = id => ({
       id,
@@ -89,7 +87,7 @@ class NodeEnvironment {
       }
     });
 
-    const timerRefToId = timer => (timer && timer.id) || null;
+    const timerRefToId = timer => (timer && timer.id) || undefined;
 
     const timerConfig = {
       idToRef: timerIdToRef,
@@ -115,7 +113,8 @@ class NodeEnvironment {
     this.context = null;
     this.fakeTimers = null;
     return Promise.resolve();
-  } // Disabling rule as return type depends on script's return type.
+  } // TS infers the return type to be `any`, since that's what `runInContext`
+  // returns.
 
   runScript(script) {
     if (this.context) {

SimenB · 2019-02-26T19:40:11Z

Thanks!

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

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.

Mikael Lirbank added 3 commits February 25, 2019 09:38

Rename files

c857e4c

Migrate jest-environment-node

0cfe10b

Minor

57a3567

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

lirbank changed the title ~~Jest environment~~ jest-environment-node Feb 25, 2019

milesj reviewed Feb 26, 2019

View reviewed changes

SimenB mentioned this pull request Feb 26, 2019

chore: cleanup JestEnvironment types #7988

Merged

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

SimenB mentioned this pull request Feb 26, 2019

☂️TypeScript migration tracking issue #7807

Closed

Mikael Lirbank added 2 commits February 26, 2019 09:28

Merge branch 'master' into jest-environment

9b279a6

Use new fake timers package

2c3afe4

lirbank commented Feb 26, 2019

View reviewed changes

Implement JestEnvironment

ae3c45c

SimenB approved these changes Feb 26, 2019

View reviewed changes

lirbank marked this pull request as ready for review February 26, 2019 18:55

Update CHANGELOG.md

71048f6

lirbank changed the title ~~jest-environment-node~~ chore: migrate jest-environment-node to TypeScript Feb 26, 2019

add to tsconfigs

cc4eacb

SimenB merged commit 3bd384b into jestjs:master Feb 26, 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

This was referenced Mar 21, 2020

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

Closed

[Snyk] Upgrade jest from 24.0.0 to 24.9.0 DavidKindler/burger-builder#47

Merged

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: migrate jest-environment-node to TypeScript #7985

chore: migrate jest-environment-node to TypeScript #7985

lirbank commented Feb 25, 2019 •

edited

facebook-github-bot commented Feb 25, 2019

facebook-github-bot commented Feb 25, 2019

SimenB commented Feb 25, 2019 •

edited

lirbank commented Feb 26, 2019

SimenB commented Feb 26, 2019

milesj Feb 26, 2019

SimenB Feb 26, 2019

SimenB Feb 26, 2019

lirbank Feb 26, 2019

lirbank Feb 26, 2019

lirbank Feb 26, 2019

SimenB commented Feb 26, 2019

codecov-io commented Feb 26, 2019

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019

lirbank Feb 26, 2019

SimenB Feb 26, 2019

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019 •

edited by SimenB

SimenB commented Feb 26, 2019

github-actions bot commented May 12, 2021

chore: migrate jest-environment-node to TypeScript #7985

chore: migrate jest-environment-node to TypeScript #7985

Conversation

lirbank commented Feb 25, 2019 • edited

facebook-github-bot commented Feb 25, 2019

facebook-github-bot commented Feb 25, 2019

SimenB commented Feb 25, 2019 • edited

lirbank commented Feb 26, 2019

SimenB commented Feb 26, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Feb 26, 2019

codecov-io commented Feb 26, 2019

Codecov Report

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019

SimenB commented Feb 26, 2019

lirbank commented Feb 26, 2019 • edited by SimenB

SimenB commented Feb 26, 2019

github-actions bot commented May 12, 2021

lirbank commented Feb 25, 2019 •

edited

SimenB commented Feb 25, 2019 •

edited

lirbank commented Feb 26, 2019 •

edited by SimenB