lib: drop setDefaultRoute and getDefaultRoute methods

Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
fastify · Dec 29, 2022 · b8e201a · b8e201a
1 parent b2fbce0
commit b8e201a
Show file tree

Hide file tree

Showing 9 changed files with 2 additions and 105 deletions.
diff --git a/docs/Reference/Errors.md b/docs/Reference/Errors.md
@@ -334,11 +334,6 @@ The router received an invalid url.
 
 The router received an error when using asynchronous constraints.
 
-#### FST_ERR_DEFAULT_ROUTE_INVALID_TYPE
-<a id="FST_ERR_DEFAULT_ROUTE_INVALID_TYPE"></a>
-
-The `defaultRoute` type should be a function.
-
 #### FST_ERR_INVALID_URL
 <a id="FST_ERR_INVALID_URL"></a>
 
@@ -382,4 +377,4 @@ 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`
+Plugin did not start in time. Default timeout (in millis): `10000`
diff --git a/docs/Reference/Server.md b/docs/Reference/Server.md
@@ -50,8 +50,6 @@ describes the properties available in that options object.
     - [ready](#ready)
     - [listen](#listen)
     - [addresses](#addresses)
-    - [getDefaultRoute](#getdefaultroute)
-    - [setDefaultRoute](#setdefaultroute)
     - [routing](#routing)
     - [route](#route)
     - [hasRoute](#hasRoute)
@@ -1008,35 +1006,6 @@ const addresses = fastify.addresses()
 
 Note that the array contains the `fastify.server.address()` too.
 
-#### getDefaultRoute
-<a id="getDefaultRoute"></a>
-
-The `defaultRoute` handler handles requests that do not match any URL specified
-by your Fastify application. This defaults to the 404 handler, but can be
-overridden with [setDefaultRoute](#setdefaultroute). Method to get the
-`defaultRoute` for the server:
-
-```js
-const defaultRoute = fastify.getDefaultRoute()
-```
-
-#### setDefaultRoute
-<a id="setDefaultRoute"></a>
-
-**Note**: The default 404 handler, or one set using `setNotFoundHandler`, will
-never trigger if the default route is overridden. This sets the handler for the 
-Fastify application, not just the current instance context. Use
-[setNotFoundHandler](#setnotfoundhandler) if you want to customize 404 handling
-instead. Method to set the `defaultRoute` for the server:
-
-```js
-const defaultRoute = function (req, res) {
-  res.end('hello world')
-}
-
-fastify.setDefaultRoute(defaultRoute)
-```
-
 #### routing
 <a id="routing"></a>
 

diff --git a/fastify.js b/fastify.js
@@ -239,8 +239,6 @@ function fastify (options) {
     [kAvvioBoot]: null,
     // routing method
     routing: httpHandler,
-    getDefaultRoute: router.getDefaultRoute.bind(router),
-    setDefaultRoute: router.setDefaultRoute.bind(router),
     // routes shorthand methods
     delete: function _delete (url, options, handler) {
       return router.prepareRoute.call(this, { method: 'DELETE', url, options, handler })

diff --git a/lib/errors.js b/lib/errors.js
@@ -245,12 +245,6 @@ const codes = {
     'Unexpected error from async constraint',
     500
   ),
-  FST_ERR_DEFAULT_ROUTE_INVALID_TYPE: createError(
-    'FST_ERR_DEFAULT_ROUTE_INVALID_TYPE',
-    'The defaultRoute type should be a function',
-    500,
-    TypeError
-  ),
   FST_ERR_INVALID_URL: createError(
     'FST_ERR_INVALID_URL',
     "URL must be a string. Received '%s'",

diff --git a/lib/route.js b/lib/route.js
@@ -17,7 +17,6 @@ const {
 const {
   FST_ERR_SCH_VALIDATION_BUILD,
   FST_ERR_SCH_SERIALIZATION_BUILD,
-  FST_ERR_DEFAULT_ROUTE_INVALID_TYPE,
   FST_ERR_DUPLICATED_ROUTE,
   FST_ERR_INVALID_URL,
   FST_ERR_SEND_UNDEFINED_ERR,
@@ -88,16 +87,6 @@ function buildRouting (options) {
     route, // configure a route in the fastify instance
     hasRoute,
     prepareRoute,
-    getDefaultRoute: function () {
-      return router.defaultRoute
-    },
-    setDefaultRoute: function (defaultRoute) {
-      if (typeof defaultRoute !== 'function') {
-        throw new FST_ERR_DEFAULT_ROUTE_INVALID_TYPE()
-      }
-
-      router.defaultRoute = defaultRoute
-    },
     routeHandler,
     closeRoutes: () => { closing = true },
     printRoutes: router.prettyPrint.bind(router),

diff --git a/test/default-route.test.js b/test/default-route.test.js
diff --git a/test/types/instance.test-d.ts b/test/types/instance.test-d.ts
@@ -324,7 +324,5 @@ const versionConstraintStrategy = {
 expectType<void>(server.addConstraintStrategy(versionConstraintStrategy))
 expectType<boolean>(server.hasConstraintStrategy(versionConstraintStrategy.name))
 
-expectAssignable<DefaultRoute<RawRequestDefaultExpression, RawReplyDefaultExpression>>(server.getDefaultRoute())
-
 expectType<FastifySchemaCompiler<any> | undefined>(server.validatorCompiler)
 expectType<FastifySerializerCompiler<any> | undefined>(server.serializerCompiler)
diff --git a/types/errors.d.ts b/types/errors.d.ts
@@ -40,7 +40,6 @@ export type FastifyErrorCodes = Record<
 'FST_ERR_FORCE_CLOSE_CONNECTIONS_IDLE_NOT_AVAILABLE' |
 'FST_ERR_DUPLICATED_ROUTE' |
 'FST_ERR_BAD_URL' |
-'FST_ERR_DEFAULT_ROUTE_INVALID_TYPE' |
 'FST_ERR_INVALID_URL' |
 'FST_ERR_REOPENED_CLOSE_SERVER' |
 'FST_ERR_REOPENED_SERVER' |

diff --git a/types/instance.d.ts b/types/instance.d.ts
@@ -8,7 +8,7 @@ import { FastifyBaseLogger } from './logger'
 import { FastifyRegister } from './register'
 import { FastifyReply } from './reply'
 import { FastifyRequest } from './request'
-import { DefaultRoute, RouteGenericInterface, RouteOptions, RouteShorthandMethod } from './route'
+import { RouteGenericInterface, RouteOptions, RouteShorthandMethod } from './route'
 import {
   FastifySchema,
   FastifySchemaCompiler,
@@ -168,8 +168,6 @@ export interface FastifyInstance<
   register: FastifyRegister<FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider> & PromiseLike<undefined>>;
 
   routing(req: RawRequest, res: RawReply): void;
-  getDefaultRoute(): DefaultRoute<RawRequest, RawReply>;
-  setDefaultRoute(defaultRoute: DefaultRoute<RawRequest, RawReply>): void;
 
   route<
     RouteGeneric extends RouteGenericInterface = RouteGenericInterface,