{{ message }}
Repository navigation
Expand file tree
/
Copy pathlistener.ts
More file actions
538 lines (491 loc) · 17.2 KB
/
Copy pathlistener.ts
File metadata and controls
538 lines (491 loc) · 17.2 KB
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
import { ServerResponse } from 'node:http'
import type { IncomingMessage, OutgoingHttpHeaders } from 'node:http'
import { Http2ServerRequest, constants as h2constants } from 'node:http2'
import type { Http2ServerResponse } from 'node:http2'
import type { Writable } from 'node:stream'
import type { IncomingMessageWithWrapBodyStream } from './request'
import {
abortRequest,
newRequest,
recordBodyBufferedBeforeDisconnect,
Request as LightweightRequest,
wrapBodyStream,
toRequestError,
} from './request'
import { defaultContentType, cacheKey, Response as LightweightResponse } from './response'
import type { InternalCache } from './response'
import type { CustomErrorHandler, FetchCallback, HttpBindings } from './types'
import {
readWithoutBlocking,
writeFromReadableStream,
writeFromReadableStreamDefaultReader,
buildOutgoingHttpHeaders,
} from './utils'
import { X_ALREADY_SENT } from './utils/response/constants'
const outgoingEnded = Symbol('outgoingEnded')
const incomingDraining = Symbol('incomingDraining')
type OutgoingHasOutgoingEnded = Http2ServerResponse & {
[outgoingEnded]?: () => void
}
type IncomingHasDrainState = (IncomingMessage | Http2ServerRequest) & {
[incomingDraining]?: boolean
}
type Http1ResponseWithContentLength = ServerResponse & {
_contentLength: number | null
_hasBody: boolean
_removedContLen: boolean
}
const DRAIN_TIMEOUT_MS = 500
const MAX_DRAIN_BYTES = 64 * 1024 * 1024
const drainIncoming = (incoming: IncomingMessage | Http2ServerRequest): void => {
const incomingWithDrainState = incoming as IncomingHasDrainState
if (incoming.destroyed || incomingWithDrainState[incomingDraining]) {
return
}
incomingWithDrainState[incomingDraining] = true
// HTTP/2: streams are multiplexed, so we can close immediately
// without risking TCP RST racing the response.
if (incoming instanceof Http2ServerRequest) {
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(incoming as any).stream?.close?.(h2constants.NGHTTP2_NO_ERROR)
} catch {
// stream may already be closed
}
return
}
let bytesRead = 0
const cleanup = () => {
clearTimeout(timer)
incoming.off('data', onData)
incoming.off('end', cleanup)
incoming.off('error', cleanup)
}
const forceClose = () => {
cleanup()
const socket = incoming.socket
if (socket && !socket.destroyed) {
if (typeof socket.destroySoon === 'function') {
socket.destroySoon()
} else if (typeof socket.destroy === 'function') {
socket.destroy()
}
}
}
const timer = setTimeout(forceClose, DRAIN_TIMEOUT_MS)
timer.unref?.()
const onData = (chunk: Buffer) => {
bytesRead += chunk.length
if (bytesRead > MAX_DRAIN_BYTES) {
forceClose()
}
}
incoming.on('data', onData)
incoming.on('end', cleanup)
incoming.on('error', cleanup)
incoming.resume()
}
const makeCloseHandler =
(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
req: any,
incoming: IncomingMessage | Http2ServerRequest,
outgoing: ServerResponse | Http2ServerResponse,
needsBodyCleanup: boolean
): (() => void) =>
() => {
if (incoming.errored) {
recordBodyBufferedBeforeDisconnect(incoming)
req[abortRequest](incoming.errored.toString())
} else if (
!outgoing.writableFinished ||
// An HTTP/2 response reports writableFinished once its stream is destroyed, including
// when the client resets the stream mid-response. `aborted` is only set in that case.
(incoming instanceof Http2ServerRequest && incoming.aborted)
) {
recordBodyBufferedBeforeDisconnect(incoming)
req[abortRequest]('Client connection prematurely closed.')
}
if (needsBodyCleanup && !incoming.readableEnded) {
setTimeout(() => {
if (!incoming.readableEnded) {
setTimeout(() => {
drainIncoming(incoming)
})
}
})
}
}
const isImmediateCacheableResponse = (res: Response): boolean => {
if (!(cacheKey in res)) {
return false
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const body = ((res as any)[cacheKey] as InternalCache)[1]
return body === null || typeof body === 'string' || body instanceof Uint8Array
}
const handleRequestError = (): Response =>
new Response(null, {
status: 400,
})
const handleFetchError = (e: unknown): Response =>
new Response(null, {
status:
e instanceof Error && (e.name === 'TimeoutError' || e.constructor.name === 'TimeoutError')
? 504 // timeout error emits 504 timeout
: 500,
})
const handleResponseError = (e: unknown, outgoing: ServerResponse | Http2ServerResponse) => {
const err = (e instanceof Error ? e : new Error('unknown error', { cause: e })) as Error & {
code: string
}
if (err.code === 'ERR_STREAM_PREMATURE_CLOSE') {
console.info('The user aborted a request.')
} else {
console.error(e)
if (!outgoing.headersSent) {
if (outgoing instanceof ServerResponse) {
// writeHead() may have failed after the fast path set the original body's length.
;(outgoing as Http1ResponseWithContentLength)._contentLength = null
}
outgoing.writeHead(500, { 'Content-Type': 'text/plain' })
}
outgoing.end(`Error: ${err.message}`)
outgoing.destroy(err)
}
}
const flushHeaders = (outgoing: ServerResponse | Http2ServerResponse) => {
// If outgoing is ServerResponse (HTTP/1.1), it requires this to flush headers.
// However, Http2ServerResponse is sent without this.
if ('flushHeaders' in outgoing && outgoing.writable) {
outgoing.flushHeaders()
}
}
// Node's HTTP/1 serializer can add Content-Length without adding a header field.
// These private fields are covered by compatibility tests in CI. Fall back
// when automatic insertion would omit the header or preserve a framing header.
const trySetContentLength = (
outgoing: ServerResponse | Http2ServerResponse,
status: number,
length: number
): boolean => {
const http1 = outgoing as Http1ResponseWithContentLength
if (
http1._contentLength === null &&
http1._hasBody &&
http1.useChunkedEncodingByDefault &&
!http1._removedContLen &&
status >= 200 &&
status !== 204 &&
status !== 304 &&
!outgoing.hasHeader('content-length') &&
!outgoing.hasHeader('transfer-encoding') &&
!outgoing.hasHeader('trailer')
) {
http1._contentLength = length
return true
}
return false
}
const writeDefaultHeaders = (
outgoing: ServerResponse | Http2ServerResponse,
status: number,
length: number
): void => {
if (trySetContentLength(outgoing, status, length)) {
outgoing.writeHead(status, { 'Content-Type': defaultContentType })
} else {
outgoing.writeHead(status, {
'Content-Type': defaultContentType,
'Content-Length': length,
})
}
}
const responseViaCache = async (
res: Response,
outgoing: ServerResponse | Http2ServerResponse
): Promise<undefined | void> => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let [status, body, header] = (res as any)[cacheKey] as InternalCache
// Fast path: no custom headers. Let Node add the length when possible.
if (!header) {
if (body === null) {
outgoing.writeHead(status)
outgoing.end()
} else if (typeof body === 'string') {
writeDefaultHeaders(outgoing, status, Buffer.byteLength(body))
outgoing.end(body)
} else if (body instanceof Uint8Array) {
writeDefaultHeaders(outgoing, status, body.byteLength)
outgoing.end(body)
} else if (body instanceof Blob) {
writeDefaultHeaders(outgoing, status, body.size)
outgoing.end(new Uint8Array(await body.arrayBuffer()))
} else {
outgoing.writeHead(status, { 'Content-Type': defaultContentType })
flushHeaders(outgoing)
await writeFromReadableStream(body, outgoing)?.catch(
(e) => handleResponseError(e, outgoing) as undefined
)
}
;(outgoing as OutgoingHasOutgoingEnded)[outgoingEnded]?.()
return
}
let hasContentLength = false
let plainHeaders = false
let canAutoLength = true
if (header instanceof Headers) {
hasContentLength = header.has('content-length')
header = buildOutgoingHttpHeaders(header, body === null ? undefined : defaultContentType)
} else if (Array.isArray(header)) {
const headerObj = new Headers(header)
hasContentLength = headerObj.has('content-length')
header = buildOutgoingHttpHeaders(headerObj, body === null ? undefined : defaultContentType)
} else {
plainHeaders = true
for (const key in header) {
if (key.length === 14 && key.toLowerCase() === 'content-length') {
hasContentLength = true
break
}
if (
(key.length === 17 && key.toLowerCase() === 'transfer-encoding') ||
(key.length === 7 && key.toLowerCase() === 'trailer')
) {
canAutoLength = false
}
}
}
// in `responseViaCache`, if body is not stream, Transfer-Encoding is considered not chunked
if (!hasContentLength) {
let length: number | undefined
if (typeof body === 'string') {
length = Buffer.byteLength(body)
} else if (body instanceof Uint8Array) {
length = body.byteLength
} else if (body instanceof Blob) {
length = body.size
}
if (
length !== undefined &&
(!plainHeaders || !canAutoLength || !trySetContentLength(outgoing, status, length))
) {
if (plainHeaders) {
header = { ...header }
}
header['Content-Length'] = length
}
}
outgoing.writeHead(status, header)
if (body == null) {
outgoing.end()
} else if (typeof body === 'string' || body instanceof Uint8Array) {
outgoing.end(body)
} else if (body instanceof Blob) {
outgoing.end(new Uint8Array(await body.arrayBuffer()))
} else {
flushHeaders(outgoing)
await writeFromReadableStream(body, outgoing)?.catch(
(e) => handleResponseError(e, outgoing) as undefined
)
}
;(outgoing as OutgoingHasOutgoingEnded)[outgoingEnded]?.()
}
const isPromise = (res: Response | Promise<Response>): res is Promise<Response> =>
typeof (res as Promise<Response>).then === 'function'
const responseViaResponseObject = async (
res: Response | Promise<Response>,
outgoing: ServerResponse | Http2ServerResponse,
options: { errorHandler?: CustomErrorHandler } = {}
) => {
if (isPromise(res)) {
if (options.errorHandler) {
try {
res = await res
} catch (err) {
const errRes = await options.errorHandler(err)
if (!errRes) {
return
}
res = errRes
}
} else {
res = await res.catch(handleFetchError)
}
}
if (cacheKey in res) {
return responseViaCache(res as Response, outgoing)
}
const resHeaderRecord: OutgoingHttpHeaders = buildOutgoingHttpHeaders(
res.headers,
res.body === null ? undefined : defaultContentType
)
if (res.body) {
const reader = res.body.getReader()
const values: Uint8Array[] = []
let done = false
let currentReadPromise: Promise<ReadableStreamReadResult<Uint8Array>> | undefined = undefined
if (resHeaderRecord['transfer-encoding'] !== 'chunked') {
// In the case of synchronous responses, usually a maximum of two (or three in special cases) readings is done
let maxReadCount = 2
for (let i = 0; i < maxReadCount; i++) {
currentReadPromise ||= reader.read()
const chunk = await readWithoutBlocking(currentReadPromise).catch((e) => {
console.error(e)
done = true
})
if (!chunk) {
if (i === 1) {
// XXX: In Node.js v24, some response bodies are not read all the way through until the next task queue,
// so wait a moment and retry. (e.g. new Blob([new Uint8Array(contents)]) )
await new Promise((resolve) => setTimeout(resolve))
maxReadCount = 3
continue
}
// Error occurred or currentReadPromise is not yet resolved.
// If an error occurs, immediately break the loop.
// If currentReadPromise is not yet resolved, pass it to writeFromReadableStreamDefaultReader.
break
}
currentReadPromise = undefined
if (chunk.value) {
values.push(chunk.value)
}
if (chunk.done) {
done = true
break
}
}
if (done && !('content-length' in resHeaderRecord)) {
resHeaderRecord['content-length'] = values.reduce((acc, value) => acc + value.length, 0)
}
}
outgoing.writeHead(res.status, resHeaderRecord)
values.forEach((value) => {
;(outgoing as Writable).write(value)
})
if (done) {
outgoing.end()
} else {
if (values.length === 0) {
flushHeaders(outgoing)
}
await writeFromReadableStreamDefaultReader(reader, outgoing, currentReadPromise)
}
} else if (resHeaderRecord[X_ALREADY_SENT]) {
// do nothing, the response has already been sent
} else {
outgoing.writeHead(res.status, resHeaderRecord)
outgoing.end()
}
;(outgoing as OutgoingHasOutgoingEnded)[outgoingEnded]?.()
}
export const getRequestListener = (
fetchCallback: FetchCallback,
options: {
hostname?: string
errorHandler?: CustomErrorHandler
overrideGlobalObjects?: boolean
autoCleanupIncoming?: boolean
} = {}
) => {
const autoCleanupIncoming = options.autoCleanupIncoming ?? true
if (options.overrideGlobalObjects !== false && global.Request !== LightweightRequest) {
Object.defineProperty(global, 'Request', {
value: LightweightRequest,
})
Object.defineProperty(global, 'Response', {
value: LightweightResponse,
})
}
return async (
incoming: IncomingMessage | Http2ServerRequest,
outgoing: ServerResponse | Http2ServerResponse
) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let res, req: any
let needsBodyCleanup = false
let closeHandlerAttached = false
const ensureCloseHandler = () => {
if (!req || closeHandlerAttached) {
return
}
closeHandlerAttached = true
outgoing.on('close', makeCloseHandler(req, incoming, outgoing, needsBodyCleanup))
}
try {
// `fetchCallback()` requests a Request object, but global.Request is expensive to generate,
// so generate a pseudo Request object with only the minimum required information.
req = newRequest(incoming, options.hostname)
// For non-GET/HEAD requests, mark for body stream wrapping and H2 cleanup.
needsBodyCleanup =
autoCleanupIncoming && !(incoming.method === 'GET' || incoming.method === 'HEAD')
if (needsBodyCleanup) {
;(incoming as IncomingMessageWithWrapBodyStream)[wrapBodyStream] = true
if (incoming instanceof Http2ServerRequest) {
// a Http2ServerResponse instance requires additional processing on exit
// since outgoing.on('close') is not called even after outgoing.end() is called
// when the state is incomplete
;(outgoing as OutgoingHasOutgoingEnded)[outgoingEnded] = () => {
// incoming is not consumed to the end
if (!incoming.readableEnded) {
setTimeout(() => {
// in the case of a simple POST request, the cleanup process may be done automatically
// and readableEnded is true at this point. At that point, nothing is done.
if (!incoming.readableEnded) {
setTimeout(() => {
incoming.destroy()
// a Http2ServerResponse instance will not terminate without also calling outgoing.destroy()
outgoing.destroy()
})
}
})
}
}
}
}
res = fetchCallback(req, { incoming, outgoing } as HttpBindings) as
| Response
| Promise<Response>
if (!isPromise(res) && isImmediateCacheableResponse(res)) {
// Synchronous cacheable response — no close listener needed.
// No I/O events can fire between fetchCallback returning and responseViaCache
// completing, so abort detection is not needed here.
if (needsBodyCleanup && !incoming.readableEnded) {
// Handler returned without consuming the body; drain after the
// response is flushed so the socket is freed gracefully (avoids
// TCP RST racing the response for HTTP/1, and RST_STREAM for HTTP/2).
outgoing.once('finish', () => {
if (!incoming.readableEnded) {
drainIncoming(incoming)
}
})
}
return responseViaCache(res, outgoing)
}
ensureCloseHandler()
} catch (e: unknown) {
if (!res) {
if (options.errorHandler) {
// Async error handler — register close listener so client disconnect aborts the signal.
ensureCloseHandler()
res = await options.errorHandler(req ? e : toRequestError(e))
if (!res) {
return
}
} else if (!req) {
res = handleRequestError()
} else {
res = handleFetchError(e)
}
} else {
return handleResponseError(e, outgoing)
}
}
try {
return await responseViaResponseObject(res, outgoing, options)
} catch (e) {
return handleResponseError(e, outgoing)
}
}
}
You can’t perform that action at this time.