Feat/len set error handler (#17)

* feat: add controller and request mappers decorators

* refactor: remove route array from Http class

* refactor: create handler to hook preHandler

* feat: implement fastify handler class and set error handler method

* style: add more keywords in package.json

Author: jlenon7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/http",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "license": "MIT",
   "author": "João Lenon",
@@ -15,6 +15,10 @@
   },
   "keywords": [
     "http",
+    "handler",
+    "router",
+    "context",
+    "middleware",
     "fastify",
     "nodejs"
   ],

src/Context/Request.ts

@@ -30,11 +30,7 @@ export class Request implements RequestContract {
   }
 
   get baseUrl(): string {
-    return this.request.url
-  }
-
-  get originalUrl(): string {
-    return this.request.url
+    return this.request.url.split('?')[0]
   }
 
   get body(): Record<string, any> {

src/Contracts/Context/ContextContract.ts

@@ -18,4 +18,5 @@ export interface ContextContract {
   queries: Record<string, string>
   next?: NextContract
   data?: Record<string, any>
+  error?: any
 }

src/Contracts/Context/HandlerContract.ts

@@ -10,5 +10,5 @@
 import { ContextContract } from './ContextContract'
 
 export interface HandlerContract {
-  (ctx: ContextContract): Promise<any> | any
+  (ctx?: ContextContract): Promise<any> | any
 }

src/Contracts/Context/RequestContract.ts

@@ -12,7 +12,6 @@ export interface RequestContract {
   method: string
   fullUrl: string
   baseUrl: string
-  originalUrl: string
   body: Record<string, any>
   params: Record<string, string>
   queries: Record<string, string>

src/Http.ts

@@ -7,79 +7,25 @@
  * file that was distributed with this source code.
  */
 
-import fastify, {
-  FastifyInstance,
-  FastifyReply,
-  FastifyRequest,
-  PrintRoutesOptions,
-} from 'fastify'
-
-import { String } from '@secjs/utils'
-import { Request } from './Context/Request'
-import { Response } from './Context/Response'
+import fastify, { FastifyInstance, PrintRoutesOptions } from 'fastify'
+
+import { FastifyHandler } from './Utils/FastifyHandler'
 import { HttpMethodTypes } from './Contracts/HttpMethodTypes'
+import { defaultErrorHandler } from './Utils/defaultErrorHandler'
 import { HandlerContract } from './Contracts/Context/HandlerContract'
-import { FastifyHandlerContract } from './Contracts/FastifyHandlerContract'
-
-declare module 'fastify' {
-  interface FastifyRequest {
-    data: Record<string, any>
-  }
-}
 
 export class Http {
   private readonly server: FastifyInstance
 
   constructor() {
     this.server = fastify()
-    this.server.setErrorHandler(Http.defaultErrorHandler)
+    this.setErrorHandler(defaultErrorHandler)
   }
 
-  private static defaultErrorHandler(
-    error: any,
-    request: FastifyRequest,
-    reply: FastifyReply,
-  ) {
-    const code = error.code || error.name
-    const statusCode = error.statusCode || error.status || 500
-
-    const body = {
-      code: String.toSnakeCase(code).toUpperCase(),
-      path: request.url,
-      method: request.method,
-      status: statusCode <= 399 ? 'SUCCESS' : 'ERROR',
-      statusCode: statusCode,
-      error: {
-        name: error.name,
-        message: error.message,
-        stack: error.stack,
-      },
-    }
-
-    reply.status(statusCode).send(body)
-  }
+  setErrorHandler(handler: HandlerContract) {
+    const fastifyErrorHandler = FastifyHandler.createErrorHandler(handler)
 
-  private createFastifyHandler(
-    handler: (ctx) => Promise<void> | void,
-  ): FastifyHandlerContract {
-    return async (req: FastifyRequest, res: FastifyReply) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-      if (!req.query) req.query = {}
-      if (!req.params) req.params = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params,
-        queries: req.query,
-        data: req.data,
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        next: () => {},
-      })
-    }
+    this.server.setErrorHandler(fastifyErrorHandler)
   }
 
   getServer(): FastifyInstance {
@@ -91,23 +37,7 @@ export class Http {
   }
 
   use(handler: HandlerContract) {
-    this.server.addHook('preHandler', (req, res, done) => {
-      const request = new Request(req)
-      const response = new Response(res)
-
-      if (!req.data) req.data = {}
-      if (!req.query) req.query = {}
-      if (!req.params) req.params = {}
-
-      return handler({
-        request,
-        response,
-        params: req.params as Record<string, string>,
-        queries: req.query as Record<string, string>,
-        data: req.data,
-        next: done,
-      })
-    })
+    this.server.addHook('preHandler', FastifyHandler.createPreHandler(handler))
   }
 
   listen(
@@ -130,9 +60,10 @@ export class Http {
     this.server.route({
       url,
       method: methods,
-      handler: this.createFastifyHandler(handler),
+      handler: FastifyHandler.createRequestHandler(handler),
       preHandler:
-        middlewares && middlewares.map(mid => this.createFastifyHandler(mid)),
+        middlewares &&
+        middlewares.map(mid => FastifyHandler.createPreHandler(mid)),
     })
   }
 

src/Utils/FastifyHandler.ts

@@ -0,0 +1,85 @@
+/**
+ * @secjs/http
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/* eslint-disable @typescript-eslint/no-empty-function */
+
+import { Request } from '../Context/Request'
+import { Response } from '../Context/Response'
+import { HandlerContract } from '../Contracts/Context/HandlerContract'
+import { FastifyReply, FastifyRequest } from 'fastify'
+
+declare module 'fastify' {
+  interface FastifyRequest {
+    data: Record<string, any>
+  }
+}
+
+export class FastifyHandler {
+  static createPreHandler(handler: HandlerContract) {
+    return (req, res, done) => {
+      const request = new Request(req)
+      const response = new Response(res)
+
+      if (!req.data) req.data = {}
+      if (!req.query) req.query = {}
+      if (!req.params) req.params = {}
+
+      return handler({
+        request,
+        response,
+        params: req.params as Record<string, string>,
+        queries: req.query as Record<string, string>,
+        data: req.data,
+        next: done,
+      })
+    }
+  }
+
+  static createErrorHandler(handler: HandlerContract) {
+    return (error: any, req: FastifyRequest, res: FastifyReply) => {
+      const request = new Request(req)
+      const response = new Response(res)
+
+      if (!req.data) req.data = {}
+      if (!req.query) req.query = {}
+      if (!req.params) req.params = {}
+
+      return handler({
+        request,
+        response,
+        params: req.params as Record<string, string>,
+        queries: req.query as Record<string, string>,
+        data: req.data,
+        next: () => {},
+        error,
+      })
+    }
+  }
+
+  static createRequestHandler(handler: HandlerContract) {
+    return async (req: FastifyRequest, res: FastifyReply) => {
+      const request = new Request(req)
+      const response = new Response(res)
+
+      if (!req.data) req.data = {}
+      if (!req.query) req.query = {}
+      if (!req.params) req.params = {}
+
+      return handler({
+        request,
+        response,
+        params: req.params as Record<string, string>,
+        queries: req.query as Record<string, string>,
+        data: req.data,
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        next: () => {},
+      })
+    }
+  }
+}

src/Utils/defaultErrorHandler.ts

@@ -0,0 +1,35 @@
+/**
+ * @secjs/http
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { String } from '@secjs/utils'
+import { ContextContract } from '../Contracts/Context/ContextContract'
+
+export function defaultErrorHandler({
+  error,
+  request,
+  response,
+}: ContextContract) {
+  const code = error.code || error.name
+  const statusCode = error.statusCode || error.status || 500
+
+  const body = {
+    code: String.toSnakeCase(code).toUpperCase(),
+    path: request.baseUrl,
+    method: request.method,
+    status: statusCode <= 399 ? 'SUCCESS' : 'ERROR',
+    statusCode: statusCode,
+    error: {
+      name: error.name,
+      message: error.message,
+      stack: error.stack,
+    },
+  }
+
+  response.status(statusCode).send(body)
+}

tests/http.spec.ts

@@ -87,7 +87,7 @@ describe('\n Http Class', () => {
 
     expect(response.status).toBe(400)
     expect(response.body.code).toStrictEqual('BAD_REQUEST_EXCEPTION')
-    expect(response.body.path).toStrictEqual('/test?throwError=true')
+    expect(response.body.path).toStrictEqual('/test')
     expect(response.body.method).toStrictEqual('GET')
     expect(response.body.status).toStrictEqual('ERROR')
     expect(response.body.statusCode).toStrictEqual(400)