forked from fastify/fastify
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhandler-timeout.test.js
More file actions
367 lines (288 loc) · 10.6 KB
/
Copy pathhandler-timeout.test.js
File metadata and controls
367 lines (288 loc) · 10.6 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
'use strict'
const { test } = require('node:test')
const net = require('node:net')
const Fastify = require('..')
const { Readable } = require('node:stream')
const { kTimeoutTimer, kOnAbort } = require('../lib/symbols')
// --- Option validation ---
test('server-level handlerTimeout defaults to 0 in initialConfig', t => {
t.plan(1)
const fastify = Fastify()
t.assert.strictEqual(fastify.initialConfig.handlerTimeout, 0)
})
test('server-level handlerTimeout: 5000 is accepted and exposed in initialConfig', t => {
t.plan(1)
const fastify = Fastify({ handlerTimeout: 5000 })
t.assert.strictEqual(fastify.initialConfig.handlerTimeout, 5000)
})
test('route-level handlerTimeout rejects invalid values', async t => {
const fastify = Fastify()
t.assert.throws(() => {
fastify.get('/a', { handlerTimeout: 'fast' }, async () => 'ok')
}, { code: 'FST_ERR_ROUTE_HANDLER_TIMEOUT_OPTION_NOT_INT' })
t.assert.throws(() => {
fastify.get('/b', { handlerTimeout: -1 }, async () => 'ok')
}, { code: 'FST_ERR_ROUTE_HANDLER_TIMEOUT_OPTION_NOT_INT' })
t.assert.throws(() => {
fastify.get('/c', { handlerTimeout: 1.5 }, async () => 'ok')
}, { code: 'FST_ERR_ROUTE_HANDLER_TIMEOUT_OPTION_NOT_INT' })
t.assert.throws(() => {
fastify.get('/d', { handlerTimeout: 0 }, async () => 'ok')
}, { code: 'FST_ERR_ROUTE_HANDLER_TIMEOUT_OPTION_NOT_INT' })
})
// --- Lazy signal without handlerTimeout ---
test('when handlerTimeout is 0 (default), request.signal is lazily created', async t => {
t.plan(3)
const fastify = Fastify()
fastify.get('/', async (request) => {
const signal = request.signal
t.assert.ok(signal instanceof AbortSignal)
t.assert.strictEqual(signal.aborted, false)
return { ok: true }
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 200)
})
test('client disconnect aborts lazily created signal (no handlerTimeout)', async t => {
t.plan(1)
const fastify = Fastify()
let signalAborted = false
fastify.get('/', async (request) => {
await new Promise((resolve) => {
request.signal.addEventListener('abort', () => {
signalAborted = true
resolve()
})
})
return 'should not reach'
})
await fastify.listen({ port: 0 })
t.after(() => fastify.close())
const address = fastify.server.address()
await new Promise((resolve) => {
const client = net.connect(address.port, () => {
client.write('GET / HTTP/1.1\r\nHost: localhost\r\n\r\n')
setTimeout(() => {
client.destroy()
setTimeout(resolve, 100)
}, 50)
})
})
t.assert.strictEqual(signalAborted, true)
})
// --- Basic timeout behavior ---
test('slow handler returns 503 with FST_ERR_HANDLER_TIMEOUT', async t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 50 }, async () => {
await new Promise(resolve => setTimeout(resolve, 500))
return 'too late'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 503)
t.assert.strictEqual(JSON.parse(res.payload).code, 'FST_ERR_HANDLER_TIMEOUT')
})
test('fast handler completes normally with 200', async t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 5000 }, async () => {
return { hello: 'world' }
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 200)
t.assert.deepStrictEqual(JSON.parse(res.payload), { hello: 'world' })
})
// --- Per-route override ---
test('route-level handlerTimeout overrides server default', async t => {
t.plan(4)
const fastify = Fastify({ handlerTimeout: 5000 })
fastify.get('/slow', { handlerTimeout: 50 }, async () => {
await new Promise(resolve => setTimeout(resolve, 500))
return 'too late'
})
fastify.get('/fast', async () => {
return { ok: true }
})
const resSlow = await fastify.inject({ method: 'GET', url: '/slow' })
t.assert.strictEqual(resSlow.statusCode, 503)
t.assert.strictEqual(JSON.parse(resSlow.payload).code, 'FST_ERR_HANDLER_TIMEOUT')
const resFast = await fastify.inject({ method: 'GET', url: '/fast' })
t.assert.strictEqual(resFast.statusCode, 200)
t.assert.deepStrictEqual(JSON.parse(resFast.payload), { ok: true })
})
// --- request.signal behavior ---
test('request.signal is an AbortSignal when handlerTimeout > 0', async t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 5000 }, async (request) => {
t.assert.ok(request.signal instanceof AbortSignal)
t.assert.strictEqual(request.signal.aborted, false)
return 'ok'
})
await fastify.inject({ method: 'GET', url: '/' })
})
test('request.signal aborts when timeout fires with reason', async t => {
t.plan(2)
const fastify = Fastify()
let signalReason = null
fastify.get('/', { handlerTimeout: 50 }, async (request) => {
request.signal.addEventListener('abort', () => {
signalReason = request.signal.reason
})
await new Promise(resolve => setTimeout(resolve, 500))
return 'too late'
})
await fastify.inject({ method: 'GET', url: '/' })
t.assert.ok(signalReason !== null)
t.assert.strictEqual(signalReason.code, 'FST_ERR_HANDLER_TIMEOUT')
})
// --- Streaming response ---
test('streaming response: timer clears when response finishes', async t => {
t.plan(1)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 5000 }, async (request, reply) => {
const stream = new Readable({
read () {
this.push('hello')
this.push(null)
}
})
reply.type('text/plain').send(stream)
return reply
})
await fastify.listen({ port: 0 })
t.after(() => fastify.close())
const address = fastify.server.address()
const res = await fetch(`http://localhost:${address.port}/`)
t.assert.strictEqual(res.status, 200)
})
// --- SSE with reply.hijack() ---
test('reply.hijack() clears timeout timer', async t => {
t.plan(1)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 100 }, async (request, reply) => {
reply.hijack()
// Write after the original timeout would have fired
await new Promise(resolve => setTimeout(resolve, 200))
reply.raw.writeHead(200, { 'Content-Type': 'text/plain' })
reply.raw.end('hijacked response')
})
await fastify.listen({ port: 0 })
t.after(() => fastify.close())
const address = fastify.server.address()
const res = await fetch(`http://localhost:${address.port}/`)
t.assert.strictEqual(res.status, 200)
})
// --- Error handler integration ---
test('route-level errorHandler receives FST_ERR_HANDLER_TIMEOUT', async t => {
t.plan(3)
const fastify = Fastify()
fastify.get('/', {
handlerTimeout: 50,
errorHandler: (error, request, reply) => {
t.assert.strictEqual(error.code, 'FST_ERR_HANDLER_TIMEOUT')
reply.code(504).send({ custom: 'timeout' })
}
}, async () => {
await new Promise(resolve => setTimeout(resolve, 500))
return 'too late'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 504)
t.assert.deepStrictEqual(JSON.parse(res.payload), { custom: 'timeout' })
})
// --- Timer cleanup / no leaks ---
test('timer is cleaned up after fast response (no leak)', async t => {
t.plan(3)
const fastify = Fastify()
let capturedRequest
fastify.get('/', { handlerTimeout: 60000 }, async (request) => {
capturedRequest = request
return 'fast'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 200)
// Timer and listener should be cleaned up
t.assert.strictEqual(capturedRequest[kTimeoutTimer], null)
t.assert.strictEqual(capturedRequest[kOnAbort], null)
})
// --- routeOptions exposure ---
test('request.routeOptions.handlerTimeout reflects configured value', async t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 3000 }, async (request) => {
t.assert.strictEqual(request.routeOptions.handlerTimeout, 3000)
return 'ok'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 200)
})
test('request.routeOptions.handlerTimeout reflects server default', async t => {
t.plan(2)
const fastify = Fastify({ handlerTimeout: 7000 })
fastify.get('/', async (request) => {
t.assert.strictEqual(request.routeOptions.handlerTimeout, 7000)
return 'ok'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 200)
})
// --- Client disconnect aborts signal ---
test('client disconnect aborts request.signal', async t => {
t.plan(1)
const fastify = Fastify()
let signalAborted = false
fastify.get('/', { handlerTimeout: 5000 }, async (request) => {
await new Promise((resolve) => {
request.signal.addEventListener('abort', () => {
signalAborted = true
resolve()
})
})
return 'should not reach'
})
await fastify.listen({ port: 0 })
t.after(() => fastify.close())
const address = fastify.server.address()
await new Promise((resolve) => {
const client = net.connect(address.port, () => {
client.write('GET / HTTP/1.1\r\nHost: localhost\r\n\r\n')
setTimeout(() => {
client.destroy()
// Give the server time to process the close event
setTimeout(resolve, 100)
}, 50)
})
})
t.assert.strictEqual(signalAborted, true)
})
// --- Race: handler completes just as timeout fires ---
test('no double-send when handler completes near timeout boundary', async t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/', { handlerTimeout: 50 }, async (request, reply) => {
// Respond just before timeout
await new Promise(resolve => setTimeout(resolve, 40))
reply.send({ ok: true })
return reply
})
const res = await fastify.inject({ method: 'GET', url: '/' })
// Should get either 200 or 503 depending on race, but never crash
t.assert.ok(res.statusCode === 200 || res.statusCode === 503)
// Verify response is valid JSON regardless of which won the race
t.assert.ok(JSON.parse(res.payload))
})
// --- Server default inherited by routes ---
test('routes inherit server-level handlerTimeout', async t => {
t.plan(3)
const fastify = Fastify({ handlerTimeout: 50 })
fastify.get('/', async (request) => {
// Verify the signal is present (inherited from server default)
t.assert.ok(request.signal instanceof AbortSignal)
await new Promise(resolve => setTimeout(resolve, 500))
return 'too late'
})
const res = await fastify.inject({ method: 'GET', url: '/' })
t.assert.strictEqual(res.statusCode, 503)
t.assert.strictEqual(JSON.parse(res.payload).code, 'FST_ERR_HANDLER_TIMEOUT')
})