Unverified Commit 8cc2dd0e authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Add prerender indicator for app router (#67306)

## Background

Currently in app router during development all pages are dynamic
rendered and streamed since we don't know if a page will be prerendered
until after the page is rendered. During build time we do a render pass
for each path and if it doesn't bail from static generation it is
considered prerendered/ISR'd.

Since it can be tricky to track all the bail outs for static generation
and doing numerous builds to track this isn't feasible we want to have
some sort of signal in development to show if it would have been
prerendered.

## New Handling

To alleviate the above pain point we are planning to bring back the
prerendered indicator from pages initially and have a config to disable
if desired. We are also going to investigate other possible indicators
potentially through headers or similar.

<details>

<summary>Preview</summary>

![CleanShot 2024-06-29 at 08 56
11@2x](https://github.com/vercel/next.js/assets/22380829/37d4d351-903d-49a2-9541-932e7d5a1e54)

![CleanShot 2024-06-29 at 08 55
46@2x](https://github.com/vercel/next.js/assets/22380829/8356f287-e0d0-4c37-aa1e-1f08639dd478)

</details>

---------
Co-authored-by: 's avatarJiachi Liu <inbox@huozhi.im>
parent 026f8873
...@@ -31,6 +31,16 @@ module.exports = { ...@@ -31,6 +31,16 @@ module.exports = {
} }
``` ```
There is also an indicator to show whether a page will be prerendered during a build in dev. It can be hidden per-page by clicking although if you never want it to show it can be disabled:
```js filename="next.config.js"
module.exports = {
devIndicators: {
appIsrStatus: false,
},
}
```
</AppOnly> </AppOnly>
<PagesOnly> <PagesOnly>
......
...@@ -173,6 +173,9 @@ export function getDefineEnv({ ...@@ -173,6 +173,9 @@ export function getDefineEnv({
? 'nodejs' ? 'nodejs'
: '', : '',
'process.env.NEXT_MINIMAL': '', 'process.env.NEXT_MINIMAL': '',
'process.env.__NEXT_APP_ISR_INDICATOR': Boolean(
config.devIndicators.appIsrStatus
),
'process.env.__NEXT_PPR': checkIsAppPPREnabled(config.experimental.ppr), 'process.env.__NEXT_PPR': checkIsAppPPREnabled(config.experimental.ppr),
'process.env.__NEXT_AFTER': config.experimental.after ?? false, 'process.env.__NEXT_AFTER': config.experimental.after ?? false,
'process.env.NEXT_DEPLOYMENT_ID': config.deploymentId || false, 'process.env.NEXT_DEPLOYMENT_ID': config.deploymentId || false,
......
...@@ -37,6 +37,16 @@ window.console.error = (...args) => { ...@@ -37,6 +37,16 @@ window.console.error = (...args) => {
} }
} }
if (process.env.NODE_ENV === 'development') {
const initializePrerenderIndicator =
require('./components/prerender-indicator')
.default as typeof import('./components/prerender-indicator').default
initializePrerenderIndicator((handlers) => {
window.next.isrIndicatorHandlers = handlers
})
}
/// <reference types="react-dom/experimental" /> /// <reference types="react-dom/experimental" />
const appElement: HTMLElement | Document | null = document const appElement: HTMLElement | Document | null = document
......
import type { ShowHideHandler } from '../dev/dev-build-watcher'
export default function initializePrerenderIndicator(
toggleCallback: (handlers: ShowHideHandler) => void
) {
const shadowHost = document.createElement('div')
shadowHost.id = '__next-prerender-indicator'
// Make sure container is fixed and on a high zIndex so it shows
shadowHost.style.position = 'fixed'
shadowHost.style.bottom = '20px'
shadowHost.style.right = '10px'
shadowHost.style.width = '0'
shadowHost.style.height = '0'
shadowHost.style.zIndex = '99998'
shadowHost.style.transition = 'all 100ms ease'
document.body.appendChild(shadowHost)
let shadowRoot
let prefix = ''
if (shadowHost.attachShadow) {
shadowRoot = shadowHost.attachShadow({ mode: 'open' })
} else {
// If attachShadow is undefined then the browser does not support
// the Shadow DOM, we need to prefix all the names so there
// will be no conflicts
shadowRoot = shadowHost
prefix = '__next-prerender-indicator-'
}
// Container
const container = createContainer(prefix)
shadowRoot.appendChild(container)
// CSS
const css = createCss(prefix)
shadowRoot.appendChild(css)
const expandEl = container.querySelector('a')
const closeEl: HTMLDivElement | null = container.querySelector(
`#${prefix}close`
) as any
if (closeEl) {
closeEl.title = 'Click to disable indicator for one hour in this session'
}
// State
const dismissKey = '__NEXT_DISMISS_PRERENDER_INDICATOR'
const dismissUntil = parseInt(
window.localStorage.getItem(dismissKey) || '',
10
)
const dismissed = dismissUntil > new Date().getTime()
if (dismissed) return
let isVisible = false
function updateContainer() {
if (isVisible) {
container.classList.add(`${prefix}visible`)
} else {
container.classList.remove(`${prefix}visible`)
}
}
const expandedClass = `${prefix}expanded`
let toggleTimeout: ReturnType<typeof setTimeout>
const toggleExpand = (expand = true) => {
clearTimeout(toggleTimeout)
toggleTimeout = setTimeout(() => {
if (expand) {
expandEl?.classList.add(expandedClass)
if (closeEl) {
closeEl.style.display = 'flex'
}
} else {
expandEl?.classList.remove(expandedClass)
if (closeEl) {
closeEl.style.display = 'none'
}
}
}, 50)
}
closeEl?.addEventListener('click', () => {
const oneHourAway = new Date().getTime() + 1 * 60 * 60 * 1000
window.localStorage.setItem(dismissKey, oneHourAway + '')
isVisible = false
updateContainer()
})
closeEl?.addEventListener('mouseenter', () => toggleExpand())
closeEl?.addEventListener('mouseleave', () => toggleExpand(false))
expandEl?.addEventListener('mouseenter', () => toggleExpand())
expandEl?.addEventListener('mouseleave', () => toggleExpand(false))
toggleCallback({
show: () => {
isVisible = true
updateContainer()
},
hide: () => {
isVisible = false
updateContainer()
},
})
}
function createContainer(prefix: string) {
const container = document.createElement('div')
container.id = `${prefix}container`
container.innerHTML = `
<button id="${prefix}close" title="Hide indicator for session">
<span>×</span>
</button>
<a href="https://nextjs.org/docs/api-reference/next.config.js/devIndicators" target="_blank" rel="noreferrer">
<div id="${prefix}icon-wrapper">
<svg width="15" height="20" viewBox="0 0 60 80" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M36 3L30.74 41H8L36 3Z" fill="black"/>
<path d="M25 77L30.26 39H53L25 77Z" fill="black"/>
<path d="M13.5 33.5L53 39L47.5 46.5L7 41.25L13.5 33.5Z" fill="black"/>
</svg>
Prerendered Page
</div>
</a>
`
return container
}
function createCss(prefix: string) {
const css = document.createElement('style')
css.textContent = `
#${prefix}container {
position: absolute;
display: none;
bottom: 10px;
right: 15px;
}
#${prefix}close {
top: -10px;
right: -10px;
border: none;
width: 18px;
height: 18px;
color: #333333;
font-size: 16px;
cursor: pointer;
display: none;
position: absolute;
background: #ffffff;
border-radius: 100%;
align-items: center;
flex-direction: column;
justify-content: center;
}
#${prefix}container a {
color: inherit;
text-decoration: none;
width: 15px;
height: 23px;
overflow: hidden;
border-radius: 3px;
background: #fff;
color: #000;
font: initial;
cursor: pointer;
letter-spacing: initial;
text-shadow: initial;
text-transform: initial;
visibility: initial;
font-size: 14px;
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
padding: 4px 2px;
align-items: center;
box-shadow: 0 11px 40px 0 rgba(0, 0, 0, 0.25), 0 2px 10px 0 rgba(0, 0, 0, 0.12);
display: flex;
transition: opacity 0.1s ease, bottom 0.1s ease, width 0.3s ease;
animation: ${prefix}fade-in 0.1s ease-in-out;
}
#${prefix}icon-wrapper {
width: 140px;
height: 20px;
display: flex;
flex-shrink: 0;
align-items: center;
position: relative;
}
#${prefix}icon-wrapper svg {
flex-shrink: 0;
margin-right: 3px;
}
#${prefix}container a.${prefix}expanded {
width: 135px;
}
#${prefix}container.${prefix}visible {
display: flex;
bottom: 10px;
opacity: 1;
}
@keyframes ${prefix}fade-in {
from {
bottom: 0px;
opacity: 0;
}
to {
bottom: 10px;
opacity: 1;
}
}
`
return css
}
import type { ReactNode } from 'react' import type { ReactNode } from 'react'
import { useCallback, useEffect, startTransition, useMemo } from 'react' import { useCallback, useEffect, startTransition, useMemo, useRef } from 'react'
import stripAnsi from 'next/dist/compiled/strip-ansi' import stripAnsi from 'next/dist/compiled/strip-ansi'
import formatWebpackMessages from '../internal/helpers/format-webpack-messages' import formatWebpackMessages from '../internal/helpers/format-webpack-messages'
import { useRouter } from '../../navigation' import { usePathname, useRouter } from '../../navigation'
import { import {
ACTION_BEFORE_REFRESH, ACTION_BEFORE_REFRESH,
ACTION_BUILD_ERROR, ACTION_BUILD_ERROR,
...@@ -33,6 +33,7 @@ import type { ...@@ -33,6 +33,7 @@ import type {
import { extractModulesFromTurbopackMessage } from '../../../../server/dev/extract-modules-from-turbopack-message' import { extractModulesFromTurbopackMessage } from '../../../../server/dev/extract-modules-from-turbopack-message'
import { REACT_REFRESH_FULL_RELOAD_FROM_ERROR } from '../shared' import { REACT_REFRESH_FULL_RELOAD_FROM_ERROR } from '../shared'
import type { HydrationErrorState } from '../internal/helpers/hydration-error-info' import type { HydrationErrorState } from '../internal/helpers/hydration-error-info'
import type { ShowHideHandler } from '../../../dev/dev-build-watcher'
interface Dispatcher { interface Dispatcher {
onBuildOk(): void onBuildOk(): void
onBuildError(message: string): void onBuildError(message: string): void
...@@ -241,7 +242,9 @@ function processMessage( ...@@ -241,7 +242,9 @@ function processMessage(
sendMessage: (message: string) => void, sendMessage: (message: string) => void,
processTurbopackMessage: (msg: TurbopackMsgToBrowser) => void, processTurbopackMessage: (msg: TurbopackMsgToBrowser) => void,
router: ReturnType<typeof useRouter>, router: ReturnType<typeof useRouter>,
dispatcher: Dispatcher dispatcher: Dispatcher,
appIsrManifestRef: ReturnType<typeof useRef>,
pathnameRef: ReturnType<typeof useRef>
) { ) {
if (!('action' in obj)) { if (!('action' in obj)) {
return return
...@@ -292,6 +295,29 @@ function processMessage( ...@@ -292,6 +295,29 @@ function processMessage(
} }
switch (obj.action) { switch (obj.action) {
case HMR_ACTIONS_SENT_TO_BROWSER.APP_ISR_MANIFEST: {
if (process.env.__NEXT_APP_ISR_INDICATOR) {
if (appIsrManifestRef) {
appIsrManifestRef.current = obj.data
const isrIndicatorHandlers: ShowHideHandler | undefined =
window.next?.isrIndicatorHandlers
// handle initial status on receiving manifest
// navigation is handled in useEffect for pathname changes
// as we'll receive the updated manifest before usePathname
// triggers for new value
if (isrIndicatorHandlers) {
if ((pathnameRef.current as string) in obj.data) {
isrIndicatorHandlers.show()
} else {
isrIndicatorHandlers.hide()
}
}
}
}
break
}
case HMR_ACTIONS_SENT_TO_BROWSER.BUILDING: { case HMR_ACTIONS_SENT_TO_BROWSER.BUILDING: {
startLatency = Date.now() startLatency = Date.now()
console.log('[Fast Refresh] rebuilding') console.log('[Fast Refresh] rebuilding')
...@@ -522,6 +548,30 @@ export default function HotReload({ ...@@ -522,6 +548,30 @@ export default function HotReload({
) )
const router = useRouter() const router = useRouter()
const pathname = usePathname()
const appIsrManifestRef = useRef<Record<string, false | number>>({})
const pathnameRef = useRef(pathname)
if (process.env.__NEXT_APP_ISR_INDICATOR) {
// this conditional is only for dead-code elimination which
// isn't a runtime conditional only build-time so ignore hooks rule
// eslint-disable-next-line react-hooks/rules-of-hooks
useEffect(() => {
pathnameRef.current = pathname
const isrIndicatorHandlers: ShowHideHandler | undefined =
window.next?.isrIndicatorHandlers
const appIsrManifest = appIsrManifestRef.current
if (isrIndicatorHandlers && appIsrManifest) {
if (pathname in appIsrManifest) {
isrIndicatorHandlers.show()
} else {
isrIndicatorHandlers.hide()
}
}
}, [pathname])
}
useEffect(() => { useEffect(() => {
const websocket = webSocketRef.current const websocket = webSocketRef.current
...@@ -535,7 +585,9 @@ export default function HotReload({ ...@@ -535,7 +585,9 @@ export default function HotReload({
sendMessage, sendMessage,
processTurbopackMessage, processTurbopackMessage,
router, router,
dispatcher dispatcher,
appIsrManifestRef,
pathnameRef
) )
} catch (err: any) { } catch (err: any) {
console.warn( console.warn(
...@@ -546,7 +598,14 @@ export default function HotReload({ ...@@ -546,7 +598,14 @@ export default function HotReload({
websocket.addEventListener('message', handler) websocket.addEventListener('message', handler)
return () => websocket.removeEventListener('message', handler) return () => websocket.removeEventListener('message', handler)
}, [sendMessage, router, webSocketRef, dispatcher, processTurbopackMessage]) }, [
sendMessage,
router,
webSocketRef,
dispatcher,
processTurbopackMessage,
appIsrManifestRef,
])
return ( return (
<ReactDevOverlay onReactError={handleOnReactError} state={state}> <ReactDevOverlay onReactError={handleOnReactError} state={state}>
......
...@@ -59,6 +59,7 @@ export default (mode: 'webpack' | 'turbopack') => { ...@@ -59,6 +59,7 @@ export default (mode: 'webpack' | 'turbopack') => {
} }
case 'serverError': case 'serverError':
case 'devPagesManifestUpdate': case 'devPagesManifestUpdate':
case 'appIsrManifest':
case 'building': case 'building':
case 'finishBuilding': { case 'finishBuilding': {
return return
......
...@@ -609,6 +609,12 @@ async function renderToHTMLOrFlightImpl( ...@@ -609,6 +609,12 @@ async function renderToHTMLOrFlightImpl(
globalThis.__next_chunk_load__ = instrumented.loadChunk globalThis.__next_chunk_load__ = instrumented.loadChunk
} }
if (process.env.NODE_ENV === 'development') {
// reset isr status at start of request
const { pathname } = new URL(req.url || '/', 'http://n')
renderOpts.setAppIsrStatus?.(pathname, null)
}
if ( if (
// The type check here ensures that `req` is correctly typed, and the // The type check here ensures that `req` is correctly typed, and the
// environment variable check provides dead code elimination. // environment variable check provides dead code elimination.
...@@ -616,6 +622,25 @@ async function renderToHTMLOrFlightImpl( ...@@ -616,6 +622,25 @@ async function renderToHTMLOrFlightImpl(
isNodeNextRequest(req) isNodeNextRequest(req)
) { ) {
req.originalRequest.on('end', () => { req.originalRequest.on('end', () => {
const staticGenStore =
ComponentMod.staticGenerationAsyncStorage.getStore()
if (
process.env.NODE_ENV === 'development' &&
staticGenStore &&
renderOpts.setAppIsrStatus
) {
// only node can be ISR so we only need to update the status here
const { pathname } = new URL(req.url || '/', 'http://n')
let { revalidate } = staticGenStore
if (typeof revalidate === 'undefined') {
revalidate = false
}
if (revalidate === false || revalidate > 0) {
renderOpts.setAppIsrStatus(pathname, revalidate)
}
}
requestEndedState.ended = true requestEndedState.ended = true
if ('performance' in globalThis) { if ('performance' in globalThis) {
......
...@@ -150,6 +150,7 @@ export interface RenderOptsPartial { ...@@ -150,6 +150,7 @@ export interface RenderOptsPartial {
nextFontManifest?: DeepReadonly<NextFontManifest> nextFontManifest?: DeepReadonly<NextFontManifest>
isBot?: boolean isBot?: boolean
incrementalCache?: import('../lib/incremental-cache').IncrementalCache incrementalCache?: import('../lib/incremental-cache').IncrementalCache
setAppIsrStatus?: (key: string, value: false | number | null) => void
isRevalidate?: boolean isRevalidate?: boolean
nextExport?: boolean nextExport?: boolean
nextConfigOutput?: 'standalone' | 'export' nextConfigOutput?: 'standalone' | 'export'
......
...@@ -2393,6 +2393,8 @@ export default abstract class Server< ...@@ -2393,6 +2393,8 @@ export default abstract class Server<
postponed, postponed,
waitUntil: this.getWaitUntil(), waitUntil: this.getWaitUntil(),
onClose: res.onClose.bind(res), onClose: res.onClose.bind(res),
// only available in dev
setAppIsrStatus: (this as any).setAppIsrStatus,
} }
if (isDebugStaticShell || isDebugDynamicAccesses) { if (isDebugStaticShell || isDebugDynamicAccesses) {
......
...@@ -226,6 +226,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() => ...@@ -226,6 +226,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
deploymentId: z.string().optional(), deploymentId: z.string().optional(),
devIndicators: z devIndicators: z
.object({ .object({
appIsrStatus: z.boolean().optional(),
buildActivity: z.boolean().optional(), buildActivity: z.boolean().optional(),
buildActivityPosition: z buildActivityPosition: z
.union([ .union([
...@@ -250,6 +251,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() => ...@@ -250,6 +251,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
.strictObject({ .strictObject({
after: z.boolean().optional(), after: z.boolean().optional(),
appDocumentPreloading: z.boolean().optional(), appDocumentPreloading: z.boolean().optional(),
appIsrStatus: z.boolean().optional(),
preloadEntriesOnStart: z.boolean().optional(), preloadEntriesOnStart: z.boolean().optional(),
adjustFontFallbacks: z.boolean().optional(), adjustFontFallbacks: z.boolean().optional(),
adjustFontFallbacksWithSizeAdjust: z.boolean().optional(), adjustFontFallbacksWithSizeAdjust: z.boolean().optional(),
......
...@@ -683,6 +683,8 @@ export interface NextConfig extends Record<string, any> { ...@@ -683,6 +683,8 @@ export interface NextConfig extends Record<string, any> {
| 'bottom-left' | 'bottom-left'
| 'top-right' | 'top-right'
| 'top-left' | 'top-left'
appIsrStatus?: boolean
} }
/** /**
...@@ -899,6 +901,7 @@ export const defaultConfig: NextConfig = { ...@@ -899,6 +901,7 @@ export const defaultConfig: NextConfig = {
compress: true, compress: true,
images: imageConfigDefault, images: imageConfigDefault,
devIndicators: { devIndicators: {
appIsrStatus: true,
buildActivity: true, buildActivity: true,
buildActivityPosition: 'bottom-right', buildActivityPosition: 'bottom-right',
}, },
......
...@@ -546,8 +546,9 @@ export async function createHotReloaderTurbopack( ...@@ -546,8 +546,9 @@ export async function createHotReloaderTurbopack(
}, },
// TODO: Figure out if socket type can match the NextJsHotReloaderInterface // TODO: Figure out if socket type can match the NextJsHotReloaderInterface
onHMR(req, socket: Socket, head) { onHMR(req, socket: Socket, head, onUpgrade) {
wsServer.handleUpgrade(req, socket, head, (client) => { wsServer.handleUpgrade(req, socket, head, (client) => {
onUpgrade(client)
const clientIssues: EntryIssuesMap = new Map() const clientIssues: EntryIssuesMap = new Map()
const subscriptions: Map<string, AsyncIterator<any>> = new Map() const subscriptions: Map<string, AsyncIterator<any>> = new Map()
......
...@@ -22,6 +22,7 @@ export const enum HMR_ACTIONS_SENT_TO_BROWSER { ...@@ -22,6 +22,7 @@ export const enum HMR_ACTIONS_SENT_TO_BROWSER {
TURBOPACK_MESSAGE = 'turbopack-message', TURBOPACK_MESSAGE = 'turbopack-message',
SERVER_ERROR = 'serverError', SERVER_ERROR = 'serverError',
TURBOPACK_CONNECTED = 'turbopack-connected', TURBOPACK_CONNECTED = 'turbopack-connected',
APP_ISR_MANIFEST = 'appIsrManifest',
} }
interface ServerErrorAction { interface ServerErrorAction {
...@@ -105,6 +106,11 @@ export interface TurbopackConnectedAction { ...@@ -105,6 +106,11 @@ export interface TurbopackConnectedAction {
action: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED action: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED
} }
export interface AppIsrManifestAction {
action: HMR_ACTIONS_SENT_TO_BROWSER.APP_ISR_MANIFEST
data: Record<string, false | number>
}
export type HMR_ACTION_TYPES = export type HMR_ACTION_TYPES =
| TurbopackMessageAction | TurbopackMessageAction
| TurbopackConnectedAction | TurbopackConnectedAction
...@@ -120,6 +126,7 @@ export type HMR_ACTION_TYPES = ...@@ -120,6 +126,7 @@ export type HMR_ACTION_TYPES =
| ServerOnlyChangesAction | ServerOnlyChangesAction
| DevPagesManifestUpdateAction | DevPagesManifestUpdateAction
| ServerErrorAction | ServerErrorAction
| AppIsrManifestAction
export type TurbopackMsgToBrowser = export type TurbopackMsgToBrowser =
| { type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE; data: any } | { type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE; data: any }
...@@ -142,7 +149,12 @@ export interface NextJsHotReloaderInterface { ...@@ -142,7 +149,12 @@ export interface NextJsHotReloaderInterface {
stop(): Promise<void> stop(): Promise<void>
send(action: HMR_ACTION_TYPES): void send(action: HMR_ACTION_TYPES): void
getCompilationErrors(page: string): Promise<any[]> getCompilationErrors(page: string): Promise<any[]>
onHMR(req: IncomingMessage, _socket: Duplex, head: Buffer): void onHMR(
req: IncomingMessage,
_socket: Duplex,
head: Buffer,
onUpgrade: (client: { send(data: string): void }) => void
): void
invalidate({ invalidate({
reloadAfterInvalidation, reloadAfterInvalidation,
}: { }: {
......
...@@ -404,10 +404,16 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -404,10 +404,16 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
}) })
} }
public onHMR(req: IncomingMessage, _socket: Duplex, head: Buffer) { public onHMR(
req: IncomingMessage,
_socket: Duplex,
head: Buffer,
callback: (client: ws.WebSocket) => void
) {
wsServer.handleUpgrade(req, req.socket, head, (client) => { wsServer.handleUpgrade(req, req.socket, head, (client) => {
this.webpackHotMiddleware?.onHMR(client) this.webpackHotMiddleware?.onHMR(client)
this.onDemandEntries?.onHMR(client, () => this.hmrServerError) this.onDemandEntries?.onHMR(client, () => this.hmrServerError)
callback(client)
client.addEventListener('message', ({ data }) => { client.addEventListener('message', ({ data }) => {
data = typeof data !== 'string' ? data.toString() : data data = typeof data !== 'string' ? data.toString() : data
......
...@@ -2,17 +2,35 @@ import type { IncomingMessage } from 'http' ...@@ -2,17 +2,35 @@ import type { IncomingMessage } from 'http'
import type { DevBundler } from './router-utils/setup-dev-bundler' import type { DevBundler } from './router-utils/setup-dev-bundler'
import type { WorkerRequestHandler } from './types' import type { WorkerRequestHandler } from './types'
import LRUCache from 'next/dist/compiled/lru-cache'
import { createRequestResponseMocks } from './mock-request' import { createRequestResponseMocks } from './mock-request'
import { HMR_ACTIONS_SENT_TO_BROWSER } from '../dev/hot-reloader-types'
/** /**
* The DevBundlerService provides an interface to perform tasks with the * The DevBundlerService provides an interface to perform tasks with the
* bundler while in development. * bundler while in development.
*/ */
export class DevBundlerService { export class DevBundlerService {
// can't leverage LRU type directly here as it
// isn't a direct dependency
public appIsrManifestInner: {
get(key: string): number | false
set(key: string, value: number | false): void
del(key: string): void
keys(): string[]
}
constructor( constructor(
private readonly bundler: DevBundler, private readonly bundler: DevBundler,
private readonly handler: WorkerRequestHandler private readonly handler: WorkerRequestHandler
) {} ) {
this.appIsrManifestInner = new LRUCache({
max: 8_000,
length() {
return 16
},
}) as any
}
public ensurePage: typeof this.bundler.hotReloader.ensurePage = async ( public ensurePage: typeof this.bundler.hotReloader.ensurePage = async (
definition definition
...@@ -72,4 +90,27 @@ export class DevBundlerService { ...@@ -72,4 +90,27 @@ export class DevBundlerService {
return {} return {}
} }
public get appIsrManifest() {
const serializableManifest: Record<string, false | number> = {}
for (const key of this.appIsrManifestInner.keys() as string[]) {
serializableManifest[key] = this.appIsrManifestInner.get(key) as
| false
| number
}
return serializableManifest
}
public setAppIsrStatus(key: string, value: false | number | null) {
if (value === null) {
this.appIsrManifestInner.del(key)
} else {
this.appIsrManifestInner.set(key, value)
}
this.bundler?.hotReloader?.send({
action: HMR_ACTIONS_SENT_TO_BROWSER.APP_ISR_MANIFEST,
data: this.appIsrManifest,
})
}
} }
...@@ -47,6 +47,19 @@ export function deleteCache(filePaths: string[]) { ...@@ -47,6 +47,19 @@ export function deleteCache(filePaths: string[]) {
} }
} }
export async function getServerField(
dir: string,
field: PropagateToWorkersField
) {
const initialization = await initializations[dir]
if (!initialization) {
throw new Error('Invariant cant propagate server field, no app initialized')
}
const { app } = initialization
let appField = (app as any).server
return appField[field]
}
export async function propagateServerField( export async function propagateServerField(
dir: string, dir: string,
field: PropagateToWorkersField, field: PropagateToWorkersField,
......
// this must come first as it includes require hooks // this must come first as it includes require hooks
import type { WorkerRequestHandler, WorkerUpgradeHandler } from './types' import type { WorkerRequestHandler, WorkerUpgradeHandler } from './types'
import type { DevBundler } from './router-utils/setup-dev-bundler' import type { DevBundler, ServerFields } from './router-utils/setup-dev-bundler'
import type { NextUrlWithParsedQuery, RequestMeta } from '../request-meta' import type { NextUrlWithParsedQuery, RequestMeta } from '../request-meta'
import type { NextServer } from '../next' import type { NextServer } from '../next'
...@@ -41,6 +41,10 @@ import { getNextPathnameInfo } from '../../shared/lib/router/utils/get-next-path ...@@ -41,6 +41,10 @@ import { getNextPathnameInfo } from '../../shared/lib/router/utils/get-next-path
import { getHostname } from '../../shared/lib/get-hostname' import { getHostname } from '../../shared/lib/get-hostname'
import { detectDomainLocale } from '../../shared/lib/i18n/detect-domain-locale' import { detectDomainLocale } from '../../shared/lib/i18n/detect-domain-locale'
import { MockedResponse } from './mock-request' import { MockedResponse } from './mock-request'
import {
HMR_ACTIONS_SENT_TO_BROWSER,
type AppIsrManifestAction,
} from '../dev/hot-reloader-types'
const debug = setupDebug('next:router-server:main') const debug = setupDebug('next:router-server:main')
const isNextFont = (pathname: string | null) => const isNextFont = (pathname: string | null) =>
...@@ -53,6 +57,7 @@ export type RenderServer = Pick< ...@@ -53,6 +57,7 @@ export type RenderServer = Pick<
| 'clearModuleContext' | 'clearModuleContext'
| 'deleteAppClientCache' | 'deleteAppClientCache'
| 'propagateServerField' | 'propagateServerField'
| 'getServerField'
> >
export interface LazyRenderServerInstance { export interface LazyRenderServerInstance {
...@@ -603,7 +608,11 @@ export async function initialize(opts: { ...@@ -603,7 +608,11 @@ export async function initialize(opts: {
minimalMode: opts.minimalMode, minimalMode: opts.minimalMode,
dev: !!opts.dev, dev: !!opts.dev,
server: opts.server, server: opts.server,
serverFields: developmentBundler?.serverFields || {}, serverFields: {
...(developmentBundler?.serverFields || {}),
setAppIsrStatus:
devBundlerService?.setAppIsrStatus.bind(devBundlerService),
} satisfies ServerFields,
experimentalTestProxy: !!config.experimental.testProxy, experimentalTestProxy: !!config.experimental.testProxy,
experimentalHttpsServer: !!opts.experimentalHttpsServer, experimentalHttpsServer: !!opts.experimentalHttpsServer,
bundlerService: devBundlerService, bundlerService: devBundlerService,
...@@ -660,7 +669,19 @@ export async function initialize(opts: { ...@@ -660,7 +669,19 @@ export async function initialize(opts: {
// only handle HMR requests if the basePath in the request // only handle HMR requests if the basePath in the request
// matches the basePath for the handler responding to the request // matches the basePath for the handler responding to the request
if (isHMRRequest) { if (isHMRRequest) {
return developmentBundler.hotReloader.onHMR(req, socket, head) return developmentBundler.hotReloader.onHMR(
req,
socket,
head,
(client) => {
client.send(
JSON.stringify({
action: HMR_ACTIONS_SENT_TO_BROWSER.APP_ISR_MANIFEST,
data: devBundlerService?.appIsrManifest || {},
} satisfies AppIsrManifestAction)
)
}
)
} }
} }
......
...@@ -116,6 +116,7 @@ export type ServerFields = { ...@@ -116,6 +116,7 @@ export type ServerFields = {
interceptionRoutes?: ReturnType< interceptionRoutes?: ReturnType<
typeof import('./filesystem').buildCustomRoute typeof import('./filesystem').buildCustomRoute
>[] >[]
setAppIsrStatus?: (key: string, value: false | number | null) => void
} }
async function verifyTypeScript(opts: SetupOpts) { async function verifyTypeScript(opts: SetupOpts) {
......
...@@ -5,3 +5,4 @@ export type PropagateToWorkersField = ...@@ -5,3 +5,4 @@ export type PropagateToWorkersField =
| 'loadEnvConfig' | 'loadEnvConfig'
| 'appPathRoutes' | 'appPathRoutes'
| 'middleware' | 'middleware'
| 'renderOpts'
...@@ -25,6 +25,7 @@ import { PHASE_PRODUCTION_SERVER } from '../shared/lib/constants' ...@@ -25,6 +25,7 @@ import { PHASE_PRODUCTION_SERVER } from '../shared/lib/constants'
import { getTracer } from './lib/trace/tracer' import { getTracer } from './lib/trace/tracer'
import { NextServerSpan } from './lib/trace/constants' import { NextServerSpan } from './lib/trace/constants'
import { formatUrl } from '../shared/lib/router/utils/format-url' import { formatUrl } from '../shared/lib/router/utils/format-url'
import type { ServerFields } from './lib/router-utils/setup-dev-bundler'
let ServerImpl: typeof Server let ServerImpl: typeof Server
...@@ -140,7 +141,7 @@ export class NextServer { ...@@ -140,7 +141,7 @@ export class NextServer {
return server.render404(...args) return server.render404(...args)
} }
async prepare(serverFields?: any) { async prepare(serverFields?: ServerFields) {
if (this.standaloneMode) return if (this.standaloneMode) return
const server = await this.getServer() const server = await this.getServer()
......
export default function RootLayout({ children }) {
return (
<html>
<head />
<body>{children}</body>
</html>
)
}
/* eslint-disable @typescript-eslint/no-unused-vars */
import { headers } from 'next/headers'
export default async function Page() {
// headers()
return <p>hello world</p>
}
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('prerender indicator', () => {
const { next } = nextTestSetup({
files: __dirname,
})
it('should have prerender-indicator by default for static page', async () => {
const browser = await next.browser('/')
await retry(async () => {
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual(['visible'])
})
})
it('should hide the indicator when changing to dynamic', async () => {
const browser = await next.browser('/')
const origContent = await next.readFile('app/page.tsx')
await next.patchFile(
'app/page.tsx',
origContent.replace('// headers()', 'headers()')
)
try {
await retry(async () => {
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual([])
})
} finally {
await next.patchFile('app/page.tsx', origContent)
}
})
it('should not have the indicator on dynamic page on load', async () => {
const origContent = await next.readFile('app/page.tsx')
await next.patchFile(
'app/page.tsx',
origContent.replace('// headers()', 'headers()')
)
const browser = await next.browser('/')
try {
await retry(async () => {
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual([])
})
} finally {
await next.patchFile('app/page.tsx', origContent)
}
})
it('should not show the indicator if disabled in next.config', async () => {
await next.stop()
await next.patchFile(
'next.config.js',
`
module.exports = {
devIndicators: {
appIsrStatus: false
}
}
`
)
try {
await next.start()
const browser = await next.browser('/')
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual([])
} finally {
await next.deleteFile('app/page.tsx')
}
})
})
...@@ -6,7 +6,7 @@ function SubmitButton() { ...@@ -6,7 +6,7 @@ function SubmitButton() {
const { pending } = useFormStatus() const { pending } = useFormStatus()
return ( return (
<button type="submit" aria-disabled={pending}> <button type="submit" aria-disabled={pending} id="submit">
Add to cart Add to cart
</button> </button>
) )
......
...@@ -38,7 +38,7 @@ describe('app-dir action handling', () => { ...@@ -38,7 +38,7 @@ describe('app-dir action handling', () => {
await browser.elementByCss('a').click() await browser.elementByCss('a').click()
await browser.elementByCss('button').click() await browser.elementByCss('#submit').click()
await retry(async () => { await retry(async () => {
expect(await browser.elementById('result').text()).toBe('Added to cart!') expect(await browser.elementById('result').text()).toBe('Added to cart!')
......
...@@ -7,7 +7,7 @@ export default async function Page() { ...@@ -7,7 +7,7 @@ export default async function Page() {
return ( return (
<> <>
<p id="page">/variable-revalidate/revalidate-360</p> <p id="page">/</p>
<p id="page-data">{data}</p> <p id="page-data">{data}</p>
<p id="now">{Date.now()}</p> <p id="now">{Date.now()}</p>
</> </>
......
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
"packages/next/src/client/head-manager.ts", "packages/next/src/client/head-manager.ts",
"packages/next/src/client/script.tsx", "packages/next/src/client/script.tsx",
"packages/next/src/client/dev/dev-build-watcher.ts", "packages/next/src/client/dev/dev-build-watcher.ts",
"packages/next/src/client/app-bootstrap.ts" "packages/next/src/client/app-bootstrap.ts",
"packages/next/src/client/components/prerender-indicator.ts"
], ],
"ban-element-setattribute": [ "ban-element-setattribute": [
"packages/next/src/client/head-manager.ts", "packages/next/src/client/head-manager.ts",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment