fastify 4.27.0 → 5.0.0-alpha.2

package/test/check.test.js

@@ -0,0 +1,225 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const { S } = require('fluent-json-schema')
+const Fastify = require('..')
+const sget = require('simple-get').concat
+
+const BadRequestSchema = S.object()
+  .prop('statusCode', S.number())
+  .prop('error', S.string())
+  .prop('message', S.string())
+
+const InternalServerErrorSchema = S.object()
+  .prop('statusCode', S.number())
+  .prop('error', S.string())
+  .prop('message', S.string())
+
+const NotFoundSchema = S.object()
+  .prop('statusCode', S.number())
+  .prop('error', S.string())
+  .prop('message', S.string())
+
+const options = {
+  schema: {
+    body: {
+      type: 'object',
+      properties: {
+        id: { type: 'string' }
+      }
+    },
+    response: {
+      200: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' }
+        }
+      },
+      400: {
+        description: 'Bad Request',
+        content: {
+          'application/json': {
+            schema: BadRequestSchema.valueOf()
+          }
+        }
+      },
+      404: {
+        description: 'Resource not found',
+        content: {
+          'application/json': {
+            schema: NotFoundSchema.valueOf(),
+            example: {
+              statusCode: 404,
+              error: 'Not Found',
+              message: 'Not Found'
+            }
+          }
+        }
+      },
+      500: {
+        description: 'Internal Server Error',
+        content: {
+          'application/json': {
+            schema: InternalServerErrorSchema.valueOf(),
+            example: {
+              message: 'Internal Server Error'
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+const handler = (request, reply) => {
+  console.log('in handler')
+  if (request.body.id === '400') {
+    return reply.status(400).send({
+      statusCode: 400,
+      error: 'Bad Request',
+      message: 'Custom message',
+      extra: 'This should not be in the response'
+    })
+  }
+
+  if (request.body.id === '404') {
+    return reply.status(404).send({
+      statusCode: 404,
+      error: 'Not Found',
+      message: 'Custom Not Found',
+      extra: 'This should not be in the response'
+    })
+  }
+
+  if (request.body.id === '500') {
+    reply.status(500).send({
+      statusCode: 500,
+      error: 'Internal Server Error',
+      message: 'Custom Internal Server Error',
+      extra: 'This should not be in the response'
+    })
+  }
+
+  reply.send({
+    id: request.body.id,
+    extra: 'This should not be in the response'
+  })
+}
+
+test('serialize the response for a Bad Request error, as defined on the schema', t => {
+  const fastify = Fastify({})
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.post('/', options, handler)
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    const url = `http://localhost:${fastify.server.address().port}/`
+
+    sget({
+      method: 'POST',
+      url,
+      json: true
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 400)
+      t.same(body, {
+        statusCode: 400,
+        error: 'Bad Request',
+        message: 'body must be object'
+      })
+      t.end()
+    })
+  })
+})
+
+// test('serialize the response for a Not Found error, as defined on the schema', t => {
+//   const fastify = Fastify({})
+
+//   t.teardown(fastify.close.bind(fastify))
+
+//   fastify.post('/', options, handler)
+
+//   fastify.listen({ port: 0 }, err => {
+//     t.error(err)
+
+//     const url = `http://localhost:${fastify.server.address().port}/`
+
+//     sget({
+//       method: 'POST',
+//       url,
+//       json: true,
+//       body: { id: '404' }
+//     }, (err, response, body) => {
+//       t.error(err)
+//       t.equal(response.statusCode, 404)
+//       t.same(body, {
+//         statusCode: 404,
+//         error: 'Not Found',
+//         message: 'Custom Not Found'
+//       })
+//       t.end()
+//     })
+//   })
+// })
+
+// test('serialize the response for a Internal Server Error error, as defined on the schema', t => {
+//   const fastify = Fastify({})
+
+//   t.teardown(fastify.close.bind(fastify))
+
+//   fastify.post('/', options, handler)
+
+//   fastify.listen({ port: 0 }, err => {
+//     t.error(err)
+
+//     const url = `http://localhost:${fastify.server.address().port}/`
+
+//     sget({
+//       method: 'POST',
+//       url,
+//       json: true,
+//       body: { id: '500' }
+//     }, (err, response, body) => {
+//       t.error(err)
+//       t.equal(response.statusCode, 500)
+//       t.same(body, {
+//         statusCode: 500,
+//         error: 'Internal Server Error',
+//         message: 'Custom Internal Server Error'
+//       })
+//       t.end()
+//     })
+//   })
+// })
+
+// test('serialize the success response, as defined on the schema', t => {
+//   const fastify = Fastify({})
+
+//   t.teardown(fastify.close.bind(fastify))
+
+//   fastify.post('/', options, handler)
+
+//   fastify.listen({ port: 0 }, err => {
+//     t.error(err)
+
+//     const url = `http://localhost:${fastify.server.address().port}/`
+
+//     sget({
+//       method: 'POST',
+//       url,
+//       json: true,
+//       body: { id: 'test' }
+//     }, (err, response, body) => {
+//       t.error(err)
+//       t.equal(response.statusCode, 200)
+//       t.same(body, {
+//         id: 'test'
+//       })
+//       t.end()
+//     })
+//   })
+// })

package/test/close-pipelining.test.js

@@ -4,7 +4,6 @@ const t = require('tap')
 const test = t.test
 const Fastify = require('..')
 const { Client } = require('undici')
-const semver = require('semver')
 
 test('Should return 503 while closing - pipelining', async t => {
   const fastify = Fastify({
@@ -36,39 +35,8 @@ test('Should return 503 while closing - pipelining', async t => {
   await instance.close()
 })
 
-const isNodeVersionGte1819 = semver.gte(process.version, '18.19.0')
-test('Should not return 503 while closing - pipelining - return503OnClosing: false, skip Node >= v18.19.x', { skip: isNodeVersionGte1819 }, async t => {
-  const fastify = Fastify({
-    return503OnClosing: false,
-    forceCloseConnections: false
-  })
-
-  fastify.get('/', (req, reply) => {
-    fastify.close()
-    reply.send({ hello: 'world' })
-  })
-
-  await fastify.listen({ port: 0 })
-
-  const instance = new Client('http://localhost:' + fastify.server.address().port, {
-    pipelining: 2
-  })
-
-  const codes = [200, 200, 200]
-  const responses = await Promise.all([
-    instance.request({ path: '/', method: 'GET' }),
-    instance.request({ path: '/', method: 'GET' }),
-    instance.request({ path: '/', method: 'GET' })
-  ])
-  const actual = responses.map(r => r.statusCode)
-
-  t.same(actual, codes)
-
-  await instance.close()
-})
-
-test('Should close the socket abruptly - pipelining - return503OnClosing: false, skip Node < v18.19.x', { skip: !isNodeVersionGte1819 }, async t => {
-  // Since Node v18, we will always invoke server.closeIdleConnections()
+test('Should close the socket abruptly - pipelining - return503OnClosing: false', async t => {
+  // Since Node v20, we will always invoke server.closeIdleConnections()
   // therefore our socket will be closed
   const fastify = Fastify({
     return503OnClosing: false,

package/test/close.test.js

@@ -5,7 +5,6 @@ const http = require('node:http')
 const { test } = require('tap')
 const Fastify = require('..')
 const { Client } = require('undici')
-const semver = require('semver')
 const split = require('split2')
 const { sleep } = require('./helper')
 
@@ -204,46 +203,7 @@ test('Should return error while closing (callback) - injection', t => {
   })
 })
 
-const isNodeVersionGte1819 = semver.gte(process.version, '18.19.0')
-test('Current opened connection should continue to work after closing and return "connection: close" header - return503OnClosing: false, skip Node >= v18.19.x', { skip: isNodeVersionGte1819 }, t => {
-  const fastify = Fastify({
-    return503OnClosing: false,
-    forceCloseConnections: false
-  })
-
-  fastify.get('/', (req, reply) => {
-    fastify.close()
-    reply.send({ hello: 'world' })
-  })
-
-  fastify.listen({ port: 0 }, err => {
-    t.error(err)
-
-    const port = fastify.server.address().port
-    const client = net.createConnection({ port }, () => {
-      client.write('GET / HTTP/1.1\r\nHost: example.com\r\n\r\n')
-
-      client.once('data', data => {
-        t.match(data.toString(), /Connection:\s*keep-alive/i)
-        t.match(data.toString(), /200 OK/i)
-
-        client.write('GET / HTTP/1.1\r\nHost: example.com\r\n\r\n')
-
-        client.once('data', data => {
-          t.match(data.toString(), /Connection:\s*close/i)
-          t.match(data.toString(), /200 OK/i)
-
-          // Test that fastify closes the TCP connection
-          client.once('close', () => {
-            t.end()
-          })
-        })
-      })
-    })
-  })
-})
-
-test('Current opened connection should NOT continue to work after closing and return "connection: close" header - return503OnClosing: false, skip Node < v18.19.x', { skip: !isNodeVersionGte1819 }, t => {
+test('Current opened connection should NOT continue to work after closing and return "connection: close" header - return503OnClosing: false', t => {
   t.plan(4)
   const fastify = Fastify({
     return503OnClosing: false,

package/test/content-parser.test.js

@@ -12,19 +12,20 @@ const third = function (req, payload, done) {}
 
 test('hasContentTypeParser', t => {
   test('should know about internal parsers', t => {
-    t.plan(4)
+    t.plan(5)
 
     const fastify = Fastify()
     fastify.ready(err => {
       t.error(err)
       t.ok(fastify.hasContentTypeParser('application/json'))
       t.ok(fastify.hasContentTypeParser('text/plain'))
+      t.ok(fastify.hasContentTypeParser('  text/plain  '))
       t.notOk(fastify.hasContentTypeParser('application/jsoff'))
     })
   })
 
-  test('should work with string and RegExp', t => {
-    t.plan(7)
+  test('should only work with string and RegExp', t => {
+    t.plan(8)
 
     const fastify = Fastify()
     fastify.addContentTypeParser(/^image\/.*/, first)
@@ -38,6 +39,7 @@ test('hasContentTypeParser', t => {
     t.notOk(fastify.hasContentTypeParser(/^image\/.+\+xml/))
     t.notOk(fastify.hasContentTypeParser('image/png'))
     t.notOk(fastify.hasContentTypeParser('*'))
+    t.throws(() => fastify.hasContentTypeParser(123), FST_ERR_CTP_INVALID_TYPE)
   })
 
   t.end()
@@ -45,7 +47,7 @@ test('hasContentTypeParser', t => {
 
 test('getParser', t => {
   test('should return matching parser', t => {
-    t.plan(3)
+    t.plan(6)
 
     const fastify = Fastify()
 
@@ -56,9 +58,12 @@ test('getParser', t => {
     t.equal(fastify[keys.kContentTypeParser].getParser('application/t+xml').fn, second)
     t.equal(fastify[keys.kContentTypeParser].getParser('image/png').fn, first)
     t.equal(fastify[keys.kContentTypeParser].getParser('text/html').fn, third)
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/html; charset=utf-8').fn, third)
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/html ; charset=utf-8').fn, third)
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/htmlINVALID')?.fn, undefined)
   })
 
-  test('should return matching parser with caching', t => {
+  test('should return matching parser with caching /1', t => {
     t.plan(6)
 
     const fastify = Fastify()
@@ -73,6 +78,21 @@ test('getParser', t => {
     t.equal(fastify[keys.kContentTypeParser].cache.size, 1)
   })
 
+  test('should return matching parser with caching /2', t => {
+    t.plan(6)
+
+    const fastify = Fastify()
+
+    fastify.addContentTypeParser(/^text\/html(;\s*charset=[^;]+)?$/, first)
+
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/html').fn, first)
+    t.equal(fastify[keys.kContentTypeParser].cache.size, 1)
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/html;charset=utf-8').fn, first)
+    t.equal(fastify[keys.kContentTypeParser].cache.size, 2)
+    t.equal(fastify[keys.kContentTypeParser].getParser('text/html;charset=utf-8').fn, first)
+    t.equal(fastify[keys.kContentTypeParser].cache.size, 2)
+  })
+
   test('should prefer content type parser with string value', t => {
     t.plan(2)
 
@@ -199,6 +219,36 @@ test('add', t => {
     t.equal(contentTypeParser.customParsers.get('').fn, first)
   })
 
+  test('should lowercase contentTypeParser name', async t => {
+    t.plan(1)
+    const fastify = Fastify()
+    fastify.addContentTypeParser('text/html', function (req, done) {
+      done()
+    })
+    try {
+      fastify.addContentTypeParser('TEXT/html', function (req, done) {
+        done()
+      })
+    } catch (err) {
+      t.same(err.message, FST_ERR_CTP_ALREADY_PRESENT('text/html').message)
+    }
+  })
+
+  test('should trim contentTypeParser name', async t => {
+    t.plan(1)
+    const fastify = Fastify()
+    fastify.addContentTypeParser('text/html', function (req, done) {
+      done()
+    })
+    try {
+      fastify.addContentTypeParser('    text/html', function (req, done) {
+        done()
+      })
+    } catch (err) {
+      t.same(err.message, FST_ERR_CTP_ALREADY_PRESENT('text/html').message)
+    }
+  })
+
   t.end()
 })
 
@@ -256,7 +306,7 @@ test('Error thrown 415 from content type is null and make post request to server
 
 test('remove', t => {
   test('should remove default parser', t => {
-    t.plan(3)
+    t.plan(6)
 
     const fastify = Fastify()
     const contentTypeParser = fastify[keys.kContentTypeParser]
@@ -264,6 +314,9 @@ test('remove', t => {
     t.ok(contentTypeParser.remove('application/json'))
     t.notOk(contentTypeParser.customParsers['application/json'])
     t.notOk(contentTypeParser.parserList.find(parser => parser === 'application/json'))
+    t.ok(contentTypeParser.remove('  text/plain  '))
+    t.notOk(contentTypeParser.customParsers['text/plain'])
+    t.notOk(contentTypeParser.parserList.find(parser => parser === 'text/plain'))
   })
 
   test('should remove RegExp parser', t => {
@@ -421,32 +474,25 @@ test('Safeguard against content-type spoofing - string', async t => {
   })
 })
 
-test('Safeguard against content-type spoofing - regexp', async t => {
-  t.plan(1)
+test('Warning against improper content-type - regexp', t => {
+  t.plan(2)
 
   const fastify = Fastify()
+
+  process.on('warning', onWarning)
+  function onWarning (warning) {
+    t.equal(warning.name, 'FastifySecurity')
+    t.equal(warning.code, 'FSTSEC001')
+  }
+  t.teardown(() => process.removeListener('warning', onWarning))
+
   fastify.removeAllContentTypeParsers()
   fastify.addContentTypeParser(/text\/plain/, function (request, body, done) {
-    t.pass('should be called')
     done(null, body)
   })
   fastify.addContentTypeParser(/application\/json/, function (request, body, done) {
-    t.fail('shouldn\'t be called')
     done(null, body)
   })
-
-  fastify.post('/', async () => {
-    return 'ok'
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'text/plain; content-type="application/json"'
-    },
-    body: ''
-  })
 })
 
 test('content-type match parameters - string 1', async t => {
@@ -477,34 +523,6 @@ test('content-type match parameters - string 1', async t => {
   })
 })
 
-test('content-type match parameters - string 2', async t => {
-  t.plan(1)
-
-  const fastify = Fastify()
-  fastify.removeAllContentTypeParsers()
-  fastify.addContentTypeParser('application/json; charset=utf8; foo=bar', function (request, body, done) {
-    t.pass('should be called')
-    done(null, body)
-  })
-  fastify.addContentTypeParser('text/plain; charset=utf8; foo=bar', function (request, body, done) {
-    t.fail('shouldn\'t be called')
-    done(null, body)
-  })
-
-  fastify.post('/', async () => {
-    return 'ok'
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'application/json; foo=bar; charset=utf8'
-    },
-    body: ''
-  })
-})
-
 test('content-type match parameters - regexp', async t => {
   t.plan(1)
 
@@ -650,72 +668,6 @@ test('content-type regexp list should be cloned when plugin override', async t =
   }
 })
 
-test('allow partial content-type - essence check', async t => {
-  t.plan(1)
-
-  const fastify = Fastify()
-  fastify.removeAllContentTypeParsers()
-  fastify.addContentTypeParser('json', function (request, body, done) {
-    t.pass('should be called')
-    done(null, body)
-  })
-
-  fastify.post('/', async () => {
-    return 'ok'
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'application/json; foo=bar; charset=utf8'
-    },
-    body: ''
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'image/jpeg'
-    },
-    body: ''
-  })
-})
-
-test('allow partial content-type - not essence check', async t => {
-  t.plan(1)
-
-  const fastify = Fastify()
-  fastify.removeAllContentTypeParsers()
-  fastify.addContentTypeParser('json;', function (request, body, done) {
-    t.pass('should be called')
-    done(null, body)
-  })
-
-  fastify.post('/', async () => {
-    return 'ok'
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'application/json; foo=bar; charset=utf8'
-    },
-    body: ''
-  })
-
-  await fastify.inject({
-    method: 'POST',
-    path: '/',
-    headers: {
-      'content-type': 'image/jpeg'
-    },
-    body: ''
-  })
-})
-
 test('edge case content-type - ;', async t => {
   t.plan(1)
 

package/test/custom-parser.1.test.js

@@ -63,7 +63,7 @@ test('Should have typeof body object with no custom parser defined, undefined bo
   })
 })
 
-test('Should get the body as string', t => {
+test('Should get the body as string /1', t => {
   t.plan(6)
   const fastify = Fastify()
 
@@ -102,6 +102,45 @@ test('Should get the body as string', t => {
   })
 })
 
+test('Should get the body as string /2', t => {
+  t.plan(6)
+  const fastify = Fastify()
+
+  fastify.post('/', (req, reply) => {
+    reply.send(req.body)
+  })
+
+  fastify.addContentTypeParser('text/plain/test', { parseAs: 'string' }, function (req, body, done) {
+    t.ok('called')
+    t.ok(typeof body === 'string')
+    try {
+      const plainText = body
+      done(null, plainText)
+    } catch (err) {
+      err.statusCode = 400
+      done(err, undefined)
+    }
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    sget({
+      method: 'POST',
+      url: getServerUrl(fastify),
+      body: 'hello world',
+      headers: {
+        'Content-Type': '   text/plain/test  '
+      }
+    }, (err, response, body) => {
+      t.error(err)
+      t.equal(response.statusCode, 200)
+      t.equal(body.toString(), 'hello world')
+      fastify.close()
+    })
+  })
+})
+
 test('Should get the body as buffer', t => {
   t.plan(6)
   const fastify = Fastify()

package/test/decorator-namespace.test._js_

@@ -0,0 +1,31 @@
+'use strict'
+
+/* eslint no-prototype-builtins: 0 */
+
+const t = require('tap')
+const test = t.test
+const Fastify = require('..')
+const fp = require('fastify-plugin')
+
+test('plugin namespace', async t => {
+  t.plan(2)
+  const app = Fastify()
+
+  await app.register(async function plugin (app, opts) {
+    app.decorate('utility', function () {
+      return 'utility'
+    })
+
+    app.get('/', function (req, reply) {
+      // ! here the plugin would use app.utility()
+      // ! the plugin does not know about the namespace
+      reply.send({ utility: app.utility() })
+    })
+  }, { namepace: 'foo' })
+
+  // ! but outside the plugin the decorator would be app.foo.utility()
+  t.ok(app.foo.utility)
+
+  const res = await app.inject('/')
+  t.same(res.json(), { utility: 'utility' })
+})