Unverified Commit e9990a6a authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Move static indicator into dev overlay (#68369)

This moves the static indicator we added for the app router into the dev
overlay so it can share the logic/be aware when either are showing to
coordinate position. This also applies similar design to make the look
more consistent as well.



https://github.com/user-attachments/assets/bca899d4-0635-4868-8284-02f0cb4b5444

Closes: NDX-74
parent 86fe199d
......@@ -41,16 +41,6 @@ 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" />
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/app/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
}
......@@ -4,12 +4,14 @@ import { ACTION_UNHANDLED_ERROR, type OverlayState } from '../shared'
import { ShadowPortal } from '../internal/components/ShadowPortal'
import { BuildError } from '../internal/container/BuildError'
import { Errors } from '../internal/container/Errors'
import { StaticIndicator } from '../internal/container/StaticIndicator'
import type { SupportedErrorEvent } from '../internal/container/Errors'
import { parseStack } from '../internal/helpers/parseStack'
import { Base } from '../internal/styles/Base'
import { ComponentStyles } from '../internal/styles/ComponentStyles'
import { CssReset } from '../internal/styles/CssReset'
import { RootLayoutMissingTagsError } from '../internal/container/root-layout-missing-tags-error'
import type { Dispatcher } from './hot-reloader-client'
interface ReactDevOverlayState {
reactError: SupportedErrorEvent | null
......@@ -17,6 +19,7 @@ interface ReactDevOverlayState {
export default class ReactDevOverlay extends React.PureComponent<
{
state: OverlayState
dispatcher?: Dispatcher
children: React.ReactNode
onReactError: (error: Error) => void
},
......@@ -43,14 +46,12 @@ export default class ReactDevOverlay extends React.PureComponent<
}
render() {
const { state, children } = this.props
const { state, children, dispatcher } = this.props
const { reactError } = this.state
const hasBuildError = state.buildError != null
const hasRuntimeErrors = Boolean(state.errors.length)
const hasMissingTags = Boolean(state.rootLayoutMissingTags?.length)
const isMounted =
hasBuildError || hasRuntimeErrors || reactError || hasMissingTags
const hasStaticIndicator = state.staticIndicator
return (
<>
......@@ -62,37 +63,45 @@ export default class ReactDevOverlay extends React.PureComponent<
) : (
children
)}
{isMounted ? (
<ShadowPortal>
<CssReset />
<Base />
<ComponentStyles />
{state.rootLayoutMissingTags?.length ? (
<RootLayoutMissingTagsError
missingTags={state.rootLayoutMissingTags}
/>
) : hasBuildError ? (
<BuildError
message={state.buildError!}
versionInfo={state.versionInfo}
/>
) : reactError ? (
<Errors
isAppDir={true}
versionInfo={state.versionInfo}
initialDisplayState="fullscreen"
errors={[reactError]}
/>
) : hasRuntimeErrors ? (
<Errors
isAppDir={true}
initialDisplayState="minimized"
errors={state.errors}
versionInfo={state.versionInfo}
/>
) : undefined}
</ShadowPortal>
) : undefined}
<ShadowPortal>
<CssReset />
<Base />
<ComponentStyles />
{state.rootLayoutMissingTags?.length ? (
<RootLayoutMissingTagsError
missingTags={state.rootLayoutMissingTags}
/>
) : hasBuildError ? (
<BuildError
message={state.buildError!}
versionInfo={state.versionInfo}
/>
) : (
<>
{reactError ? (
<Errors
isAppDir={true}
versionInfo={state.versionInfo}
initialDisplayState="fullscreen"
errors={[reactError]}
hasStaticIndicator={hasStaticIndicator}
/>
) : hasRuntimeErrors ? (
<Errors
isAppDir={true}
initialDisplayState="minimized"
errors={state.errors}
versionInfo={state.versionInfo}
hasStaticIndicator={hasStaticIndicator}
/>
) : null}
{hasStaticIndicator && (
<StaticIndicator dispatcher={dispatcher} />
)}
</>
)}
</ShadowPortal>
</>
)
}
......
......@@ -8,6 +8,7 @@ import {
ACTION_BUILD_ERROR,
ACTION_BUILD_OK,
ACTION_REFRESH,
ACTION_STATIC_INDICATOR,
ACTION_UNHANDLED_ERROR,
ACTION_UNHANDLED_REJECTION,
ACTION_VERSION_INFO,
......@@ -33,13 +34,14 @@ import type {
import { extractModulesFromTurbopackMessage } from '../../../../server/dev/extract-modules-from-turbopack-message'
import { REACT_REFRESH_FULL_RELOAD_FROM_ERROR } from '../shared'
import type { HydrationErrorState } from '../internal/helpers/hydration-error-info'
import type { ShowHideHandler } from '../../../dev/dev-build-watcher'
interface Dispatcher {
export interface Dispatcher {
onBuildOk(): void
onBuildError(message: string): void
onVersionInfo(versionInfo: VersionInfo): void
onBeforeRefresh(): void
onRefresh(): void
onStaticIndicator(status: boolean): void
}
let mostRecentCompilationHash: any = null
......@@ -323,19 +325,14 @@ function processMessage(
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()
}
if ((pathnameRef.current as string) in obj.data) {
dispatcher.onStaticIndicator(true)
} else {
dispatcher.onStaticIndicator(false)
}
}
}
......@@ -527,6 +524,9 @@ export default function HotReload({
onVersionInfo(versionInfo) {
dispatch({ type: ACTION_VERSION_INFO, versionInfo })
},
onStaticIndicator(status: boolean) {
dispatch({ type: ACTION_STATIC_INDICATOR, staticIndicator: status })
},
}
}, [dispatch])
......@@ -585,19 +585,17 @@ export default function HotReload({
// 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 (appIsrManifest) {
if (pathname in appIsrManifest) {
isrIndicatorHandlers.show()
dispatcher.onStaticIndicator(true)
} else {
isrIndicatorHandlers.hide()
dispatcher.onStaticIndicator(false)
}
}
}, [pathname])
}, [pathname, dispatcher])
}
useEffect(() => {
......@@ -635,7 +633,11 @@ export default function HotReload({
])
return (
<ReactDevOverlay onReactError={handleOnReactError} state={state}>
<ReactDevOverlay
onReactError={handleOnReactError}
state={state}
dispatcher={dispatcher}
>
{children}
</ReactDevOverlay>
)
......
......@@ -10,15 +10,16 @@ export const Toast: React.FC<ToastProps> = function Toast({
onClick,
children,
className,
...props
}) {
return (
<div
data-nextjs-toast
{...props}
onClick={(e) => {
e.preventDefault()
return onClick?.()
}}
className={className}
className={`nextjs-toast${className ? ' ' + className : ''}`}
>
<div data-nextjs-toast-wrapper>{children}</div>
</div>
......
import { noop as css } from '../../helpers/noop-template'
const styles = css`
[data-nextjs-toast] {
.nextjs-toast {
position: fixed;
bottom: var(--size-gap-double);
left: var(--size-gap-double);
max-width: 420px;
z-index: 9000;
box-shadow: 0px var(--size-gap-double) var(--size-gap-quad)
rgba(0, 0, 0, 0.25);
}
@media (max-width: 440px) {
[data-nextjs-toast] {
.nextjs-toast {
max-width: 90vw;
left: 5vw;
}
}
[data-nextjs-toast-wrapper] {
.nextjs-toast-errors-parent {
padding: 16px;
border-radius: var(--size-gap-half);
border-radius: var(--size-gap-quad);
font-weight: 500;
color: var(--color-ansi-bright-white);
background-color: var(--color-ansi-red);
box-shadow: 0px var(--size-gap-double) var(--size-gap-quad)
rgba(0, 0, 0, 0.25);
}
.nextjs-static-indicator-toast-wrapper {
padding: 8px 16px;
border-radius: var(--size-gap-triple);
background: var(--color-background);
color: var(--color-font);
}
.nextjs-static-indicator-toast-wrapper div {
display: flex;
flex-direction: row;
align-items: center;
}
.nextjs-static-indicator-toast-wrapper span {
padding: 4px;
margin: 0;
}
`
......
......@@ -38,6 +38,7 @@ export type ErrorsProps = {
errors: SupportedErrorEvent[]
initialDisplayState: DisplayState
versionInfo?: VersionInfo
hasStaticIndicator?: boolean
}
type ReadyErrorEvent = ReadyRuntimeError
......@@ -69,6 +70,7 @@ export function Errors({
errors,
initialDisplayState,
versionInfo,
hasStaticIndicator,
}: ErrorsProps) {
const [lookups, setLookups] = useState(
{} as { [eventId: string]: ReadyErrorEvent }
......@@ -184,7 +186,11 @@ export function Errors({
if (displayState === 'minimized') {
return (
<Toast className="nextjs-toast-errors-parent" onClick={fullscreen}>
<Toast
data-nextjs-toast
className={`nextjs-toast-errors-parent${hasStaticIndicator ? ' nextjs-error-with-static' : ''}`}
onClick={fullscreen}
>
<div className="nextjs-toast-errors">
<svg
xmlns="http://www.w3.org/2000/svg"
......@@ -206,7 +212,7 @@ export function Errors({
</span>
<button
data-nextjs-toast-errors-hide-button
className="nextjs-toast-errors-hide-button"
className="nextjs-toast-hide-button"
type="button"
onClick={(e) => {
e.stopPropagation()
......@@ -323,6 +329,9 @@ export function Errors({
}
export const styles = css`
.nextjs-error-with-static {
bottom: calc(var(--size-gap-double) * 4.5);
}
.nextjs-container-errors-header {
position: relative;
}
......@@ -397,7 +406,7 @@ export const styles = css`
.nextjs-toast-errors > svg {
margin-right: var(--size-gap);
}
.nextjs-toast-errors-hide-button {
.nextjs-toast-hide-button {
margin-left: var(--size-gap-triple);
border: none;
background: none;
......@@ -406,7 +415,7 @@ export const styles = css`
transition: opacity 0.25s ease;
opacity: 0.7;
}
.nextjs-toast-errors-hide-button:hover {
.nextjs-toast-hide-button:hover {
opacity: 1;
}
.nextjs-container-errors-header
......
import { Toast } from '../components/Toast'
import { LightningBolt } from '../icons/LightningBolt'
import { CloseIcon } from '../icons/CloseIcon'
import type { Dispatcher } from '../../app/hot-reloader-client'
export function StaticIndicator({ dispatcher }: { dispatcher?: Dispatcher }) {
return (
<Toast className="nextjs-static-indicator-toast-wrapper">
<LightningBolt />
<span>
Statically rendered page.{' '}
<a
onClick={(e) => e.stopPropagation()}
href="https://nextjs.org/docs/app/api-reference/next-config-js/devIndicators"
target="_blank"
rel="noreferrer"
>
Learn more
</a>
</span>
<button
onClick={() => {
dispatcher?.onStaticIndicator(false)
}}
className="nextjs-toast-hide-button"
style={{ marginLeft: 'var(--size-gap)' }}
>
<CloseIcon />
</button>
</Toast>
)
}
export const LightningBolt = (props: React.SVGProps<any>) => (
<svg
xmlns="http://www.w3.org/2000/svg"
width={16}
height={16}
fill="none"
{...props}
>
<path
style={{ fill: 'var(--color-font)' }}
fillRule="evenodd"
d="M7.157 0 2.333 9.408l-.56 1.092H7a.25.25 0 0 1 .25.25V16h1.593l4.824-9.408.56-1.092H9a.25.25 0 0 1-.25-.25V0H7.157ZM7 9H4.227L7.25 3.106V5.25C7.25 6.216 8.034 7 9 7h2.773L8.75 12.894V10.75A1.75 1.75 0 0 0 7 9Z"
clipRule="evenodd"
/>
</svg>
)
......@@ -19,8 +19,10 @@ export interface OverlayState {
rootLayoutMissingTags: typeof window.__next_root_layout_missing_tags
versionInfo: VersionInfo
notFound: boolean
staticIndicator: boolean
}
export const ACTION_STATIC_INDICATOR = 'static-indicator'
export const ACTION_BUILD_OK = 'build-ok'
export const ACTION_BUILD_ERROR = 'build-error'
export const ACTION_BEFORE_REFRESH = 'before-fast-refresh'
......@@ -29,6 +31,11 @@ export const ACTION_VERSION_INFO = 'version-info'
export const ACTION_UNHANDLED_ERROR = 'unhandled-error'
export const ACTION_UNHANDLED_REJECTION = 'unhandled-rejection'
interface StaticIndicatorAction {
type: typeof ACTION_STATIC_INDICATOR
staticIndicator: boolean
}
interface BuildOkAction {
type: typeof ACTION_BUILD_OK
}
......@@ -69,6 +76,7 @@ export type BusEvent =
| UnhandledErrorAction
| UnhandledRejectionAction
| VersionInfoAction
| StaticIndicatorAction
function pushErrorFilterDuplicates(
errors: SupportedErrorEvent[],
......@@ -88,6 +96,7 @@ export const INITIAL_OVERLAY_STATE: OverlayState = {
buildError: null,
errors: [],
notFound: false,
staticIndicator: false,
refreshState: { type: 'idle' },
rootLayoutMissingTags: [],
versionInfo: { installed: '0.0.0', staleness: 'unknown' },
......@@ -96,6 +105,9 @@ export const INITIAL_OVERLAY_STATE: OverlayState = {
export function useErrorOverlayReducer() {
return useReducer((_state: OverlayState, action: BusEvent): OverlayState => {
switch (action.type) {
case ACTION_STATIC_INDICATOR: {
return { ..._state, staticIndicator: action.staticIndicator }
}
case ACTION_BUILD_OK: {
return { ..._state, buildError: null }
}
......
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
import { BrowserInterface } from 'next-webdriver'
describe('prerender indicator', () => {
const { next } = nextTestSetup({
files: __dirname,
})
async function hasStaticIndicator(browser: BrowserInterface) {
const staticIndicatorPresent = await browser.eval(() =>
Boolean(
document
.querySelector('nextjs-portal')
.shadowRoot.querySelector('.nextjs-static-indicator-toast-wrapper')
)
)
return staticIndicatorPresent
}
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'])
expect(await hasStaticIndicator(browser)).toBe(true)
})
})
......@@ -31,14 +37,7 @@ describe('prerender indicator', () => {
try {
await retry(async () => {
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual([])
expect(await hasStaticIndicator(browser)).toBe(false)
})
} finally {
await next.patchFile('app/page.tsx', origContent)
......@@ -57,13 +56,7 @@ describe('prerender indicator', () => {
try {
await retry(async () => {
const classNames = await browser.eval(() => [
...document
.querySelector('#__next-prerender-indicator')
.shadowRoot.querySelector('#container')
.classList.values(),
])
expect(classNames).toEqual([])
expect(await hasStaticIndicator(browser)).toBe(false)
})
} finally {
await next.patchFile('app/page.tsx', origContent)
......@@ -87,14 +80,7 @@ describe('prerender indicator', () => {
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([])
expect(await hasStaticIndicator(browser)).toBe(false)
} finally {
await next.deleteFile('app/page.tsx')
}
......
'use client'
export function Button() {
return (
<button
onClick={() => {
throw new Error('oof')
}}
>
click me!
</button>
)
}
import { Button } from './button'
export default async function Page() {
console.log('rendering index')
......@@ -10,6 +12,7 @@ export default async function Page() {
<p id="page">/</p>
<p id="page-data">{data}</p>
<p id="now">{Date.now()}</p>
<Button />
</>
)
}
......@@ -837,6 +837,7 @@ describe('app dir - navigation', () => {
// throttling the CPU to rule out flakiness based on how quickly the page loads
cpuThrottleRate: 6,
})
const body = await browser.elementByCss('body')
expect(await body.text()).toContain('Item 50')
await browser.elementById('load-more').click()
......
......@@ -8,4 +8,9 @@ module.exports = {
},
]
},
// scroll position can be finicky with the
// indicators showing so hide by default
devIndicators: {
appIsrStatus: false,
},
}
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