Unverified Commit 0756f552 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

[dev-overlay]: fix inline docs to show correct info for given router (#76461)

The docs here differ depending on which router you're using. This wires the router type into overlay state so we can render different information in the popover.
parent e071b839
...@@ -42,7 +42,11 @@ export function createRootLevelDevOverlayElement(reactEl: React.ReactElement) { ...@@ -42,7 +42,11 @@ export function createRootLevelDevOverlayElement(reactEl: React.ReactElement) {
return ( return (
<FallbackLayout> <FallbackLayout>
<AppDevOverlay <AppDevOverlay
state={{ ...INITIAL_OVERLAY_STATE, rootLayoutMissingTags }} state={{
...INITIAL_OVERLAY_STATE,
rootLayoutMissingTags,
routerType: 'app',
}}
globalError={[GlobalError, null]} globalError={[GlobalError, null]}
> >
{reactEl} {reactEl}
......
...@@ -541,7 +541,7 @@ export default function HotReload({ ...@@ -541,7 +541,7 @@ export default function HotReload({
children: ReactNode children: ReactNode
globalError: [GlobalErrorComponent, React.ReactNode] globalError: [GlobalErrorComponent, React.ReactNode]
}) { }) {
const [state, dispatch] = useErrorOverlayReducer() const [state, dispatch] = useErrorOverlayReducer('app')
const dispatcher = useMemo<Dispatcher>(() => { const dispatcher = useMemo<Dispatcher>(() => {
return { return {
......
...@@ -4,7 +4,7 @@ import { useErrorOverlayReducer } from '../shared' ...@@ -4,7 +4,7 @@ import { useErrorOverlayReducer } from '../shared'
import { Router } from '../../../router' import { Router } from '../../../router'
export const usePagesDevOverlay = () => { export const usePagesDevOverlay = () => {
const [state, dispatch] = useErrorOverlayReducer() const [state, dispatch] = useErrorOverlayReducer('pages')
React.useEffect(() => { React.useEffect(() => {
Bus.on(dispatch) Bus.on(dispatch)
......
...@@ -23,6 +23,7 @@ export interface OverlayState { ...@@ -23,6 +23,7 @@ export interface OverlayState {
staticIndicator: boolean staticIndicator: boolean
disableDevIndicator: boolean disableDevIndicator: boolean
debugInfo: DebugInfo debugInfo: DebugInfo
routerType: 'pages' | 'app'
} }
export const ACTION_STATIC_INDICATOR = 'static-indicator' export const ACTION_STATIC_INDICATOR = 'static-indicator'
...@@ -101,7 +102,7 @@ function pushErrorFilterDuplicates( ...@@ -101,7 +102,7 @@ function pushErrorFilterDuplicates(
] ]
} }
export const INITIAL_OVERLAY_STATE: OverlayState = { export const INITIAL_OVERLAY_STATE: Omit<OverlayState, 'routerType'> = {
nextId: 1, nextId: 1,
buildError: null, buildError: null,
errors: [], errors: [],
...@@ -114,7 +115,16 @@ export const INITIAL_OVERLAY_STATE: OverlayState = { ...@@ -114,7 +115,16 @@ export const INITIAL_OVERLAY_STATE: OverlayState = {
debugInfo: { devtoolsFrontendUrl: undefined }, debugInfo: { devtoolsFrontendUrl: undefined },
} }
export function useErrorOverlayReducer() { function getInitialState(
routerType: 'pages' | 'app'
): OverlayState & { routerType: 'pages' | 'app' } {
return {
...INITIAL_OVERLAY_STATE,
routerType,
}
}
export function useErrorOverlayReducer(routerType: 'pages' | 'app') {
return useReducer((_state: OverlayState, action: BusEvent): OverlayState => { return useReducer((_state: OverlayState, action: BusEvent): OverlayState => {
switch (action.type) { switch (action.type) {
case ACTION_DEBUG_INFO: { case ACTION_DEBUG_INFO: {
...@@ -188,7 +198,7 @@ export function useErrorOverlayReducer() { ...@@ -188,7 +198,7 @@ export function useErrorOverlayReducer() {
return _state return _state
} }
} }
}, INITIAL_OVERLAY_STATE) }, getInitialState(routerType))
} }
export const REACT_REFRESH_FULL_RELOAD_FROM_ERROR = export const REACT_REFRESH_FULL_RELOAD_FROM_ERROR =
......
...@@ -51,6 +51,7 @@ const mockVersionInfo: VersionInfo = { ...@@ -51,6 +51,7 @@ const mockVersionInfo: VersionInfo = {
} }
const state: OverlayState = { const state: OverlayState = {
routerType: 'app',
nextId: 1, nextId: 1,
buildError: null, buildError: null,
errors: [], errors: [],
......
...@@ -41,6 +41,7 @@ export function DevToolsIndicator({ ...@@ -41,6 +41,7 @@ export function DevToolsIndicator({
return ( return (
<DevToolsPopover <DevToolsPopover
routerType={state.routerType}
semver={state.versionInfo.installed} semver={state.versionInfo.installed}
issueCount={errorCount} issueCount={errorCount}
isStaticRoute={state.staticIndicator} isStaticRoute={state.staticIndicator}
...@@ -70,6 +71,7 @@ interface C { ...@@ -70,6 +71,7 @@ interface C {
const Context = createContext({} as C) const Context = createContext({} as C)
function DevToolsPopover({ function DevToolsPopover({
routerType,
disabled, disabled,
issueCount, issueCount,
isStaticRoute, isStaticRoute,
...@@ -79,6 +81,7 @@ function DevToolsPopover({ ...@@ -79,6 +81,7 @@ function DevToolsPopover({
hide, hide,
setIsErrorOverlayOpen, setIsErrorOverlayOpen,
}: { }: {
routerType: 'pages' | 'app'
disabled: boolean disabled: boolean
issueCount: number issueCount: number
isStaticRoute: boolean isStaticRoute: boolean
...@@ -283,6 +286,7 @@ function DevToolsPopover({ ...@@ -283,6 +286,7 @@ function DevToolsPopover({
{routeInfoMounted && ( {routeInfoMounted && (
<RouteInfo <RouteInfo
ref={routeInfoRef} ref={routeInfoRef}
routerType={routerType}
routeType={isStaticRoute ? 'Static' : 'Dynamic'} routeType={isStaticRoute ? 'Static' : 'Dynamic'}
isOpen={isRouteInfoOpen} isOpen={isRouteInfoOpen}
setIsOpen={setIsRouteInfoOpen} setIsOpen={setIsRouteInfoOpen}
......
import { DevToolsInfo } from './dev-tools-info' import { DevToolsInfo } from './dev-tools-info'
function StaticRouteContent() { function StaticRouteContent({ routerType }: { routerType: 'pages' | 'app' }) {
return ( return (
<article className="dev-tools-info-article"> <article className="dev-tools-info-article">
<p className="dev-tools-info-paragraph"> <p className="dev-tools-info-paragraph">
...@@ -14,7 +14,11 @@ function StaticRouteContent() { ...@@ -14,7 +14,11 @@ function StaticRouteContent() {
background after{' '} background after{' '}
<a <a
className="dev-tools-info-link" className="dev-tools-info-link"
href="https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration" href={
routerType === 'pages'
? 'https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration'
: `https://nextjs.org/docs/app/building-your-application/data-fetching/incremental-static-regeneration`
}
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
> >
...@@ -31,7 +35,7 @@ function StaticRouteContent() { ...@@ -31,7 +35,7 @@ function StaticRouteContent() {
) )
} }
function DynamicRouteContent() { function DynamicRouteContent({ routerType }: { routerType: 'pages' | 'app' }) {
return ( return (
<article className="dev-tools-info-article"> <article className="dev-tools-info-article">
<p className="dev-tools-info-paragraph"> <p className="dev-tools-info-paragraph">
...@@ -45,42 +49,75 @@ function DynamicRouteContent() { ...@@ -45,42 +49,75 @@ function DynamicRouteContent() {
to the user or has information that can only be known at request time, to the user or has information that can only be known at request time,
such as cookies or the URL's search params. such as cookies or the URL's search params.
</p> </p>
<p className="dev-tools-info-paragraph"> {routerType === 'pages' ? (
During rendering, if a{' '} <p className="dev-tools-info-pagraph">
<a Exporting the{' '}
className="dev-tools-info-link" <a
href="https://nextjs.org/docs/app/building-your-application/rendering/server-components#dynamic-apis" className="dev-tools-info-link"
target="_blank" href="https://nextjs.org/docs/pages/building-your-application/data-fetching/get-server-side-props"
rel="noopener noreferrer" target="_blank"
> rel="noopener noreferrer"
Dynamic API >
</a>{' '} getServerSideProps
or a{' '} </a>{' '}
<a function will opt the route into dynamic rendering. This function will
className="dev-tools-info-link" be called by the server on every request.
href="https://nextjs.org/docs/app/api-reference/functions/fetch" </p>
target="_blank" ) : (
rel="noopener noreferrer" <p className="dev-tools-info-paragraph">
> During rendering, if a{' '}
fetch <a
</a>{' '} className="dev-tools-info-link"
option of{' '} href="https://nextjs.org/docs/app/building-your-application/rendering/server-components#dynamic-apis"
<code className="dev-tools-info-code">{`{ cache: 'no-store' }`}</code>{' '} target="_blank"
is discovered, Next.js will switch to dynamically rendering the whole rel="noopener noreferrer"
route. >
</p> Dynamic API
</a>{' '}
or a{' '}
<a
className="dev-tools-info-link"
href="https://nextjs.org/docs/app/api-reference/functions/fetch"
target="_blank"
rel="noopener noreferrer"
>
fetch
</a>{' '}
option of{' '}
<code className="dev-tools-info-code">{`{ cache: 'no-store' }`}</code>{' '}
is discovered, Next.js will switch to dynamically rendering the whole
route.
</p>
)}
</article> </article>
) )
} }
const learnMoreLink = {
pages: {
static:
'https://nextjs.org/docs/pages/building-your-application/rendering/static-site-generation',
dynamic:
'https://nextjs.org/docs/pages/building-your-application/rendering/server-side-rendering',
},
app: {
static:
'https://nextjs.org/docs/app/building-your-application/rendering/server-components#static-rendering-default',
dynamic:
'https://nextjs.org/docs/app/building-your-application/rendering/server-components#dynamic-rendering',
},
}
export function RouteInfo({ export function RouteInfo({
routeType, routeType,
routerType,
isOpen, isOpen,
setIsOpen, setIsOpen,
setPreviousOpen, setPreviousOpen,
...props ...props
}: { }: {
routeType: 'Static' | 'Dynamic' routeType: 'Static' | 'Dynamic'
routerType: 'pages' | 'app'
isOpen: boolean isOpen: boolean
setIsOpen: (isOpen: boolean) => void setIsOpen: (isOpen: boolean) => void
setPreviousOpen: (isOpen: boolean) => void setPreviousOpen: (isOpen: boolean) => void
...@@ -88,18 +125,23 @@ export function RouteInfo({ ...@@ -88,18 +125,23 @@ export function RouteInfo({
ref?: React.RefObject<HTMLElement | null> ref?: React.RefObject<HTMLElement | null>
}) { }) {
const isStaticRoute = routeType === 'Static' const isStaticRoute = routeType === 'Static'
const learnMoreLink = isStaticRoute
? 'https://nextjs.org/docs/app/building-your-application/rendering/server-components#static-rendering-default' const learnMore = isStaticRoute
: 'https://nextjs.org/docs/app/building-your-application/rendering/server-components#dynamic-rendering' ? learnMoreLink[routerType].static
: learnMoreLink[routerType].dynamic
return ( return (
<DevToolsInfo <DevToolsInfo
{...props} {...props}
title={`${routeType} Route`} title={`${routeType} Route`}
learnMoreLink={learnMoreLink} learnMoreLink={learnMore}
setIsOpen={setIsOpen} setIsOpen={setIsOpen}
setPreviousOpen={setPreviousOpen} setPreviousOpen={setPreviousOpen}
> >
{isStaticRoute ? <StaticRouteContent /> : <DynamicRouteContent />} {isStaticRoute ? (
<StaticRouteContent routerType={routerType} />
) : (
<DynamicRouteContent routerType={routerType} />
)}
</DevToolsInfo> </DevToolsInfo>
) )
} }
......
...@@ -17,6 +17,7 @@ type Story = StoryObj<typeof DevOverlay> ...@@ -17,6 +17,7 @@ type Story = StoryObj<typeof DevOverlay>
const state: OverlayState = { const state: OverlayState = {
nextId: 0, nextId: 0,
routerType: 'app',
buildError: null, buildError: null,
disableDevIndicator: false, disableDevIndicator: false,
errors: [ errors: [
......
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