node-fastify 5.8.3

package/test/route.7.test.js

@@ -0,0 +1,406 @@
+'use strict'
+
+const stream = require('node:stream')
+const { ReadableStream } = require('node:stream/web')
+const split = require('split2')
+const { test } = require('node:test')
+const Fastify = require('..')
+const createError = require('@fastify/error')
+
+test("HEAD route should handle stream.on('error')", (t, done) => {
+  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.assert.deepStrictEqual(line.err, { type: 'Error', message, stack })
+    t.assert.strictEqual(line.msg, 'Error on Stream found for HEAD route')
+    t.assert.strictEqual(line.level, 50)
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/more-coffee'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.strictEqual(res.headers['content-type'], undefined)
+    done()
+  })
+})
+
+test('HEAD route should handle ReadableStream.cancel() error', (t, done) => {
+  t.plan(7)
+
+  const logStream = split(JSON.parse)
+  const expectedError = new Error('Cancel error!')
+  const fastify = Fastify({
+    logger: {
+      stream: logStream,
+      level: 'error'
+    }
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/web-stream',
+    exposeHeadRoute: true,
+    handler: (req, reply) => {
+      const webStream = new ReadableStream({
+        start (controller) {
+          controller.enqueue('Hello from web stream!')
+        },
+        cancel (reason) {
+          t.assert.strictEqual(reason, 'Stream cancelled by HEAD route')
+          throw expectedError
+        }
+      })
+      return webStream
+    }
+  })
+
+  logStream.once('data', line => {
+    const { message, stack } = expectedError
+    t.assert.deepStrictEqual(line.err, { type: 'Error', message, stack })
+    t.assert.strictEqual(line.msg, 'Error on Stream found for HEAD route')
+    t.assert.strictEqual(line.level, 50)
+  })
+
+  fastify.inject({
+    method: 'HEAD',
+    url: '/web-stream'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.strictEqual(res.headers['content-type'], undefined)
+    done()
+  })
+})
+
+test('HEAD route should be exposed by default', async t => {
+  t.plan(5)
+
+  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
+    }
+  })
+
+  let res = await fastify.inject({
+    method: 'HEAD',
+    url: '/without-flag'
+  })
+  t.assert.strictEqual(res.statusCode, 200)
+
+  res = await fastify.inject({
+    method: 'HEAD',
+    url: '/with-flag'
+  })
+  t.assert.strictEqual(res.statusCode, 200)
+  t.assert.strictEqual(res.headers['content-type'], 'application/json; charset=utf-8')
+  t.assert.strictEqual(res.headers['content-length'], `${Buffer.byteLength(JSON.stringify(resJson))}`)
+  t.assert.strictEqual(res.body, '')
+})
+
+test('HEAD route should be exposed if route exposeHeadRoute is set', async t => {
+  t.plan(5)
+
+  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
+    }
+  })
+
+  let res = await fastify.inject({
+    method: 'HEAD',
+    url: '/one'
+  })
+  t.assert.strictEqual(res.statusCode, 200)
+  t.assert.strictEqual(res.headers['content-type'], 'application/octet-stream')
+  t.assert.strictEqual(res.headers['content-length'], `${resBuffer.byteLength}`)
+  t.assert.strictEqual(res.body, '')
+
+  res = await fastify.inject({
+    method: 'HEAD',
+    url: '/two'
+  })
+  t.assert.strictEqual(res.statusCode, 404)
+})
+
+test('Set a custom HEAD route before GET one without disabling exposeHeadRoutes (global)', (t, done) => {
+  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.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.strictEqual(res.headers['content-type'], 'application/pdf')
+    t.assert.strictEqual(res.headers['content-length'], `${resBuffer.byteLength}`)
+    t.assert.strictEqual(res.headers['x-custom-header'], 'some-custom-header')
+    t.assert.strictEqual(res.body, '')
+    done()
+  })
+})
+
+test('Set a custom HEAD route before GET one without disabling exposeHeadRoutes (route)', (t, done) => {
+  t.plan(6)
+
+  const fastify = Fastify()
+
+  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.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.strictEqual(res.headers['content-type'], 'application/pdf')
+    t.assert.strictEqual(res.headers['content-length'], `${resBuffer.byteLength}`)
+    t.assert.strictEqual(res.headers['x-custom-header'], 'some-custom-header')
+    t.assert.strictEqual(res.body, '')
+    done()
+  })
+})
+
+test('HEAD routes properly auto created for GET routes when prefixTrailingSlash: \'no-slash\'', (t, done) => {
+  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.assert.ifError(err)
+    t.assert.strictEqual(res.statusCode, 404)
+    done()
+  })
+})
+
+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.assert.strictEqual(doublePrefixReply.statusCode, 404)
+  t.assert.strictEqual(trailingSlashReply.statusCode, 200)
+  t.assert.strictEqual(noneTrailingReply.statusCode, 200)
+})
+
+test('GET route with body schema should throw', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  t.assert.throws(() => {
+    fastify.route({
+      method: 'GET',
+      path: '/get',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, createError('FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED', '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.assert.throws(() => {
+    fastify.route({
+      method: 'HEAD',
+      path: '/shouldThrow',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, createError('FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED', '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.assert.throws(() => {
+    fastify.route({
+      method: ['HEAD', 'GET'],
+      path: '/shouldThrowHead',
+      schema: {
+        body: {}
+      },
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    })
+  }, createError('FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED', '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.assert.throws(() => {
+    fastify.get('/shouldThrow', {
+      schema: {
+        body: {}
+      }
+    },
+    function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+    )
+  }, createError('FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED', '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.assert.throws(() => {
+    fastify.head('/shouldThrow2', {
+      schema: {
+        body: {}
+      }
+    },
+    function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+    )
+  }, createError('FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED', 'Body validation schema for HEAD:/shouldThrow2 route is not supported!')())
+})

package/test/route.8.test.js

@@ -0,0 +1,225 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('..')
+const {
+  FST_ERR_INVALID_URL
+} = require('../lib/errors')
+
+test('Request and Reply share the route options', 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.assert.deepStrictEqual(req.routeOptions, reply.routeOptions)
+      t.assert.deepStrictEqual(req.routeOptions.config, reply.routeOptions.config)
+      t.assert.match(req.routeOptions.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.assert.ok(true)
+})
+
+test('route with non-english characters', async (t) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+
+  fastify.get('/föö', (request, reply) => {
+    reply.send('here /föö')
+  })
+
+  const fastifyServer = await fastify.listen({ port: 0 })
+  t.after(() => fastify.close())
+
+  const response = await fetch(fastifyServer + encodeURI('/föö'))
+  t.assert.ok(response.ok)
+  t.assert.strictEqual(response.status, 200)
+  const body = await response.text()
+  t.assert.strictEqual(body, '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.assert.strictEqual(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.assert.strictEqual(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.assert.ok("fastify.all doesn't degrade performance")
+})
+
+test('Adding manually HEAD route after GET with the same path throws Fastify duplicated route instance error', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'GET',
+    path: '/:param1',
+    handler: (req, reply) => {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  try {
+    fastify.route({
+      method: 'HEAD',
+      path: '/:param2',
+      handler: (req, reply) => {
+        reply.send({ hello: 'world' })
+      }
+    })
+    t.assert.fail('Should throw fastify duplicated route declaration')
+  } catch (error) {
+    t.assert.strictEqual(error.code, 'FST_ERR_DUPLICATED_ROUTE')
+  }
+})
+
+test('Will pass onSend hook to HEAD method if exposeHeadRoutes is true /1', async (t) => {
+  t.plan(1)
+
+  const fastify = Fastify({ exposeHeadRoutes: true })
+
+  await fastify.register((scope, opts, next) => {
+    scope.route({
+      method: 'GET',
+      path: '/route',
+      handler: (req, reply) => {
+        reply.send({ ok: true })
+      },
+      onSend: (req, reply, payload, done) => {
+        reply.header('x-content-type', 'application/fastify')
+        done(null, payload)
+      }
+    })
+
+    next()
+  }, { prefix: '/prefix' })
+
+  await fastify.ready()
+
+  const result = await fastify.inject({
+    url: '/prefix/route',
+    method: 'HEAD'
+  })
+
+  t.assert.strictEqual(result.headers['x-content-type'], 'application/fastify')
+})
+
+test('Will pass onSend hook to HEAD method if exposeHeadRoutes is true /2', async (t) => {
+  t.plan(1)
+
+  const fastify = Fastify({ exposeHeadRoutes: true })
+
+  await fastify.register((scope, opts, next) => {
+    scope.route({
+      method: 'get',
+      path: '/route',
+      handler: (req, reply) => {
+        reply.send({ ok: true })
+      },
+      onSend: (req, reply, payload, done) => {
+        reply.header('x-content-type', 'application/fastify')
+        done(null, payload)
+      }
+    })
+
+    next()
+  }, { prefix: '/prefix' })
+
+  await fastify.ready()
+
+  const result = await fastify.inject({
+    url: '/prefix/route',
+    method: 'HEAD'
+  })
+
+  t.assert.strictEqual(result.headers['x-content-type'], 'application/fastify')
+})