Unverified Commit b3b97bc4 authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

Allow attaching a debugger when `next dev` is already running (#86083)

parent a3aadbd3
...@@ -924,5 +924,6 @@ ...@@ -924,5 +924,6 @@
"923": "%s is being parsed as a normalized route, but it has a route group or parallel route segment.", "923": "%s is being parsed as a normalized route, but it has a route group or parallel route segment.",
"924": "Invalid interception route: %s", "924": "Invalid interception route: %s",
"925": "You cannot define a route with the same specificity as an optional catch-all route (\"%s\" and \"/[[...%s]]\").", "925": "You cannot define a route with the same specificity as an optional catch-all route (\"%s\" and \"/[[...%s]]\").",
"926": "Optional route parameters are not yet supported (\"[%s]\") in route \"%s\"." "926": "Optional route parameters are not yet supported (\"[%s]\") in route \"%s\".",
"927": "No debug targets found"
} }
...@@ -23,7 +23,8 @@ export function ErrorOverlayToolbar({ ...@@ -23,7 +23,8 @@ export function ErrorOverlayToolbar({
<CopyErrorButton error={error} generateErrorInfo={generateErrorInfo} /> <CopyErrorButton error={error} generateErrorInfo={generateErrorInfo} />
<DocsLinkButton errorMessage={error.message} /> <DocsLinkButton errorMessage={error.message} />
<NodejsInspectorButton <NodejsInspectorButton
devtoolsFrontendUrl={debugInfo?.devtoolsFrontendUrl} key={debugInfo?.devtoolsFrontendUrl}
defaultDevtoolsFrontendUrl={debugInfo?.devtoolsFrontendUrl}
/> />
</span> </span>
) )
...@@ -73,6 +74,10 @@ export const styles = ` ...@@ -73,6 +74,10 @@ export const styles = `
} }
} }
.nodejs-inspector-button[data-pending='true'] {
cursor: wait;
}
.error-overlay-toolbar-button-icon { .error-overlay-toolbar-button-icon {
color: var(--color-gray-900); color: var(--color-gray-900);
} }
......
...@@ -15,12 +15,13 @@ type Story = StoryObj<typeof NodejsInspectorButton> ...@@ -15,12 +15,13 @@ type Story = StoryObj<typeof NodejsInspectorButton>
export const WithDevtoolsUrl: Story = { export const WithDevtoolsUrl: Story = {
args: { args: {
devtoolsFrontendUrl: 'chrome-devtools://devtools/bundled/inspector.html', defaultDevtoolsFrontendUrl:
'chrome-devtools://devtools/bundled/inspector.html',
}, },
} }
export const WithoutDevtoolsUrl: Story = { export const WithoutDevtoolsUrl: Story = {
args: { args: {
devtoolsFrontendUrl: undefined, defaultDevtoolsFrontendUrl: undefined,
}, },
} }
import { startTransition, useActionState, useEffect } from 'react'
import { CopyButton } from '../../copy-button' import { CopyButton } from '../../copy-button'
// Inline this helper to avoid widely used across the codebase,
// as for this feature the Chrome detector doesn't need to be super accurate.
function isChrome() {
if (typeof window === 'undefined') return false
const isChromium = 'chrome' in window && window.chrome
const vendorName = window.navigator.vendor
return (
isChromium !== null &&
isChromium !== undefined &&
vendorName === 'Google Inc.'
)
}
const isChromeBrowser = isChrome()
function NodeJsIcon(props: any) { function NodeJsIcon(props: any) {
return ( return (
<svg <svg
...@@ -248,41 +233,85 @@ function NodeJsDisabledIcon(props: any) { ...@@ -248,41 +233,85 @@ function NodeJsDisabledIcon(props: any) {
) )
} }
const label =
'Learn more about enabling Node.js inspector for server code with Chrome DevTools'
export function NodejsInspectorButton({ export function NodejsInspectorButton({
devtoolsFrontendUrl, defaultDevtoolsFrontendUrl,
}: { }: {
devtoolsFrontendUrl: string | undefined defaultDevtoolsFrontendUrl: string | undefined
}) { }) {
const content = devtoolsFrontendUrl || '' const [devtoolsFrontendUrlState, attachDebuggerAction, isAttachingDebugger] =
const disabled = !content || !isChromeBrowser useActionState<
if (disabled) { | { status: 'fulfilled'; value: string | undefined }
| { status: 'rejected'; reason: unknown }
>(
async () => {
try {
const response = await fetch('/__nextjs_attach-nodejs-inspector', {
method: 'POST',
})
if (!response.ok) {
throw new Error(
`${response.status} ${response.statusText}: ${await response.text()}`
)
}
const devtoolsFrontendUrl = await response.json()
return {
status: 'fulfilled',
value: devtoolsFrontendUrl,
}
} catch (cause) {
return {
status: 'rejected',
reason: new Error(
'Failed to attach Node.js inspector: ' +
// TODO: Use `cause` property once Redbox supports displaying `cause`
String(cause)
),
}
}
},
{ status: 'fulfilled', value: defaultDevtoolsFrontendUrl }
)
const devtoolsFrontendUrl =
devtoolsFrontendUrlState.status === 'fulfilled'
? devtoolsFrontendUrlState.value
: undefined
useEffect(() => {
if (devtoolsFrontendUrlState.status === 'rejected') {
console.error(devtoolsFrontendUrlState.reason)
}
}, [devtoolsFrontendUrlState])
const attachDebugger = startTransition.bind(null, attachDebuggerAction)
if (devtoolsFrontendUrl === undefined) {
return ( return (
<a <button
title={label}
aria-label={label}
className="nodejs-inspector-button" className="nodejs-inspector-button"
href={`https://nextjs.org/docs/app/building-your-application/configuring/debugging#server-side-code`} data-pending={isAttachingDebugger}
target="_blank" onClick={isAttachingDebugger ? undefined : attachDebugger}
rel="noopener noreferrer" title={
devtoolsFrontendUrlState.status === 'rejected'
? 'Retry attaching Node.js inspector'
: 'Attach Node.js inspector'
}
> >
<NodeJsDisabledIcon <NodeJsDisabledIcon
className="error-overlay-toolbar-button-icon" className="error-overlay-toolbar-button-icon"
width={14} width={14}
height={14} height={14}
/> />
</a> </button>
) )
} }
return ( return (
<CopyButton <CopyButton
data-nextjs-data-runtime-error-copy-devtools-url data-nextjs-data-runtime-error-copy-devtools-url
className="nodejs-inspector-button" className="nodejs-inspector-button"
actionLabel={'Copy Chrome DevTools URL'} actionLabel={'Copy DevTools URL for Chrome'}
successLabel="Copied" successLabel="Copied"
content={content} content={devtoolsFrontendUrl}
icon={ icon={
<NodeJsIcon <NodeJsIcon
className="error-overlay-toolbar-button-icon" className="error-overlay-toolbar-button-icon"
......
import { middlewareResponse } from './middleware-response'
import type { ServerResponse, IncomingMessage } from 'http'
import * as inspector from 'inspector'
export function getAttachNodejsDebuggerMiddleware() {
return async function (
req: IncomingMessage,
res: ServerResponse,
next: () => void
): Promise<void> {
const { pathname } = new URL(`http://n${req.url}`)
if (pathname !== '/__nextjs_attach-nodejs-inspector') {
return next()
}
try {
const isInspecting = inspector.url() !== undefined
const debugPort = process.debugPort
if (!isInspecting) {
// Node.js will already log that the inspector is listening.
inspector.open(debugPort)
}
const inspectorURLRaw = inspector.url()
if (inspectorURLRaw === undefined) {
// could not open, possibly because already in use.
return middlewareResponse.badRequest(
res,
`Failed to open port "${debugPort}". Address may be already in use.`
)
}
const inspectorURL = new URL(inspectorURLRaw)
const debugInfoListResponse = await fetch(
`http://${inspectorURL.host}/json/list`
)
const debugInfoList = await debugInfoListResponse.json()
if (!Array.isArray(debugInfoList) || debugInfoList.length === 0) {
throw new Error('No debug targets found')
}
return middlewareResponse.json(res, debugInfoList[0].devtoolsFrontendUrl)
} catch (error) {
return middlewareResponse.internalServerError(res)
}
}
}
...@@ -6,9 +6,14 @@ export const middlewareResponse = { ...@@ -6,9 +6,14 @@ export const middlewareResponse = {
res.statusCode = 204 res.statusCode = 204
res.end('No Content') res.end('No Content')
}, },
badRequest(res: ServerResponse) { badRequest(res: ServerResponse, reason?: string) {
res.statusCode = 400 res.statusCode = 400
res.end('Bad Request') if (reason !== undefined) {
res.setHeader('Content-Type', 'text/plain')
res.end(reason)
} else {
res.end()
}
}, },
notFound(res: ServerResponse) { notFound(res: ServerResponse) {
res.statusCode = 404 res.statusCode = 404
......
...@@ -107,6 +107,7 @@ import { ...@@ -107,6 +107,7 @@ import {
devToolsConfigMiddleware, devToolsConfigMiddleware,
getDevToolsConfig, getDevToolsConfig,
} from '../../next-devtools/server/devtools-config-middleware' } from '../../next-devtools/server/devtools-config-middleware'
import { getAttachNodejsDebuggerMiddleware } from '../../next-devtools/server/attach-nodejs-debugger-middleware'
import { import {
connectReactDebugChannel, connectReactDebugChannel,
connectReactDebugChannelForHtmlRequest, connectReactDebugChannelForHtmlRequest,
...@@ -773,6 +774,7 @@ export async function createHotReloaderTurbopack( ...@@ -773,6 +774,7 @@ export async function createHotReloaderTurbopack(
}) })
}, },
}), }),
getAttachNodejsDebuggerMiddleware(),
...(nextConfig.experimental.mcpServer ...(nextConfig.experimental.mcpServer
? [ ? [
getMcpMiddleware({ getMcpMiddleware({
......
...@@ -96,6 +96,7 @@ import { ...@@ -96,6 +96,7 @@ import {
devToolsConfigMiddleware, devToolsConfigMiddleware,
getDevToolsConfig, getDevToolsConfig,
} from '../../next-devtools/server/devtools-config-middleware' } from '../../next-devtools/server/devtools-config-middleware'
import { getAttachNodejsDebuggerMiddleware } from '../../next-devtools/server/attach-nodejs-debugger-middleware'
import { InvariantError } from '../../shared/lib/invariant-error' import { InvariantError } from '../../shared/lib/invariant-error'
import { import {
connectReactDebugChannel, connectReactDebugChannel,
...@@ -1667,6 +1668,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -1667,6 +1668,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
}) })
}, },
}), }),
getAttachNodejsDebuggerMiddleware(),
...(this.config.experimental.mcpServer ...(this.config.experimental.mcpServer
? [ ? [
getMcpMiddleware({ getMcpMiddleware({
......
...@@ -430,6 +430,7 @@ export default class DevServer extends Server { ...@@ -430,6 +430,7 @@ export default class DevServer extends Server {
*/ */
if ( if (
request.url.includes('/_next/static') || request.url.includes('/_next/static') ||
request.url.includes('/__nextjs_attach-nodejs-inspector') ||
request.url.includes('/__nextjs_original-stack-frame') || request.url.includes('/__nextjs_original-stack-frame') ||
request.url.includes('/__nextjs_source-map') || request.url.includes('/__nextjs_source-map') ||
request.url.includes('/__nextjs_error_feedback') request.url.includes('/__nextjs_error_feedback')
......
...@@ -15,6 +15,6 @@ describe('app-dir - devtool-copy-button', () => { ...@@ -15,6 +15,6 @@ describe('app-dir - devtool-copy-button', () => {
await browser await browser
.elementByCss('[data-nextjs-data-runtime-error-copy-devtools-url]') .elementByCss('[data-nextjs-data-runtime-error-copy-devtools-url]')
.getAttribute('aria-label') .getAttribute('aria-label')
).toBe('Copy Chrome DevTools URL') ).toBe('Copy DevTools URL for Chrome')
}) })
}) })
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