@athenna/http 3.0.5 → 3.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -54,24 +54,25 @@
     "#tests/*": "./tests/*.js"
   },
   "dependencies": {
+    "fastify": "4.9.2"
+  },
+  "devDependencies": {
+    "@athenna/artisan": "3.0.7",
+    "@athenna/common": "3.0.1",
+    "@athenna/config": "3.0.3",
+    "@athenna/ioc": "3.0.1",
+    "@athenna/logger": "3.0.6",
     "@fastify/cors": "8.1.1",
     "@fastify/helmet": "10.0.2",
     "@fastify/rate-limit": "7.5.0",
     "@fastify/swagger": "8.1.0",
     "@fastify/swagger-ui": "1.1.0",
-    "fastify": "4.9.2"
-  },
-  "devDependencies": {
-    "@athenna/artisan": "3.0.5",
-    "@athenna/common": "3.0.0",
-    "@athenna/config": "3.0.2",
-    "@athenna/ioc": "3.0.0",
-    "@athenna/logger": "3.0.3",
     "@japa/assert": "1.3.4",
     "@japa/run-failed-tests": "1.0.7",
     "@japa/runner": "2.0.7",
     "@japa/spec-reporter": "1.1.12",
     "c8": "7.11.2",
+    "cls-rtracer": "2.6.2",
     "commitizen": "4.2.5",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",

package/src/Commands/Route/List.js

@@ -60,11 +60,11 @@ export class RouteList extends Command {
     const kernel = new Kernel()
 
     await kernel.registerCors()
+    await kernel.registerTracer()
     await kernel.registerRateLimit()
     await kernel.registerMiddlewares()
     await kernel.registerErrorHandler()
     await kernel.registerLogMiddleware()
-    await kernel.registerRequestIdMiddleware()
 
     const routePath = Path.routes(`http.${Path.ext()}`)
 

package/src/Handlers/HttpExceptionHandler.js

@@ -7,9 +7,9 @@
  * file that was distributed with this source code.
  */
 
-import { Log } from '@athenna/logger'
 import { Config } from '@athenna/config'
-import { Exception, String } from '@athenna/common'
+import { String } from '@athenna/common'
+import { Log, Logger } from '@athenna/logger'
 
 export class HttpExceptionHandler {
   /**
@@ -61,8 +61,6 @@ export class HttpExceptionHandler {
       delete body.stack
     }
 
-    response.status(statusCode).send(body)
-
     if (
       this.ignoreCodes.includes(code) ||
       this.ignoreStatuses.includes(statusCode)
@@ -70,20 +68,20 @@ export class HttpExceptionHandler {
       return
     }
 
-    if (error.prettify) {
-      const prettyError = await error.prettify()
-
-      Log.channel('exception').error(prettyError.concat('\n'))
+    const logger = Config.exists('logging.channels.exception')
+      ? Log.channel('exception')
+      : Logger.getConsoleLogger({
+          level: 'trace',
+          streamType: 'stderr',
+          formatter: 'none',
+        })
 
-      return
+    if (!error.prettify) {
+      error = error.toAthennaException()
     }
 
-    const exception = new Exception(body.message, body.statusCode, body.code)
-
-    exception.stack = error.stack
-
-    const prettyError = await exception.prettify()
+    logger.error((await error.prettify()).concat('\n'))
 
-    Log.channel('exception').error(prettyError.concat('\n'))
+    return response.status(statusCode).send(body)
   }
 }

package/src/Kernels/HttpKernel.js

@@ -7,11 +7,12 @@
  * file that was distributed with this source code.
  */
 
-import { Log } from '@athenna/logger'
-import { Config } from '@athenna/config'
-import { Module, Path, Uuid } from '@athenna/common'
+import rTracer from 'cls-rtracer'
 
+import { Log, Logger } from '@athenna/logger'
+import { Config } from '@athenna/config'
 import { Server } from '#src/Facades/Server'
+import { Module, Path } from '@athenna/common'
 
 export class HttpKernel {
   /**
@@ -100,6 +101,21 @@ export class HttpKernel {
     await Server.registerCors(Config.get('http.cors'))
   }
 
+  /**
+   * Register the rTracer plugin.
+   *
+   * @return {Promise<void>}
+   */
+  async registerTracer() {
+    if (Config.is('http.noTracer', true)) {
+      return
+    }
+
+    Server.use(async ctx => (ctx.data.traceId = rTracer.id()))
+
+    await Server.registerTracer(Config.get('http.tracer'))
+  }
+
   /**
    * Register helmet plugin.
    *
@@ -169,22 +185,14 @@ export class HttpKernel {
     }
 
     Server.use(async ctx => {
-      await Log.channel('request').info(ctx)
+      const logger = Config.exists('logging.channels.request')
+        ? Log.channel('request')
+        : Logger.getConsoleLogger({
+            level: 'trace',
+            formatter: 'none',
+          })
+
+      logger.info(ctx)
     }, 'terminate')
   }
-
-  /**
-   * Register the requestId handle middleware.
-   *
-   * @return {Promise<void>}
-   */
-  async registerRequestIdMiddleware() {
-    if (Config.is('http.noRequestId', true)) {
-      return
-    }
-
-    Server.use(async ctx => {
-      ctx.data.requestId = Uuid.generate('ath')
-    }, 'handle')
-  }
 }

package/src/Providers/ControllerProvider.js

@@ -23,7 +23,7 @@ export class ControllerProvider extends ServiceProvider {
     const controllers = await Module.getAllFromWithAlias(path, subAlias)
 
     controllers.forEach(({ alias, module }) => {
-      this.container.singleton(alias, module)
+      this.container.bind(alias, module)
     })
   }
 }

package/src/index.d.ts

@@ -11,8 +11,8 @@ import { Facade } from '@athenna/ioc'
 import { Exception, Json } from '@athenna/common'
 import { OpenAPIV2, OpenAPIV3 } from 'openapi-types'
 import { FastifyHelmetOptions } from '@fastify/helmet'
-import { FastifyReply, FastifyRequest, RouteOptions } from 'fastify'
 import { RateLimitOptions } from '@fastify/rate-limit'
+import { FastifyReply, FastifyRequest, RouteOptions } from 'fastify'
 
 export const Server: typeof Facade & Http
 export const Route: typeof Facade & Router.Router
@@ -70,6 +70,13 @@ export class HttpKernel {
    */
   registerCors(): Promise<void>
 
+  /**
+   * Register the rTracer plugin.
+   *
+   * @return {Promise<void>}
+   */
+  registerTracer(): Promise<void>
+
   /**
    * Register helmet plugin.
    *
@@ -104,13 +111,6 @@ export class HttpKernel {
    * @return {Promise<void>}
    */
   registerLogMiddleware(): Promise<void>
-
-  /**
-   * Register the requestId handle middleware.
-   *
-   * @return {Promise<void>}
-   */
-  registerRequestIdMiddleware(): Promise<void>
 }
 
 export class HttpExceptionHandler {
@@ -150,7 +150,7 @@ export class Http {
    *
    * @param {import('fastify').FastifyPluginCallback<import('fastify').FastifyPluginOptions>} plugin
    * @param {import('fastify').FastifyRegisterOptions<import('fastify').FastifyPluginOptions>} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   register(
     plugin: import('fastify').FastifyPluginCallback<
@@ -159,41 +159,49 @@ export class Http {
     options?: import('fastify').FastifyRegisterOptions<
       import('fastify').FastifyPluginOptions
     >,
-  ): Http
+  ): Promise<Http>
 
   /**
    * Register the cors plugin to fastify server.
    *
    * @param {import('@fastify/cors').FastifyCorsOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
-  registerCors(options?: import('@fastify/cors').FastifyCorsOptions): Http
+  registerCors(options?: import('@fastify/cors').FastifyCorsOptions): Promise<Http>
+
+  /**
+   * Register the rTracer plugin.
+   *
+   * @param {import('cls-rtracer').IFastifyOptions} options
+   * @return {Promise<Http>}
+   */
+  registerTracer(options?: import('cls-rtracer').IFastifyOptions): Promise<Http>
 
   /**
    * Register the helmet plugin to fastify server.
    *
    * @param {import('@fastify/helmet').FastifyHelmetOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
-  registerHelmet(options?: import('@fastify/helmet').FastifyHelmetOptions): Http
+  registerHelmet(options?: import('@fastify/helmet').FastifyHelmetOptions): Promise<Http>
 
   /**
    * Register the swagger plugin to fastify server.
    *
    * @param {import('@fastify/swagger').SwaggerOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
-  registerSwagger(options?: import('@fastify/swagger').SwaggerOptions): Http
+  registerSwagger(options?: import('@fastify/swagger').SwaggerOptions): Promise<Http>
 
   /**
    * Register the rate limit plugin to fastify server.
    *
    * @param {import('@fastify/rate-limit').RateLimitOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   registerRateLimit(
     options?: import('@fastify/rate-limit').RateLimitOptions,
-  ): Http
+  ): Promise<Http>
 
   /**
    * Get the fastify server instance.
@@ -217,6 +225,13 @@ export class Http {
    */
   getPort(): number
 
+  /**
+   * Get the server http version.
+   *
+   * @return {string}
+   */
+  getVersion(): string
+
   /**
    * Print all routes registered.
    *

package/src/index.js

@@ -7,10 +7,9 @@
  * file that was distributed with this source code.
  */
 
-import { Options } from '@athenna/common'
-
 import fastify from 'fastify'
 
+import { Options } from '@athenna/common'
 import { FastifyHandler } from '#src/Handlers/FastifyHandler'
 
 export * from './Facades/Route.js'
@@ -83,7 +82,7 @@ export class Http {
    *
    * @param {any} plugin
    * @param {any} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   async register(plugin, options = {}) {
     await this.#server.register(plugin, options)
@@ -95,17 +94,29 @@ export class Http {
    * Register the cors plugin to fastify server.
    *
    * @param {import('@fastify/cors').FastifyCorsOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   async registerCors(options) {
     return this.register(import('@fastify/cors'), options)
   }
 
+  /**
+   * Register the rTracer plugin to fastify server.
+   *
+   * @param {import('cls-rtracer').IFastifyOptions} [options]
+   * @return {Promise<Http>}
+   */
+  async registerTracer(options) {
+    const rTracer = await import('cls-rtracer')
+
+    return this.register(rTracer.fastifyPlugin, options)
+  }
+
   /**
    * Register the helmet plugin to fastify server.
    *
    * @param {import('@fastify/helmet').FastifyHelmetOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   async registerHelmet(options) {
     return this.register(import('@fastify/helmet'), options)
@@ -118,7 +129,7 @@ export class Http {
    *    ui: import('@fastify/swagger-ui').FastifySwaggerUiOptions,
    *    configurations: import('@fastify/swagger').SwaggerOptions
    *  }} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   async registerSwagger(options = {}) {
     await this.register(import('@fastify/swagger'), options.configurations)
@@ -130,7 +141,7 @@ export class Http {
    * Register the rate limit plugin to fastify server.
    *
    * @param {import('@fastify/rate-limit').RateLimitOptions} [options]
-   * @return {Http}
+   * @return {Promise<Http>}
    */
   async registerRateLimit(options) {
     return this.register(import('@fastify/rate-limit'), options)
@@ -164,6 +175,15 @@ export class Http {
     return this.#server.server.address().port
   }
 
+  /**
+   * Get the server http version.
+   *
+   * @return {string}
+   */
+  getVersion() {
+    return this.#server.version
+  }
+
   /**
    * Print all routes registered.
    *