Remove unnecessary re render on link reveal #74670
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 8, 2025
Tests Passed |
Stats from current PRDefault Build (Increase detected
|
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| buildDuration | 28.5s | 27.7s | N/A |
| buildDurationCached | 24.4s | 23.3s | N/A |
| nodeModulesSize | 418 MB | 418 MB | |
| nextStartRea..uration (ms) | 709ms | 854ms |
Client Bundles (main, webpack) Overall increase ⚠️
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| 5306-HASH.js gzip | 53.4 kB | 53.7 kB | |
| 8276.HASH.js gzip | 169 B | 168 B | N/A |
| 8377-HASH.js gzip | 5.44 kB | 5.44 kB | N/A |
| bccd1874-HASH.js gzip | 53 kB | 53 kB | N/A |
| framework-HASH.js gzip | 57.5 kB | 57.5 kB | N/A |
| main-app-HASH.js gzip | 240 B | 241 B | N/A |
| main-HASH.js gzip | 34.1 kB | 34.1 kB | N/A |
| webpack-HASH.js gzip | 1.71 kB | 1.71 kB | N/A |
| Overall change | 53.4 kB | 53.7 kB |
Legacy Client Bundles (polyfills)
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| polyfills-HASH.js gzip | 39.4 kB | 39.4 kB | ✓ |
| Overall change | 39.4 kB | 39.4 kB | ✓ |
Client Pages
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| _app-HASH.js gzip | 193 B | 193 B | ✓ |
| _error-HASH.js gzip | 193 B | 193 B | ✓ |
| amp-HASH.js gzip | 512 B | 510 B | N/A |
| css-HASH.js gzip | 343 B | 342 B | N/A |
| dynamic-HASH.js gzip | 1.84 kB | 1.84 kB | ✓ |
| edge-ssr-HASH.js gzip | 265 B | 265 B | ✓ |
| head-HASH.js gzip | 363 B | 362 B | N/A |
| hooks-HASH.js gzip | 393 B | 392 B | N/A |
| image-HASH.js gzip | 4.57 kB | 4.57 kB | N/A |
| index-HASH.js gzip | 268 B | 268 B | ✓ |
| link-HASH.js gzip | 2.35 kB | 2.34 kB | N/A |
| routerDirect..HASH.js gzip | 328 B | 328 B | ✓ |
| script-HASH.js gzip | 397 B | 397 B | ✓ |
| withRouter-HASH.js gzip | 323 B | 326 B | N/A |
| 1afbb74e6ecf..834.css gzip | 106 B | 106 B | ✓ |
| Overall change | 3.59 kB | 3.59 kB | ✓ |
Client Build Manifests
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| _buildManifest.js gzip | 749 B | 747 B | N/A |
| Overall change | 0 B | 0 B | ✓ |
Rendered Page Sizes
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| index.html gzip | 523 B | 523 B | ✓ |
| link.html gzip | 538 B | 537 B | N/A |
| withRouter.html gzip | 519 B | 520 B | N/A |
| Overall change | 523 B | 523 B | ✓ |
Edge SSR bundle Size Overall increase ⚠️
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| edge-ssr.js gzip | 128 kB | 128 kB | N/A |
| page.js gzip | 207 kB | 207 kB | |
| Overall change | 207 kB | 207 kB |
Middleware size
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| middleware-b..fest.js gzip | 670 B | 666 B | N/A |
| middleware-r..fest.js gzip | 155 B | 156 B | N/A |
| middleware.js gzip | 31.2 kB | 31.2 kB | N/A |
| edge-runtime..pack.js gzip | 844 B | 844 B | ✓ |
| Overall change | 844 B | 844 B | ✓ |
Next Runtimes Overall increase ⚠️
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| 274-experime...dev.js gzip | 322 B | 322 B | ✓ |
| 274.runtime.dev.js gzip | 314 B | 314 B | ✓ |
| app-page-exp...dev.js gzip | 365 kB | 366 kB | |
| app-page-exp..prod.js gzip | 129 kB | 130 kB | |
| app-page-tur..prod.js gzip | 142 kB | 143 kB | |
| app-page-tur..prod.js gzip | 138 kB | 138 kB | |
| app-page.run...dev.js gzip | 354 kB | 354 kB | |
| app-page.run..prod.js gzip | 126 kB | 126 kB | |
| app-route-ex...dev.js gzip | 37.5 kB | 37.5 kB | ✓ |
| app-route-ex..prod.js gzip | 25.6 kB | 25.6 kB | ✓ |
| app-route-tu..prod.js gzip | 25.6 kB | 25.6 kB | ✓ |
| app-route-tu..prod.js gzip | 25.4 kB | 25.4 kB | ✓ |
| app-route.ru...dev.js gzip | 39.2 kB | 39.2 kB | ✓ |
| app-route.ru..prod.js gzip | 25.4 kB | 25.4 kB | ✓ |
| pages-api-tu..prod.js gzip | 9.69 kB | 9.69 kB | ✓ |
| pages-api.ru...dev.js gzip | 11.6 kB | 11.6 kB | ✓ |
| pages-api.ru..prod.js gzip | 9.68 kB | 9.68 kB | ✓ |
| pages-turbo...prod.js gzip | 21.7 kB | 21.7 kB | ✓ |
| pages.runtim...dev.js gzip | 27.5 kB | 27.5 kB | ✓ |
| pages.runtim..prod.js gzip | 21.7 kB | 21.7 kB | ✓ |
| server.runti..prod.js gzip | 916 kB | 916 kB | ✓ |
| Overall change | 2.45 MB | 2.45 MB |
build cache Overall increase ⚠️
| vercel/next.js canary | acdlite/next.js remove-unnecessary-re-render-on-link-reveal | Change | |
|---|---|---|---|
| 0.pack gzip | 2.09 MB | 2.09 MB | N/A |
| index.pack gzip | 75 kB | 75.2 kB | |
| Overall change | 75 kB | 75.2 kB |
Diff details
Diff for 5306-HASH.js
Diff too large to display
Diff for main-HASH.js
Diff too large to display
Diff for app-page-exp..ntime.dev.js
Diff too large to display
Diff for app-page-exp..time.prod.js
Diff too large to display
Diff for app-page-tur..time.prod.js
Diff too large to display
Diff for app-page-tur..time.prod.js
Diff too large to display
Diff for app-page.runtime.dev.js
Diff too large to display
Diff for app-page.runtime.prod.js
Diff too large to display
acdlite
force-pushed
the
remove-unnecessary-re-render-on-link-reveal
branch
2 times, most recently
from
c7c2abc to
b293dd3
Compare
ztanner
approved these changes
Jan 13, 2025
| // it doesn't change. So we can store it in a global rather than pass | ||
| // it around everywhere via props/context. | ||
| if (globalActionQueue !== null) { | ||
| throw new Error( |
There was a problem hiding this comment.
nit: we have an InvariantError for these types of errors though I don't have a strong opinion on if we should use it
There was a problem hiding this comment.
Is it used for anything other than setting the name property to "InvariantError"? Does it change how the error gets reported?
There was a problem hiding this comment.
I believe it's purely to have a standardized error message for invariants
The Link component initiates a prefetch whenever it enters the viewport, but currently the implementation works by setting an `isVisible` state to true, rerendering the component, and calling `router.prefetch` inside a `useEffect` hook. This extra render is not necessary — we can initiate the prefetch directly inside the IntersectionObserver's event handler. The bulk of the changes in this commit involve removing the use of the `useIntersection` abstraction and inlining the IntersectionObserver into the Link module. The removal of this indirection will make it easier to add more sophisticated scheduling improvements, like canceling the prefetch on viewport exit, and increasing the priority of the prefetch during hover. This affects App Router only, not Pages Router.
acdlite
force-pushed
the
remove-unnecessary-re-render-on-link-reveal
branch
from
b293dd3 to
2d15a69
Compare
huozhi
added a commit
that referenced
this pull request
Jan 17, 2025
### What Regression introduced in #74670, where the element somehow is invalid to be observed by observer or be set as key in to WeakMap. The possible cause is `mountInstance` is calling with `null`. ``` TypeError: Failed to execute 'observe' on 'IntersectionObserver': parameter 1 is not of type 'Element'. ``` ``` TypeError: Invalid value used as weak map key at WeakMap.set (<anonymous>) ``` The root cause is the `useMergedRef` could return `null` in callback, we need to filter them out before passing to `mountLinkInstance` or `unmountLinkInstance`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Link component initiates a prefetch whenever it enters the viewport, but currently the implementation works by setting an
isVisiblestate to true, rerendering the component, and callingrouter.prefetchinside auseEffecthook. This extra render is not necessary — we can initiate the prefetch directly inside the IntersectionObserver's event handler.The bulk of the changes in this commit involve removing the use of the
useIntersectionabstraction and inlining the IntersectionObserver into the Link module. The removal of this indirection will make it easier to add more sophisticated scheduling improvements, like canceling the prefetch on viewport exit, and increasing the priority of the prefetch during hover.