Add `jest.isolateModules` for scoped module initialization #6701

rogeliog · 2018-07-16T15:45:31Z

Summary

This PR provides an interface(jest.isolateModules) for scoped module initialization/cleanup.

This was originally proposed by @gaearon, and a similar proposal was done by @benmj #6638

~I initially built this with the idea that you could have multiple nested withResetModules, but I'm not sure if that would be a valid use case

~~I made withResetModules async, so that a user can wait for some async code to be executed inside of the function before moving forward with the rest.~~

Add documentation

gaearon · 2018-07-16T16:00:59Z

I made withResetModules async, so that a user can wait for some async code to be executed inside of the function before moving forward with the rest.

Hmm. How would this work in beforeEach? Here's what we're doing today:

https://github.com/facebook/react/blob/43ffae2d1750ee32409e140e41ea562ff46d2516/packages/react-art/src/__tests__/ReactART-test.js#L18-L33

or

https://github.com/facebook/react/blob/43ffae2d1750ee32409e140e41ea562ff46d2516/packages/react-dom/src/__tests__/ReactServerRenderingBrowser-test.js#L19-L24

codecov-io · 2018-07-16T16:06:28Z

Codecov Report

Merging #6701 into master will increase coverage by 0.03%.
The diff coverage is 88.88%.

@@            Coverage Diff             @@
##           master    #6701      +/-   ##
==========================================
+ Coverage   66.54%   66.58%   +0.03%     
==========================================
  Files         241      241              
  Lines        9316     9336      +20     
  Branches        5        6       +1     
==========================================
+ Hits         6199     6216      +17     
- Misses       3114     3117       +3     
  Partials        3        3

Impacted Files	Coverage Δ
packages/jest-runtime/src/index.js	`77.47% <88.88%> (+0.48%)`	⬆️

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 c22d9f5...380e9c6. Read the comment docs.

rogeliog · 2018-07-17T18:32:01Z

@gaearon That is a good, point I'll remove it.

Another question... could withResetModules be nested inside each other?

gaearon · 2018-07-17T19:09:40Z

Another question... could withResetModules be nested inside each other?

In theory it might make sense to support it. Not sure I see practical use case.

rogeliog · 2018-07-17T19:27:00Z

I agree with that. I think the API makes it seem as if it should be supported, but it does add a bit of complexity to the implementation given that it needs to keep a stack of sandbox registries, compared to just one.

We could throw an error if the user tries to nest them. withResetModules cannot be nested inside another withResetModules.

Also, I'll give this a try with the tests that you linked above and I'll let you know how it goes.

gaearon · 2018-07-17T19:36:19Z

Yeah, if it's not supported then it should error. If somebody later asks for it we can look at a use case.

rogeliog · 2018-07-18T15:49:50Z

My implementation is still rough and I would need to change some things, but it seems to be working.
@gaearon I went ahead changed all the resetModules() in facebook/react to withResetModules(() => {}), and the full React test suite seems to be passing

facebook/react@master...rogeliog:with-reset-modules

NOTE: I'm not sure if replacing all the resetModules() with withResetModules(() => {}) is something that makes sense for the React codebase, I just did it to better test my withResetModules implementation

rogeliog · 2018-07-23T00:59:06Z

@gaearon do you know if the changes that I did on facebook/react to support withResetModules make sense?

gaearon · 2018-08-19T20:42:04Z

I think they make sense.

Maybe isolateModules would be a better name?

rogeliog · 2018-10-11T16:56:07Z

@SimenB, @rickhanlonii, @cpojer any thoughts?

SimenB · 2018-10-11T17:26:28Z

Disclaimer: It is still in a rough state, needs to be cleaned up and still has some issues.

What issues? Or do you think it's ready for review?

EDIT: Looking though quickly now nothing popped up, at least. Mind adding some docs?

rogeliog · 2018-10-12T15:24:01Z

What issues? Or do you think it's ready for review?

I forgot to remove that, yes it is ready for review

SimenB

Looks good!

SimenB · 2018-10-12T17:26:57Z

docs/Configuration.md

+
+Default: `false`
+
+`isolateModules` goes a step further than `resetModules` and creates a sanbox registry for the modules that are loaded inside the callback function. This is useful to isolate modules for every test so that local module state doesn't conflict between tests. This can be done programmatically using [`jest.isolateModules()`](#jest-isolatemodules).


Typo: sanbox

SimenB · 2018-10-12T17:27:25Z

packages/jest-runtime/src/__tests__/runtime_require_module_or_mock.test.js

