No description
Find a file
Jimmy Lai ff1664b11b
perf: avoid sync re-renders when using next/link and next/image (#45165)
fixes NEXT-164

## Context

This PR fixes an issue happening when using `next/image` or `next/link` where rendering them caused sync re-renders with React. This breaks [selective hydration](https://github.com/reactwg/react-18/discussions/130) in React.

## The fix

The cause of this behaviour is that we're calling `setState` in a ref mount, which basically "forces" React to disable concurrent rendering. It finishes the render, runs synchronously the passive effects and re-renders again to make sure that everything is in sync, all of that in without yielding to the browser to paint.

Here in this case, the `setState` call is because of the `useIntersectionObserver` hook. It's implemented in a way that requires the user to call a setter that will store the ref value in a component state variable to re-trigger a render and re-run the effect to create the intersection observer.

This is not necessary as the ref init phase always runs before the passive effect runs, so we can just copy the ref to another ref inside `useIntersectionObserver` without triggering a re-render.

## Before/After

1st screenshot: before
2nd screenshot: after

Basically on the first screenshot, you can see that React is doing a synchronous re-render (see `flushPassiveEffects`). This is not good.

If you look at screenshot 2, you can see it does not happen anymore and that the passive effects are flushed in another block in the flamegraph.

<img width="1110" alt="CleanShot 2023-01-23 at 14 30 11@2x" src="https://user-images.githubusercontent.com/11064311/214051860-c42d2849-cd10-4922-a3e0-9b715fc87b23.png">

<img width="520" alt="CleanShot 2023-01-23 at 14 29 01@2x" src="https://user-images.githubusercontent.com/11064311/214051555-04adf516-9c0b-4056-ac65-1ef33614c767.png">





## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2023-01-24 17:47:18 +00:00
.devcontainer Remove devcontainer network host argument (#44157) 2022-12-19 16:38:20 -08:00
.github Add timeout for actions/cache restoring (#45198) 2023-01-23 14:39:11 -08:00
.husky Replace pre-commit with husky (#38350) 2022-07-06 11:14:16 -05:00
.vscode Add VSCode settings and recommended extensions for Next.js repository (#43954) 2022-12-12 15:10:54 +01:00
bench misc: fix benchmark script (#44592) 2023-01-05 13:46:41 +00:00
contributing Update testing.md to reflect that we don't use yarn anymore (#45185) 2023-01-23 14:41:42 -08:00
docs Update example test file name in cypress example (#45146) 2023-01-23 13:37:56 -08:00
errors chore: fix invalid-new-link error typo (#45157) 2023-01-23 17:06:50 -08:00
examples Pin library version in Convex example (#45206) 2023-01-24 03:16:54 +00:00
packages perf: avoid sync re-renders when using next/link and next/image (#45165) 2023-01-24 17:47:18 +00:00
scripts Switch from yarn pack to pnpm pack in tests (#45167) 2023-01-23 15:07:35 +00:00
test Update handling of autoscrolling on navigation in app (#43845) 2023-01-24 15:41:06 +00:00
.alexignore Enable Alex documentation linting for docs (#26598) 2021-06-25 11:40:50 -05:00
.alexrc Add section to next/future/image docs about Known Browser Bugs (#39759) 2022-08-20 00:21:00 +00:00
.eslintignore refactor: Latest Tigris sdk and example using decorators (#44256) 2023-01-18 20:44:18 -08:00
.eslintrc.json Replace eslint rule for no-shadow with typescript-eslint/no-shadow (#44936) 2023-01-16 16:02:59 -08:00
.gitattributes the way towards webpack 5 typings (#29105) 2021-09-21 19:17:16 +02:00
.gitignore Fix turbo usage in tests (#44715) 2023-01-18 20:35:28 +01:00
.npmrc declare pnpm7 as engine (#37303) 2022-05-30 13:13:36 +00:00
.prettierignore hmr error improvements (#30616) 2023-01-06 20:35:16 +01:00
.prettierignore_staged hmr error improvements (#30616) 2023-01-06 20:35:16 +01:00
.prettierrc.json Prettier trailingComma default value to es5 since 2.0 (#14391) 2020-06-22 13:25:24 +02:00
azure-pipelines.yml Update to latest version of pnpm (#44791) 2023-01-11 17:36:52 -08:00
CODE_OF_CONDUCT.md updated code of conduct to v2.1 (#34208) 2022-02-10 18:11:42 -06:00
contributing.md refactor: split up CONTRIBUTING.md (#40515) 2022-09-16 14:54:58 -07:00
jest.config.js Allow unit tests to be written in packages/next/src (#45222) 2023-01-24 14:32:09 +00:00
jest.replay.config.js Add Replay integration for dev e2e tests (#40955) 2022-09-29 14:45:10 -07:00
lerna.json v13.1.6-canary.0 2023-01-23 15:04:49 -08:00
license.md Update license year (#44403) 2023-01-01 11:12:49 +01:00
lint-staged.config.js Change test template to use TS and improve template for app-dir (#44227) 2023-01-06 20:36:47 +00:00
package.json Fix turbo usage in tests (#44715) 2023-01-18 20:35:28 +01:00
plopfile.js Fix new-error command (#44720) 2023-01-09 14:56:00 +01:00
pnpm-lock.yaml v13.1.6-canary.0 2023-01-23 15:04:49 -08:00
pnpm-workspace.yaml misc: add benchmarking script for edge rendering (#40716) 2022-09-27 17:57:16 +02:00
readme.md Monorepo (#5341) 2018-10-01 01:02:10 +02:00
release.js Fix labels for release sections 2021-11-21 13:11:54 +01:00
run-tests.js Update test env variable passing (#44912) 2023-01-15 23:20:16 -08:00
test-file.txt Add additional file serving tests (#12479) 2020-05-04 11:58:19 -05:00
tsconfig-tsec.json Integrate tsec into the linting process (#33746) 2022-02-24 16:59:18 -08:00
tsconfig.json Adds tests to ensure eslint-plugin-next's available rules are properly exported and recommended rules are correctly defined. (#38183) 2022-06-30 11:31:33 -05:00
tsec-exemptions.json Move core files to src folder and move JS files to TypeScript (#44405) 2023-01-03 10:05:50 +01:00
turbo.json Fix turbo cache miss due to depending on gitignored files (#45166) 2023-01-24 11:53:07 +00:00
UPGRADING.md Move upgrading guide to /docs (#10727) 2020-02-28 23:46:18 +01:00
vercel.json Silence GH Comments for Preview URLs (#18766) 2020-11-03 21:59:47 +00:00

Next.js

Getting Started

Visit https://nextjs.org/learn to get started with Next.js.

Documentation

Visit https://nextjs.org/docs to view the full documentation.

Who is using Next.js?

Next.js is used by the world's leading companies. Check out the Next.js Showcase to learn more.

Community

The Next.js community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.

To chat with other community members you can join the Next.js Discord.

Our Code of Conduct applies to all Next.js community channels.

Contributing

Please see our contributing.md.

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Authors

Security

If you believe you have found a security vulnerability in Next.js, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email security@vercel.com to disclose any security vulnerabilities.

https://vercel.com/security