Lifecycle

Following the schema of the internal lifecycle of Fastify.
On the right branch of every section there is the next phase of the lifecycle, on the left branch there is the corresponding error code that will be generated if the parent throws an error (note that all the errors are automatically handled by Fastify).

  1. Incoming Request
  2.   │
  3.   └─▶ Routing
  4.         │
  5.         └─▶ Instance Logger
  6.              │
  7.    4**/5** ◀─┴─▶ onRequest Hook
  8.                   │
  9.         4**/5** ◀─┴─▶ preParsing Hook
  10.                         │
  11.               4**/5** ◀─┴─▶ Parsing
  12.                              │
  13.                    4**/5** ◀─┴─▶ preValidation Hook
  14.                                   │
  15.                             415 ◀─┴─▶ Validation
  16.                                         │
  17.                               4**/5** ◀─┴─▶ preHandler Hook
  18.                                               │
  19.                                     4**/5** ◀─┴─▶ User Handler
  20.                                                     │
  21.                                                     └─▶ Reply
  22.                                                           │
  23.                                                 4**/5** ◀─┴─▶ preSerialization Hook
  24.                                                                 │
  25.                                                                 └─▶ onSend Hook
  26.                                                                       │
  27.                                                             4**/5** ◀─┴─▶ Outgoing Response
  28.                                                                             │
  29.                                                                             └─▶ onResponse Hook

At any point before or during the User Handler, reply.hijack() can be called to prevent fastify from:

  • Running all the following hooks and user handler
  • Sending the response automatically

NB (*): If reply.raw is used to send a response back to the user, onResponse hooks will still be executed

Reply Lifecycle

Whenever the user handles the request the result may be:

  • in async handler: it returns a payload
  • in async handler: it throws an Error
  • in sync handler: it sends a payload
  • in sync handler: it sends an Error instance

If the reply was hijacked, we skip all the below steps. Otherwise, when it is being submitted, the data flow performed is the following:

  1.                         ★ schema validation Error
  2.                                     │
  3.                                     └─▶ schemaErrorFormatter
  4.                                                │
  5.                           reply sent ◀── JSON ─┴─ Error instance
  6.                                                       │
  7.                                                       │         ★ throw an Error
  8.                      ★ send or return                 │                 │
  9.                             │                         │                 │
  10.                             │                         ▼                 │
  11.        reply sent ◀── JSON ─┴─ Error instance ──▶ setErrorHandler ◀─────┘
  12.                                                       │
  13.                                  reply sent ◀── JSON ─┴─ Error instance ──▶ onError Hook
  14.                                                                                 │
  15.                                                                                 └─▶ reply sent

Note: reply sent means that the JSON payload will be serialized by: