fastify 4.23.2 → 4.24.1

package/test/plugin.3.test.js

@@ -0,0 +1,311 @@
+'use strict'
+
+/* eslint no-prototype-builtins: 0 */
+
+const t = require('tap')
+const test = t.test
+const Fastify = require('../fastify')
+const sget = require('simple-get').concat
+const fp = require('fastify-plugin')
+
+test('if a plugin raises an error and there is not a callback to handle it, the server must not start', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  fastify.register((instance, opts, done) => {
+    done(new Error('err'))
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.ok(err instanceof Error)
+    t.equal(err.message, 'err')
+  })
+})
+
+test('add hooks after route declaration', t => {
+  t.plan(3)
+  const fastify = Fastify()
+
+  function plugin (instance, opts, done) {
+    instance.decorateRequest('check', null)
+    instance.addHook('onRequest', (req, reply, done) => {
+      req.check = {}
+      done()
+    })
+    setImmediate(done)
+  }
+  fastify.register(fp(plugin))
+
+  fastify.register((instance, options, done) => {
+    instance.addHook('preHandler', function b (req, res, done) {
+      req.check.hook2 = true
+      done()
+    })
+
+    instance.get('/', (req, reply) => {
+      reply.send(req.check)
+    })
+
+    instance.addHook('preHandler', function c (req, res, done) {
+      req.check.hook3 = true
+      done()
+    })
+
+    done()
+  })
+
+  fastify.addHook('preHandler', function a (req, res, done) {
+    req.check.hook1 = true
+    done()
+  })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    sget({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port
+    }, (err, response, body) => {
+      t.error(err)
+      t.same(JSON.parse(body), { hook1: true, hook2: true, hook3: true })
+      fastify.close()
+    })
+  })
+})
+
+test('nested plugins', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.register(function (fastify, opts, done) {
+    fastify.register((fastify, opts, done) => {
+      fastify.get('/', function (req, reply) {
+        reply.send('I am child 1')
+      })
+      done()
+    }, { prefix: '/child1' })
+
+    fastify.register((fastify, opts, done) => {
+      fastify.get('/', function (req, reply) {
+        reply.send('I am child 2')
+      })
+      done()
+    }, { prefix: '/child2' })
+
+    done()
+  }, { prefix: '/parent' })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    sget({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/parent/child1'
+    }, (err, response, body) => {
+      t.error(err)
+      t.same(body.toString(), 'I am child 1')
+    })
+
+    sget({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/parent/child2'
+    }, (err, response, body) => {
+      t.error(err)
+      t.same(body.toString(), 'I am child 2')
+    })
+  })
+})
+
+test('nested plugins awaited', t => {
+  t.plan(5)
+
+  const fastify = Fastify()
+
+  t.teardown(fastify.close.bind(fastify))
+
+  fastify.register(async function wrap (fastify, opts) {
+    await fastify.register(async function child1 (fastify, opts) {
+      fastify.get('/', function (req, reply) {
+        reply.send('I am child 1')
+      })
+    }, { prefix: '/child1' })
+
+    await fastify.register(async function child2 (fastify, opts) {
+      fastify.get('/', function (req, reply) {
+        reply.send('I am child 2')
+      })
+    }, { prefix: '/child2' })
+  }, { prefix: '/parent' })
+
+  fastify.listen({ port: 0 }, err => {
+    t.error(err)
+
+    sget({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/parent/child1'
+    }, (err, response, body) => {
+      t.error(err)
+      t.same(body.toString(), 'I am child 1')
+    })
+
+    sget({
+      method: 'GET',
+      url: 'http://localhost:' + fastify.server.address().port + '/parent/child2'
+    }, (err, response, body) => {
+      t.error(err)
+      t.same(body.toString(), 'I am child 2')
+    })
+  })
+})
+
+test('plugin metadata - decorators', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  fastify.decorate('plugin1', true)
+  fastify.decorateReply('plugin1', true)
+  fastify.decorateRequest('plugin1', true)
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    decorators: {
+      fastify: ['plugin1'],
+      reply: ['plugin1'],
+      request: ['plugin1']
+    }
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.ok(fastify.plugin)
+  })
+
+  function plugin (instance, opts, done) {
+    instance.decorate('plugin', true)
+    done()
+  }
+})
+
+test('plugin metadata - decorators - should throw', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  fastify.decorate('plugin1', true)
+  fastify.decorateReply('plugin1', true)
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    decorators: {
+      fastify: ['plugin1'],
+      reply: ['plugin1'],
+      request: ['plugin1']
+    }
+  }
+
+  fastify.register(plugin)
+  fastify.ready((err) => {
+    t.equal(err.message, "The decorator 'plugin1' is not present in Request")
+  })
+
+  function plugin (instance, opts, done) {
+    instance.decorate('plugin', true)
+    done()
+  }
+})
+
+test('plugin metadata - decorators - should throw with plugin name', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  fastify.decorate('plugin1', true)
+  fastify.decorateReply('plugin1', true)
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'the-plugin',
+    decorators: {
+      fastify: ['plugin1'],
+      reply: ['plugin1'],
+      request: ['plugin1']
+    }
+  }
+
+  fastify.register(plugin)
+  fastify.ready((err) => {
+    t.equal(err.message, "The decorator 'plugin1' required by 'the-plugin' is not present in Request")
+  })
+
+  function plugin (instance, opts, done) {
+    instance.decorate('plugin', true)
+    done()
+  }
+})
+
+test('plugin metadata - dependencies', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  dependency[Symbol.for('skip-override')] = true
+  dependency[Symbol.for('plugin-meta')] = {
+    name: 'plugin'
+  }
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    dependencies: ['plugin']
+  }
+
+  fastify.register(dependency)
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function dependency (instance, opts, done) {
+    done()
+  }
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - dependencies (nested)', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  dependency[Symbol.for('skip-override')] = true
+  dependency[Symbol.for('plugin-meta')] = {
+    name: 'plugin'
+  }
+
+  nested[Symbol.for('skip-override')] = true
+  nested[Symbol.for('plugin-meta')] = {
+    dependencies: ['plugin']
+  }
+
+  fastify.register(dependency)
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function dependency (instance, opts, done) {
+    done()
+  }
+
+  function plugin (instance, opts, done) {
+    instance.register(nested)
+    done()
+  }
+
+  function nested (instance, opts, done) {
+    done()
+  }
+})

