improvement: consolidate all exceptions to a json file

Author: thetutlage

exceptions.json

@@ -0,0 +1,82 @@
+{
+	"E_CANNOT_LOOKUP_ROUTE": {
+		"message": "Cannot find route for \"{identifier}\" identifier",
+		"code": "E_CANNOT_FIND_ROUTE",
+		"status": 500,
+		"help": [
+			"When making URL for a route. You can use one of the following identifiers",
+			"- The route name. Defined using `Route.as()`",
+			"- The route controller.method name. `PostsController.show`"
+		]
+	},
+	"E_CANNOT_SERIALIZE_RESPONSE_BODY": {
+		"message": "Unable to send HTTP response. Cannot serialize \"{dataType}\" to a string",
+		"code": "E_CANNOT_SERIALIZE_RESPONSE_BODY",
+		"status": 500,
+		"help": [
+			"AdonisJS can only send following data types as a response",
+			"- object, array, number, boolean, date, buffer and string",
+			"- For sending streams, you must use `response.stream` method",
+			"- For downloading files, you must use `response.download` method"
+		]
+	},
+	"E_HTTP_EXCEPTION": {
+		"message": "Request aborted with status code {status}",
+		"code": "E_HTTP_EXCEPTION",
+		"help": ["A generic exception usually raised using \"response.abort\""]
+	},
+	"E_CANNOT_DEFINE_GROUP_NAME": {
+		"message": "All the routes inside a group must have names before calling \"Route.group.as\"",
+		"code": "E_CANNOT_DEFINE_GROUP_NAME",
+		"status": 500,
+		"help": [
+			"`Route.group.as` adds a prefix to the route names and hence it cannot prefix a route with no initial name",
+			"To fix the issue, you must give name to all the routes inside a group"
+		]
+	},
+	"E_DUPLICATE_ROUTE_NAME": {
+		"message": "Duplicate route name \"{name}\"",
+		"code": "E_DUPLICATE_ROUTE_NAME",
+		"status": 500,
+		"help": [
+			"Names are assigned to the routes to identify them uniquely and hence a duplicate name is not allowed",
+			"Run `node ace list:routes` to find the route using this name"
+		]
+	},
+	"E_DUPLICATE_ROUTE": {
+		"message": "Duplicate route \"{method}:{pattern}\"",
+		"code": "E_DUPLICATE_ROUTE",
+		"status": 500,
+		"help": [
+			"The route with the pattern is already registered",
+			"Double check your routes file or run `node ace list:routes`"
+		]
+	},
+	"E_DUPLICATE_ROUTE_PARAM": {
+		"message": "The \"{param}\" param is mentioned twice in the route pattern \"{pattern}\"",
+		"code": "E_DUPLICATE_ROUTE_PARAM",
+		"status": 500
+	},
+	"E_ROUTE_NOT_FOUND": {
+		"message": "Cannot {method}:{url}",
+		"code": "E_ROUTE_NOT_FOUND",
+		"status": 404
+	},
+	"E_MISSING_NAMED_MIDDLEWARE": {
+		"message": "Cannot find a middleware named \"{name}\"",
+		"code": "E_MISSING_NAMED_MIDDLEWARE",
+		"status": 500,
+		"help": [
+			"The named middleware are supposed to be registered inside `start/kernel` file first",
+			"Open the file and make sure middleware is defined inside `Server.middleware.registerNamed()` call"
+		]
+	},
+	"E_CANNOT_MAKE_ROUTE_URL": {
+		"message": "\"{param}\" param is required to make URL for \"{pattern}\" route",
+		"code": "E_CANNOT_MAKE_ROUTE_URL",
+		"status": 500,
+		"help": [
+			"Make sure to define params object when using `Route.makeUrl` or the view help `route`."
+		]
+	}
+}

npm-audit.html

@@ -55,7 +55,7 @@ <h5 class="card-title">
                 <div class="card">
                     <div class="card-body">
                         <h5 class="card-title">
