fastify 4.28.0 → 5.0.0-alpha.3

package/test/logger/options.test.js

@@ -12,7 +12,7 @@ const { on } = stream
 t.test('logger options', (t) => {
   t.setTimeout(60000)
 
-  t.plan(12)
+  t.plan(16)
 
   t.test('logger can be silenced', (t) => {
     t.plan(17)
@@ -48,10 +48,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'error' }, stream)
+    const loggerInstance = pino({ level: 'error' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -94,10 +94,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'error' }, stream)
+    const loggerInstance = pino({ level: 'error' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -130,10 +130,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'error' }, stream)
+    const loggerInstance = pino({ level: 'error' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -193,9 +193,9 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'info' }, stream)
+    const loggerInstance = pino({ level: 'info' }, stream)
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -252,9 +252,9 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'info' }, stream)
+    const loggerInstance = pino({ level: 'info' }, stream)
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -290,9 +290,9 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'info' }, stream)
+    const loggerInstance = pino({ level: 'info' }, stream)
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -333,10 +333,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'info' }, stream)
+    const loggerInstance = pino({ level: 'info' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -369,10 +369,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'warn' }, stream)
+    const loggerInstance = pino({ level: 'warn' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -404,10 +404,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'warn' }, stream)
+    const loggerInstance = pino({ level: 'warn' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -444,10 +444,10 @@ t.test('logger options', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'error' }, stream)
+    const loggerInstance = pino({ level: 'error' }, stream)
 
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -497,4 +497,85 @@ t.test('logger options', (t) => {
     t.equal(typeof fastify.log.trace, 'function')
     t.equal(typeof fastify.log.child, 'function')
   })
+
+  t.test('Should throw an error if logger instance is passed to `logger`', async (t) => {
+    t.plan(2)
+    const stream = split(JSON.parse)
+
+    const logger = require('pino')(stream)
+
+    try {
+      Fastify({ logger })
+    } catch (err) {
+      t.ok(err)
+      t.equal(err.code, 'FST_ERR_LOG_INVALID_LOGGER_CONFIG')
+    }
+  })
+
+  t.test('Should throw an error if options are passed to `loggerInstance`', async (t) => {
+    t.plan(2)
+    try {
+      Fastify({ loggerInstance: { level: 'log' } })
+    } catch (err) {
+      t.ok(err)
+      t.equal(err.code, 'FST_ERR_LOG_INVALID_LOGGER_INSTANCE')
+    }
+  })
+
+  t.test('If both `loggerInstance` and `logger` are provided, an error should be thrown', async (t) => {
+    t.plan(2)
+    const loggerInstanceStream = split(JSON.parse)
+    const loggerInstance = pino({ level: 'error' }, loggerInstanceStream)
+    const loggerStream = split(JSON.parse)
+    try {
+      Fastify({
+        logger: {
+          stream: loggerStream,
+          level: 'info'
+        },
+        loggerInstance
+      })
+    } catch (err) {
+      t.ok(err)
+      t.equal(err.code, 'FST_ERR_LOG_LOGGER_AND_LOGGER_INSTANCE_PROVIDED')
+    }
+  })
+
+  t.test('`logger` should take pino configuration and create a pino logger', async (t) => {
+    const lines = ['hello', 'world']
+    t.plan(2 * lines.length + 2)
+    const loggerStream = split(JSON.parse)
+    const fastify = Fastify({
+      logger: {
+        stream: loggerStream,
+        level: 'error'
+      }
+    })
+    t.teardown(fastify.close.bind(fastify))
+    fastify.get('/hello', (req, reply) => {
+      req.log.error('hello')
+      reply.code(404).send()
+    })
+
+    fastify.get('/world', (req, reply) => {
+      req.log.error('world')
+      reply.code(201).send()
+    })
+
+    await fastify.ready()
+    {
+      const response = await fastify.inject({ method: 'GET', url: '/hello' })
+      t.equal(response.statusCode, 404)
+    }
+    {
+      const response = await fastify.inject({ method: 'GET', url: '/world' })
+      t.equal(response.statusCode, 201)
+    }
+
+    for await (const [line] of on(loggerStream, 'data')) {
+      t.equal(line.level, 50)
+      t.equal(line.msg, lines.shift())
+      if (lines.length === 0) break
+    }
+  })
 })

package/test/logger/response.test.js

