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
3f4899f7
Unverified
Commit
3f4899f7
authored
Nov 21, 2024
by
Jiachi Liu
Committed by
GitHub
Nov 21, 2024
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Pass down ignored field to error overlay (#72925)
parent
80bbc755
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
164 additions
and
69 deletions
+164
-69
ignore-list.ts
packages/next/src/build/webpack/config/ignore-list.ts
+7
-0
parseNotFoundError.ts
...ack/plugins/wellknown-errors-plugin/parseNotFoundError.ts
+5
-1
CallStackFrame.tsx
...verlay/internal/container/RuntimeError/CallStackFrame.tsx
+1
-1
index.tsx
...act-dev-overlay/internal/container/RuntimeError/index.tsx
+8
-13
stack-frame.ts
...ponents/react-dev-overlay/internal/helpers/stack-frame.ts
+5
-10
middleware-turbopack.ts
...mponents/react-dev-overlay/server/middleware-turbopack.ts
+21
-10
middleware.ts
.../client/components/react-dev-overlay/server/middleware.ts
+114
-33
shared.ts
.../src/client/components/react-dev-overlay/server/shared.ts
+1
-1
setup-dev-bundler.ts
...ges/next/src/server/lib/router-utils/setup-dev-bundler.ts
+2
-0
No files found.
packages/next/src/build/webpack/config/ignore-list.ts
0 → 100644
View file @
3f4899f7
export
function
shouldIgnorePath
(
modulePath
:
string
):
boolean
{
return
(
modulePath
.
includes
(
'node_modules'
)
||
// Only relevant for when Next.js is symlinked e.g. in the Next.js monorepo
modulePath
.
includes
(
'next/dist'
)
)
}
packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts
View file @
3f4899f7
import
{
bold
,
cyan
,
green
,
red
,
yellow
}
from
'../../../../lib/picocolors'
import
{
SimpleWebpackError
}
from
'./simpleWebpackError'
import
{
createOriginalStackFrame
}
from
'../../../../client/components/react-dev-overlay/server/middleware'
import
{
createOriginalStackFrame
,
getIgnoredSources
,
}
from
'../../../../client/components/react-dev-overlay/server/middleware'
import
type
{
webpack
}
from
'next/dist/compiled/webpack/webpack'
// Based on https://github.com/webpack/webpack/blob/fcdd04a833943394bbb0a9eeb54a962a24cc7e41/lib/stats/DefaultStatsFactoryPlugin.js#L422-L431
...
...
@@ -62,6 +65,7 @@ async function getSourceFrame(
source
:
{
type
:
'bundle'
,
sourceMap
,
ignoredSources
:
getIgnoredSources
(
sourceMap
),
compilation
,
moduleId
,
modulePath
:
fileName
,
...
...
packages/next/src/client/components/react-dev-overlay/internal/container/RuntimeError/CallStackFrame.tsx
View file @
3f4899f7
...
...
@@ -37,7 +37,7 @@ export const CallStackFrame: React.FC<{
return
(
<
div
data
-
nextjs
-
call
-
stack
-
frame
>
<
h3
data
-
nextjs
-
frame
-
expanded=
{
Boolean
(
frame
.
expanded
)
}
>
<
h3
data
-
nextjs
-
frame
-
expanded=
{
!
frame
.
ignored
}
>
<
HotlinkedText
text=
{
formattedMethod
}
/>
</
h3
>
<
div
...
...
packages/next/src/client/components/react-dev-overlay/internal/container/RuntimeError/index.tsx
View file @
3f4899f7
...
...
@@ -8,34 +8,29 @@ import { GroupedStackFrames } from './GroupedStackFrames'
export
type
RuntimeErrorProps
=
{
error
:
ReadyRuntimeError
}
export
function
RuntimeError
({
error
}:
RuntimeErrorProps
)
{
const
{
frames
}
=
error
const
{
firstFrame
,
allLeadingFrames
,
allCallStackFrames
}
=
React
.
useMemo
(()
=>
{
const
filteredFrames
=
error
.
frames
// Filter out nodejs internal frames since you can't do anything about them.
// e.g. node:internal/timers shows up pretty often due to timers, but not helpful to users.
// Only present the last line before nodejs internal trace.
.
filter
((
f
)
=>
!
f
.
sourceStackFrame
.
file
?.
startsWith
(
'node:'
))
const
firstFirstPartyFrameIndex
=
filteredFrames
.
findIndex
(
const
firstFirstPartyFrameIndex
=
frames
.
findIndex
(
(
entry
)
=>
entry
.
expand
ed
&&
!
entry
.
ignor
ed
&&
Boolean
(
entry
.
originalCodeFrame
)
&&
Boolean
(
entry
.
originalStackFrame
)
)
return
{
firstFrame
:
f
ilteredF
rames
[
firstFirstPartyFrameIndex
]
??
null
,
firstFrame
:
frames
[
firstFirstPartyFrameIndex
]
??
null
,
allLeadingFrames
:
firstFirstPartyFrameIndex
<
0
?
[]
:
f
ilteredF
rames
.
slice
(
0
,
firstFirstPartyFrameIndex
),
allCallStackFrames
:
f
ilteredF
rames
.
slice
(
firstFirstPartyFrameIndex
+
1
),
:
frames
.
slice
(
0
,
firstFirstPartyFrameIndex
),
allCallStackFrames
:
frames
.
slice
(
firstFirstPartyFrameIndex
+
1
),
}
},
[
error
.
frames
])
},
[
frames
])
const
{
leadingFramesGroupedByFramework
,
stackFramesGroupedByFramework
}
=
React
.
useMemo
(()
=>
{
const
leadingFrames
=
allLeadingFrames
.
filter
((
f
)
=>
f
.
expand
ed
)
const
leadingFrames
=
allLeadingFrames
.
filter
((
f
)
=>
!
f
.
ignor
ed
)
return
{
stackFramesGroupedByFramework
:
...
...
packages/next/src/client/components/react-dev-overlay/internal/helpers/stack-frame.ts
View file @
3f4899f7
...
...
@@ -8,7 +8,7 @@ export interface OriginalStackFrame extends OriginalStackFrameResponse {
error
:
boolean
reason
:
string
|
null
external
:
boolean
expand
ed
:
boolean
ignor
ed
:
boolean
sourceStackFrame
:
StackFrame
}
...
...
@@ -49,20 +49,15 @@ function getOriginalStackFrame(
error
:
false
,
reason
:
null
,
external
:
false
,
expanded
:
!
Boolean
(
/* collapsed */
(
source
.
file
?.
includes
(
'node_modules'
)
||
body
.
originalStackFrame
?.
file
?.
includes
(
'node_modules'
)
||
body
.
originalStackFrame
?.
file
?.
startsWith
(
'[turbopack]/'
))
??
true
),
sourceStackFrame
:
source
,
originalStackFrame
:
body
.
originalStackFrame
,
originalCodeFrame
:
body
.
originalCodeFrame
||
null
,
sourcePackage
:
body
.
sourcePackage
,
ignored
:
body
.
originalStackFrame
?.
ignored
||
false
,
}
}
// TODO: merge this section into ignoredList handling
if
(
source
.
file
===
'<anonymous>'
||
source
.
file
===
'file://'
||
...
...
@@ -73,11 +68,11 @@ function getOriginalStackFrame(
error
:
false
,
reason
:
null
,
external
:
true
,
expanded
:
false
,
sourceStackFrame
:
source
,
originalStackFrame
:
null
,
originalCodeFrame
:
null
,
sourcePackage
:
null
,
ignored
:
true
,
})
}
...
...
@@ -85,11 +80,11 @@ function getOriginalStackFrame(
error
:
true
,
reason
:
err
?.
message
??
err
?.
toString
()
??
'Unknown Error'
,
external
:
false
,
expanded
:
false
,
sourceStackFrame
:
source
,
originalStackFrame
:
null
,
originalCodeFrame
:
null
,
sourcePackage
:
null
,
ignored
:
false
,
}))
}
...
...
packages/next/src/client/components/react-dev-overlay/server/middleware-turbopack.ts
View file @
3f4899f7
...
...
@@ -19,11 +19,13 @@ import type { Project, TurbopackStackFrame } from '../../../../build/swc/types'
import
{
getSourceMapFromFile
}
from
'../internal/helpers/get-source-map-from-file'
import
{
findSourceMap
}
from
'node:module'
type
IgnorableStackFrame
=
StackFrame
&
{
ignored
:
boolean
}
const
currentSourcesByFile
:
Map
<
string
,
Promise
<
string
|
null
>>
=
new
Map
()
export
async
function
batchedTraceSource
(
project
:
Project
,
frame
:
TurbopackStackFrame
):
Promise
<
{
frame
:
StackFrame
;
source
:
string
|
null
}
|
undefined
>
{
):
Promise
<
{
frame
:
Ignorable
StackFrame
;
source
:
string
|
null
}
|
undefined
>
{
const
file
=
frame
.
file
?
decodeURIComponent
(
frame
.
file
)
:
undefined
if
(
!
file
)
return
...
...
@@ -31,10 +33,15 @@ export async function batchedTraceSource(
if
(
!
sourceFrame
)
return
let
source
=
null
let
ignored
=
true
// 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
)
!
(
sourceFrame
.
file
.
includes
(
'node_modules'
)
||
// isInternal means resource starts with turbopack://[turbopack]
sourceFrame
.
isInternal
)
)
{
let
sourcePromise
=
currentSourcesByFile
.
get
(
sourceFrame
.
file
)
if
(
!
sourcePromise
)
{
...
...
@@ -46,18 +53,22 @@ export async function batchedTraceSource(
currentSourcesByFile
.
delete
(
sourceFrame
.
file
!
)
},
100
)
}
ignored
=
false
source
=
await
sourcePromise
}
// TODO: get ignoredList from turbopack source map
const
ignorableFrame
=
{
file
:
sourceFrame
.
file
,
lineNumber
:
sourceFrame
.
line
??
0
,
column
:
sourceFrame
.
column
??
0
,
methodName
:
sourceFrame
.
methodName
??
frame
.
methodName
??
'<unknown>'
,
ignored
,
arguments
:
[],
}
return
{
frame
:
{
file
:
sourceFrame
.
file
,
lineNumber
:
sourceFrame
.
line
??
0
,
column
:
sourceFrame
.
column
??
0
,
methodName
:
sourceFrame
.
methodName
??
frame
.
methodName
??
'<unknown>'
,
arguments
:
[],
},
frame
:
ignorableFrame
,
source
,
}
}
...
...
packages/next/src/client/components/react-dev-overlay/server/middleware.ts
View file @
3f4899f7
...
...
@@ -21,18 +21,43 @@ export { getSourceMapFromFile }
import
type
{
IncomingMessage
,
ServerResponse
}
from
'http'
import
type
webpack
from
'webpack'
import
type
{
RawSourceMap
}
from
'next/dist/compiled/source-map08'
import
type
{
NullableMappedPosition
,
RawSourceMap
,
}
from
'next/dist/compiled/source-map08'
import
{
formatFrameSourceFile
}
from
'../internal/helpers/webpack-module-path'
import
type
{
MappedPosition
}
from
'source-map'
function
shouldIgnorePath
(
modulePath
:
string
):
boolean
{
return
(
modulePath
.
includes
(
'node_modules'
)
||
// Only relevant for when Next.js is symlinked e.g. in the Next.js monorepo
modulePath
.
includes
(
'next/dist'
)
)
}
type
IgnoredSources
=
Array
<
{
url
:
string
;
ignored
:
boolean
}
>
export
interface
IgnorableStackFrame
extends
StackFrame
{
ignored
:
boolean
}
type
SourceAttributes
=
{
sourcePosition
:
NullableMappedPosition
sourceContent
:
string
|
null
}
type
Source
=
|
{
type
:
'file'
sourceMap
:
RawSourceMap
ignoredSources
:
IgnoredSources
modulePath
:
string
}
|
{
type
:
'bundle'
sourceMap
:
RawSourceMap
ignoredSources
:
IgnoredSources
compilation
:
webpack
.
Compilation
moduleId
:
string
modulePath
:
string
...
...
@@ -58,7 +83,7 @@ function getSourcePath(source: string) {
async
function
findOriginalSourcePositionAndContent
(
sourceMap
:
RawSourceMap
,
position
:
{
line
:
number
;
column
:
number
|
null
}
)
{
)
:
Promise
<
SourceAttributes
|
null
>
{
const
consumer
=
await
new
SourceMapConsumer
(
sourceMap
)
try
{
const
sourcePosition
=
consumer
.
originalPositionFor
({
...
...
@@ -85,9 +110,50 @@ async function findOriginalSourcePositionAndContent(
}
}
export
function
getIgnoredSources
(
sourceMap
:
RawSourceMap
):
IgnoredSources
{
const
ignoreList
=
new
Set
<
number
>
()
const
moduleFilenames
=
sourceMap
?.
sources
??
[]
for
(
let
index
=
0
;
index
<
moduleFilenames
.
length
;
index
++
)
{
// bundlerFilePath case: webpack://./app/page.tsx
const
bundlerFilePath
=
moduleFilenames
[
index
]
// Format the path to the normal file path
const
formattedFilePath
=
formatFrameSourceFile
(
bundlerFilePath
)
if
(
shouldIgnorePath
(
formattedFilePath
))
{
ignoreList
.
add
(
index
)
}
}
const
ignoredSources
=
sourceMap
.
sources
.
map
((
source
,
index
)
=>
{
return
{
url
:
source
,
ignored
:
ignoreList
.
has
(
sourceMap
.
sources
.
indexOf
(
source
)),
content
:
sourceMap
.
sourcesContent
?.[
index
]
??
null
,
}
})
return
ignoredSources
}
function
isIgnoredSource
(
source
:
Source
,
sourcePosition
:
MappedPosition
|
NullableMappedPosition
)
{
if
(
sourcePosition
.
source
==
null
)
{
return
true
}
for
(
const
ignoredSource
of
source
.
ignoredSources
)
{
if
(
ignoredSource
.
ignored
&&
ignoredSource
.
url
===
sourcePosition
.
source
)
{
return
true
}
}
return
false
}
function
createStackFrame
(
searchParams
:
URLSearchParams
)
{
const
file
=
searchParams
.
get
(
'file'
)
as
string
return
{
file
:
searchParams
.
get
(
'file'
)
as
string
,
file
,
methodName
:
searchParams
.
get
(
'methodName'
)
as
string
,
lineNumber
:
parseInt
(
searchParams
.
get
(
'lineNumber'
)
??
'0'
,
10
)
||
0
,
column
:
parseInt
(
searchParams
.
get
(
'column'
)
??
'0'
,
10
)
||
0
,
...
...
@@ -99,7 +165,7 @@ function findOriginalSourcePositionAndContentFromCompilation(
moduleId
:
string
|
undefined
,
importedModule
:
string
,
compilation
:
webpack
.
Compilation
)
{
)
:
SourceAttributes
|
null
{
const
module
=
getModuleById
(
moduleId
,
compilation
)
return
module
?.
buildInfo
?.
importLocByPath
?.
get
(
importedModule
)
??
null
}
...
...
@@ -136,27 +202,34 @@ export async function createOriginalStackFrame({
})
})()
if
(
!
result
?.
sourcePosition
.
source
)
{
if
(
!
result
)
{
return
null
}
const
{
sourcePosition
,
sourceContent
}
=
result
const
filePath
=
path
.
resolve
(
rootDirectory
,
getSourcePath
(
// When sourcePosition.source is the loader path the modulePath is generally better.
(
sourcePosition
.
source
.
includes
(
'|'
)
?
source
.
modulePath
:
sourcePosition
.
source
)
||
source
.
modulePath
)
if
(
!
sourcePosition
.
source
)
{
return
null
}
const
ignored
=
isIgnoredSource
(
source
,
sourcePosition
)
||
// If the source file is externals, should be excluded even it's not ignored source.
// e.g. webpack://next/dist/.. needs to be ignored
shouldIgnorePath
(
source
.
modulePath
)
const
sourcePath
=
getSourcePath
(
// When sourcePosition.source is the loader path the modulePath is generally better.
(
sourcePosition
.
source
!
.
includes
(
'|'
)
?
source
.
modulePath
:
sourcePosition
.
source
)
||
source
.
modulePath
)
const
filePath
=
path
.
resolve
(
rootDirectory
,
sourcePath
)
const
resolvedFilePath
=
sourceContent
?
path
.
relative
(
rootDirectory
,
filePath
)
:
sourcePosition
.
source
const
traced
=
{
const
traced
:
IgnorableStackFrame
=
{
file
:
resolvedFilePath
,
lineNumber
:
sourcePosition
.
line
,
column
:
(
sourcePosition
.
column
??
0
)
+
1
,
...
...
@@ -168,7 +241,8 @@ export async function createOriginalStackFrame({
?.
replace
(
'__WEBPACK_DEFAULT_EXPORT__'
,
'default'
)
?.
replace
(
'__webpack_exports__.'
,
''
),
arguments
:
[],
}
satisfies
StackFrame
ignored
,
}
return
{
originalStackFrame
:
traced
,
...
...
@@ -201,7 +275,7 @@ export async function getSourceMapFromCompilation(
}
}
export
async
function
getSource
(
async
function
getSource
(
filename
:
string
,
options
:
{
getCompilations
:
()
=>
webpack
.
Compilation
[]
...
...
@@ -215,11 +289,11 @@ export async function getSource(
if
(
filename
.
startsWith
(
'file:'
))
{
const
sourceMap
=
await
getSourceMapFromFile
(
filename
)
return
sourceMap
?
{
type
:
'file'
,
sourceMap
,
ignoredSources
:
getIgnoredSources
(
sourceMap
),
modulePath
:
filename
.
replace
(
/^file:
\/\/
/
,
''
),
}
:
undefined
...
...
@@ -241,9 +315,29 @@ export async function getSource(
for
(
const
compilation
of
getCompilations
())
{
// TODO: `ignoreList`
const
sourceMap
=
await
getSourceMapFromCompilation
(
moduleId
,
compilation
)
const
ignoreList
=
[]
const
moduleFilenames
=
sourceMap
?.
sources
??
[]
for
(
let
index
=
0
;
index
<
moduleFilenames
.
length
;
index
++
)
{
// bundlerFilePath case: webpack://./app/page.tsx
const
bundlerFilePath
=
moduleFilenames
[
index
]
// Format the path to the normal file path
const
formattedFilePath
=
formatFrameSourceFile
(
bundlerFilePath
)
if
(
shouldIgnorePath
(
formattedFilePath
))
{
ignoreList
.
push
(
index
)
}
}
if
(
sourceMap
)
{
return
{
type
:
'bundle'
,
sourceMap
,
compilation
,
moduleId
,
modulePath
}
const
ignoredSources
=
getIgnoredSources
(
sourceMap
)
return
{
type
:
'bundle'
,
sourceMap
,
compilation
,
moduleId
,
modulePath
,
ignoredSources
,
}
}
}
...
...
@@ -270,24 +364,11 @@ export function getOverlayMiddleware(options: {
const
isEdgeServer
=
searchParams
.
get
(
'isEdgeServer'
)
===
'true'
const
isAppDirectory
=
searchParams
.
get
(
'isAppDirectory'
)
===
'true'
const
frame
=
createStackFrame
(
searchParams
)
let
sourcePackage
=
findSourcePackage
(
frame
)
if
(
!
(
/^
(
rsc:
\/\/
React
\/[^/]
+
\/)?(
webpack-internal:
\/\/\/
|
(
file|webpack
)
:
\/\/)
/
.
test
(
frame
.
file
)
&&
frame
.
lineNumber
)
)
{
if
(
sourcePackage
)
return
json
(
res
,
{
sourcePackage
})
return
badRequest
(
res
)
}
const
formattedFilePath
=
formatFrameSourceFile
(
frame
.
file
)
const
filePath
=
path
.
join
(
rootDirectory
,
formattedFilePath
)
const
isNextjsSource
=
filePath
.
startsWith
(
NEXT_PROJECT_ROOT
)
let
sourcePackage
=
findSourcePackage
(
frame
)
let
source
:
Source
|
undefined
if
(
isNextjsSource
)
{
...
...
packages/next/src/client/components/react-dev-overlay/server/shared.ts
View file @
3f4899f7
...
...
@@ -10,7 +10,7 @@ import isInternal, {
export
type
SourcePackage
=
'react'
|
'next'
export
interface
OriginalStackFrameResponse
{
originalStackFrame
?:
StackFrame
|
null
originalStackFrame
?:
(
StackFrame
&
{
ignored
:
boolean
})
|
null
originalCodeFrame
?:
string
|
null
/** We use this to group frames in the error overlay */
sourcePackage
?:
SourcePackage
|
null
...
...
packages/next/src/server/lib/router-utils/setup-dev-bundler.ts
View file @
3f4899f7
...
...
@@ -69,6 +69,7 @@ import {
getSourceMapFromCompilation
,
getSourceMapFromFile
,
parseStack
,
getIgnoredSources
,
}
from
'../../../client/components/react-dev-overlay/server/middleware'
import
{
batchedTraceSource
,
...
...
@@ -1012,6 +1013,7 @@ async function startWatcher(opts: SetupOpts) {
type
:
'bundle'
,
sourceMap
,
compilation
,
ignoredSources
:
getIgnoredSources
(
sourceMap
),
moduleId
,
modulePath
,
},
...
...
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