Refactor/len remove route array (#15)

* feat: add controller and request mappers decorators

* refactor: remove route array from Http class

* refactor: create handler to hook preHandler

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/http",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "license": "MIT",
   "author": "João Lenon",
@@ -21,7 +21,7 @@
   "devDependencies": {
     "@secjs/exceptions": "1.0.4",
     "@secjs/ioc": "1.0.8",
-    "@secjs/utils": "1.6.2",
+    "@secjs/utils": "1.6.3",
     "@types/jest": "27.0.1",
     "@types/node": "14.14.37",
     "@types/supertest": "^2.0.11",
@@ -42,6 +42,7 @@
     "jest": "27.1.0",
     "lint-staged": "11.1.2",
     "prettier": "2.3.2",
+    "reflect-metadata": "0.1.13",
     "supertest": "6.1.6",
     "ts-jest": "27.0.5",
     "ts-loader": "9.2.3",

package.json

@@ -0,0 +1,53 @@
+/**
+ * @secjs/http
+ *
+ * (c) João Lenon <lenon@secjs.com.br>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import 'reflect-metadata'
+import { removeSlash } from '../Utils/removeSlash'
+
+export function Controller(path?: string | string[]): ClassDecorator {
+  if (!path) path = '/'
+
+  path = removeSlash(path)
+
+  return (target: any) => {
+    const routes: any[] = Reflect.getMetadata('controller:routes', target)
+
+    if (routes && routes.length) {
+      if (Array.isArray(path)) {
+        const routesPrefixed = []
+
+        path.forEach(p => {
+          if (p === '/') return
+
+          routes.forEach(route =>
+            routesPrefixed.push({
+              ...route,
+              path: `${p}${route.path}`,
+            }),
+          )
+        })
+
+        Reflect.defineMetadata('controller:routes', routesPrefixed, target)
+      } else {
+        const routesPrefixed =
+          path === '/'
+            ? routes
+            : routes.filter(route => (route.path = `${path}${route.path}`))
+
+        Reflect.defineMetadata('controller:routes', routesPrefixed, target)
+      }
+    }
+
+    Reflect.defineMetadata(
+      'controller:path',
+      typeof path === 'string' ? [path] : path,
+      target,
+    )
+  }
+}

src/Decorators/Controller.ts

@@ -0,0 +1,71 @@
+/**
+ * @secjs/http
+ *
+ * (c) João Lenon <lenon@secjs.com.br>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import 'reflect-metadata'
+import { removeSlash } from '../Utils/removeSlash'
+
+export enum RequestMethod {
+  GET,
+  POST,
+  PUT,
+  DELETE,
+  PATCH,
+  ALL,
+  OPTIONS,
+  HEAD,
+}
+
+export function RequestMapper(
+  path: string | string[] = '/',
+  method: RequestMethod = RequestMethod.GET,
+): MethodDecorator {
+  if (path.length && !path[0]) path = '/'
+
+  path = removeSlash(path)
+
+  return (
+    target: any,
+    key: string | symbol,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) => {
+    let routes = Reflect.getMetadata('controller:routes', target.constructor)
+
+    if (!routes) {
+      Reflect.defineMetadata(
+        'controller:routes',
+        (routes = []),
+        target.constructor,
+      )
+    }
+
+    typeof path === 'string'
+      ? routes.push({ path, method, handler: target[key] })
+      : path.forEach(p =>
+          routes.push({ path: p, method, handler: target[key] }),
+        )
+
+    Reflect.defineMetadata('controller:routes', routes, target.constructor)
+
+    return descriptor
+  }
+}
+
+export const createRequestDecorator =
+  (method: RequestMethod) =>
+  (path?: string | string[]): MethodDecorator =>
+    RequestMapper(path, method)
+
+export const Get = createRequestDecorator(RequestMethod.GET)
+export const Post = createRequestDecorator(RequestMethod.POST)
+export const Put = createRequestDecorator(RequestMethod.PUT)
+export const Patch = createRequestDecorator(RequestMethod.PATCH)
+export const Delete = createRequestDecorator(RequestMethod.DELETE)
+export const All = createRequestDecorator(RequestMethod.ALL)
+export const Options = createRequestDecorator(RequestMethod.OPTIONS)
+export const Head = createRequestDecorator(RequestMethod.HEAD)

src/Decorators/RequestMapping.ts

@@ -17,7 +17,6 @@ import fastify, {
 import { String } from '@secjs/utils'
 import { Request } from './Context/Request'
 import { Response } from './Context/Response'
-import { RouteContract } from './Contracts/RouteContract'
 import { HttpMethodTypes } from './Contracts/HttpMethodTypes'
 import { HandlerContract } from './Contracts/Context/HandlerContract'
 import { FastifyHandlerContract } from './Contracts/FastifyHandlerContract'
@@ -29,14 +28,9 @@ declare module 'fastify' {
 }
 
 export class Http {
-  private readonly routes: RouteContract[]
   private readonly server: FastifyInstance
-  private readonly middlewares: HandlerContract[]
 
   constructor() {
-    this.routes = []
-    this.middlewares = []
-
     this.server = fastify()
     this.server.setErrorHandler(Http.defaultErrorHandler)
   }
@@ -68,23 +62,22 @@ export class Http {
   private createFastifyHandler(
     handler: (ctx) => Promise<void> | void,
   ): FastifyHandlerContract {
-    return async (req: FastifyRequest, res: FastifyReply, next?: any) => {
+    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 = {}
-      // eslint-disable-next-line @typescript-eslint/no-empty-function
-      if (!next) next = () => {}
 
       return handler({
         request,
         response,
         params: req.params,
         queries: req.query,
         data: req.data,
-        next,
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        next: () => {},
       })
     }
   }
@@ -93,24 +86,38 @@ export class Http {
     return this.server
   }
 
-  use(handler: HandlerContract) {
-    this.middlewares.push(handler)
-  }
-
   getRoutes(options?: PrintRoutesOptions) {
     return this.server.printRoutes(options)
   }
 
-  async listen(
+  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,
+      })
+    })
+  }
+
+  listen(
     port?: number,
     cb?: (err: Error | null, address: string) => void,
-  ): Promise<void> {
-    this.routes.forEach(route => this.server.route(route))
-
+  ): void | string {
     return this.server.listen(port || 1335, cb)
   }
 
-  async close(cb?: () => void): Promise<void> {
+  close(cb?: () => void): void {
     return this.server.close(cb)
   }
 
@@ -120,23 +127,12 @@ export class Http {
     handler: HandlerContract,
     middlewares?: HandlerContract[],
   ) {
-    let allMiddlewares = this.middlewares
-
-    if (middlewares && middlewares.length) {
-      allMiddlewares = allMiddlewares.concat(middlewares)
-    }
-
-    const preHandlers: FastifyHandlerContract[] = allMiddlewares.map(mid =>
-      this.createFastifyHandler(mid),
-    )
-
-    methods.forEach(method => {
-      this.routes.push({
-        url,
-        method,
-        preHandler: preHandlers,
-        handler: this.createFastifyHandler(handler),
-      })
+    this.server.route({
+      url,
+      method: methods,
+      handler: this.createFastifyHandler(handler),
+      preHandler:
+        middlewares && middlewares.map(mid => this.createFastifyHandler(mid)),
     })
   }
 

src/Http.ts

@@ -49,7 +49,7 @@ export class Route {
   }
 
   private getUrl(): string {
-    const url = removeSlash(this.url)
+    const url = removeSlash(this.url) as string
 
     const prefix = this.prefixes
       .slice()

src/Router/Route.ts

@@ -7,10 +7,18 @@
  * file that was distributed with this source code.
  */
 
-export function removeSlash(url: string): string {
+import { Is } from '@secjs/utils'
+
+export function removeSlash(url: string | string[]): string | string[] {
   if (url === '/') {
     return url
   }
 
-  return `/${url.replace(/^\//, '').replace(/\/$/, '')}`
+  const matcher = url => `/${url.replace(/^\//, '').replace(/\/$/, '')}`
+
+  if (Is.Array(url)) {
+    return url.map(u => matcher(u))
+  }
+
+  return matcher(url)
 }