node-fastify 5.8.3

package/test/route-shorthand.test.js

@@ -0,0 +1,48 @@
+'use strict'
+
+const { describe, test } = require('node:test')
+const { Client } = require('undici')
+const Fastify = require('..')
+
+describe('route-shorthand', () => {
+  const methodsReader = new Fastify()
+  const supportedMethods = methodsReader.supportedMethods
+
+  for (const method of supportedMethods) {
+    test(`route-shorthand - ${method.toLowerCase()}`, async (t) => {
+      t.plan(2)
+      const fastify = new Fastify()
+      fastify[method.toLowerCase()]('/', (req, reply) => {
+        t.assert.strictEqual(req.method, method)
+        reply.send()
+      })
+      await fastify.listen({ port: 0 })
+      t.after(() => fastify.close())
+
+      const instance = new Client(`http://localhost:${fastify.server.address().port}`)
+
+      const response = await instance.request({ path: '/', method })
+      t.assert.strictEqual(response.statusCode, 200)
+    })
+  }
+
+  test('route-shorthand - all', async (t) => {
+    t.plan(2 * supportedMethods.length)
+    const fastify = new Fastify()
+    let currentMethod = ''
+    fastify.all('/', function (req, reply) {
+      t.assert.strictEqual(req.method, currentMethod)
+      reply.send()
+    })
+    await fastify.listen({ port: 0 })
+    t.after(() => fastify.close())
+
+    for (const method of supportedMethods) {
+      currentMethod = method
+      const instance = new Client(`http://localhost:${fastify.server.address().port}`)
+
+      const response = await instance.request({ path: '/', method })
+      t.assert.strictEqual(response.statusCode, 200)
+    }
+  })
+})

package/test/route.1.test.js

