feat: requireAndTranspileModule support ESM #11232

WeiAnAn · 2021-03-23T16:45:05Z

Summary

requireAndTranspileModule is called by importing globalSetup, globalTeardown, testRunner, runner, testEnvironment and createTranspilingRequire function.

Only createTranspilingRequire may need to import none default exporter, so I refactor requireAndTranspileModule, which now accept applyInteropRequireDefault option (default true) to determine return module itself or default. So does requireAndTranspileModule.

Breaking Change

requireAndTranspileModule always return a Promise.
createTranspilingRequire return function which return a Promise now.

Test plan

esm module e2e test
- globalSetup
- globalTeardown
- testRunner
- runner
- testEnvironment

TODO

Testing
CHANGELOG.md

jakobrosenberg · 2021-03-26T15:04:13Z

Hi, does globalSetup work with esm without this PR?

WeiAnAn · 2021-03-28T16:25:37Z

Hi, does globalSetup work with esm without this PR?

No.

codecov-io · 2021-03-28T16:33:08Z

Codecov Report

Merging #11232 (95b7825) into master (2d96526) will decrease coverage by 0.02%.
The diff coverage is 4.00%.

@@            Coverage Diff             @@
##           master   #11232      +/-   ##
==========================================
- Coverage   64.24%   64.22%   -0.03%     
==========================================
  Files         308      308              
  Lines       13499    13504       +5     
  Branches     3288     3290       +2     
==========================================
  Hits         8673     8673              
- Misses       4117     4122       +5     
  Partials      709      709

Impacted Files	Coverage Δ
packages/jest-core/src/runGlobalHook.ts	`22.72% <0.00%> (+0.98%)`	⬆️
packages/jest-runner/src/runTest.ts	`1.98% <0.00%> (ø)`
packages/jest-transform/src/ScriptTransformer.ts	`73.37% <0.00%> (-0.26%)`	⬇️
packages/jest-util/src/requireOrImportModule.ts	`0.00% <0.00%> (ø)`
packages/jest-core/src/TestScheduler.ts	`68.18% <100.00%> (ø)`

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 2d96526...95b7825. Read the comment docs.

e2e/test-environment-esm/__tests__/custom.test.js

e2e/transform/transform-esm-runner/runner.mjs

SimenB · 2021-04-01T23:11:17Z

e2e/transform/transform-esm-runner/runner.mjs

+import testResult from '@jest/test-result';
+
+const {createEmptyTestResult} = testResult;


Suggested change

import testResult from '@jest/test-result';

const {createEmptyTestResult} = testResult;

import {createEmptyTestResult} from '@jest/test-result';

does this work?

No.
Because ts will compile to common js modules, and export using Object.defineProperty with getter.
ESM named import from CJS module only support exports.name = value way. esm commonjs namespaces

CI error log

Tested. It worked.

packages/jest-transform/src/ScriptTransformer.ts

hieuhuynhdev

That looks good to me

SimenB · 2021-04-14T08:01:03Z

@WeiAnAn thanks, this looks really good! We've gotten a few PRs from first time contributors adding support for some which overlap with some you've added here. I think I'm gonna merge those even though this PR handles it a bit cleaner, then we'll need to resolve conflicts here

SimenB · 2021-04-30T08:21:01Z

Hey @WeiAnAn! Finally landed the other open PRs, so if you could rebase this that'd be awesome 👍

…OrImportModule

codecov-commenter · 2021-05-01T20:21:35Z

Codecov Report

Merging #11232 (884c7e0) into master (26cb29a) will increase coverage by 0.07%.
The diff coverage is 3.44%.

@@            Coverage Diff             @@
##           master   #11232      +/-   ##
==========================================
+ Coverage   64.10%   64.18%   +0.07%     
==========================================
  Files         308      308              
  Lines       13532    13516      -16     
  Branches     3297     3293       -4     
==========================================
  Hits         8675     8675              
+ Misses       4142     4126      -16     
  Partials      715      715

Impacted Files	Coverage Δ
packages/jest-core/src/runGlobalHook.ts	`22.72% <0.00%> (+7.10%)`	⬆️
packages/jest-runner/src/runTest.ts	`1.98% <0.00%> (+0.21%)`	⬆️
packages/jest-snapshot/src/SnapshotResolver.ts	`96.66% <ø> (ø)`
packages/jest-transform/src/ScriptTransformer.ts	`73.37% <0.00%> (-0.26%)`	⬇️
packages/jest-util/src/requireOrImportModule.ts	`0.00% <0.00%> (ø)`
packages/jest-core/src/TestScheduler.ts	`68.58% <100.00%> (ø)`

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 26cb29a...884c7e0. Read the comment docs.

SimenB

thanks! I think we can just trim the changelog a bit, and remove a test which is already covered by othe rtests

CHANGELOG.md

e2e/__tests__/esmGlobalSetup.test.ts

e2e/__tests__/esmGlobalTeardown.test.ts

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

SimenB · 2021-05-02T08:00:59Z

e2e/__tests__/globalSetup.test.ts

