-
Notifications
You must be signed in to change notification settings - Fork 46.9k
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
Update to Jest 29 #26088
Update to Jest 29 #26088
Conversation
Comparing: 28fcae0...3f8db9b Critical size changesIncludes critical production bundles, as well as any change greater than 2%:
Significant size changesIncludes any change greater than 0.2%: (No significant changes) |
jest.isolateModules(() => { | ||
React = require('react'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reference #21575 (comment)
@@ -23,6 +23,7 @@ describe('SchedulerNoDOM', () => { | |||
jest.resetModules(); | |||
jest.useFakeTimers(); | |||
delete global.setImmediate; | |||
delete global.MessageChannel; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jest v28 add MessageChannel to globals. jestjs/jest#12553
@@ -5,6 +5,7 @@ | |||
* LICENSE file in the root directory of this source tree. | |||
* | |||
* @emails react-core | |||
* @jest-environment ./scripts/jest/ReactDOMServerIntegrationEnvironment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Jest v26, the module path 'react-dom/server' would map to the file path 'packages/react-dom/server.js'.
However, in Jest v29, this mapping rule has changed and it will first look at the exports field of the package.json file, and then decide which file to load based on the testing environment. In jest-environment-jsdom, 'packages/react-dom/server.browser.js' will be loaded, and in jest-environment-node, 'packages/react-dom/server.node.js' will be loaded.
This will cause tests that use node environment methods (such as renderToPipeableStream) to fail. Is it possible to use the module path 'react-dom/server.node'? I see that the problem can also be solved by customizing the testing environment (#21575), adding some jsdom environment variables in the node testing environment.
packages/react-dom/src/__tests__/ReactDOMFizzStaticNode-test.js
Outdated
Show resolved
Hide resolved
// @TODO this is a hack to work around lack of support for abortSignal.reason in node | ||
// The abort call itself should set this property but since we are testing in node we | ||
// set it here manually | ||
controller.signal.reason = theReason; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
abortSignal.reason is read-only in jsdom and node, https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/reason
@@ -19,7 +20,7 @@ let ReactDOMServer; | |||
|
|||
function initModules() { | |||
// Reset warning cache. | |||
jest.resetModuleRegistry(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"jest.resetModuleRegistry" has been removed in Jest v27 and should be replaced with "jest.resetModules".
@@ -3119,7 +3120,7 @@ describe('ReactDOMServerPartialHydration', () => { | |||
// We're now partially hydrated. | |||
await act(async () => { | |||
form.dispatchEvent( | |||
new Event('submit', { | |||
new window.Event('submit', { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the Event from jsdom instead of the one from node.
@@ -2428,17 +2440,21 @@ describe('ReactSuspenseWithNoopRenderer', () => { | |||
'Loading B...', | |||
]); | |||
// Still suspended. | |||
expect(ReactNoop.getChildren()).toEqual([span('A')]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following diff are sources of the OOM problem.
Interestingly, using 'yarn test' does not cause an OOM problem, but using the following commands does: 'yarn test -r=experimental --env=development --persistent --ci', 'yarn test -r=experimental --env=production --ci', 'yarn test --build -r=experimental --env=development --ci', 'yarn test --build -r=experimental --env=production --ci'.
It is speculated that this may be because the OOM problem is avoided due to mocking of certain modules in the 'scripts/jest/setupTests.www.js' file that is referenced in 'yarn test'.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we only using removeNonEnumerableProperties
on some assertions? We have >100 assertions on ReactNoop.getChildren()
but only a couple of are now wrapped in removeNonEnumerableProperties
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pointing out the issue with the assertions.
I did some further investigation and found that the OOM problem was caused by the tests with the titles "keeps showing an avoided parent fallback if it is already showing" and "do not show placeholder when mounting an avoided boundary with startTransition".
I located the specific lines of code that were causing the problem and initially wrapped them with removeNonEnumerableProperties, but upon further review, I realized that this may not be the best solution.
I think it would be better to further investigate and find the root cause of the problem.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you get OOM locally or in CI?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can remove the removeNonEnumerableProperties function wrapper and reproduce it in your local jestbump branch code with the following ci test command
yarn test -r=experimental --env=development --persistent
yarn test -r=experimental --env=development --persistent --ci
yarn test -r=experimental --env=production --ci
yarn test --build -r=experimental --env=development --ci
yarn test --build -r=experimental --env=production --ci
Interestingly, the OOM does not occur with the following test command
yarn test
These links below are about OOM
- https://app.circleci.com/pipelines/github/facebook/react/37815/workflows/af2d09e1-48d7-4e29-a33a-f4106c5783cc/jobs/621083
- https://app.circleci.com/pipelines/github/facebook/react/37815/workflows/af2d09e1-48d7-4e29-a33a-f4106c5783cc/jobs/621073
- https://app.circleci.com/pipelines/github/facebook/react/37815/workflows/af2d09e1-48d7-4e29-a33a-f4106c5783cc/jobs/621072
- https://app.circleci.com/pipelines/github/facebook/react/37815/workflows/af2d09e1-48d7-4e29-a33a-f4106c5783cc/jobs/621071
- https://app.circleci.com/pipelines/github/facebook/react/37815/workflows/af2d09e1-48d7-4e29-a33a-f4106c5783cc/jobs/621053
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$ git clone https://github.com/eps1lon/react.git
$ git checkout jestbump-perf-repro
$ yarn
$ yarn test -r=experimental --env=development --persistent --ci packages/react-reconciler/src/__tests__/ReactSuspenseWithNoopRenderer-test.js --verbose
I'm also getting a lot of deprecation warnings from testcheck
which is used by Jasmine. So maybe it's actually a Jasmine issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably have this problem on main
(i.e. Jest 26) already: https://app.circleci.com/pipelines/github/facebook/react/38061/workflows/a2043dd0-df62-49d5-a10e-9b534c33cbdb/jobs/623788/parallel-runs/5?filterBy=ALL
Going to convert expect(ReactNoop.getChildren()).toEqual
to expect(ReactNoop).toMatchRenderedOutput
in a separate PR. This will hopefully fix issues on main
and unblock this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Settled on using toMatchRenderedOutput
instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a smaller reproduction than react?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have one and I expect it to be quite hard to reproduce. From what I could tell, the doubly linked-list structure of Fiber caused the severe slowdown in expect(somethingHavingFibers).toEqual()
.
@gaearon This PR is important because Jest v29 has been released and the new version contains a lot of new features and bug fix which is important for our project. It's ready for review and merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we do fixtures/ in a follow-up? These are not automatically tested and rarely used so I'd rather do some manual testing so we don't accidentally break them.
And that we can use the automated tests in packages/ as a canary.
packages/react-dom/src/__tests__/ReactDOMFizzShellHydration-test.js
Outdated
Show resolved
Hide resolved
packages/react-dom/src/__tests__/ReactDOMFizzSuppressHydrationWarning-test.js
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works like a charm. Much appreciated, thanks!
🎉 |
@ymqy thanks for the huge update and debugging the issues! |
amazing work. thank you. |
Summary: This sync includes the following changes: - **[86c8c8db7](facebook/react@86c8c8db7 )**: test: Don't retry flushActWork if flushUntilNextPaint threw ([#26121](facebook/react#26121)) //<Sebastian Silbermann>// - **[64acd3918](facebook/react@64acd3918 )**: remove unguarded getRootNode call ([#26152](facebook/react#26152)) //<Josh Story>// - **[71cace4d3](facebook/react@71cace4d3 )**: Migrate testRunner from jasmine2 to jest-circus ([#26144](facebook/react#26144)) //<Ming Ye>// - **[c8510227c](facebook/react@c8510227c )**: Treat displayName as undefined ([#26148](facebook/react#26148)) //<Sebastian Markbåge>// - **[55542bc73](facebook/react@55542bc73 )**: Update jest printBasicPrototype config ([#26142](facebook/react#26142)) //<Ming Ye>// - **[6396b6641](facebook/react@6396b6641 )**: Model Float on Hoistables semantics ([#26106](facebook/react#26106)) //<Josh Story>// - **[ef9f6e77b](facebook/react@ef9f6e77b )**: Enable passing Server References from Server to Client ([#26124](facebook/react#26124)) //<Sebastian Markbåge>// - **[35698311d](facebook/react@35698311d )**: Update jest escapeString config ([#26140](facebook/react#26140)) //<Ming Ye>// - **[6ddcbd4f9](facebook/react@6ddcbd4f9 )**: [flow] enable LTI inference mode ([#26104](facebook/react#26104)) //<Jan Kassens>// - **[53b1f69ba](facebook/react@53b1f69ba )**: Implement unstable_getBoundingClientRect in RN Fabric refs ([#26137](facebook/react#26137)) //<Rubén Norte>// - **[594093496](facebook/react@594093496 )**: Update to Jest 29 ([#26088](facebook/react#26088)) //<Ming Ye>// - **[28fcae062](facebook/react@28fcae062 )**: Add support for SVG `transformOrigin` prop ([#26130](facebook/react#26130)) //<Aravind D>// - **[3ff1540e9](facebook/react@3ff1540e9 )**: Prefer JSX in ReactNoop assertions (to combat out-of-memory test runs) ([#26127](facebook/react#26127)) //<Sebastian Silbermann>// - **[01a0c4e12](facebook/react@01a0c4e12 )**: Add Edge Server Builds for workerd / edge-light ([#26116](facebook/react#26116)) //<Sebastian Markbåge>// - **[f0cf832e1](facebook/react@f0cf832e1 )**: Update Flight Fixture to "use client" instead of .client.js ([#26118](facebook/react#26118)) //<Sebastian Markbåge>// - **[03a216070](facebook/react@03a216070 )**: Rename "dom" fork to "dom-node" and "bun" fork to "dom-bun" ([#26117](facebook/react#26117)) //<Sebastian Markbåge>// - **[4bf2113a1](facebook/react@4bf2113a1 )**: Revert "Move the Webpack manifest config to one level deeper ([#26083](facebook/react#26083))" ([#26111](facebook/react#26111)) //<Sebastian Markbåge>// - **[2ef24145e](facebook/react@2ef24145e )**: [flow] upgrade to 0.199.0 ([#26096](facebook/react#26096)) //<Jan Kassens>// - **[922dd7ba5](facebook/react@922dd7ba5 )**: Revert the outer module object to an object ([#26093](facebook/react#26093)) //<Sebastian Markbåge>// - **[9d111ffdf](facebook/react@9d111ffdf )**: Serialize Promises through Flight ([#26086](facebook/react#26086)) //<Sebastian Markbåge>// - **[0ba4698c7](facebook/react@0ba4698c7 )**: Fix async test in React reconciler ([#26087](facebook/react#26087)) //<Ming Ye>// - **[8c234c0de](facebook/react@8c234c0de )**: Move the Webpack manifest config to one level deeper ([#26083](facebook/react#26083)) //<Sebastian Markbåge>// - **[977bccd24](facebook/react@977bccd24 )**: Refactor Flight Encoding ([#26082](facebook/react#26082)) //<Sebastian Markbåge>// - **[d7bb524ad](facebook/react@d7bb524ad )**: [cleanup] Remove unused package jest-mock-scheduler ([#26084](facebook/react#26084)) //<Ming Ye>// - **[6b3083266](facebook/react@6b3083266 )**: Upgrade prettier ([#26081](facebook/react#26081)) //<Jan Kassens>// - **[1f5ce59dd](facebook/react@1f5ce59dd )**: [cleanup] fully roll out warnAboutSpreadingKeyToJSX ([#26080](facebook/react#26080)) //<Jan Kassens>// Changelog: [General][Changed] - React Native sync for revisions 48b687f...fccf3a9 jest_e2e[run_all_tests] Reviewed By: rubennorte Differential Revision: D43305607 fbshipit-source-id: 8da7567ca2a182f4be27788935c2da30a731f83b
Summary: This sync includes the following changes: - **[86c8c8db7](facebook/react@86c8c8db7 )**: test: Don't retry flushActWork if flushUntilNextPaint threw ([facebook#26121](facebook/react#26121)) //<Sebastian Silbermann>// - **[64acd3918](facebook/react@64acd3918 )**: remove unguarded getRootNode call ([facebook#26152](facebook/react#26152)) //<Josh Story>// - **[71cace4d3](facebook/react@71cace4d3 )**: Migrate testRunner from jasmine2 to jest-circus ([facebook#26144](facebook/react#26144)) //<Ming Ye>// - **[c8510227c](facebook/react@c8510227c )**: Treat displayName as undefined ([facebook#26148](facebook/react#26148)) //<Sebastian Markbåge>// - **[55542bc73](facebook/react@55542bc73 )**: Update jest printBasicPrototype config ([facebook#26142](facebook/react#26142)) //<Ming Ye>// - **[6396b6641](facebook/react@6396b6641 )**: Model Float on Hoistables semantics ([facebook#26106](facebook/react#26106)) //<Josh Story>// - **[ef9f6e77b](facebook/react@ef9f6e77b )**: Enable passing Server References from Server to Client ([facebook#26124](facebook/react#26124)) //<Sebastian Markbåge>// - **[35698311d](facebook/react@35698311d )**: Update jest escapeString config ([facebook#26140](facebook/react#26140)) //<Ming Ye>// - **[6ddcbd4f9](facebook/react@6ddcbd4f9 )**: [flow] enable LTI inference mode ([facebook#26104](facebook/react#26104)) //<Jan Kassens>// - **[53b1f69ba](facebook/react@53b1f69ba )**: Implement unstable_getBoundingClientRect in RN Fabric refs ([facebook#26137](facebook/react#26137)) //<Rubén Norte>// - **[594093496](facebook/react@594093496 )**: Update to Jest 29 ([facebook#26088](facebook/react#26088)) //<Ming Ye>// - **[28fcae062](facebook/react@28fcae062 )**: Add support for SVG `transformOrigin` prop ([facebook#26130](facebook/react#26130)) //<Aravind D>// - **[3ff1540e9](facebook/react@3ff1540e9 )**: Prefer JSX in ReactNoop assertions (to combat out-of-memory test runs) ([facebook#26127](facebook/react#26127)) //<Sebastian Silbermann>// - **[01a0c4e12](facebook/react@01a0c4e12 )**: Add Edge Server Builds for workerd / edge-light ([facebook#26116](facebook/react#26116)) //<Sebastian Markbåge>// - **[f0cf832e1](facebook/react@f0cf832e1 )**: Update Flight Fixture to "use client" instead of .client.js ([facebook#26118](facebook/react#26118)) //<Sebastian Markbåge>// - **[03a216070](facebook/react@03a216070 )**: Rename "dom" fork to "dom-node" and "bun" fork to "dom-bun" ([facebook#26117](facebook/react#26117)) //<Sebastian Markbåge>// - **[4bf2113a1](facebook/react@4bf2113a1 )**: Revert "Move the Webpack manifest config to one level deeper ([facebook#26083](facebook/react#26083))" ([facebook#26111](facebook/react#26111)) //<Sebastian Markbåge>// - **[2ef24145e](facebook/react@2ef24145e )**: [flow] upgrade to 0.199.0 ([facebook#26096](facebook/react#26096)) //<Jan Kassens>// - **[922dd7ba5](facebook/react@922dd7ba5 )**: Revert the outer module object to an object ([facebook#26093](facebook/react#26093)) //<Sebastian Markbåge>// - **[9d111ffdf](facebook/react@9d111ffdf )**: Serialize Promises through Flight ([facebook#26086](facebook/react#26086)) //<Sebastian Markbåge>// - **[0ba4698c7](facebook/react@0ba4698c7 )**: Fix async test in React reconciler ([facebook#26087](facebook/react#26087)) //<Ming Ye>// - **[8c234c0de](facebook/react@8c234c0de )**: Move the Webpack manifest config to one level deeper ([facebook#26083](facebook/react#26083)) //<Sebastian Markbåge>// - **[977bccd24](facebook/react@977bccd24 )**: Refactor Flight Encoding ([facebook#26082](facebook/react#26082)) //<Sebastian Markbåge>// - **[d7bb524ad](facebook/react@d7bb524ad )**: [cleanup] Remove unused package jest-mock-scheduler ([facebook#26084](facebook/react#26084)) //<Ming Ye>// - **[6b3083266](facebook/react@6b3083266 )**: Upgrade prettier ([facebook#26081](facebook/react#26081)) //<Jan Kassens>// - **[1f5ce59dd](facebook/react@1f5ce59dd )**: [cleanup] fully roll out warnAboutSpreadingKeyToJSX ([facebook#26080](facebook/react#26080)) //<Jan Kassens>// Changelog: [General][Changed] - React Native sync for revisions 48b687f...fccf3a9 jest_e2e[run_all_tests] Reviewed By: rubennorte Differential Revision: D43305607 fbshipit-source-id: 8da7567ca2a182f4be27788935c2da30a731f83b
Summary
How did you test this change?
ci green