Hooks

Hooks are registered with the fastify.addHook method and allow you to listen to specific events in the application or request/response lifecycle. You have to register a hook before the event is triggered otherwise the event is lost.

Request/Response Hooks

By using the hooks you can interact directly inside the lifecycle of Fastify. There are seven different Hooks that you can use (in order of execution):

  • 'onRequest'
  • 'preParsing'
  • 'preValidation'
  • 'preHandler'
  • 'preSerialization'
  • 'onError'
  • 'onSend'
  • 'onResponse'Example:
  1. fastify.addHook('onRequest', (request, reply, done) => {
  2.   // some code
  3.   done()
  4. })
  6. fastify.addHook('preParsing', (request, reply, done) => {
  7.   // some code
  8.   done()
  9. })
  11. fastify.addHook('preValidation', (request, reply, done) => {
  12.   // some code
  13.   done()
  14. })
  16. fastify.addHook('preHandler', (request, reply, done) => {
  17.   // some code
  18.   done()
  19. })
  21. fastify.addHook('preSerialization', (request, reply, payload, done) => {
  22.   // some code
  23.   done()
  24. })
  26. fastify.addHook('onError', (request, reply, error, done) => {
  27.   // some code
  28.   done()
  29. })
  31. fastify.addHook('onSend', (request, reply, payload, done) => {
  32.   // some code
  33.   done()
  34. })
  36. fastify.addHook('onResponse', (request, reply, done) => {
  37.   // some code
  38.   done()
  39. })

Or async/await

  1. fastify.addHook('onRequest', async (request, reply) => {
  2.   // some code
  3.   await asyncMethod()
  4.   // error occurred
  5.   if (err) {
  6.     throw new Error('some errors occurred.')
  7.   }
  8.   return
  9. })
  11. fastify.addHook('preParsing', async (request, reply) => {
  12.   // some code
  13.   await asyncMethod()
  14.   // error occurred
  15.   if (err) {
  16.     throw new Error('some errors occurred.')
  17.   }
  18.   return
  19. })
  21. fastify.addHook('preValidation', async (request, reply) => {
  22.   // some code
  23.   await asyncMethod()
  24.   // error occurred
  25.   if (err) {
  26.     throw new Error('some errors occurred.')
  27.   }
  28.   return
  29. })
  31. fastify.addHook('preHandler', async (request, reply) => {
  32.   // some code
  33.   await asyncMethod()
  34.   // error occurred
  35.   if (err) {
  36.     throw new Error('some errors occurred.')
  37.   }
  38.   return
  39. })
  41. fastify.addHook('preSerialization', async (request, reply, payload) => {
  42.   // some code
  43.   await asyncMethod()
  44.   // error occurred
  45.   if (err) {
  46.     throw new Error('some errors occurred.')
  47.   }
  48.   return payload
  49. })
  51. fastify.addHook('onError', async (request, reply, error) => {
  52.   // useful for custom error logging
  53.   // you should not use this hook to update the error
  54. })
  56. fastify.addHook('onSend', async (request, reply, payload) => {
  57.   // some code
  58.   await asyncMethod()
  59.   // error occurred
  60.   if (err) {
  61.     throw new Error('some errors occurred.')
  62.   }
  63.   return
  64. })
  66. fastify.addHook('onResponse', async (request, reply) => {
  67.   // some code
  68.   await asyncMethod()
  69.   // error occurred
  70.   if (err) {
  71.     throw new Error('some errors occurred.')
  72.   }
  73.   return
  74. })

Notice: the done callback is not available when using async/await or returning a Promise. If you do invoke a done callback in this situation unexpected behavior may occur, e.g. duplicate invocation of handlers.

Notice: in the onRequest and preValidation hooks, request.body will always be null, because the body parsing happens before the preHandler hook.

Request and Reply are the core Fastify objects.done is the function to continue with the lifecycle.

It is pretty easy to understand where each hook is executed by looking at the lifecycle page.Hooks are affected by Fastify's encapsulation, and can thus be applied to selected routes. See the Scopes section for more information.

If you get an error during the execution of your hook, just pass it to done() and Fastify will automatically close the request and send the appropriate error code to the user.

  1. fastify.addHook('onRequest', (request, reply, done) => {
  2.   done(new Error('some error'))
  3. })

If you want to pass a custom error code to the user, just use reply.code():

  1. fastify.addHook('preHandler', (request, reply, done) => {
  2.   reply.code(400)
  3.   done(new Error('some error'))
  4. })

The error will be handled by Reply.

The onError Hook

This hook is useful if you need to do some custom error logging or add some specific header in case of error.It is not intended for changing the error, and calling reply.send will throw an exception.This hook will be executed only after the customErrorHandler has been executed, and only if the customErrorHandler sends back an error to the user (Note that the default customErrorHandler always send back the error to the user).Notice: unlike the other hooks, pass an error to the done function is not supported.

  1. fastify.addHook('onError', (request, reply, error, done) => {
  2.   // apm stands for Application Performance Monitoring
  3.   apm.sendError(error)
  4.   done()
  5. })
  7. // Or async
  8. fastify.addHook('onError', async (request, reply, error) => {
  9.   // apm stands for Application Performance Monitoring
  10.   apm.sendError(error)
  11. })

The preSerialization Hook

If you are using the preSerialization hook, you can change (or replace) the payload before it is serialized. For example:

  1. fastify.addHook('preSerialization', (request, reply, payload, done) => {
  2.   var err = null;
  3.   var newPayload = {wrapped: payload }
  4.   done(err, newPayload)
  5. })
  7. // Or async
  8. fastify.addHook('preSerialization', async (request, reply, payload) => {
  9.   return {wrapped: payload }
  10. })

Note: the hook is NOT called if the payload is a string, a Buffer, a stream, or null.

The onSend Hook

If you are using the onSend hook, you can change the payload. For example:

  1. fastify.addHook('onSend', (request, reply, payload, done) => {
  2.   var err = null;
  3.   var newPayload = payload.replace('some-text', 'some-new-text')
  4.   done(err, newPayload)
  5. })
  7. // Or async
  8. fastify.addHook('onSend', async (request, reply, payload) => {
  9.   var newPayload = payload.replace('some-text', 'some-new-text')
  10.   return newPayload
  11. })

You can also clear the payload to send a response with an empty body by replacing the payload with null:

  1. fastify.addHook('onSend', (request, reply, payload, done) => {
  2.   reply.code(304)
  3.   const newPayload = null
  4.   done(null, newPayload)
  5. })

You can also send an empty body by replacing the payload with the empty string '', but be aware that this will cause the Content-Length header to be set to 0, whereas the Content-Length header will not be set if the payload is null.

Note: If you change the payload, you may only change it to a string, a Buffer, a stream, or null.

The onResponse Hook

The onResponse hook is executed when a response has been sent, so you will not be able to send more data to the client, however you can use this hook to send some data to an external service or elaborate some statistics.

Respond to a request from a hook

If needed, you can respond to a request before you reach the route handler. An example could be an authentication hook. If you are using onRequest or preHandler use reply.send; if you are using a middleware, res.end.

  1. fastify.addHook('onRequest', (request, reply, done) => {
  2.   reply.send('early response')
  3. })
  5. // Works with async functions too
  6. fastify.addHook('preHandler', async (request, reply) => {
  7.   reply.send({ hello: 'world' })
  8. })

If you want to respond with a stream, you should avoid using an async function for the hook. If you must use an async function, your code will need to follow the pattern in test/hooks-async.js.

  1. fastify.addHook('onRequest', (request, reply, done) => {
  2.   const stream = fs.createReadStream('some-file', 'utf8')
  3.   reply.send(stream)
  4. })

Application Hooks

You are able to hook into the application-lifecycle as well. It's important to note that these hooks aren't fully encapsulated. The this inside the hooks are encapsulated but the handlers can respond to an event outside the encapsulation boundaries.

  • 'onClose'
  • 'onRoute'
  • 'onRegister''onClose'Triggered when fastify.close() is invoked to stop the server. It is useful when plugins need a "shutdown" event, such as a connection to a database.The first argument is the Fastify instance, the second one the done callback.
  1. fastify.addHook('onClose', (instance, done) => {
  2.   // some code
  3.   done()
  4. })