@@ -24,9 +24,9 @@ t.test('response serialization', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({ level: 'info' }, stream)
+    const loggerInstance = pino({ level: 'info' }, stream)
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -70,7 +70,7 @@ t.test('response serialization', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({
+    const loggerInstance = pino({
       level: 'info',
       serializers: {
         test: value => 'X' + value,
@@ -78,7 +78,7 @@ t.test('response serialization', (t) => {
       }
     }, stream)
     const fastify = Fastify({
-      logger
+      loggerInstance
     })
     t.teardown(fastify.close.bind(fastify))
 
@@ -115,14 +115,14 @@ t.test('response serialization', (t) => {
 
     const stream = split(JSON.parse)
 
-    const logger = pino({
+    const loggerInstance = pino({
       level: 'info',
       serializers: {
         test: value => 'X' + value
       }
     }, stream)
 
-    const fastify = Fastify({ logger })
+    const fastify = Fastify({ loggerInstance })
     t.teardown(fastify.close.bind(fastify))
 
     fastify.register(context1, { logSerializers: { test2: value => 'Y' + value } })

package/test/maxRequestsPerSocket.test.js

@@ -2,12 +2,9 @@
 
 const net = require('node:net')
 const { test } = require('tap')
-const semver = require('semver')
 const Fastify = require('../fastify')
 
-const skip = semver.lt(process.versions.node, '16.10.0')
-
-test('maxRequestsPerSocket on node version >= 16.10.0', { skip }, t => {
+test('maxRequestsPerSocket', t => {
   t.plan(8)
 
   const fastify = Fastify({ maxRequestsPerSocket: 2 })
@@ -48,7 +45,7 @@ test('maxRequestsPerSocket on node version >= 16.10.0', { skip }, t => {
   })
 })
 
-test('maxRequestsPerSocket zero should behave same as null', { skip }, t => {
+test('maxRequestsPerSocket zero should behave same as null', t => {
   t.plan(10)
 
   const fastify = Fastify({ maxRequestsPerSocket: 0 })

package/test/method-missing.test.js

@@ -0,0 +1,24 @@
+const http = require('http')
+const { test } = require('tap')
+const Fastify = require('../fastify')
+
+test('missing method from http client', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  fastify.listen({ port: 3000 }, (err) => {
+    t.error(err)
+
+    const port = fastify.server.address().port
+    const req = http.request({
+      port,
+      method: 'REBIND',
+      path: '/'
+    }, (res) => {
+      t.equal(res.statusCode, 404)
+      fastify.close()
+    })
+
+    req.end()
+  })
+})

package/test/plugin.1.test.js

@@ -1,7 +1,5 @@
 'use strict'
 
-/* eslint no-prototype-builtins: 0 */
-
 const t = require('tap')
 const test = t.test
 const Fastify = require('../fastify')
@@ -117,8 +115,8 @@ test('fastify.register with fastify-plugin should provide access to external fas
 
     instance.register((i, o, n) => n(), p => {
       t.notOk(p === instance || p === fastify)
-      t.ok(instance.isPrototypeOf(p))
-      t.ok(fastify.isPrototypeOf(p))
+      t.ok(Object.prototype.isPrototypeOf.call(instance, p))
+      t.ok(Object.prototype.isPrototypeOf.call(fastify, p))
       t.ok(p.global)
     })
 

package/test/plugin.2.test.js

@@ -1,7 +1,5 @@
 'use strict'
 
-/* eslint no-prototype-builtins: 0 */
-
 const t = require('tap')
 const test = t.test
 const Fastify = require('../fastify')

package/test/plugin.3.test.js

@@ -1,7 +1,5 @@
 'use strict'
 
-/* eslint no-prototype-builtins: 0 */
-
 const t = require('tap')
 const test = t.test
 const Fastify = require('../fastify')

package/test/plugin.4.test.js

@@ -1,12 +1,11 @@
 'use strict'
 
-/* eslint no-prototype-builtins: 0 */
-
 const t = require('tap')
 const test = t.test
 const Fastify = require('../fastify')
 const fp = require('fastify-plugin')
 const fakeTimer = require('@sinonjs/fake-timers')
+const { FST_ERR_PLUGIN_INVALID_ASYNC_HANDLER } = require('../lib/errors')
 
 test('pluginTimeout', t => {
   t.plan(5)
@@ -133,6 +132,9 @@ test('plugin metadata - version not matching requirement', t => {
 test('plugin metadata - version not matching requirement 2', t => {
   t.plan(2)
   const fastify = Fastify()
+  Object.defineProperty(fastify, 'version', {
+    value: '99.0.0'
+  })
 
   plugin[Symbol.for('skip-override')] = true
   plugin[Symbol.for('plugin-meta')] = {
@@ -198,36 +200,75 @@ test('plugin metadata - release candidate', t => {
   }
 })
 
-test('fastify-rc loads prior version plugins', t => {
-  t.plan(2)
-  const fastify = Fastify()
-  Object.defineProperty(fastify, 'version', {
-    value: '99.0.0-rc.1'
+test('fastify-rc loads prior version plugins', async t => {
+  t.test('baseline (rc)', t => {
+    t.plan(2)
+
+    const fastify = Fastify()
+    Object.defineProperty(fastify, 'version', {
+      value: '99.0.0-rc.1'
+    })
+
+    plugin[Symbol.for('plugin-meta')] = {
+      name: 'plugin',
+      fastify: '^98.1.0'
+    }
+    plugin2[Symbol.for('plugin-meta')] = {
+      name: 'plugin2',
+      fastify: '98.x'
+    }
+
+    fastify.register(plugin)
+
+    fastify.ready((err) => {
+      t.error(err)
+      t.pass('everything right')
+    })
+
+    function plugin (instance, opts, done) {
+      done()
+    }
+
+    function plugin2 (instance, opts, done) {
+      done()
+    }
   })
 
-  plugin[Symbol.for('plugin-meta')] = {
-    name: 'plugin',
-    fastify: '^98.1.0'
-  }
-  plugin2[Symbol.for('plugin-meta')] = {
-    name: 'plugin2',
-    fastify: '98.x'
-  }
+  t.test('pre', t => {
+    t.plan(2)
 
-  fastify.register(plugin)
+    const fastify = Fastify()
+    Object.defineProperty(fastify, 'version', { value: '99.0.0-pre.1' })
 
-  fastify.ready((err) => {
-    t.error(err)
-    t.pass('everything right')
+    plugin[Symbol.for('plugin-meta')] = { name: 'plugin', fastify: '^98.x' }
+
+    fastify.register(plugin)
+
+    fastify.ready((err) => {
+      t.error(err)
+      t.pass()
+    })
+
+    function plugin (instance, opts, done) { done() }
   })
 
-  function plugin (instance, opts, done) {
-    done()
-  }
+  t.test('alpha', t => {
+    t.plan(2)
 
-  function plugin2 (instance, opts, done) {
-    done()
-  }
+    const fastify = Fastify()
+    Object.defineProperty(fastify, 'version', { value: '99.0.0-pre.1' })
+
+    plugin[Symbol.for('plugin-meta')] = { name: 'plugin', fastify: '^98.x' }
+
+    fastify.register(plugin)
+
+    fastify.ready((err) => {
+      t.error(err)
+      t.pass()
+    })
+
+    function plugin (instance, opts, done) { done() }
+  })
 })
 
 test('hasPlugin method exists as a function', t => {
@@ -415,49 +456,44 @@ test('hasPlugin returns true when using encapsulation', async t => {
   await fastify.ready()
 })
 
-test('registering plugins with mixed style should return a warning', async t => {
-  t.plan(12)
-
-  const pluginNames = ['error-plugin', 'anonymous', 'anotherPlugin', 'anotherPluginNamed']
-
-  const oldWarnings = process.listeners('warning')
-  process.removeAllListeners('warning')
-  process.on('warning', onWarning)
-  function onWarning (warning) {
-    t.match(warning.message, new RegExp(`.*${pluginNames.shift()} plugin being registered mixes async and callback styles.*`))
-    t.equal(warning.name, 'FastifyWarning')
-    t.equal(warning.code, 'FSTWRN002')
-  }
-  t.teardown(() => {
-    process.removeListener('warning', onWarning)
-    for (const warning of oldWarnings) {
-      process.on('warning', warning)
-    }
-  })
+test('registering anonymous plugin with mixed style should throw', async t => {
+  t.plan(2)
 
   const fastify = Fastify()
 
-  const pluginName = 'error-plugin'
-  const errorPlugin = async (app, opts, done) => {
+  const anonymousPlugin = async (app, opts, done) => {
     done()
   }
 
-  const namedPlugin = fp(errorPlugin, { name: pluginName })
+  fastify.register(anonymousPlugin)
 
-  async function anotherPlugin (app, opts, done) {
-    done()
+  try {
+    await fastify.ready()
+    t.fail('should throw')
+  } catch (error) {
+    t.type(error, FST_ERR_PLUGIN_INVALID_ASYNC_HANDLER)
+    t.equal(error.message, 'The anonymousPlugin plugin being registered mixes async and callback styles. Async plugin should not mix async and callback style.')
   }
+})
+
+test('registering named plugin with mixed style should throw', async t => {
+  t.plan(2)
+
+  const fastify = Fastify()
 
-  const anotherPluginNamed = async function (app, opts, done) {
+  const pluginName = 'error-plugin'
+  const errorPlugin = async (app, opts, done) => {
     done()
   }
+  const namedPlugin = fp(errorPlugin, { name: pluginName })
 
   fastify.register(namedPlugin)
-  fastify.register(async (app, opts, done) => {
-    done()
-  })
-  fastify.register(anotherPlugin)
-  fastify.register(anotherPluginNamed)
 
-  await fastify.ready()
+  try {
+    await fastify.ready()
+    t.fail('should throw')
+  } catch (error) {
+    t.type(error, FST_ERR_PLUGIN_INVALID_ASYNC_HANDLER)
+    t.equal(error.message, 'The error-plugin plugin being registered mixes async and callback styles. Async plugin should not mix async and callback style.')
+  }
 })

package/test/register.test.js

@@ -1,7 +1,5 @@
 'use strict'
 
-/* eslint no-prototype-builtins: 0 */
-
 const t = require('tap')
 const test = t.test
 const sget = require('simple-get').concat
@@ -14,7 +12,7 @@ test('register', t => {
 
   fastify.register(function (instance, opts, done) {
     t.not(instance, fastify)
-    t.ok(fastify.isPrototypeOf(instance))
+    t.ok(Object.prototype.isPrototypeOf.call(fastify, instance))
 
     t.equal(typeof opts, 'object')
     t.equal(typeof done, 'function')
@@ -27,7 +25,7 @@ test('register', t => {
 
   fastify.register(function (instance, opts, done) {
     t.not(instance, fastify)
-    t.ok(fastify.isPrototypeOf(instance))
+    t.ok(Object.prototype.isPrototypeOf.call(fastify, instance))
 
     t.equal(typeof opts, 'object')
     t.equal(typeof done, 'function')

package/test/reply-earlyHints.test.js

@@ -0,0 +1,98 @@
+'use strict'
+
+const Fastify = require('..')
+const { test } = require('tap')
+const http = require('http')
+const http2 = require('http2')
+
+const testResBody = 'Hello, world!'
+
+test('sends early hints', (t) => {
+  t.plan(6)
+
+  const fastify = Fastify({
+    logger: false
+  })
+
+  fastify.get('/', async (request, reply) => {
+    reply.writeEarlyHints({
+      link: '</styles.css>; rel=preload; as=style'
+    }, () => {
+      t.pass('callback called')
+    })
+
+    return testResBody
+  })
+
+  fastify.listen({ port: 0 }, (err, address) => {
+    t.error(err)
+
+    const req = http.get(address)
+
+    req.on('information', (res) => {
+      t.equal(res.statusCode, 103)
+      t.equal(res.headers.link, '</styles.css>; rel=preload; as=style')
+    })
+
+    req.on('response', (res) => {
+      t.equal(res.statusCode, 200)
+
+      let data = ''
+      res.on('data', (chunk) => {
+        data += chunk
+      })
+
+      res.on('end', () => {
+        t.equal(data, testResBody)
+        fastify.close(t.end)
+      })
+    })
+  })
+})
+
+test('sends early hints (http2)', (t) => {
+  t.plan(6)
+
+  const fastify = Fastify({
+    http2: true,
+    logger: false
+  })
+
+  fastify.get('/', async (request, reply) => {
+    reply.writeEarlyHints({
+      link: '</styles.css>; rel=preload; as=style'
+    })
+
+    return testResBody
+  })
+
+  fastify.listen({ port: 0 }, (err, address) => {
+    t.error(err)
+
+    const client = http2.connect(address)
+    const req = client.request()
+
+    req.on('headers', (headers) => {
+      t.not(headers, undefined)
+      t.equal(headers[':status'], 103)
+      t.equal(headers.link, '</styles.css>; rel=preload; as=style')
+    })
+
+    req.on('response', (headers) => {
+      t.equal(headers[':status'], 200)
+    })
+
+    let data = ''
+    req.on('data', (chunk) => {
+      data += chunk
+    })
+
+    req.on('end', () => {
+      t.equal(data, testResBody)
+      client.close()
+      fastify.close(t.end)
+    })
+
+    req.end()
+  })
+})

package/test/reply-error.test.js

@@ -603,7 +603,6 @@ test('error handler is triggered when a string is thrown from sync handler', t =
   const payload = 'error'
 
   fastify.get('/', function (req, reply) {
-    // eslint-disable-next-line no-throw-literal
     throw throwable
   })
 
@@ -666,7 +665,6 @@ test('should trigger error handlers if a sync route throws any non-error object'
   const payload = 'error'
 
   fastify.get('/', function async (req, reply) {
-    // eslint-disable-next-line no-throw-literal
     throw throwable
   })
 

package/test/route-hooks.test.js

@@ -255,7 +255,6 @@ function testBeforeHandlerHook (hook) {
 
     fastify.get('/', {
       [hook]: async () => {
-        // eslint-disable-next-line no-throw-literal
         throw myError
       }
     }, (req, reply) => {