@@ -27,6 +27,7 @@ const customTransformDIR = path.join(
 const nodeModulesDIR = path.join(tmpdir(), 'jest-global-setup-node-modules');
 const rejectionDir = path.join(tmpdir(), 'jest-global-setup-rejection');
 const e2eDir = path.resolve(__dirname, '../global-setup');
+const esmTmpDir = path.join(tmpdir(), 'jest-global-setup-esm');


is this (and the one in teardown) used?

Yes, the directory is created in setup file.

sure, but what is that directory used for? In the test it looks like it's created and deleted but never used

GlobalSetup/Teardown will read this directory and do some assertion.
If we don't clean directory before testing, it will failed in second round.

even after 884c7e0 (#11232)?

Yes.
It fix #11267 globalSetup/globalTeardown e2e test.

Aha, gotcha!

github-actions · 2021-06-02T00:21:52Z

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.

facebook-github-bot added the cla signed label Mar 23, 2021

WeiAnAn force-pushed the require-and-transpile-module-support-esm branch from 83e9687 to e574c98 Compare March 24, 2021 16:41

WeiAnAn marked this pull request as ready for review March 24, 2021 17:18

WeiAnAn force-pushed the require-and-transpile-module-support-esm branch from ba420fc to ae4f650 Compare March 24, 2021 17:51

WeiAnAn force-pushed the require-and-transpile-module-support-esm branch 2 times, most recently from 1010a4d to e5e9f65 Compare March 28, 2021 16:17

SimenB reviewed Apr 2, 2021

View reviewed changes

hieuhuynhdev approved these changes Apr 5, 2021

View reviewed changes

nhuanhoangduc approved these changes Apr 5, 2021

View reviewed changes

WeiAnAn requested a review from SimenB April 10, 2021 14:19

SimenB mentioned this pull request Apr 30, 2021

Support ESM versions of all pluggable modules #11167

Open

16 tasks

WeiAnAn added 13 commits May 2, 2021 01:36

refactor(jest-util): add applyInteropRequireDefault option in require…

28b88d8

…OrImportModule

refactor(jest-transform): requireAndTranspileModule support ESM

adf5307

add esm runner e2e test

6469e42

move transform-esm-runner test

2ef8e02

add esm testrunner e2e test

9a394bd

add esm globalSetup e2e test

5c0f7f3

add esm globalTeardown e2e test

2f5098d

fix esm can not get cjs named export problem

409340e

update changelog

8910f9d

remove mutex in runner

99ce250

remove eslint comment

ed3b8c3

add comment on supportsDynamicImport

739a122

clean up temp dir after test

02a697a

WeiAnAn force-pushed the require-and-transpile-module-support-esm branch from fccb777 to 02a697a Compare May 1, 2021 19:48

SimenB approved these changes May 2, 2021

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

e2e/__tests__/esmGlobalSetup.test.ts Outdated Show resolved Hide resolved

e2e/__tests__/esmGlobalTeardown.test.ts Outdated Show resolved Hide resolved

WeiAnAn and others added 3 commits May 2, 2021 15:49

Remove implementation detail in CHANGELOG

7b721f1

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

Remove implementation detail in CHANGELOG

a80b820

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

remove redundant test

884c7e0

SimenB reviewed May 2, 2021

View reviewed changes

SimenB merged commit 2abd495 into jestjs:master May 2, 2021

github-actions bot locked as resolved and limited conversation to collaborators Jun 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: requireAndTranspileModule support ESM #11232

feat: requireAndTranspileModule support ESM #11232

WeiAnAn commented Mar 23, 2021 •

edited

jakobrosenberg commented Mar 26, 2021

WeiAnAn commented Mar 28, 2021

codecov-io commented Mar 28, 2021 •

edited

SimenB Apr 1, 2021

WeiAnAn Apr 4, 2021

nhuanhoangduc Apr 5, 2021

hieuhuynhdev left a comment

SimenB commented Apr 14, 2021

SimenB commented Apr 30, 2021

codecov-commenter commented May 1, 2021 •

edited

SimenB left a comment

SimenB May 2, 2021

WeiAnAn May 2, 2021

SimenB May 2, 2021

WeiAnAn May 2, 2021

SimenB May 2, 2021

WeiAnAn May 2, 2021

SimenB May 2, 2021

github-actions bot commented Jun 2, 2021

		import testResult from '@jest/test-result';

		const {createEmptyTestResult} = testResult;

feat: requireAndTranspileModule support ESM #11232

feat: requireAndTranspileModule support ESM #11232

Conversation

WeiAnAn commented Mar 23, 2021 • edited

Summary

Breaking Change

Test plan

TODO

jakobrosenberg commented Mar 26, 2021

WeiAnAn commented Mar 28, 2021

codecov-io commented Mar 28, 2021 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hieuhuynhdev left a comment

Choose a reason for hiding this comment

SimenB commented Apr 14, 2021

SimenB commented Apr 30, 2021

codecov-commenter commented May 1, 2021 • edited

Codecov Report

SimenB left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 2, 2021

WeiAnAn commented Mar 23, 2021 •

edited

codecov-io commented Mar 28, 2021 •

edited

codecov-commenter commented May 1, 2021 •

edited