+      expect(exports.getState()).toBe(1);
+    }));
+
+  it('cannot nest isolateModules blocks', async () =>


SimenB · 2018-10-12T17:38:59Z

packages/jest-runtime/src/__tests__/test_root/ModuleWithState.js

+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @providesModule ModuleWithState


We've cleaned out providesModule from master

SimenB · 2018-10-12T22:55:08Z

@gaearon have you been able to test this? Does it work for your use case?

rogeliog · 2018-10-17T02:10:35Z

@gaearon @cpojer any thoughts?

thymikee

Small adjustments to the docs and we're good to land it 🚀

thymikee · 2018-10-28T07:50:59Z

docs/Configuration.md

+let myModule;
+jest.isolateModules(() => {
+  myModule = require('myModule');
+});


I think we should move the example to https://jestjs.io/docs/en/jest-object (and fix the link to jest.isolateModules() above)

Good point, I think it should only live in jest-object. This was my bad.

thymikee · 2018-10-28T08:02:41Z

packages/jest-runtime/src/index.js

  _moduleMocker: ModuleMocker;
+  _sandboxModuleRegistry: ?ModuleRegistry;


I think _isolatedModuleRegistry would play slightly better with the name isolateModules but I'm good with both names 👍.

👍 I like it way better!

thymikee

Awesome!

rogeliog · 2018-10-29T19:08:00Z

@gaearon @cpojer any thoughts?

thymikee · 2018-12-18T18:23:46Z

@SimenB let's merge it and iterate when needed. Thanks @rogeliog for taking a stab at it!

* master: (24 commits) Add `jest.isolateModules` for scoped module initialization (jestjs#6701) Migrate to Babel 7 (jestjs#7016) docs: changed "Great Scott!" link (jestjs#7524) Use reduce instead of filter+map in dependency_resolver (jestjs#7522) Update Configuration.md (jestjs#7455) Support dashed args (jestjs#7497) Allow % based configuration of max workers (jestjs#7494) chore: Standardize filenames: jest-runner pkg (jestjs#7464) allow `bail` setting to control when to bail out of a failing test run (jestjs#7335) Add issue template labels (jestjs#7470) chore: standardize filenames in e2e/babel-plugin-jest-hoist (jestjs#7467) Add node worker-thread support to jest-worker (jestjs#7408) Add `testPathIgnorePatterns` to CLI documentation (jestjs#7440) pretty-format: Omit non-enumerable symbol properties (jestjs#7448) Add Jest Architecture overview to docs. (jestjs#7449) chore: run appveyor tests on node 10 chore: fix failures e2e test for node 8 (jestjs#7446) chore: update docusaurus to v1.6.0 (jestjs#7445) Enhancement/expect-to-be-close-to-with-infinity (jestjs#7444) Update CHANGELOG formatting (jestjs#7429) ...

* First iteration of withResetModules * Make withResetModules "not async" * Reimplement withResetModules without the stack * Rename withResetModules to isolateModules * Add changelog entry * Fix eslint * Add docs for isolateModules * Fix typo, remove provideModules and extra async stuff * Update Configuration.md * Rename implementation to isolated* and change docs to JestObjectAPI

dreyks · 2020-07-17T11:57:13Z

hey! I know this is an old thread, but what do you think about an async version of isolateModules? I'm using import() instead of require in my tests, so I'd love to be able to do something like

await jest.isolateModules.async(async () => (await import('something')).default)

github-actions · 2021-05-11T05:08:18Z

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.

First iteration of withResetModules

93a11a1

facebook-github-bot added the cla signed label Jul 16, 2018

rogeliog mentioned this pull request Jul 16, 2018

Scoped module initialization / cleanup #6174

Closed

Make withResetModules "not async"

1f86b12

Reimplement withResetModules without the stack

65e426e

rogeliog force-pushed the with-reset-modules branch from 4af7d27 to 65e426e Compare July 23, 2018 00:57

rogeliog added 3 commits October 4, 2018 23:01

Merge branch 'master' into with-reset-modules

68d4e40

Rename withResetModules to isolateModules

927773d

Add changelog entry

fffd74f

rogeliog changed the title ~~[PoC][WIP] scoped module initialization withResetModules~~ Add jest.isolateModules for scoped module initialization Oct 5, 2018

Fix eslint

8c6910d

Add docs for isolateModules

9e4c58c

SimenB approved these changes Oct 12, 2018

View reviewed changes

rogeliog added 2 commits October 12, 2018 12:48

Merge branch 'master' into with-reset-modules

c6ca84a

Fix typo, remove provideModules and extra async stuff

59fb053

Update Configuration.md

6eab501

SimenB requested a review from thymikee October 12, 2018 22:57

SimenB added this to the Jest 24 milestone Oct 17, 2018

rogeliog requested review from gaearon and cpojer October 18, 2018 23:24

Merge branch 'master' into with-reset-modules

a829797

thymikee reviewed Oct 28, 2018

View reviewed changes

Rename implementation to isolated* and change docs to JestObjectAPI

380e9c6

thymikee approved these changes Oct 28, 2018

View reviewed changes

Merge branch 'master' into with-reset-modules

8c9e2d0

thymikee merged commit 873c641 into jestjs:master Dec 18, 2018

lonix1 mentioned this pull request Jan 24, 2019

Not working with Jest sindresorhus/import-fresh#9

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `jest.isolateModules` for scoped module initialization #6701

Add `jest.isolateModules` for scoped module initialization #6701

rogeliog commented Jul 16, 2018 •

edited

Loading

gaearon commented Jul 16, 2018 •

edited

Loading

codecov-io commented Jul 16, 2018 •

edited

Loading

rogeliog commented Jul 17, 2018

gaearon commented Jul 17, 2018

rogeliog commented Jul 17, 2018

gaearon commented Jul 17, 2018

rogeliog commented Jul 18, 2018 •

edited

Loading

rogeliog commented Jul 23, 2018

gaearon commented Aug 19, 2018

rogeliog commented Oct 11, 2018 •

edited

Loading

SimenB commented Oct 11, 2018 •

edited

Loading

rogeliog commented Oct 12, 2018

SimenB left a comment

SimenB Oct 12, 2018

SimenB Oct 12, 2018

SimenB Oct 12, 2018

SimenB commented Oct 12, 2018

rogeliog commented Oct 17, 2018

thymikee left a comment

thymikee Oct 28, 2018 •

edited

Loading

rogeliog Oct 28, 2018

thymikee Oct 28, 2018

rogeliog Oct 28, 2018

thymikee left a comment

rogeliog commented Oct 29, 2018

thymikee commented Dec 18, 2018

dreyks commented Jul 17, 2020

github-actions bot commented May 11, 2021


		Default: `false`

		`isolateModules` goes a step further than `resetModules` and creates a sanbox registry for the modules that are loaded inside the callback function. This is useful to isolate modules for every test so that local module state doesn't conflict between tests. This can be done programmatically using [`jest.isolateModules()`](#jest-isolatemodules).

		_moduleMocker: ModuleMocker;
		_sandboxModuleRegistry: ?ModuleRegistry;

Add jest.isolateModules for scoped module initialization #6701

Add jest.isolateModules for scoped module initialization #6701

Conversation

rogeliog commented Jul 16, 2018 • edited Loading

Summary

gaearon commented Jul 16, 2018 • edited Loading

codecov-io commented Jul 16, 2018 • edited Loading

Codecov Report

rogeliog commented Jul 17, 2018

gaearon commented Jul 17, 2018

rogeliog commented Jul 17, 2018

gaearon commented Jul 17, 2018

rogeliog commented Jul 18, 2018 • edited Loading

rogeliog commented Jul 23, 2018

gaearon commented Aug 19, 2018

rogeliog commented Oct 11, 2018 • edited Loading

SimenB commented Oct 11, 2018 • edited Loading

rogeliog commented Oct 12, 2018

SimenB left a comment

Choose a reason for hiding this comment

SimenB Oct 12, 2018

Choose a reason for hiding this comment

SimenB Oct 12, 2018

Choose a reason for hiding this comment

SimenB Oct 12, 2018

Choose a reason for hiding this comment

SimenB commented Oct 12, 2018

rogeliog commented Oct 17, 2018

thymikee left a comment

Choose a reason for hiding this comment

thymikee Oct 28, 2018 • edited Loading

Choose a reason for hiding this comment

rogeliog Oct 28, 2018

Choose a reason for hiding this comment

thymikee Oct 28, 2018

Choose a reason for hiding this comment

rogeliog Oct 28, 2018

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

rogeliog commented Oct 29, 2018

thymikee commented Dec 18, 2018

dreyks commented Jul 17, 2020

github-actions bot commented May 11, 2021

Add `jest.isolateModules` for scoped module initialization #6701

Add `jest.isolateModules` for scoped module initialization #6701

rogeliog commented Jul 16, 2018 •

edited

Loading

gaearon commented Jul 16, 2018 •

edited

Loading

codecov-io commented Jul 16, 2018 •

edited

Loading

rogeliog commented Jul 18, 2018 •

edited

Loading

rogeliog commented Oct 11, 2018 •

edited

Loading

SimenB commented Oct 11, 2018 •

edited

Loading

thymikee Oct 28, 2018 •

edited

Loading