-
Notifications
You must be signed in to change notification settings - Fork 26k
/
middleware.ts
381 lines (335 loc) · 9.5 KB
/
middleware.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
import { codeFrameColumns } from '@babel/code-frame'
import { constants as FS, promises as fs } from 'fs'
import { IncomingMessage, ServerResponse } from 'http'
import path from 'path'
import {
NullableMappedPosition,
RawSourceMap,
SourceMapConsumer,
} from 'source-map'
import { StackFrame } from 'stacktrace-parser'
import url from 'url'
// @ts-ignore
// eslint-disable-next-line import/no-extraneous-dependencies
import type webpack from 'webpack'
import { getRawSourceMap } from './internal/helpers/getRawSourceMap'
import { launchEditor } from './internal/helpers/launchEditor'
export { getErrorSource } from './internal/helpers/nodeStackFrames'
export {
decorateServerError,
getServerError,
} from './internal/helpers/nodeStackFrames'
export { parseStack } from './internal/helpers/parseStack'
export type OverlayMiddlewareOptions = {
rootDirectory: string
stats(): webpack.Stats | null
serverStats(): webpack.Stats | null
edgeServerStats(): webpack.Stats | null
}
export type OriginalStackFrameResponse = {
originalStackFrame: StackFrame
originalCodeFrame: string | null
}
type Source = { map: () => RawSourceMap } | null
function getModuleId(compilation: any, module: any) {
return compilation.chunkGraph.getModuleId(module)
}
function getModuleById(
id: string | undefined,
compilation: webpack.Compilation
) {
return [...compilation.modules].find(
(searchModule) => getModuleId(compilation, searchModule) === id
)
}
function findModuleNotFoundFromError(errorMessage: string | undefined) {
const match = errorMessage?.match(/'([^']+)' module/)
return match && match[1]
}
function getModuleSource(compilation: any, module: any): any {
return (
(module &&
compilation.codeGenerationResults
.get(module)
?.sources.get('javascript')) ??
null
)
}
function getSourcePath(source: string) {
// Webpack prefixes certain source paths with this path
if (source.startsWith('webpack:///')) {
return source.substring(11)
}
// Make sure library name is filtered out as well
if (source.startsWith('webpack://_N_E/')) {
return source.substring(15)
}
if (source.startsWith('webpack://')) {
return source.substring(10)
}
return source
}
async function findOriginalSourcePositionAndContent(
webpackSource: any,
position: { line: number; column: number | null }
) {
const consumer = await new SourceMapConsumer(webpackSource.map())
try {
const sourcePosition: NullableMappedPosition = consumer.originalPositionFor(
{
line: position.line,
column: position.column ?? 0,
}
)
if (!sourcePosition.source) {
return null
}
const sourceContent: string | null =
consumer.sourceContentFor(
sourcePosition.source,
/* returnNullOnMissing */ true
) ?? null
return {
sourcePosition,
sourceContent,
}
} finally {
consumer.destroy()
}
}
function findOriginalSourcePositionAndContentFromCompilation(
modulePath: string | undefined,
importedModule: string,
compilation: webpack.Compilation
) {
const module = getModuleById(modulePath, compilation)
return module?.buildInfo?.importLocByPath?.get(importedModule) ?? null
}
export async function createOriginalStackFrame({
line,
column,
source,
modulePath,
rootDirectory,
frame,
errorMessage,
compilation,
}: {
line: number
column: number | null
source: any
modulePath?: string
rootDirectory: string
frame: any
errorMessage?: string
compilation?: webpack.Compilation
}): Promise<OriginalStackFrameResponse | null> {
const moduleNotFound = findModuleNotFoundFromError(errorMessage)
const result = moduleNotFound
? findOriginalSourcePositionAndContentFromCompilation(
modulePath,
moduleNotFound,
compilation
)
: await findOriginalSourcePositionAndContent(source, {
line,
column,
})
if (result === null) {
return null
}
const { sourcePosition, sourceContent } = result
if (!sourcePosition.source) {
return null
}
const filePath = path.resolve(
rootDirectory,
modulePath || getSourcePath(sourcePosition.source)
)
const originalFrame: StackFrame = {
file: sourceContent
? path.relative(rootDirectory, filePath)
: sourcePosition.source,
lineNumber: sourcePosition.line,
column: sourcePosition.column,
methodName: frame.methodName, // TODO: resolve original method name (?)
arguments: [],
}
const originalCodeFrame: string | null =
!(originalFrame.file?.includes('node_modules') ?? true) &&
sourceContent &&
sourcePosition.line
? (codeFrameColumns(
sourceContent,
{
start: {
line: sourcePosition.line,
column: sourcePosition.column ?? 0,
},
},
{ forceColor: true }
) as string)
: null
return {
originalStackFrame: originalFrame,
originalCodeFrame,
}
}
export async function getSourceById(
isFile: boolean,
id: string,
compilation: webpack.Compilation
): Promise<Source> {
if (isFile) {
const fileContent: string | null = await fs
.readFile(id, 'utf-8')
.catch(() => null)
if (fileContent == null) {
return null
}
const map = getRawSourceMap(fileContent)
if (map == null) {
return null
}
return {
map() {
return map
},
}
}
try {
if (compilation == null) {
return null
}
const module = getModuleById(id, compilation)
return getModuleSource(compilation, module)
} catch (err) {
console.error(`Failed to lookup module by ID ("${id}"):`, err)
return null
}
}
function getOverlayMiddleware(options: OverlayMiddlewareOptions) {
return async function (
req: IncomingMessage,
res: ServerResponse,
next: Function
) {
const { pathname, query } = url.parse(req.url!, true)
if (pathname === '/__nextjs_original-stack-frame') {
const frame = query as unknown as StackFrame & {
isEdgeServer: 'true' | 'false'
isServer: 'true' | 'false'
errorMessage: string | undefined
}
if (
!(
(frame.file?.startsWith('webpack-internal:///') ||
frame.file?.startsWith('file://')) &&
Boolean(parseInt(frame.lineNumber?.toString() ?? '', 10))
)
) {
res.statusCode = 400
res.write('Bad Request')
return res.end()
}
const moduleId: string = frame.file.replace(
/^(webpack-internal:\/\/\/|file:\/\/)/,
''
)
let source: Source
const compilation =
frame.isEdgeServer === 'true'
? options.edgeServerStats()?.compilation
: frame.isServer === 'true'
? options.serverStats()?.compilation
: options.stats()?.compilation
try {
source = await getSourceById(
frame.file.startsWith('file:'),
moduleId,
compilation
)
} catch (err) {
console.log('Failed to get source map:', err)
res.statusCode = 500
res.write('Internal Server Error')
return res.end()
}
if (source == null) {
res.statusCode = 204
res.write('No Content')
return res.end()
}
const frameLine = parseInt(frame.lineNumber?.toString() ?? '', 10)
let frameColumn: number | null = parseInt(
frame.column?.toString() ?? '',
10
)
if (!frameColumn) {
frameColumn = null
}
try {
const originalStackFrameResponse = await createOriginalStackFrame({
line: frameLine,
column: frameColumn,
source,
frame,
modulePath: moduleId,
rootDirectory: options.rootDirectory,
errorMessage: frame.errorMessage,
compilation,
})
if (originalStackFrameResponse === null) {
res.statusCode = 204
res.write('No Content')
return res.end()
}
res.statusCode = 200
res.setHeader('Content-Type', 'application/json')
res.write(Buffer.from(JSON.stringify(originalStackFrameResponse)))
return res.end()
} catch (err) {
console.log('Failed to parse source map:', err)
res.statusCode = 500
res.write('Internal Server Error')
return res.end()
}
} else if (pathname === '/__nextjs_launch-editor') {
const frame = query as unknown as StackFrame
const frameFile = frame.file?.toString() || null
if (frameFile == null) {
res.statusCode = 400
res.write('Bad Request')
return res.end()
}
// frame files may start with their webpack layer, like (middleware)/middleware.js
const filePath = path.resolve(
options.rootDirectory,
frameFile.replace(/^\([^)]+\)\//, '')
)
const fileExists = await fs.access(filePath, FS.F_OK).then(
() => true,
() => false
)
if (!fileExists) {
res.statusCode = 204
res.write('No Content')
return res.end()
}
const frameLine = parseInt(frame.lineNumber?.toString() ?? '', 10) || 1
const frameColumn = parseInt(frame.column?.toString() ?? '', 10) || 1
try {
await launchEditor(filePath, frameLine, frameColumn)
} catch (err) {
console.log('Failed to launch editor:', err)
res.statusCode = 500
res.write('Internal Server Error')
return res.end()
}
res.statusCode = 204
return res.end()
}
return next()
}
}
export { getOverlayMiddleware }