Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(jest-runtime): prevent global module registry from leaking into isolateModules registry #10963

Conversation

toomuchdesign
Copy link
Contributor

@toomuchdesign toomuchdesign commented Dec 21, 2020

Summary

require statement inside isolateModules callbacks are unpredictable since they do not always return a fresh copy of imported modules. Currently if global registry has the require module in cache, the cached instance is returned even within `isolateModules. Fixes: #7863

This PR ensures that require statement inside isolateModules always return a fresh copy of imported modules.

Current behaviour

const myModule = require('myModule');

jest.isolateModules(() => {
  const myIsolatedModule = require('myModule');
  // myIsolatedModule === myModule;
});

New behaviour

const myModule = require('myModule');

jest.isolateModules(() => {
  const myIsolatedModule = require('myModule');
  // myIsolatedModule !== myModule;
});

Test plan

Added relevant test in: packages/jest-runtime/src/__tests__/runtime_require_module_or_mock.test.js

@facebook-github-bot
Copy link
Contributor

Hi @toomuchdesign!

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 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.

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

@toomuchdesign toomuchdesign force-pushed the fix-isolatemodules-returning-global-registry-entries branch from df83469 to 1cc7726 Compare December 21, 2020 11:06
@facebook-github-bot
Copy link
Contributor

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

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good stuff, thanks! could you update the changelog as well?

@toomuchdesign toomuchdesign force-pushed the fix-isolatemodules-returning-global-registry-entries branch from 1cc7726 to 8e9fc15 Compare December 21, 2020 11:24
@facebook-github-bot
Copy link
Contributor

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

@toomuchdesign
Copy link
Contributor Author

toomuchdesign commented Dec 21, 2020

Hi @SimenB, I thought I did but it was still on my machine uncommitted :) Just force-pushed.

…solated registry

BREAKING CHANGE:
require statements in isolateModules will always return a fresh instance of imported module
@toomuchdesign toomuchdesign force-pushed the fix-isolatemodules-returning-global-registry-entries branch from 8e9fc15 to 982159f Compare December 21, 2020 11:31
@SimenB SimenB merged commit e5a84d9 into jestjs:master Dec 21, 2020
@toomuchdesign toomuchdesign deleted the fix-isolatemodules-returning-global-registry-entries branch December 21, 2020 12:50
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants