refactor: cleanup exceptions

Author: thetutlage

index.ts

@@ -18,7 +18,4 @@ export { defineConfig } from './src/define_config.js'
 export { RouteResource } from './src/router/resource.js'
 export { BriskRoute } from './src/router/brisk.js'
 export { HttpContext } from './src/http_context/main.js'
-export { HttpException } from './src/exceptions/http_exception.js'
-export { AbortException } from './src/exceptions/abort_exception.js'
-export { RouteNotFoundException } from './src/exceptions/route_not_found.js'
-export { CannotLookupRouteException } from './src/exceptions/cannot_lookup_route.js'
+export * as errors from './src/exceptions/main.js'

src/exceptions/abort_exception.ts

@@ -7,12 +7,22 @@
  * file that was distributed with this source code.
  */
 
-import { Exception } from '@poppinss/utils'
+import { createError, Exception } from '@poppinss/utils'
+import type { HttpContext } from '../http_context/main.js'
 
-/**
- * Exception class to represent an HTTP exception
- */
-export class HttpException extends Exception {
+export const E_ROUTE_NOT_FOUND = createError<[method: string, url: string]>(
+  'Cannot %s:%s',
+  'E_ROUTE_NOT_FOUND',
+  404
+)
+
+export const E_CANNOT_LOOKUP_ROUTE = createError<[routeIdentifier: string]>(
+  'Cannot lookup route "%s"',
+  'E_CANNOT_LOOKUP_ROUTE',
+  500
+)
+
+export const E_HTTP_EXCEPTION = class HttpException extends Exception {
   body: any
   static code = 'E_HTTP_EXCEPTION'
 
@@ -37,3 +47,9 @@ export class HttpException extends Exception {
     return error
   }
 }
+
+export const E_HTTP_REQUEST_ABORTED = class AbortException extends E_HTTP_EXCEPTION {
+  handle(error: AbortException, ctx: HttpContext) {
+    ctx.response.status(error.status).send(error.body)
+  }
+}

src/exceptions/cannot_lookup_route.ts

@@ -28,7 +28,7 @@ import { Redirect } from './redirect.js'
 import type { Router } from './router/main.js'
 import type { HttpContext } from './http_context/main.js'
 import { CookieSerializer } from './cookies/serializer.js'
-import { AbortException } from './exceptions/abort_exception.js'
+import { E_HTTP_REQUEST_ABORTED } from './exceptions/main.js'
 import type {
   CastableHeader,
   CookieOptions,
@@ -927,7 +927,7 @@ export class Response extends Macroable {
    * used when status is not defined
    */
   abort(body: any, status?: number): never {
-    throw AbortException.invoke(body, status || 400)
+    throw E_HTTP_REQUEST_ABORTED.invoke(body, status || 400)
   }
 
   /**

src/exceptions/http_exception.ts src/exceptions/main.tssrc/exceptions/http_exception.ts renamed to src/exceptions/main.ts

@@ -7,8 +7,8 @@
  * file that was distributed with this source code.
  */
 
+import * as errors from '../../exceptions/main.js'
 import type { RouteJSON } from '../../types/route.js'
-import { CannotLookupRouteException } from '../../exceptions/cannot_lookup_route.js'
 
 /**
  * Route finder is used to find a route by its name, route pattern
@@ -45,7 +45,7 @@ export class RouteFinder {
   findOrFail(routeIdentifier: string): RouteJSON {
     const route = this.find(routeIdentifier)
     if (!route) {
-      throw new CannotLookupRouteException(`Cannot lookup route "${routeIdentifier}"`)
+      throw new errors.E_CANNOT_LOOKUP_ROUTE([routeIdentifier])
     }
 
     return route

src/exceptions/route_not_found.ts

@@ -9,9 +9,9 @@
 
 import type { ContainerResolver } from '@adonisjs/fold'
 
+import * as errors from '../../exceptions/main.js'
 import type { Router } from '../../router/main.js'
 import type { HttpContext } from '../../http_context/main.js'
-import { RouteNotFoundException } from '../../exceptions/route_not_found.js'
 
 /**
  * The final handler is executed after the server middleware stack.
@@ -33,6 +33,6 @@ export function finalHandler(router: Router, resolver: ContainerResolver<any>, c
       return route.route.execute(route.route, resolver, ctx)
     }
 
-    return Promise.reject(new RouteNotFoundException(`Cannot ${method}:${url}`))
+    return Promise.reject(new errors.E_ROUTE_NOT_FOUND([method, url]))
   }
 }

src/response.ts

@@ -8,12 +8,12 @@
  */
 
 import { test } from '@japa/runner'
-import { HttpException } from '../../src/exceptions/http_exception.js'
+import { E_HTTP_EXCEPTION } from '../../src/exceptions/main.js'
 
 test.group('Http exception', () => {
   test('create http exception with an error object', ({ assert }) => {
     const error = new Error('Something went wrong')
-    const exception = HttpException.invoke(new Error('Something went wrong'), 500)
+    const exception = E_HTTP_EXCEPTION.invoke(new Error('Something went wrong'), 500)
 
     assert.deepEqual(exception.body, error)
     assert.equal(exception.message, 'Something went wrong')
@@ -22,7 +22,7 @@ test.group('Http exception', () => {
   })
 
   test('create http exception with a string message', ({ assert }) => {
-    const exception = HttpException.invoke('Something went wrong', 500)
+    const exception = E_HTTP_EXCEPTION.invoke('Something went wrong', 500)
 
     assert.deepEqual(exception.body, 'Something went wrong')
     assert.equal(exception.message, 'Something went wrong')
@@ -31,7 +31,7 @@ test.group('Http exception', () => {
   })
 
   test('create http exception with an error of values', ({ assert }) => {
-    const exception = HttpException.invoke([{ message: 'Something went wrong' }], 500)
+    const exception = E_HTTP_EXCEPTION.invoke([{ message: 'Something went wrong' }], 500)
 
     assert.deepEqual(exception.body, [{ message: 'Something went wrong' }])
     assert.equal(exception.message, 'HTTP Exception')
@@ -40,7 +40,10 @@ test.group('Http exception', () => {
   })
 
   test('create http exception with an object without message', ({ assert }) => {
-    const exception = HttpException.invoke({ errors: [{ message: 'Something went wrong' }] }, 500)
+    const exception = E_HTTP_EXCEPTION.invoke(
+      { errors: [{ message: 'Something went wrong' }] },
+      500
+    )
 
     assert.deepEqual(exception.body, { errors: [{ message: 'Something went wrong' }] })
     assert.equal(exception.message, 'HTTP Exception')
@@ -49,7 +52,7 @@ test.group('Http exception', () => {
   })
 
   test('create http exception with null body', ({ assert }) => {
-    const exception = HttpException.invoke(null, 500)
+    const exception = E_HTTP_EXCEPTION.invoke(null, 500)
 
     assert.deepEqual(exception.body, 'Internal server error')
     assert.equal(exception.message, 'HTTP Exception')
@@ -58,7 +61,7 @@ test.group('Http exception', () => {
   })
 
   test('create http exception with undefined body', ({ assert }) => {
-    const exception = HttpException.invoke(undefined, 500)
+    const exception = E_HTTP_EXCEPTION.invoke(undefined, 500)
 
     assert.deepEqual(exception.body, 'Internal server error')
     assert.equal(exception.message, 'HTTP Exception')