[Feature]: add isolateModulesAsync #13680

mmanciop · 2022-12-16T22:33:22Z

Summary

Introduce jest.isolateModulesAsync, the async equivalent of jest.isolateModules. Examples of use-cases are provided in #10428.

Test plan

Unit tests added with similar coverage and structure as isolateModules.

Credits

Changes originally proposed by @dreyks in #10428.

Fixes #10428.

Introduce `jest.isolateModulesAsync`, the async equivalent of `jest.isolateModules`.

facebook-github-bot · 2022-12-16T22:33:27Z

Hi @mmanciop!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign 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 to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

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

facebook-github-bot · 2022-12-17T00:34:56Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

mrazauskas

Looks interesting. I left few comments.

packages/jest-types/__typetests__/jest.test.ts

packages/jest-runtime/src/index.ts

packages/jest-environment/src/index.ts

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

mrazauskas

It would be good to run ESLint and Prettier: yarn lint && yarn lint:prettier

If you decide to stick with fluent API idea, it needs a type test somewhere here:

https://github.com/facebook/jest/blob/41bf2300895a2c00d0525d21260f0a392819871f/packages/jest-types/__typetests__/jest.test.ts#L21-L32

packages/jest-types/__typetests__/jest.test.ts

packages/jest-environment/src/index.ts

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

mmanciop · 2022-12-19T12:32:17Z

@mrazauskas I think this may be ready for a second look :-)

mrazauskas

Thanks. Looks much better. I left few comments.

packages/jest-types/__typetests__/jest.test.ts

mrazauskas · 2022-12-19T12:40:52Z

packages/jest-runtime/src/index.ts

@@ -2226,6 +2248,7 @@ export default class Runtime {
      getTimerCount: () => _getFakeTimers().getTimerCount(),
      isMockFunction: this._moduleMocker.isMockFunction,
      isolateModules,
+      isolateModulesAsync,


Isn’t it better to simply inline:

Suggested change

isolateModulesAsync,

isolateModulesAsync: this.isolateModulesAsync,

Done in 36c138e

docs/JestObjectAPI.md

mmanciop · 2022-12-19T13:25:46Z

@mrazauskas 3rd is the charm? ;-)

mrazauskas

Thanks. I think these are last details to solve.

mrazauskas · 2022-12-19T13:29:55Z

packages/jest-types/__typetests__/jest.test.ts

@@ -98,6 +98,10 @@ expectError(jest.enableAutomock('moduleName'));
 expectType<typeof jest>(jest.isolateModules(() => {}));
 expectError(jest.isolateModules());

+expectType<Promise<void>>(jest.isolateModulesAsync(async () => {}));
+expectType<Promise<void>>(jest.isolateModulesAsync(() => {}));


Try running type tests. This assertion is currently failing. Should be:

Suggested change

expectType<Promise<void>>(jest.isolateModulesAsync(() => {}));

expectError(jest.isolateModulesAsync(() => {}));

mmm I did run it and it did not fail:

mmanciop@Micheles-MacBook-Pro jest % yarn test-types Running one project: type-tests PASS type-tests packages/expect/__typetests__/expect.test.ts PASS type-tests packages/jest-worker/__typetests__/jest-worker.test.ts PASS type-tests packages/jest-mock/__typetests__/utility-types.test.ts PASS type-tests packages/jest-mock/__typetests__/Mocked.test.ts PASS type-tests packages/jest-types/__typetests__/each.test.ts PASS type-tests packages/jest-types/__typetests__/globals.test.ts PASS type-tests packages/jest-types/__typetests__/expect.test.ts PASS type-tests packages/jest-types/__typetests__/jest.test.ts PASS type-tests packages/jest-reporters/__typetests__/jest-reporters.test.ts PASS type-tests packages/jest-resolve/__typetests__/resolver.test.ts PASS type-tests packages/jest-runner/__typetests__/jest-runner.test.ts PASS type-tests packages/jest-mock/__typetests__/mock-functions.test.ts PASS type-tests packages/jest-snapshot/__typetests__/SnapshotResolver.test.ts PASS type-tests packages/jest-snapshot/__typetests__/matchers.test.ts PASS type-tests packages/expect-utils/__typetests__/utils.test.ts PASS type-tests packages/jest-types/__typetests__/config.test.ts PASS type-tests packages/jest-expect/__typetests__/jest-expect.test.ts PASS type-tests packages/jest-mock/__typetests__/ModuleMocker.test.ts PASS type-tests packages/jest/__typetests__/jest.test.ts Test Suites: 19 passed, 19 total Tests: 1283 passed, 1283 total Snapshots: 0 total Time: 1.951 s, estimated 2 s Ran all test suites.

@mrazauskas I am not managing to replicate the type error. I must be doing something wrong here. I updated the signature as I understand you suggested, can you please check again?

The repo was not rebuild? Tests import from @jest/globals, not from src. That is why rebuilding is important after making changes in src.

docs/JestObjectAPI.md

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

mrazauskas · 2022-12-19T14:14:55Z

Thanks. The type test is passing now and the rest looks good for me.

Let’s wait for maintainers review.

mmanciop · 2022-12-19T16:43:25Z

The error in test-jest-jasmine is the same that occurs in #13675 . I don't think it is this PR introducing it.

mrazauskas · 2022-12-19T17:20:12Z

Yep. This odd "Segmentation fault" error appears from time to time. Not related with your PR for sure.

mmanciop · 2022-12-29T17:51:17Z

@SimenB @jeysal WDYT?

SimenB

thanks!

mmanciop · 2023-01-05T23:54:24Z

@SimenB do you have a timeline for the next release? I am very much looking forward to using this ;-)

