Decorators

The decorators API allows customization of the core Fastify objects, such as the server instance itself and any request and reply objects used during the HTTP request lifecycle. The decorators API can be used to attach any type of property to the core objects, e.g. functions, plain objects, or native types.

This API is synchronous. Attempting to define a decoration asynchronously could result in the Fastify instance booting before the decoration completes its initialization. To avoid this issue, and register an asynchronous decoration, the register API, in combination with fastify-plugin, must be used instead. To learn more, see the Plugins documentation.

Decorating core objects with this API allows the underlying JavaScript engine to optimize the handling of server, request, and reply objects. This is accomplished by defining the shape of all such object instances before they are instantiated and used. As an example, the following is not recommended because it will change the shape of objects during their lifecycle:

  1. // Bad example! Continue reading.
  3. // Attach a user property to the incoming request before the request
  4. // handler is invoked.
  5. fastify.addHook('preHandler', function (req, reply, done) {
  6.   req.user = 'Bob Dylan'
  7.   done()
  8. })
  10. // Use the attached user property in the request handler.
  11. fastify.get('/', function (req, reply) {
  12.   reply.send(`Hello, ${req.user}`)
  13. })

Since the above example mutates the request object after it has already been instantiated, the JavaScript engine must deoptimize access to the request object. By using the decoration API this deoptimization is avoided:

  1. // Decorate request with a 'user' property
  2. fastify.decorateRequest('user', '')
  4. // Update our property
  5. fastify.addHook('preHandler', (req, reply, done) => {
  6.   req.user = 'Bob Dylan'
  7.   done()
  8. })
  9. // And finally access it
  10. fastify.get('/', (req, reply) => {
  11.   reply.send(`Hello, ${req.user}!`)
  12. })

Note that it is important to keep the initial shape of a decorated field as close as possible to the value intended to be set dynamically in the future. Initialize a decorator as a '' if the intended value is a string, and as null if it will be an object or a function.

Remember this example works only with value types as reference types will be shared amongst all requests. See decorateRequest.

See JavaScript engine fundamentals: Shapes and Inline Caches for more information on this topic.

Usage

decorate(name, value, [dependencies])

This method is used to customize the Fastify server instance.

For example, to attach a new method to the server instance:

  1. fastify.decorate('utility', function () {
  2.   // Something very useful
  3. })

As mentioned above, non-function values can be attached:

  1. fastify.decorate('conf', {
  2.   db: 'some.db',
  3.   port: 3000
  4. })

To access decorated properties, use the name provided to the decoration API:

  1. fastify.utility()
  3. console.log(fastify.conf.db)

The decorated Fastify server is bound to this in route route handlers:

  1. fastify.decorate('db', new DbConnection())
  3. fastify.get('/', async function (request, reply) {
  4.   reply({hello: await this.db.query('world')})
  5. })

The dependencies parameter is an optional list of decorators that the decorator being defined relies upon. This list is simply a list of string names of other decorators. In the following example, the “utility” decorator depends upon “greet” and “log” decorators:

  1. fastify.decorate('utility', fn, ['greet', 'log'])

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

If a dependency is not satisfied, the decorate method will throw an exception. The dependency check is performed before the server instance is booted. Thus, it cannot occur during runtime.

decorateReply(name, value, [dependencies])

As the name suggests, this API is used to add new methods/properties to the core Reply object:

  1. fastify.decorateReply('utility', function () {
  2.   // Something very useful
  3. })

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

Note: using decorateReply will emit a warning if used with a reference type:

  1. // Don't do this
  2. fastify.decorateReply('foo', { bar: 'fizz'})

In this example, the reference of the object is shared with all the requests: any mutation will impact all requests, potentially creating security vulnerabilities or memory leaks. To achieve proper encapsulation across requests configure a new value for each incoming request in the ‘onRequest’ hook. Example:

  1. const fp = require('fastify-plugin')
  3. async function myPlugin (app) {
  4.   app.decorateRequest('foo', null)
  5.   app.addHook('onRequest', async (req, reply) => {
  6.     req.foo = { bar: 42 }
  7.   }) 
  8. }
  10. module.exports = fp(myPlugin)

See decorate for information about the dependencies parameter.

decorateRequest(name, value, [dependencies])

As above with decorateReply, this API is used add new methods/properties to the core Request object:

  1. fastify.decorateRequest('utility', function () {
  2.   // something very useful
  3. })

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

Note: using decorateRequest will emit a warning if used with a reference type:

  1. // Don't do this
  2. fastify.decorateRequest('foo', { bar: 'fizz'})

In this example, the reference of the object is shared with all the requests: any mutation will impact all requests, potentially creating security vulnerabilities or memory leaks.

To achieve proper encapsulation across requests configure a new value for each incoming request in the ‘onRequest’ hook. Example:

  1. const fp = require('fastify-plugin')
  3. async function myPlugin (app) {
  4.   app.decorateRequest('foo', null)
  5.   app.addHook('onRequest', async (req, reply) => {
  6.     req.foo = { bar: 42 }
  7.   }) 
  8. }
  10. module.exports = fp(myPlugin)

See decorate for information about the dependencies parameter.

hasDecorator(name)

Used to check for the existence of a server instance decoration:

  1. fastify.hasDecorator('utility')

hasRequestDecorator

Used to check for the existence of a Request decoration:

  1. fastify.hasRequestDecorator('utility')

hasReplyDecorator

Used to check for the existence of a Reply decoration:

  1. fastify.hasReplyDecorator('utility')

Decorators and Encapsulation

Defining a decorator (using decorate, decorateRequest, or decorateReply) with the same name more than once in the same encapsulated context will throw an exception.

As an example, the following will throw:

  1. const server = require('fastify')()
  3. server.decorateReply('view', function (template, args) {
  4.   // Amazing view rendering engine
  5. })
  7. server.get('/', (req, reply) => {
  8.   reply.view('/index.html', { hello: 'world' })
  9. })
  11. // Somewhere else in our codebase, we define another
  12. // view decorator. This throws.
  13. server.decorateReply('view', function (template, args) {
  14.   // Another rendering engine
  15. })
  17. server.listen(3000)

But this will not:

  1. const server = require('fastify')()
  3. server.decorateReply('view', function (template, args) {
  4.   // Amazing view rendering engine.
  5. })
  7. server.register(async function (server, opts) {
  8.   // We add a view decorator to the current encapsulated
  9.   // plugin. This will not throw as outside of this encapsulated
  10.   // plugin view is the old one, while inside it is the new one.
  11.   server.decorateReply('view', function (template, args) {
  12.     // Another rendering engine
  13.   })
  15.   server.get('/', (req, reply) => {
  16.     reply.view('/index.page', { hello: 'world' })
  17.   })
  18. }, { prefix: '/bar' })
  20. server.listen(3000)

Getters and Setters

Decorators accept special “getter/setter” objects. These objects have functions named getter and setter (though the setter function is optional). This allows defining properties via decorators, for example:

  1. fastify.decorate('foo', {
  2.   getter () {
  3.     return 'a getter'
  4.   }
  5. })

Will define the foo property on the Fastify instance:

  1. console.log(fastify.foo) // 'a getter'