* Refresh triggers a refresh of the full page data.
* Refresh triggers a refresh of the full page data.
* - fetches the Flight data and fills subTreeData at the root of the cache.
* - fetches the Flight data and fills subTreeData at the root of the cache.
* - The router state is updated at the root of the state tree.
* - The router state is updated at the root.
*/
*/
interfaceRefreshAction{
interfaceRefreshAction{
type:typeofACTION_REFRESH
type:typeofACTION_REFRESH
...
@@ -582,28 +582,39 @@ interface RefreshAction {
...
@@ -582,28 +582,39 @@ interface RefreshAction {
}
}
/**
/**
* Navigate triggers a navigation to the provided url. It supports a combination of `cacheType` (`hard` and `soft`) and `navigateType` (`push` and `replace`).
* Navigate triggers a navigation to the provided url. It supports two types: `push` and `replace`.
*
*
* `navigateType`:
* `navigateType`:
* - `push` - pushes a new history entry in the browser history
* - `push` - pushes a new history entry in the browser history
* - `replace` - replaces the current history entry in the browser history
* - `replace` - replaces the current history entry in the browser history
*
*
* `cacheType`:
* Navigate has multiple cache heuristics:
* - `hard` - Creates a new cache in one of two ways:
* - page was prefetched
* - Not optimistic
* - Apply router state tree from prefetch
* - Default if there is no loading.js.
* - Apply Flight data from prefetch to the cache
* - Fetch data in the reducer and suspend there.
* - If Flight data is a string, it's a redirect and the state is updated to trigger a redirect
* - Copies the previous cache nodes as far as possible and applies new subTreeData.
* - Check if hard navigation is needed
* - Applies the new router state.
* - Hard navigation happens when a dynamic parameter below the common layout changed
* - optimistic
* - When hard navigation is needed the cache is invalidated below the flightSegmentPath
* - Enabled when somewhere in the router state path to the page there is a loading.js.
* - The missing cache nodes of the page will be fetched in layout-router and trigger the SERVER_PATCH action
* - Similar to `soft` but kicks off the data fetch in the reducer and applies `data` in the spot that should suspend.
* - If hard navigation is not needed
* - This enables showing loading states while navigating.
* - The cache is reused
* - Will trigger fast path or server-patch case in layout-router.
* - If any cache nodes are missing they'll be fetched in layout-router and trigger the SERVER_PATCH action
* - `soft`
* - page was not prefetched
* - Reuses the existing cache.
* - The navigate was called from `next/link` with `prefetch={false}`. This case is called `forceOptimisticNavigation`. It triggers an optimistic navigation so that loading spinners can be shown early if any.
* - Creates an optimistic router state that causes the fetch to start in layout-router when there is missing data.
* - Creates an optimistic router tree based on the provided url
* - If there is no missing data the existing cache data is rendered.
* - Adds a cache node to the cache with a Flight data fetch that was eagerly started in the reducer
* - Flight data fetch is suspended in the layout-router
* - Triggers SERVER_PATCH action when the data comes back, this will apply the data to the cache and router state, at that point the optimistic router tree is replaced by the actual router tree.
* - The navigate was called from `next/router` (`router.push()` / `router.replace()`) / `next/link` without prefetch set (e.g. the prefetch didn't come back from the server before clicking the link)
* - Flight data is fetched in the reducer (suspends the reducer)
* - Router state tree is created based on Flight data
* - Cache is filled based on the Flight data
*
* Above steps explain 3 cases:
* - `soft` - Reuses the existing cache and fetches missing nodes in layout-router.
* - `hard` - Creates a new cache where cache nodes are removed below the common layout and fetches missing nodes in layout-router.
* - `optimistic` (explicit no prefetch) - Creates a new cache and kicks off the data fetch in the reducer. The data fetch is awaited in the layout-router.
*/
*/
interfaceNavigateAction{
interfaceNavigateAction{
type:typeofACTION_NAVIGATE
type:typeofACTION_NAVIGATE
...
@@ -624,8 +635,8 @@ interface NavigateAction {
...
@@ -624,8 +635,8 @@ interface NavigateAction {
* Restore applies the provided router state.
* Restore applies the provided router state.
* - Only used for `popstate` (back/forward navigation) where a known router state has to be applied.
* - Only used for `popstate` (back/forward navigation) where a known router state has to be applied.
* - Router state is applied as-is from the history state.
* - Router state is applied as-is from the history state.
* - If any data is missing it will be fetched in layout-router during rendering and trigger fast path or server-patch case.
* - If any cache node is missing it will be fetched in layout-router during rendering and the server-patch case.
* - If no data is missing the existing cached data is rendered.
* - If existing cache nodes match these are used.
*/
*/
interfaceRestoreAction{
interfaceRestoreAction{
type:typeofACTION_RESTORE
type:typeofACTION_RESTORE
...
@@ -635,8 +646,7 @@ interface RestoreAction {
...
@@ -635,8 +646,7 @@ interface RestoreAction {
/**
/**
* Server-patch applies the provided Flight data to the cache and router tree.
* Server-patch applies the provided Flight data to the cache and router tree.
* - Only triggered in layout-router when the data can't be handled in the fast path.
* - Only triggered in layout-router.
* - Main case where this is triggered is when a rewrite applies and Flight data for a different path is returned from the server.
* - Creates a new cache and router state with the Flight data applied.
* - Creates a new cache and router state with the Flight data applied.