package/test/plugin.4.test.js

@@ -0,0 +1,416 @@
+'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')
+
+test('pluginTimeout', t => {
+  t.plan(5)
+  const fastify = Fastify({
+    pluginTimeout: 10
+  })
+  fastify.register(function (app, opts, done) {
+    // to no call done on purpose
+  })
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'function (app, opts, done) { -- // to no call done on purpose'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
+  })
+})
+
+test('pluginTimeout - named function', t => {
+  t.plan(5)
+  const fastify = Fastify({
+    pluginTimeout: 10
+  })
+  fastify.register(function nameFunction (app, opts, done) {
+    // to no call done on purpose
+  })
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'nameFunction'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
+  })
+})
+
+test('pluginTimeout default', t => {
+  t.plan(5)
+  const clock = fakeTimer.install({ shouldClearNativeTimers: true })
+
+  const fastify = Fastify()
+  fastify.register(function (app, opts, done) {
+    // default time elapsed without calling done
+    clock.tick(10000)
+  })
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.message,
+      "fastify-plugin: Plugin did not start in time: 'function (app, opts, done) { -- // default time elapsed without calling done'. You may have forgotten to call 'done' function or to resolve a Promise")
+    t.equal(err.code, 'FST_ERR_PLUGIN_TIMEOUT')
+    t.ok(err.cause)
+    t.equal(err.cause.code, 'AVV_ERR_READY_TIMEOUT')
+  })
+
+  t.teardown(clock.uninstall)
+})
+
+test('plugin metadata - version', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '2.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - version range', t => {
+  t.plan(1)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '>=2.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready(() => {
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - version not matching requirement', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '99.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - version not matching requirement 2', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '<=3.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - version not matching requirement 3', t => {
+  t.plan(2)
+  const fastify = Fastify()
+
+  plugin[Symbol.for('skip-override')] = true
+  plugin[Symbol.for('plugin-meta')] = {
+    name: 'plugin',
+    fastify: '>=99.0.0'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.ok(err)
+    t.equal(err.code, 'FST_ERR_PLUGIN_VERSION_MISMATCH')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('plugin metadata - release candidate', 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: '99.x'
+  }
+
+  fastify.register(plugin)
+
+  fastify.ready((err) => {
+    t.error(err)
+    t.pass('everything right')
+  })
+
+  function plugin (instance, opts, done) {
+    done()
+  }
+})
+
+test('fastify-rc loads prior version plugins', 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()
+  }
+})
+
+test('hasPlugin method exists as a function', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+  t.equal(typeof fastify.hasPlugin, 'function')
+})
+
+test('hasPlugin returns true if the specified plugin has been registered', async t => {
+  t.plan(4)
+
+  const fastify = Fastify()
+
+  function pluginA (fastify, opts, done) {
+    t.ok(fastify.hasPlugin('plugin-A'))
+    done()
+  }
+  pluginA[Symbol.for('fastify.display-name')] = 'plugin-A'
+  fastify.register(pluginA)
+
+  fastify.register(function pluginB (fastify, opts, done) {
+    t.ok(fastify.hasPlugin('pluginB'))
+    done()
+  })
+
+  fastify.register(function (fastify, opts, done) {
+    // one line
+    t.ok(fastify.hasPlugin('function (fastify, opts, done) { -- // one line'))
+    done()
+  })
+
+  await fastify.ready()
+
+  t.ok(fastify.hasPlugin('fastify'))
+})
+
+test('hasPlugin returns false if the specified plugin has not been registered', t => {
+  t.plan(1)
+
+  const fastify = Fastify()
+  t.notOk(fastify.hasPlugin('pluginFoo'))
+})
+
+test('hasPlugin returns false when using encapsulation', async t => {
+  t.plan(25)
+
+  const fastify = Fastify()
+
+  fastify.register(function pluginA (fastify, opts, done) {
+    t.ok(fastify.hasPlugin('pluginA'))
+    t.notOk(fastify.hasPlugin('pluginAA'))
+    t.notOk(fastify.hasPlugin('pluginAAA'))
+    t.notOk(fastify.hasPlugin('pluginAB'))
+    t.notOk(fastify.hasPlugin('pluginB'))
+
+    fastify.register(function pluginAA (fastify, opts, done) {
+      t.notOk(fastify.hasPlugin('pluginA'))
+      t.ok(fastify.hasPlugin('pluginAA'))
+      t.notOk(fastify.hasPlugin('pluginAAA'))
+      t.notOk(fastify.hasPlugin('pluginAB'))
+      t.notOk(fastify.hasPlugin('pluginB'))
+
+      fastify.register(function pluginAAA (fastify, opts, done) {
+        t.notOk(fastify.hasPlugin('pluginA'))
+        t.notOk(fastify.hasPlugin('pluginAA'))
+        t.ok(fastify.hasPlugin('pluginAAA'))
+        t.notOk(fastify.hasPlugin('pluginAB'))
+        t.notOk(fastify.hasPlugin('pluginB'))
+
+        done()
+      })
+
+      done()
+    })
+
+    fastify.register(function pluginAB (fastify, opts, done) {
+      t.notOk(fastify.hasPlugin('pluginA'))
+      t.notOk(fastify.hasPlugin('pluginAA'))
+      t.notOk(fastify.hasPlugin('pluginAAA'))
+      t.ok(fastify.hasPlugin('pluginAB'))
+      t.notOk(fastify.hasPlugin('pluginB'))
+
+      done()
+    })
+
+    done()
+  })
+
+  fastify.register(function pluginB (fastify, opts, done) {
+    t.notOk(fastify.hasPlugin('pluginA'))
+    t.notOk(fastify.hasPlugin('pluginAA'))
+    t.notOk(fastify.hasPlugin('pluginAAA'))
+    t.notOk(fastify.hasPlugin('pluginAB'))
+    t.ok(fastify.hasPlugin('pluginB'))
+
+    done()
+  })
+
+  await fastify.ready()
+})
+
+test('hasPlugin returns true when using no encapsulation', async t => {
+  t.plan(26)
+
+  const fastify = Fastify()
+
+  fastify.register(fp((fastify, opts, done) => {
+    t.equal(fastify.pluginName, 'fastify -> plugin-AA')
+    t.ok(fastify.hasPlugin('plugin-AA'))
+    t.notOk(fastify.hasPlugin('plugin-A'))
+    t.notOk(fastify.hasPlugin('plugin-AAA'))
+    t.notOk(fastify.hasPlugin('plugin-AB'))
+    t.notOk(fastify.hasPlugin('plugin-B'))
+
+    fastify.register(fp((fastify, opts, done) => {
+      t.ok(fastify.hasPlugin('plugin-AA'))
+      t.ok(fastify.hasPlugin('plugin-A'))
+      t.notOk(fastify.hasPlugin('plugin-AAA'))
+      t.notOk(fastify.hasPlugin('plugin-AB'))
+      t.notOk(fastify.hasPlugin('plugin-B'))
+
+      fastify.register(fp((fastify, opts, done) => {
+        t.ok(fastify.hasPlugin('plugin-AA'))
+        t.ok(fastify.hasPlugin('plugin-A'))
+        t.ok(fastify.hasPlugin('plugin-AAA'))
+        t.notOk(fastify.hasPlugin('plugin-AB'))
+        t.notOk(fastify.hasPlugin('plugin-B'))
+
+        done()
+      }, { name: 'plugin-AAA' }))
+
+      done()
+    }, { name: 'plugin-A' }))
+
+    fastify.register(fp((fastify, opts, done) => {
+      t.ok(fastify.hasPlugin('plugin-AA'))
+      t.ok(fastify.hasPlugin('plugin-A'))
+      t.ok(fastify.hasPlugin('plugin-AAA'))
+      t.ok(fastify.hasPlugin('plugin-AB'))
+      t.notOk(fastify.hasPlugin('plugin-B'))
+
+      done()
+    }, { name: 'plugin-AB' }))
+
+    done()
+  }, { name: 'plugin-AA' }))
+
+  fastify.register(fp((fastify, opts, done) => {
+    t.ok(fastify.hasPlugin('plugin-AA'))
+    t.ok(fastify.hasPlugin('plugin-A'))
+    t.ok(fastify.hasPlugin('plugin-AAA'))
+    t.ok(fastify.hasPlugin('plugin-AB'))
+    t.ok(fastify.hasPlugin('plugin-B'))
+
+    done()
+  }, { name: 'plugin-B' }))
+
+  await fastify.ready()
+})
+
+test('hasPlugin returns true when using encapsulation', async t => {
+  t.plan(2)
+
+  const fastify = Fastify()
+
+  const pluginCallback = function (server, options, done) {
+    done()
+  }
+  const pluginName = 'awesome-plugin'
+  const plugin = fp(pluginCallback, { name: pluginName })
+
+  fastify.register(plugin)
+
+  fastify.register(async (server) => {
+    t.ok(server.hasPlugin(pluginName))
+  })
+
+  fastify.register(async function foo (server) {
+    server.register(async function bar (server) {
+      t.ok(server.hasPlugin(pluginName))
+    })
+  })
+
+  await fastify.ready()
+})