SimenB · 2023-01-06T12:17:57Z

Waiting for #13375

github-actions · 2023-02-06T00:08:45Z

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.

feat: add isolateModulesAsync

c0e975e

Introduce `jest.isolateModulesAsync`, the async equivalent of `jest.isolateModules`.

mmanciop marked this pull request as draft December 16, 2022 22:33

chore: update CHANGELOG

e688b0e

facebook-github-bot added the cla signed label Dec 17, 2022

mrazauskas reviewed Dec 17, 2022

View reviewed changes

Michele Mancioppi and others added 2 commits December 19, 2022 08:02

Update packages/jest-runtime/src/index.ts

c45aaa9

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

change return type of isolateModulesAsync to returning a Promise of Jest

b53d9da

mrazauskas reviewed Dec 19, 2022

View reviewed changes

packages/jest-types/__typetests__/jest.test.ts Outdated Show resolved Hide resolved

mrazauskas reviewed Dec 19, 2022

View reviewed changes

packages/jest-environment/src/index.ts Outdated Show resolved Hide resolved

Michele Mancioppi and others added 3 commits December 19, 2022 10:31

Update packages/jest-types/__typetests__/jest.test.ts

442588b

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

change isolateModulesAsync to return Promise<void>

5810116

lint

de40383

mmanciop marked this pull request as ready for review December 19, 2022 10:47

add website docs for isolateModulesAsync

f88db2b

mmanciop force-pushed the isolateModulesAsync branch from 2cf0d73 to f88db2b Compare December 19, 2022 10:48

CircleCI added 2 commits December 19, 2022 11:53

fix unit test to accept new error message

18405a8

lint

4045eb7

mmanciop mentioned this pull request Dec 19, 2022

feature: jest.isolateModules accept an async function for dynamic import()s #10428

Closed

mrazauskas reviewed Dec 19, 2022

View reviewed changes

test sync callbacks, add docu and type test

36c138e

mrazauskas reviewed Dec 19, 2022

View reviewed changes

Michele Mancioppi and others added 2 commits December 19, 2022 14:50

Update docs/JestObjectAPI.md

326fa10

Co-authored-by: Tom Mrazauskas <tom@mrazauskas.de>

remove support for synchronous callbacks

f85df7f

mmanciop changed the title ~~feat: add isolateModulesAsync~~ [Feature]: add isolateModulesAsync Dec 19, 2022

Merge branch 'main' into isolateModulesAsync

c4b488e

SimenB approved these changes Dec 31, 2022

View reviewed changes

SimenB merged commit abc64a6 into jestjs:main Dec 31, 2022

mmanciop deleted the isolateModulesAsync branch December 31, 2022 21:37

mrazauskas mentioned this pull request Jan 24, 2023

[jest]: add features released in v29.4 DefinitelyTyped/DefinitelyTyped#64052

Merged

7 tasks

github-actions bot locked as resolved and limited conversation to collaborators Feb 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature]: add isolateModulesAsync #13680

[Feature]: add isolateModulesAsync #13680

mmanciop commented Dec 16, 2022 •

edited

facebook-github-bot commented Dec 16, 2022

facebook-github-bot commented Dec 17, 2022

mrazauskas left a comment

mrazauskas left a comment

mmanciop commented Dec 19, 2022

mrazauskas left a comment

mrazauskas Dec 19, 2022

mmanciop Dec 19, 2022

mmanciop commented Dec 19, 2022

mrazauskas left a comment

mrazauskas Dec 19, 2022

mmanciop Dec 19, 2022

mmanciop Dec 19, 2022

mrazauskas Dec 19, 2022

mrazauskas commented Dec 19, 2022

mmanciop commented Dec 19, 2022

mrazauskas commented Dec 19, 2022

mmanciop commented Dec 29, 2022

SimenB left a comment

mmanciop commented Jan 5, 2023

SimenB commented Jan 6, 2023

github-actions bot commented Feb 6, 2023

	isolateModulesAsync,
	isolateModulesAsync: this.isolateModulesAsync,

	expectType<Promise<void>>(jest.isolateModulesAsync(() => {}));
	expectError(jest.isolateModulesAsync(() => {}));

[Feature]: add isolateModulesAsync #13680

[Feature]: add isolateModulesAsync #13680

Conversation

mmanciop commented Dec 16, 2022 • edited

Summary

Test plan

Credits

facebook-github-bot commented Dec 16, 2022

Action Required

Process

facebook-github-bot commented Dec 17, 2022

mrazauskas left a comment

Choose a reason for hiding this comment

mrazauskas left a comment

Choose a reason for hiding this comment

mmanciop commented Dec 19, 2022

mrazauskas left a comment

Choose a reason for hiding this comment

mrazauskas Dec 19, 2022

Choose a reason for hiding this comment

mmanciop Dec 19, 2022

Choose a reason for hiding this comment

mmanciop commented Dec 19, 2022

mrazauskas left a comment

Choose a reason for hiding this comment

mrazauskas Dec 19, 2022

Choose a reason for hiding this comment

mmanciop Dec 19, 2022

Choose a reason for hiding this comment

mmanciop Dec 19, 2022

Choose a reason for hiding this comment

mrazauskas Dec 19, 2022

Choose a reason for hiding this comment

mrazauskas commented Dec 19, 2022

mmanciop commented Dec 19, 2022

mrazauskas commented Dec 19, 2022

mmanciop commented Dec 29, 2022

SimenB left a comment

Choose a reason for hiding this comment

mmanciop commented Jan 5, 2023

SimenB commented Jan 6, 2023

github-actions bot commented Feb 6, 2023

mmanciop commented Dec 16, 2022 •

edited