@@ -0,0 +1,259 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('..')
+const {
+  FST_ERR_INSTANCE_ALREADY_LISTENING,
+  FST_ERR_ROUTE_METHOD_INVALID
+} = require('../lib/errors')
+const { getServerUrl } = require('./helper')
+
+test('route', async t => {
+  t.plan(10)
+
+  await t.test('route - get', async (t) => {
+    t.plan(4)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() =>
+      fastify.route({
+        method: 'GET',
+        url: '/',
+        schema: {
+          response: {
+            '2xx': {
+              type: 'object',
+              properties: {
+                hello: {
+                  type: 'string'
+                }
+              }
+            }
+          }
+        },
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      })
+    )
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const response = await fetch(getServerUrl(fastify) + '/')
+    t.assert.ok(response.ok)
+    t.assert.strictEqual(response.status, 200)
+    t.assert.deepStrictEqual(await response.json(), { hello: 'world' })
+  })
+
+  await t.test('missing schema - route', async (t) => {
+    t.plan(4)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() =>
+      fastify.route({
+        method: 'GET',
+        url: '/missing',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      })
+    )
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const response = await fetch(getServerUrl(fastify) + '/missing')
+    t.assert.ok(response.ok)
+    t.assert.strictEqual(response.status, 200)
+    t.assert.deepStrictEqual(await response.json(), { hello: 'world' })
+  })
+
+  await t.test('invalid handler attribute - route', t => {
+    t.plan(1)
+
+    const fastify = Fastify()
+    t.assert.throws(() => fastify.get('/', { handler: 'not a function' }, () => { }))
+  })
+
+  await t.test('Add Multiple methods per route all uppercase', async (t) => {
+    t.plan(7)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() =>
+      fastify.route({
+        method: ['GET', 'DELETE'],
+        url: '/multiple',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      }))
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const getResponse = await fetch(getServerUrl(fastify) + '/multiple')
+    t.assert.ok(getResponse.ok)
+    t.assert.strictEqual(getResponse.status, 200)
+    t.assert.deepStrictEqual(await getResponse.json(), { hello: 'world' })
+
+    const deleteResponse = await fetch(getServerUrl(fastify) + '/multiple', { method: 'DELETE' })
+    t.assert.ok(deleteResponse.ok)
+    t.assert.strictEqual(deleteResponse.status, 200)
+    t.assert.deepStrictEqual(await deleteResponse.json(), { hello: 'world' })
+  })
+
+  await t.test('Add Multiple methods per route all lowercase', async (t) => {
+    t.plan(7)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() =>
+      fastify.route({
+        method: ['get', 'delete'],
+        url: '/multiple',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      }))
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const getResponse = await fetch(getServerUrl(fastify) + '/multiple')
+    t.assert.ok(getResponse.ok)
+    t.assert.strictEqual(getResponse.status, 200)
+    t.assert.deepStrictEqual(await getResponse.json(), { hello: 'world' })
+
+    const deleteResponse = await fetch(getServerUrl(fastify) + '/multiple', { method: 'DELETE' })
+    t.assert.ok(deleteResponse.ok)
+    t.assert.strictEqual(deleteResponse.status, 200)
+    t.assert.deepStrictEqual(await deleteResponse.json(), { hello: 'world' })
+  })
+
+  await t.test('Add Multiple methods per route mixed uppercase and lowercase', async (t) => {
+    t.plan(7)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() =>
+      fastify.route({
+        method: ['GET', 'delete'],
+        url: '/multiple',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      }))
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const getResponse = await fetch(getServerUrl(fastify) + '/multiple')
+    t.assert.ok(getResponse.ok)
+    t.assert.strictEqual(getResponse.status, 200)
+    t.assert.deepStrictEqual(await getResponse.json(), { hello: 'world' })
+
+    const deleteResponse = await fetch(getServerUrl(fastify) + '/multiple', { method: 'DELETE' })
+    t.assert.ok(deleteResponse.ok)
+    t.assert.strictEqual(deleteResponse.status, 200)
+    t.assert.deepStrictEqual(await deleteResponse.json(), { hello: 'world' })
+  })
+
+  t.test('Add invalid Multiple methods per route', t => {
+    t.plan(1)
+
+    const fastify = Fastify()
+    t.assert.throws(() =>
+      fastify.route({
+        method: ['GET', 1],
+        url: '/invalid-method',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      }), new FST_ERR_ROUTE_METHOD_INVALID())
+  })
+
+  await t.test('Add method', t => {
+    t.plan(1)
+
+    const fastify = Fastify()
+    t.assert.throws(() =>
+      fastify.route({
+        method: 1,
+        url: '/invalid-method',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      }), new FST_ERR_ROUTE_METHOD_INVALID())
+  })
+
+  await t.test('Add additional multiple methods to existing route', async (t) => {
+    t.plan(7)
+
+    const fastify = Fastify()
+    t.assert.doesNotThrow(() => {
+      fastify.get('/add-multiple', function (req, reply) {
+        reply.send({ hello: 'Bob!' })
+      })
+      fastify.route({
+        method: ['PUT', 'DELETE'],
+        url: '/add-multiple',
+        handler: function (req, reply) {
+          reply.send({ hello: 'world' })
+        }
+      })
+    })
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    const putResponse = await fetch(getServerUrl(fastify) + '/add-multiple', { method: 'PUT' })
+    t.assert.ok(putResponse.ok)
+    t.assert.strictEqual(putResponse.status, 200)
+    t.assert.deepStrictEqual(await putResponse.json(), { hello: 'world' })
+
+    const deleteResponse = await fetch(getServerUrl(fastify) + '/add-multiple', { method: 'DELETE' })
+    t.assert.ok(deleteResponse.ok)
+    t.assert.strictEqual(deleteResponse.status, 200)
+    t.assert.deepStrictEqual(await deleteResponse.json(), { hello: 'world' })
+  })
+
+  await t.test('cannot add another route after binding', async (t) => {
+    t.plan(1)
+
+    const fastify = Fastify()
+
+    await fastify.listen({ port: 0 })
+    t.after(() => { fastify.close() })
+
+    t.assert.throws(() => fastify.route({
+      method: 'GET',
+      url: '/another-get-route',
+      handler: function (req, reply) {
+        reply.send({ hello: 'world' })
+      }
+    }), new FST_ERR_INSTANCE_ALREADY_LISTENING('Cannot add route!'))
+  })
+})
+
+test('invalid schema - route', (t, done) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.route({
+    handler: () => { },
+    method: 'GET',
+    url: '/invalid',
+    schema: {
+      querystring: {
+        id: 'string'
+      }
+    }
+  })
+  fastify.after(err => {
+    t.assert.ok(!err, 'the error is throw on preReady')
+  })
+  fastify.ready(err => {
+    t.assert.strictEqual(err.code, 'FST_ERR_SCH_VALIDATION_BUILD')
+    t.assert.match(err.message, /Failed building the validation schema for GET: \/invalid/)
+    done()
+  })
+})