-                            July 23rd 2020, 7:24:11 am
+                            July 24th 2020, 6:20:27 am
                         </h5>
                         <p class="card-text">Last updated</p>
                     </div>

package-lock.json

@@ -4,9 +4,10 @@
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/providers/HttpServerProvider.js",
   "files": [
-    "build/src",
-    "build/providers",
     "build/adonis-typings",
+    "build/providers",
+    "build/src",
+    "build/exceptions.json",
     "build/standalone.d.ts",
     "build/standalone.js"
   ],
@@ -44,7 +45,7 @@
     "@poppinss/dev-utils": "^1.0.8",
     "@types/cookie": "^0.4.0",
     "@types/ms": "^0.7.31",
-    "@types/node": "^14.0.24",
+    "@types/node": "^14.0.25",
     "@types/pluralize": "0.0.29",
     "@types/proxy-addr": "^2.0.0",
     "@types/qs": "^6.9.3",
@@ -102,7 +103,7 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@poppinss/utils": "^2.3.0",
+    "@poppinss/utils": "^2.4.1",
     "accepts": "^1.3.7",
     "co-compose": "^6.0.1",
     "content-disposition": "^0.5.3",
@@ -136,5 +137,8 @@
   "bugs": {
     "url": "https://github.com/adonisjs/http-server/issues"
   },
-  "homepage": "https://github.com/adonisjs/http-server#readme"
+  "homepage": "https://github.com/adonisjs/http-server#readme",
+  "adonisjs": {
+  	"exceptions": "./build/exceptions.json"
+  }
 }

package.json

@@ -0,0 +1,48 @@
+/**
+ * @adonisjs/http-server
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/// <reference path="../../adonis-typings/index.ts" />
+
+import { Exception, interpolate } from '@poppinss/utils'
+import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
+
+import { E_HTTP_EXCEPTION } from '../../exceptions.json'
+
+/**
+ * Custom exception to abort requests as one liners
+ */
+export class HttpException extends Exception {
+	public body: any
+
+	/**
+	 * This method returns an instance of the exception class
+	 */
+	public static invoke(body: any, status: number, code?: string) {
+		const message = E_HTTP_EXCEPTION.message
+		code = code || E_HTTP_EXCEPTION.code
+
+		if (body !== null && typeof body === 'object') {
+			const error = new this(body.message || interpolate(message, { status }), status, code)
+			error.body = body
+			return error
+		}
+
+		const error = new this(body || interpolate(message, { status }), status, code)
+		error.body = error.message
+		return error
+	}
+
+	/**
+	 * Handle itself by making the response. This only works when using the
+	 * base exception handler shipped by AdonisJs
+	 */
+	public handle(error: HttpException, ctx: HttpContextContract) {
+		ctx.response.status(error.status).send(error.body)
+	}
+}

src/Exceptions/HttpException.ts

