fastify#4521 Replace native errors with @fastify/errors (fastify#4554)

Author: alainrk

docs/Reference/Errors.md

@@ -133,7 +133,43 @@ fastify.listen({ port: 3000 }, function (err, address) {
 
 404 Not Found.
 
+#### FST_ERR_OPTIONS_NOT_OBJ
+<a id="FST_ERR_OPTIONS_NOT_OBJ"></a>
+
+Fastify options must be an object.
+
+#### FST_ERR_QSP_NOT_FN
+<a id="FST_ERR_QSP_NOT_FN"></a>
+
+QueryStringParser option should be a function.
+
+#### FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN
+<a id="FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN"></a>
+
+SchemaController.bucket option should be a function.
+
+#### FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN
+<a id="FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN"></a>
+
+SchemaErrorFormatter option should be a non async function.
+
+#### FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ
+<a id="FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ"></a>
+
+ajv.customOptions option should be an object.
+
+#### FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR
+<a id="FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR"></a>
+
+ajv.plugins option should be an array.
+
+#### FST_ERR_VERSION_CONSTRAINT_NOT_STR
+<a id="FST_ERR_VERSION_CONSTRAINT_NOT_STR"></a>
+
+Version constraint should be a string.
+
 <a name="FST_ERR_CTP_ALREADY_PRESENT"></a>
+
 #### FST_ERR_CTP_ALREADY_PRESENT
 <a id="FST_ERR_CTP_ALREADY_PRESENT"></a>
 
@@ -184,6 +220,16 @@ Request body size did not match `Content-Length`.
 
 Body cannot be empty when content-type is set to `application/json`.
 
+#### FST_ERR_CTP_INSTANCE_ALREADY_STARTED
+<a id="FST_ERR_CTP_INSTANCE_ALREADY_STARTED"></a>
+
+Fastify is already started.
+
+#### FST_ERR_INSTANCE_ALREADY_LISTENING
+<a id="FST_ERR_INSTANCE_ALREADY_LISTENING"></a>
+
+Fastify instance is already listening.
+
 #### FST_ERR_DEC_ALREADY_PRESENT
 <a id="FST_ERR_DEC_ALREADY_PRESENT"></a>
 
@@ -214,10 +260,15 @@ The hook name must be a string.
 
 The hook callback must be a function.
 
+#### FST_ERR_HOOK_NOT_SUPPORTED
+<a id="FST_ERR_HOOK_NOT_SUPPORTED"></a>
+
+The hook is not supported.
+
 #### FST_ERR_MISSING_MIDDLEWARE
 <a id="FST_ERR_MISSING_MIDDLEWARE"></a>
 
-You must register a plugin for handling middlewares, 
+You must register a plugin for handling middlewares,
 visit [`Middleware`](./Middleware.md) for more info.
 
 <a name="FST_ERR_HOOK_TIMEOUT"></a>
@@ -278,7 +329,7 @@ Missing serialization function.
 #### FST_ERR_REQ_INVALID_VALIDATION_INVOCATION
 <a id="FST_ERR_REQ_INVALID_VALIDATION_INVOCATION"></a>
 
-Invalid validation invocation. Missing validation function for 
+Invalid validation invocation. Missing validation function for
 HTTP part nor schema provided.
 
 #### FST_ERR_SCH_MISSING_ID
@@ -306,6 +357,11 @@ The JSON schema provided for validation to a route is not valid.
 
 The JSON schema provided for serialization of a route response is not valid.
 
+#### FST_ERR_SCH_RESPONSE_SCHEMA_NOT_NESTED_2XX
+<a id="FST_ERR_SCH_RESPONSE_SCHEMA_NOT_NESTED_2XX"></a>
+
+Response schemas should be nested under a valid status code (2XX).
+
 #### FST_ERR_HTTP2_INVALID_VERSION
 <a id="FST_ERR_HTTP2_INVALID_VERSION"></a>
 
@@ -319,7 +375,7 @@ Invalid initialization options.
 #### FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE
 <a id="FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE"></a>
 
-Cannot set forceCloseConnections to `idle` as your HTTP server 
+Cannot set forceCloseConnections to `idle` as your HTTP server
 does not support `closeIdleConnections` method.
 
 <a name="FST_ERR_DUPLICATED_ROUTE"></a>
@@ -347,6 +403,46 @@ The `defaultRoute` type should be a function.
 
 URL must be a string.
 
+#### FST_ERR_ROUTE_OPTIONS_NOT_OBJ
+<a id="FST_ERR_ROUTE_OPTIONS_NOT_OBJ"></a>
+
+Options for the route must be an object.
+
+#### FST_ERR_ROUTE_DUPLICATED_HANDLER
+<a id="FST_ERR_ROUTE_DUPLICATED_HANDLER"></a>
+
+Duplicate handler for the route is not allowed.
+
+#### FST_ERR_ROUTE_HANDLER_NOT_FN
+<a id="FST_ERR_ROUTE_HANDLER_NOT_FN"></a>
+
+Handler for the route must be a function.
+
+#### FST_ERR_ROUTE_MISSING_HANDLER
+<a id="FST_ERR_ROUTE_MISSING_HANDLER"></a>
+
+Missing handler function for the route.
+
+#### FST_ERR_ROUTE_METHOD_NOT_SUPPORTED
+<a id="FST_ERR_ROUTE_METHOD_NOT_SUPPORTED"></a>
+
+Method is not supported for the route.
+
+#### FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED
+<a id="FST_ERR_ROUTE_BODY_VALIDATION_SCHEMA_NOT_SUPPORTED"></a>
+
+Body validation schema route is not supported.
+
+#### FST_ERR_ROUTE_BODY_LIMIT_OPTION_NOT_INT
+<a id="FST_ERR_ROUTE_BODY_LIMIT_OPTION_NOT_INT"></a>
+
+BodyLimit option must be an integer.
+
+#### FST_ERR_ROUTE_REWRITE_NOT_STR
+<a id="FST_ERR_ROUTE_REWRITE_NOT_STR"></a>
+
+Rewrite url needs to be of type "string".
+
 #### FST_ERR_REOPENED_CLOSE_SERVER
 <a id="FST_ERR_REOPENED_CLOSE_SERVER"></a>
 
@@ -363,26 +459,37 @@ Fastify is already listening.
 Installed Fastify plugin mismatched expected version.
 
 <a name="FST_ERR_PLUGIN_CALLBACK_NOT_FN"></a>
+
 #### FST_ERR_PLUGIN_CALLBACK_NOT_FN
 
 Callback for a hook is not a function (mapped directly from `avvio`)
 
 <a name="FST_ERR_PLUGIN_NOT_VALID"></a>
+
 #### FST_ERR_PLUGIN_NOT_VALID
 
 Plugin must be a function or a promise.
 
 <a name="FST_ERR_ROOT_PLG_BOOTED"></a>
+
 #### FST_ERR_ROOT_PLG_BOOTED
 
 Root plugin has already booted (mapped directly from `avvio`)
 
 <a name="FST_ERR_PARENT_PLUGIN_BOOTED"></a>
+
 #### FST_ERR_PARENT_PLUGIN_BOOTED
 
 Impossible to load plugin because the parent (mapped directly from `avvio`)
 
 <a name="FST_ERR_PLUGIN_TIMEOUT"></a>
+
 #### FST_ERR_PLUGIN_TIMEOUT
 
 Plugin did not start in time. Default timeout (in millis): `10000`
+
+<a name="FST_ERR_PLUGIN_NOT_PRESENT_IN_INSTANCE"></a>
+
+#### FST_ERR_PLUGIN_NOT_PRESENT_IN_INSTANCE
+
+The decorator is not present in the instance.

fastify.js

@@ -59,7 +59,17 @@ const { defaultInitOptions } = getSecuredInitialConfig
 const {
   FST_ERR_ASYNC_CONSTRAINT,
   FST_ERR_BAD_URL,
-  FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE
+  FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE,
+  FST_ERR_OPTIONS_NOT_OBJ,
+  FST_ERR_QSP_NOT_FN,
+  FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN,
+  FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ,
+  FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR,
+  FST_ERR_VERSION_CONSTRAINT_NOT_STR,
+  FST_ERR_INSTANCE_ALREADY_LISTENING,
+  FST_ERR_REOPENED_CLOSE_SERVER,
+  FST_ERR_ROUTE_REWRITE_NOT_STR,
+  FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN
 } = errorCodes
 
 const { buildErrorHandler } = require('./lib/error-handler.js')
@@ -90,15 +100,15 @@ function fastify (options) {
   options = options || {}
 
   if (typeof options !== 'object') {
-    throw new TypeError('Options must be an object')
+    throw new FST_ERR_OPTIONS_NOT_OBJ()
   }
 
   if (options.querystringParser && typeof options.querystringParser !== 'function') {
-    throw new Error(`querystringParser option should be a function, instead got '${typeof options.querystringParser}'`)
+    throw new FST_ERR_QSP_NOT_FN(typeof options.querystringParser)
   }
 
   if (options.schemaController && options.schemaController.bucket && typeof options.schemaController.bucket !== 'function') {
-    throw new Error(`schemaController.bucket option should be a function, instead got '${typeof options.schemaController.bucket}'`)
+    throw new FST_ERR_SCHEMA_CONTROLLER_BUCKET_OPT_NOT_FN(typeof options.schemaController.bucket)
   }
 
   validateBodyLimitOption(options.bodyLimit)
@@ -117,10 +127,10 @@ function fastify (options) {
 
   // Ajv options
   if (!ajvOptions.customOptions || Object.prototype.toString.call(ajvOptions.customOptions) !== '[object Object]') {
-    throw new Error(`ajv.customOptions option should be an object, instead got '${typeof ajvOptions.customOptions}'`)
+    throw new FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_OBJ(typeof ajvOptions.customOptions)
   }
   if (!ajvOptions.plugins || !Array.isArray(ajvOptions.plugins)) {
-    throw new Error(`ajv.plugins option should be an array, instead got '${typeof ajvOptions.plugins}'`)
+    throw new FST_ERR_AJV_CUSTOM_OPTIONS_OPT_NOT_ARR(typeof ajvOptions.plugins)
   }
 
   // Instance Fastify components
@@ -156,7 +166,7 @@ function fastify (options) {
         deriveConstraint: options.versioning.deriveVersion,
         validate (value) {
           if (typeof value !== 'string') {
-            throw new Error('Version constraint should be a string.')
+            throw new FST_ERR_VERSION_CONSTRAINT_NOT_STR()
           }
         }
       }
@@ -463,7 +473,7 @@ function fastify (options) {
   return fastify
 
   function throwIfAlreadyStarted (msg) {
-    if (fastify[kState].started) throw new Error(msg)
+    if (fastify[kState].started) throw new FST_ERR_INSTANCE_ALREADY_LISTENING(msg)
   }
 
   // HTTP injection handling
@@ -479,7 +489,7 @@ function fastify (options) {
     if (fastify[kState].started) {
       if (fastify[kState].closing) {
         // Force to return an error
-        const error = new Error('Server is closed')
+        const error = new FST_ERR_REOPENED_CLOSE_SERVER()
         if (cb) {
           cb(error)
           return
@@ -564,7 +574,7 @@ function fastify (options) {
 
   // wrapper that we expose to the user for hooks handling
   function addHook (name, fn) {
-    throwIfAlreadyStarted('Cannot call "addHook" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "addHook"!')
 
     if (fn == null) {
       throw new errorCodes.FST_ERR_HOOK_INVALID_HANDLER(name, fn)
@@ -607,7 +617,7 @@ function fastify (options) {
 
   // wrapper that we expose to the user for schemas handling
   function addSchema (schema) {
-    throwIfAlreadyStarted('Cannot call "addSchema" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "addSchema"!')
     this[kSchemaController].add(schema)
     this[kChildren].forEach(child => child.addSchema(schema))
     return this
@@ -697,33 +707,33 @@ function fastify (options) {
   }
 
   function setNotFoundHandler (opts, handler) {
-    throwIfAlreadyStarted('Cannot call "setNotFoundHandler" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setNotFoundHandler"!')
 
     fourOhFour.setNotFoundHandler.call(this, opts, handler, avvio, router.routeHandler)
     return this
   }
 
   function setValidatorCompiler (validatorCompiler) {
-    throwIfAlreadyStarted('Cannot call "setValidatorCompiler" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setValidatorCompiler"!')
     this[kSchemaController].setValidatorCompiler(validatorCompiler)
     return this
   }
 
   function setSchemaErrorFormatter (errorFormatter) {
-    throwIfAlreadyStarted('Cannot call "setSchemaErrorFormatter" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setSchemaErrorFormatter"!')
     validateSchemaErrorFormatter(errorFormatter)
     this[kSchemaErrorFormatter] = errorFormatter.bind(this)
     return this
   }
 
   function setSerializerCompiler (serializerCompiler) {
-    throwIfAlreadyStarted('Cannot call "setSerializerCompiler" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setSerializerCompiler"!')
     this[kSchemaController].setSerializerCompiler(serializerCompiler)
     return this
   }
 
   function setSchemaController (schemaControllerOpts) {
-    throwIfAlreadyStarted('Cannot call "setSchemaController" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setSchemaController"!')
     const old = this[kSchemaController]
     const schemaController = SchemaController.buildSchemaController(old, Object.assign({}, old.opts, schemaControllerOpts))
     this[kSchemaController] = schemaController
@@ -733,15 +743,15 @@ function fastify (options) {
   }
 
   function setReplySerializer (replySerializer) {
-    throwIfAlreadyStarted('Cannot call "setReplySerializer" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setReplySerializer"!')
 
     this[kReplySerializerDefault] = replySerializer
     return this
   }
 
   // wrapper that we expose to the user for configure the custom error handler
   function setErrorHandler (func) {
-    throwIfAlreadyStarted('Cannot call "setErrorHandler" when fastify instance is already started!')
+    throwIfAlreadyStarted('Cannot call "setErrorHandler"!')
 
     this[kErrorHandler] = buildErrorHandler(this[kErrorHandler], func.bind(this))
     return this
@@ -766,7 +776,8 @@ function fastify (options) {
           if (typeof url === 'string') {
             req.url = url
           } else {
-            req.destroy(new Error(`Rewrite url for "${req.url}" needs to be of type "string" but received "${typeof url}"`))
+            const err = new FST_ERR_ROUTE_REWRITE_NOT_STR(req.url, typeof url)
+            req.destroy(err)
           }
         }
       }
@@ -779,9 +790,9 @@ fastify.errorCodes = errorCodes
 
 function validateSchemaErrorFormatter (schemaErrorFormatter) {
   if (typeof schemaErrorFormatter !== 'function') {
-    throw new Error(`schemaErrorFormatter option should be a function, instead got ${typeof schemaErrorFormatter}`)
+    throw new FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN(typeof schemaErrorFormatter)
   } else if (schemaErrorFormatter.constructor.name === 'AsyncFunction') {
-    throw new Error('schemaErrorFormatter option should not be an async function')
+    throw new FST_ERR_SCHEMA_ERROR_FORMATTER_NOT_FN('AsyncFunction')
   }
 }