Feat/len add interceptors terminators (#19)

* 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

* feat: add interceptors and terminators middleware to project

* feat: add interceptors/terminators middlewares and controller method to router

* fix: change ports for each test

* feat: add url methods to request and change node ci version

Author: jlenon7

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
 
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.x'
+          node-version: '16.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Download dependencies

README.md

@@ -29,7 +29,7 @@ The intention behind this repository is to always maintain a `Http` package to a
 > it keeps as dev dependency because one day `@secjs/core` will install everything once.
 
 ```bash
-npm install @secjs/ioc @secjs/utils @secjs/exceptions
+npm install @secjs/ioc @secjs/env @secjs/utils @secjs/exceptions
 ```
 
 > Then you can install the package using:
@@ -140,6 +140,66 @@ Route.register()
 http.listen()
 ```
 
+### Creating a Middleware
+
+> With Http you can define three different execution times for one middleware
+
+```ts
+import { 
+  Router,
+  MiddlewareContract,
+  HandleContextContract,
+  InterceptContextContract,
+  TerminateContextContract 
+} from '@secjs/http'
+
+export class Middleware implements MiddlewareContract {
+  // Handle method will be executed before the controller method handler
+  // This is the normal middleware
+  async handle(ctx: HandleContextContract) {
+    ctx.data.userId = '1'
+
+    ctx.next()
+  }
+
+  // Intercept method will be executed before the response goes to client
+  async intercept(ctx: InterceptContextContract) {
+    // You can use intercept to rewrite or add some information to the response
+    ctx.body.intercepted = true
+    ctx.response.status(304)
+
+    ctx.next()
+  }
+
+  // Terminate method will be executed after the response goes to client
+  async terminate(ctx: TerminateContextContract) {
+    // You can use terminate to save metrics of the request in an Elastic for example
+    console.log('Terminate middleware executed!')
+
+    ctx.next()
+  }
+}
+```
+
+> Now we can use Router to set the middleware in some route
+
+```ts
+Container.singleton(
+  {
+    'middleware': new Middleware(),
+  },
+  'Middlewares',
+)
+
+// If you use named middlewares in Router, he will register all the three methods of Middleware class.
+Route.get('middlewares', 'TestController.index').middleware('middleware')
+
+// 
+Route
+  .get('middlewares', 'TestController.index')
+  .middleware(new Middleware().handle)
+```
+
 ---
 
 ## License

index.ts

@@ -5,5 +5,16 @@ export * from './src/Contracts/MiddlewareContract'
 
 export * from './src/Contracts/Context/ContextContract'
 export * from './src/Contracts/Context/HandlerContract'
+
 export * from './src/Contracts/Context/RequestContract'
 export * from './src/Contracts/Context/ResponseContract'
+
+export * from './src/Contracts/Context/Error/ErrorContextContract'
+export * from './src/Contracts/Context/Error/ErrorHandlerContract'
+
+export * from './src/Contracts/Context/Middlewares/Handle/HandleContextContract'
+export * from './src/Contracts/Context/Middlewares/Handle/HandleHandlerContract'
+export * from './src/Contracts/Context/Middlewares/Intercept/InterceptContextContract'
+export * from './src/Contracts/Context/Middlewares/Intercept/InterceptHandlerContract'
+export * from './src/Contracts/Context/Middlewares/Terminate/TerminateContextContract'
+export * from './src/Contracts/Context/Middlewares/Terminate/TerminateHandlerContract'

package-lock.json

@@ -23,9 +23,10 @@
     "nodejs"
   ],
   "devDependencies": {
+    "@secjs/env": "1.2.8",
     "@secjs/exceptions": "1.0.4",
     "@secjs/ioc": "1.0.8",
-    "@secjs/utils": "1.6.3",
+    "@secjs/utils": "1.6.5",
     "@types/jest": "27.0.1",
     "@types/node": "14.14.37",
     "@types/supertest": "^2.0.11",

package.json

@@ -7,7 +7,10 @@
  * file that was distributed with this source code.
  */
 
+import { Env } from '@secjs/env'
+import { Is } from '@secjs/utils'
 import { FastifyRequest } from 'fastify'
+import { removeSlash } from '../Utils/removeSlash'
 import { RequestContract } from '../Contracts/Context/RequestContract'
 
 export class Request implements RequestContract {
@@ -25,14 +28,24 @@ export class Request implements RequestContract {
     return this.request.method
   }
 
-  get fullUrl(): string {
-    return this.request.url
+  get hostUrl(): string {
+    const url = this.request.url
+    const port = Env('PORT', '1335')
+    let host = Env('APP_DOMAIN', `http://localhost:${port}`)
+
+    if (!Is.Ip(host)) host = host.replace(`:${port}`, '')
+
+    return removeSlash(`${host}${url}`) as string
   }
 
   get baseUrl(): string {
     return this.request.url.split('?')[0]
   }
 
+  get originalUrl(): string {
+    return this.request.url
+  }
+
   get body(): Record<string, any> {
     return this.request.body
   }

src/Context/Request.ts

@@ -7,7 +7,6 @@
  * file that was distributed with this source code.
  */
 
-import { NextContract } from './NextContract'
 import { RequestContract } from './RequestContract'
 import { ResponseContract } from './ResponseContract'
 
@@ -16,7 +15,5 @@ export interface ContextContract {
   response: ResponseContract
   params: Record<string, string>
   queries: Record<string, string>
-  next?: NextContract
   data?: Record<string, any>
-  error?: any
 }

src/Contracts/Context/ContextContract.ts

@@ -0,0 +1,20 @@
+/**
+ * @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 { RequestContract } from '../RequestContract'
+import { ResponseContract } from '../ResponseContract'
+
+export interface ErrorContextContract {
+  request: RequestContract
+  response: ResponseContract
+  params: Record<string, string>
+  queries: Record<string, string>
+  data?: Record<string, any>
+  error: any
+}

src/Contracts/Context/Error/ErrorContextContract.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { ErrorContextContract } from './ErrorContextContract'
+
+export interface ErrorHandlerContract {
+  (ctx?: ErrorContextContract): Promise<any> | any
+}

src/Contracts/Context/Error/ErrorHandlerContract.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 { NextContract } from '../../NextContract'
+import { RequestContract } from '../../RequestContract'
+import { ResponseContract } from '../../ResponseContract'
+
+export interface HandleContextContract {
+  request: RequestContract
+  response: ResponseContract
+  params: Record<string, string>
+  queries: Record<string, string>
+  data?: Record<string, any>
+  next: NextContract
+}

src/Contracts/Context/Middlewares/Handle/HandleContextContract.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { HandleContextContract } from './HandleContextContract'
+
+export interface HandleHandlerContract {
+  (ctx?: HandleContextContract): Promise<any> | any
+}

src/Contracts/Context/Middlewares/Handle/HandleHandlerContract.ts

@@ -0,0 +1,22 @@
+/**
+ * @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 { NextContract } from '../../NextContract'
+import { RequestContract } from '../../RequestContract'
+import { ResponseContract } from '../../ResponseContract'
+
+export interface InterceptContextContract {
+  request: RequestContract
+  response: ResponseContract
+  params: Record<string, string>
+  queries: Record<string, string>
+  body: Record<string, any>
+  data?: Record<string, any>
+  next: NextContract
+}

src/Contracts/Context/Middlewares/Intercept/InterceptContextContract.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { InterceptContextContract } from './InterceptContextContract'
+
+export interface InterceptHandlerContract {
+  (ctx?: InterceptContextContract): Promise<any> | any
+}