fastify
Version:
Fast and low overhead web framework, for Node.js
1,076 lines (906 loc) • 26.3 kB
JavaScript
const { Readable } = require('node:stream')
const t = require('tap')
const test = t.test
const sget = require('simple-get').concat
const Fastify = require('../fastify')
const fs = require('node:fs')
const { sleep } = require('./helper')
process.removeAllListeners('warning')
test('async hooks', t => {
t.plan(21)
const fastify = Fastify({ exposeHeadRoutes: false })
fastify.addHook('onRequest', async function (request, reply) {
await sleep(1)
request.test = 'the request is coming'
reply.test = 'the reply has come'
if (request.raw.method === 'DELETE') {
throw new Error('some error')
}
})
fastify.addHook('preHandler', async function (request, reply) {
await sleep(1)
t.equal(request.test, 'the request is coming')
t.equal(reply.test, 'the reply has come')
if (request.raw.method === 'HEAD') {
throw new Error('some error')
}
})
fastify.addHook('onSend', async function (request, reply, payload) {
await sleep(1)
t.ok('onSend called')
})
fastify.addHook('onResponse', async function (request, reply) {
await sleep(1)
t.ok('onResponse called')
})
fastify.get('/', function (request, reply) {
t.equal(request.test, 'the request is coming')
t.equal(reply.test, 'the reply has come')
reply.code(200).send({ hello: 'world' })
})
fastify.head('/', function (req, reply) {
reply.code(200).send({ hello: 'world' })
})
fastify.delete('/', function (req, reply) {
reply.code(200).send({ hello: 'world' })
})
fastify.listen({ port: 0 }, err => {
t.error(err)
t.teardown(() => { fastify.close() })
sget({
method: 'GET',
url: 'http://localhost:' + fastify.server.address().port
}, (err, response, body) => {
t.error(err)
t.equal(response.statusCode, 200)
t.equal(response.headers['content-length'], '' + body.length)
t.same(JSON.parse(body), { hello: 'world' })
})
sget({
method: 'HEAD',
url: 'http://localhost:' + fastify.server.address().port
}, (err, response, body) => {
t.error(err)
t.equal(response.statusCode, 500)
})
sget({
method: 'DELETE',
url: 'http://localhost:' + fastify.server.address().port
}, (err, response, body) => {
t.error(err)
t.equal(response.statusCode, 500)
})
})
})
test('modify payload', t => {
t.plan(10)
const fastify = Fastify()
const payload = { hello: 'world' }
const modifiedPayload = { hello: 'modified' }
const anotherPayload = '"winter is coming"'
fastify.addHook('onSend', async function (request, reply, thePayload) {
t.ok('onSend called')
t.same(JSON.parse(thePayload), payload)
return thePayload.replace('world', 'modified')
})
fastify.addHook('onSend', async function (request, reply, thePayload) {
t.ok('onSend called')
t.same(JSON.parse(thePayload), modifiedPayload)
return anotherPayload
})
fastify.addHook('onSend', async function (request, reply, thePayload) {
t.ok('onSend called')
t.equal(thePayload, anotherPayload)
})
fastify.get('/', (req, reply) => {
reply.send(payload)
})
fastify.inject({
method: 'GET',
url: '/'
}, (err, res) => {
t.error(err)
t.equal(res.payload, anotherPayload)
t.equal(res.statusCode, 200)
t.equal(res.headers['content-length'], '18')
})
})
test('onRequest hooks should be able to block a request', t => {
t.plan(5)
const fastify = Fastify()
fastify.addHook('onRequest', async (req, reply) => {
await reply.send('hello')
})
fastify.addHook('onRequest', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('preHandler', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.ok('called')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('preParsing hooks should be able to modify the payload', t => {
t.plan(3)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const stream = new Readable()
stream.receivedEncodedLength = parseInt(req.headers['content-length'], 10)
stream.push(JSON.stringify({ hello: 'another world' }))
stream.push(null)
return stream
})
fastify.post('/', function (request, reply) {
reply.send(request.body)
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.same(JSON.parse(res.payload), { hello: 'another world' })
})
})
test('preParsing hooks should be able to supply statusCode', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const stream = new Readable({
read () {
const error = new Error('kaboom')
error.statusCode = 408
this.destroy(error)
}
})
stream.receivedEncodedLength = 20
return stream
})
fastify.addHook('onError', async (req, res, err) => {
t.equal(err.statusCode, 408)
})
fastify.post('/', function (request, reply) {
t.fail('should not be called')
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 408)
t.same(JSON.parse(res.payload), {
statusCode: 408,
error: 'Request Timeout',
message: 'kaboom'
})
})
})
test('preParsing hooks should ignore statusCode 200 in stream error', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const stream = new Readable({
read () {
const error = new Error('kaboom')
error.statusCode = 200
this.destroy(error)
}
})
stream.receivedEncodedLength = 20
return stream
})
fastify.addHook('onError', async (req, res, err) => {
t.equal(err.statusCode, 400)
})
fastify.post('/', function (request, reply) {
t.fail('should not be called')
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 400)
t.same(JSON.parse(res.payload), {
statusCode: 400,
error: 'Bad Request',
message: 'kaboom'
})
})
})
test('preParsing hooks should ignore non-number statusCode in stream error', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const stream = new Readable({
read () {
const error = new Error('kaboom')
error.statusCode = '418'
this.destroy(error)
}
})
stream.receivedEncodedLength = 20
return stream
})
fastify.addHook('onError', async (req, res, err) => {
t.equal(err.statusCode, 400)
})
fastify.post('/', function (request, reply) {
t.fail('should not be called')
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 400)
t.same(JSON.parse(res.payload), {
statusCode: 400,
error: 'Bad Request',
message: 'kaboom'
})
})
})
test('preParsing hooks should default to statusCode 400 if stream error', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const stream = new Readable({
read () {
this.destroy(new Error('kaboom'))
}
})
stream.receivedEncodedLength = 20
return stream
})
fastify.addHook('onError', async (req, res, err) => {
t.equal(err.statusCode, 400)
})
fastify.post('/', function (request, reply) {
t.fail('should not be called')
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 400)
t.same(JSON.parse(res.payload), {
statusCode: 400,
error: 'Bad Request',
message: 'kaboom'
})
})
})
test('preParsing hooks should handle errors', t => {
t.plan(3)
const fastify = Fastify()
fastify.addHook('preParsing', async (req, reply, payload) => {
const e = new Error('kaboom')
e.statusCode = 501
throw e
})
fastify.post('/', function (request, reply) {
reply.send(request.body)
})
fastify.inject({
method: 'POST',
url: '/',
payload: { hello: 'world' }
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 501)
t.same(JSON.parse(res.payload), { error: 'Not Implemented', message: 'kaboom', statusCode: 501 })
})
})
test('preHandler hooks should be able to block a request', t => {
t.plan(5)
const fastify = Fastify()
fastify.addHook('preHandler', async (req, reply) => {
await reply.send('hello')
})
fastify.addHook('preHandler', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.equal(payload, 'hello')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('preValidation hooks should be able to block a request', t => {
t.plan(5)
const fastify = Fastify()
fastify.addHook('preValidation', async (req, reply) => {
await reply.send('hello')
})
fastify.addHook('preValidation', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.equal(payload, 'hello')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('preValidation hooks should be able to change request body before validation', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('preValidation', async (req, _reply) => {
const buff = Buffer.from(req.body.message, 'base64')
req.body = JSON.parse(buff.toString('utf-8'))
})
fastify.post(
'/',
{
schema: {
body: {
type: 'object',
properties: {
foo: {
type: 'string'
},
bar: {
type: 'number'
}
},
required: ['foo', 'bar']
}
}
},
(req, reply) => {
t.pass()
reply.status(200).send('hello')
}
)
fastify.inject({
url: '/',
method: 'POST',
payload: {
message: Buffer.from(JSON.stringify({ foo: 'example', bar: 1 })).toString('base64')
}
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('preSerialization hooks should be able to modify the payload', t => {
t.plan(3)
const fastify = Fastify()
fastify.addHook('preSerialization', async (req, reply, payload) => {
return { hello: 'another world' }
})
fastify.get('/', function (request, reply) {
reply.send({ hello: 'world' })
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.same(JSON.parse(res.payload), { hello: 'another world' })
})
})
test('preSerialization hooks should handle errors', t => {
t.plan(3)
const fastify = Fastify()
fastify.addHook('preSerialization', async (req, reply, payload) => {
throw new Error('kaboom')
})
fastify.get('/', function (request, reply) {
reply.send({ hello: 'world' })
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 500)
t.same(JSON.parse(res.payload), { error: 'Internal Server Error', message: 'kaboom', statusCode: 500 })
})
})
test('preValidation hooks should handle throwing null', t => {
t.plan(4)
const fastify = Fastify()
fastify.setErrorHandler(async (error, request, reply) => {
t.ok(error instanceof Error)
await reply.send(error)
})
fastify.addHook('preValidation', async () => {
// eslint-disable-next-line no-throw-literal
throw null
})
fastify.get('/', function (request, reply) { t.fail('the handler must not be called') })
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 500)
t.same(res.json(), {
error: 'Internal Server Error',
code: 'FST_ERR_SEND_UNDEFINED_ERR',
message: 'Undefined error has occurred',
statusCode: 500
})
})
})
test('preValidation hooks should handle throwing a string', t => {
t.plan(3)
const fastify = Fastify()
fastify.addHook('preValidation', async () => {
// eslint-disable-next-line no-throw-literal
throw 'this is an error'
})
fastify.get('/', function (request, reply) { t.fail('the handler must not be called') })
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 500)
t.equal(res.payload, 'this is an error')
})
})
test('onRequest hooks should be able to block a request (last hook)', t => {
t.plan(5)
const fastify = Fastify()
fastify.addHook('onRequest', async (req, reply) => {
await reply.send('hello')
})
fastify.addHook('preHandler', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.ok('called')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('preHandler hooks should be able to block a request (last hook)', t => {
t.plan(5)
const fastify = Fastify()
fastify.addHook('preHandler', async (req, reply) => {
await reply.send('hello')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.equal(payload, 'hello')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
t.equal(res.payload, 'hello')
})
})
test('onRequest respond with a stream', t => {
t.plan(4)
const fastify = Fastify()
fastify.addHook('onRequest', async (req, reply) => {
return new Promise((resolve, reject) => {
const stream = fs.createReadStream(__filename, 'utf8')
// stream.pipe(res)
// res.once('finish', resolve)
reply.send(stream).then(() => {
reply.raw.once('finish', () => resolve())
})
})
})
fastify.addHook('onRequest', async (req, res) => {
t.fail('this should not be called')
})
fastify.addHook('preHandler', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.ok('called')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
})
})
test('preHandler respond with a stream', t => {
t.plan(7)
const fastify = Fastify()
fastify.addHook('onRequest', async (req, res) => {
t.ok('called')
})
// we are calling `reply.send` inside the `preHandler` hook with a stream,
// this triggers the `onSend` hook event if `preHandler` has not yet finished
const order = [1, 2]
fastify.addHook('preHandler', async (req, reply) => {
const stream = fs.createReadStream(__filename, 'utf8')
reply.raw.once('finish', () => {
t.equal(order.shift(), 2)
})
return reply.send(stream)
})
fastify.addHook('preHandler', async (req, reply) => {
t.fail('this should not be called')
})
fastify.addHook('onSend', async (req, reply, payload) => {
t.equal(order.shift(), 1)
t.equal(typeof payload.pipe, 'function')
})
fastify.addHook('onResponse', async (request, reply) => {
t.ok('called')
})
fastify.get('/', function (request, reply) {
t.fail('we should not be here')
})
fastify.inject({
url: '/',
method: 'GET'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 200)
})
})
test('Should log a warning if is an async function with `done`', t => {
t.test('2 arguments', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.addHook('onRequestAbort', async (req, done) => {})
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
t.test('3 arguments', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.addHook('onRequest', async (req, reply, done) => {})
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
t.test('4 arguments', t => {
t.plan(6)
const fastify = Fastify()
try {
fastify.addHook('onSend', async (req, reply, payload, done) => {})
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
try {
fastify.addHook('preSerialization', async (req, reply, payload, done) => {})
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
try {
fastify.addHook('onError', async (req, reply, payload, done) => {})
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
t.end()
})
test('early termination, onRequest async', async t => {
t.plan(2)
const app = Fastify()
app.addHook('onRequest', async (req, reply) => {
setImmediate(() => reply.send('hello world'))
return reply
})
app.get('/', (req, reply) => {
t.fail('should not happen')
})
const res = await app.inject('/')
t.equal(res.statusCode, 200)
t.equal(res.body.toString(), 'hello world')
})
test('The this should be the same of the encapsulation level', async t => {
const fastify = Fastify()
fastify.addHook('onRequest', async function (req, reply) {
if (req.raw.url === '/nested') {
t.equal(this.foo, 'bar')
} else {
t.equal(this.foo, undefined)
}
})
fastify.register(plugin)
fastify.get('/', (req, reply) => reply.send('ok'))
async function plugin (fastify, opts) {
fastify.decorate('foo', 'bar')
fastify.get('/nested', (req, reply) => reply.send('ok'))
}
await fastify.inject({ method: 'GET', path: '/' })
await fastify.inject({ method: 'GET', path: '/nested' })
await fastify.inject({ method: 'GET', path: '/' })
await fastify.inject({ method: 'GET', path: '/nested' })
})
test('preSerializationEnd should handle errors if the serialize method throws', t => {
t.test('works with sync preSerialization', t => {
t.plan(2)
const fastify = Fastify()
fastify.addHook('preSerialization', (request, reply, payload, done) => {
done(null, payload)
})
fastify.post('/', {
handler (req, reply) { reply.send({ notOk: true }) },
schema: { response: { 200: { required: ['ok'], properties: { ok: { type: 'boolean' } } } } }
})
fastify.inject({
method: 'POST',
url: '/'
}, (err, res) => {
t.error(err)
t.not(res.statusCode, 200)
})
})
t.test('works with async preSerialization', t => {
t.plan(2)
const fastify = Fastify()
fastify.addHook('preSerialization', async (request, reply, payload) => {
return payload
})
fastify.post('/', {
handler (req, reply) { reply.send({ notOk: true }) },
schema: { response: { 200: { required: ['ok'], properties: { ok: { type: 'boolean' } } } } }
})
fastify.inject({
method: 'POST',
url: '/'
}, (err, res) => {
t.error(err)
t.not(res.statusCode, 200)
})
})
t.end()
})
t.test('nested hooks to do not crash on 404', t => {
t.plan(2)
const fastify = Fastify()
fastify.get('/hello', (req, reply) => {
reply.send({ hello: 'world' })
})
fastify.register(async function (fastify) {
fastify.get('/something', (req, reply) => {
reply.callNotFound()
})
fastify.setNotFoundHandler(async (request, reply) => {
reply.statusCode = 404
return { status: 'nested-not-found' }
})
fastify.setErrorHandler(async (error, request, reply) => {
reply.statusCode = 500
return { status: 'nested-error', error }
})
}, { prefix: '/nested' })
fastify.setNotFoundHandler(async (request, reply) => {
reply.statusCode = 404
return { status: 'not-found' }
})
fastify.setErrorHandler(async (error, request, reply) => {
reply.statusCode = 500
return { status: 'error', error }
})
fastify.inject({
method: 'GET',
url: '/nested/something'
}, (err, res) => {
t.error(err)
t.equal(res.statusCode, 404)
})
})
test('Register an hook (preHandler) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
preHandler: [
async (request, reply, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('preHandler mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
test('Register an hook (onSend) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
onSend: [
async (request, reply, payload, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('onSend mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
test('Register an hook (preSerialization) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
preSerialization: [
async (request, reply, payload, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('preSerialization mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
test('Register an hook (onError) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
onError: [
async (request, reply, error, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('onError mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
test('Register an hook (preParsing) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
preParsing: [
async (request, reply, payload, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('preParsing mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})
test('Register an hook (onRequestAbort) as route option should fail if mixing async and callback style', t => {
t.plan(2)
const fastify = Fastify()
try {
fastify.get(
'/',
{
onRequestAbort: [
async (request, done) => {
done()
}
]
},
async (request, reply) => {
return { hello: 'world' }
}
)
t.fail('onRequestAbort mixing async and callback style')
} catch (e) {
t.equal(e.code, 'FST_ERR_HOOK_INVALID_ASYNC_HANDLER')
t.equal(e.message, 'Async function has too many arguments. Async hooks should not use the \'done\' argument.')
}
})