@@ -0,0 +1,106 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) Harminder Virk <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Exception, interpolate } from '@poppinss/utils'
+import {
+	E_DUPLICATE_ROUTE,
+	E_CANNOT_LOOKUP_ROUTE,
+	E_DUPLICATE_ROUTE_NAME,
+	E_CANNOT_MAKE_ROUTE_URL,
+	E_DUPLICATE_ROUTE_PARAM,
+	E_CANNOT_DEFINE_GROUP_NAME,
+} from '../../exceptions.json'
+
+/**
+ * Exceptions related to the HTTP router
+ */
+export class RouterException extends Exception {
+	/**
+	 * Raised when one of the routes inside the group doesn't have a name
+	 * but an attempt is made to name the group
+	 */
+	public static cannotDefineGroupName() {
+		const error = new this(
+			E_CANNOT_DEFINE_GROUP_NAME.message,
+			E_CANNOT_DEFINE_GROUP_NAME.status,
+			E_CANNOT_DEFINE_GROUP_NAME.code
+		)
+
+		error.help = E_CANNOT_DEFINE_GROUP_NAME.help.join('\n')
+		throw error
+	}
+
+	/**
+	 * Raised when a duplicate route pattern is find for the same HTTP method
+	 */
+	public static duplicateRoute(method: string, pattern: string) {
+		const error = new this(
+			interpolate(E_DUPLICATE_ROUTE.message, { method, pattern }),
+			E_DUPLICATE_ROUTE.status,
+			E_DUPLICATE_ROUTE.code
+		)
+
+		error.help = E_DUPLICATE_ROUTE.help.join('\n')
+		throw error
+	}
+
+	/**
+	 * Raised when a route has duplicate params
+	 */
+	public static duplicateRouteParam(param: string, pattern: string) {
+		return new this(
+			interpolate(E_DUPLICATE_ROUTE_PARAM.message, { param, pattern }),
+			E_DUPLICATE_ROUTE_PARAM.status,
+			E_DUPLICATE_ROUTE_PARAM.code
+		)
+	}
+
+	/**
+	 * Raised when route name is not unique
+	 */
+	public static duplicateRouteName(name: string) {
+		const error = new this(
+			interpolate(E_DUPLICATE_ROUTE_NAME.message, { name }),
+			E_DUPLICATE_ROUTE_NAME.status,
+			E_DUPLICATE_ROUTE_NAME.code
+		)
+
+		error.help = E_DUPLICATE_ROUTE_NAME.help.join('\n')
+		throw error
+	}
+
+	/**
+	 * Raised when unable to make url for a given route, because one of the
+	 * params value is not defined
+	 */
+	public static cannotMakeRoute(param: string, pattern: string) {
+		const error = new this(
+			interpolate(E_CANNOT_MAKE_ROUTE_URL.message, { pattern, param }),
+			E_CANNOT_MAKE_ROUTE_URL.status,
+			E_CANNOT_MAKE_ROUTE_URL.code
+		)
+
+		error.help = E_CANNOT_MAKE_ROUTE_URL.help.join('\n')
+		throw error
+	}
+
+	/**
+	 * Raised when unable to lookup a route using its identifier
+	 */
+	public static cannotLookupRoute(identifier: string) {
+		const error = new this(
+			interpolate(E_CANNOT_LOOKUP_ROUTE.message, { identifier }),
+			E_CANNOT_LOOKUP_ROUTE.status,
+			E_CANNOT_LOOKUP_ROUTE.code
+		)
+
+		error.help = E_CANNOT_LOOKUP_ROUTE.help.join('\n')
+		throw error
+	}
+}

src/Exceptions/RouterException.ts

@@ -13,9 +13,10 @@ import { parse } from 'url'
 import { stringify } from 'qs'
 import encodeurl from 'encodeurl'
 import { IncomingMessage } from 'http'
-
-import { RedirectContract, ResponseContract } from '@ioc:Adonis/Core/Response'
 import { RouterContract, MakeUrlOptions } from '@ioc:Adonis/Core/Route'
+import { RedirectContract, ResponseContract } from '@ioc:Adonis/Core/Response'
+
+import { RouterException } from '../Exceptions/RouterException'
 
 /**
  * Exposes the API to construct redirect routes
@@ -88,11 +89,9 @@ export class Redirect implements RedirectContract {
 	 * Redirect the request using a route identifier.
 	 */
 	public toRoute(routeIdentifier: string, urlOptions?: MakeUrlOptions, domain?: string) {
-		// const route = this.router.lookup(routeIdentifier, domain)
-
 		const url = this.router.makeUrl(routeIdentifier, urlOptions, domain)
 		if (!url) {
-			throw new Error(`Unable to lookup route for "${routeIdentifier}" identifier`)
+			throw RouterException.cannotLookupRoute(routeIdentifier)
 		}
 
 		return this.toPath(url)