'onRoute'Triggered when a new route is registered. Listeners are passed a routeOptions object as the sole parameter. The interface is synchronous, and, as such, the listeners do not get passed a callback.

  1. fastify.addHook('onRoute', (routeOptions) => {
  2.   // some code
  3.   routeOptions.method
  4.   routeOptions.schema
  5.   routeOptions.url
  6.   routeOptions.bodyLimit
  7.   routeOptions.logLevel
  8.   routeOptions.prefix
  9. })

'onRegister'Triggered when a new plugin function is registered, and a new encapsulation context is created, the hook will be executed before the plugin code.This hook can be useful if you are developing a plugin that needs to know when a plugin context is formed, and you want to operate in that specific context.Note: This hook will not be called if a plugin is wrapped inside fastify-plugin.

  1. fastify.decorate('data', [])
  3. fastify.register(async (instance, opts) => {
  4.   instance.data.push('hello')
  5.   console.log(instance.data) // ['hello']
  7.   instance.register(async (instance, opts) => {
  8.     instance.data.push('world')
  9.     console.log(instance.data) // ['hello', 'world']
  10.   })
  11. })
  13. fastify.register(async (instance, opts) => {
  14.   console.log(instance.data) // []
  15. })
  17. fastify.addHook('onRegister', (instance) => {
  18.   // create a new array from the old one
  19.   // but without keeping the reference
  20.   // allowing the user to have encapsulated
  21.   // instances of the `data` property
  22.   instance.data = instance.data.slice()
  23. })

Scope

Except for Application Hooks, all hooks are encapsulated. This means that you can decide where your hooks should run by using register as explained in the plugins guide. If you pass a function, that function is bound to the right Fastify context and from there you have full access to the Fastify API.

  1. fastify.addHook('onRequest', function (request, reply, done) {
  2.   const self = this // Fastify context
  3.   done()
  4. })

Note: using an arrow function will break the binding of this to the Fastify instance.

Route level hooks

You can declare one or more custom onRequest, preParsing, preValidation, preHandler and preSerialization hook(s) that will be unique for the route. If you do so, those hooks always be executed as last hook in their category.This can be useful if you need to run the authentication, and the preParsing or preValidation hooks are exactly what you need for doing that. Multiple route-level hooks can also be specified as an array.

Let's make an example:

  1. fastify.addHook('onRequest', (request, reply, done) => {
  2.   // your code
  3.   done()
  4. })
  6. fastify.addHook('preParsing', (request, reply, done) => {
  7.   // your code
  8.   done()
  9. })
  11. fastify.addHook('preValidation', (request, reply, done) => {
  12.   // your code
  13.   done()
  14. })
  16. fastify.addHook('preHandler', (request, reply, done) => {
  17.   // your code
  18.   done()
  19. })
  21. fastify.addHook('preSerialization', (request, reply, payload, done) => {
  22.   // your code
  23.   done()
  24. })
  26. fastify.route({
  27.   method: 'GET',
  28.   url: '/',
  29.   schema: { ... },
  30.   onRequest: function (request, reply, done) {
  31.     // this hook will always be executed after the shared `onRequest` hooks
  32.     done()
  33.   },
  34.   preParsing: function (request, reply, done) {
  35.     // this hook will always be executed after the shared `preParsing` hooks
  36.     done()
  37.   },
  38.   preValidation: function (request, reply, done) {
  39.     // this hook will always be executed after the shared `preValidation` hooks
  40.     done()
  41.   },
  42.   preHandler: function (request, reply, done) {
  43.     // this hook will always be executed after the shared `preHandler` hooks
  44.     done()
  45.   },
  46.   // // Example with an array. All hooks support this syntax.
  47.   //
  48.   // preHandler: [function (request, reply, done) {
  49.   //   // this hook will always be executed after the shared `preHandler` hooks
  50.   //   done()
  51.   // }],
  52.   preSerialization: (request, reply, payload, done) => {
  53.     // manipulate the payload
  54.     done(null, payload)
  55.   },
  56.   handler: function (request, reply) {
  57.     reply.send({ hello: 'world' })
  58.   }
  59. })

Note: both options also accept an array of functions.