Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
4c62c300
Unverified
Commit
4c62c300
authored
Mar 06, 2024
by
Balázs Orbán
Committed by
GitHub
Mar 06, 2024
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
refactor(error-overlay): improve server code for webpack/Turbopack middleware (#62396)
parent
1ad3963d
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
232 additions
and
328 deletions
+232
-328
index.ts
packages/next/src/build/swc/index.ts
+9
-5
parseNotFoundError.ts
...ack/plugins/wellknown-errors-plugin/parseNotFoundError.ts
+9
-6
CallStackFrame.tsx
...verlay/internal/container/RuntimeError/CallStackFrame.tsx
+0
-1
middleware-turbopack.ts
...mponents/react-dev-overlay/server/middleware-turbopack.ts
+37
-85
middleware.ts
.../client/components/react-dev-overlay/server/middleware.ts
+87
-210
shared.ts
.../src/client/components/react-dev-overlay/server/shared.ts
+87
-13
setup-dev-bundler.ts
...ges/next/src/server/lib/router-utils/setup-dev-bundler.ts
+3
-8
No files found.
packages/next/src/build/swc/index.ts
View file @
4c62c300
...
...
@@ -600,12 +600,16 @@ export interface HmrIdentifiers {
identifiers
:
string
[]
}
interface
TurbopackStackFrame
{
column
:
number
|
null
file
:
string
/** @see https://github.com/vercel/next.js/blob/415cd74b9a220b6f50da64da68c13043e9b02995/packages/next-swc/crates/napi/src/next_api/project.rs#L824-L833 */
export
interface
TurbopackStackFrame
{
isServer
:
boolean
line
:
number
methodName
:
string
|
null
isInternal
?:
boolean
file
:
string
/** 1-indexed, unlike source map tokens */
line
?:
number
/** 1-indexed, unlike source map tokens */
column
?:
number
|
null
methodName
?:
string
}
export
type
UpdateMessage
=
...
...
packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts
View file @
4c62c300
...
...
@@ -49,18 +49,21 @@ async function getSourceFrame(
compilation
:
any
):
Promise
<
{
frame
:
string
;
lineNumber
:
string
;
column
:
string
}
>
{
try
{
const
loc
=
input
.
loc
?
input
.
loc
:
input
.
dependencies
.
map
((
d
:
any
)
=>
d
.
loc
).
filter
(
Boolean
)[
0
]
const
loc
=
input
.
loc
||
input
.
dependencies
.
map
((
d
:
any
)
=>
d
.
loc
).
filter
(
Boolean
)[
0
]
const
originalSource
=
input
.
module
.
originalSource
()
const
result
=
await
createOriginalStackFrame
({
line
:
loc
.
start
.
line
,
column
:
loc
.
start
.
column
,
source
:
originalSource
,
rootDirectory
:
compilation
.
options
.
context
!
,
modulePath
:
fileName
,
frame
:
{},
frame
:
{
arguments
:
[],
file
:
fileName
,
methodName
:
''
,
lineNumber
:
loc
.
start
.
line
,
column
:
loc
.
start
.
column
,
},
})
return
{
...
...
packages/next/src/client/components/react-dev-overlay/internal/container/RuntimeError/CallStackFrame.tsx
View file @
4c62c300
import
React
from
'react'
import
type
{
StackFrame
}
from
'next/dist/compiled/stacktrace-parser'
import
{
getFrameSource
,
...
...
packages/next/src/client/components/react-dev-overlay/server/middleware-turbopack.ts
View file @
4c62c300
import
type
{
IncomingMessage
,
ServerResponse
}
from
'http'
import
{
findSourcePackage
,
type
OriginalStackFrameResponse
}
from
'./shared'
import
{
badRequest
,
findSourcePackage
,
getOriginalCodeFrame
,
internalServerError
,
json
,
noContent
,
type
OriginalStackFrameResponse
,
}
from
'./shared'
import
fs
,
{
constants
as
FS
}
from
'fs/promises'
import
{
codeFrameColumns
}
from
'next/dist/compiled/babel/code-frame'
import
{
launchEditor
}
from
'../internal/helpers/launchEditor'
interface
Project
{
getSourceForAsset
(
filePath
:
string
):
Promise
<
string
|
null
>
traceSource
(
stackFrame
:
TurbopackStackFrame
):
Promise
<
TurbopackStackFrame
|
null
>
}
interface
TurbopackStackFrame
{
// 1-based
column
:
number
|
null
// 1-based
file
:
string
isServer
:
boolean
line
:
number
|
null
methodName
:
string
|
null
isInternal
?:
boolean
}
import
type
{
StackFrame
}
from
'next/dist/compiled/stacktrace-parser'
import
type
{
Project
,
TurbopackStackFrame
}
from
'../../../../build/swc'
const
currentSourcesByFile
:
Map
<
string
,
Promise
<
string
|
null
>>
=
new
Map
()
export
async
function
batchedTraceSource
(
project
:
Project
,
frame
:
TurbopackStackFrame
)
{
)
:
Promise
<
{
frame
:
StackFrame
;
source
:
string
|
null
}
|
undefined
>
{
const
file
=
frame
.
file
?
decodeURIComponent
(
frame
.
file
)
:
undefined
if
(
!
file
)
{
return
}
if
(
!
file
)
return
const
sourceFrame
=
await
project
.
traceSource
(
frame
)
if
(
!
sourceFrame
)
{
return
}
let
source
// Don't show code frames for node_modules. These can also often be large bundled files.
if
(
!
sourceFrame
.
file
.
includes
(
'node_modules'
)
&&
!
sourceFrame
.
isInternal
)
{
if
(
!
sourceFrame
)
return
let
source
=
null
// Don't look up source for node_modules or internals. These can often be large bundled files.
if
(
sourceFrame
.
file
&&
!
(
sourceFrame
.
file
.
includes
(
'node_modules'
)
||
sourceFrame
.
isInternal
)
)
{
let
sourcePromise
=
currentSourcesByFile
.
get
(
sourceFrame
.
file
)
if
(
!
sourcePromise
)
{
sourcePromise
=
project
.
getSourceForAsset
(
sourceFrame
.
file
)
...
...
@@ -49,7 +38,7 @@ export async function batchedTraceSource(
setTimeout
(()
=>
{
// Cache file reads for 100ms, as frames will often reference the same
// files and can be large.
currentSourcesByFile
.
delete
(
sourceFrame
.
file
)
currentSourcesByFile
.
delete
(
sourceFrame
.
file
!
)
},
100
)
}
...
...
@@ -59,12 +48,12 @@ export async function batchedTraceSource(
return
{
frame
:
{
file
:
sourceFrame
.
file
,
lineNumber
:
sourceFrame
.
line
,
column
:
sourceFrame
.
column
,
lineNumber
:
sourceFrame
.
line
??
0
,
column
:
sourceFrame
.
column
??
0
,
methodName
:
sourceFrame
.
methodName
??
frame
.
methodName
??
'<unknown>'
,
arguments
:
[],
},
source
:
source
??
null
,
source
,
}
}
...
...
@@ -74,29 +63,15 @@ export async function createOriginalStackFrame(
):
Promise
<
OriginalStackFrameResponse
|
null
>
{
const
traced
=
await
batchedTraceSource
(
project
,
frame
)
if
(
!
traced
)
{
const
sourcePackage
=
findSourcePackage
(
frame
.
file
)
const
sourcePackage
=
findSourcePackage
(
frame
)
if
(
sourcePackage
)
return
{
sourcePackage
}
return
null
}
return
{
originalStackFrame
:
traced
.
frame
,
originalCodeFrame
:
traced
.
source
===
null
?
null
:
codeFrameColumns
(
traced
.
source
,
{
start
:
{
// 1-based, but -1 means start line without highlighting
line
:
traced
.
frame
.
lineNumber
??
-
1
,
// 1-based, but 0 means whole line without column highlighting
column
:
traced
.
frame
.
column
??
0
,
},
},
{
forceColor
:
true
}
),
sourcePackage
:
findSourcePackage
(
traced
.
frame
.
file
),
originalCodeFrame
:
getOriginalCodeFrame
(
traced
.
frame
,
traced
.
source
),
sourcePackage
:
findSourcePackage
(
traced
.
frame
),
}
}
...
...
@@ -106,7 +81,7 @@ export function getOverlayMiddleware(project: Project) {
const
frame
=
{
file
:
searchParams
.
get
(
'file'
)
as
string
,
methodName
:
searchParams
.
get
(
'methodName'
),
methodName
:
searchParams
.
get
(
'methodName'
)
??
'<unknown>'
,
line
:
parseInt
(
searchParams
.
get
(
'lineNumber'
)
??
'0'
,
10
)
||
0
,
column
:
parseInt
(
searchParams
.
get
(
'column'
)
??
'0'
,
10
)
||
0
,
isServer
:
searchParams
.
get
(
'isServer'
)
===
'true'
,
...
...
@@ -117,55 +92,32 @@ export function getOverlayMiddleware(project: Project) {
try
{
originalStackFrame
=
await
createOriginalStackFrame
(
project
,
frame
)
}
catch
(
e
:
any
)
{
res
.
statusCode
=
500
res
.
write
(
e
.
message
)
res
.
end
()
return
return
internalServerError
(
res
,
e
.
message
)
}
if
(
originalStackFrame
===
null
)
{
if
(
!
originalStackFrame
)
{
res
.
statusCode
=
404
res
.
write
(
'Unable to resolve sourcemap'
)
res
.
end
()
return
return
res
.
end
(
'Unable to resolve sourcemap'
)
}
res
.
statusCode
=
200
res
.
setHeader
(
'Content-Type'
,
'application/json'
)
res
.
write
(
Buffer
.
from
(
JSON
.
stringify
(
originalStackFrame
)))
res
.
end
()
return
return
json
(
res
,
originalStackFrame
)
}
else
if
(
pathname
===
'/__nextjs_launch-editor'
)
{
if
(
!
frame
.
file
)
{
res
.
statusCode
=
400
res
.
write
(
'Bad Request'
)
res
.
end
()
return
}
if
(
!
frame
.
file
)
return
badRequest
(
res
)
const
fileExists
=
await
fs
.
access
(
frame
.
file
,
FS
.
F_OK
).
then
(
()
=>
true
,
()
=>
false
)
if
(
!
fileExists
)
{
res
.
statusCode
=
204
res
.
write
(
'No Content'
)
res
.
end
()
return
}
if
(
!
fileExists
)
return
noContent
(
res
)
try
{
launchEditor
(
frame
.
file
,
frame
.
line
??
1
,
frame
.
column
??
1
)
}
catch
(
err
)
{
console
.
log
(
'Failed to launch editor:'
,
err
)
res
.
statusCode
=
500
res
.
write
(
'Internal Server Error'
)
res
.
end
()
return
return
internalServerError
(
res
)
}
res
.
statusCode
=
204
res
.
end
()
noContent
(
res
)
}
}
}
packages/next/src/client/components/react-dev-overlay/server/middleware.ts
View file @
4c62c300
This diff is collapsed.
Click to expand it.
packages/next/src/client/components/react-dev-overlay/server/shared.ts
View file @
4c62c300
import
type
{
StackFrame
}
from
'stacktrace-parser'
import
type
{
ServerResponse
}
from
'http'
import
{
codeFrameColumns
}
from
'next/dist/compiled/babel/code-frame'
export
type
SourcePackage
=
'react'
|
'next'
export
type
OriginalStackFrameResponse
=
{
export
interface
OriginalStackFrameResponse
{
originalStackFrame
?:
StackFrame
|
null
originalCodeFrame
?:
string
|
null
/** We use this to group frames in the error overlay */
...
...
@@ -16,19 +18,91 @@ const reactVendoredRe =
/** React the user installed. Used by Pages Router, or user imports in App Router. */
const
reactNodeModulesRe
=
/node_modules
[\\/](
react|react-dom|scheduler
)[\\/]
/
const
nextRe
=
/
(
node_modules
[\\/]
next
[\\/]
|
[\\/]
.next
[\\/]
static
[\\/]
chunks
[\\/]
webpack
\.
js$
)
/
const
next
Internals
Re
=
/
(
node_modules
[\\/]
next
[\\/]
|
[\\/]
.next
[\\/]
static
[\\/]
chunks
[\\/]
webpack
\.
js$
|
(
edge-runtime-webpack|webpack-runtime
)\.
js$
)
/
/** Given a potential file path, it parses which package the file belongs to. */
export
function
findSourcePackage
(
file
:
string
|
null
):
SourcePackage
|
undefined
{
if
(
!
file
)
return
const
nextMethodRe
=
/
(
^__webpack_.*|node_modules
[\\/]
next
[\\/])
/
// matching React first since vendored would match under `next` too
if
(
reactVendoredRe
.
test
(
file
)
||
reactNodeModulesRe
.
test
(
file
))
{
return
'react'
}
else
if
(
nextRe
.
test
(
file
))
{
return
'next'
function
isInternal
(
file
:
string
|
null
)
{
if
(
!
file
)
return
false
return
(
nextInternalsRe
.
test
(
file
)
||
reactVendoredRe
.
test
(
file
)
||
reactNodeModulesRe
.
test
(
file
)
)
}
/** Given a frame, it parses which package it belongs to. */
export
function
findSourcePackage
({
file
,
methodName
,
}:
Partial
<
{
file
:
string
|
null
;
methodName
:
string
|
null
}
>
):
|
SourcePackage
|
undefined
{
if
(
file
)
{
// matching React first since vendored would match under `next` too
if
(
reactVendoredRe
.
test
(
file
)
||
reactNodeModulesRe
.
test
(
file
))
{
return
'react'
}
else
if
(
nextInternalsRe
.
test
(
file
))
{
return
'next'
}
}
if
(
methodName
)
{
if
(
nextMethodRe
.
test
(
methodName
))
{
return
'next'
}
}
}
/**
* It looks up the code frame of the traced source.
* @note It ignores node_modules or Next.js/React internals, as these can often be huge budnled files.
*/
export
function
getOriginalCodeFrame
(
frame
:
StackFrame
,
source
:
string
|
null
):
string
|
null
|
undefined
{
if
(
!
source
||
frame
.
file
?.
includes
(
'node_modules'
)
||
isInternal
(
frame
.
file
)
)
{
return
null
}
return
codeFrameColumns
(
source
,
{
start
:
{
// 1-based, but -1 means start line without highlighting
line
:
frame
.
lineNumber
??
-
1
,
// 1-based, but 0 means whole line without column highlighting
column
:
frame
.
column
??
0
,
},
},
{
forceColor
:
true
}
)
}
export
function
noContent
(
res
:
ServerResponse
)
{
res
.
statusCode
=
204
res
.
end
(
'No Content'
)
}
export
function
badRequest
(
res
:
ServerResponse
)
{
res
.
statusCode
=
400
res
.
end
(
'Bad Request'
)
}
export
function
internalServerError
(
res
:
ServerResponse
,
e
?:
any
)
{
res
.
statusCode
=
500
res
.
end
(
e
??
'Internal Server Error'
)
}
export
function
json
(
res
:
ServerResponse
,
data
:
any
)
{
res
.
setHeader
(
'Content-Type'
,
'application/json'
)
.
end
(
Buffer
.
from
(
JSON
.
stringify
(
data
)))
}
packages/next/src/server/lib/router-utils/setup-dev-bundler.ts
View file @
4c62c300
...
...
@@ -74,7 +74,7 @@ import { HMR_ACTIONS_SENT_TO_BROWSER } from '../../dev/hot-reloader-types'
import
{
PAGE_TYPES
}
from
'../../../lib/page-types'
import
{
createHotReloaderTurbopack
}
from
'../../dev/hot-reloader-turbopack'
import
{
getErrorSource
}
from
'../../../shared/lib/error-source'
import
type
{
StackFrame
}
from
'stacktrace-parser'
import
type
{
StackFrame
}
from
'
next/dist/compiled/
stacktrace-parser'
export
type
SetupOpts
=
{
renderServer
:
LazyRenderServerInstance
...
...
@@ -929,20 +929,15 @@ async function startWatcher(opts: SetupOpts) {
try
{
originalFrame
=
await
createOriginalStackFrame
({
line
:
frame
.
lineNumber
,
column
:
frame
.
column
,
source
,
frame
,
moduleId
,
modulePath
,
rootDirectory
:
opts
.
dir
,
errorMessage
:
err
.
message
,
serverCompilation
:
isEdgeCompiler
?
undefined
:
hotReloader
.
serverStats
?.
compilation
,
edgeCompilation
:
isEdgeCompiler
compilation
:
isEdgeCompiler
?
hotReloader
.
edgeServerStats
?.
compilation
:
undefined
,
:
hotReloader
.
serverStats
?.
compilation
,
})
}
catch
{}
}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment