fastify 4.24.0 → 4.24.1

package/test/route.7.test.js

@@ -0,0 +1,370 @@
+'use strict'
+
+const stream = require('node:stream')
+const split = require('split2')
+const t = require('tap')
+const test = t.test
+const Fastify = require('..')
+const proxyquire = require('proxyquire')
+
+test("HEAD route should handle stream.on('error')", t => {
+  t.plan(6)
+
+  const resStream = stream.Readable.from('Hello with error!')
+  const logStream = split(JSON.parse)
+  const expectedError = new Error('Hello!')
+  const fastify = Fastify({
+    logger: {
+      stream: logStream,
+      level: 'error'
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/more-coffee',
+    exposeHeadRoute: true,
+    handler: (req, reply) => {
+      process.nextTick(() => resStream.emit('error', expectedError))
+      return resStream
+    }
+  })
+
+  logStream.once('data', line => {
+    const { message, stack } = expectedError
+    t.same(line.err, { type: 'Error', message, stack })
+    t.equal(line.msg, 'Error on Stream found for HEAD route')
+    t.equal(line.level, 50)
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/more-coffee'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+    t.equal(res.headers['content-type'], undefined)
+  })
+})
+
+test('HEAD route should be exposed by default', t => {
+  t.plan(7)
+
+  const resStream = stream.Readable.from('Hello with error!')
+  const resJson = { hello: 'world' }
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'GET',
+    path: '/without-flag',
+    handler: (req, reply) => {
+      return resStream
+    }
+  })
+
+  fastify.route({
+    exposeHeadRoute: true,
+    method: 'GET',
+    path: '/with-flag',
+    handler: (req, reply) => {
+      return resJson
+    }
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/without-flag'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/with-flag'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+    t.equal(res.headers['content-type'], 'application/json; charset=utf-8')
+    t.equal(res.headers['content-length'], `${Buffer.byteLength(JSON.stringify(resJson))}`)
+    t.equal(res.body, '')
+  })
+})
+
+test('HEAD route should be exposed if route exposeHeadRoute is set', t => {
+  t.plan(7)
+
+  const resBuffer = Buffer.from('I am a coffee!')
+  const resJson = { hello: 'world' }
+  const fastify = Fastify({ exposeHeadRoutes: false })
+
+  fastify.route({
+    exposeHeadRoute: true,
+    method: 'GET',
+    path: '/one',
+    handler: (req, reply) => {
+      return resBuffer
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/two',
+    handler: (req, reply) => {
+      return resJson
+    }
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/one'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+    t.equal(res.headers['content-type'], 'application/octet-stream')
+    t.equal(res.headers['content-length'], `${resBuffer.byteLength}`)
+    t.equal(res.body, '')
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/two'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 404)
+  })
+})
+
+test('Set a custom HEAD route before GET one without disabling exposeHeadRoutes (global)', t => {
+  t.plan(6)
+
+  const resBuffer = Buffer.from('I am a coffee!')
+  const fastify = Fastify({
+    exposeHeadRoutes: true
+  })
+
+  fastify.route({
+    method: 'HEAD',
+    path: '/one',
+    handler: (req, reply) => {
+      reply.header('content-type', 'application/pdf')
+      reply.header('content-length', `${resBuffer.byteLength}`)
+      reply.header('x-custom-header', 'some-custom-header')
+      reply.send()
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/one',
+    handler: (req, reply) => {
+      return resBuffer
+    }
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/one'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+    t.equal(res.headers['content-type'], 'application/pdf')
+    t.equal(res.headers['content-length'], `${resBuffer.byteLength}`)
+    t.equal(res.headers['x-custom-header'], 'some-custom-header')
+    t.equal(res.body, '')
+  })
+})
+
+test('Set a custom HEAD route before GET one without disabling exposeHeadRoutes (route)', t => {
+  t.plan(7)
+
+  function onWarning (code) {
+    t.equal(code, 'FSTDEP007')
+  }
+  const warning = {
+    emit: onWarning
+  }
+
+  const route = proxyquire('../lib/route', { './warnings': warning })
+  const fastify = proxyquire('..', { './lib/route.js': route })()
+
+  const resBuffer = Buffer.from('I am a coffee!')
+
+  fastify.route({
+    method: 'HEAD',
+    path: '/one',
+    handler: (req, reply) => {
+      reply.header('content-type', 'application/pdf')
+      reply.header('content-length', `${resBuffer.byteLength}`)
+      reply.header('x-custom-header', 'some-custom-header')
+      reply.send()
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    exposeHeadRoute: true,
+    path: '/one',
+    handler: (req, reply) => {
+      return resBuffer
+    }
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/one'
+  }, (error, res) => {
+    t.error(error)
+    t.equal(res.statusCode, 200)
+    t.equal(res.headers['content-type'], 'application/pdf')
+    t.equal(res.headers['content-length'], `${resBuffer.byteLength}`)
+    t.equal(res.headers['x-custom-header'], 'some-custom-header')
+    t.equal(res.body, '')
+  })
+})
+
+test('HEAD routes properly auto created for GET routes when prefixTrailingSlash: \'no-slash\'', t => {
+  t.plan(2)
+
+  const fastify = Fastify()
+
+  fastify.register(function routes (f, opts, next) {
+    f.route({
+      method: 'GET',
+      url: '/',
+      exposeHeadRoute: true,
+      prefixTrailingSlash: 'no-slash',
+      handler: (req, reply) => {
+        reply.send({ hello: 'world' })
+      }
+    })
+
+    next()
+  }, { prefix: '/prefix' })
+
+  fastify.inject({ url: '/prefix/prefix', method: 'HEAD' }, (err, res) => {
+    t.error(err)
+    t.equal(res.statusCode, 404)
+  })
+})
+
+test('HEAD routes properly auto created for GET routes when prefixTrailingSlash: \'both\'', async t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+
+  fastify.register(function routes (f, opts, next) {
+    f.route({
+      method: 'GET',
+      url: '/',
+      exposeHeadRoute: true,
+      prefixTrailingSlash: 'both',
+      handler: (req, reply) => {
+        reply.send({ hello: 'world' })
+      }
+    })
+
+    next()
+  }, { prefix: '/prefix' })
+
+  const doublePrefixReply = await fastify.inject({ url: '/prefix/prefix', method: 'HEAD' })
+  const trailingSlashReply = await fastify.inject({ url: '/prefix/', method: 'HEAD' })
+  const noneTrailingReply = await fastify.inject({ url: '/prefix', method: 'HEAD' })
+
+  t.equal(doublePrefixReply.statusCode, 404)
+  t.equal(trailingSlashReply.statusCode, 200)
+  t.equal(noneTrailingReply.statusCode, 200)
+})
+
+test('GET route with body schema should throw', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.throws(() => {
+    fastify.route({
+      method: 'GET',
+      path: '/get',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, new Error('Body validation schema for GET:/get route is not supported!'))
+})
+
+test('HEAD route with body schema should throw', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.throws(() => {
+    fastify.route({
+      method: 'HEAD',
+      path: '/shouldThrow',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, new Error('Body validation schema for HEAD:/shouldThrow route is not supported!'))
+})
+
+test('[HEAD, GET] route with body schema should throw', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.throws(() => {
+    fastify.route({
+      method: ['HEAD', 'GET'],
+      path: '/shouldThrowHead',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, new Error('Body validation schema for HEAD:/shouldThrowHead route is not supported!'))
+})
+
+test('GET route with body schema should throw - shorthand', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.throws(() => {
+    fastify.get('/shouldThrow', {
+      schema: {
+        body: {}
+      }
+    },
+    function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+    )
+  }, new Error('Body validation schema for GET:/shouldThrow route is not supported!'))
+})
+
+test('HEAD route with body schema should throw - shorthand', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.throws(() => {
+    fastify.head('/shouldThrow2', {
+      schema: {
+        body: {}
+      }
+    },
+    function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+    )
+  }, new Error('Body validation schema for HEAD:/shouldThrow2 route is not supported!'))
+})

package/test/route.8.test.js

@@ -0,0 +1,142 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const sget = require('simple-get').concat
+const Fastify = require('../fastify')
+const { FST_ERR_INVALID_URL } = require('../lib/errors')
+const { getServerUrl } = require('./helper')
+
+test('Request and Reply share the route config', async t => {
+  t.plan(3)
+
+  const fastify = Fastify()
+
+  const config = {
+    this: 'is a string',
+    thisIs: function aFunction () {}
+  }
+
+  fastify.route({
+    method: 'GET',
+    url: '/',
+    config,
+    handler: (req, reply) => {
+      t.same(req.context, reply.context)
+      t.same(req.context.config, reply.context.config)
+      t.match(req.context.config, config, 'there are url and method additional properties')
+
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  await fastify.inject('/')
+})
+
+test('Will not try to re-createprefixed HEAD route if it already exists and exposeHeadRoutes is true', async (t) => {
+  t.plan(1)
+
+  const fastify = Fastify({ exposeHeadRoutes: true })
+
+  fastify.register((scope, opts, next) => {
+    scope.route({
+      method: 'HEAD',
+      path: '/route',
+      handler: (req, reply) => {
+        reply.header('content-type', 'text/plain')
+        reply.send('custom HEAD response')
+      }
+    })
+    scope.route({
+      method: 'GET',
+      path: '/route',
+      handler: (req, reply) => {
+        reply.send({ ok: true })
+      }
+    })
+
+    next()
+  }, { prefix: '/prefix' })
+
+  await fastify.ready()
+
+  t.ok(true)
+})
+
+test('route with non-english characters', t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+
+  fastify.get('/föö', (request, reply) => {
+    reply.send('here /föö')
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    t.teardown(() => { fastify.close() })
+
+    sget({
+      method: 'GET',
+      url: getServerUrl(fastify) + encodeURI('/föö')
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.equal(body.toString(), 'here /föö')
+    })
+  })
+})
+
+test('invalid url attribute - non string URL', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  try {
+    fastify.get(/^\/(donations|skills|blogs)/, () => { })
+  } catch (error) {
+    t.equal(error.code, FST_ERR_INVALID_URL().code)
+  }
+})
+
+test('exposeHeadRoute should not reuse the same route option', async t => {
+  t.plan(2)
+
+  const fastify = Fastify()
+
+  // we update the onRequest hook in onRoute hook
+  // if we reuse the same route option
+  // that means we will append another function inside the array
+  fastify.addHook('onRoute', function (routeOption) {
+    if (Array.isArray(routeOption.onRequest)) {
+      routeOption.onRequest.push(() => {})
+    } else {
+      routeOption.onRequest = [() => {}]
+    }
+  })
+
+  fastify.addHook('onRoute', function (routeOption) {
+    t.equal(routeOption.onRequest.length, 1)
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/more-coffee',
+    async handler () {
+      return 'hello world'
+    }
+  })
+})
+
+test('using fastify.all when a catchall is defined does not degrade performance', { timeout: 30000 }, async t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  fastify.get('/*', async (_, reply) => reply.json({ ok: true }))
+
+  for (let i = 0; i < 100; i++) {
+    fastify.all(`/${i}`, async (_, reply) => reply.json({ ok: true }))
+  }
+
+  t.pass()
+})

package/test/stream.1.test.js

@@ -0,0 +1,108 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const sget = require('simple-get').concat
+const fs = require('node:fs')
+const Fastify = require('../fastify')
+
+test('should respond with a stream', t => {
+  t.plan(6)
+  const fastify = Fastify()
+
+  fastify.get('/', function (req, reply) {
+    const stream = fs.createReadStream(__filename, 'utf8')
+    reply.code(200).send(stream)
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    t.teardown(() => { fastify.close() })
+
+    sget(`http://localhost:${fastify.server.address().port}`, function (err, response, data) {
+      t.error(err)
+      t.equal(response.headers['content-type'], undefined)
+      t.equal(response.statusCode, 200)
+
+      fs.readFile(__filename, (err, expected) => {
+        t.error(err)
+        t.equal(expected.toString(), data.toString())
+      })
+    })
+  })
+})
+
+test('should respond with a stream (error)', t => {
+  t.plan(3)
+  const fastify = Fastify()
+
+  fastify.get('/error', function (req, reply) {
+    const stream = fs.createReadStream('not-existing-file', 'utf8')
+    reply.code(200).send(stream)
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    t.teardown(() => { fastify.close() })
+
+    sget(`http://localhost:${fastify.server.address().port}/error`, function (err, response) {
+      t.error(err)
+      t.equal(response.statusCode, 500)
+    })
+  })
+})
+
+test('should trigger the onSend hook', t => {
+  t.plan(4)
+  const fastify = Fastify()
+
+  fastify.get('/', (req, reply) => {
+    reply.send(fs.createReadStream(__filename, 'utf8'))
+  })
+
+  fastify.addHook('onSend', (req, reply, payload, done) => {
+    t.ok(payload._readableState)
+    reply.header('Content-Type', 'application/javascript')
+    done()
+  })
+
+  fastify.inject({
+    url: '/'
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.headers['content-type'], 'application/javascript')
+    t.equal(res.payload, fs.readFileSync(__filename, 'utf8'))
+    fastify.close()
+  })
+})
+
+test('should trigger the onSend hook only twice if pumping the stream fails, first with the stream, second with the serialized error', t => {
+  t.plan(5)
+  const fastify = Fastify()
+
+  fastify.get('/', (req, reply) => {
+    reply.send(fs.createReadStream('not-existing-file', 'utf8'))
+  })
+
+  let counter = 0
+  fastify.addHook('onSend', (req, reply, payload, done) => {
+    if (counter === 0) {
+      t.ok(payload._readableState)
+    } else if (counter === 1) {
+      const error = JSON.parse(payload)
+      t.equal(error.statusCode, 500)
+    }
+    counter++
+    done()
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+    t.teardown(() => { fastify.close() })
+
+    sget(`http://localhost:${fastify.server.address().port}`, function (err, response) {
+      t.error(err)
+      t.equal(response.statusCode, 500)
+    })
+  })
+})