package/test/route.2.test.js

@@ -0,0 +1,100 @@
+'use strict'
+
+const { test } = require('node:test')
+const Fastify = require('../fastify')
+
+test('same route definition object on multiple prefixes', async t => {
+  t.plan(2)
+
+  const routeObject = {
+    handler: () => { },
+    method: 'GET',
+    url: '/simple'
+  }
+
+  const fastify = Fastify({ exposeHeadRoutes: false })
+
+  fastify.register(async function (f) {
+    f.addHook('onRoute', (routeOptions) => {
+      t.assert.strictEqual(routeOptions.url, '/v1/simple')
+    })
+    f.route(routeObject)
+  }, { prefix: '/v1' })
+  fastify.register(async function (f) {
+    f.addHook('onRoute', (routeOptions) => {
+      t.assert.strictEqual(routeOptions.url, '/v2/simple')
+    })
+    f.route(routeObject)
+  }, { prefix: '/v2' })
+
+  await fastify.ready()
+})
+
+test('path can be specified in place of uri', (t, done) => {
+  t.plan(3)
+  const fastify = Fastify()
+
+  fastify.route({
+    method: 'GET',
+    path: '/path',
+    handler: function (req, reply) {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  const reqOpts = {
+    method: 'GET',
+    url: '/path'
+  }
+
+  fastify.inject(reqOpts, (err, res) => {
+    t.assert.ifError(err)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(JSON.parse(res.payload), { hello: 'world' })
+    done()
+  })
+})
+
+test('invalid bodyLimit option - route', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  try {
+    fastify.route({
+      bodyLimit: false,
+      method: 'PUT',
+      handler: () => null
+    })
+    t.assert.fail('bodyLimit must be an integer')
+  } catch (err) {
+    t.assert.strictEqual(err.message, "'bodyLimit' option must be an integer > 0. Got 'false'")
+  }
+
+  try {
+    fastify.post('/url', { bodyLimit: 10000.1 }, () => null)
+    t.assert.fail('bodyLimit must be an integer')
+  } catch (err) {
+    t.assert.strictEqual(err.message, "'bodyLimit' option must be an integer > 0. Got '10000.1'")
+  }
+})
+
+test('handler function in options of shorthand route should works correctly', (t, done) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  fastify.get('/foo', {
+    handler: (req, reply) => {
+      reply.send({ hello: 'world' })
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/foo'
+  }, (err, res) => {
+    t.assert.ifError(err)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(JSON.parse(res.payload), { hello: 'world' })
+    done()
+  })
+})

package/test/route.3.test.js

@@ -0,0 +1,213 @@
+'use strict'
+
+const { test } = require('node:test')
+const joi = require('joi')
+const Fastify = require('..')
+
+test('does not mutate joi schemas', (t, done) => {
+  t.plan(5)
+
+  const fastify = Fastify()
+  function validatorCompiler ({ schema, method, url, httpPart }) {
+    // Needed to extract the params part,
+    // without the JSON-schema encapsulation
+    // that is automatically added by the short
+    // form of params.
+    schema = joi.object(schema.properties)
+
+    return validateHttpData
+
+    function validateHttpData (data) {
+      return schema.validate(data)
+    }
+  }
+
+  fastify.setValidatorCompiler(validatorCompiler)
+
+  fastify.route({
+    path: '/foo/:an_id',
+    method: 'GET',
+    schema: {
+      params: { an_id: joi.number() }
+    },
+    handler (req, res) {
+      t.assert.strictEqual(Object.keys(req.params).length, 1)
+      t.assert.strictEqual(req.params.an_id, '42')
+      res.send({ hello: 'world' })
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/foo/42'
+  }, (err, res) => {
+    t.assert.ifError(err)
+    t.assert.strictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.json(), { hello: 'world' })
+    done()
+  })
+})
+
+test('multiple routes with one schema', (t, done) => {
+  t.plan(2)
+
+  const fastify = Fastify()
+
+  const schema = {
+    query: {
+      type: 'object',
+      properties: {
+        id: { type: 'number' }
+      }
+    }
+  }
+
+  fastify.route({
+    schema,
+    method: 'GET',
+    path: '/first/:id',
+    handler (req, res) {
+      res.send({ hello: 'world' })
+    }
+  })
+
+  fastify.route({
+    schema,
+    method: 'GET',
+    path: '/second/:id',
+    handler (req, res) {
+      res.send({ hello: 'world' })
+    }
+  })
+
+  fastify.ready(error => {
+    t.assert.ifError(error)
+    t.assert.deepStrictEqual(schema, schema)
+    done()
+  })
+})
+
+test('route error handler overrides default error handler', (t, done) => {
+  t.plan(4)
+
+  const fastify = Fastify()
+
+  const customRouteErrorHandler = (error, request, reply) => {
+    t.assert.strictEqual(error.message, 'Wrong Pot Error')
+
+    reply.code(418).send({
+      message: 'Make a brew',
+      statusCode: 418,
+      error: 'Wrong Pot Error'
+    })
+  }
+
+  fastify.route({
+    method: 'GET',
+    path: '/coffee',
+    handler: (req, res) => {
+      res.send(new Error('Wrong Pot Error'))
+    },
+    errorHandler: customRouteErrorHandler
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/coffee'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 418)
+    t.assert.deepStrictEqual(res.json(), {
+      message: 'Make a brew',
+      statusCode: 418,
+      error: 'Wrong Pot Error'
+    })
+    done()
+  })
+})
+
+test('route error handler does not affect other routes', (t, done) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+
+  const customRouteErrorHandler = (error, request, reply) => {
+    t.assert.strictEqual(error.message, 'Wrong Pot Error')
+
+    reply.code(418).send({
+      message: 'Make a brew',
+      statusCode: 418,
+      error: 'Wrong Pot Error'
+    })
+  }
+
+  fastify.route({
+    method: 'GET',
+    path: '/coffee',
+    handler: (req, res) => {
+      res.send(new Error('Wrong Pot Error'))
+    },
+    errorHandler: customRouteErrorHandler
+  })
+
+  fastify.route({
+    method: 'GET',
+    path: '/tea',
+    handler: (req, res) => {
+      res.send(new Error('No tea today'))
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/tea'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 500)
+    t.assert.deepStrictEqual(res.json(), {
+      message: 'No tea today',
+      statusCode: 500,
+      error: 'Internal Server Error'
+    })
+    done()
+  })
+})
+
+test('async error handler for a route', (t, done) => {
+  t.plan(4)
+
+  const fastify = Fastify()
+
+  const customRouteErrorHandler = async (error, request, reply) => {
+    t.assert.strictEqual(error.message, 'Delayed Pot Error')
+    reply.code(418)
+    return {
+      message: 'Make a brew sometime later',
+      statusCode: 418,
+      error: 'Delayed Pot Error'
+    }
+  }
+
+  fastify.route({
+    method: 'GET',
+    path: '/late-coffee',
+    handler: (req, res) => {
+      res.send(new Error('Delayed Pot Error'))
+    },
+    errorHandler: customRouteErrorHandler
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/late-coffee'
+  }, (error, res) => {
+    t.assert.ifError(error)
+    t.assert.strictEqual(res.statusCode, 418)
+    t.assert.deepStrictEqual(res.json(), {
+      message: 'Make a brew sometime later',
+      statusCode: 418,
+      error: 'Delayed Pot Error'
+    })
+    done()
+  })
+})