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

Add prefetch to new router #39866

Merged
merged 40 commits into from Sep 6, 2022
Merged

Conversation

timneutkens
Copy link
Member

@timneutkens timneutkens commented Aug 23, 2022

Follow-up to #37551
Implements prefetching for the new router.

There are multiple behaviors related to prefetching so I've split them out for each case. The list below each case is what's prefetched:

Reference:

  • Checkmark checked → it's implemented.
  • RSC Payload → Rendered server components.
  • Router state → Patch for the router history state.
  • Preloads for client component entry → This will be handled in a follow-up PR.
  • No loading.js static case → Will be handled in a follow-up PR.

  • prefetch={true} (default, same as current router, links in viewport are prefetched)
    • Static all the way down the component tree
      • RSC payload
      • Router state
      • preloads for the client component entry
    • Not static all the way down the component tree
      • With loading.js
        • RSC payload up until the loading below the common layout
        • router state
        • preloads for the client component entry
      • No loading.js (This case can be static files to make sure it’s fast)
        • router state
        • preloads for the client component entry
  • prefetch={false}
    • always do an optimistic navigation. We already have this implemented where it tries to figure out the router state based on the provided url. That result might be wrong but the router will automatically figure out that

In the first implementation there is a distinction between hard and soft navigation. With the addition of prefetching you no longer have to add a soft prop to next/link in order to leverage the soft case.

A heuristic has been added that automatically prefers soft navigation except when navigating between mismatching dynamic parameters.

An example:

  • app/[userOrTeam]/dashboard/page.js and app/[userOrTeam]/dashboard/settings/page.js
    • /tim/dashboard/tim/dashboard/settings = Soft navigation
    • /tim/dashboard/vercel/dashboard = Hard navigation
    • /vercel/dashboard/vercel/dashboard/settings = Soft navigation
    • /vercel/dashboard/settings -> /tim/dashboard = Hard navigation

While adding these new heuristics some of the tests started failing and I found some state bugs in router.reload() which have been fixed. An example being when you push to /dashboard while on / in the same transition it would navigate to /, it also wouldn't push a new history entry. Both of these cases are now fixed:

React.startTransition(() => {
  router.push('/dashboard')
  router.reload()
})

While debugging the various changes I ended up debugging and manually diffing the cache and router state quite often and was looking at a way to automate this. useReducer is quite similar to Redux so I was wondering if Redux Devtools could be used in order to debug the various actions as it has diffing built-in. It took a bit of time to figure out the connection mechanism but in the end I figured out how to connect useReducer, a new hook useReducerWithReduxDevtools has been added, we'll probably want to put this behind a compile-time flag when the new router is marked stable but until then it's useful to have it enabled by default (only when you have Redux Devtools installed ofcourse).

⚠️ Redux Devtools is only connected to take incoming actions / state. Time travel and other features are not supported because the state sent to the devtools is normalized to allow diffing the maps, you can't move backward based on that state so applying the state is not connected.

Example of the integration:

Screen Shot 2022-09-02 at 10 00 40

Adds the initial event for prefetching. Implementation is WIP.
@ijjk ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Aug 23, 2022
@ijjk

This comment was marked as outdated.

@ijjk

This comment was marked as outdated.

@timneutkens timneutkens marked this pull request as ready for review September 6, 2022 12:43
timneutkens and others added 2 commits September 6, 2022 15:34
@kodiakhq kodiakhq bot merged commit 71ad0dd into vercel:canary Sep 6, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants